SearchField

A SearchField is a text field designed for searches.

installyarn add @adobe/react-spectrum
version3.1.2
usageimport {SearchField} from '@adobe/react-spectrum'

Example#


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

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

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

  return (
    <>
      <SearchField
        label="Search"
        placeholder="Enter text"
        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>
  );
}

Placeholder text that describes the expected value or formatting for the SearchField can be provided using the placeholder prop. Placeholder text will only appear when the SearchField is empty, and should not be used as a substitute for labeling the component with a visible label.

<SearchField placeholder="e.g. Sally Jones" label="Search for user" />
<SearchField
  placeholder="e.g. Sally Jones"
  label="Search for user"
/>
<SearchField
  placeholder="e.g. Sally Jones"
  label="Search for user"
/>

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
        placeholder="Enter some text"
        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
        placeholder="Enter some text"
        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
        placeholder="Enter some text"
        onClear={() =>
          setCurrentText(
            ''
          )
        }
        onChange={
          setCurrentText
        }
        onSubmit={
          setSubmittedText
        }
        label="Your text"
        value={
          currentText
        }
      />
      <pre>
        Mirrored text:{' '}
        {currentText}
      </pre>
      <pre>
        Submitted text:{' '}
        {submittedText}
      </pre>
    </div>
  );
}

Props#


NameTypeDefaultDescription
isDisabledbooleanWhether the input is disabled.
isReadOnlybooleanWhether the input can be selected but not changed by the user.
validationStateValidationStateWhether the input should display its "valid" or "invalid" visual styling.
isRequiredbooleanWhether user input is required on the input before form submission. Often paired with the necessityIndicator prop to add a visual indicator to the input.
autoFocusbooleanWhether the element should receive focus on render.
placeholderstringTemporary text that occupies the text input when it is empty.
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.
namestringThe name of the input element, used when submitting an HTML form. See MDN.
patternstringRegex pattern that the value of the input must match to be valid. See MDN.
type'text''search''url''tel''email''password'stringThe 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.
iconReactElementAn icon to display at the start of the textfield.
isQuietbooleanWhether the textfield should be displayed with a quiet style.
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.
Events
NameTypeDefaultDescription
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 )) => voidHandler that is called when the element receives focus.
onBlur( (e: FocusEvent )) => 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: string )) => 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
NameTypeDefaultDescription
flexstringnumberbooleanWhen used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrownumberWhen used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinknumberWhen used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisnumberstringWhen used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelf'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.
justifySelf'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.
ordernumberThe layout order for the element within a flex or grid container. See MDN.
gridAreastringWhen used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnstringWhen used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowstringWhen used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartstringWhen used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndstringWhen used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartstringWhen used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndstringWhen used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginDimensionValueThe margin for all four sides of the element. See MDN.
marginTopDimensionValueThe margin for the top side of the element. See MDN.
marginBottomDimensionValueThe margin for the bottom side of the element. See MDN.
marginStartDimensionValueThe margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndDimensionValueThe margin for the logical end side of an element, depending on layout direction. See MDN.
marginXDimensionValueThe margin for both the left and right sides of the element. See MDN.
marginYDimensionValueThe margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthDimensionValueThe width of the element. See MDN.
minWidthDimensionValueThe minimum width of the element. See MDN.
maxWidthDimensionValueThe maximum width of the element. See MDN.
heightDimensionValueThe height of the element. See MDN.
minHeightDimensionValueThe minimum height of the element. See MDN.
maxHeightDimensionValueThe maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
position'static''relative''absolute''fixed''sticky'Specifies how the element is positioned. See MDN.
topDimensionValueThe top position for the element. See MDN.
bottomDimensionValueThe bottom position for the element. See MDN.
leftDimensionValueThe left position for the element. See MDN. Consider using start instead for RTL support.
rightDimensionValueThe right position for the element. See MDN. Consider using start instead for RTL support.
startDimensionValueThe logical start position for the element, depending on layout direction. See MDN.
endDimensionValueThe logical end position for the element, depending on layout direction. See MDN.
zIndexnumberThe stacking order for the element. See MDN.
isHiddenbooleanHides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
excludeFromTabOrderbooleanWhether 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
NameTypeDefaultDescription
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" placeholder="Email Address" isQuiet />
<SearchField
  label="Search"
  placeholder="Email Address"
  isQuiet
/>
<SearchField
  label="Search"
  placeholder="Email Address"
  isQuiet
/>

Disabled#

<SearchField label="Search" placeholder="Email Address" isDisabled />
<SearchField
  label="Search"
  placeholder="Email Address"
  isDisabled
/>
<SearchField
  label="Search"
  placeholder="Email Address"
  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"
/>

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 />}
/>