Class FormControlBase<TProps>`Abstract`

A base class for form controls and their validation.

Type Parameters

TProps extends EmptyObject = EmptyObject

Hierarchy (view full)

AbstractControl
- FormControlBase

Implements

FormControl

Constructors

constructor

new FormControlBase<TProps>(): FormControlBase<TProps>
Type Parameters
- TProps extends object = object
Returns FormControlBase<TProps>
Overrides AbstractControl.constructor
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:26

Properties

cursorPosition

cursorPosition: CursorPosition = ...

The current and previous cursor position of the input element.

eventData

eventData: AbstractControlEvents<ValidControlValue>

invalidMessage

invalidMessage: string = 'Invalid input'

onCursorChange

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

onErrorChange

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

Registers a function called when the control error changes.

pattern

pattern: RegExp = AllowAllRegex

patternStrict

patternStrict: RegExp = AllowAllRegex

props

props: TProps = ...

required

required: boolean = false

`Static` `Optional`defaultLogger

defaultLogger?: Logger

`Static` `Readonly`globalInstances

globalInstances: Record<string, WeakRef<Base<undefined | BaseParamsFields>>[]>

`Static` `Readonly`globalInstancesCountHistory

globalInstancesCountHistory: Record<string, number[]>

`Static` `Readonly`uniqueName

uniqueName: string

Accessors

disabled

get disabled(): boolean
Returns boolean
Deprecated
- disabled functionality not implemented
Implementation of FormControl.disabled
Inherited from AbstractControl.disabled
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:51

enabled

get enabled(): boolean
A control is enabled as long as its status is not DISABLED.

Returns boolean
True if the control has any status other than 'DISABLED', false if the status is 'DISABLED'.
Implementation of FormControl.enabled
Inherited from AbstractControl.enabled
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:61

error

get error(): string
The error message for the control.

Returns string
Implementation of FormControl.error
Inherited from AbstractControl.error
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:48

invalid

get invalid(): boolean
A control is invalid when its status is INVALID.

Returns boolean
True if this control has failed one or more of its validation checks, false otherwise.
Implementation of FormControl.invalid
Inherited from AbstractControl.invalid
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:72

logger

get logger(): undefined | Logger
Returns undefined | Logger
Implementation of FormControl.logger
Inherited from AbstractControl.logger
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:27

name

get name(): undefined | string
Returns undefined | string
Implementation of FormControl.name
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:30

params

get params(): TParams
Returns TParams
Implementation of FormControl.params
Inherited from AbstractControl.params
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:28

pending

get pending(): boolean
A control is pending when its status is PENDING.

Returns boolean
True if this control is in the process of conducting a validation check, false otherwise.
Implementation of FormControl.pending
Inherited from AbstractControl.pending
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:82

previousValue

get previousValue(): TValue
The "previous value" of the input element.

Returns TValue
Implementation of FormControl.previousValue
Inherited from AbstractControl.previousValue
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:55

rawValue

get rawValue(): ValidControlValue
The raw value of the control.

Returns ValidControlValue
Implementation of FormControl.rawValue
Overrides AbstractControl.rawValue
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:34

serializeSettings

get serializeSettings(): ControlSerializeSettings
The serialize settings of the input element.

Returns ControlSerializeSettings
Implementation of FormControl.serializeSettings
Inherited from AbstractControl.serializeSettings
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:62

status

get status(): undefined | FormControlStatus
The current status of the control.

Returns undefined | FormControlStatus
Implementation of FormControl.status
Inherited from AbstractControl.status
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:96

touched

get touched(): boolean
The "touched" state of the input element.

Returns boolean
Implementation of FormControl.touched
Inherited from AbstractControl.touched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:69

valid

get valid(): boolean
A control is valid when its status is VALID.

Returns boolean
True if the control has passed all of its validation tests, false otherwise.
Implementation of FormControl.valid
Inherited from AbstractControl.valid
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:106

value

get value(): TValue
The current value of the input element.

Returns TValue
Implementation of FormControl.value
Inherited from AbstractControl.value
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:76

`Static`historyInterval

get historyInterval(): number
Returns number
Inherited from AbstractControl.historyInterval
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:20
set historyInterval(value): void
Parameters
- value: number
Returns void
Inherited from AbstractControl.historyInterval
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:21

