Let users enter search terms or find specific items using a single-line input field.

Requirements

Requires OctantisEventProxy hook. See Install Hooks README.

Example

<.s_search_field
  label="Search"
  label_accessibility_visibility="exclusive"
  placeholder="Search items"
  data-phx-debounce="500"
/>

See

• https://shopify.dev/docs/api/app-home/polaris-web-components/forms/searchfield

Attributes

• autocomplete (:string) - A hint as to the intended content of te field.

  When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.

  When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

  Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.

• default_value (:string) - The default value for the field.

• details (:string) - Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.

  This will also be exposed to screen reader users.

• disabled (:string) - Disables the field, disallowing any interaction.

• error (:string) - Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.

• id (:string) (required) - A unique identifier for the element.

• label (:string) - Content to use as the field label.

• label_accessibility_visibility (:string) - "visible" | "exclusive"

  Changes the visibility of the component's label.

  • visible: the label is visible to all users.
  • exclusive: the label is visually hidden but remains in the accessibility tree.

• max_length (:string) - Specifies the maximum number of characters allowed.

• min_length (:string) - Specifies the min number of characters allowed.

• placeholder (:string) - A short hint that describes the expected value of the field.

• read_only (:string) - The field cannot be edited by the user. It is focusable will be announced by screen readers.

• required (:string) - Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.

• value (:string) - The current value for the field. If omitted, the field will be empty.

• field (Phoenix.HTML.FormField) (required) - The Phoenix Form Field.

• blur (:string)

• change (:string)

• focus (:string)

• input (:string)

• Global attributes are accepted.

Slots

• inner_block