FormControl | RxCompForm

Class representing a FormControl.

Hierarchy

FormAbstract
- FormControl

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FormControl(value?: any, validators?: FormValidator | FormValidator[]): FormControl

Overrides FormAbstract.constructor
- Defined in src/form/form-control.ts:8
Create a FormControl.

example

const form = new FormControl(null);

form.changes$.subscribe(changes => { console.log(changes); });

Parameters
- Default value value: any = null
  
  The value of the control.
- Optional validators: FormValidator | FormValidator[]
  
  a list of validators.
Returns FormControl

Properties

changes$

changes$: Observable<any> = merge(this.value$, this.status$).pipe(map(() => this.value),auditTime(1),shareReplay(1))

dirty_

dirty_: boolean = false

Optional name

name: undefined | string

Optional status

status: FormStatus

status$

status$: Observable<{}> = merge(this.statusSubject, this.validatorsSubject).pipe(// auditTime(1),switchMap(() => this.validate$(this.value)),shareReplay(1))

Protected statusSubject

statusSubject: BehaviorSubject<null> = new BehaviorSubject(null)

submitted_

submitted_: boolean = false

touched_

touched_: boolean = false

validators

validators: FormValidator[]

Protected validatorsSubject

validatorsSubject: ReplaySubject<Observable<any[]>> = new ReplaySubject<Observable<any[]>>().pipe(switchAll()) as ReplaySubject<Observable<any[]>>

value$

value$: Observable<any> = this.valueSubject.pipe(distinctUntilChanged(),skip(1),tap(() => {this.submitted_ = false;this.dirty_ = true;this.statusSubject.next(null);}),shareReplay(1))

Protected valueSubject

valueSubject: BehaviorSubject<any> = new BehaviorSubject(null)

value_

value_: any = undefined

Accessors

dirty

get dirty(): boolean

Inherited from FormAbstract.dirty
- Defined in src/form/form-abstract.ts:148
Returns boolean

the dirty status

disabled

get disabled(): boolean
set disabled(disabled: boolean): void

Inherited from FormAbstract.disabled
- Defined in src/form/form-abstract.ts:123
Returns boolean

the disabled status
Inherited from FormAbstract.disabled
- Defined in src/form/form-abstract.ts:168
Parameters
- disabled: boolean
  
  the disabled state
Returns void

the disabled status

enabled

get enabled(): boolean

Inherited from FormAbstract.enabled
- Defined in src/form/form-abstract.ts:128
Returns boolean

the enabled status

errors

get errors(): {}
set errors(errors: {}): void

Inherited from FormAbstract.errors
- Defined in src/form/form-abstract.ts:12
Returns {}
- [key: string]: any
Inherited from FormAbstract.errors
- Defined in src/form/form-abstract.ts:15
Parameters
- errors: {}
  - [key: string]: any
Returns void

flags

get flags(): {}

Inherited from FormAbstract.flags
- Defined in src/form/form-abstract.ts:190
Returns {}
- [key: string]: boolean

hidden

get hidden(): boolean
set hidden(hidden: boolean): void

Inherited from FormAbstract.hidden
- Defined in src/form/form-abstract.ts:133
Returns boolean

the hidden status
Inherited from FormAbstract.hidden
- Defined in src/form/form-abstract.ts:210
Parameters
- hidden: boolean
  
  the hidden state
Returns void

the hidden status

invalid

get invalid(): boolean

Inherited from FormAbstract.invalid
- Defined in src/form/form-abstract.ts:118
Returns boolean

the invalid status

pending

get pending(): boolean

Inherited from FormAbstract.pending
- Defined in src/form/form-abstract.ts:108
Returns boolean

the pending status

pristine

get pristine(): boolean

Inherited from FormAbstract.pristine
- Defined in src/form/form-abstract.ts:153
Returns boolean

the pristine status

submitted

get submitted(): boolean
set submitted(submitted: boolean): void

Inherited from FormAbstract.submitted
- Defined in src/form/form-abstract.ts:143
Returns boolean

the submitted status
Inherited from FormAbstract.submitted
- Defined in src/form/form-abstract.ts:235
Parameters
- submitted: boolean
  
  the submitted state
Returns void

the submitted status

touched

get touched(): boolean
set touched(touched: boolean): void

Inherited from FormAbstract.touched
- Defined in src/form/form-abstract.ts:158
Returns boolean

the touched status
Inherited from FormAbstract.touched
- Defined in src/form/form-abstract.ts:243
Parameters
- touched: boolean
  
  the touched state
Returns void

the touched status

untouched

get untouched(): boolean

Inherited from FormAbstract.untouched
- Defined in src/form/form-abstract.ts:163
Returns boolean

the untouched status

valid

get valid(): boolean

Inherited from FormAbstract.valid
- Defined in src/form/form-abstract.ts:113
Returns boolean

the valid status

value

get value(): any
set value(value: any): void

Inherited from FormAbstract.value
- Defined in src/form/form-abstract.ts:251
Returns any

inner value of the control
Inherited from FormAbstract.value
- Defined in src/form/form-abstract.ts:256
Parameters
- value: any
  
  a value
Returns void

inner value of the control

visible

get visible(): boolean

Inherited from FormAbstract.visible
- Defined in src/form/form-abstract.ts:138
Returns boolean

the visible status

Methods

addValidators

addValidators(...validators: FormValidator[]): void

Inherited from FormAbstract.addValidators
- Defined in src/form/form-abstract.ts:287
adds one or more FormValidator.

Parameters
- Rest ...validators: FormValidator[]
  
  a list of validators.
Returns void

clearValidators

clearValidators(): void

Inherited from FormAbstract.clearValidators
- Defined in src/form/form-abstract.ts:304
remove all FormValidator.

Returns void

Protected initObservables_

initObservables_(): void

Inherited from FormAbstract.initObservables_
- Defined in src/form/form-abstract.ts:78
initialize observables

Returns void

Protected initSubjects_

initSubjects_(): void

Inherited from FormAbstract.initSubjects_
- Defined in src/form/form-abstract.ts:65
initialize subjects

Returns void

patch

patch(value: any): void

Inherited from FormAbstract.patch
- Defined in src/form/form-abstract.ts:276
Parameters
- value: any
  
  a value
Returns void

replaceValidators

replaceValidators(...validators: FormValidator[]): void

Inherited from FormAbstract.replaceValidators
- Defined in src/form/form-abstract.ts:296
replace one or more FormValidator.

Parameters
- Rest ...validators: FormValidator[]
  
  a list of validators.
Returns void

reset

reset(status?: FormStatus): void

Inherited from FormAbstract.reset
- Defined in src/form/form-abstract.ts:264
Parameters
- Optional status: FormStatus
  
  optional FormStatus
Returns void

validate$

validate$(value: any): Observable<{}>

Inherited from FormAbstract.validate$
- Defined in src/form/form-abstract.ts:84
Parameters
- value: any
  
  the inner control value
Returns Observable<{}>

an object with key, value errors

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Default value value: any = null

Optional validators: FormValidator | FormValidator[]

Returns FormControl

Properties

changes$

dirty_

Optional name

Optional status

status$

Protected statusSubject

submitted_

touched_

validators

Protected validatorsSubject

value$

Protected valueSubject

value_

Accessors

dirty

Returns boolean

disabled

Returns boolean

Parameters

disabled: boolean

Returns void

enabled

Returns boolean

errors

Returns {}

[key: string]: any

Parameters

errors: {}

[key: string]: any

Returns void

flags

Returns {}

[key: string]: boolean

hidden

Returns boolean

Parameters

hidden: boolean

Returns void

invalid

Returns boolean

pending

Returns boolean

pristine

Returns boolean

submitted

Returns boolean

Parameters

submitted: boolean

Returns void

touched

Returns boolean

Parameters

touched: boolean

Returns void

untouched

Returns boolean

valid

Returns boolean

value

Returns any

Parameters

value: any

Returns void

visible

Returns boolean

Methods

addValidators