Skip to content

Commit

Permalink
docs(colors): improve styling (#37)
Browse files Browse the repository at this point in the history
  • Loading branch information
poteirard committed Jun 21, 2019
1 parent ae12f12 commit 02a186f
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 6 deletions.
20 changes: 15 additions & 5 deletions src/content/Colors/Colors.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,30 @@ You can modify the Colors component with a js object of colors. See props & meth

### Base Colors

<Colors defaultSection='base' />
```js noeditor
<Colors defaultSection="base" />
```

### Primary Colors

<Colors defaultSection='primary' />
```js noeditor
<Colors defaultSection="primary" />
```

### Extended Colors

<Colors defaultSection='extended' />
```js noeditor
<Colors defaultSection="extended" />
```

### Neutral Colors

<Colors defaultSection='neutral' />
```js noeditor
<Colors defaultSection="neutral" />
```

### Alert Colors

<Colors defaultSection='alert' />
```js noeditor
<Colors defaultSection="alert" />
```
6 changes: 5 additions & 1 deletion src/content/Colors/Colors.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,15 @@ export interface IColorsProps {
* Object with the colors for testing purposes.
* The key must be the name of the color and the value the color itself as in css. (e.g: { red: '#ff0000' }).
* @default defaultColors of Zopa
* @ignore
*/
colors?: {
[colorName: string]: string;
};
/** section of the default colors */
/**
* section of the default colors
* @ignore
*/
defaultSection: 'base' | 'primary' | 'extended' | 'neutral' | 'alert';
}

Expand Down

0 comments on commit 02a186f

Please sign in to comment.