GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-06 07:21:16 +08:00
Code Issues Packages Projects Releases Wiki Activity
storybook/docs/configure/integration/frameworks-feature-support.mdx
Kyle Gach 9e3d644c83 Address feedback
2024-08-29 08:49:05 -06:00

121 lines
16 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: 'Feature support for frameworks'
sidebar:
order: 2
title: Feature support for frameworks
---
Storybook integrates with many popular frontend frameworks. We do our best to keep feature parity amongst frameworks, but it’s tricky for our modest team to support every framework.
Below is a comprehensive table of what’s supported in which framework integration. If you’d like a certain feature supported in your framework, we welcome pull requests.
## Core frameworks
Core frameworks have dedicated maintainers or contributors who are responsible for maintaining the integration. As such, you can use most Storybook features in these frameworks.
| | React | Vue 3 | Angular | Web Components |
| --------------------------------------------------------------------------------------------- | ----- | ----- | ------- | -------------- |
| **Essentials** | | | | |
| [Actions](../../essentials/actions.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Backgrounds](../../essentials/backgrounds.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Docs](../../writing-docs/index.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Viewport](../../essentials/viewport.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Controls](../../essentials/controls.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Measure](../../essentials/measure-and-outline.mdx#measure-addon) | ✅ | ✅ | ✅ | ✅ |
| [Outline](../../essentials/measure-and-outline.mdx#outline-addon) | ✅ | ✅ | ✅ | ✅ |
| **Addons** | | | | |
| [A11y](../../writing-tests/accessibility-testing.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Component testing](../../writing-tests/component-testing.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Test runner](../../writing-tests/test-runner.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Test coverage](../../writing-tests/test-coverage.mdx) | ✅ | ✅ | ✅ | ✅ |
| [CSS resources](https://github.com/storybookjs/addon-cssresources) | ✅ | ✅ | ✅ | ✅ |
| [Design assets](https://github.com/storybookjs/addon-design-assets) | ✅ | ✅ | ✅ | ✅ |
| [Events](https://github.com/storybookjs/addon-events) | ✅ | ✅ | ✅ | ✅ |
| [Google analytics](https://github.com/storybookjs/addon-google-analytics) | ✅ | ✅ | ✅ | ✅ |
| [GraphQL](https://github.com/storybookjs/addon-graphql) | ✅ | | ✅ | |
| [Jest](https://github.com/storybookjs/storybook/tree/next/code/addons/jest) | ✅ | ✅ | ✅ | ✅ |
| [Links](https://github.com/storybookjs/storybook/tree/next/code/addons/links) | ✅ | ✅ | ✅ | ✅ |
| [Queryparams](https://github.com/storybookjs/addon-queryparams) | ✅ | ✅ | ✅ | ✅ |
| [Storysource](https://github.com/storybookjs/storybook/tree/next/code/addons/storysource) | ✅ | ✅ | ✅ | ✅ |
| **Docs** | | | | |
| [CSF Stories](../../api/csf.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Autodocs](../../writing-docs/autodocs.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - ArgTypes](../../api/doc-blocks/doc-block-argtypes.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Canvas](../../api/doc-blocks/doc-block-canvas.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - ColorPalette](../../api/doc-blocks/doc-block-colorpalette.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Controls](../../api/doc-blocks/doc-block-controls.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Description](../../api/doc-blocks/doc-block-description.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - IconGallery](../../api/doc-blocks/doc-block-icongallery.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Markdown](../../api/doc-blocks/doc-block-markdown.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Meta](../../api/doc-blocks/doc-block-meta.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Primary](../../api/doc-blocks/doc-block-primary.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Source](../../api/doc-blocks/doc-block-source.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Story](../../api/doc-blocks/doc-block-story.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Stories](../../api/doc-blocks/doc-block-stories.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Subtitle](../../api/doc-blocks/doc-block-subtitle.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Title](../../api/doc-blocks/doc-block-title.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Typeset](../../api/doc-blocks/doc-block-typeset.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Unstyled](../../api/doc-blocks/doc-block-unstyled.mdx) | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - UseOf](../../api/doc-blocks/doc-block-useof.mdx) | ✅ | ✅ | ✅ | ✅ |
| Inline stories | ✅ | ✅ | ✅ | ✅ |
## Community frameworks
Community frameworks have fewer contributors which means they may not be as up to date as core frameworks. If you use one of these frameworks for your job, please consider contributing to its integration with Storybook.
| | Ember | HTML | Svelte | Preact | Qwik | SolidJS |
| --------------------------------------------------------------------------------------------- | ----- | ---- | ------ | ------ | ---- | ------- |
| **Essentials** | | | | | | |
| [Actions](../../essentials/actions.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Backgrounds](../../essentials/backgrounds.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Docs](../../writing-docs/index.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Viewport](../../essentials/viewport.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Controls](../../essentials/controls.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Measure](../../essentials/measure-and-outline.mdx#measure-addon) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Outline](../../essentials/measure-and-outline.mdx#outline-addon) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Addons** | | | | | | |
| [A11y](../../writing-tests/accessibility-testing.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Component testing](../../writing-tests/component-testing.mdx) | | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Test runner](../../writing-tests/test-runner.mdx) | | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Test coverage](../../writing-tests/test-coverage.mdx) | | ✅ | ✅ | ✅ | ✅ | ✅ |
| [CSS resources](https://github.com/storybookjs/addon-cssresources) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Design assets](https://github.com/storybookjs/addon-design-assets) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Events](https://github.com/storybookjs/addon-events) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Google analytics](https://github.com/storybookjs/addon-google-analytics) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [GraphQL](https://github.com/storybookjs/addon-graphql) | | | | | | |
| [Jest](https://github.com/storybookjs/storybook/tree/next/code/addons/jest) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Links](https://github.com/storybookjs/storybook/tree/next/code/addons/links) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Queryparams](https://github.com/storybookjs/addon-queryparams) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Storysource](https://github.com/storybookjs/storybook/tree/next/code/addons/storysource) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| **Docs** | | | | | | |
| [CSF Stories](../../api/csf.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Autodocs](../../writing-docs/autodocs.mdx) | | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - ArgTypes](../../api/doc-blocks/doc-block-argtypes.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Canvas](../../api/doc-blocks/doc-block-canvas.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - ColorPalette](../../api/doc-blocks/doc-block-colorpalette.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Controls](../../api/doc-blocks/doc-block-controls.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Description](../../api/doc-blocks/doc-block-description.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - IconGallery](../../api/doc-blocks/doc-block-icongallery.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Markdown](../../api/doc-blocks/doc-block-markdown.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Meta](../../api/doc-blocks/doc-block-meta.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Primary](../../api/doc-blocks/doc-block-primary.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Source](../../api/doc-blocks/doc-block-source.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Story](../../api/doc-blocks/doc-block-story.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Stories](../../api/doc-blocks/doc-block-stories.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Subtitle](../../api/doc-blocks/doc-block-subtitle.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Title](../../api/doc-blocks/doc-block-title.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Typeset](../../api/doc-blocks/doc-block-typeset.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - Unstyled](../../api/doc-blocks/doc-block-unstyled.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| [Doc Blocks - UseOf](../../api/doc-blocks/doc-block-useof.mdx) | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
| Inline stories | | ✅ | ✅ | | | |
## Deprecated
To align the Storybook ecosystem with the current state of frontend development, the following features and addons are now deprecated, no longer maintained, and will be removed in future versions of Storybook
| Feature | Status |
| ---------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Knobs](https://github.com/storybookjs/addon-knobs) | The Knobs addon was officially deprecated with the release of Storybook 6.3 and is no longer actively maintained. We recommend using the [controls](../../essentials/controls.mdx) instead. |
| [Storyshots](../../writing-tests/snapshot-testing/storyshots-migration-guide.mdx) | The Storyshots addon was officially deprecated with the release of Storybook 7.6, is no longer actively maintained and was removed in Storybook 8. See the [migration guide](../../writing-tests/snapshot-testing/storyshots-migration-guide.mdx) for the available alternatives. |
| StoriesOf | The `storiesOf` API was officially removed with the release of Storybook 8 and is no longer maintained. We recommend using the [CSF API](../../api/csf.mdx) instead for writing stories.<br />See the [migration guide](../../migration-guide/index.mdx#storiesof-to-csf) for more information. |
Reference in New Issue View Git Blame Copy Permalink