SearchField

A SearchField is a text field designed for searches.

installyarn add @adobe/react-spectrum
added3.0.0
usageimport {SearchField} from '@adobe/react-spectrum'

Example#


function Example() {
  let [submittedText, setSubmittedText] = React.useState(null);

  return (
    <>
      <SearchField
        label="Search"
        onSubmit={setSubmittedText} />
      <p>Submitted text: {submittedText}</p>
    </>
  );
}
function Example() {
  let [submittedText, setSubmittedText] = React.useState(
    null
  );

  return (
    <>
      <SearchField
        label="Search"
        onSubmit={setSubmittedText}
      />
      <p>Submitted text: {submittedText}</p>
    </>
  );
}
function Example() {
  let [
    submittedText,
    setSubmittedText
  ] = React.useState(
    null
  );

  return (
    <>
      <SearchField
        label="Search"
        onSubmit={setSubmittedText}
      />
      <p>
        Submitted text:
        {' '}
        {submittedText}
      </p>
    </>
  );
}

Value#


A SearchField's value is empty by default, but an initial, uncontrolled, value can be provided using the defaultValue prop. Alternatively, a controlled value can be provided using the value prop.

function Example() {
  let [searchValue, setSearchValue] = React.useState('puppies');
  return (
    <Flex gap="size-300">
      <SearchField
        defaultValue="puppies"
        label="Search (uncontrolled)" />

      <SearchField
        value={searchValue}
        onChange={setSearchValue}
        label="Search (controlled)" />
    </Flex>
  );
}
function Example() {
  let [searchValue, setSearchValue] = React.useState(
    'puppies'
  );
  return (
    <Flex gap="size-300">
      <SearchField
        defaultValue="puppies"
        label="Search (uncontrolled)"
      />

      <SearchField
        value={searchValue}
        onChange={setSearchValue}
        label="Search (controlled)"
      />
    </Flex>
  );
}
function Example() {
  let [
    searchValue,
    setSearchValue
  ] = React.useState(
    'puppies'
  );
  return (
    <Flex gap="size-300">
      <SearchField
        defaultValue="puppies"
        label="Search (uncontrolled)"
      />

      <SearchField
        value={searchValue}
        onChange={setSearchValue}
        label="Search (controlled)"
      />
    </Flex>
  );
}

HTML forms#

SearchField supports the name prop for integration with HTML forms. In addition, attributes such as type, pattern, inputMode, and others are passed through to the underlying <input> element.

<SearchField label="Email" name="email" type="email" />
<SearchField label="Email" name="email" type="email" />
<SearchField
  label="Email"
  name="email"
  type="email"
/>

Labeling#


A visual label should be provided for the SearchField using the label prop. If the SearchField is required, the isRequired and necessityIndicator props can be used to show a required state.

<Flex gap="size-300" wrap>
  <SearchField label="Search" />
  <SearchField label="Search" isRequired necessityIndicator="icon" />
  <SearchField label="Search" isRequired necessityIndicator="label" />
  <SearchField label="Search" necessityIndicator="label" />
</Flex>
<Flex gap="size-300" wrap>
  <SearchField label="Search" />
  <SearchField
    label="Search"
    isRequired
    necessityIndicator="icon"
  />
  <SearchField
    label="Search"
    isRequired
    necessityIndicator="label"
  />
  <SearchField
    label="Search"
    necessityIndicator="label"
  />
</Flex>
<Flex
  gap="size-300"
  wrap
>
  <SearchField label="Search" />
  <SearchField
    label="Search"
    isRequired
    necessityIndicator="icon"
  />
  <SearchField
    label="Search"
    isRequired
    necessityIndicator="label"
  />
  <SearchField
    label="Search"
    necessityIndicator="label"
  />
</Flex>

Accessibility#

If a visible label isn't specified, an aria-label must be provided to the SearchField for accessibility. If the field is labeled by a separate element, an aria-labelledby prop must be provided using the id of the labeling element instead.

Internationalization#

