Class NameFormControl<TProps>

Type Parameters

TProps extends EmptyObject = EmptyObject

Hierarchy (view full)

FormControlBase<TProps>
- NameFormControl

Constructors

constructor

new NameFormControl<TProps>(nameLabel, autoCompleteLabel, placeHolder): NameFormControl<TProps>
Type Parameters
- TProps extends object = object
Parameters
- nameLabel: string
- autoCompleteLabel: string
- placeHolder: string
Returns NameFormControl<TProps>
Overrides FormControlBase.constructor
- Defined in packages/sdk/packages/form/packages/credit-card/dist/browser/index.d.ts:208

Properties

cursorPosition

cursorPosition: CursorPosition

eventData

eventData: AbstractControlEvents<ValidControlValue>

invalidMessage

invalidMessage: string

onChange

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

onCursorChange

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

onErrorChange

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

onTouched

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

pattern

pattern: RegExp

patternStrict

patternStrict: RegExp

props

props: TProps

required

required: boolean

`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
Inherited from FormControlBase.disabled
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:90

enabled

get enabled(): boolean
Returns boolean
Inherited from FormControlBase.enabled
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:91

error

get error(): string
Returns string
Inherited from FormControlBase.error
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:58

invalid

get invalid(): boolean
Returns boolean
Inherited from FormControlBase.invalid
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:92

logger

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

name

get name(): undefined | string
Returns undefined | string
Inherited from FormControlBase.name
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:134

params

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

pending

get pending(): boolean
Returns boolean
Inherited from FormControlBase.pending
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:93

previousValue

get previousValue(): TValue
Returns TValue
Inherited from FormControlBase.previousValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:59

rawValue

get rawValue(): ValidControlValue
Returns ValidControlValue
Inherited from FormControlBase.rawValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:135

serializeSettings

get serializeSettings(): ControlSerializeSettings
Returns ControlSerializeSettings
Inherited from FormControlBase.serializeSettings
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:60

status

get status(): undefined | FormControlStatus
Returns undefined | FormControlStatus
Inherited from FormControlBase.status
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:95

touched

get touched(): boolean
Returns boolean
Inherited from FormControlBase.touched
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:61

valid

get valid(): boolean
Returns boolean
Inherited from FormControlBase.valid
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:96

value

get value(): TValue
Returns TValue
Inherited from FormControlBase.value
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:62

`Static`historyInterval

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

`Static`historyTime

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

`Static`maxGcFrequency

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

`Static`maxHistoryDepth

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

Methods

blurError

blurError(value): void
Parameters
- value: string
Returns void
Overrides FormControlBase.blurError
- Defined in packages/sdk/packages/form/packages/credit-card/dist/browser/index.d.ts:209

changeError

changeError(value): void
Parameters
- value: string
Returns void
Overrides FormControlBase.changeError
- Defined in packages/sdk/packages/form/packages/credit-card/dist/browser/index.d.ts:210

clearListeners

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

`Optional`getCursorPosition

getCursorPosition(): undefined | number
Returns undefined | number
Inherited from FormControlBase.getCursorPosition
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:138

listenerCount

listenerCount(eventNames): number
Parameters
- eventNames: (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged" | (keyof ControlValueAccessorBaseEvents<ValidControlValue> | "statusChanged")[]
Returns number
Inherited from FormControlBase.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
Inherited from FormControlBase.mask
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:139

off

off<TEventName>(eventNames, listener): void
Type Parameters
- TEventName extends (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns void
Inherited from FormControlBase.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
Inherited from FormControlBase.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 (keyof ControlValueAccessorBaseEvents<ValidControlValue>) | "statusChanged"
Parameters
- eventNames: TEventName | TEventName[]
- listener: EventListener<AbstractControlEvents<ValidControlValue>[TEventName]>
Returns (() => void)
- - (): void
  - Returns void
Inherited from FormControlBase.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
Inherited from FormControlBase.onAny
- Defined in node_modules/@xyo-network/module-event-emitter/dist/neutral/BaseEmitter.d.ts:15

once

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

registerOnChange

registerOnChange(fn): void
Parameters
- fn: ((_value: ValidControlValue) => void)
  - - (_value): void
    - Parameters
      _value: ValidControlValue
      Returns void
Returns void
Inherited from FormControlBase.registerOnChange
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:66

registerOnErrorChange

registerOnErrorChange(fn): void
Parameters
- fn: ((error: string) => void)
  - - (error): void
    - Parameters
      error: string
      Returns void
Returns void
Inherited from FormControlBase.registerOnErrorChange
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:67

registerOnTouched

registerOnTouched(fn): void
Parameters
- fn: ((isTouched: boolean) => void)
  - - (isTouched): void
    - Parameters
      isTouched: boolean
      Returns void
Returns void
Inherited from FormControlBase.registerOnTouched
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:68

`Protected`setError

setError(error): void
Parameters
- error: string
Returns void
Inherited from FormControlBase.setError
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:71

setErrorAndValidity

setErrorAndValidity(error, status): void
Parameters
- error: string
- status: FormControlStatus
Returns void
Inherited from FormControlBase.setErrorAndValidity
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:97

`Protected`setName

setName(name): void
Parameters
- name: undefined | string
Returns void
Inherited from FormControlBase.setName
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:144

`Protected`setPreviousValue

setPreviousValue(value): void
Parameters
- value: ValidControlValue
Returns void
Inherited from FormControlBase.setPreviousValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:72

`Protected`setSerializeSettings

setSerializeSettings(settings): void
Parameters
- settings: ControlSerializeSettings
Returns void
Inherited from FormControlBase.setSerializeSettings
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:73

setStatus

setStatus(status): void
Parameters
- status: FormControlStatus
Returns void
Inherited from FormControlBase.setStatus
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:98

setTouched

setTouched(isTouched): void
Parameters
- isTouched: boolean
Returns void
Inherited from FormControlBase.setTouched
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:69

setValue

setValue(value, setOptions): void
Parameters
- value: undefined | string
- setOptions: SetOptions
Returns void
Inherited from FormControlBase.setValue
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:141

`Optional`unmask

unmask(value): string
Parameters
- value: string
Returns string
Inherited from FormControlBase.unmask
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:142

validate

validate(): boolean
Returns boolean
Inherited from FormControlBase.validate
- Defined in packages/sdk/packages/form/packages/group/dist/browser/index.d.ts:143

`Static`gc

gc(force?): void
Parameters
- Optionalforce: boolean
Returns void
Inherited from FormControlBase.gc
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:29
gc(className): void
Parameters
- className: string
Returns void
Inherited from FormControlBase.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 FormControlBase.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 FormControlBase.instanceCounts
- Defined in node_modules/@xylabs/object/dist/neutral/Base.d.ts:32

`Static`startHistory

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

`Static`stopHistory

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

Class NameFormControl<TProps>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NameFormControl<TProps>

Properties

cursorPosition

eventData

invalidMessage

onChange

onCursorChange

onErrorChange

onTouched

pattern

patternStrict

props

required

Static OptionaldefaultLogger

Static ReadonlyglobalInstances

Static ReadonlyglobalInstancesCountHistory

Static ReadonlyuniqueName

Accessors

disabled

Returns boolean

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

blurError

Parameters

Returns void

changeError

Parameters

`Static` `Optional`defaultLogger

`Static` `Readonly`globalInstances

`Static` `Readonly`globalInstancesCountHistory

`Static` `Readonly`uniqueName

`Static`historyInterval

`Static`historyTime

`Static`maxGcFrequency

`Static`maxHistoryDepth

`Optional`getCursorPosition

`Optional`mask

`Protected`setError

`Protected`setName

`Protected`setPreviousValue

`Protected`setSerializeSettings