@storybook/core-common
Advanced tools
Package description
The @storybook/core-common 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 includes common functionalities and utilities used by various Storybook packages to configure and manage the core aspects of Storybook. It provides a set of APIs and configurations that are shared across different parts of the Storybook codebase.
Configuration Management
This feature allows developers to manage Storybook's configuration, including setting up the list of stories, adding addons, and customizing the Webpack configuration.
module.exports = { stories: ['../src/**/*.stories.js'], addons: ['@storybook/addon-actions', '@storybook/addon-links'], webpackFinal: async (config, { configType }) => { // Return the altered config return config; }, };Preset Management
Preset management helps in merging custom configurations with Storybook's default configurations using utilities like mergeConfig.
const { mergeConfig } = require('@storybook/core-common'); module.exports = { addons: ['@storybook/addon-essentials'], webpackFinal: (config) => mergeConfig(config, customConfig), };Custom Decorators and Parameters
Developers can use this package to add custom decorators and parameters to their Storybook setup, enhancing the functionality and customization of their stories.
const { addDecorator, addParameters } = require('@storybook/core-common'); addDecorator(myDecorator); addParameters({ myParameter: 'value' });React Cosmos is a development environment for creating reusable React components. It allows developers to render components with different props and states. While it shares the component isolation feature with Storybook, it does not have an extensive plugin system or the same level of community support.
React Styleguidist is a component development environment with a focus on living style guides. It differs from Storybook in that it emphasizes documenting components through Markdown files, whereas Storybook focuses on creating stories and using addons for additional functionality.
Docz leverages MDX to help you document your components with ease. It's similar to Storybook in that it provides a UI for showcasing components, but it focuses more on documentation and less on the interactive development environment aspect.
Changelog
7.0.0-alpha.33 (September 13, 2022)
throwPlayFunctionExceptions parameter #19143waitFor #19145DOCS_OPTIONS in the vite builder #19127cra-ts-essentials #19170config with previewAnnotations, remove previewEntries #19152lib/store #19105Readme
Common utilities used across @storybook/core-server (manager UI configuration) and @storybook/builder-webpack{4,5} (preview configuration).
This is a lot of code extracted for convenience, not because it made sense.
Supporting multiple version of webpack and this duplicating a large portion of code that was never meant to be generic caused this.
At some point we'll refactor this, it's likely a lot of this code is dead or barely used.
FAQs
Storybook framework-agnostic API
The npm package @storybook/core-common receives a total of 7,967,846 weekly downloads. As such, @storybook/core-common popularity was classified as popular.
We found that @storybook/core-common 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.
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.