Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FieldDecoratorOptions

Hierarchy

  • FieldDecoratorOptions

Index

Properties

Methods

Properties

Optional auto

auto: undefined | false | true

Transforms a regular field to an auto field.

Auto fields are allowed not only to receive data comes up from native form elements with change events but also to change these elements values by form updates. It happens automatically and does not require specific actions from the user.

Optional childrenSelector

childrenSelector: undefined | string

This option defines a selector for the querySelectorAll method that will be used by an auto field to collect children form elements like <input>, <textarea>, etc. in order to apply the form changes to them. By default, it is input, select, textarea.

Methods

Optional scheduler

  • scheduler(task: function): Promise<void>
  • This option defines the function that schedules the re-subscription to the form instance. It is necessary to avoid multiple subscriptions if several options that require it are changed.

    Parameters

    • task: function

      a callback that will be run at the scheduled time.

        • (): void
        • Returns void

    Returns Promise<void>

Generated using TypeDoc