ProvidedTextFieldProps

All the props that will be generated and returned by the useTextField hook that should be passed to a TextField component.

remarks: @since 2.5.0

Hierarchy

TextConstraints
Required<TextFieldChangeHandlers>
Required<Pick<TextFieldProps, "id" | "value" | "error">>
Pick<TextFieldProps, "aria-describedby" | "theme" | "rightChildren">
- ProvidedTextFieldProps
  - ProvidedTextFieldMessageProps
  - ProvidedNumberFieldProps

Index

Properties

Optional aria-describedby

aria-describedby?: string

Identifies the element (or elements) that describes the object.

see: aria-labelledby

error

error: boolean

Boolean if the text field should gain the error state and update the colors.

id

id: string

The id for the text field. This is required for accessibility.

Optional maxLength

maxLength?: number

Optional minLength

minLength?: number

onBlur

onBlur: FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>

onChange

onChange: FormEventHandler<HTMLInputElement | HTMLTextAreaElement>

Optional pattern

pattern?: string

Optional required

required?: boolean

Optional rightChildren

rightChildren?: ReactNode

An optional addon to apply to the right of the text field. This should be a clickable button such as a password field toggle or a reset button for the field.

Optional theme

theme?: FormTheme

The current theme type.

value

value: string

The value to use for the text field. This will make the component controlled and require the onChange prop to be provided as well otherwise this will act as a read only text field.