-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(docz-example-flow): add example folder
- Loading branch information
1 parent
5a83610
commit 27002d8
Showing
6 changed files
with
142 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| { | ||
| "presets": [ | ||
| "@babel/preset-flow" | ||
| ], | ||
| "plugins": [ | ||
| "emotion" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| { | ||
| "name": "docz-example-flow", | ||
| "version": "0.0.0", | ||
| "license": "MIT", | ||
| "scripts": { | ||
| "dev": "docz dev", | ||
| "build": "docz build" | ||
| }, | ||
| "dependencies": { | ||
| "@babel/preset-flow": "^7.0.0-beta.49", | ||
| "docz": "^0.0.1", | ||
| "emotion": "^9.1.3", | ||
| "prop-types": "^15.6.1", | ||
| "react": "^16.4.0", | ||
| "react-dom": "^16.4.0", | ||
| "react-emotion": "^9.1.3" | ||
| }, | ||
| "devDependencies": { | ||
| "babel-plugin-emotion": "^9.0.1", | ||
| "flow-bin": "^0.73.0" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| // @flow | ||
|
|
||
| import React, { Fragment } from 'react' | ||
| import styled from 'react-emotion' | ||
| import t from 'prop-types' | ||
|
|
||
| const kinds = { | ||
| info: '#5352ED', | ||
| positive: '#2ED573', | ||
| negative: '#FF4757', | ||
| warning: '#FFA502', | ||
| } | ||
|
|
||
| type Kind = 'info' | 'positive' | 'negative' | 'warning' | ||
|
|
||
| type AlertProps = { | ||
| /** | ||
| * Set this to change alert kind | ||
| */ | ||
| kind: Kind | ||
| } | ||
|
|
||
| const AlertStyled = styled('div')` | ||
| padding: 15px 20px; | ||
| background: white; | ||
| border-radius: 3px; | ||
| color: white; | ||
| background: ${({ kind = 'info' }) => kinds[kind]}; | ||
| ` | ||
|
|
||
| const Alert = ({ kind = 'info', ...props }: AlertProps) => ( | ||
| <AlertStyled {...props} kind={kind} /> | ||
| ) | ||
|
|
||
| export default Alert |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| --- | ||
| name: Alert | ||
| menu: Components | ||
| --- | ||
|
|
||
| import { Playground, PropsTable } from 'docz' | ||
| import Alert from './Alert' | ||
|
|
||
| # Alert | ||
|
|
||
| <PropsTable of={Alert} /> | ||
|
|
||
| ## Basic usage | ||
|
|
||
| <Playground> | ||
| <Alert>Some message</Alert> | ||
| </Playground> | ||
|
|
||
| ## Using different kinds | ||
|
|
||
| <Playground> | ||
| <Alert kind="info">Some message</Alert> | ||
| <Alert kind="positive">Some message</Alert> | ||
| <Alert kind="negative">Some message</Alert> | ||
| <Alert kind="warning">Some message</Alert> | ||
| </Playground> | ||
|
|
||
| ## Use with children as a function | ||
|
|
||
| <Playground> | ||
| {() => { | ||
| const message = 'Hello world' | ||
|
|
||
| return ( | ||
| <Alert>{message}</Alert> | ||
| ) | ||
| }} | ||
| </Playground> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| --- | ||
| name: Getting Started | ||
| route: / | ||
| order: 1 | ||
| --- | ||
|
|
||
| # Getting Started | ||
|
|
||
| A design system can help establish a common vocabulary between everyone in an organization. That’s why I’ve spent a great deal of time coming up with structure and naming for Vue Design System that would make sense. To start opening it up, let’s go through each layer in detail and what the terms mean: | ||
|
|
||
| - *Principles* are the foundation of the whole system. They form the basis of a good product and help the team with decision making. They are there to guide you and your team when working with the myriad parts of the system and help you do better and more informed decisions. | ||
| - *Design* Tokens are the atoms of the system as Salesforce describes them. In Vue Design System they are used instead of hard coded values to ensure a better consistency across any platform. | ||
| - *Elements* utilize decisions made on the token level. A simple example of an element would be a button, a link, or an input. Anything that cannot be broken down further. I use the name ‘element’ since everything in Vue and React world is nowadays ‘a component.’ Using that term for anything else would be confusing. | ||
| - *Patterns* are UI Patterns that fall on the more complex side of the spectrum. So for example things like a date picker, a data table, or a visualization. Patterns utilize both elements and tokens. If you wonder whether something should be called an element or a pattern, ask yourself this question: “Can this be broken down into smaller pieces?” If the answer is yes, it should most likely be a pattern in Vue Design System. | ||
| - *Templates* exist to document the layout and structure of a section. I am not calling these pages since semantically that would be incorrect. While they can be pages, that’s not their only functionality. Templates consist of the three things mentioned above: tokens, elements, and patterns. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters