@storybook/components

What is @storybook/components?

The @storybook/components package provides a set of reusable components specifically designed for building UIs in Storybook. These components are used within Storybook's own UI but are also available for developers to use in their own stories. They include basic UI elements such as buttons, inputs, icons, typography, and more complex components like syntax-highlighted code blocks and controls for live-editing component props.

What are @storybook/components's main functionalities?

Buttons

Provides styled button components that can be used in stories.

{"import { Button } from '@storybook/components';

export const MyButton = () => <Button>Click me</Button>;"}

Typography

Includes components for displaying titles, subtitles, and text with consistent styling.

{"import { Title, Subtitle } from '@storybook/components';

export const MyTypography = () => (
  <>
    <Title>This is a title</Title>
    <Subtitle>This is a subtitle</Subtitle>
  </>
);"}

Form Controls

Contains various form elements like text inputs and textareas for use in stories.

{"import { Input, Textarea } from '@storybook/components';

export const MyForm = () => (
  <>
    <Input placeholder='Enter text' />
    <Textarea placeholder='Enter multiline text' />
  </>
);"}

Icons

Provides a set of icons that can be easily included in stories.

{"import { Icons } from '@storybook/components';

export const MyIcons = () => <Icons icon='check' />;"}

Syntax Highlighter

Allows for the display of syntax-highlighted code blocks within stories.

{"import { SyntaxHighlighter } from '@storybook/components';

export const MyCodeBlock = () => (
  <SyntaxHighlighter language='javascript'>
    {`const myFunction = () => console.log('Hello, world!');`}
  </SyntaxHighlighter>
);"}

Other packages similar to @storybook/components

antd

Ant Design (antd) is a design system and React UI library that provides a multitude of components, similar to @storybook/components, but with a focus on implementing the Ant Design system rather than integrating with Storybook.

material-ui

Material-UI offers React components that implement Google's Material Design. It is similar to @storybook/components in providing a wide range of UI components but is designed for general application use rather than specifically for Storybook.

react-bootstrap

React-Bootstrap provides Bootstrap 4 components built with React. It offers a similar set of components to @storybook/components but is tailored to fit into the Bootstrap ecosystem.

semantic-ui-react

Semantic UI React is the official React integration for Semantic UI. It is a collection of components that help create beautiful, responsive layouts using human-friendly HTML, similar to @storybook/components but with a focus on Semantic UI's themes and styles.

README

Storybook Components

Storybook Components is a React UI components collection used by the UI of Storybook and Addons.

All components use emotion for styling.