Class: CheckboxGroupComponent<T>
checkbox-group.CheckboxGroupComponent
CheckboxGroupComponent allows user to pass a list of options and check
multiple ones using checkboxes. It is possible to filter the list of
options by a search query using a searchControl,
this option is determined using canBeFiltered.
The CheckboxGroupComponent is connected to an embeddedControl, and every change
on selection, should reflect on control value.
Type parameters​
| Name |
|---|
T |
Hierarchy​
ControlComponent<T[]>↳
CheckboxGroupComponent
Implements​
HasOptionsProvider<T>OnInitOnChanges
Constructors​
constructor​
• new CheckboxGroupComponent<T>(i18n, logger, cdr, controlContainer)
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type |
|---|---|
i18n | I18nService |
logger | Logger |
cdr | ChangeDetectorRef |
controlContainer | ControlContainer |
Overrides​
ControlComponent<T[]\>.constructor
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:103
Properties​
_counts​
• Private _counts: Nil<SelectOptionCounts>
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:100
_model​
• Protected _model: T[]
Inherited from​
ControlComponent._model
Defined in​
libs/ng-core/src/lib/components/control.component.ts:63
_optionsProvider​
• Private _optionsProvider: SelectOptionsProvider<T>
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:99
allOptions​
• Private allOptions: SelectOption<T>[] = []
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:101
canBeFiltered​
• canBeFiltered: boolean = false
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:76
cdr​
• Protected cdr: ChangeDetectorRef
Inherited from​
ControlComponent.cdr
controlChanged​
• Protected controlChanged: Subject<void>
Inherited from​
ControlComponent.controlChanged
Defined in​
libs/ng-core/src/lib/components/control.component.ts:61
controlContainer​
• Protected Optional controlContainer: ControlContainer
Inherited from​
ControlComponent.controlContainer
defaultValue​
• Optional defaultValue: T[]
Inherited from​
ControlComponent.defaultValue
Defined in​
libs/ng-core/src/lib/components/control.component.ts:59
direction​
• direction: "row" | "column" = 'column'
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:78
disabled​
• disabled: boolean = false
Inherited from​
ControlComponent.disabled
Defined in​
libs/ng-core/src/lib/components/control.component.ts:53
embeddedControl​
• embeddedControl: FormControl
Overrides​
ControlComponent.embeddedControl
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:94
inputLabel​
• Optional inputLabel: string
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:84
label​
• Optional label: string
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:56
logger​
• Protected logger: Logger
Inherited from​
ControlComponent.logger
name​
• Optional name: string
Inherited from​
ControlComponent.name
Defined in​
libs/ng-core/src/lib/components/control.component.ts:23
onDestroy$​
• onDestroy$: Observable<void>
Inherited from​
ControlComponent.onDestroy$
Defined in​
libs/ng-core/src/lib/mixins/on-destroy.mixin.ts:9
onModelChange​
• Protected onModelChange: Function
Inherited from​
ControlComponent.onModelChange
Defined in​
libs/ng-core/src/lib/components/control.component.ts:129
onModelTouched​
• Protected onModelTouched: Function
Inherited from​
ControlComponent.onModelTouched
Defined in​
libs/ng-core/src/lib/components/control.component.ts:131
options​
• options: SelectOption<T>[] = []
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:66
optionsGroups​
• optionsGroups: SelectOptionGroup<T>[] = []
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:97
removeDisabledOptions​
• removeDisabledOptions: boolean = true
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:82
required​
• Optional required: boolean
Inherited from​
ControlComponent.required
Defined in​
libs/ng-core/src/lib/components/control.component.ts:20
searchControl​
• searchControl: FormControl
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:95
seeMore​
• seeMore: boolean = false
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:89
selectedOption​
• Optional selectedOption: SelectOption<T>
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:91
selectedOptionIndex​
• selectedOptionIndex: number = -1
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:92
sortType​
• Optional sortType: SelectOptionSortType
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:80
subSink​
• subSink: Subscription
Inherited from​
ControlComponent.subSink
Defined in​
libs/ng-core/src/lib/mixins/on-destroy.mixin.ts:10
template​
• template: TemplateRef<unknown>
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:87
trackBySelectOption​
• trackBySelectOption: <T>(index: number, option: SelectOption<T>) => T = trackBySelectOption
Type declaration​
â–¸ <T>(index, option): T
a TrackByFn to be used with an *ngFor in case it is used on an array of {@link SelectOption}
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type |
|---|---|
index | number |
option | SelectOption<T> |
Returns​
T
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:96
valueChanges​
• Optional valueChanges: Observable<any>
Inherited from​
ControlComponent.valueChanges
Defined in​
libs/ng-core/src/lib/components/control.component.ts:57
arguments​
â–ª Static arguments: any
Inherited from​
ControlComponent.arguments
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:302
caller​
â–ª Static caller: Function
Inherited from​
ControlComponent.caller
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:303
length​
â–ª Static Readonly length: number
Inherited from​
ControlComponent.length
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:299
name​
â–ª Static Readonly name: string
Returns the name of the function. Function names are read-only and can not be changed.
Inherited from​
ControlComponent.name
Defined in​
apps/docs/node_modules/typescript/lib/lib.es2015.core.d.ts:97
Accessors​
counts​
• get counts(): Nil<SelectOptionCounts>
Returns​
Nil<SelectOptionCounts>
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:68
• set counts(value): void
Parameters​
| Name | Type |
|---|---|
value | Nil<SelectOptionCounts> |
Returns​
void
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:71
formControl​
• get formControl(): Maybe<AbstractControl>
Returns​
Maybe<AbstractControl>
Inherited from​
ControlComponent.formControl
Defined in​
libs/ng-core/src/lib/components/control.component.ts:36
• set formControl(value): void
Parameters​
| Name | Type |
|---|---|
value | Maybe<AbstractControl> |
Returns​
void
Inherited from​
ControlComponent.formControl
Defined in​
libs/ng-core/src/lib/components/control.component.ts:40
formControlName​
• get formControlName(): Maybe<string>
Returns​
Maybe<string>
Inherited from​
ControlComponent.formControlName
Defined in​
libs/ng-core/src/lib/components/control.component.ts:26
• set formControlName(value): void
Parameters​
| Name | Type |
|---|---|
value | Maybe<string> |
Returns​
void
Inherited from​
ControlComponent.formControlName
Defined in​
libs/ng-core/src/lib/components/control.component.ts:30
model​
• get model(): MODEL
Returns​
MODEL
Inherited from​
ControlComponent.model
Defined in​
libs/ng-core/src/lib/components/control.component.ts:45
• set model(value): void
Parameters​
| Name | Type |
|---|---|
value | MODEL |
Returns​
void
Inherited from​
ControlComponent.model
Defined in​
libs/ng-core/src/lib/components/control.component.ts:49
optionsProvider​
• get optionsProvider(): SelectOptionsProvider<T>
Returns​
SelectOptionsProvider<T>
Implementation of​
HasOptionsProvider.optionsProvider
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:62
• set optionsProvider(value): void
Parameters​
| Name | Type |
|---|---|
value | SelectOptionsProvider<T> |
Returns​
void
Implementation of​
HasOptionsProvider.optionsProvider
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:58
Methods​
embeddedValueToValue​
â–¸ Protected embeddedValueToValue(value): T[]
Parameters​
| Name | Type |
|---|---|
value | T[] |
Returns​
T[]
Inherited from​
ControlComponent.embeddedValueToValue
Defined in​
libs/ng-core/src/lib/components/control.component.ts:123
emptySink​
â–¸ emptySink(): void
Returns​
void
Inherited from​
ControlComponent.emptySink
Defined in​
libs/ng-core/src/lib/mixins/on-destroy.mixin.ts:13
firstUntilDestroyed​
â–¸ firstUntilDestroyed<T>(): MonoTypeOperatorFunction<T>
Type parameters​
| Name |
|---|
T |
Returns​
MonoTypeOperatorFunction<T>
Inherited from​
ControlComponent.firstUntilDestroyed
Defined in​
libs/ng-core/src/lib/mixins/on-destroy.mixin.ts:12
getContext​
â–¸ getContext(option): Object
getContext provides option context for ng-template
adding more flexibility for customizing chip template of selected options
Parameters​
| Name | Type |
|---|---|
option | SelectOption<T> |
Returns​
Object
| Name | Type |
|---|---|
$implicit | SelectOption<T> |
option | SelectOption<T> |
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:175
getCount​
â–¸ getCount(option): number
getCount provides count of each option
Parameters​
| Name | Type |
|---|---|
option | SelectOption<T> |
Returns​
number
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:159
ngOnChanges​
â–¸ ngOnChanges(changes): void
Parameters​
| Name | Type |
|---|---|
changes | SimpleChanges |
Returns​
void
Implementation of​
OnChanges.ngOnChanges
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:117
ngOnDestroy​
â–¸ ngOnDestroy(): void
A callback method that performs custom clean-up, invoked immediately before a directive, pipe, or service instance is destroyed.
Returns​
void
Inherited from​
ControlComponent.ngOnDestroy
Defined in​
node_modules/@angular/core/core.d.ts:5167
ngOnInit​
â–¸ ngOnInit(): void
Returns​
void
Implementation of​
OnInit.ngOnInit
Overrides​
ControlComponent.ngOnInit
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:107
onChange​
â–¸ onChange(event, option): void
onChange update list of checked options and refreshes the value of embeddedControl
Parameters​
| Name | Type |
|---|---|
event | MatCheckboxChange |
option | SelectOption<T> |
Returns​
void
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:141
registerOnChange​
â–¸ registerOnChange(fn): void
Parameters​
| Name | Type |
|---|---|
fn | Function |
Returns​
void
Inherited from​
ControlComponent.registerOnChange
Defined in​
libs/ng-core/src/lib/components/control.component.ts:96
registerOnTouched​
â–¸ registerOnTouched(fn): void
Parameters​
| Name | Type |
|---|---|
fn | Function |
Returns​
void
Inherited from​
ControlComponent.registerOnTouched
Defined in​
libs/ng-core/src/lib/components/control.component.ts:100
setDisabledState​
â–¸ setDisabledState(isDisabled): void
Parameters​
| Name | Type |
|---|---|
isDisabled | boolean |
Returns​
void
Inherited from​
ControlComponent.setDisabledState
Defined in​
libs/ng-core/src/lib/components/control.component.ts:104
setModelAndEmit​
â–¸ setModelAndEmit(value): void
Parameters​
| Name | Type |
|---|---|
value | T[] |
Returns​
void
Inherited from​
ControlComponent.setModelAndEmit
Defined in​
libs/ng-core/src/lib/components/control.component.ts:112
setOptions​
â–¸ Private setOptions(): void
setOptions provides the list of options and optionsGroups
list updates with searchControl value changes, which filters list of options based on search query
Returns​
void
Defined in​
libs/legi-shared/checkbox-group/checkbox-group.component.ts:185
untilDestroyed​
â–¸ untilDestroyed<T>(): MonoTypeOperatorFunction<T>
Type parameters​
| Name |
|---|
T |
Returns​
MonoTypeOperatorFunction<T>
Inherited from​
ControlComponent.untilDestroyed
Defined in​
libs/ng-core/src/lib/mixins/on-destroy.mixin.ts:11
valueToEmbeddedValue​
â–¸ Protected valueToEmbeddedValue(value): T[]
Parameters​
| Name | Type |
|---|---|
value | T[] |
Returns​
T[]
Inherited from​
ControlComponent.valueToEmbeddedValue
Defined in​
libs/ng-core/src/lib/components/control.component.ts:119
writeValue​
â–¸ writeValue(value): void
Parameters​
| Name | Type |
|---|---|
value | T[] |
Returns​
void
Inherited from​
ControlComponent.writeValue
Defined in​
libs/ng-core/src/lib/components/control.component.ts:85
[hasInstance]​
â–¸ Static [hasInstance](value): boolean
Determines whether the given value inherits from this function if this function was used as a constructor function.
A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.
Parameters​
| Name | Type |
|---|---|
value | any |
Returns​
boolean
Inherited from​
ControlComponent.__@hasInstance@35749
Defined in​
apps/docs/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:162
apply​
â–¸ Static apply<T>(thisArg): void
Calls the function with the specified object as the this value and the elements of specified array as the arguments.
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type | Description |
|---|---|---|
thisArg | T | The object to be used as the this object. |
Returns​
void
Inherited from​
ControlComponent.apply
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:364
â–¸ Static apply<T, A>(thisArg, args): void
Type parameters​
| Name | Type |
|---|---|
T | T |
A | extends any[] |
Parameters​
| Name | Type |
|---|---|
thisArg | T |
args | A |
Returns​
void
Inherited from​
ControlComponent.apply
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:365
â–¸ Static apply(thisArg, argArray?): any
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
Parameters​
| Name | Type | Description |
|---|---|---|
thisArg | any | The object to be used as the this object. |
argArray? | any | A set of arguments to be passed to the function. |
Returns​
any
Inherited from​
ControlComponent.apply
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:278
bind​
â–¸ Static bind<T>(thisArg): T
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Type parameters​
| Name |
|---|
T |
Parameters​
| Name | Type | Description |
|---|---|---|
thisArg | any | The object to be used as the this object. |
Returns​
T
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:380
â–¸ Static bind<A0, A, R>(thisArg, arg0): (...args: A) => R
Type parameters​
| Name | Type |
|---|---|
A0 | A0 |
A | extends any[] |
R | R |
Parameters​
| Name | Type |
|---|---|
thisArg | any |
arg0 | A0 |
Returns​
fn
• new bind(...args)
Parameters​
| Name | Type |
|---|---|
...args | A |
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:381
â–¸ Static bind<A0, A1, A, R>(thisArg, arg0, arg1): (...args: A) => R
Type parameters​
| Name | Type |
|---|---|
A0 | A0 |
A1 | A1 |
A | extends any[] |
R | R |
Parameters​
| Name | Type |
|---|---|
thisArg | any |
arg0 | A0 |
arg1 | A1 |
Returns​
fn
• new bind(...args)
Parameters​
| Name | Type |
|---|---|
...args | A |
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:382
â–¸ Static bind<A0, A1, A2, A, R>(thisArg, arg0, arg1, arg2): (...args: A) => R
Type parameters​
| Name | Type |
|---|---|
A0 | A0 |
A1 | A1 |
A2 | A2 |
A | extends any[] |
R | R |
Parameters​
| Name | Type |
|---|---|
thisArg | any |
arg0 | A0 |
arg1 | A1 |
arg2 | A2 |
Returns​
fn
• new bind(...args)
Parameters​
| Name | Type |
|---|---|
...args | A |
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:383
â–¸ Static bind<A0, A1, A2, A3, A, R>(thisArg, arg0, arg1, arg2, arg3): (...args: A) => R
Type parameters​
| Name | Type |
|---|---|
A0 | A0 |
A1 | A1 |
A2 | A2 |
A3 | A3 |
A | extends any[] |
R | R |
Parameters​
| Name | Type |
|---|---|
thisArg | any |
arg0 | A0 |
arg1 | A1 |
arg2 | A2 |
arg3 | A3 |
Returns​
fn
• new bind(...args)
Parameters​
| Name | Type |
|---|---|
...args | A |
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:384
â–¸ Static bind<AX, R>(thisArg, ...args): (...args: AX[]) => R
Type parameters​
| Name |
|---|
AX |
R |
Parameters​
| Name | Type |
|---|---|
thisArg | any |
...args | AX[] |
Returns​
fn
• new bind(...args)
Parameters​
| Name | Type |
|---|---|
...args | AX[] |
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:385
â–¸ Static bind(thisArg, ...argArray): any
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Parameters​
| Name | Type | Description |
|---|---|---|
thisArg | any | An object to which the this keyword can refer inside the new function. |
...argArray | any[] | A list of arguments to be passed to the new function. |
Returns​
any
Inherited from​
ControlComponent.bind
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:293
call​
â–¸ Static call<T, A>(thisArg, ...args): void
Calls the function with the specified object as the this value and the specified rest arguments as the arguments.
Type parameters​
| Name | Type |
|---|---|
T | T |
A | extends any[] |
Parameters​
| Name | Type | Description |
|---|---|---|
thisArg | T | The object to be used as the this object. |
...args | A | Argument values to be passed to the function. |
Returns​
void
Inherited from​
ControlComponent.call
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:372
â–¸ Static call(thisArg, ...argArray): any
Calls a method of an object, substituting another object for the current object.
Parameters​
| Name | Type | Description |
|---|---|---|
thisArg | any | The object to be used as the current object. |
...argArray | any[] | A list of arguments to be passed to the method. |
Returns​
any
Inherited from​
ControlComponent.call
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:285
toString​
â–¸ Static toString(): string
Returns a string representation of a function.
Returns​
string
Inherited from​
ControlComponent.toString
Defined in​
apps/docs/node_modules/typescript/lib/lib.es5.d.ts:296