Skip to content
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

Jump to bottom

Pane & Card (layers) documentation #155

Merged
merged 3 commits into from
Mar 8, 2018
Merged

Pane & Card (layers) documentation #155

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
472f637
added layers docs template and some optimizations
jeroenransijn Mar 8, 2018
ea8f680
pane + card docs
jeroenransijn Mar 8, 2018
f00d2dc
Merge branch 'master' into docs-layers
jeroenransijn Mar 8, 2018
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
Prev Previous commit
Next Next commit
pane + card docs
  • Loading branch information
@jeroenransijn
jeroenransijn committed Mar 8, 2018
commit ea8f68047f145642daa9ebb29ed78b10f412b8a4
3 changes: 2 additions & 1 deletion docs/src/componentRoutes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,11 @@ module.exports = [
},
{
name: 'Layers',
sidebarOverride: 'Pane & Card',
path: '/components/layers'
}
].sort((a, b) => {
// Lazy way to sort this list so I don't have
// to sing the alphabet everytime.
return b.name - a.name
return (b.sidebarOverride || b.name) - (a.sidebarOverride || a.name)
})
8 changes: 8 additions & 0 deletions docs/src/components/ComponentReadme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import PlaygroundExample from './PlaygroundExample'
export default class ComponentReadme extends PureComponent {
static propTypes = {
name: PropTypes.string,
introduction: PropTypes.node,
title: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
subTitle: PropTypes.oneOfType([PropTypes.string, PropTypes.node]),
designGuidelines: PropTypes.node,
Expand All @@ -23,6 +24,7 @@ export default class ComponentReadme extends PureComponent {
subTitle,
designGuidelines,
examples,
introduction,
appearanceOptions,
components,
...props
Expand All @@ -45,6 +47,12 @@ export default class ComponentReadme extends PureComponent {
</p>
</header>
<div>
{introduction && (
<div className="Content">
<h2 id="introduction">Introduction</h2>
{introduction}
</div>
)}
{designGuidelines && (
<div className="Content">
<h2 id="design-guidelines">Design Guidelines</h2>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/components/ComponentsSidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default class ComponentsSidebar extends PureComponent {
title: 'Components',
links: componentRoutes.map(route => {
return {
label: route.name,
label: route.sidebarOverride || route.name,
to: route.path
}
})
Expand Down
2 changes: 2 additions & 0 deletions docs/src/templates/component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export default class ComponentTemplate extends React.PureComponent {

render() {
const {
introduction,
designGuidelines,
appearanceOptions,
components,
Expand All @@ -29,6 +30,7 @@ export default class ComponentTemplate extends React.PureComponent {
title={title}
subTitle={subTitle}
name={this.props.pathContext.name}
introduction={introduction}
designGuidelines={designGuidelines}
appearanceOptions={appearanceOptions}
components={components}
Expand Down
13 changes: 13 additions & 0 deletions src/layers/docs/examples/Card-basic.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<Card
innerRef={(ref) => console.log(ref)}
elevation={2}
border='muted'
marginLeft={12}
marginY={24}
paddingTop={12}
paddingX={40}
width={120}
height={120}
cursor='pointer'
onClick={() => alert('Works just like expected')}
/>
73 changes: 73 additions & 0 deletions src/layers/docs/examples/Card-elevation-styles.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<Card clearfix>
<Card
elevation={0}
float="left"
backgroundColor="white"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 0</Text>
<Text size={300}>Flat Cards</Text>
</Card>
<Card
elevation={1}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 1</Text>
<Text size={300}>Floating Cards</Text>
</Card>
<Card
elevation={2}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 2</Text>
<Text size={300}>Popovers and Dropdowns</Text>
</Card>
<Card
elevation={3}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 3</Text>
<Text size={300}>Toasts</Text>
</Card>
<Card
elevation={4}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 4</Text>
<Text size={300}>Dialog</Text>
</Card>
</Card>
63 changes: 63 additions & 0 deletions src/layers/docs/examples/Pane-appearances.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<Pane clearfix>
<Pane
appearance="tint1"
float="left"
width={120}
height={120}
margin={24}
display="flex"
alignItems="center"
justifyContent="center"
>
<Text color="inherit">tint1</Text>
</Pane>
<Pane
appearance="tint2"
float="left"
width={120}
height={120}
margin={24}
display="flex"
alignItems="center"
justifyContent="center"
>
<Text color="inherit">tint1</Text>
</Pane>
<Pane
appearance="tint3"
float="left"
width={120}
height={120}
margin={24}
display="flex"
alignItems="center"
justifyContent="center"
>
<Text color="inherit">tint1</Text>
</Pane>
<Pane
appearance="dark"
color="white"
float="left"
width={120}
height={120}
margin={24}
display="flex"
alignItems="center"
justifyContent="center"
>
<Text color="inherit">dark</Text>
</Pane>
<Pane
appearance="selected"
float="left"
width={120}
height={120}
margin={24}
display="flex"
alignItems="center"
justifyContent="center"
>
<Text color="inherit">selected</Text>
</Pane>
</Pane>
14 changes: 14 additions & 0 deletions src/layers/docs/examples/Pane-basic.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<Pane
is="section"
innerRef={(ref) => console.log(ref)}
appearance="tint2"
border="muted"
marginLeft={12}
marginY={24}
paddingTop={12}
paddingX={40}
width={120}
height={120}
cursor="help"
onClick={() => alert('Works just like expected')}
/>
14 changes: 14 additions & 0 deletions src/layers/docs/examples/Pane-borders.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<div>
<Pane borderTop width={120} height={120} display='flex' justifyContent='center' alignItems='center'>
<Text>borderTop</Text>
</Pane>
<Pane borderRight width={120} height={120} display='flex' justifyContent='center' alignItems='center'>
<Text>borderRight</Text>
</Pane>
<Pane borderBottom width={120} height={120} display='flex' justifyContent='center' alignItems='center'>
<Text>borderBottom</Text>
</Pane>
<Pane borderLeft width={120} height={120} display='flex' justifyContent='center' alignItems='center'>
<Text>borderLeft</Text>
</Pane>
</div>
73 changes: 73 additions & 0 deletions src/layers/docs/examples/Pane-elevation-styles.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<Pane clearfix>
<Pane
elevation={0}
float="left"
backgroundColor="white"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 0</Text>
<Text size={300}>Flat Panes</Text>
</Pane>
<Pane
elevation={1}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 1</Text>
<Text size={300}>Floating Panes</Text>
</Pane>
<Pane
elevation={2}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 2</Text>
<Text size={300}>Popovers and Dropdowns</Text>
</Pane>
<Pane
elevation={3}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 3</Text>
<Text size={300}>Toasts</Text>
</Pane>
<Pane
elevation={4}
float="left"
width={200}
height={120}
margin={24}
display="flex"
justifyContent="center"
alignItems="center"
flexDirection="column"
>
<Text>Elevation 4</Text>
<Text size={300}>Dialog</Text>
</Pane>
</Pane>
Loading