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

Update readme.md #199

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

Update readme.md #199

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
67 changes: 34 additions & 33 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,39 +63,40 @@ class Example extends Component {

## Properties

name | description | type | default
:----------------- |:--------------------------------------------- | --------:|:------------------
label | Text field label text | String | -
error | Text field error text | String | -
animationDuration | Text field animation duration in ms | Number | 225
fontSize | Text field font size | Number | 16
labelFontSize | Text field label font size | Number | 12
baseColor | Text field base color | String | rgba(0, 0, 0, .38)
textColor | Text field text color | String | rgba(0, 0, 0, .87)
itemColor | Dropdown item text color (inactive item) | String | rgba(0, 0, 0, .54)
selectedItemColor | Dropdown item text color (active item) | String | rgba(0, 0, 0, .87)
disabledItemColor | Dropdown item text color (disabled item) | String | rgba(0, 0, 0, .38)
dropdownPosition | Dropdown position (dynamic if undefined) | Number | -
itemCount | Dropdown visible item count | Number | 4
itemPadding | Dropdown item vertical padding | Number | 8
itemTextStyle | Dropdown item text styles | Object | -
dropdownOffset | Dropdown offset | Object | { top: 32, left: 0 }
dropdownMargins | Dropdown margins | Object | { min: 8, max: 16 }
data | Dropdown item data | Array | []
value | Selected value | String | -
containerStyle | Styles for container view | Object | -
overlayStyle | Styles for overlay view | Object | -
pickerStyle | Styles for item picker view | Object | -
shadeOpacity | Shade opacity for dropdown items | Number | 0.12
rippleOpacity | Opacity for ripple effect | Number | 0.54
rippleInsets | Insets for ripple on base component | Object | { top: 16, bottom: -8 }
rippleCentered | Ripple on base component should be centered | Boolean | false
renderBase | Render base component | Function | -
renderAccessory | Render text field accessory | Function | -
valueExtractor | Extract value from item (args: item, index) | Function | ({ value }) => value
labelExtractor | Extract label from item (args: item, index) | Function | ({ label }) => label
propsExtractor | Extract props from item (args: item, index) | Function | () => null
onChangeText | Selection callback (args: value, index, data) | Function | -
name | description | type | default
:------------------ |:--------------------------------------------- | --------:|:------------------
label | Text field label text | String | -
error | Text field error text | String | -
animationDuration | Text field animation duration in ms | Number | 225
fontSize | Text field font size | Number | 16
labelFontSize | Text field label font size | Number | 12
baseColor | Text field base color | String | rgba(0, 0, 0, .38)
textColor | Text field text color | String | rgba(0, 0, 0, .87)
itemColor | Dropdown item text color (inactive item) | String | rgba(0, 0, 0, .54)
selectedItemColor | Dropdown item text color (active item) | String | rgba(0, 0, 0, .87)
disabledItemColor | Dropdown item text color (disabled item) | String | rgba(0, 0, 0, .38)
dropdownPosition | Dropdown position (dynamic if undefined) | Number | -
itemCount | Dropdown visible item count | Number | 4
itemPadding | Dropdown item vertical padding | Number | 8
itemTextStyle | Dropdown item text styles | Object | -
dropdownOffset | Dropdown offset | Object | { top: 32, left: 0 }
dropdownMargins | Dropdown margins | Object | { min: 8, max: 16 }
data | Dropdown item data | Array | []
value | Selected value | String | -
containerStyle | Styles for container view | Object | -
overlayStyle | Styles for overlay view | Object | -
pickerStyle | Styles for item picker view | Object | -
inputContainerStyle | Styles for input container | Object | -
shadeOpacity | Shade opacity for dropdown items | Number | 0.12
rippleOpacity | Opacity for ripple effect | Number | 0.54
rippleInsets | Insets for ripple on base component | Object | { top: 16, bottom: -8 }
rippleCentered | Ripple on base component should be centered | Boolean | false
renderBase | Render base component | Function | -
renderAccessory | Render text field accessory | Function | -
valueExtractor | Extract value from item (args: item, index) | Function | ({ value }) => value
labelExtractor | Extract label from item (args: item, index) | Function | ({ label }) => label
propsExtractor | Extract props from item (args: item, index) | Function | () => null
onChangeText | Selection callback (args: value, index, data) | Function | -

Other [TextField][textfield], [TextInput][textinput] and [TouchableWithoutFeedback][touchable] properties will also work

Expand Down