Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Components/icon: Added documentation for medium and large props #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Components/icon: Added documentation for medium and large props #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions components/icon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Icon
Icons are used as a visual indicator to describe an action the user could take. That little Facebook icon never looked better.
Icons are used as a visual indicator to describe an action the user could take. That little Facebook icon never looked better.

### Usage
Imports:
Expand All @@ -20,6 +20,8 @@ Simple example:
| family | string | null | Choose your Icon's family from the same list |
| size | number | theme.SIZES.BASE | This sets your Icon's size |
| color | string | theme.COLORS.BLACK | This sets your Icon's color |
| medium | boolean | false | Sets icon size to theme.SIZES.ICON_MEDIUM. Overridden by size prop. |
| large | boolean | false | Sets icon size to theme.SIZES.ICON_LARGE. Overridden by medium & size prop. |


*We're grateful to use the icon sets from [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons). You can find the full list of icons they've prepared for React Native [here](https://oblador.github.io/react-native-vector-icons/).*
*We're grateful to use the icon sets from [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons). You can find the full list of icons they've prepared for React Native [here](https://oblador.github.io/react-native-vector-icons/).*