Skip to main content

Interface: ComboBoxProps<T>

Defined in: components/ComboBox/ComboBox.tsx:98

Props for the ComboBox component.

Extends​

  • Omit<RACComboBoxProps<T>, "style" | "children" | "className">

Type Parameters​

Type ParameterDefault type
T extends objectobject

Properties​

children?​

optional children?: ReactNode

Defined in: components/ComboBox/ComboBox.tsx:133

ComboBoxItem children rendered inside the filtered options list.

contextualHelp?​

optional contextualHelp?: ReactNode

Defined in: components/ComboBox/ComboBox.tsx:108

A <ContextualHelp> element rendered beside the label (the reference system's prop shape) — for the explanation too long for description.

description?​

optional description?: ReactNode

Defined in: components/ComboBox/ComboBox.tsx:110

Supplementary helper text linked to the field via aria-describedby.

errorMessage?​

optional errorMessage?: ReactNode

Defined in: components/ComboBox/ComboBox.tsx:115

Validation message shown when the field is invalid. Supply caller-localized copy (i18n rule / §6).

label?​

optional label?: ReactNode

Defined in: components/ComboBox/ComboBox.tsx:103

Visible label displayed above the field.

placeholder?​

optional placeholder?: string

Defined in: components/ComboBox/ComboBox.tsx:124

Placeholder shown in the text input while it is empty.

Ships a documented English fallback — the placeholder is supplementary hint text, not a flow-critical label (CONTRIBUTING §6.2 / ADR-001). Localized hosts should still supply their own copy.

Default​

'Search…'

triggerLabel?​

optional triggerLabel?: string

Defined in: components/ComboBox/ComboBox.tsx:131

Accessible name for the chevron button that opens the full list (the icon is the sole carrier of meaning). Documented English fallback, overridable (i18n rule §6.2).

Default​

'Show suggestions'