Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Checkfront/react-storybook-addon-chapters
📒 Showcase multiple React components within a story
https://github.com/Checkfront/react-storybook-addon-chapters
categories chapters components react react-storybook react-storybook-addons sections storybook
Last synced: about 2 months ago
JSON representation
📒 Showcase multiple React components within a story
- Host: GitHub
- URL: https://github.com/Checkfront/react-storybook-addon-chapters
- Owner: Checkfront
- License: mit
- Created: 2017-03-07T15:30:16.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T00:55:58.000Z (over 1 year ago)
- Last Synced: 2024-10-28T15:39:51.088Z (2 months ago)
- Topics: categories, chapters, components, react, react-storybook, react-storybook-addons, sections, storybook
- Language: JavaScript
- Homepage: http://checkfront.github.io/react-storybook-addon-chapters
- Size: 5.04 MB
- Stars: 148
- Watchers: 16
- Forks: 21
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## â›” [DEPRECATED] This addon is no longer maintained and is now considered deprecated in favour of Storybook's native [nesting and component hierarchy](https://storybook.js.org/docs/react/writing-stories/naming-components-and-hierarchy). We recommend Storybook version 6 be used instead.
# React Storybook Chapters Addon
React Storybook Chapters addon allows showcasing of multiple components within a story by breaking it down into smaller categories (chapters) and subcategories (sections) for more organizational goodness.
Using the addon, a story can consist of multiple chapters and a chapter consists of multiple sections. Each section can render a block of code,
which typically used to showcase one component or a particular state of a component.
Chapters can be used to group related components together, or show varying states of a component.
Each chapter comes with a **Chapter Title**, **Chapter Subtitle**, **Chapter Info** and a list of **Sections**.
Simply omit any of them to hide them from rendering.
Each section comes with a **Section Title**, **Section Subtitle**, **Section Info**.
This addon was modified from [react-storybook-addon-info](https://github.com/storybooks/react-storybook-addon-info) and uses some of the component code from there.
## Usage
Install the following npm module:
```sh
npm install --save-dev react-storybook-addon-chapters
```
Then set the addon in the place you configure storybook like this:
```js
import React from 'react';
import { configure, setAddon } from '@storybook/react';
import chaptersAddon from 'react-storybook-addon-chapters';
setAddon(chaptersAddon);
configure(function () {
...
}, module);
```
To turn off the default styles add:
```js
setDefaults({ sectionOptions: { useTheme: false } });
```
All rendered components have a specified class. With the 'useTheme' set to false you should have no problem styling your chapters.
Then create your stories with the `.addWithChapters` API.
```js
import React from 'react';
import Button from './Button';
import { storiesOf } from '@storybook/react';
storiesOf('Addon Chapters')
.addWithChapters(
'Story With Chapters',
{
subtitle: ,
info: ,
chapters: [
// List of chapters. Refer to Configuration Format section.
{
title: ,
subtitle: ,
info: ,
sections: [
// List of sections.
{
title: ,
subtitle: ,
info: ,
sectionFn: () => ( { alert('Hello World!'); }}/>),
options: {
showSource: true,
allowSourceToggling: true,
showPropTables: true,
allowPropTablesToggling: true,
},
},
...
],
},
...
]
}
);
```
> Have a look at [this example](example/story.js) stories to learn more about the `addWithChapters` API.
## Global options
To configure default options for all chapter sections (`section.options`), use `setDefaults` in `.storybook/config.js` .
```js
import React from 'react';
import { configure, setAddon } from '@storybook/react';
import chaptersAddon, { setDefaults } from 'react-storybook-addon-chapters';
// optionally override defaults
setDefaults({
sectionOptions: {
showSource: true,
allowSourceToggling: true,
showPropTables: false,
allowPropTablesToggling: true,
decorator: story => (
{story()}),
}
});
setAddon(chaptersAddon);
configure(function () {
...
}, module);
```
## Configuration Format
#### Story
| Key | Description | Type | Default |
| -------- | ------------------------------------ | ----------------- | ------- |
| subtitle | Story subtitle | String | - |
| info | Additional information for the story | String (markdown) | - |
| chapters | An array of Chapter objects | Array | - |
#### Chapter
| Key | Description | Type | Default |
| -------- | -------------------------------------- | ----------------- | ------- |
| title | Chapter title | String | - |
| subtitle | Chapter subtitle | String | - |
| info | Additional information for the chapter | String (markdown) | - |
| sections | An array of Section objects | Array | - |
#### Section
| Key | Description | Type | Default |
| ------------------------------- | --------------------------------------------------------------------------------------- | ----------------- | ------- |
| title | Section title | String | - |
| subtitle | Section subtitle | String | - |
| info | Additional information for the section | String (markdown) | - |
| sectionFn | A function that returns a React component to be displayed | Function | - |
| options | A configuration object for this section. Refer to the next few rows for the keys | Object | - |
| options.showSource | Display the component's source | Boolean | True |
| options.allowSourceToggling | Allow showing/hiding of the component's source | Boolean | True |
| options.showPropTables | Display the component's propTypes | Boolean | False |
| options.allowPropTablesToggling | Allow showing/hiding of the component's propTypes | Boolean | True |
| options.decorator | An optional decorator function that will be used for rendering the component in section | Function | - |
## The FAQ
**Components lose their names on static build**
Component names also get minified with other javascript code when building for production. When creating components, set the `displayName` static property to show the correct component name on static builds.