Class FormField

ReadonlyfieldName

Readonlyid

Readonlyvalidator

Computederrors

• get errors(): ReadonlySet<string>

  Error messages for the field

  Regardless of isErrorReported, this value is always up-to-date.

  Returns ReadonlySet<string>

ComputedhasErrors

• get hasErrors(): boolean

  Whether the field has errors

  Regardless of isErrorReported, this value is always up-to-date.

  Returns boolean

isChanged

• get isChanged(): boolean

  Whether the field value is changed

  Returns boolean

ComputedisErrorReported

• get isErrorReported(): undefined | boolean

  Whether the error states has been reported.

  Check this value to determine if errors should be displayed to the user.

  Returns undefined | boolean

  • undefined - Validity is undetermined (not yet reported)
  • false - Field is valid
  • true - Field is invalid

  Remarks

  • Error reporting is delayed until validation is complete.
  • It can be used directly with the aria-invalid attribute.

isIntermediate

• get isIntermediate(): boolean

  Whether the field value is intermediate (partial input)

  Returns boolean

  Example

  - Typing "user@" in an email field
  - Typing a partial date "2024-"
  Copy

  Remarks

  Intermediate values are automatically finalized after a delay

isTouched

• get isTouched(): boolean

  Whether the field is touched.

  A field becomes touched when the user interacts with it.

  Returns boolean

finalizeChangeIfNeeded

• finalizeChangeIfNeeded(): void

  Finalize the intermediate change if needed (usually triggered by onBlur)

  Returns void

ActionmarkAsChanged

• markAsChanged(type?: ChangeType): void

  Mark the field as changed

  It's usually triggered by onChange.

  Parameters

  • type: ChangeType = "final"

    Default to "final"

  Returns void

  Remarks

  • "final" immediately reports errors
  • "intermediate" schedules auto-finalization after delay

ActionmarkAsTouched

• markAsTouched(): void

  Mark the field as touched

  It's usually triggered by onFocus.

  Returns void

ActionreportError

• reportError(): void

  Report the errors of the field.

  It will wait until the validation is up-to-date before reporting the errors.

  Returns void

Actionreset

• reset(): void

  Reset the field state

  Returns void

  Remarks

  • Clears touched state
  • Clears change state
  • Clears error reporting
  • Cancels any pending auto-finalization