Class formItems<T>

Type Parameters

  • T extends AnyItem = FormField | FormGroup | FormButton

Methods

disable emitChange enable excludeDates getValue hasValue hide input removePicklist setCustomValidation setEmpty setInvalid setLabel setMandatory setMessage setOptional setRequired setRequiredAny setRequiredNone setValid setValue show switchType validate

Methods

disable

  • disable(): void

    Returns void

    Example

    fields('tag').disable();

emitChange

  • emitChange(): void

    Returns void

    Example

    fields('tag').emitChange();

enable

  • enable(): void

    Returns void

    Example

    fields('tag').enable();

excludeDates

  • excludeDates(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').excludeDays([new Date("2025-07-17"), new Date("2025-03-26")]);

getValue

  • getValue(...args: any[]): any

    Parameters

    • ...args: any[]

    Returns any

    Example

    const value = fields('tag').getValue();

hasValue

  • hasValue(): boolean

    Returns boolean

    Example

    if(fields('tag').hasValue()) {
      console.info('field has value');
    }

hide

  • hide(): void

    Returns void

    Example

    fields('tag').hide();

input

  • input(): any

    Returns any

    Example

    const inputs = fields('tag').input();

removePicklist

  • removePicklist(): void

    Returns void

    Example

    fields('tag').removePicklist();

setCustomValidation

  • setCustomValidation(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').setCustomValidation(() => {
     if(fields('tag').getValue() === 'test') {
         return 'Field is currently invalid. Please enter a valid value.';
     } else {
         return;
     }
    });

setEmpty

  • setEmpty(): void

    Returns void

    Example

    fields('tag').setEmpty();

setInvalid

  • setInvalid(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').setInvalid('Field is invalid because it is not an email-address');

setLabel

  • setLabel(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').setLabel("Suffix");

setMandatory

  • setMandatory(): void

    Returns void

    Example

    fields('tag').setMandatory();

setMessage

  • setMessage(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').setMessage("There is something wrong with this field.");

setOptional

  • setOptional(): void

    Returns void

    Example

    fields('tag').setOptional();

setRequired

setRequiredAny

  • setRequiredAny(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').setRequiredAny(fields('required_fields'));

setRequiredNone

  • setRequiredNone(): void

    Returns void

    Example

    fields('tag').setRequiredAny();

setValid

  • setValid(): void

    Returns void

    Example

    fields('tag').setValid();

setValue

  • setValue(...args: any[]): void

    Parameters

    • ...args: any[]

    Returns void

    Example

    fields('tag').setValue('newValue');

show

  • show(): void

    Returns void

    Example

    fields('tag').show();

switchType

  • switchType(
        options: {
            dataType?: SimpleTypes;
            multivalueType?: "set" | "list" | "single" | "singleValue";
        },
    ): void

    Parameters

    • options: {
          dataType?: SimpleTypes;
          multivalueType?: "set" | "list" | "single" | "singleValue";
      }

    Returns void

    Example

    fields('tag').switchType({ dataType: 'integer' });

    Example

    fields('tag').switchType({ multivalueType: 'list' });

    Example

    fields('tag').switchType({ dataType: 'string', multivalueType: 'singleValue' });

validate

  • validate(): any

    Returns any

    Example

    fields('tag').validate();

Settings

Member Visibility

On This Page

Methods