diff --git a/packages/big-design/src/components/Box/README.md b/packages/big-design/src/components/Box/README.md deleted file mode 100644 index 5001afb21..000000000 --- a/packages/big-design/src/components/Box/README.md +++ /dev/null @@ -1,26 +0,0 @@ -# Box - -### Examples - - - - - ---- - -## Description and Usage - -Et dolore sunt nisi quis commodo fugiat eu duis exercitation culpa. Nulla ipsum et cupidatat aliquip sint aute mollit labore. Irure aliquip consequat deserunt id proident pariatur minim ipsum officia sit anim. Reprehenderit duis in ad laborum proident esse anim esse. Velit adipisicing dolor exercitation voluptate excepteur laboris proident culpa anim velit qui ea eiusmod. - -Amet reprehenderit mollit labore aute sunt duis reprehenderit in ullamco mollit culpa. Voluptate minim labore voluptate nulla aliqua nulla do adipisicing aliquip. Ea excepteur veniam laboris est id ut ex esse aliqua. Laboris sint et qui cupidatat id. - -| Prop | Type | Description | Default | Required | -| :-------------- | :----- | :---------- | :------ | :----------------: | -| backgroundColor | string | Description | | :no_good: | -| elevation | string | Description | | :no_good: | -| border | string | Description | | :no_good: | -| borderBottom | string | Description | | :white_check_mark: | -| borderLeft | string | Description | | :no_good: | -| borderRight | string | Description | | :no_good: | -| borderTop | string | Description | | :no_good: | -| borderRadius | string | Description | | :no_good: | diff --git a/packages/big-design/src/components/ProgressBar/README.md b/packages/big-design/src/components/ProgressBar/README.md deleted file mode 100644 index 13e6793ca..000000000 --- a/packages/big-design/src/components/ProgressBar/README.md +++ /dev/null @@ -1,23 +0,0 @@ -# Progress Bar - -## Examples - - - - - ---- - -### Determinant Progress - -Determinant Progress is a known amount of time or completeness for a task to complete. To render a determinant progress bar, a `percent` property needs to be passed. - -### Indeterminant Progress - -Indeterminant Progress is an unknown amount of time for a task to complete. Will render an indeterminate progress bar if no `percent` property is passed. - -## Properties & Methods - -| Prop Name | Type | Default | Description | -| :-------- | :------- | :------ | :------------------- | -| `percent` | `number` | | Sets the fill length | diff --git a/packages/big-design/src/components/ProgressCircle/README.md b/packages/big-design/src/components/ProgressCircle/README.md deleted file mode 100644 index a375720da..000000000 --- a/packages/big-design/src/components/ProgressCircle/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# Progress Circle - -## Examples - - - - - ---- - -### Determinant Progress - -Determinant Progress is a known amount of time or completeness for a task to complete. For determinate progress indicators, the fill extends along the path of the indicator until the task complete. - -### Indeterminant Progress - -Indeterminant Progress is an unknown amount of time for a task to complete. For indeterminate progress indicators, the fill expands and contracts as it travels the length of the path until the tasks is complete. - -## Properties & Methods - -| Prop | Type | Default | Default | -| :-------- | :------------------------------------------- | :--------- | :----------------------------------- | -| `error` | `boolean` | | Toggles error state | -| `percent` | `number` | | Sets the fill length | -| `size` | `'xSmall' \| 'small' \| 'medium' \| 'large'` | `'medium'` | Sets the size of the progress circle | diff --git a/packages/storybook/.storybook/config.tsx b/packages/storybook/.storybook/config.tsx index fa7ccc628..b22ca9584 100644 --- a/packages/storybook/.storybook/config.tsx +++ b/packages/storybook/.storybook/config.tsx @@ -1,9 +1,8 @@ -import { defaultTheme, Panel } from '@bigcommerce/big-design'; +import { defaultTheme } from '@bigcommerce/big-design'; import { withA11y } from '@storybook/addon-a11y'; import { withKnobs } from '@storybook/addon-knobs'; import { addDecorator, addParameters, configure } from '@storybook/react'; import React from 'react'; -import { addReadme } from 'storybook-readme-source'; import { StoryWrapper } from '../components/StoryWrapper/StoryWrapper'; @@ -32,13 +31,8 @@ addParameters({ value: '#ffffff', }, ], - readme: { - codeTheme: 'a11y-dark', - StoryPreview: (props: any) => {props.children}, - }, }); -addDecorator(addReadme); addDecorator(withKnobs); addParameters({ diff --git a/packages/storybook/package.json b/packages/storybook/package.json index c2222cf6f..c7ed6dd02 100644 --- a/packages/storybook/package.json +++ b/packages/storybook/package.json @@ -56,7 +56,6 @@ "@types/styled-components": "^4.1.12", "babel-loader": "^8.0.5", "rimraf": "^2.6.3", - "storybook-readme-source": "^5.0.6", "ts-loader": "^6.0.4" } } diff --git a/packages/storybook/stories/Box.story.tsx b/packages/storybook/stories/Box.story.tsx index f758cec02..dacbc8142 100644 --- a/packages/storybook/stories/Box.story.tsx +++ b/packages/storybook/stories/Box.story.tsx @@ -2,14 +2,7 @@ import { Box } from '@bigcommerce/big-design'; import { storiesOf } from '@storybook/react'; import React from 'react'; -import BoxReadme from '../../big-design/src/components/Box/README.md'; - storiesOf('Box', module) - .addParameters({ - readme: { - content: BoxReadme, - }, - }) .add('Basic', () => I'm a Box) .add('With Border', () => ( <> diff --git a/packages/storybook/stories/Button.story.tsx b/packages/storybook/stories/Button.story.tsx index 5ab13d231..d41f5c723 100644 --- a/packages/storybook/stories/Button.story.tsx +++ b/packages/storybook/stories/Button.story.tsx @@ -1,4 +1,4 @@ -import { Button, DropdownIcon, Flex, Grid, Link, PlusIcon } from '@bigcommerce/big-design'; +import { Button, DropdownIcon, Flex, Grid, Link, Panel, PlusIcon } from '@bigcommerce/big-design'; import { action } from '@storybook/addon-actions'; import { boolean, select } from '@storybook/addon-knobs'; import { linkTo } from '@storybook/addon-links'; @@ -12,7 +12,7 @@ const actionType = ['normal' as 'normal', 'destructive' as 'destructive']; storiesOf('Button', module) .add('Overview', () => ( - <> +