Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface 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

Index

Properties

aria-describedby?: string

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

see

aria-labelledby

error: boolean

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

id: string

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

maxLength?: number
minLength?: number
onBlur: FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>
onChange: FormEventHandler<HTMLInputElement | HTMLTextAreaElement>
pattern?: string
required?: boolean
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.

theme?: FormTheme

The current theme type.

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.

Generated using TypeDoc