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

Merge branch 'master' into release/3.3

Browse Source
This commit is contained in:
Michael Shilman 2017-08-25 18:32:41 -07:00 committed by GitHub
commit 90897f87eb
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
addons/info/README.md
View File

@ -41,7 +41,7 @@ storiesOf('Component', module)
## Usage with options
`withInfo` can also take an options object in case you want to configure how
`withInfo` can also take an [options object](#global-options) in case you want to configure how
the info panel looks on a per-story basis:
```js
@ -50,10 +50,8 @@ import { withInfo } from '@storybook/addon-info';
storiesOf('Component', module)
.add('simple info',
withInfo({
text: 'doc string about my component',
maxPropsIntoLine: 1,
maxPropObjectKeys: 10,
maxPropArrayLength: 10,
text: 'String or React Element with docs about my component', // Warning! This option's name will be likely renamed to "summary" in 3.3 release. Follow this PR #1501 for details
// other possible options see in Global options section below
)(() =>
<Component>Click the "?" mark at top-right to view the info.</Component>
)
@ -78,8 +76,14 @@ import { setDefaults } from '@storybook/addon-info';
// addon-info
setDefaults({
inline: true,
maxPropsIntoLine: 1,
header: false, // Toggles display of header with component name and description
inline: true, // Displays info inline vs click button to view
source: true, // Displays the source of story Component
propTables: [/* Components used in story */], // displays Prop Tables with this components
propTablesExclude: [], // Exclude Components from being shoun in Prop Tables section
styles: {}, // Overrides styles of addon
marksyConf: {}, // Overrides components used to display markdown. Warning! This option's name will be likely deprecated in favor to "components" with the same API in 3.3 release. Follow this PR #1501 for details
maxPropsIntoLine: 1, // Max props to display per line in source code
maxPropObjectKeys: 10,
maxPropArrayLength: 10,
maxPropStringLength: 100,