Interface FormControl<TProps>

interface FormControl<TProps> {
    blurError?: ((value: string) => void);
    changeError?: ((value: string) => void);
    cursorPosition: CursorPosition;
    eventData: AbstractControlEvents<ValidControlValue>;
    getCursorPosition?: (() => undefined | number);
    mask?: ((value: string) => string);
    name?: string;
    onChange: ((_: ValidControlValue) => void);
    onCursorChange?: ((cursor: undefined | number) => void);
    onErrorChange: ((error: string) => void);
    onTouched: ((_isTouched: boolean) => void);
    pattern?: RegExp;
    patternStrict?: RegExp;
    props: TProps;
    required?: boolean;
    unmask?: ((value: string) => string);
    get disabled(): boolean;
    get enabled(): boolean;
    get error(): string;
    get invalid(): boolean;
    get logger(): undefined | Logger;
    get params(): TParams;
    get pending(): boolean;
    get previousValue(): TValue;
    get rawValue(): TValue;
    get serializeSettings(): ControlSerializeSettings;
    get status(): undefined | FormControlStatus;
    get touched(): boolean;
    get valid(): boolean;
    get value(): TValue;
    clearListeners(eventNames: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]): void;
    emit<TEventName, TEventArgs>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
    emitSerial<TEventName, TEventArgs>(eventName: TEventName, eventArgs: TEventArgs): Promise<void>;
    listenerCount(eventNames: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]): number;
    off<TEventName>(eventNames: TEventName | TEventName[], listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>): void;
    offAny(listener: EventAnyListener): void;
    on<TEventName>(eventNames: TEventName | TEventName[], listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>): (() => void);
    onAny(listener: EventAnyListener): (() => void);
    once<TEventName>(eventName: TEventName, listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>): (() => void);
    registerOnChange(fn: ((_value: ValidControlValue) => void)): void;
    registerOnErrorChange(fn: ((error: string) => void)): void;
    registerOnTouched(fn: ((isTouched: boolean) => void)): void;
    setError(error: string): void;
    setErrorAndValidity(error: string, status: FormControlStatus): void;
    setPreviousValue(value: ValidControlValue): void;
    setSerializeSettings(settings: ControlSerializeSettings): void;
    setStatus(status: FormControlStatus): void;
    setTouched(isTouched: boolean): void;
    setValue(value: ValidControlValue, options?: SetOptions): void;
    validate(): boolean;
}

Type Parameters

  • TProps extends EmptyObject = EmptyObject

Hierarchy (view full)

Implemented by

Properties

blurError? changeError? cursorPosition eventData getCursorPosition? mask? name? onChange onCursorChange? onErrorChange onTouched pattern? patternStrict? props required? unmask?

Accessors

disabled enabled error invalid logger params pending previousValue rawValue serializeSettings status touched valid value

Methods

clearListeners emit emitSerial listenerCount off offAny on onAny once registerOnChange registerOnErrorChange registerOnTouched setError setErrorAndValidity setPreviousValue setSerializeSettings setStatus setTouched setValue validate

Properties

OptionalblurError

blurError?: ((value: string) => void)

OptionalchangeError

changeError?: ((value: string) => void)

cursorPosition

cursorPosition: CursorPosition

eventData

eventData: AbstractControlEvents<ValidControlValue>

OptionalgetCursorPosition

getCursorPosition?: (() => undefined | number)

Optionalmask

mask?: ((value: string) => string)

Optional Readonlyname

name?: string

onChange

onChange: ((_: ValidControlValue) => void)

OptionalonCursorChange

onCursorChange?: ((cursor: undefined | number) => void)

onErrorChange

onErrorChange: ((error: string) => void)

onTouched

onTouched: ((_isTouched: boolean) => void)

Optionalpattern

pattern?: RegExp

OptionalpatternStrict

patternStrict?: RegExp

props

props: TProps

Optionalrequired

required?: boolean

Optionalunmask

unmask?: ((value: string) => string)

Accessors

disabled

  • get disabled(): boolean

  • Returns boolean

enabled

  • get enabled(): boolean

  • Returns boolean

error

  • get error(): string

  • Returns string

invalid

  • get invalid(): boolean

  • Returns boolean

logger

  • get logger(): undefined | Logger

  • Returns undefined | Logger

params

  • get params(): TParams

  • Returns TParams

pending

  • get pending(): boolean

  • Returns boolean

previousValue

  • get previousValue(): TValue

  • Returns TValue

rawValue

  • get rawValue(): TValue

  • Returns TValue

serializeSettings

status

  • get status(): undefined | FormControlStatus

  • Returns undefined | FormControlStatus

touched

  • get touched(): boolean

  • Returns boolean

valid

  • get valid(): boolean

  • Returns boolean

value

  • get value(): TValue

  • Returns TValue

Methods

clearListeners

  • clearListeners(eventNames): void

  • Parameters

    • eventNames: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]

    Returns void

emit

  • emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>

  • Type Parameters

    • TEventName extends (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" = (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
    • TEventArgs extends
          | {
              error: string;
          }
          | {
              touched: boolean;
          }
          | {
              value: ValidControlValue;
          }
          | {
              status: FormControlStatus;
          } = AbstractControlEvents<ValidControlValue>[TEventName]

    Parameters

    Returns Promise<void>

emitSerial

  • emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>

  • Type Parameters

    • TEventName extends (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" = (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
    • TEventArgs extends
          | {
              error: string;
          }
          | {
              touched: boolean;
          }
          | {
              value: ValidControlValue;
          }
          | {
              status: FormControlStatus;
          } = AbstractControlEvents<ValidControlValue>[TEventName]

    Parameters

    Returns Promise<void>

listenerCount

  • listenerCount(eventNames): number

  • Parameters

    • eventNames: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]

    Returns number

off

offAny

  • offAny(listener): void

  • Parameters

    • listener: EventAnyListener

    Returns void

on

onAny

  • onAny(listener): (() => void)

  • Parameters

    • listener: EventAnyListener

    Returns (() => void)

      • (): void

      • Returns void

once

registerOnChange

registerOnErrorChange

  • registerOnErrorChange(fn): void

  • Parameters

    • fn: ((error: string) => void)
        • (error): void

        • Parameters

          • error: string

          Returns void

    Returns void

registerOnTouched

  • registerOnTouched(fn): void

  • Parameters

    • fn: ((isTouched: boolean) => void)
        • (isTouched): void

        • Parameters

          • isTouched: boolean

          Returns void

    Returns void

ProtectedsetError

  • setError(error): void

  • Parameters

    • error: string

    Returns void

setErrorAndValidity

ProtectedsetPreviousValue

ProtectedsetSerializeSettings

setStatus

setTouched

  • setTouched(isTouched): void

  • Parameters

    • isTouched: boolean

    Returns void

setValue

validate

  • validate(): boolean

  • Returns boolean

Settings

Member Visibility

On This Page

Properties
Accessors
Methods