Search field API

Import

import { SearchField } from '@cimpress-ui/react';

Controlled/uncontrolled usage

This component can be used in a controlled or uncontrolled way.

In the controlled way, this component doesn’t maintain its own internal state, and its value is provided by the parent component. Use the controlled way when you need to be able to change the state of this component in other parts of your application.

In the uncontrolled way, this component maintains its own internal state, and can optionally notify the parent component when its internal state changes. Use the uncontrolled way when you don’t need to change the state of this component in other parts of your application.

Preview
Code

Search (controlled)

Search (uncontrolled)

import { SearchField, Stack } from '@cimpress-ui/react';
import { useState } from 'react';

export default function Demo() {
  const [query, setQuery] = useState('checkbox');

  return (
    <Stack gap={32}>
      <SearchField label="Search (controlled)" value={query} onChange={setQuery} />
      <SearchField label="Search (uncontrolled)" defaultValue="checkbox" />
    </Stack>
  );
}

Imperative API

This component exposes an imperative API through the apiRef prop. This API allows triggering behaviors that can’t be expressed by props.

Preview
Code

import { Button, SearchField, type SearchFieldApi, Stack } from '@cimpress-ui/react';
import { useRef } from 'react';

export default function Demo() {
  const apiRef = useRef<SearchFieldApi>(null);

  return (
    <Stack gap={16}>
      <SearchField label="Search" defaultValue="checkbox" apiRef={apiRef} />

      <Stack gap={16} direction={{ md: 'horizontal' }}>
        <Button onPress={() => apiRef.current?.focus()}>Focus</Button>
        <Button onPress={() => apiRef.current?.select()}>Select text</Button>
      </Stack>
    </Stack>
  );
}

Accessibility notes

The search term can be submitted by pressing the Enter key, and cleared by pressing the Escape key.

SearchField requires a textual label to remain accessible to assistive technologies. See our accessibility guide for more details.

Detecting changes

SearchField exposes multiple events that can be used to detect changes:

onChange - triggered on every change of the field’s value
onSubmit - triggered when the value is submitted by the user (for example, by pressing the Enter key)
onClear - triggered when the value is cleared by the user (for example, by pressing the clear button)

Play with the example below to see the difference between these events.

Preview
Code

Current query:

Submitted query:

import { SearchField, Stack, Text } from '@cimpress-ui/react';
import { useState } from 'react';

export default function Demo() {
  const [query, setQuery] = useState('');
  const [submittedQuery, setSubmittedQuery] = useState('');

  return (
    <Stack gap={16}>
      <SearchField
        label="Search"
        value={query}
        onChange={setQuery}
        onSubmit={setSubmittedQuery}
        onClear={() => setQuery('')}
      />
      <Text as="p">Current query: {query}</Text>
      <Text as="p">Submitted query: {submittedQuery}</Text>
    </Stack>
  );
}

Forms

Search field can integrate with native HTML forms. See our forms guide to learn how to work with forms.

API reference

SearchField

Allows users to enter and clear a search query.

See search field usage guidelines.

ref Section titled “ ref ” Ref<HTMLDivElement>: The ref type for this component.

SearchFieldProps

id Section titled “ id ” string: The element's unique identifier. See MDN.
data-cim-style-root Section titled “ data-cim-style-root ” boolean: Use this attribute to "claim" the component tree for exclusive Cimpress UI usage.
UNSAFE_className Section titled “ UNSAFE_className ” string: Sets the CSS className for the element. Only use as a last resort. Use style props instead.

See styling guide.
UNSAFE_style Section titled “ UNSAFE_style ” CSSProperties: Sets the CSS style for the element. Only use as a last resort. Use style props instead.

