Comments (12)
I can help and do this, but I wanna know your opinion about the concept.
You may have to rename your package according to this idea 🙂
from storybook-readme.
Hi,
I like this idea! But not sure if it is possible to implement (I mean dynamic panels)
Panels are registered after importing storybook-readme/register
at .storybook/addons.js
.
I think we can make it configurable:
import register from `storybook-readme/register`
register({
panels: ['README', 'DOCS', 'CHANGELOG']
});
At stories:
const withChangelog = storybookReadme.at('CHANGELOG');
const withReadme = storybookReadme.at('README');
storiesOf('Button', module)
.addDecorator(withChangelog(ButtonChangelog))
.addDecorator(withReadme(ButtonReadme))
And we should hide panel if it is unused at active story.
from storybook-readme.
@ndelangen What do you think about this?
from storybook-readme.
Yeah, sounds good!
But AFAIU there is no possibility to hide panel if we have no content.
from storybook-readme.
@SuperOl3g if it is not possible to hide panels - this feature will be not so useful.
If there is story without docs / changelog / readme / etc. - all panels will be shown and with empty content.
But we can contribute to storybook :) Suggest "Hide panels" feature
from storybook-readme.
@SuperOl3g @tuchk4 I'm working on improving the extensibility of Storybook to make these things much easier. Not just to make addons hidable, I think that would be selling a faster horse.
What I'm working on is a re-implementation of the core ui layout. It would allow users to show multiple addons at once, in any split-configuration they please.
It's likely a 3.4 feature
from storybook-readme.
So multiple tabs with different docs will not be useful (until it is possible to hide tab if there is no assigned doc).
@SuperOl3g Actually we can implement tabs inside main tab.
If you would like to implement it - I will be happy. Consider that the same behaviour should be implemented for withDocs
api.
from storybook-readme.
@tuchk4 Sorry, I think this solution doesn't look cool enough.
@ndelangen how can I help to implement new core API feature?
from storybook-readme.
This is feature is not useful until it is not possible to hide panels.
I close this issue for now.
Please reopen if you have another idea how to implement it :)
from storybook-readme.
affirmative)
from storybook-readme.
@SuperOl3g Join me on the Storybook slack and we can discuss how we can co-dev this feature.
https://now-examples-slackin-nqnzoygycp.now.sh/
I would be super happy to peer with you on this!
from storybook-readme.
I've opened a PR here:
storybookjs/storybook#2101
from storybook-readme.
Related Issues (20)
- Theme error when using Storybook 5.3+ HOT 6
- Word wrap on enums in PropTypes
- nodeEmoji.default.get is not a function HOT 1
- image path HOT 1
- Svelte Question! HOT 1
- cannot read property theme of undefined HOT 2
- importing props from another component
- (api help) "no readme found" for story exported as object without `storiesOf` HOT 2
- How to set storybook-readme as default panel in the sidebar of storybook?
- Usage with Component Story Format (CSF) HOT 2
- About use <docs> in Vue
- Support for storybook v6 ? HOT 3
- Display <!-- PROPS --> without the Story Props table
- PrismJS dependency fails NPM dependency audit
- License in package.json
- Cannot read property 'commit' of undefined
- Update marked and markdown-loader to resolve vulnerabilities
- [Question] Extension of sidebar search functionality
- Adapting to React 17+
- Getting it to work with storybook 7
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from storybook-readme.