Skip to main content

Interface: NumberFieldProps

Defined in: components/NumberField/NumberField.tsx:65

Props for the NumberField component.

Extends​

  • Omit<RACNumberFieldProps, "style" | "children" | "className">

Properties​

contextualHelp?​

optional contextualHelp?: ReactNode

Defined in: components/NumberField/NumberField.tsx:75

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

decrementLabel?​

optional decrementLabel?: string

Defined in: components/NumberField/NumberField.tsx:89

Accessible name for the decrement stepper (the icon is the sole carrier of meaning). Ships a documented English fallback (supplementary AT text, not a flow-critical label — i18n rule §6.2); localized hosts override it.

Default​

'Decrease'

description?​

optional description?: ReactNode

Defined in: components/NumberField/NumberField.tsx:77

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

errorMessage?​

optional errorMessage?: ReactNode

Defined in: components/NumberField/NumberField.tsx:82

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

incrementLabel?​

optional incrementLabel?: string

Defined in: components/NumberField/NumberField.tsx:95

Accessible name for the increment stepper. Documented English fallback, overridable (i18n rule §6.2).

Default​

'Increase'

label?​

optional label?: ReactNode

Defined in: components/NumberField/NumberField.tsx:70

Visible label displayed above the field.