In order to internationalize a SearchField, a localized string should be passed to the label or aria-label prop. When the necessityIndicator prop is set to "label", a localized string will be provided for "(required)" or "(optional)" automatically.

Events#


The most commonly used handlers for events in SearchField are the:

  • onChange prop which is triggered whenever the value is edited by the user.
  • onSubmit prop which is triggered whenever the value is submitted by the user.
  • onClear prop which is triggered whenever the value is cleared by the user.

The example below uses onChange, onSubmit, and onClear to update two separate elements with the text entered into the SearchField.

function Example() {
  let [currentText, setCurrentText] = React.useState('');
  let [submittedText, setSubmittedText] = React.useState('');

  return (
    <div>
      <SearchField
        onClear={() => setCurrentText('')}
        onChange={setCurrentText}
        onSubmit={setSubmittedText}
        label="Your text"
        value={currentText}
      />
      <pre>Mirrored text: {currentText}</pre>
      <pre>Submitted text: {submittedText}</pre>
    </div>
  );
}
function Example() {
  let [currentText, setCurrentText] = React.useState('');
  let [submittedText, setSubmittedText] = React.useState(
    ''
  );

  return (
    <div>
      <SearchField
        onClear={() => setCurrentText('')}
        onChange={setCurrentText}
        onSubmit={setSubmittedText}
        label="Your text"
        value={currentText}
      />
      <pre>Mirrored text: {currentText}</pre>
      <pre>Submitted text: {submittedText}</pre>
    </div>
  );
}
function Example() {
  let [
    currentText,
    setCurrentText
  ] = React.useState('');
  let [
    submittedText,
    setSubmittedText
  ] = React.useState('');

  return (
    <div>
      <SearchField
        onClear={() =>
          setCurrentText(
            ''
          )}
        onChange={setCurrentText}
        onSubmit={setSubmittedText}
        label="Your text"
        value={currentText}
      />
      <pre>Mirrored text: {currentText}</pre>
      <pre>Submitted text: {submittedText}</pre>
    </div>
  );
}

Validation#


SearchField supports native HTML constraint validation props such as isRequired, minLength, and pattern, as well as custom validation functions, realtime validation, and server-side validation. It can also be integrated with other form libraries. See the Forms guide to learn more.

When the Form component has the validationBehavior="native" prop, validation errors block form submission and are displayed as help text automatically. Errors are displayed when the user blurs the search field or submits the form.

import {Form, ButtonGroup, Button} from '@adobe/react-spectrum';

<Form validationBehavior="native" maxWidth="size-3000">
  <SearchField label="Search" name="search" isRequired />  <ButtonGroup>
    <Button type="submit" variant="primary">Submit</Button>
    <Button type="reset" variant="secondary">Reset</Button>
  </ButtonGroup>
</Form>
import {
  Button,
  ButtonGroup,
  Form
} from '@adobe/react-spectrum';

<Form validationBehavior="native" maxWidth="size-3000">
  <SearchField label="Search" name="search" isRequired />  <ButtonGroup>
    <Button type="submit" variant="primary">
      Submit
    </Button>
    <Button type="reset" variant="secondary">
      Reset
    </Button>
  </ButtonGroup>
</Form>
import {
  Button,
  ButtonGroup,
  Form
} from '@adobe/react-spectrum';

<Form
  validationBehavior="native"
  maxWidth="size-3000"
>
  <SearchField
    label="Search"
    name="search"
    isRequired
  />  <ButtonGroup>
    <Button
      type="submit"
      variant="primary"
    >
      Submit
    </Button>
    <Button
      type="reset"
      variant="secondary"
    >
      Reset
    </Button>
  </ButtonGroup>
</Form>

By default, SearchField displays default validation messages provided by the browser. See Customizing error messages in the Forms guide to learn how to provide your own custom errors.

Props#


NameTypeDefaultDescription
isDisabledbooleanWhether the input is disabled.
isReadOnlybooleanWhether the input can be selected but not changed by the user.
isRequiredbooleanWhether user input is required on the input before form submission.
validationBehavior'aria''native''aria'

Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.

validate( (value: string )) => ValidationErrortruenullundefined

