@storybook/client-api
Advanced tools
The @storybook/client-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 configure and manage stories in the Storybook environment programmatically. It allows developers to add stories, decorators, and parameters, and to interact with Storybook's client-side application.
Add stories
This feature allows developers to add stories to Storybook. Each story represents a single visual state of a component. The 'storiesOf' function is used to define a new set of stories.
import { storiesOf } from '@storybook/client-api';
storiesOf('Button', module)
.add('with text', () => '<button>Click me</button>')
.add('with emoji', () => '<button>😀 😎 👍 💯</button>');Add decorators
Decorators are a way to provide custom rendering and add functionality to stories. The 'addDecorator' function is used to globally add decorators to all stories.
import { addDecorator } from '@storybook/client-api';
import { withKnobs } from '@storybook/addon-knobs';
addDecorator(withKnobs);Set global parameters
Parameters are a set of static, named metadata about a story, typically used to control the behavior of Storybook's addons. The 'addParameters' function is used to set global parameters for all stories.
import { addParameters } from '@storybook/client-api';
addParameters({
backgrounds: [
{ name: 'light', value: '#eeeeee', default: true },
{ name: 'dark', value: '#222222' }
]
});React Cosmos is a development tool for creating reusable React components. It provides a similar environment to Storybook for developing and testing components in isolation. While it shares the concept of component playgrounds with Storybook, it has a different API and focuses more on the component's state rather than the story format.
Docz leverages MDX to allow developers to write documentation alongside their code. It is similar to Storybook in that it provides a way to showcase components, but it emphasizes ease of writing documentation and reduces the need for configuration. Unlike Storybook, Docz is optimized for documentation and less for interactive component development.
The contents of this package have moved to @storybook/preview-api. Please update your import.
This package will no longer be released as part of the 8.0 release of storybook.
FAQs
Storybook Client API
The npm package @storybook/client-api receives a total of 1,320,028 weekly downloads. As such, @storybook/client-api popularity was classified as popular.
We found that @storybook/client-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.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.