@storybook/core
Advanced tools
The @storybook/core package is a part of Storybook, which is an open-source tool for developing UI components in isolation for React, Vue, Angular, and many other frameworks. It allows developers to create component libraries, interactive examples, and UI documentation. The core package is responsible for the fundamental functionalities of Storybook, including the server, UI, and the management of stories.
Custom Storybook Configuration
This code snippet demonstrates how to customize Storybook's configuration, including specifying where to find stories, which addons to use, the framework (e.g., React), and the builder (e.g., Webpack 5).
module.exports = {
stories: ['../src/**/*.stories.js'],
addons: ['@storybook/addon-links', '@storybook/addon-essentials'],
framework: '@storybook/react',
core: {
builder: 'webpack5'
}
};Adding Decorators
Decorators are a way to wrap stories with extra markup or styling. This code sample shows how to add a decorator globally in `.storybook/preview.js` that adds margin around each story.
export const decorators = [(Story) => <div style={{ margin: '3em' }}><Story/></div>];Custom Webpack Configuration
This demonstrates how to extend Storybook's default Webpack configuration to support additional file types or loaders, in this case, adding support for SCSS files.
const path = require('path');
module.exports = {
webpackFinal: async (config) => {
config.module.rules.push({
test: /\.scss$/,
use: ['style-loader', 'css-loader', 'sass-loader'],
include: path.resolve(__dirname, '../'),
});
return config;
},
};Docz is a documentation tool that uses MDX to help you write documentation and build component libraries. It's similar to Storybook in that it focuses on components but differs in its approach by leveraging Markdown and providing a more documentation-oriented experience.
The @storybook/core package is the core of Storybook. It is responsible for the following:
This package is not intended to be used by anyone but storybook internally.
Even though this is where all of the code is located, it is NOT to be the entry point when using functionality within!
Consumers of the code should import like so:
import { addons } from 'storybook/internal/manager-api';
Importing from @storybook/core is explicitly NOT supported; it WILL break in a future version of storybook, very likely in a non-major version bump.
@storybook/coreIn the following packages you should import from @storybook/core (and ONLY from @storybook/core):
@storybook/core@storybook/codemodTo prevent cyclical dependencies, these packages cannot depend on the storybook package.
storybook/internalIn every other package you should import from storybook/internal (and ONLY from storybook/internal).
The heuristic is simple:
If you see a peerDependency on
storybookin thepackage.jsonof the package you are working on, you should import fromstorybook/internal.
storybook package itselfThe sole exception is the storybook package itself.
Obviously, the storybook package cannot depend on itself, so it must import from @storybook/core.
8.4.0
Storybook 8.4 comes with a ton of exciting new features designed to give you the best experience developing, testing, and debugging tests in the browser!
@vitest/browser v2.1.2 - #29407, thanks @strozw!es-toolkit - #29259, thanks @JReinhold!@storybook/addon-links by default - #29177, thanks @tobiasdiez!.gitignore updated via CLI ends with a newline - #29124, thanks @3w36zj6!yarn detection - #29448, thanks @ndelangen!chalk to picocolors - #28262, thanks @43081j!export { X } parsing - #29344, thanks @vctqs1!prettier an optional peer dependency - #29223, thanks @JReinhold!express to polka - #29230, thanks @43081j!qs to picoquery - #28315, thanks @43081j!handlebars usage - #29208, thanks @ndelangen!file-system-cache - #29256, thanks @ndelangen!fs-extra with the native APIs - #29126, thanks @ziebam!lodash with es-toolkit - #28981, thanks @ndelangen!esbuild, broadening version range - #29254, thanks @ndelangen!renderers/react's dependencies - #29298, thanks @ndelangen!svelte2tsx - support runes - #29423, thanks @JReinhold!util dependency - #29310, thanks @JReinhold!react in manager - #29197, thanks @ndelangen!optimizeDeps - #29179, thanks @tobiasdiez!FAQs
Storybook framework-agnostic API
The npm package @storybook/core receives a total of 2,197,779 weekly downloads. As such, @storybook/core popularity was classified as popular.
We found that @storybook/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 11 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.