Skip to content

Components/input: Added documentation for various missing props #21

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

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

Components/input: Added documentation for various missing props #21

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
9 changes: 8 additions & 1 deletion components/input.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,19 @@ Code example:
| borderless | bool | false | Sets the Input's borderWidth to 0 |
| viewPass | bool | false | Adds the functionality of pressing a button in order to see your password's letters |
| icon | string | null | Choose your Icon's name from Expo's icon list |
| iconSize | number | theme.SIZES.BASE * 1.0625 | Prop to pass size for icon |
| iconColor | string | null | Changes the Icon's color |
| iconContent | React.Component | null | Prop which takes a rendered component, which is used to render custom content in place of the default Icon component |
| family | string | null | Choose your Icon's family from the same list |
| color | string | null | Sets the Input's text color. |
| help | string | null | Sets a helper line for more information regarding your input. |
| left | bool | true | Sets the Icon to the left of the Input. |
| right | bool | false | Sets the Icon to the right of the Input. |
| topHelp | bool | true | Sets the helper line above the input. |
| bottomHelp | bool | false | Sets the helper line below the input. |

| textInputStyle | object | null | Custom style object for the react-native TextInput |
| labelStyles | object | {} | Custom style object for the label |
| helpStyles | object | {} | Custom style object for the help text |
| onRef | function | null | Function which can be used to access ref of the inner TextInput. Function is called with ref as argument ((ref) => {}) |
| error | boolean | false | If true, changes color of border and Icon to theme.COLORS.DANGER |
| styles | object | {} | Object that can be used to pass custom styles to various parts of the Input. Possible keys are: **inputStyle**, **inputContainer**, **rounded**, **borderless**, **inputView**, **inputIcon**, **inputText**, **label**, **helpText**. These styles are overwritten by any styles that are passed in a custom prop for any part of Input. For eg. *styles.label* will be overwritten by *labelStyles*, if both have an common properties |