See styling guide.
label Section titled “ label ” string: The content to display as the label.
aria-label Section titled “ aria-label ” string: Defines a string value that labels the current element.
aria-labelledby Section titled “ aria-labelledby ” string: Identifies the element (or elements) that labels the current element.
aria-describedby Section titled “ aria-describedby ” string: Identifies the element (or elements) that describes the object.
aria-details Section titled “ aria-details ” string: Identifies the element (or elements) that provide a detailed, extended description for the object.
form Section titled “ form ” string: The <form> element to associate the input with. The value of this attribute must be the id of a <form> in the same document. See MDN.
name Section titled “ name ” string: The name of the input element, used when submitting an HTML form. See MDN.
description Section titled “ description ” string: A description for the field. Provides a hint such as specific requirements for what to choose.
error Section titled “ error ” FieldError: An error message for the field.
validate Section titled “ validate ” (value: string) => string | true | string[] | undefined: A function that returns an error message (or true) if a given value is invalid. Validation errors are displayed to the user when the form is submitted. For real-time validation, use the error prop instead.
placeholder Section titled “ placeholder ” string: The placeholder text displayed in the input field.
apiRef Section titled “ apiRef ” RefObject<SearchFieldApi | null>: A React ref that allows access to the imperative API of this component.
onSubmit Section titled “ onSubmit ” (value: string) => void: Handler that is called when the SearchField is submitted.
onClear Section titled “ onClear ” () => void: Handler that is called when the clear button is pressed.
autoComplete Section titled “ autoComplete ” string: Describes the type of autocomplete functionality the input should provide if any. See MDN.
maxLength Section titled “ maxLength ” number: The maximum number of characters supported by the input. See MDN.
minLength Section titled “ minLength ” number: The minimum number of characters required by the input. See MDN.
pattern Section titled “ pattern ” string: Regex pattern that the value of the input must match to be valid. See MDN.
inputMode Section titled “ inputMode ” 'search' | 'none' | 'text' | 'tel' | 'url' | 'email' | 'numeric' | 'decimal': Hints at the type of data that might be entered by the user while editing the element or its contents. See MDN.
autoCorrect Section titled “ autoCorrect ” string: An attribute that takes as its value a space-separated string that describes what, if any, type of autocomplete functionality the input should provide. See MDN.
spellCheck Section titled “ spellCheck ” string: An enumerated attribute that defines whether the element may be checked for spelling errors. See MDN.
onFocus Section titled “ onFocus ” (e: FocusEvent<HTMLInputElement>) => void: Handler that is called when the element receives focus.
onBlur Section titled “ onBlur ” (e: FocusEvent<HTMLInputElement>) => void: Handler that is called when the element loses focus.
autoFocus Section titled “ autoFocus ” boolean: Whether the element should receive focus on render.
isRequired Section titled “ isRequired ” boolean: Whether user input is required on the input before form submission.
isInvalid Section titled “ isInvalid ” boolean: Whether the input value is invalid.
isDisabled Section titled “ isDisabled ” boolean: Whether the input is disabled.
isReadOnly Section titled “ isReadOnly ” boolean: Whether the input can be selected but not changed by the user.
value Section titled “ value ” string: The current value (controlled).
defaultValue Section titled “ defaultValue ” string: The default value (uncontrolled).
onChange Section titled “ onChange ” (value: string) => void: Handler that is called when the value changes.

StyleProps

margin Section titled “ margin ” Responsive<Spacing | "auto">: The amount of margin applied to all edges of this component.
marginX Section titled “ marginX ” Responsive<Spacing | "auto">: The amount of margin applied to the left and right edges of this component. Takes priority over margin.
marginY Section titled “ marginY ” Responsive<Spacing | "auto">: The amount of margin applied to the top and bottom edges of this component. Takes priority over margin.
marginTop Section titled “ marginTop ” Responsive<Spacing | "auto">: The amount of margin applied to the top edge of this component. Takes priority over marginY and margin.
marginRight Section titled “ marginRight ” Responsive<Spacing | "auto">: The amount of margin applied to the right edge of this component. Takes priority over marginX and margin.
marginBottom Section titled “ marginBottom ” Responsive<Spacing | "auto">: The amount of margin applied to the bottom edge of this component. Takes priority over marginY and margin.
marginLeft Section titled “ marginLeft ” Responsive<Spacing | "auto">: The amount of margin applied to the left edge of this component. Takes priority over marginX and margin.

Search field API

Import

Controlled/uncontrolled usage

Imperative API

Accessibility notes

Detecting changes

Forms

API reference

SearchField

ref

id

data-cim-style-root

UNSAFE_className

UNSAFE_style

label

aria-label

aria-labelledby

aria-describedby

aria-details

form

name

description

error

validate

placeholder

apiRef

onSubmit

onClear

autoComplete

maxLength

minLength

pattern

inputMode

autoCorrect

spellCheck

onFocus

onBlur

autoFocus

isRequired

isInvalid

isDisabled

isReadOnly

value

defaultValue

onChange

margin

marginX

marginY

marginTop

marginRight

marginBottom

marginLeft