{"_id":"@avalane/storybook-addon-status","_rev":"1-39fda2e2f68e721f4a60edcb1865ad28","name":"@avalane/storybook-addon-status","dist-tags":{"latest":"5.0.1"},"versions":{"5.0.0":{"name":"@avalane/storybook-addon-status","version":"5.0.0","description":"Add component status to the storybook UI","main":"dist/preset.js","scripts":{"prepare":"husky install; babel ./src --out-dir ./dist","storybook":"storybook dev -p 6006","build-storybook":"storybook build","lint":"eslint . && stylelint ."},"repository":{"type":"git","url":"git+https://github.com/etchteam/storybook-addon-status.git"},"keywords":["storybook","addon","status","react","storybook-addon","organize","popular"],"author":{"name":"etchteam"},"license":"MIT","bugs":{"url":"https://github.com/etchteam/storybook-addon-status/issues"},"homepage":"https://github.com/etchteam/storybook-addon-status#readme","dependencies":{"@etchteam/eslint-config":"^1.7.1","@storybook/client-logger":"^8.0.6","@storybook/components":"^8.0.6","@storybook/core-events":"^8.0.6","@storybook/manager-api":"^8.0.6","@storybook/test":"^8.0.6","@storybook/theming":"^8.0.6","eslint":"^8.54.0","lodash":"^4.17.21","prettier":"^3.1.0","react":"18.2.0","react-dom":"^18.2.0"},"devDependencies":{"@babel/cli":"^7.14.5","@babel/core":"^7.14.6","@babel/preset-env":"^7.21.5","@babel/preset-react":"^7.18.6","@commitlint/cli":"^17.6.3","@commitlint/config-conventional":"^17.6.3","@etchteam/stylelint-config":"^1.5.0","@storybook/addon-essentials":"^8.0.6","@storybook/addon-interactions":"^8.0.6","@storybook/addon-links":"^8.0.6","@storybook/addon-webpack5-compiler-babel":"^3.0.3","@storybook/blocks":"^8.0.6","@storybook/react":"^8.0.6","@storybook/react-webpack5":"^8.0.6","babel-loader":"^8.2.2","eslint-plugin-storybook":"^0.6.12","husky":"^8.0.3","lint-staged":"^13.2.2","prop-types":"^15.8.1","storybook":"^8.0.6","stylelint":"^15.11.0"},"publishConfig":{"access":"public"},"storybook":{"icon":"https://pbs.twimg.com/profile_images/998947662287130625/7Ff1hOdQ_400x400.jpg","displayName":"Status"},"_id":"@avalane/storybook-addon-status@5.0.0","gitHead":"9f41d90355519313c79d509fff39743d31985841","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-hmk5UQePqsBFI3JEBuDXlZjxd5L7JSeH3us40BQDDcXnEJW2Ih1R4a8f7Qjy5aQgZLLVstH2KZudMnhjaKJfdg==","shasum":"0f64669579948b678c99df9632d71f817d5eb544","tarball":"https://registry.npmjs.org/@avalane/storybook-addon-status/-/storybook-addon-status-5.0.0.tgz","fileCount":16,"unpackedSize":19339,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFnhIPMG+D1wfKmXQpOB1ro1fwn0yyu8DsZhrPsxjBgaAiEA+KqTB1xmDHiy97XUpYPz0F3oSNBaZ3+EpQX0MPcjgbE="}]},"_npmUser":{"name":"oyvinmar","email":"oyvinmar@gmail.com"},"directories":{},"maintainers":[{"name":"oyvinmar","email":"oyvinmar@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-addon-status_5.0.0_1712561561591_0.6561955338495193"},"_hasShrinkwrap":false},"5.0.1":{"name":"@avalane/storybook-addon-status","version":"5.0.1","description":"Add component status to the storybook UI","main":"dist/preset.js","scripts":{"prepare":"husky install; babel ./src --out-dir ./dist","storybook":"storybook dev -p 6006","build-storybook":"storybook build","lint":"eslint . && stylelint ."},"repository":{"type":"git","url":"git+https://github.com/etchteam/storybook-addon-status.git"},"keywords":["storybook","addon","status","react","storybook-addon","organize","popular"],"author":{"name":"etchteam"},"license":"MIT","bugs":{"url":"https://github.com/etchteam/storybook-addon-status/issues"},"homepage":"https://github.com/etchteam/storybook-addon-status#readme","devDependencies":{"@etchteam/eslint-config":"^1.7.1","@storybook/client-logger":"^8.0.0","@storybook/components":"^8.0.0","@storybook/core-events":"^8.0.0","@storybook/manager-api":"^8.0.0","@storybook/test":"^8.0.0","@storybook/theming":"^8.0.0","eslint":"^8.54.0","lodash":"^4.17.21","prettier":"^3.1.0","react":"^18.2.0","react-dom":"^18.2.0","@babel/cli":"^7.14.5","@babel/core":"^7.14.6","@babel/preset-env":"^7.21.5","@babel/preset-react":"^7.18.6","@commitlint/cli":"^17.6.3","@commitlint/config-conventional":"^17.6.3","@etchteam/stylelint-config":"^1.5.0","@storybook/addon-essentials":"^8.0.0","@storybook/addon-interactions":"^8.0.0","@storybook/addon-links":"^8.0.0","@storybook/addon-webpack5-compiler-babel":"^3.0.3","@storybook/blocks":"^8.0.0","@storybook/react":"^8.0.0","@storybook/react-webpack5":"^8.0.0","babel-loader":"^8.2.2","eslint-plugin-storybook":"^0.6.12","husky":"^8.0.3","lint-staged":"^13.2.2","prop-types":"^15.8.1","storybook":"^8.0.6","stylelint":"^15.11.0"},"publishConfig":{"access":"public"},"storybook":{"icon":"https://pbs.twimg.com/profile_images/998947662287130625/7Ff1hOdQ_400x400.jpg","displayName":"Status"},"_id":"@avalane/storybook-addon-status@5.0.1","gitHead":"dd167c9cd5ee49bf1bc7c3f6694b5a06a9609fbc","_nodeVersion":"20.11.1","_npmVersion":"10.2.4","dist":{"integrity":"sha512-FDVQerzeBugbJDHWgU1BZpLTMngzTNZEM/dTu5KZruaAGJS9o+JpA3lzvpRExICh++yUmI5zPZt8pauUqvlQnQ==","shasum":"a23482e34ec5a3b8d8dca4710934647961ddddd5","tarball":"https://registry.npmjs.org/@avalane/storybook-addon-status/-/storybook-addon-status-5.0.1.tgz","fileCount":16,"unpackedSize":19316,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCSbJZPynW6ayWRp+vblPQ/cD+20+T1AHs3uRS9qkTIQQIhANHIEb4lvPfN6bkW8a58+Iy7FkGfjlJbKie//tzYGkPa"}]},"_npmUser":{"name":"oyvinmar","email":"oyvinmar@gmail.com"},"directories":{},"maintainers":[{"name":"oyvinmar","email":"oyvinmar@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/storybook-addon-status_5.0.1_1712562423237_0.94199918121322"},"_hasShrinkwrap":false}},"time":{"created":"2024-04-08T07:32:41.437Z","5.0.0":"2024-04-08T07:32:41.741Z","modified":"2024-04-08T07:47:03.600Z","5.0.1":"2024-04-08T07:47:03.377Z"},"maintainers":[{"name":"oyvinmar","email":"oyvinmar@gmail.com"}],"description":"Add component status to the storybook UI","homepage":"https://github.com/etchteam/storybook-addon-status#readme","keywords":["storybook","addon","status","react","storybook-addon","organize","popular"],"repository":{"type":"git","url":"git+https://github.com/etchteam/storybook-addon-status.git"},"author":{"name":"etchteam"},"bugs":{"url":"https://github.com/etchteam/storybook-addon-status/issues"},"license":"MIT","readme":"# Storybook Addon Status\n\nStorybook Status Addon can be used to add a component status label in [Storybook](https://storybook.js.org).\n\n![React Storybook Screenshot](https://raw.githubusercontent.com/etchteam/storybook-addon-status/master/screenshot.png)\n\n## Installation\n\n```sh\nnpm install @etchteam/storybook-addon-status --save-dev\n```\n\n## Configuration\n\nThen create a file called `main.js` in your storybook config.\n\nAdd the following content to it:\n\n```js\nmodule.exports = {\n  addons: ['@etchteam/storybook-addon-status'],\n};\n```\n\nIn `preview.js` you can globally configure custom status configurations, or overwrite the built in \"beta\", \"deprecated\", \"stable\" & \"releaseCandidate\"\n\n```js\nexport const parameters = {\n  status: {\n    statuses: {\n      released: {\n        background: '#0000ff',\n        color: '#ffffff',\n        description: 'This component is stable and released',\n      },\n    },\n  },\n};\n```\n\n## Story Usage\n\nThen write your stories like this:\n\n**.js**\n\n```js\n\nexport default {\n  title: 'BetterSoftwareLink',\n  parameters: {\n    status: {\n      type: 'beta', // 'beta' | 'stable' | 'deprecated' | 'releaseCandidate'\n      url: 'http://www.url.com/status', // will make the tag a link\n      statuses: {...} // add custom statuses for this story here\n    }\n  },\n};\n\nexport const defaultView = () => (\n  <a href=\"https://makebetter.software\">Make Better Software</a>\n);\n```\n\nFor multiple statuses `type` also accepts array values. If not specifically set every status uses `status.url` as the linked Url.\n\n```jsonc\nstatus: {\n  type: ['beta', 'released', 'myCustomStatus', { name: 'stable', url: 'http://www.example.com' }],\n  // url, statuses ...\n}\n```\n\n**NOTE:** The status dot in the sidebar only shows the color of the first status.\n\n**.mdx** (using addon-docs)\n\n```js\nimport { Meta } from \"@storybook/addon-docs/blocks\";\n<Meta title=\"BetterSoftwareLink\" parameters={{ status: { type: 'beta' } }}  /> // 'beta' | 'stable' | 'deprecated' | 'releaseCandidate'\n...\n```\n\nYou'll get an awesome label injected in the top toolbar and the sidebar.\n\n**Note** the `type` will be used as label for tag and will convert camelCase to words (release)\n\nMade with ☕ at [Etch](https://etch.co)\n\n## Migration guide\n\nNeed to [update your major version](Migration.md)?\n","readmeFilename":"Readme.md"}