Socket
Socket
Sign inDemoInstall

@storybook/theming

Package Overview
Dependencies
0
Maintainers
11
Versions
1549
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @storybook/theming

Core Storybook Components


Version published
Maintainers
11
Install size
803 kB
Created

Package description

What is @storybook/theming?

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.

What are @storybook/theming's main functionalities?

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
});

Other packages similar to @storybook/theming

Readme

Source

Storybook Theming

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.

Keywords

FAQs

Last updated on 23 May 2024

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc