Interface NumberField<W>

Number field within a form.

Type Parameters

W extends NumberWidget = NumberWidget

Hierarchy

BaseField<"number", number>
- NumberField

Index

Properties

helperText? key label? type validation? value? widget

Properties

`Optional` helperText

helperText?: string

Helper text.

key

key: string

The property key that this field value will appear in the returned NotificationFormSubmittedEvent.form|form object.

`Optional` label

label?: string

Input label.

type

type: "number"

Field data type.

`Optional` validation

validation?: Partial<{
    lessThan: ValidationEntry<number>;
    max: ValidationEntry<number>;
    min: ValidationEntry<number>;
    moreThan: ValidationEntry<number>;
    negative: ValidationEntry<any>;
    positive: ValidationEntry<any>;
    required: ValidationEntry<any>;
}>

Validation rules used to validate user input.

Type declaration

lessThan: ValidationEntry<number>

Number must be less than this.
max: ValidationEntry<number>

Maximum number of characters.
min: ValidationEntry<number>

Minimum number of characters.
moreThan: ValidationEntry<number>

Number must be more than this.
negative: ValidationEntry<any>

Number must be negative.
positive: ValidationEntry<any>

Number must be positive.
required: ValidationEntry<any>

The field is required to be filled in by the user.

`Optional` value

value?: number

Default value for field, and where it will be written to

widget

widget: W