Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NumberFieldHookOptions

remarks

@since 2.5.0

Hierarchy

Index

Properties

Properties

Optional counter

counter?: boolean

Boolean if the FormMessage should also display a counter for the remaining letters allowed based on the maxLength.

This will still be considered false if the maxLength value is not provided.

Optional defaultValue

defaultValue?: number | (() => undefined | number)

The default number value to use which can be a number or undefined. When this value is set to a number (or a function that returns a number), the returned value will never be undefined.

Optional disableMaxLength

disableMaxLength?: boolean

Boolean if the maxLength prop should not be passed to the TextField component since it will prevent any additional characters from being entered in the text field which might feel like weird behavior to some users. This should really only be used when the counter option is also enabled and rendering along with a FormMessage component.

Optional disableMessage

disableMessage?: boolean

Boolean if the TextField or TextArea will not be rendered along with a FormMessage component. This will prevent the aria-describedby prop from being returned when set to true.

Optional errorIcon

errorIcon?: ReactNode

An optional error icon used in the getErrorIcon option.

Optional fixOnBlur

fixOnBlur?: FixNumberOnBlur
see

FixNumberOnBlur

Optional getErrorIcon

getErrorIcon?: GetErrorIcon

A function used to get the error icon to display at the right of the TextField or TextArea. The default behavior will only show an icon when the error state is true and an errorIcon option has been provided.

Optional getErrorMessage

getErrorMessage?: GetErrorMessage

A function to get and display an error message based on the TextField or TextArea validity. See defaultGetErrorMessage for the default implementation details.

Optional helpText

helpText?: ReactNode

An optional help text to display in the FormMessage component when there is not an error.

id

id: string

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

Optional isErrored

isErrored?: IsErrored

A function used to determine if the TextField or TextArea is an in errored state. See defaultIsErrored for the default implementation details.

Optional max

max?: number

An optional max value for the number field.

Optional maxLength

maxLength?: number

Optional min

min?: number

An optional min value for the number field.

Optional minLength

minLength?: number

Optional onBlur

onBlur?: FocusEventHandler<HTMLInputElement | HTMLTextAreaElement>

Optional onChange

onChange?: FormEventHandler<HTMLInputElement | HTMLTextAreaElement>

Optional onErrorChange

onErrorChange?: ErrorChangeHandler

An optional function that will be called whenever the error state is changed. This can be used for more complex forms to disable the Submit button or anything else if any field has an error.

Optional pattern

pattern?: string

Optional required

required?: boolean

Optional step

step?: number

An optional step amount to use.

Note: The min and max values must be divisible by this value when any are defined.

Optional theme

theme?: FormTheme

The current theme type.

Optional updateOnChange

updateOnChange?: boolean

Boolean if the number value should be updated as the user types instead of only once the text field has been blurred.

Optional validateOnChange

validateOnChange?: ChangeValidationBehavior

Describes the validation behavior that should be done when the value within the TextField changes. This can either be:

  • a boolean
  • the string "recommended"
  • a single key of the ValidityState that should trigger the validation
  • a list of keys of the ValidityState that should trigger the validation

Generated using TypeDoc