From 21dc421d73cfcb7bbff3c1476780c3944b601b82 Mon Sep 17 00:00:00 2001 From: Keren Chandran Date: Fri, 25 Mar 2016 10:35:44 -0400 Subject: [PATCH] Updated Font Icon Examples. Also updated value type --- components/font_icon/readme.md | 12 ++++++------ .../main/modules/examples/font_icon_example_1.txt | 2 +- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/components/font_icon/readme.md b/components/font_icon/readme.md index 13ca3b56..eb28a7b0 100644 --- a/components/font_icon/readme.md +++ b/components/font_icon/readme.md @@ -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). ```jsx @@ -9,7 +9,7 @@ import FontIcon from 'react-toolbox/lib/font_icon'; const FontIcons = () => ( - + star ); @@ -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.| diff --git a/docs/app/components/layout/main/modules/examples/font_icon_example_1.txt b/docs/app/components/layout/main/modules/examples/font_icon_example_1.txt index b6dfc9e9..dfaebaf9 100644 --- a/docs/app/components/layout/main/modules/examples/font_icon_example_1.txt +++ b/docs/app/components/layout/main/modules/examples/font_icon_example_1.txt @@ -2,7 +2,7 @@ const FontIcons = () => ( - + star );