Class FormField

Description

Represents a form field where users can enter values.

Hierarchy

  • FormField

Properties

fieldKey inputType key placeholder? regex? required temporaryAnswer? title

Accessors

isSubmittable

Methods

isValid

Properties

Readonly fieldKey

fieldKey: string

Deprecated

Use FormField.key instead.

Readonly inputType

inputType: FormFieldInputType

The input type of the form field.

Readonly key

key: string

The key of the form field.

Optional Readonly placeholder

placeholder?: string

The placeholder of this form field when the input value is empty.

Optional Readonly regex

regex?: string

The regular expression of this form field to validate the input value.

Readonly required

required: boolean

Whether this form field is required or not.

Optional temporaryAnswer

temporaryAnswer?: string

The temporary answer to this form field to store the input value before submitting. It becomes null when it is submitted.

Readonly title

title: string

The title of the form field.

Accessors

isSubmittable

  • get isSubmittable(): boolean

  • Whether this form field is submittable or not.

    Returns boolean

Methods

isValid

  • Parameters

    • value: string

    Returns boolean

    Description

    Whether the given string is valid or not. If the regex is null or not a regular expression, it always returns true.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc