1.1.0 • Published 3 years ago

@brightlayer-ui/storybook-themes v1.1.0

Weekly downloads
-
License
BSD-3-Clause
Repository
github
Last release
3 years ago

Brightlayer UI themes for Storybook applications

npm.io npm.io

This package contains theming support for Storybook applications built using Angular or React. It is primarily used to give these applications a Brightlayer UI look and feel. Integrating this theme into your storybook application will change the appearance of the storybook container and any Markdown notes found within the @storybook/addon-notes add-on.

Installation

This theme package depends on @brightlayer-ui/colors and the @storybook/theming add-on. To begin, install all three by running:

yarn add @brightlayer-ui/colors @storybook/theming @brightlayer-ui/storybook-themes

Usage

To integrate the theme into your storybook app, add the following code to your config:

import { bluiTheme } from '@brightlayer-ui/storybook-themes';
import { addParameters } from '@storybook/react';

addParameters({
    options: {
        theme: bluiTheme,
    },
});

For additional help while integrating storybook themes, see the storybook docs.

Demos

You can see this theme in action in the documentation for Brightlayer UI component libraries at brightlayer-ui-components.github.io.