@storybook/preview-api
Advanced tools
Package description
The @storybook/preview-api package is part of the Storybook ecosystem, which is a tool for developing UI components in isolation for React, Vue, Angular, and more. This package provides APIs to interact with the Storybook preview, allowing developers to control the rendering of stories, listen to events, and manipulate the state of the Storybook UI.
Fetching and rendering stories
This feature allows developers to fetch story data by ID and render it using a custom component or utility.
import { useStorybookApi } from '@storybook/api';
function MyComponent() {
const api = useStorybookApi();
const story = api.getData('some-story-id');
return <StoryRenderer story={story} />;
}Listening to Storybook events
This feature enables components to listen to Storybook-specific events and react accordingly, as well as emit events to the Storybook environment.
import { useEffect } from 'react';
import { useChannel } from '@storybook/api';
function MyComponent() {
const emit = useChannel({
'storybook/my-event': (eventData) => {
console.log('Event data:', eventData);
}
});
useEffect(() => {
emit('storybook/my-event', { payload: 'data' });
}, [emit]);
return <div>Check the console for event data.</div>;
}Manipulating the Storybook UI
Developers can use this feature to programmatically control the Storybook UI, such as changing the current story displayed.
import { addons } from '@storybook/addons';
addons.setChannel(new Channel({ transport: new PostmsgTransport({ key: 'iframe-key' }) }));
addons.getChannel().emit('setCurrentStory', { storyId: 'some-story-id' });This package allows developers to create callbacks that appear in the actions panel of the Storybook UI when clicked. It is similar to @storybook/preview-api in that it enhances the Storybook development experience but focuses on actions rather than preview functionality.
This package provides a way to create links between stories. It is similar to @storybook/preview-api in that it interacts with the Storybook UI, but it specifically focuses on linking stories together rather than providing a general API for preview manipulation.
This addon shows the source of the story next to the story itself. While it enhances the Storybook experience by providing source code context, it does not offer an API for controlling the preview like @storybook/preview-api does.
Changelog
8.1.0
Storybook 8.1 is here with a tone of new features and bug fixes:
beforeEach test hook@vitejs/plugin-react-swc and plugins - #26837, thanks @JReinhold!providerImportSource extension - #26868, thanks @bashmish!react-dom/server imports breaking stories and docs - #26557, thanks @JReinhold![Object object] displayName in some JSX components - #26566, thanks @yannbf!of prop to Subtitle - #22552, thanks @joaonunomota!of prop to Title - #23728, thanks @Sidnioulz!docs.autodocs automigration - #27089, thanks @shilman!extends - #27097, thanks @shilman!vite-config-file.ts - #26375, thanks @joevaugh4n!duration and onClick support to Notification API and improve Notification UI - #26696, thanks @ghengeveld!UPDATE_STORY_ARGS which was for SSv6 - #25993, thanks @tmeasday!@joshwooding/vite-plugin-react-docgen-typescript to 0.3.1 - #26673, thanks @joshwooding!ejs to 3.1.10 - #27054, thanks @RiuSalvi!http:// links - #26488, thanks @JReinhold!document for preview - #24248, thanks @DylanPiercey!react-dom-shim - #26898, thanks @Tobbe!dev/autodocs/test system tags - #26634, thanks @shilman!preview.js - #27098, thanks @shilman!package.json - #26688, thanks @kasperpeulen!experimental-playwright entries without type:bundler - #27107, thanks @ndelangen!Readme
TODO write proper documentation of this package
This package used to be multiple packages (they have been combined into this one):
@storybook/addons read (old) docs@storybook/core-client read (old) docs@storybook/preview-web read (old) docs@storybook/store read (old) docsFAQs
Unknown package
We found that @storybook/preview-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 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.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
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.