You are viewing a PR preview for PR #1506

Agriculture Design System
Beta
Design System for the Export Service

Search input

Search input enables users to enter a word or phrase to find relevant content.

View in FigmaView in StorybookView in Github
import { ... } from '@ag.ds-next/react/search-input';

Usage

Search input components can be imported via the search-input entrypoint in the @ag.ds-next/react package.

For example:

import { ... } from '@ag.ds-next/react/search-input';

Props

SearchInput Props
PropTypeDescription
labelstringDescribes the purpose of the field.
autoFocus?boolean
block?booleanIf true, the field will stretch to the fill the width of its container.
disabled?boolean
hideOptionalLabel?booleanIf true, "(optional)" will never be appended to the label.
hint?stringProvides extra information about the field.
id?string
invalid?booleanIf true, the invalid state will be rendered.
maxWidth?SearchInputMaxWidthThe maximum width of the field.
message?stringMessage to show when the field is invalid.
name?string
onBlur?FocusEventHandler<HTMLInputElement>
onChange?((value: string) => void)
onClear?(() => void)Function to be called when the input is cleared.
onFocus?FocusEventHandler<HTMLInputElement>
ref?Ref<HTMLInputElement>
required?booleanIf false, "(optional)" will be appended to the label.
value?string | number | readonly string[]

Source

You can view the full source code for this package on Github.