{"id":16124017,"url":"https://github.com/itaditya/storybook-addon-variants","last_synced_at":"2025-03-16T08:32:53.759Z","repository":{"id":39699086,"uuid":"507083516","full_name":"itaditya/storybook-addon-variants","owner":"itaditya","description":"Show all variants of a component in a grid","archived":false,"fork":false,"pushed_at":"2022-08-01T18:54:44.000Z","size":1058,"stargazers_count":32,"open_issues_count":6,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-27T06:08:46.069Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"storybook-addon-variants.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itaditya.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-24T16:54:34.000Z","updated_at":"2025-02-27T02:44:16.000Z","dependencies_parsed_at":"2022-07-13T15:59:28.770Z","dependency_job_id":null,"html_url":"https://github.com/itaditya/storybook-addon-variants","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":"storybookjs/addon-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itaditya%2Fstorybook-addon-variants","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itaditya%2Fstorybook-addon-variants/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itaditya%2Fstorybook-addon-variants/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itaditya%2Fstorybook-addon-variants/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itaditya","download_url":"https://codeload.github.com/itaditya/storybook-addon-variants/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809865,"owners_count":20351403,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-09T21:19:30.083Z","updated_at":"2025-03-16T08:32:52.648Z","avatar_url":"https://github.com/itaditya.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cbr /\u003e\n  \u003cimg src=\"https://storybook-addon-variants.vercel.app/logo.png\" alt=\"\" /\u003e\n  \u003cbr /\u003e\n  \u003cbr /\u003e\n\u003c/p\u003e\n\n# Storybook Variants Addon\n\nShow all variants of a component in a grid\n\n- 📦 No extra code required for creating variants.\n- 📝 Editing from Controls table and editor re-renders all variants.\n\n## Getting Started\n\n#### First install it\n\n```sh\nnpm install storybook-addon-variants\n```\n\n#### Register the addon in your main.js file\n\n```js\n// .storybook/main.js\n\nmodule.exports = {\n  stories: [...],\n  addons: [\"storybook-addon-variants\"],\n};\n```\n\n#### Enable your component variants\n\nThere are two ways to do so:\n\n1. By using the toolbar button:\n\n![](.github/assets/toolbar-example.gif)\n\n2. By defining a parameter in your story:\n\n```js\n// /MyComponent.stories.js\n\n// ...rest of code omitted for brevity\n\n// CSF2 syntax example\nexport const MyStory = Template.bind({})\nMyStory.parameters = {\n  variants: {\n    enable: true\n  }\n};\n\n// or CSF3 syntax example\nexport const MyStory = {\n  parameters: {\n    variants: {\n      enable: true\n    }\n  }\n};\n```\n\nBy defining this parameter, this story will _always_ render with all variants, regardless of what you select in the toolbar.\n\nThis method is quite useful if you want to have a fixed story that shows all variants in your sidebar. It's particularly useful for visual regression testing, when you want to take snapshots of all variants at once with tools like [Chromatic](https://www.chromatic.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitaditya%2Fstorybook-addon-variants","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitaditya%2Fstorybook-addon-variants","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitaditya%2Fstorybook-addon-variants/lists"}