@ng-doc/app / Interface

NgDocTypeControl

Generic types:T
Extends:ControlValueAccessor

Interface describing Type Control

Properties

NameTypeDescription
default
T | undefined

The default value of the input

description
string | undefined

The description of the input (based on the comment)

isManual
boolean | undefined

Determines if the property is manually added by the user using controls property in playground config

name
string | undefined

The name of the input for which it is created

options
string[] | undefined

The list of possible values, it usually works only for Type Aliases which has several values

Methods

registerOnChange()

inherited from ControlValueAccessor

@description Registers a callback function that is called when the control's value changes in the UI.

This method is called by the forms API on initialization to update the form model when values propagate from the view to the model.

When implementing the registerOnChange method in your own value accessor, save the given function so your class calls it at the appropriate time.

@usageNotes

Store the change function

The following example stores the provided function as an internal method.

registerOnChange(fn: (_: any) => void): void {
  this._onChange = fn;
}

When the value changes in the UI, call the registered function to allow the forms API to update itself:

host: {
   '(change)': '_onChange($event.target.value)'
}
Presentation
registerOnChange(fn: any): void;
Parameters
NameTypeDescription
fn
any

@param fn The callback function to register

Returns
void

registerOnTouched()

inherited from ControlValueAccessor

@description Registers a callback function that is called by the forms API on initialization to update the form model on blur.

When implementing registerOnTouched in your own value accessor, save the given function so your class calls it when the control should be considered blurred or "touched".

@usageNotes

Store the callback function

The following example stores the provided function as an internal method.

registerOnTouched(fn: any): void {
  this._onTouched = fn;
}

On blur (or equivalent), your class should call the registered function to allow the forms API to update itself:

host: {
   '(blur)': '_onTouched()'
}
Presentation
registerOnTouched(fn: any): void;
Parameters
NameTypeDescription
fn
any

@param fn The callback function to register

Returns
void

setDisabledState()

inherited from ControlValueAccessor

@description Function that is called by the forms API when the control status changes to or from 'DISABLED'. Depending on the status, it enables or disables the appropriate DOM element.

@usageNotes The following is an example of writing the disabled property to a native DOM element:

setDisabledState(isDisabled: boolean): void {
  this._renderer.setProperty(this._elementRef.nativeElement, 'disabled', isDisabled);
}
Presentation
setDisabledState(isDisabled: boolean): void;
Parameters
NameTypeDescription
isDisabled
boolean

@param isDisabled The disabled status to set on the element

Returns
void

writeValue()

inherited from ControlValueAccessor

@description Writes a new value to the element.

This method is called by the forms API to write to the view when programmatic changes from model to view are requested.

@usageNotes

Write a value to the element

The following example writes a value to the native DOM element.

writeValue(value: any): void {
  this._renderer.setProperty(this._elementRef.nativeElement, 'value', value);
}
Presentation
writeValue(obj: any): void;
Parameters
NameTypeDescription
obj
any

@param obj The new value for the element

Returns
void