Merge pull request #265 from edx/fix-readme-addons

docs(readme-storybook-addons): update storybook README addons
openedx · May 25, 2018 · 9b868e4 · 9b868e4
2 parents 7c97e22 + b56fd08
commit 9b868e4
Show file tree

Hide file tree

Showing 9 changed files with 31 additions and 10 deletions.
diff --git a/src/Button/Button.stories.jsx b/src/Button/Button.stories.jsx
@@ -5,14 +5,16 @@ import { action } from '@storybook/addon-actions';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
 import README from './README.md';
 
 import Button from './index';
 
 storiesOf('Button', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('basic usage', () => (
     <Button
       label="Click me and check the console!"

diff --git a/src/CheckBox/CheckBox.stories.jsx b/src/CheckBox/CheckBox.stories.jsx
@@ -5,6 +5,7 @@ import { storiesOf } from '@storybook/react';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
 
 import CheckBox from './index';
 import Button from '../Button';
@@ -46,9 +47,10 @@ class CheckBoxWrapper extends React.Component {
 }
 
 storiesOf('CheckBox', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('basic usage', () => (
     <CheckBox
       name="checkbox"

diff --git a/src/Dropdown/Dropdown.stories.jsx b/src/Dropdown/Dropdown.stories.jsx
@@ -4,14 +4,16 @@ import { storiesOf } from '@storybook/react';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
 
 import Dropdown from './index';
 import README from './README.md';
 
 storiesOf('Dropdown', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('basic usage', () => (
     <Dropdown
       title="Search Engines"

diff --git a/src/Fieldset/Fieldset.stories.jsx b/src/Fieldset/Fieldset.stories.jsx
@@ -3,6 +3,7 @@ import { storiesOf } from '@storybook/react';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
 
 import Fieldset from './index';
 import InputText from '../InputText/index';
@@ -74,9 +75,10 @@ class ValidatedForm extends React.Component {
 }
 
 storiesOf('Fieldset', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('basic usage', () => (
     <form>
       <Fieldset

diff --git a/src/Hyperlink/Hyperlink.stories.jsx b/src/Hyperlink/Hyperlink.stories.jsx
@@ -6,7 +6,10 @@ import { checkA11y } from '@storybook/addon-a11y';
 import { action } from '@storybook/addon-actions';
 import { setConsoleOptions } from '@storybook/addon-console';
 import { withInfo } from '@storybook/addon-info';
-import FontAwesomeStyles from 'font-awesome/css/font-awesome.min.css';
+import { withReadme } from 'storybook-readme';
+
+import 'font-awesome/css/font-awesome.min.css';
+
 import README from './README.md';
 
 import Hyperlink from './index';
@@ -22,9 +25,10 @@ const onClick = (event) => {
 };
 
 storiesOf('HyperLink', module)
-  .addDecorator((story, context) => withInfo({ styles: FontAwesomeStyles }, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('minimal usage', () => <Hyperlink destination="https://en.wikipedia.org/wiki/Hyperlink" content="edX.org" />)
   .add('with blank target', () => (
     <Hyperlink

diff --git a/src/Icon/Icon.stories.jsx b/src/Icon/Icon.stories.jsx
@@ -3,15 +3,17 @@ import { storiesOf } from '@storybook/react';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
 
 import FontAwesomeStyles from 'font-awesome/css/font-awesome.min.css';
 import Icon from './index';
 import README from './README.md';
 
 storiesOf('Icon', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('basic usage', () => (
     <Icon
       className={[

diff --git a/src/MailtoLink/MailtoLink.stories.jsx b/src/MailtoLink/MailtoLink.stories.jsx
@@ -6,6 +6,7 @@ import { setConsoleOptions } from '@storybook/addon-console';
 import { withInfo } from '@storybook/addon-info';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
+import { withReadme } from 'storybook-readme';
 
 import MailtoLink from './index';
 import README from './README.md';
@@ -21,9 +22,10 @@ const onClick = (event) => {
 };
 
 storiesOf('MailtoLink', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('minimal usage', () => (
     <MailtoLink
       to="[email protected]"

diff --git a/src/RadioButtonGroup/RadioButtonGroup.stories.jsx b/src/RadioButtonGroup/RadioButtonGroup.stories.jsx
@@ -6,6 +6,8 @@ import { checkA11y } from '@storybook/addon-a11y';
 import { action } from '@storybook/addon-actions';
 import { setConsoleOptions } from '@storybook/addon-console';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
+
 import README from './README.md';
 
 import RadioButtonGroup, { RadioButton } from './index';
@@ -42,9 +44,10 @@ const onKeyDown = (event) => {
 };
 
 storiesOf('RadioButtonGroup', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('unselected minimal usage', () => (
     <RadioButtonGroup
       name="rbg"

diff --git a/src/SearchField/SearchField.stories.jsx b/src/SearchField/SearchField.stories.jsx
@@ -4,14 +4,16 @@ import { action } from '@storybook/addon-actions';
 import centered from '@storybook/addon-centered';
 import { checkA11y } from '@storybook/addon-a11y';
 import { withInfo } from '@storybook/addon-info';
+import { withReadme } from 'storybook-readme';
 
 import SearchField from './index';
 import README from './README.md';
 
 storiesOf('SearchField', module)
-  .addDecorator((story, context) => withInfo({}, README)(story)(context))
+  .addDecorator((story, context) => withInfo()(story)(context))
   .addDecorator(centered)
   .addDecorator(checkA11y)
+  .addDecorator(withReadme(README))
   .add('basic usage', () => (
     <SearchField
       onSubmit={action('search-submitted')}