Add avatar to docs
Javi Velasco
parent
cdd7d773be
commit
b249d58313
|
|
@ -0,0 +1,34 @@
|
|||
# Avatar
|
||||
|
||||
Avatars can be used to represent people. For personal avatars, offer personalization options. As users may choose not to personalize an avatar, provide delightful defaults. When used with a specific logo, avatars can also be used to represent brand
|
||||
|
||||
<!-- example -->
|
||||
```jsx
|
||||
import Avatar from 'react-toolbox/lib/avatar';
|
||||
|
||||
const GithubIcon = () => (
|
||||
<svg viewBox="0 0 284 277">
|
||||
<g><path d="M141.888675,0.0234927555 C63.5359948,0.0234927555 0,63.5477395 0,141.912168 C0,204.6023 40.6554239,257.788232 97.0321356,276.549924 C104.12328,277.86336 106.726656,273.471926 106.726656,269.724287 C106.726656,266.340838 106.595077,255.16371 106.533987,243.307542 C67.0604204,251.890693 58.7310279,226.56652 58.7310279,226.56652 C52.2766299,210.166193 42.9768456,205.805304 42.9768456,205.805304 C30.1032937,196.998939 43.9472374,197.17986 43.9472374,197.17986 C58.1953153,198.180797 65.6976425,211.801527 65.6976425,211.801527 C78.35268,233.493192 98.8906827,227.222064 106.987463,223.596605 C108.260955,214.426049 111.938106,208.166669 115.995895,204.623447 C84.4804813,201.035582 51.3508808,188.869264 51.3508808,134.501475 C51.3508808,119.01045 56.8936274,106.353063 65.9701981,96.4165325 C64.4969882,92.842765 59.6403297,78.411417 67.3447241,58.8673023 C67.3447241,58.8673023 79.2596322,55.0538738 106.374213,73.4114319 C117.692318,70.2676443 129.83044,68.6910512 141.888675,68.63701 C153.94691,68.6910512 166.09443,70.2676443 177.433682,73.4114319 C204.515368,55.0538738 216.413829,58.8673023 216.413829,58.8673023 C224.13702,78.411417 219.278012,92.842765 217.804802,96.4165325 C226.902519,106.353063 232.407672,119.01045 232.407672,134.501475 C232.407672,188.998493 199.214632,200.997988 167.619331,204.510665 C172.708602,208.913848 177.243363,217.54869 177.243363,230.786433 C177.243363,249.771339 177.078889,265.050898 177.078889,269.724287 C177.078889,273.500121 179.632923,277.92445 186.825101,276.531127 C243.171268,257.748288 283.775,204.581154 283.775,141.912168 C283.775,63.5477395 220.248404,0.0234927555 141.888675,0.0234927555" /></g>
|
||||
</svg>
|
||||
);
|
||||
|
||||
const AvatarTest = () => (
|
||||
<div>
|
||||
<Avatar style={{backgroundColor: 'deepskyblue'}} icon="folder" />
|
||||
<Avatar icon={<GithubIcon />}/>
|
||||
<Avatar><img src="https://placeimg.com/80/80/animals"/></Avatar>
|
||||
<Avatar title="Javier" img="https://placeimg.com/80/80/animals"/>
|
||||
<Avatar style={{backgroundColor: 'yellowgreen'}}><GithubIcon /></Avatar>
|
||||
</div>
|
||||
);
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Default | Description|
|
||||
|:-----|:-----|:-----|:-----|
|
||||
| `children` | `Node` | | Children for the avatar. You can pass an SVG for a custom icon or, for example, an image.|
|
||||
| `className` | `String` | `''` | Set a class to style the Component.|
|
||||
| `icon` | `String` or `Element` | | A key to identify an Icon from Material Design Icons or a custom Icon Element.|
|
||||
| `image` | `String` or `Element` | | An image source or an image element. |
|
||||
| `title` | `String` | `false` | A title for the image. If there is image, the first letter will be displayed as avatar. |
|
||||
|
|
@ -2,6 +2,7 @@ import './utils/polyfills'; // Import polyfills for IE11
|
|||
export App from './app';
|
||||
export AppBar from './app_bar';
|
||||
export Autocomplete from './autocomplete';
|
||||
export Avatar from './avatar';
|
||||
export Button from './button/Button';
|
||||
export IconButton from './button/IconButton';
|
||||
export * from './card';
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
// Documentation files
|
||||
import AppBar from 'react-toolbox/app_bar/readme';
|
||||
import Autocomplete from 'react-toolbox/autocomplete/readme';
|
||||
import Avatar from 'react-toolbox/avatar/readme';
|
||||
import Button from 'react-toolbox/button/readme';
|
||||
import Card from 'react-toolbox/card/readme';
|
||||
import Checkbox from 'react-toolbox/checkbox/readme';
|
||||
|
|
@ -25,8 +26,9 @@ import Tooltip from 'react-toolbox/tooltip/readme';
|
|||
import TimePicker from 'react-toolbox/time_picker/readme';
|
||||
|
||||
// Examples for the Playground
|
||||
import ButtonExample1 from './examples/button_example_1.txt';
|
||||
import AutocompleteExample1 from './examples/autocomplete_example_1.txt';
|
||||
import AvatarExample1 from './examples/avatar_example_1.txt';
|
||||
import ButtonExample1 from './examples/button_example_1.txt';
|
||||
import CardExample1 from './examples/card_example_1.txt';
|
||||
import CheckboxExample1 from './examples/checkbox_example_1.txt';
|
||||
import DatePickerExample1 from './examples/datepicker_example_1.txt';
|
||||
|
|
@ -61,6 +63,12 @@ export default {
|
|||
path: '/components/autocomplete',
|
||||
examples: [AutocompleteExample1]
|
||||
},
|
||||
avatar: {
|
||||
name: 'Avatar',
|
||||
docs: Avatar,
|
||||
path: '/components/avatar',
|
||||
examples: [AvatarExample1]
|
||||
},
|
||||
button: {
|
||||
name: 'Button',
|
||||
docs: Button,
|
||||
|
|
|
|||
|
|
@ -0,0 +1,17 @@
|
|||
const GithubIcon = () => (
|
||||
<svg viewBox="0 0 284 277">
|
||||
<g><path d="M141.888675,0.0234927555 C63.5359948,0.0234927555 0,63.5477395 0,141.912168 C0,204.6023 40.6554239,257.788232 97.0321356,276.549924 C104.12328,277.86336 106.726656,273.471926 106.726656,269.724287 C106.726656,266.340838 106.595077,255.16371 106.533987,243.307542 C67.0604204,251.890693 58.7310279,226.56652 58.7310279,226.56652 C52.2766299,210.166193 42.9768456,205.805304 42.9768456,205.805304 C30.1032937,196.998939 43.9472374,197.17986 43.9472374,197.17986 C58.1953153,198.180797 65.6976425,211.801527 65.6976425,211.801527 C78.35268,233.493192 98.8906827,227.222064 106.987463,223.596605 C108.260955,214.426049 111.938106,208.166669 115.995895,204.623447 C84.4804813,201.035582 51.3508808,188.869264 51.3508808,134.501475 C51.3508808,119.01045 56.8936274,106.353063 65.9701981,96.4165325 C64.4969882,92.842765 59.6403297,78.411417 67.3447241,58.8673023 C67.3447241,58.8673023 79.2596322,55.0538738 106.374213,73.4114319 C117.692318,70.2676443 129.83044,68.6910512 141.888675,68.63701 C153.94691,68.6910512 166.09443,70.2676443 177.433682,73.4114319 C204.515368,55.0538738 216.413829,58.8673023 216.413829,58.8673023 C224.13702,78.411417 219.278012,92.842765 217.804802,96.4165325 C226.902519,106.353063 232.407672,119.01045 232.407672,134.501475 C232.407672,188.998493 199.214632,200.997988 167.619331,204.510665 C172.708602,208.913848 177.243363,217.54869 177.243363,230.786433 C177.243363,249.771339 177.078889,265.050898 177.078889,269.724287 C177.078889,273.500121 179.632923,277.92445 186.825101,276.531127 C243.171268,257.748288 283.775,204.581154 283.775,141.912168 C283.775,63.5477395 220.248404,0.0234927555 141.888675,0.0234927555" /></g>
|
||||
</svg>
|
||||
);
|
||||
|
||||
const AvatarTest = () => (
|
||||
<div>
|
||||
<Avatar style={{backgroundColor: 'deepskyblue'}} icon="folder" />
|
||||
<Avatar icon={<GithubIcon />}/>
|
||||
<Avatar><img src="https://placeimg.com/80/80/animals"/></Avatar>
|
||||
<Avatar title="Javier" img="https://placeimg.com/80/80/animals"/>
|
||||
<Avatar style={{backgroundColor: 'yellowgreen'}}><GithubIcon /></Avatar>
|
||||
</div>
|
||||
);
|
||||
|
||||
return <AvatarTest />
|
||||
Loading…
Reference in New Issue