`Static`historyTime

get historyTime(): number
Returns number
Inherited from AbstractControl.historyTime
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:22
set historyTime(value): void
Parameters
- value: number
Returns void
Inherited from AbstractControl.historyTime
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:23

`Static`maxGcFrequency

get maxGcFrequency(): number
Returns number
Inherited from AbstractControl.maxGcFrequency
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:24
set maxGcFrequency(value): void
Parameters
- value: number
Returns void
Inherited from AbstractControl.maxGcFrequency
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:25

`Static`maxHistoryDepth

get maxHistoryDepth(): number
Returns number
Inherited from AbstractControl.maxHistoryDepth
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:26

Methods

`Optional`blurError

blurError(value): undefined | void
Parameters
- value: string
Returns undefined | void
Implementation of FormControl.blurError
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:38

`Optional`changeError

changeError(value): void
Parameters
- value: string
Returns void
Implementation of FormControl.changeError
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:39

clearListeners

clearListeners(eventNames): void
Parameters
- eventNames: "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | ("statusChanged" | keyof ControlValueAccessorBaseEvents<ValidControlValue>)[]
Returns void
Implementation of FormControl.clearListeners
Inherited from AbstractControl.clearListeners
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:8

emit

emit<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) = "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
- TEventArgs extends
      | {
          error: string;
      }
      | {
          touched: boolean;
      }
      | {
          status: FormControlStatus;
      }
      | {
          value: ValidControlValue;
      } = AbstractControlEvents<ValidControlValue>[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of FormControl.emit
Inherited from AbstractControl.emit
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:9

emitSerial

emitSerial<TEventName, TEventArgs>(eventName, eventArgs): Promise<void>
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) = "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
- TEventArgs extends
      | {
          error: string;
      }
      | {
          touched: boolean;
      }
      | {
          status: FormControlStatus;
      }
      | {
          value: ValidControlValue;
      } = AbstractControlEvents<ValidControlValue>[TEventName]
Parameters
- eventName: TEventName
- eventArgs: TEventArgs
Returns Promise<void>
Implementation of FormControl.emitSerial
Inherited from AbstractControl.emitSerial
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:10

`Optional`getCursorPosition

getCursorPosition(): undefined | number
Returns undefined | number
Implementation of FormControl.getCursorPosition
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:40

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | ("statusChanged" | keyof ControlValueAccessorBaseEvents<ValidControlValue>)[]
Returns number
Implementation of FormControl.listenerCount
Inherited from AbstractControl.listenerCount
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:11

`Optional`mask

mask(value): string
Parameters
- value: string
Returns string
Implementation of FormControl.mask
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:41

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns void
Implementation of FormControl.off
Inherited from AbstractControl.off
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:12

offAny

offAny(listener): void
Parameters
- listener: EventAnyListener
Returns void
Implementation of FormControl.offAny
Inherited from AbstractControl.offAny
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:13

on

on<TEventName>(eventNames, listener): (() => void)
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of FormControl.on
Inherited from AbstractControl.on
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:14

onAny

onAny(listener): (() => void)
Parameters
- listener: EventAnyListener
Returns (() => void)
- - (): void
  - Returns void
Implementation of FormControl.onAny
Inherited from AbstractControl.onAny
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:15

onChange

onChange(_): void
The registered callback function called when a change or input event occurs on the input element.
Parameters
- _: ValidControlValue
Returns void
Implementation of FormControl.onChange
Inherited from AbstractControl.onChange
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:84

onTouched

onTouched(_isTouched): void
The registered callback function called when a blur event occurs on the input element.
Parameters
- _isTouched: boolean
Returns void
Implementation of FormControl.onTouched
Inherited from AbstractControl.onTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:94

once

once<TEventName>(eventName, listener): (() => void)
Type Parameters
- TEventName extends "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue>)
Parameters
- eventName: TEventName
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Implementation of FormControl.once
Inherited from AbstractControl.once
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:16

registerOnChange

registerOnChange(fn): void
Registers a function called when the control value changes.
Parameters
- fn: ((_value: ValidControlValue) => void)
  - - (_value): void
    - Parameters
      _value: ValidControlValue
      Returns void
