SearchInput

Type: React component

How to get SearchInput?

JavaScript

import { SearchInput } from 'fds/components';

Renders a TextInput with a submit button used for searching within a desired context. Optionally also renders an arbitrary results counter.

Props

  1. isDisabled

    (Optional)

    Type: Boolean

    Whether or not the component should be rendered in a disabled state.

    Default value

  2. name

    (Optional)

    Type: String

    The name of this component to identify it (and its value) when used inside an intelligent container component which aggregates its children (and/or their values), like a Form.

    Default value

  3. onChange

    (Optional)

    Type: Function

    A callback that is called whenever a component's value changes.

    This callback is called just before the "validate" prop is called.

    Use this callback to update local state which in turn should update the value prop of the component whose callback just fired.

    Arguments

    Default value

  4. onKeyDown

    (Optional)

    Type: Function

    A callback that is called whenever a key on the keyboard is pressed. This callback is only fired when the key is pressed down.

    For more information about React and "events", check the React documentation

    Arguments

    Default value

  5. onSubmitButtonClick

    (Optional)

    Type: Function

    A callback that is called whenever the submit button is clicked.

    Default value

  6. placeholder

    (Optional)

    Type: String

    The placeholder text displayed in component when it is empty, i.e. has no values.

    Default value

  7. renderResultsCounter

    (Optional)

    Type: Function

    Renders an arbitrary results counter, should generally return a Label.

    Default value

  8. tooltipContent

    (Optional)

    Type: String | ReactElement

    The content of the tooltip that is displayed when hovering over the whole component.

    • string: the textual content of the tooltip

    • ReactElement: a React Element (instance of a React Component, usually created with JSX)

    Default value

  9. validate

    (Optional)

    Type: Function

    A callback that is called directly after the value(s) of a form component change(s).

    Use this callback to check the selected value(s) against business rules and to set any feedback for the user based on this.

    Arguments

    Returns

    Default value

  10. value

    (Optional)

    Type: String

    The current value of the component. This value should be a valid string.

    Default value