@storybook/theming
Advanced tools
Package description
The @storybook/theming package is designed to help you customize the appearance of Storybook, an open-source tool for developing UI components in isolation. It allows you to create themes that can change the look and feel of Storybook's user interface to match your project's branding or style guidelines.
Creating custom themes
This feature allows you to define a custom theme for Storybook by specifying various properties such as base theme (light or dark), brand title, brand URL, brand image, and primary and secondary colors.
{
"base": "light",
"brandTitle": "My Custom Storybook",
"brandUrl": "https://mycompany.com",
"brandImage": "https://mycompany.com/logo.svg",
"colorPrimary": "#ff4785",
"colorSecondary": "#1EA7FD"
}Applying custom themes
This code sample demonstrates how to apply a built-in dark theme from the @storybook/theming package to your Storybook instance using the addParameters function.
import { themes } from '@storybook/theming';
import { addParameters } from '@storybook/react';
addParameters({
options: {
theme: themes.dark
}
});Extending existing themes
This feature allows you to extend an existing theme (in this case, the default light theme) and customize it further by overriding specific properties such as colors, background, border, typography, and more.
import { create } from '@storybook/theming';
import { themes } from '@storybook/theming';
export default create({
base: 'light',
brandTitle: 'Custom Storybook',
...themes.light,
colorPrimary: 'hotpink',
colorSecondary: 'deepskyblue',
// UI
appBg: 'white',
appContentBg: 'silver',
appBorderColor: 'grey',
appBorderRadius: 4,
// Typography
fontBase: '"Open Sans", sans-serif',
fontCode: 'monospace',
// Text colors
textColor: 'black',
textInverseColor: 'rgba(255,255,255,0.9)',
// Toolbar default and active colors
barTextColor: 'silver',
barSelectedColor: 'black',
barBg: 'hotpink',
// Form colors
inputBg: 'white',
inputBorder: 'silver',
inputTextColor: 'black',
inputBorderRadius: 4
});Material-UI is a popular React component library that follows Material Design guidelines. It includes a theming solution that allows you to customize the look and feel of your application. Unlike @storybook/theming, which is specific to Storybook, Material-UI's theming is meant for general React applications and provides a wider range of components to style.
Styled-components is a library for styling React applications using tagged template literals. It supports theming by allowing you to define a theme object and then use it throughout your application via a ThemeProvider. While @storybook/theming is focused on theming Storybook's UI, styled-components is a more general-purpose styling solution that can be used to theme entire React applications.
Ant Design (antd) is a design system for enterprise-level products. It includes a set of high-quality React components and a theming system that allows for customization of component styles. Ant Design's theming is more component-focused compared to @storybook/theming, which is tailored for customizing the Storybook interface.
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
Storybook Theming is a wrapper library for emotion. It ensures a single version of emotion is used everywhere.
It also includes some ready to use themes: light (normal) and dark.
FAQs
Core Storybook Components
The npm package @storybook/theming receives a total of 7,624,458 weekly downloads. As such, @storybook/theming popularity was classified as popular.
We found that @storybook/theming 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
Ecma TC39 is meeting this week and has moved key ECMAScript proposals forward, advancing Deferred Import Evaluation, Error.isError(), RegExp Escaping, and Promise.try to the next stages.
Security News
Researchers have demonstrated that teams of LLM agents can exploit zero-day vulnerabilities with a 53% success rate, and the costs of using AI to do so are rapidly becoming more affordable than hiring a human penetration tester.
Security News
In an unprecedented surge, May 2024 saw the publication of over 5,000 CVEs, marking a historic milestone in cybersecurity with an average of 164 CVEs per day, nearly double the 2023 daily average.