Returns void
void
Implementation of FormControl.registerOnChange
Inherited from AbstractControl.registerOnChange
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:101

registerOnErrorChange

registerOnErrorChange(fn): void
Registers a function called when the control error changes.
Parameters
- fn: ((error: string) => void)
  - - (error): void
    - Parameters
      error: string
      Returns void
Returns void
Implementation of FormControl.registerOnErrorChange
Inherited from AbstractControl.registerOnErrorChange
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:109

registerOnTouched

registerOnTouched(fn): void
Registers a function called when the control is touched.
Parameters
- fn: ((isTouched: boolean) => void)
  - - (isTouched): void
    - Parameters
      isTouched: boolean
      Returns void
Returns void
void
Implementation of FormControl.registerOnTouched
Inherited from AbstractControl.registerOnTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:118

`Protected`setError

setError(error): void
Set the error message for the control.
Parameters
- error: string
Returns void
Implementation of FormControl.setError
Inherited from AbstractControl.setError
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:161

setErrorAndValidity

setErrorAndValidity(error, status): void
Parameters
- error: string
- status: FormControlStatus
Returns void
Implementation of FormControl.setErrorAndValidity
Inherited from AbstractControl.setErrorAndValidity
- Defined in packages/sdk/packages/form/packages/group/src/control/AbstractControl.ts:110

`Protected`setName

setName(name): void
Parameters
- name: undefined | string
Returns void
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:81

setTouched

setTouched(isTouched): void
Sets the "touched" state of the input element.
Parameters
- isTouched: boolean
Returns void
Implementation of FormControl.setTouched
Inherited from AbstractControl.setTouched
- Defined in packages/sdk/packages/form/packages/group/src/control/accessor/ControlValueAccessorBase.ts:126

setValue

setValue(value?, setOptions): void
Sets the "value" property on the input element.
Parameters
- value: string = ''
- setOptions: SetOptions
Returns void
void
Implementation of FormControl.setValue
Overrides AbstractControl.setValue
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:44

`Optional`unmask

unmask(value): string
Parameters
- value: string
Returns string
Implementation of FormControl.unmask
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:70

validate

validate(): boolean
Returns boolean
Implementation of FormControl.validate
Overrides AbstractControl.validate
- Defined in packages/sdk/packages/form/packages/group/src/control/FormControlBase.ts:73

`Static`gc

gc(force?): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from AbstractControl.gc
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:29
gc(className): void
Parameters
- className: string
Returns void
Inherited from AbstractControl.gc
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:30

`Static`instanceCount

instanceCount(className): number
Parameters
- className: string
Returns number
Inherited from AbstractControl.instanceCount
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:31

`Static`instanceCounts

instanceCounts(): Record<string, number>
Returns Record<string, number>
Inherited from AbstractControl.instanceCounts
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:32

`Static`startHistory

startHistory(): void
Returns void
Inherited from AbstractControl.startHistory
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:33

`Static`stopHistory

stopHistory(): void
Returns void
Inherited from AbstractControl.stopHistory
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:34

Class FormControlBase<TProps>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns FormControlBase<TProps>

Properties

cursorPosition

eventData

invalidMessage

onCursorChange

onErrorChange

pattern

patternStrict

props

required

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

disabled

Returns boolean

Deprecated

enabled

Returns boolean

error

Returns string

invalid

Returns boolean

logger

Returns undefined | Logger

name

Returns undefined | string

params

Returns TParams

pending

Returns boolean

previousValue

Returns TValue

rawValue

Returns ValidControlValue

serializeSettings

Returns ControlSerializeSettings

status

Returns undefined | FormControlStatus

touched

Returns boolean

valid

Returns boolean

value

Returns TValue

StatichistoryInterval

Returns number

Parameters

Returns void

StatichistoryTime

Returns number

Parameters

Returns void

StaticmaxGcFrequency

Returns number

Parameters

Returns void

StaticmaxHistoryDepth

Returns number

Methods

OptionalblurError

Parameters

Returns undefined | void

OptionalchangeError

Parameters

Returns void

Class FormControlBase<TProps>`Abstract`

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Optional`blurError

`Optional`changeError

`Optional`getCursorPosition

`Optional`mask

`Protected`setError

`Protected`setName