@storybook/api
Advanced tools
Package description
The @storybook/api package is a part of Storybook, which is an open-source tool for developing UI components in isolation for React, Vue, Angular, and more. It provides a set of APIs that allow developers to interact with Storybook's internal state and methods, enabling them to create custom addons and tools that can enhance the Storybook experience.
useStorybookApi
This hook allows you to access the Storybook API within your components or addons to interact with Storybook's state and functions, such as selecting a specific story.
import { useStorybookApi } from '@storybook/api';
const api = useStorybookApi();
api.selectStory('component-id');useAddonState
This hook is used to persist state across the Storybook UI. It's useful for addons that need to maintain state.
import { useAddonState } from '@storybook/api';
const [state, setState] = useAddonState('your-addon-id', initialState);useParameter
This hook allows you to retrieve the value of a parameter passed to a story, which can be used to customize the behavior of an addon.
import { useParameter } from '@storybook/api';
const parameter = useParameter('parameterName', defaultValue);React Cosmos is a development tool that allows you to build and test reusable React components. It is similar to Storybook in that it provides an isolated environment to develop components, but it does not offer the same addon API for extending its functionality.
Docz is a documentation tool that leverages MDX to help you document your components. While it provides a way to showcase components similar to Storybook, it does not have an extensive API for creating addons or interacting with the tool's internal state.
React Styleguidist is a component development environment with a focus on living style guides. It differs from Storybook in that it does not have a dedicated API for addons, but it allows developers to document and showcase components interactively.
Changelog
7.6.0
Storybook 7.6 is here with increased performance and much more!
@storybook/core-events/preview-errors dependency missing for Yarn PnP - #24973, thanks @JReinhold!react and Storybook packages devDependencies where possible - #24676, thanks @JReinhold!react and Storybook packages devDependencies where possible - ATTEMPT 2 - #24834, thanks @JReinhold!addon-onboarding when checking versions - #24634, thanks @JReinhold!useStoryPrepared hook failing with undefined data - #22631, thanks @SpookyJelly!of prop to Primary block - #23849, thanks @Wilson2k!defaultProps in Stories block - #24506, thanks @WouterK12!store.settings.lastTrackedStoryId - #24115, thanks @rashidshamloo!"type": "commonjs" compatibility - #24534, thanks @ndelangen!react-docgen to v7 - #24530, thanks @shilman!SlotDecorator component - #24800, thanks @JReinhold!goto, invalidate and invalidateAll - #24955, thanks @paoloricciuti!--test CLI-flag - #24862, thanks @ndelangen!--test is true - #24799, thanks @ndelangen!@storybook/blocks if build.test.emptyBlocks is true - #24650, thanks @ndelangen!Readme
The contents of this package have moved to @storybook/manager-api. Please update your import.
This package will no longer be released as part of the 8.0 release of storybook.
FAQs
Storybook Manager API (facade)
The npm package @storybook/api receives a total of 3,509,260 weekly downloads. As such, @storybook/api popularity was classified as popular.
We found that @storybook/api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.