A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if validationBehavior="native". For realtime validation, use the isInvalid prop instead.

descriptionReactNodeA description for the field. Provides a hint such as specific requirements for what to choose.
errorMessageReactNode( (v: ValidationResult )) => ReactNodeAn error message for the field.
autoFocusbooleanWhether the element should receive focus on render.
valuestringThe current value (controlled).
defaultValuestringThe default value (uncontrolled).
labelReactNodeThe content to display as the label.
autoCompletestringDescribes the type of autocomplete functionality the input should provide if any. See MDN.
maxLengthnumberThe maximum number of characters supported by the input. See MDN.
minLengthnumberThe minimum number of characters required by the input. See MDN.
patternstringRegex pattern that the value of the input must match to be valid. See MDN.
type'text''search''url''tel''email''password'string{}The type of input to render. See MDN.
inputMode'none''text''tel''url''email''numeric''decimal''search'Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN.
namestringThe name of the input element, used when submitting an HTML form. See MDN.
iconReactElementnullAn icon to display at the start of the input.
isQuietbooleanWhether the input should be displayed with a quiet style.
validationStateValidationStateWhether the input should display its "valid" or "invalid" visual styling.
labelPositionLabelPosition'top'The label's overall position relative to the element it is labeling.
labelAlignAlignment'start'The label's horizontal alignment relative to the element it is labeling.
necessityIndicatorNecessityIndicator'icon'Whether the required state should be shown as an icon or text.
contextualHelpReactNodeA ContextualHelp element to place next to the label.
Events
NameTypeDescription
onSubmit( (value: string )) => voidHandler that is called when the SearchField is submitted.
onClear() => voidHandler that is called when the clear button is pressed.
onFocus( (e: FocusEvent<Target> )) => voidHandler that is called when the element receives focus.
onBlur( (e: FocusEvent<Target> )) => voidHandler that is called when the element loses focus.
onFocusChange( (isFocused: boolean )) => voidHandler that is called when the element's focus status changes.
onKeyDown( (e: KeyboardEvent )) => voidHandler that is called when a key is pressed.
onKeyUp( (e: KeyboardEvent )) => voidHandler that is called when a key is released.
onChange( (value: T )) => voidHandler that is called when the value changes.
onCopyClipboardEventHandler<HTMLInputElement>Handler that is called when the user copies text. See MDN.
onCutClipboardEventHandler<HTMLInputElement>Handler that is called when the user cuts text. See MDN.
onPasteClipboardEventHandler<HTMLInputElement>Handler that is called when the user pastes text. See MDN.
onCompositionStartCompositionEventHandler<HTMLInputElement>Handler that is called when a text composition system starts a new text composition session. See MDN.
onCompositionEndCompositionEventHandler<HTMLInputElement>Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
onCompositionUpdateCompositionEventHandler<HTMLInputElement>Handler that is called when a new character is received in the current text composition session. See MDN.
onSelectReactEventHandler<HTMLInputElement>Handler that is called when text in the input is selected. See MDN.
onBeforeInputFormEventHandler<HTMLInputElement>Handler that is called when the input value is about to be modified. See MDN.
onInputFormEventHandler<HTMLInputElement>Handler that is called when the input value is modified. See MDN.
Layout
NameTypeDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'>Overrides the alignItems property of a flex or grid container. See MDN.
justifySelfResponsive<'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'>Specifies how the element is justified inside a flex or grid container. See MDN.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDescription
idstringThe element's unique identifier. See MDN.
excludeFromTabOrderboolean

Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.

aria-activedescendantstringIdentifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-autocomplete'none''inline''list''both'

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

aria-haspopupboolean'false''true''menu''listbox''tree''grid''dialog'Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
aria-errormessagestringIdentifies the element that provides an error message for the object.
Advanced
NameTypeDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Quiet#

<SearchField label="Search" isQuiet />
<SearchField label="Search" isQuiet />
<SearchField
  label="Search"
  isQuiet
/>

Disabled#

<SearchField label="Search" isDisabled />
<SearchField label="Search" isDisabled />
<SearchField
  label="Search"
  isDisabled
