{"bugs":{"url":"https://github.com/storybooks/storybook/issues"},"dist":{"shasum":"02b7695d9fa90f782bb180af79326349f919f51e","tarball":"https://registry.npmjs.org/@storybook/addon-options/-/addon-options-5.2.0-alpha.4.tgz","fileCount":20,"integrity":"sha512-UHRVQwAf62htVRm5UHSHaB95FvLM3GswHqClHaD+w5H1DXKecvLmsyITUHiUcs6Vpqe6XAvGS+dMaHKpLinlZQ==","signatures":[{"sig":"MEYCIQCX/efxB8qQZaYmkhhSD8jtDEI/OpUaLIuHAEJZ/Zer8QIhAJ/cxsh8gzRT5OrKyUoxx0/pCDW1euer4aM6vxZcEFHP","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":126162,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJc1mrCCRA9TVsSAnZWagAASasQAJ0ifLxTAbYf1/bQS/tY\nfnM6+F+eGjHbBS0/WhDZZHpqEDAl5HyqfJRYtmZ1BrkjyrVd0gcaA5iI8XWe\nTjrBs9w7lWW4tqxH59LhiXIQF+dQRg6U9FQ0viUbafbmLjIhDMkKcx8aprue\nfesKYjaqhR1he7FR0dXwhAmsMOLnHJibpnm+oeZPnafBkWe+TsC1+HQZum3f\n6WjBRIsPpqJCjoglqmGW8OT12P/Cjux7SPDCLoG6pJacJSlPkkQg7mTWH3Pe\nsZijDqusbeJXTGLpgvDHaPUQvwcYy7ylQG0Pbo2FwgANgMwKARe9MmhrN+9L\nQ9jObxkvrmhR3VfLh78nTKiDGkqKmAFWpnL2H8M9wlyVT3J/3WK+1s39ApKA\n76dIbRcy4g7wGyhN/80vccLWAUEilhv7ZYgLSegqwhHMy5Cn56kuBzVajHOu\nnAm0m3GYOjyaN3VCHBs9r2ZNbtjpLhZ10z5k9QwAYZjKSPyEAXdfVkfIUtEt\nFlAoTarSzKrzgolO4UpElkomcO34GV3M/Up5HYQ3ddk8z9OCDJCCmDI185CJ\nNKjmO4b2qEwknFP8ihnVhQjymD6INLN+Kuiffnpbwn2q3KeoqySDxlXt8hnb\nQvxgGQPeIu+reOzo2RvU17trNY7zY+NvWiwmKvcOI++3eK9AhE0M59xX7M3C\nSfQv\r\n=40SK\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"@storybook/addon-options","types":"dist/public_api.d.ts","readme":"#NOTE: Options Addon is deprecated as of Storybook 5.0\n\nOptions are now configured using the [`options` parameter](../../docs/src/pages/configurations/options-parameter/index.md) which is built into Storybook.\n\n- Global options: `addParameters({ options: { ... }})` and no addon is needed.\n- Story options: `storiesOf(...).add('name', storyFn, { options: { ... }})`\n\nSee the [migration docs](../../MIGRATION.md#options-addon-deprecated) for what's changed.\n\n# Storybook Options Addon\n\nThe Options addon can be used to (re-)configure the [Storybook](https://storybook.js.org) UI at runtime.\n\n[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)\n\n![Screenshot](https://raw.githubusercontent.com/storybooks/storybook/HEAD/addons/options/docs/screenshot.png)\n\n## Getting Started\n\nFirst, install the addon\n\n```sh\nyarn add @storybook/addon-options --dev\n```\n\nAdd this line to your `addons.js` file (create this file inside your storybook config directory if needed).\n\n```js\nimport '@storybook/addon-options/register';\n```\n\n### Set options globally\n\nImport and use the `addParameters` + `options`-key in your `config.js` file.\n\n```js\nimport { addParameters, configure } from '@storybook/react';\n\n// Option defaults:\naddParameters({\n  options: {\n    /**\n     * name to display in the top left corner\n     * @type {String}\n     */\n    name: 'Storybook',\n    /**\n     * URL for name in top left corner to link to\n     * @type {String}\n     */\n    url: '#',\n    /**\n     * show story component as full screen\n     * @type {Boolean}\n     */\n    goFullScreen: false,\n    /**\n     * display panel that shows a list of stories\n     * @type {Boolean}\n     */\n    showStoriesPanel: true,\n    /**\n     * display panel that shows addon configurations\n     * @type {Boolean}\n     */\n    showAddonPanel: true,\n    /**\n     * display floating search box to search through stories\n     * @type {Boolean}\n     */\n    showSearchBox: false,\n    /**\n     * show addon panel as a vertical panel on the right\n     * @type {Boolean}\n     */\n    addonPanelInRight: false,\n    /**\n     * sorts stories\n     * @type {Boolean}\n     */\n    sortStoriesByKind: false,\n    /**\n     * regex for finding the hierarchy separator\n     * @example:\n     *   null - turn off hierarchy\n     *   /\\// - split by `/`\n     *   /\\./ - split by `.`\n     *   /\\/|\\./ - split by `/` or `.`\n     * @type {Regex}\n     */\n    hierarchySeparator: null,\n    /**\n     * regex for finding the hierarchy root separator\n     * @example:\n     *   null - turn off multiple hierarchy roots\n     *   /\\|/ - split by `|`\n     * @type {Regex}\n     */\n    hierarchyRootSeparator: null,\n    /**\n     * sidebar tree animations\n     * @type {Boolean}\n     */\n    sidebarAnimations: true,\n    /**\n     * id to select an addon panel\n     * @type {String}\n     */\n    selectedPanel: undefined, // The order of addons in the \"Addon panel\" is the same as you import them in 'addons.js'. The first panel will be opened by default as you run Storybook\n    /**\n     * enable/disable shortcuts\n     * @type {Boolean}\n     */\n    enableShortcuts: false, // true by default\n    /**\n     * show/hide tool bar\n     * @type {Boolean}\n     */\n    isToolshown: false, // true by default\n  },\n});\n\nconfigure(() => require('./stories'), module);\n```\n\n### Using per-story options\n\nThe options-addon accepts story parameters on the `options` key:\n\n```js\nimport { storiesOf } from '@storybook/react';\nimport MyComponent from './my-component';\n\nstoriesOf('Addons|Custom options', module)\n  // If you want to set the option for all stories in of this kind\n  .addParameters({ options: { addonPanelInRight: true } })\n  .add(\n    'Story for MyComponent',\n    () => <MyComponent />,\n    // If you want to set the options for a specific story\n    { options: { addonPanelInRight: false } }\n  );\n```\n\n## TypeScript\n\nTo install type definitions: `yarn add @types/storybook__addon-options --dev`\n\nMake sure you also have the type definitions installed for the following libs:\n\n- Node\n- React\n\nYou can install them using `yarn add @types/node @types/react --dev`, assuming you are using TypeScript >2.0.\n","gitHead":"b248902dad664229659f6807b8a5ff9dd85909f5","license":"MIT","scripts":{"prepare":"node ../../scripts/prepare.js"},"_npmUser":{"name":"shilman","email":"michael@lab80.co"},"homepage":"https://github.com/storybooks/storybook/tree/master/addons/options","keywords":["addon","storybook"],"repository":{"url":"git+https://github.com/storybooks/storybook.git","type":"git","directory":"addons/options"},"_npmVersion":"lerna/3.13.4/node@v8.11.2+x64 (darwin)","description":"Options addon for storybook","directories":{},"maintainers":[{"name":"alexandrebodin","email":"bodin.alex@gmail.com"},{"name":"danielduan","email":"dduan@yahoo.com"},{"name":"gongreg","email":"gytis.vinclovas@gmail.com"},{"name":"hypnosphi","email":"talpa@yandex.ru"},{"name":"igor-dv","email":"davydkin.igor@gmail.com"},{"name":"ndelangen","email":"ndelangen@me.com"},{"name":"pksunkara","email":"pavan.sss1991@gmail.com"},{"name":"shilman","email":"michael@lab80.co"},{"name":"tmeasday","email":"tom@thesnail.org"},{"name":"usulpro","email":"regx@usul.su"}],"_nodeVersion":"8.11.2","dependencies":{"core-js":"^3.0.1","util-deprecate":"^1.0.2","@storybook/addons":"5.2.0-alpha.4"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","peerDependencies":{"react":"*"},"_npmOperationalInternal":{"tmp":"tmp/addon-options_5.2.0-alpha.4_1557555906213_0.7154883277265307","host":"s3://npm-registry-packages"},"_id":"@storybook/addon-options@5.2.0-alpha.4","version":"5.2.0-alpha.4"}