Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ADDONS_SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
|[knobs](addons/knobs) |+|+|+|+|+|
|[links](addons/links) |+|+|+|+| |
|[notes](addons/notes) |+| |+|+|+|
|[options](addons/options) |+|+|+|+|+|
|[storyshots](addons/storyshots) |+|+|+|+| |
|[storysource](addons/storysource)|+| |+|+|+|
|[viewport](addons/viewport) |+| | | | |
|[viewport](addons/viewport) |+| |+| |+|
2 changes: 2 additions & 0 deletions addons/a11y/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

This storybook addon can be helpfull to make your UI components more accessibile.

[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![](docs/screenshot.png)

## Getting started
Expand Down
5 changes: 1 addition & 4 deletions addons/actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@

Storybook Addon Actions can be used to display data received by event handlers in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue).
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Screenshot](docs/screenshot.png)

Expand Down
4 changes: 1 addition & 3 deletions addons/background/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@

Storybook Centered Decorator can be used to center components inside the preview in [Storybook](https://storybook.js.org).

This addon works with Storybook for:

- [React](https://github.com/storybooks/storybook/tree/master/app/react)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![React Storybook Screenshot](https://storybook.js.org/img/addon-backgrounds.gif)

Expand Down
5 changes: 1 addition & 4 deletions addons/centered/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@

Storybook Centered Decorator can be used to center components inside the preview in [Storybook](https://storybook.js.org).

This addon works with Storybook for:

- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

### Usage

Expand Down
2 changes: 2 additions & 0 deletions addons/events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

This [storybook](https://storybooks.js.org) ([source](https://github.com/storybooks/storybook)) addon allows you to add events for your stories.

[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Storybook Addon Events Example](docs/demo1.png)
[Storybook Addon Events Live Demo](https://z4o4z.github.io/storybook-addon-events/index.html)

Expand Down
3 changes: 1 addition & 2 deletions addons/graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@

Storybook GraphQL Addon can be used to display the GraphiQL IDE with example queries in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Screenshot](docs/screenshot.png)

Expand Down
3 changes: 1 addition & 2 deletions addons/info/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,7 @@
Storybook Info Addon will show additional information for your stories in [Storybook](https://storybook.js.org).
Useful when you want to display usage or other types of documentation alongside your story.

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Screenshot](docs/home-screenshot.png)

Expand Down
2 changes: 2 additions & 0 deletions addons/jest/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Brings Jest results in storybook.

[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

[![Storybook Jest Addon Demo](@storybook/addon-jest.gif)](https://storybook-addon-jest-example.herokuapp.com/)

> Checkout the above [Live Storybook](https://storybook-addon-jest-example.herokuapp.com/).
Expand Down
10 changes: 1 addition & 9 deletions addons/knobs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,12 @@
[![Storybook Slack](https://now-examples-slackin-rrirkqohko.now.sh/badge.svg)](https://now-examples-slackin-rrirkqohko.now.sh/)
[![Backers on Open Collective](https://opencollective.com/storybook/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/storybook/sponsors/badge.svg)](#sponsors)

This addon works with Storybook for:
[React](https://github.com/storybooks/storybook/tree/master/app/react).
[React Native](https://github.com/storybooks/storybook/tree/master/app/react-native).
[Vue](https://github.com/storybooks/storybook/tree/master/app/vue).

* * *

Storybook Addon Knobs allow you to edit React props dynamically using the Storybook UI.
You can also use Knobs as a dynamic variable inside stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

This is how Knobs look like:

Expand Down
5 changes: 1 addition & 4 deletions addons/links/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@

The Storybook Links addon can be used to create links that navigate between stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

## Getting Started

Expand Down
5 changes: 1 addition & 4 deletions addons/notes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@

Storybook Addon Notes allows you to write notes (text or HTML) for your stories in [Storybook](https://storybook.js.org).

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Storybook Addon Notes Demo](docs/demo.png)

Expand Down
5 changes: 1 addition & 4 deletions addons/options/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,7 @@

The Options addon can be used to (re-)configure the [Storybook](https://storybook.js.org) UI at runtime.

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Screenshot](docs/screenshot.png)

Expand Down
6 changes: 1 addition & 5 deletions addons/storyshots/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,7 @@

StoryShots adds automatic Jest Snapshot Testing for [Storybook](https://storybook.js.org/).

This addon works with Storybook for:
- [React](https://github.com/storybooks/storybook/tree/master/app/react)
- [React Native](https://github.com/storybooks/storybook/tree/master/app/react-native)
- [Angular](https://github.com/storybooks/storybook/tree/master/app/angular)
- [Vue](https://github.com/storybooks/storybook/tree/master/app/vue)
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![StoryShots In Action](docs/storyshots-fail.png)

Expand Down
4 changes: 3 additions & 1 deletion addons/storysource/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Storybook Storysource Addon

This addon is used to show stories source in the addon panel.
This addon is used to show stories source in the addon panel.

[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Storysource Demo](demo.gif)

Expand Down
2 changes: 1 addition & 1 deletion addons/viewport/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Storybook Viewport Addon allows your stories to be displayed in different sizes and layouts in [Storybook](https://storybookjs.org). This helps build responsive components inside of Storybook.

This addon works with Storybook for: [React](https://github.com/storybooks/storybook/tree/master/app/react) and [Vue](https://github.com/storybooks/storybook/tree/master/app/vue).
[Framework Support](https://github.com/storybooks/storybook/blob/master/ADDONS_SUPPORT.md)

![Screenshot](https://github.com/storybooks/storybook/blob/master/addons/viewport/docs/viewport.png)

Expand Down