Skip to content

docs(story-template): modify the default template, add inline templates #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jeff-phillips-18 merged 1 commit into from
Jan 8, 2018
Merged

docs(story-template): modify the default template, add inline templates #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 src/components/Alert/Alert.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { storiesOf } from '@storybook/react';
import { action } from '@storybook/addon-actions';
import { withKnobs, text } from '@storybook/addon-knobs';
import { defaultTemplate } from '../../../storybook/decorators/storyTemplates';
import { DOCUMENTATION_URL } from '../../../storybook/constants';
import { Alert } from './index';

const stories = storiesOf('Alert', module);
Expand All @@ -11,7 +12,7 @@ stories.addDecorator(
defaultTemplate({
title: 'Alert / Inline Notification',
documentationLink:
'http://www.patternfly.org/pattern-library/communication/inline-notifications/'
DOCUMENTATION_URL.PATTERNFLY_ORG_COMMUNICATION + 'inline-notifications/'
})
);

Expand Down
6 changes: 3 additions & 3 deletions src/components/Badge/Badge.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';
import { storiesOf } from '@storybook/react';
import { defaultTemplate } from '../../../storybook/decorators/storyTemplates';
import { DOCUMENTATION_URL } from '../../../storybook/constants';
import { Badge } from './index';

const stories = storiesOf('Badges', module);
Expand All @@ -9,7 +10,7 @@ const description = (
<p>
This component is based on React Bootstrap Badge component. Badges easily
highlight new or unread items. See{' '}
<a href="https://react-bootstrap.github.io/components.html#badges">
<a href={DOCUMENTATION_URL.REACT_BOOTSTRAP_COMPONENT + 'badge/'}>
React Bootstrap Docs
</a>{' '}
for complete Badge component documentation.
Expand All @@ -19,8 +20,7 @@ const description = (
stories.addDecorator(
defaultTemplate({
title: 'Badges',
documentationLink:
'http://www.patternfly.org/pattern-library/widgets/#badges',
documentationLink: DOCUMENTATION_URL.PATTERNFLY_ORG_WIDGETS + '#badges',
description: description
})
);
Expand Down
5 changes: 3 additions & 2 deletions src/components/Breadcrumb/Breadcrumb.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import React from 'react';
import { storiesOf } from '@storybook/react';
import { defaultTemplate } from '../../../storybook/decorators/storyTemplates';
import { DOCUMENTATION_URL } from '../../../storybook/constants';
import { Breadcrumb } from './index';

const stories = storiesOf('Breadcrumb', module);
Expand All @@ -9,7 +10,7 @@ const description = (
<p>
This component is based on React Bootstrap Breadcrumb component. Breadcrumbs
are used to indicate the current page's location. See{' '}
<a href="https://react-bootstrap.github.io/components.html#breadcrumbs">
<a href={DOCUMENTATION_URL.REACT_BOOTSTRAP_COMPONENT + 'breadcrumb/'}>
React Bootstrap Docs
</a>{' '}
for complete Breadcrumb component documentation.
Expand All @@ -20,7 +21,7 @@ stories.addDecorator(
defaultTemplate({
title: 'Breadcrumb',
documentationLink:
'http://www.patternfly.org/pattern-library/navigation/breadcrumbs/',
DOCUMENTATION_URL.PATTERNFLY_ORG_NAVIGATION + 'breadcrumbs/',
description: description
})
);
Expand Down
89 changes: 51 additions & 38 deletions src/components/Button/Button.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,52 +2,44 @@ import React from 'react';
import { storiesOf } from '@storybook/react';
import { action } from '@storybook/addon-actions';
import { withKnobs, select } from '@storybook/addon-knobs';
import { defaultTemplate } from '../../../storybook/decorators/storyTemplates';
import { inlineTemplate } from '../../../storybook/decorators/storyTemplates';
import { DOCUMENTATION_URL } from '../../../storybook/constants';
import { Grid, Row, Col, MenuItem } from '../../index';
import { Button, ButtonGroup, DropdownButton, SplitButton } from './index';
import { BUTTON_BS_STYLES } from './constants';

const stories = storiesOf('Button', module);

const description = (
<p>
This component is based on React Bootstrap Button component. See{' '}
<a href="https://react-bootstrap.github.io/components.html#buttons">
React Bootstrap Docs
</a>{' '}
for complete Button component documentation.
</p>
);

stories.addDecorator(withKnobs);
stories.addDecorator(
defaultTemplate({
title: 'Button',
documentationLink:
'http://www.patternfly.org/pattern-library/widgets/#buttons',
description: description
})
);

stories.addWithInfo('Button', '', () => (
<div>
<p>
<Button>Default Button</Button>{' '}
<Button bsStyle="primary">Primary Button</Button>{' '}
<Button bsStyle="danger">Danger Button</Button>{' '}
<Button bsStyle="link">Link Button</Button>
</p>
<p>
<Button bsSize="large">Large Button</Button>{' '}
<Button>Default Button</Button>{' '}
<Button bsSize="small">Small Button</Button>{' '}
<Button bsSize="xsmall">Extra Small Button</Button>
</p>
</div>
));
stories.addWithInfo('Button', '', () => {
let story = (
<div>
<p>
<Button>Default Button</Button>{' '}
<Button bsStyle="primary">Primary Button</Button>{' '}
<Button bsStyle="danger">Danger Button</Button>{' '}
<Button bsStyle="link">Link Button</Button>
</p>
<p>
<Button bsSize="large">Large Button</Button>{' '}
<Button>Default Button</Button>{' '}
<Button bsSize="small">Small Button</Button>{' '}
<Button bsSize="xsmall">Extra Small Button</Button>
</p>
</div>
);
return inlineTemplate({
title: 'Button',
documentationLink: DOCUMENTATION_URL.PATTERNFLY_ORG_WIDGETS + '#buttons',
reactBootstrapDocumentationLink:
DOCUMENTATION_URL.REACT_BOOTSTRAP_COMPONENT + 'buttons/',
story: story
});
});

stories.addWithInfo('ButtonGroup', () => {
return (
let story = (
<Grid>
<Row style={{ marginBottom: '20px' }}>
<Col xs={12} md={3}>
Expand Down Expand Up @@ -141,6 +133,14 @@ stories.addWithInfo('ButtonGroup', () => {
</Row>
</Grid>
);
return inlineTemplate({
title: 'ButtonGroup',
documentationLink:
DOCUMENTATION_URL.PATTERNFLY_ORG_WIDGETS + '#button-groups',
reactBootstrapDocumentationLink:
DOCUMENTATION_URL.REACT_BOOTSTRAP_COMPONENT + 'button-group/',
story: story
});
});

stories.addWithInfo('DropdownButton', '', () => {
Expand All @@ -150,7 +150,7 @@ stories.addWithInfo('DropdownButton', '', () => {
const props = { bsStyle, title: bsStyle, id: 'dropdown-example' };
if (bsSize) props.bsSize = bsSize;

return (
let story = (
<DropdownButton {...props} onClick={action('onClick')}>
<MenuItem eventKey="1">Action</MenuItem>
<MenuItem eventKey="2">Another action</MenuItem>
Expand All @@ -161,6 +161,12 @@ stories.addWithInfo('DropdownButton', '', () => {
<MenuItem eventKey="4">Separated link</MenuItem>
</DropdownButton>
);
return inlineTemplate({
title: 'DropdownButton',
reactBootstrapDocumentationLink:
DOCUMENTATION_URL.REACT_BOOTSTRAP_COMPONENT + 'dropdowns/',
story: story
});
});

stories.addWithInfo('SplitButton', '', () => {
Expand All @@ -170,7 +176,7 @@ stories.addWithInfo('SplitButton', '', () => {
const props = { bsStyle, title: bsStyle, id: 'dropdown-example' };
if (bsSize) props.bsSize = bsSize;

return (
let story = (
<SplitButton {...props} onClick={action('onClick')}>
<MenuItem eventKey="1">Action</MenuItem>
<MenuItem eventKey="2">Another action</MenuItem>
Expand All @@ -181,4 +187,11 @@ stories.addWithInfo('SplitButton', '', () => {
<MenuItem eventKey="4">Separated link</MenuItem>
</SplitButton>
);

return inlineTemplate({
title: 'SplitButton',
reactBootstrapDocumentationLink:
DOCUMENTATION_URL.REACT_BOOTSTRAP_COMPONENT + 'dropdowns/',
story: story
});
});
21 changes: 0 additions & 21 deletions src/components/Chart/Chart.stories.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
import React from 'react';
import { storiesOf } from '@storybook/react';
import { defaultTemplate } from '../../../storybook/decorators/storyTemplates';

import {
areaChartAddWithInfo,
barChartAddWithInfo,
Expand All @@ -11,24 +8,6 @@ import {
} from './Stories';

const stories = storiesOf('Chart', module);
const description = (
<p>
This component is based on Patternfly Chart component. See{' '}
<a href="http://www.patternfly.org/pattern-library/data-visualization/line-chart/">
Patternfly Chart Docs
</a>{' '}
for complete Chart component documentation.
</p>
);

stories.addDecorator(
defaultTemplate({
title: 'Chart',
documentationLink:
'http://www.patternfly.org/pattern-library/data-visualization/line-chart/',
description: description
})
);

/**
* Chart stories
Expand Down
46 changes: 28 additions & 18 deletions src/components/Chart/Stories/AreaChartStory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import React from 'react';
import { AreaChart, SingleAreaChart } from '../index';
import { inlineTemplate } from '../../../../storybook/decorators/storyTemplates';
import { DOCUMENTATION_URL } from '../../../../storybook/constants';

/**
* Story constants
Expand Down Expand Up @@ -27,27 +29,35 @@ const singleAreaChartData = {
*/

const areaChartAddWithInfo = stories => {
stories.addWithInfo('Area Charts', '', () => (
<div>
<h2>Area Chart</h2>
stories.addWithInfo('Area Charts', '', () => {
let story = (
<div>
<AreaChart
id="area-chart-1"
size={{ width: 600 }}
data={areaChartData}
/>
</div>
<h2>Area Chart</h2>
<div>
<AreaChart
id="area-chart-1"
size={{ width: 600 }}
data={areaChartData}
/>
</div>

<h2>Single Area Chart</h2>
<div>
<SingleAreaChart
id="area-chart-2"
size={{ width: 600 }}
data={singleAreaChartData}
/>
<h2>Single Area Chart</h2>
<div>
<SingleAreaChart
id="area-chart-2"
size={{ width: 600 }}
data={singleAreaChartData}
/>
</div>
</div>
</div>
));
);
return inlineTemplate({
title: 'Area Charts',
documentationLink:
DOCUMENTATION_URL.PATTERNFLY_ORG_DATA_VISUALIZATION + 'area-chart/',
story: story
});
});
};

export default areaChartAddWithInfo;
Loading