/>

Read only#

The isReadOnly boolean prop makes the SearchField's text content immutable. Unlike isDisabled, the SearchField remains focusable and the contents can still be copied. See the MDN docs for more information.

<SearchField label="Search" defaultValue="abc@adobe.com" isReadOnly />
<SearchField
  label="Search"
  defaultValue="abc@adobe.com"
  isReadOnly
/>
<SearchField
  label="Search"
  defaultValue="abc@adobe.com"
  isReadOnly
/>

Label alignment and position#

By default, the label is positioned above the SearchField. The labelPosition prop can be used to position the label to the side. The labelAlign prop can be used to align the label as "start" or "end". For left-to-right (LTR) languages, "start" refers to the left most edge of the SearchField and "end" refers to the right most edge. For right-to-left (RTL) languages, this is flipped.

<SearchField label="Search" labelPosition="side" labelAlign="end" />
<SearchField
  label="Search"
  labelPosition="side"
  labelAlign="end"
/>
<SearchField
  label="Search"
  labelPosition="side"
  labelAlign="end"
/>

Help text#

View guidelines

Both a description and an error message can be supplied to a SearchField. The description is always visible unless the validationState is “invalid” and an error message is provided. The error message can be used to help the user fix their input quickly and should be specific to the detected error. All strings should be localized.

<Flex gap="size-100" wrap>
  <SearchField
    label="Search"
    defaultValue="Burritos"
    validationState="valid"
    description="Enter a query."
  />
  <SearchField
    label="Search"
    validationState="invalid"
    errorMessage="Empty input is not allowed."
  />
</Flex>
<Flex gap="size-100" wrap>
  <SearchField
    label="Search"
    defaultValue="Burritos"
    validationState="valid"
    description="Enter a query."
  />
  <SearchField
    label="Search"
    validationState="invalid"
    errorMessage="Empty input is not allowed."
  />
</Flex>
<Flex
  gap="size-100"
  wrap
>
  <SearchField
    label="Search"
    defaultValue="Burritos"
    validationState="valid"
    description="Enter a query."
  />
  <SearchField
    label="Search"
    validationState="invalid"
    errorMessage="Empty input is not allowed."
  />
</Flex>

Contextual help#

A ContextualHelp element may be placed next to the label to provide additional information or help about a SearchField.

import {Content, ContextualHelp, Heading} from '@adobe/react-spectrum';

<SearchField
  label="Search"
  contextualHelp={
    <ContextualHelp variant="info">
      <Heading>Search tips</Heading>
      <Content>
        You can use modifiers like "date:" and "from:" to search by specific
        attributes.
      </Content>
    </ContextualHelp>
  }
/>
import {
  Content,
  ContextualHelp,
  Heading
} from '@adobe/react-spectrum';

<SearchField
  label="Search"
  contextualHelp={
    <ContextualHelp variant="info">
      <Heading>Search tips</Heading>
      <Content>
        You can use modifiers like "date:" and "from:" to
        search by specific attributes.
      </Content>
    </ContextualHelp>
  }
/>
import {
  Content,
  ContextualHelp,
  Heading
} from '@adobe/react-spectrum';

<SearchField
  label="Search"
  contextualHelp={
    <ContextualHelp variant="info">
      <Heading>
        Search tips
      </Heading>
      <Content>
        You can use
        modifiers like
        "date:" and
        "from:" to
        search by
        specific
        attributes.
      </Content>
    </ContextualHelp>
  }
/>

Custom width#

<SearchField label="Search" width="size-3600" />
<SearchField label="Search" width="size-3600" />
<SearchField
  label="Search"
  width="size-3600"
/>

Custom icon#

The icon in the SearchField can be changed to suit the theme of a search. For instance, if the SearchField was for searching users, an icon relating to that would help convey meaning. See the Icons page for more.

<SearchField label="Search for users" icon={<User />} />
<SearchField label="Search for users" icon={<User />} />
<SearchField
  label="Search for users"
  icon={<User />}
/>