Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/app / Class

NgDocBooleanControlComponent

Decorators:@Component
Selectors:ng-doc-boolean-control
Extends:DIControl<boolean | undefined, boolean | undefined>
Implements:NgDocTypeControl<boolean | undefined>

No documentation has been provided.

Constructor

No documentation has been provided.

Presentation

Properties

NameTypeDescription
change
p
inherited from DIControlValueAccessor
(value: T | null) => void
changeDetectorRef
p r
inherited from DIControlValueAccessor
ChangeDetectorRef
config
p r
inherited from DIControl
DIControlConfig<TModel, TChildModel> | undefined
default
implements NgDocTypeControl
boolean | undefined
description
implements NgDocTypeControl
string
disabledValue
p r
inherited from DIControlValueAccessor
WritableSignal<boolean>
elementRef
p r
inherited from DIControlValueAccessor
ElementRef<HTMLElement>
incomingUpdate
p r
inherited from DIControlValueAccessor
((value: T | null) => void) | undefined
model
p r
inherited from DIControlValueAccessor
Signal<T | null>
name
implements NgDocTypeControl
string
ngControl
p r
inherited from DIControlValueAccessor
NgControl | null
renderer
p r
inherited from DIControlValueAccessor
Renderer2
touch
p
inherited from DIControl
() => void

Function that should be used to make control touched.

Accessors

get defaultValue

No documentation has been provided.

Presentation
get defaultValue(): boolean | undefined;
Type

boolean | undefined

get disabled

inherited from DIControlValueAccessor

Returns true if the control is disabled.

Presentation
get disabled(): boolean;
Type

boolean

set disabled

inherited from DIControlValueAccessor

No documentation has been provided.

Presentation
set disabled(isDisabled: boolean);
Type

boolean

get hasValue

inherited from DIControlValueAccessor

Returns true if the control is not empty.

Presentation
get hasValue(): boolean;
Type

boolean

Methods

ngOnInit()

inherited from DIControl

No documentation has been provided.

Presentation
ngOnInit(): void;
Returns
void
Overload #1

No documentation has been provided.

Presentation
ngOnInit(): void;
Returns
void

registerOnTouched()

inherited from DIControl

Method is called by the forms API.

Presentation
registerOnTouched(fn: () => void): void;
Parameters
NameTypeDescription
fn
inherited from registerOnTouched
() => void

callback function to register on touch

Returns
void
Overload #1

No documentation has been provided.

Presentation
registerOnTouched(fn: () => void): void;
Parameters
NameTypeDescription
fn
() => void
Returns
void

updateModel()

overrides DIControl

Updates the model of the current control. This is the main method that should be used to update the model.

Presentation
updateModel(obj: boolean | null | undefined): void;
Parameters
NameTypeDescription
obj
inherited from updateModel
boolean | null | undefined
Returns
void

writeValue()

inherited from DIControl

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

Presentation
writeValue(value: TModel | null): void;
Parameters
NameTypeDescription
value
inherited from writeValue
TModel | null
Returns
void
Overload #1

No documentation has been provided.

Presentation
writeValue(value: TModel | null): void;
Parameters
NameTypeDescription
value
TModel | null
Returns
void