vitalif
/
react-toolbox
1
0
Fork 0
Code Issues Pull Requests Releases 12 Wiki Activity

Updated Font Icon Examples. Also updated value type

old
Keren Chandran 2016-03-25 10:35:44 -04:00
parent fe9312aad0
commit 21dc421d73
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/font_icon/readme.md
View File

@ -1,6 +1,6 @@
# Font Icon
The font icon component is used to represent an icon from the [Google Material Design](https://www.google.com/design/icons/) icon font. React Toolbox does **not** provide the font icon for you. You'd need to get the icons using whatever method you want. We recommend to import the font and the associated CSS from Google Fonts as is specified [here](http://google.github.io/material-design-icons/#getting-icons).
The font icon component is used to represent an icon from the [Google Material Design](https://www.google.com/design/icons/) icon font. React Toolbox does **not** provide the font icon for you. You need to get the icons using whatever method you want. We recommend to import the font and the associated CSS from Google Fonts as is specified [here](http://google.github.io/material-design-icons/#getting-icons).
<!-- example -->
```jsx
@ -9,7 +9,7 @@ import FontIcon from 'react-toolbox/lib/font_icon';
const FontIcons = () => (
<span>
<FontIcon value='add' />
<FontIcon value='add_circle_outline' />
<FontIcon value='favorite' />
<FontIcon>star</FontIcon>
</span>
);
@ -17,8 +17,8 @@ const FontIcons = () => (
## Properties
| Name | Type | Default | Description|
| Name | Type | Default | Description|
|:-----|:-----|:-----|:-----|
| `children` | `String` | | The key string for the icon you want to be displayed.|
| `className` | `String` | | The class name to give custom styles such as sizing.|
| `value` | `String` | | The key string for the icon you want be displayed.|
| `children` | `String` | | The key string for the icon you want to be displayed.|
| `className` | `String` | `''` | The class name to give custom styles such as sizing.|
| `value` | `String` or `Element` | | The key string for the icon you want be displayed.|

2
docs/app/components/layout/main/modules/examples/font_icon_example_1.txt
View File

@ -2,7 +2,7 @@ const FontIcons = () => (
<span>
<FontIcon value='add' />
<FontIcon value='favorite' />
<FontIcon value='add-circle-outline' />
<FontIcon>star</FontIcon>
</span>
);