SearchBar
Default SearchBar
Platform specific SearchBar
iOS
Android
import { SearchBar } from 'react-native-elements'
<SearchBar
onChangeText={someMethod}
onClear={someMethod}
placeholder='Type Here...' />
<SearchBar
noIcon
onChangeText={someMethod}
onClear={someMethod}
placeholder='Type Here...' />
<SearchBar
round
onChangeText={someMethod}
onClear={someMethod}
placeholder='Type Here...' />
<SearchBar
lightTheme
onChangeText={someMethod}
onClear={someMethod}
placeholder='Type Here...' />
<SearchBar
lightTheme
onChangeText={someMethod}
onClear={someMethod}
icon={{ type: 'font-awesome', name: 'search' }}
placeholder='Type Here...' />
<SearchBar
showLoading
platform="ios"
cancelButtonTitle="Cancel"
placeholder='Search' />
<SearchBar
showLoading
platform="android"
placeholder='Search' />
Props
This component inherits all native TextInput props that come with a standard React Native TextInput element, along with the following:
clearIcon
containerStyle
icon
inputStyle
lightTheme
loadingProps
noIcon
onChangeText
onClear
placeholder
placeholderTextColor
round
showLoading
underlineColorAndroid
cancelButtonTitle
onCancel
platform
Reference
clearIcon
specify color, styling, or another Material Icon Name (Note: pressing on this icon clears text inside the searchbar)
Type | Default |
---|---|
object {name (string), color (string), style (object)} | { color: '#86939e', name: 'close' } |
containerStyle
style the container of the TextInput
Type | Default |
---|---|
object (style) | inherited styling |
icon
specify type, name, color, and styling of the icon
Type | Default |
---|---|
object {type (string), name (string), color (string), style (object)} | { type: 'material', color: '#86939e', name: 'search' } |
inputStyle
style the TextInput
Type | Default |
---|---|
object (style) | inherited styling |
lightTheme
change theme to light theme
Type | Default |
---|---|
boolean | false |
loadingProps
props passed to ActivityIndicator
Type | Default |
---|---|
object | { } |
noIcon
remove icon from textinput
Type | Default |
---|---|
boolean | false |
onChangeText
method to fire when text is changed
Type | Default |
---|---|
function | none |
onClear
method to fire when input is cleared
Type | Default |
---|---|
function | none |
placeholder
set the placeholder text
Type | Default |
---|---|
string | '' |
placeholderTextColor
set the color of the placeholder text
Type | Default |
---|---|
string | '#86939e' |
round
change TextInput styling to rounded corners
Type | Default |
---|---|
boolean | false |
showLoading
show the loading ActivityIndicator effect
Type | Default |
---|---|
boolean | false |
underlineColorAndroid
specify other than the default transparent underline color
Type | Default |
---|---|
string (color) | transparent |
cancelButtonTitle
(iOS only) title of the cancel button on the right side
Type | Default |
---|---|
string | "Cancel" |
onCancel
callback fired when pressing the cancel button (iOS) or the back icon (Android)
Type | Default |
---|---|
function | null |
platform
choose the look and feel of the search bar. One of "default", "ios", "android"
Type | Default |
---|---|
string | "default" |
Interaction methods
method | description |
---|---|
focus | call focus on the textinput (example) |
blur | call blur on the textinput (example) |
clear | call clear on the textinput (example) |
cancel | (Android and iOS SearchBars only) call cancel on the SearchBar (left arrow on Android, Cancel button on iOS). This will basically blur the input and hide the keyboard (example) |
Calling methods on SearchBar
Store a reference to the SearchBar in your component by using the ref prop provided by React (see docs):
<SearchBar
ref={search => this.search = search}
...
/>
You can then access SearchBar methods like so:
this.search.focus();
this.search.blur();
this.search.clear();
this.search.cancel(); // Only available if `platform` props is "ios" | "android"