Type alias SearchProps

Type declaration

• Optional autoCapitalize?: "characters" | "words" | "sentences" | "none"

  Define auto cap rule (default is normally sentences)

• Optional autoCorrect?: boolean

  Indicate if autoCorrect should be used (default is true)

• Optional buttonProps?: ButtonProps

  Button to render to right of search.

• Optional clearTextButtonText?: string

  Text to use for clear text button (accessibility). Defaults to ENGLISH "Clear"

• Optional componentProps?: ReactTextInputProps

  Direct props to set on the React Native component (including iOS and Android specific props). Helpful for fully customizing text input behavior.

• Optional disabled?: boolean

  Indicate if disabled

• Optional label?: string

  Label string to use

• Optional labelBreakMode?: TextBreakModes

  Label break mode

• Optional light?: boolean

  Indicate if text box is used on layer

• Optional maxLength?: number

  Max length of field

• Optional onBlur?: ((event) => void)

  • • (event): void

    • Blur event when focus is lost

      Parameters

      • event: NativeSyntheticEvent<TextInputFocusEventData>

      Returns void

• onChangeText: ((value) => void)

  • • (value): void

    • Change event when text changed

      Parameters

      • value: string

      Returns void

• Optional onFocus?: ((event) => void)

  • • (event): void

    • Focus event when focus is gained

      Parameters

      • event: NativeSyntheticEvent<TextInputFocusEventData>

      Returns void

• Optional onSubmitEditing?: (() => void)

  • • (): void

    • Trigger ENTER event (consumer should validate if form is valid and submit if this is called)

      Returns void

• Optional onTextClearPress?: ((textBeforeClear, event) => void)

  • • (textBeforeClear, event): void

    • Callback when the clear button is pressed

      Parameters

      • textBeforeClear: string

      • event: GestureResponderEvent

      Returns void

• Optional placeholder?: string

  Placeholder text to use

• Optional searchIconText?: string

  Text to use for search icon (accessibility). Defaults to ENGLISH "Search"

• Optional style?: StyleProp<ViewStyle>

  Style to set on the item

• value: string

  Value of text (Controlled component)