Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@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

No documentation has been provided.

Presentation
registerOnChange(fn: any): void;
Parameters
NameTypeDescription
fn
any

The callback function to register

Returns
void

registerOnTouched()

inherited from ControlValueAccessor

No documentation has been provided.

Presentation
registerOnTouched(fn: any): void;
Parameters
NameTypeDescription
fn
any

The callback function to register

Returns
void

setDisabledState()

inherited from ControlValueAccessor

No documentation has been provided.

Presentation
setDisabledState(isDisabled: boolean): void;
Parameters
NameTypeDescription
isDisabled
boolean

The disabled status to set on the element

Returns
void

writeValue()

inherited from ControlValueAccessor

No documentation has been provided.

Presentation
writeValue(obj: any): void;
Parameters
NameTypeDescription
obj
any

The new value for the element

Returns
void