Interface SmiSingleValueControlFormApi

An API of methods and properties for forms on a single value control.

interface SmiSingleValueControlFormApi {
    addValidator(validator: (() => null | {
        [errorName: string]: string;
    })): (() => void);
    getErrors(): null | {
        [error: string]: string;
    };
    getValidationMessageId(): undefined | string;
    isDirty(): boolean;
    isInvalid(): boolean;
    isTouched(): boolean;
    isValid(): boolean;
    markAsDirty(): void;
    markAsPristine(): void;
    markAsTouched(): void;
    onShowInvalidChange(callback: ((showInvalid: boolean) => void)): (() => void);
    onValidityChange(callback: ((valid: boolean) => void)): (() => void);
    reset(): void;
    setErrors(errors: null | {
        [error: string]: string;
    }): void;
    showInvalid(): boolean;
}

Methods

addValidator getErrors getValidationMessageId isDirty isInvalid isTouched isValid markAsDirty markAsPristine markAsTouched onShowInvalidChange onValidityChange reset setErrors showInvalid

Methods

addValidator

  • addValidator(validator): (() => void)

  • Adds a validator function to the control. Returns an error object, or null if there are no errors. to the control.

    Parameters

    • validator: (() => null | {
          [errorName: string]: string;
      })

      The validator function to add.

        • (): null | {
              [errorName: string]: string;
          }

        • Returns null | {
              [errorName: string]: string;
          }

    Returns (() => void)

    A function that removes the validator.

      • (): void

      • Returns void

    Method

getErrors

  • getErrors(): null | {
        [error: string]: string;
    }

  • Returns all errors for the control.

    Returns null | {
        [error: string]: string;
    }

    An object containing the errors or null.

    Method

getValidationMessageId

  • getValidationMessageId(): undefined | string

  • Returns undefined | string

    The id of the element that is showing a validation message for the control or returns undefined if there is no message being shown.

    Method

isDirty

  • isDirty(): boolean

  • Returns whether the control is dirty. A control is dirty after the user has changed the value of the control.

    Returns boolean

    A boolean value describing if the control is dirty.

    Method

isInvalid

  • isInvalid(): boolean

  • Gives whether the control is invalid.

    Returns boolean

    A boolean value describing if the control is invalid.

    Method

isTouched

  • isTouched(): boolean

  • Returns whether the control is touched. A control is touched after the user has triggered a blur event on it.

    Returns boolean

    A boolean value describing if the control has been touched.

    Method

isValid

  • isValid(): boolean

  • Returns whether the control is valid.

    Returns boolean

    A boolean value describing if the control is valid.

    Method

markAsDirty

  • markAsDirty(): void

  • Marks the control as dirty.

    Returns void

    Method

markAsPristine

  • markAsPristine(): void

  • Marks the control as pristine.

    Returns void

    Method

markAsTouched

  • markAsTouched(): void

  • Marks the control as touched.

    Returns void

    Method

onShowInvalidChange

  • onShowInvalidChange(callback): (() => void)

  • Runs a callback when the the control's show invalid state changes.

    Parameters

    • callback: ((showInvalid: boolean) => void)
        • (showInvalid): void

        • Parameters

          • showInvalid: boolean

          Returns void

    Returns (() => void)

    A function that removes the callback.

      • (): void

      • Returns void

onValidityChange

  • onValidityChange(callback): (() => void)

  • Runs a callback when the the control's validity changes.

    Parameters

    • callback: ((valid: boolean) => void)

      A callback that is invoked with the valid state.

        • (valid): void

        • Parameters

          • valid: boolean

          Returns void

    Returns (() => void)

    A function that removes the callback.

      • (): void

      • Returns void

reset

  • reset(): void

  • Resets the form control, marking it pristine and untouched.

    Returns void

setErrors

  • setErrors(errors): void

  • Sets the given error on the control.

    Parameters

    • errors: null | {
          [error: string]: string;
      }

      The errors object.

    Returns void

    Method

showInvalid

  • showInvalid(): boolean

  • Returns whether the control should show itself as being invalid.

    Returns boolean

    A boolean value indicating whether the control should show itself as being invalid.

    Method

Settings

Member Visibility

On This Page

Methods