Skip to content

Commit

Permalink
add short description to each addon option.
Browse files Browse the repository at this point in the history
  • Loading branch information
danielduan committed Aug 1, 2017
1 parent e66dce8 commit 5e23c37
Showing 1 changed file with 48 additions and 6 deletions.
54 changes: 48 additions & 6 deletions addons/options/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,58 @@ Import and use the `setOptions` function in your config.js file.
import * as storybook from '@storybook/react';
import { setOptions } from '@storybook/addon-options';

// Option defaults:
setOptions({
name: 'My Storybook',
url: 'https://example.com',
/**
* string name to display in the top left corner
* @type {String}
*/
name: 'Storybook',
/**
* URL for string in top left corner to link to
* @type {String}
*/
url: '#',
/**
* show story component as full screen
* @type {Boolean}
*/
goFullScreen: false,
showLeftPanel: false,
showDownPanel: false,
showSearchBox: false,
/**
* display left panel that shows a list of stories
* @type {Boolean}
*/
showLeftPanel: true,
/**
* display horizontal panel that displays addon configurations
* @type {Boolean}
*/
showDownPanel: true,
/**
* display search box to filter stories
* @type {Boolean}
*/
showSearchBox: true,
/**
* show horizontal addons panel as a vertical panel on the right
* @type {Boolean}
*/
downPanelInRight: false,
/**
* sorts stories
* @type {Boolean}
*/
sortStoriesByKind: false,
hierarchySeparator: /\//,
/**
* regex for finding the hierarchy separator
* @example:
* null - turn off hierarchy
* /\// - split by `/`
* /\./ - split by `.`
* /\/|\./ - split by `/` or `.`
* @type {Regex}
*/
hierarchySeparator: null,
});

storybook.configure(() => require('./stories'), module);
Expand Down

0 comments on commit 5e23c37

Please sign in to comment.