GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-04 23:01:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2133 from storybooks/dd/fix-info-story-description

Browse Source 
fix info not importing docgen descriptions
This commit is contained in:
Filipp Riabchun 2017-11-01 02:12:41 +03:00 committed by GitHub
commit 64c29d73fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
addons/info/README.md
View File

@ -35,7 +35,7 @@ import { withInfo } from '@storybook/addon-info';
storiesOf('Component', module)
.add('simple info',
withInfo('doc string about my component')(() =>
withInfo('description or documentation about my component, supports markdown')(() =>
<Component>Click the "?" mark at top-right to view the info.</Component>
)
)
@ -148,7 +148,7 @@ setAddon(infoAddon);
### React Docgen Integration
React Docgen is included as part of the @storybook/react package through the use of `babel-plugin-react-docgen` during babel compile time.
When rendering a story with a React component commented in this supported format, the Addon Info prop table will display the prop's comment in the description column.
When rendering a story with a React component commented in this supported format, the Addon Info description will render the comments above the component declaration and the prop table will display the prop's comment in the description column.
```js
import React from 'react';

2
addons/info/src/components/Story.js
View File

@ -237,7 +237,7 @@ export default class Story extends React.Component {
if (Object.keys(STORYBOOK_REACT_CLASSES).length) {
Object.keys(STORYBOOK_REACT_CLASSES).forEach(key => {
if (STORYBOOK_REACT_CLASSES[key].name === this.props.context.kind) {
if (STORYBOOK_REACT_CLASSES[key].name === this.props.context.story) {
retDiv = <div>{STORYBOOK_REACT_CLASSES[key].docgenInfo.description}</div>;
}
});