A foundational component for inputting text into the app via a keyboard. Props provide configurability for several features, such as auto-correction, auto-capitalization, placeholder text, and different keyboard types, such as a numeric keypad.
The simplest use case is to plop down a TextInput
and subscribe to the onChangeText
events to read the user input. There are also other events, such as onSubmitEditing
and onFocus
that can be subscribed to. A simple example:
1 2 3 4 5 | <TextInput style={{height: 40, borderColor: 'gray' , borderWidth: 1}} onChangeText={(text) => this .setState({text})} value={ this .state.text} /> |
Note that some props are only available with multiline={true/false}
. Additionally, border styles that apply to only one side of the element (e.g., borderBottomColor
, borderLeftWidth
, etc.) will not be applied if multiline=false
. To achieve the same effect, you can wrap your TextInput
in a View
:
1 2 3 | <View style={{ borderBottomColor: '#000000' , borderBottomWidth: 1, }}> <TextInput {...props} /> </View> |
Props
View props...
autoCapitalize enum('none', 'sentences', 'words', 'characters')
Can tell TextInput to automatically capitalize certain characters.
- characters: all characters,
- words: first letter of each word
- sentences: first letter of each sentence (default)
- none: don't auto capitalize anything
autoCorrect bool
If false, disables auto-correct. The default value is true.
autoFocus bool
If true, focuses the input on componentDidMount. The default value is false.
blurOnSubmit bool
If true, the text field will blur when submitted. The default value is true for single-line fields and false for multiline fields. Note that for multiline fields, setting blurOnSubmit to true means that pressing return will blur the field and trigger the onSubmitEditing event instead of inserting a newline into the field.
defaultValue string
Provides an initial value that will change when the user starts typing. Useful for simple use-cases where you don't want to deal with listening to events and updating the value prop to keep the controlled state in sync.
editable bool
If false, text is not editable. The default value is true.
keyboardType enum('default', 'email-address', 'numeric', 'phone-pad', 'ascii-capable', 'numbers-and-punctuation', 'url', 'number-pad', 'name-phone-pad', 'decimal-pad', 'twitter', 'web-search')
Determines which keyboard to open, e.g.numeric
.
The following values work across platforms:
- default
- numeric
- email-address
maxLength number
Limits the maximum number of characters that can be entered. Use this instead of implementing the logic in JS to avoid flicker.
multiline bool
If true, the text input can be multiple lines. The default value is false.
onBlur function
Callback that is called when the text input is blurred
onChange function
Callback that is called when the text input's text changes.
onChangeText function
Callback that is called when the text input's text changes. Changed text is passed as an argument to the callback handler.
onEndEditing function
Callback that is called when text input ends.
onFocus function
Callback that is called when the text input is focused
onLayout function
Invoked on mount and layout changes with {x, y, width, height}
.
onSelectionChange function
Callback that is called when the text input selection is changed
onSubmitEditing function
Callback that is called when the text input's submit button is pressed. Invalid if multiline={true} is specified.
placeholder string
The string that will be rendered before text input has been entered
placeholderTextColor string
The text color of the placeholder string
returnKeyType enum('done', 'go', 'next', 'search', 'send', 'none', 'previous', 'default', 'emergency-call', 'google', 'join', 'route', 'yahoo')
Determines how the return key should look. On Android you can also use returnKeyLabel
.
The following values work across platforms:
- done
- go
- next
- search
- send
The following values work on Android only:
- none
- previous
The following values work on iOS only:
- default
- emergency-call
- join
- route
- yahoo
secureTextEntry bool
If true, the text input obscures the text entered so that sensitive text like passwords stay secure. The default value is false.
selectTextOnFocus bool
If true, all text will automatically be selected on focus
selectionColor string
The highlight (and cursor on ios) color of the text input
style Text#style
Styles
value string
The value to show for the text input. TextInput is a controlled component, which means the native value will be forced to match this value prop if provided. For most uses this works great, but in some cases this may cause flickering - one common cause is preventing edits by keeping value the same. In addition to simply setting the same value, either set editable={false}
, or set/update maxLength
to prevent unwanted edits without flicker.
androidnumberOfLines number
Sets the number of lines for a TextInput. Use it with multiline set to true to be able to fill the lines.
androidreturnKeyLabel string
Sets the return key to the label. Use it instead of returnKeyType
.
androidunderlineColorAndroid string
The color of the textInput underline.
iosclearButtonMode enum('never', 'while-editing', 'unless-editing', 'always')
When the clear button should appear on the right side of the text view
iosclearTextOnFocus bool
If true, clears the text field automatically when editing begins
iosenablesReturnKeyAutomatically bool
If true, the keyboard disables the return key when there is no text and automatically enables it when there is text. The default value is false.
ioskeyboardAppearance enum('default', 'light', 'dark')
Determines the color of the keyboard.
iosonKeyPress function
Callback that is called when a key is pressed. Pressed key value is passed as an argument to the callback handler. Fires before onChange callbacks.
iosselectionState DocumentSelectionState
See DocumentSelectionState.js, some state that is responsible for maintaining selection information for a document
Methods
isFocused(): boolean
Returns if the input is currently focused.
clear()
Removes all text from the input.
Examples
IOS |
Edit on GitHub |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 | 'use strict' ; var React = require( 'react' ); var ReactNative = require( 'react-native' ); var { Text, TextInput, View, StyleSheet, } = ReactNative; var WithLabel = React.createClass({ render: function () { return ( <View style={styles.labelContainer}> <View style={styles.label}> <Text>{ this .props.label}</Text> </View> { this .props.children} </View> ); }, }); var TextEventsExample = React.createClass({ getInitialState: function () { return { curText: '<No Event>' , prevText: '<No Event>' , prev2Text: '<No Event>' , prev3Text: '<No Event>' , }; }, updateText: function (text) { this .setState((state) => { return { curText: text, prevText: state.curText, prev2Text: state.prevText, prev3Text: state.prev2Text, }; }); }, render: function () { return ( <View> <TextInput autoCapitalize= "none" placeholder= "Enter text to see events" autoCorrect={ false } onFocus={() => this .updateText( 'onFocus' )} onBlur={() => this .updateText( 'onBlur' )} onChange={(event) => this .updateText( 'onChange text: ' + event.nativeEvent.text )} onEndEditing={(event) => this .updateText( 'onEndEditing text: ' + event.nativeEvent.text )} onSubmitEditing={(event) => this .updateText( 'onSubmitEditing text: ' + event.nativeEvent.text )} onSelectionChange={(event) => this .updateText( 'onSelectionChange range: ' + event.nativeEvent.selection.start + ',' + event.nativeEvent.selection.end )} onKeyPress={(event) => { this .updateText( 'onKeyPress key: ' + event.nativeEvent.key); }} style={styles. default } /> <Text style={styles.eventLabel}> { this .state.curText}{ '\n' } (prev: { this .state.prevText}){ '\n' } (prev2: { this .state.prev2Text}){ '\n' } (prev3: { this .state.prev3Text}) </Text> </View> ); } }); class AutoExpandingTextInput extends React.Component { state: any; constructor(props) { super (props); this .state = {text: '' , height: 0}; } render() { return ( <TextInput {... this .props} multiline={ true } onChange={(event) => { this .setState({ text: event.nativeEvent.text, height: event.nativeEvent.contentSize.height, }); }} style={[styles. default , {height: Math.max(35, this .state.height)}]} value={ this .state.text} /> ); } } class RewriteExample extends React.Component { state: any; constructor(props) { super (props); this .state = {text: '' }; } render() { var limit = 20; var remainder = limit - this .state.text.length; var remainderColor = remainder > 5 ? 'blue' : 'red' ; return ( <View style={styles.rewriteContainer}> <TextInput multiline={ false } maxLength={limit} onChangeText={(text) => { text = text.replace(/ /g, '_' ); this .setState({text}); }} style={styles. default } value={ this .state.text} /> <Text style={[styles.remainder, {color: remainderColor}]}> {remainder} </Text> </View> ); } } class RewriteExampleInvalidCharacters extends React.Component { state: any; constructor(props) { super (props); this .state = {text: '' }; } render() { return ( <View style={styles.rewriteContainer}> <TextInput multiline={ false } onChangeText={(text) => { this .setState({text: text.replace(/\s/g, '' )}); }} style={styles. default } value={ this .state.text} /> </View> ); } } class TokenizedTextExample extends React.Component { state: any; constructor(props) { super (props); this .state = {text: 'Hello #World' }; } render() { //define delimiter let delimiter = /\s+/; //split string let _text = this .state.text; let token, index, parts = []; while (_text) { delimiter.lastIndex = 0; token = delimiter.exec(_text); if (token === null ) { break ; } index = token.index; if (token[0].length === 0) { index = 1; } parts.push(_text.substr(0, index)); parts.push(token[0]); index = index + token[0].length; _text = _text.slice(index); } parts.push(_text); //highlight hashtags parts = parts.map((text) => { if (/^ #/.test(text)) { return <Text key={text} style={styles.hashtag}>{text}</Text>; } else { return text; } }); return ( <View> <TextInput multiline={ true } style={styles.multiline} onChangeText={(text) => { this .setState({text}); }}> <Text>{parts}</Text> </TextInput> </View> ); } } var BlurOnSubmitExample = React.createClass({ focusNextField(nextField) { this .refs[nextField].focus(); }, render: function () { return ( <View> <TextInput ref= "1" style={styles. default } placeholder= "blurOnSubmit = false" returnKeyType= "next" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '2' )} /> <TextInput ref= "2" style={styles. default } keyboardType= "email-address" placeholder= "blurOnSubmit = false" returnKeyType= "next" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '3' )} /> <TextInput ref= "3" style={styles. default } keyboardType= "url" placeholder= "blurOnSubmit = false" returnKeyType= "next" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '4' )} /> <TextInput ref= "4" style={styles. default } keyboardType= "numeric" placeholder= "blurOnSubmit = false" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '5' )} /> <TextInput ref= "5" style={styles. default } keyboardType= "numbers-and-punctuation" placeholder= "blurOnSubmit = true" returnKeyType= "done" /> </View> ); } }); var styles = StyleSheet.create({ page: { paddingBottom: 300, }, default : { height: 26, borderWidth: 0.5, borderColor: '#0f0f0f' , flex: 1, fontSize: 13, padding: 4, }, multiline: { borderWidth: 0.5, borderColor: '#0f0f0f' , flex: 1, fontSize: 13, height: 50, padding: 4, marginBottom: 4, }, multilineWithFontStyles: { color: 'blue' , fontWeight: 'bold' , fontSize: 18, fontFamily: 'Cochin' , height: 60, }, multilineChild: { width: 50, height: 40, position: 'absolute' , right: 5, backgroundColor: 'red' , }, eventLabel: { margin: 3, fontSize: 12, }, labelContainer: { flexDirection: 'row' , marginVertical: 2, flex: 1, }, label: { width: 115, alignItems: 'flex-end' , marginRight: 10, paddingTop: 2, }, rewriteContainer: { flexDirection: 'row' , alignItems: 'center' , }, remainder: { textAlign: 'right' , width: 24, }, hashtag: { color: 'blue' , fontWeight: 'bold' , }, }); exports.displayName = (undefined: ?string); exports.title = '<TextInput>' ; exports.description = 'Single and multi-line text inputs.' ; exports.examples = [ { title: 'Auto-focus' , render: function () { return ( <TextInput autoFocus={ true } style={styles. default } accessibilityLabel= "I am the accessibility label for text input" /> ); } }, { title: "Live Re-Write (<sp> -> '_') + maxLength" , render: function () { return <RewriteExample />; } }, { title: 'Live Re-Write (no spaces allowed)' , render: function () { return <RewriteExampleInvalidCharacters />; } }, { title: 'Auto-capitalize' , render: function () { return ( <View> <WithLabel label= "none" > <TextInput autoCapitalize= "none" style={styles. default } /> </WithLabel> <WithLabel label= "sentences" > <TextInput autoCapitalize= "sentences" style={styles. default } /> </WithLabel> <WithLabel label= "words" > <TextInput autoCapitalize= "words" style={styles. default } /> </WithLabel> <WithLabel label= "characters" > <TextInput autoCapitalize= "characters" style={styles. default } /> </WithLabel> </View> ); } }, { title: 'Auto-correct' , render: function () { return ( <View> <WithLabel label= "true" > <TextInput autoCorrect={ true } style={styles. default } /> </WithLabel> <WithLabel label= "false" > <TextInput autoCorrect={ false } style={styles. default } /> </WithLabel> </View> ); } }, { title: 'Keyboard types' , render: function () { var keyboardTypes = [ 'default' , 'ascii-capable' , 'numbers-and-punctuation' , 'url' , 'number-pad' , 'phone-pad' , 'name-phone-pad' , 'email-address' , 'decimal-pad' , 'twitter' , 'web-search' , 'numeric' , ]; var examples = keyboardTypes.map((type) => { return ( <WithLabel key={type} label={type}> <TextInput keyboardType={type} style={styles. default } /> </WithLabel> ); }); return <View>{examples}</View>; } }, { title: 'Keyboard appearance' , render: function () { var keyboardAppearance = [ 'default' , 'light' , 'dark' , ]; var examples = keyboardAppearance.map((type) => { return ( <WithLabel key={type} label={type}> <TextInput keyboardAppearance={type} style={styles. default } /> </WithLabel> ); }); return <View>{examples}</View>; } }, { title: 'Return key types' , render: function () { var returnKeyTypes = [ 'default' , 'go' , 'google' , 'join' , 'next' , 'route' , 'search' , 'send' , 'yahoo' , 'done' , 'emergency-call' , ]; var examples = returnKeyTypes.map((type) => { return ( <WithLabel key={type} label={type}> <TextInput returnKeyType={type} style={styles. default } /> </WithLabel> ); }); return <View>{examples}</View>; } }, { title: 'Enable return key automatically' , render: function () { return ( <View> <WithLabel label= "true" > <TextInput enablesReturnKeyAutomatically={ true } style={styles. default } /> </WithLabel> </View> ); } }, { title: 'Secure text entry' , render: function () { return ( <View> <WithLabel label= "true" > <TextInput secureTextEntry={ true } style={styles. default } defaultValue= "abc" /> </WithLabel> </View> ); } }, { title: 'Event handling' , render: function (): ReactElement<any> { return <TextEventsExample />; }, }, { title: 'Colored input text' , render: function () { return ( <View> <TextInput style={[styles. default , {color: 'blue' }]} defaultValue= "Blue" /> <TextInput style={[styles. default , {color: 'green' }]} defaultValue= "Green" /> </View> ); } }, { title: 'Colored highlight/cursor for text input' , render: function () { return ( <View> <TextInput style={styles. default } selectionColor={ "green" } defaultValue= "Highlight me" /> <TextInput style={styles. default } selectionColor={ "rgba(86, 76, 205, 1)" } defaultValue= "Highlight me" /> </View> ); } }, { title: 'Clear button mode' , render: function () { return ( <View> <WithLabel label= "never" > <TextInput style={styles. default } clearButtonMode= "never" /> </WithLabel> <WithLabel label= "while editing" > <TextInput style={styles. default } clearButtonMode= "while-editing" /> </WithLabel> <WithLabel label= "unless editing" > <TextInput style={styles. default } clearButtonMode= "unless-editing" /> </WithLabel> <WithLabel label= "always" > <TextInput style={styles. default } clearButtonMode= "always" /> </WithLabel> </View> ); } }, { title: 'Clear and select' , render: function () { return ( <View> <WithLabel label= "clearTextOnFocus" > <TextInput placeholder= "text is cleared on focus" defaultValue= "text is cleared on focus" style={styles. default } clearTextOnFocus={ true } /> </WithLabel> <WithLabel label= "selectTextOnFocus" > <TextInput placeholder= "text is selected on focus" defaultValue= "text is selected on focus" style={styles. default } selectTextOnFocus={ true } /> </WithLabel> </View> ); } }, { title: 'Blur on submit' , render: function (): ReactElement<any> { return <BlurOnSubmitExample />; }, }, { title: 'Multiline blur on submit' , render: function () { return ( <View> <TextInput style={styles.multiline} placeholder= "blurOnSubmit = true" returnKeyType= "next" blurOnSubmit={ true } multiline={ true } onSubmitEditing={event => alert(event.nativeEvent.text)} /> </View> ); } }, { title: 'Multiline' , render: function () { return ( <View> <TextInput placeholder= "multiline text input" multiline={ true } style={styles.multiline} /> <TextInput placeholder= "multiline text input with font styles and placeholder" multiline={ true } clearTextOnFocus={ true } autoCorrect={ true } autoCapitalize= "words" placeholderTextColor= "red" keyboardType= "url" style={[styles.multiline, styles.multilineWithFontStyles]} /> <TextInput placeholder= "uneditable multiline text input" editable={ false } multiline={ true } style={styles.multiline} /> <TextInput placeholder= "multiline with children" multiline={ true } enablesReturnKeyAutomatically={ true } returnKeyType= "go" style={styles.multiline}> <View style={styles.multilineChild}/> </TextInput> </View> ); } }, { title: 'Auto-expanding' , render: function () { return ( <View> <AutoExpandingTextInput placeholder= "height increases with content" enablesReturnKeyAutomatically={ true } returnKeyType= "default" /> </View> ); } }, { title: 'Attributed text' , render: function () { return <TokenizedTextExample />; } }, ]; |
ANDROID |
Edit on GitHub |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 | 'use strict' ; var React = require( 'react' ); var ReactNative = require( 'react-native' ); var { Text, TextInput, View, StyleSheet, } = ReactNative; var TextEventsExample = React.createClass({ getInitialState: function () { return { curText: '<No Event>' , prevText: '<No Event>' , prev2Text: '<No Event>' , }; }, updateText: function (text) { this .setState((state) => { return { curText: text, prevText: state.curText, prev2Text: state.prevText, }; }); }, render: function () { return ( <View> <TextInput autoCapitalize= "none" placeholder= "Enter text to see events" autoCorrect={ false } onFocus={() => this .updateText( 'onFocus' )} onBlur={() => this .updateText( 'onBlur' )} onChange={(event) => this .updateText( 'onChange text: ' + event.nativeEvent.text )} onEndEditing={(event) => this .updateText( 'onEndEditing text: ' + event.nativeEvent.text )} onSubmitEditing={(event) => this .updateText( 'onSubmitEditing text: ' + event.nativeEvent.text )} style={styles.singleLine} /> <Text style={styles.eventLabel}> { this .state.curText}{ '\n' } (prev: { this .state.prevText}){ '\n' } (prev2: { this .state.prev2Text}) </Text> </View> ); } }); class AutoExpandingTextInput extends React.Component { constructor(props) { super (props); this .state = {text: '' , height: 0}; } render() { return ( <TextInput {... this .props} multiline={ true } onChange={(event) => { this .setState({ text: event.nativeEvent.text, height: event.nativeEvent.contentSize.height, }); }} style={[styles. default , {height: Math.max(35, this .state.height)}]} value={ this .state.text} /> ); } } class RewriteExample extends React.Component { constructor(props) { super (props); this .state = {text: '' }; } render() { var limit = 20; var remainder = limit - this .state.text.length; var remainderColor = remainder > 5 ? 'blue' : 'red' ; return ( <View style={styles.rewriteContainer}> <TextInput multiline={ false } maxLength={limit} onChangeText={(text) => { text = text.replace(/ /g, '_' ); this .setState({text}); }} style={styles. default } value={ this .state.text} /> <Text style={[styles.remainder, {color: remainderColor}]}> {remainder} </Text> </View> ); } } class TokenizedTextExample extends React.Component { constructor(props) { super (props); this .state = {text: 'Hello #World' }; } render() { //define delimiter let delimiter = /\s+/; //split string let _text = this .state.text; let token, index, parts = []; while (_text) { delimiter.lastIndex = 0; token = delimiter.exec(_text); if (token === null ) { break ; } index = token.index; if (token[0].length === 0) { index = 1; } parts.push(_text.substr(0, index)); parts.push(token[0]); index = index + token[0].length; _text = _text.slice(index); } parts.push(_text); //highlight hashtags parts = parts.map((text) => { if (/^ #/.test(text)) { return <Text key={text} style={styles.hashtag}>{text}</Text>; } else { return text; } }); return ( <View> <TextInput multiline={ true } style={styles.multiline} onChangeText={(text) => { this .setState({text}); }}> <Text>{parts}</Text> </TextInput> </View> ); } } var BlurOnSubmitExample = React.createClass({ focusNextField(nextField) { this .refs[nextField].focus(); }, render: function () { return ( <View> <TextInput ref= "1" style={styles.singleLine} placeholder= "blurOnSubmit = false" returnKeyType= "next" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '2' )} /> <TextInput ref= "2" style={styles.singleLine} keyboardType= "email-address" placeholder= "blurOnSubmit = false" returnKeyType= "next" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '3' )} /> <TextInput ref= "3" style={styles.singleLine} keyboardType= "url" placeholder= "blurOnSubmit = false" returnKeyType= "next" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '4' )} /> <TextInput ref= "4" style={styles.singleLine} keyboardType= "numeric" placeholder= "blurOnSubmit = false" blurOnSubmit={ false } onSubmitEditing={() => this .focusNextField( '5' )} /> <TextInput ref= "5" style={styles.singleLine} keyboardType= "numbers-and-punctuation" placeholder= "blurOnSubmit = true" returnKeyType= "done" /> </View> ); } }); var styles = StyleSheet.create({ multiline: { height: 60, fontSize: 16, padding: 4, marginBottom: 10, }, eventLabel: { margin: 3, fontSize: 12, }, singleLine: { fontSize: 16, padding: 4, }, singleLineWithHeightTextInput: { height: 30, }, hashtag: { color: 'blue' , fontWeight: 'bold' , }, }); exports.title = '<TextInput>' ; exports.description = 'Single and multi-line text inputs.' ; exports.examples = [ { title: 'Auto-focus' , render: function () { return ( <TextInput autoFocus={ true } style={styles.singleLine} accessibilityLabel= "I am the accessibility label for text input" /> ); } }, { title: "Live Re-Write (<sp> -> '_')" , render: function () { return <RewriteExample />; } }, { title: 'Auto-capitalize' , render: function () { var autoCapitalizeTypes = [ 'none' , 'sentences' , 'words' , 'characters' , ]; var examples = autoCapitalizeTypes.map((type) => { return ( <TextInput key={type} autoCapitalize={type} placeholder={ 'autoCapitalize: ' + type} style={styles.singleLine} /> ); }); return <View>{examples}</View>; } }, { title: 'Auto-correct' , render: function () { return ( <View> <TextInput autoCorrect={ true } placeholder= "This has autoCorrect" style={styles.singleLine} /> <TextInput autoCorrect={ false } placeholder= "This does not have autoCorrect" style={styles.singleLine} /> </View> ); } }, { title: 'Keyboard types' , render: function () { var keyboardTypes = [ 'default' , 'email-address' , 'numeric' , 'phone-pad' , ]; var examples = keyboardTypes.map((type) => { return ( <TextInput key={type} keyboardType={type} placeholder={ 'keyboardType: ' + type} style={styles.singleLine} /> ); }); return <View>{examples}</View>; } }, { title: 'Blur on submit' , render: function (): ReactElement { return <BlurOnSubmitExample />; }, }, { title: 'Event handling' , render: function (): ReactElement { return <TextEventsExample />; }, }, { title: 'Colors and text inputs' , render: function () { return ( <View> <TextInput style={[styles.singleLine]} defaultValue= "Default color text" /> <TextInput style={[styles.singleLine, {color: 'green' }]} defaultValue= "Green Text" /> <TextInput placeholder= "Default placeholder text color" style={styles.singleLine} /> <TextInput placeholder= "Red placeholder text color" placeholderTextColor= "red" style={styles.singleLine} /> <TextInput placeholder= "Default underline color" style={styles.singleLine} /> <TextInput placeholder= "Blue underline color" style={styles.singleLine} underlineColorAndroid= "blue" /> <TextInput defaultValue= "Same BackgroundColor as View " style={[styles.singleLine, {backgroundColor: 'rgba(100, 100, 100, 0.3)' }]}> <Text style={{backgroundColor: 'rgba(100, 100, 100, 0.3)' }}> Darker backgroundColor </Text> </TextInput> <TextInput defaultValue= "Highlight Color is red" selectionColor={ 'red' } style={styles.singleLine}> </TextInput> </View> ); } }, { title: 'Text input, themes and heights' , render: function () { return ( <TextInput placeholder= "If you set height, beware of padding set from themes" style={[styles.singleLineWithHeightTextInput]} /> ); } }, { title: 'fontFamily, fontWeight and fontStyle' , render: function () { return ( <View> <TextInput style={[styles.singleLine, {fontFamily: 'sans-serif' }]} placeholder= "Custom fonts like Sans-Serif are supported" /> <TextInput style={[styles.singleLine, {fontFamily: 'sans-serif' , fontWeight: 'bold' }]} placeholder= "Sans-Serif bold" /> <TextInput style={[styles.singleLine, {fontFamily: 'sans-serif' , fontStyle: 'italic' }]} placeholder= "Sans-Serif italic" /> <TextInput style={[styles.singleLine, {fontFamily: 'serif' }]} placeholder= "Serif" /> </View> ); } }, { title: 'Passwords' , render: function () { return ( <View> <TextInput defaultValue= "iloveturtles" secureTextEntry={ true } style={styles.singleLine} /> <TextInput secureTextEntry={ true } style={[styles.singleLine, {color: 'red' }]} placeholder= "color is supported too" placeholderTextColor= "red" /> </View> ); } }, { title: 'Editable' , render: function () { return ( <TextInput defaultValue= "Can't touch this! (>'-')> ^(' - ')^ <('-'<) (>'-')> ^(' - ')^" editable={ false } style={styles.singleLine} /> ); } }, { title: 'Multiline ', render: function() { return ( <View> <TextInput autoCorrect={true} placeholder="multiline, aligned top-left" placeholderTextColor="red" multiline={true} style={[styles.multiline, {textAlign: "left", textAlignVertical: "top"}]} /> <TextInput autoCorrect={true} placeholder="multiline, aligned center" placeholderTextColor="green" multiline={true} style={[styles.multiline, {textAlign: "center", textAlignVertical: "center"}]} /> <TextInput autoCorrect={true} multiline={true} style={[styles.multiline, {color: ' blue '}, {textAlign: "right", textAlignVertical: "bottom"}]}> <Text style={styles.multiline}>multiline with children, aligned bottom-right</Text> </TextInput> </View> ); } }, { title: ' Fixed number of lines ', platform: ' android ', render: function() { return ( <View> <TextInput numberOfLines={2} multiline={true} placeholder="Two line input" /> <TextInput numberOfLines={5} multiline={true} placeholder="Five line input" /> </View> ); } }, { title: ' Auto-expanding ', render: function() { return ( <View> <AutoExpandingTextInput placeholder="height increases with content" enablesReturnKeyAutomatically={true} returnKeyType="done" /> </View> ); } }, { title: ' Attributed text ', render: function() { return <TokenizedTextExample />; } }, { title: ' Return key ', render: function() { var returnKeyTypes = [ ' none ', ' go ', ' search ', ' send ', ' done ', ' previous ', ' next ', ]; var returnKeyLabels = [ ' Compile ', ' React Native ', ]; var examples = returnKeyTypes.map((type) => { return ( <TextInput key={type} returnKeyType={type} placeholder={' returnKeyType: ' + type} style={styles.singleLine} /> ); }); var types = returnKeyLabels.map((type) => { return ( <TextInput key={type} returnKeyLabel={type} placeholder={' returnKeyLabel: ' + type} style={styles.singleLine} /> ); }); return <View>{examples}{types}</View>; } }, ]; |