Storybook Addon Theme

Storybook Addon Theme can be used to change the background color and default theme inside the preview in Storybook.

Installation

Theme is part of @pluralsight/ps-design-system-storybook-preset or you can install it individually with:

npm i -D @pluralsight/ps-design-system-storybook-addon-theme

Configuration

Add the following to .storybook/main.js:

module.exports = {
  addons: ['@pluralsight/ps-design-system-storybook-addon-theme']
}

Usage

Stories will default to the dark theme.

Override the default for a single story, all of a component's stories, or for all stories with the theme.name parameter (see more instructions here):

theme: { name: 'light' }

Disable the theme with the theme.disable parameter:

```typescript jsx theme: { disable: true }

If you're using Storybook's [addon-essentials](https://storybook.js.org/docs/react/essentials/introduction) you'll probably want to disable the `Background` addon since it also sets the background. Add the following to `.storybook/preview.js`:
```js
parameters: {
  backgrounds: { disable: true }
}

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

9.1.25 (2022-03-31)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.24 (2022-02-24)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.23 (2022-01-27)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.22 (2021-12-15)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.21 (2021-12-15)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.20 (2021-12-06)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.19 (2021-10-28)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.18 (2021-09-15)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.17 (2021-09-03)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.16 (2021-08-12)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.15 (2021-07-27)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.14 (2021-07-26)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.13 (2021-06-28)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.12 (2021-06-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.11 (2021-06-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.10 (2021-06-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.9 (2021-06-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.8 (2021-06-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.7 (2021-06-10)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.6 (2021-06-10)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.5 (2021-06-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.4 (2021-05-28)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.3 (2021-05-26)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.2 (2021-05-20)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

9.1.1 (2021-04-30)

Bug Fixes

• makes storybook theme addon work (#1723) (fc3b845)

9.1.0 (2021-04-20)

Features

• storybook-addon-theme: expose package.json in conditional exports (8ee47ec)

9.0.1 (2021-04-15)

Bug Fixes

• storybook-addon-theme: properly order the conditional exports in package (9aa2371)

9.0.0 (2021-04-14)

Code Refactoring

• storybook-addon-theme: add exports to package.json as alternate entry point (f634460)

BREAKING CHANGES

• storybook-addon-theme: add exports to package.json

8.2.1 (2021-04-05)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.2.0 (2021-03-31)

Bug Fixes

• storybook-addon-theme: update incorrect package name in README (105595e)

Features

• storybook-addon-theme: ability to set theme per-story (ae52523)
• storybook-addon-theme: update icon to circle (9bb5869)

8.1.6 (2021-03-23)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.1.5 (2021-03-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.1.4 (2021-03-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.1.3 (2021-02-25)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.1.2 (2021-02-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.1.1 (2021-02-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.1.0 (2021-02-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.0.1 (2021-02-04)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

8.0.0 (2021-01-25)

Build System

• storybook-addon-theme: update to react@17 (3d27597)

BREAKING CHANGES

• storybook-addon-theme: react@17 peerDependency upgrade

7.1.23 (2021-01-15)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.22 (2021-01-05)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.21 (2021-01-04)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.20 (2020-12-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.19 (2020-12-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.18 (2020-12-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.17 (2020-12-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.16 (2020-12-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.15 (2020-12-07)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.14 (2020-12-07)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.13 (2020-12-03)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.12 (2020-11-30)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.11 (2020-11-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.10 (2020-11-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.9 (2020-11-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.8 (2020-11-12)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.7 (2020-11-05)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.6 (2020-11-02)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.5 (2020-10-29)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.4 (2020-10-28)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.3 (2020-10-26)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.2 (2020-10-20)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.1 (2020-10-13)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.1.0 (2020-10-13)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.6 (2020-10-13)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.5 (2020-10-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.4 (2020-10-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.3 (2020-10-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.2 (2020-09-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.1 (2020-09-15)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

7.0.0 (2020-09-14)

Code Refactoring

• storybook-addon-theme: use new api (bd899cc)

Features

• storybook-addon-theme: use mirror icon for tool (d075c44)

BREAKING CHANGES

• storybook-addon-theme: storybook 6 required

6.0.10 (2020-08-10)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.9 (2020-07-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.8 (2020-05-07)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.7 (2020-04-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.6 (2020-04-07)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.5 (2020-04-03)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.5 (2020-04-02)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.4 (2020-03-27)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.3 (2020-03-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.2 (2020-03-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

6.0.0 (2020-03-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.18 (2020-02-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.17 (2020-02-04)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.16 (2020-01-30)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.15 (2020-01-29)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.14 (2020-01-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.12 (2020-01-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.10 (2020-01-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.8 (2020-01-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.7 (2020-01-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.6 (2020-01-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.5 (2020-01-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.3 (2019-12-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.2 (2019-12-16)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

5.0.1 (2019-11-06)

Bug Fixes

• revert react dep (c8d1a5a)

5.0.0 (2019-11-04)

Code Refactoring

• core: esm refactor (02d5928)
• theme: esm export refactor (dee9f11)

BREAKING CHANGES

• core: import patterns
• theme: new import pattern

4.1.0 (2019-10-21)

Features

• verticaltabs: new verticaltabs component (c1748e8)

4.0.2 (2019-10-02)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

4.0.1 (2019-09-17)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

4.0.0 (2019-08-09)

Build System

• storybook-addon-theme: move theme package to peerDeps (5be21cf)

BREAKING CHANGES

• storybook-addon-theme: @pluralsight/ps-design-system-theme is now a peerDependency and must be installed separately

3.0.0 (2019-07-30)

Bug Fixes

• storybook-addon-theme: move glamor to peerDeps (8c0a0f3)
• storybook-addon-theme: update mock (59cf02a)

Code Refactoring

• storybook-addon-theme: upgrade to use storybook5 and babel7 (1a3d886)

BREAKING CHANGES

• storybook-addon-theme: depends on storybook 5

2.0.5 (2019-07-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

2.0.4 (2019-06-03)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

2.0.3 (2019-05-31)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

2.0.2 (2019-04-24)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

2.0.1 (2019-04-23)

Bug Fixes

• dependency range (e6e59f9)

2.0.0 (2019-03-04)

Features

• theme: forward refs (5946706)

BREAKING CHANGES

• theme: bump to react 16.3 to use forwardrefs api

1.3.2 (2018-12-20)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.3.1 (2018-12-20)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.3.0 (2018-12-14)

Features

• storybook-addon-theme: mock support (0b5b411)

1.2.6 (2018-11-30)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.2.5 (2018-11-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.2.4 (2018-11-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.2.3 (2018-11-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.2.2 (2018-11-09)

Bug Fixes

• upgrade storybook and fix issues with require.context (ba6a6e8)

1.2.1 (2018-10-31)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.2.0 (2018-10-31)

Features

• storybook-addon-theme: add nice swatches to switch theme (8df6b87)

1.1.44 (2018-10-10)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.43 (2018-09-25)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.41 (2018-07-31)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.40 (2018-07-30)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.39 (2018-07-26)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.38 (2018-07-09)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.37 (2018-06-26)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.36 (2018-06-26)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.35 (2018-06-19)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.34 (2018-06-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.33 (2018-06-05)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.32 (2018-05-21)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.31 (2018-05-09)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.30 (2018-04-19)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.29 (2018-04-14)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.28 (2018-04-09)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.27 (2018-03-27)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.26 (2018-03-09)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.25 (2018-03-06)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.24 (2018-02-23)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.23 (2018-02-12)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.22 (2018-02-12)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.21 (2018-02-09)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.20 (2018-02-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.19 (2018-02-08)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.18 (2018-02-06)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.17 (2018-02-01)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.16 (2018-02-01)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.15 (2018-01-30)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.14 (2018-01-29)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.13 (2018-01-29)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.12 (2018-01-24)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.11 (2018-01-24)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.10 (2018-01-22)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.9 (2018-01-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.8 (2018-01-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.7 (2018-01-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.6 (2018-01-11)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.5 (2017-12-20)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.4 (2017-12-19)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.3 (2017-12-19)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.2 (2017-12-18)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.1 (2017-12-07)

Note: Version bump only for package @pluralsight/ps-design-system-storybook-addon-theme

1.1.0 (2017-11-02)

Features

• storybook-addon-theme: move button theme decorator to pkg (d16aa5b)