Components Filters Filter Multiple Selection

Filter Multiple Selection

Overview API Examples Style Tokens

LmnFilterMultipleSelectionComponent

import { LmnFilterMultipleSelectionComponent } from '@elemental/ui';
Decorators:@Component
Generic types:SelectionValueType
Selectors:lmn-filter-multiple-selection
Extends:LmnFilter<SelectionValueType>

Properties

NameTypeDescription
checkboxGroupConfiguration
r
InputSignal<LmnFilterMultipleSelectionCheckboxGroupConfiguration | undefined>

The checkbox group configuration.

configuration
r
InputSignal<LmnFilterMultipleSelectionConfiguration>

The configuration of the filter.

filterId
r
implements LmnFilter
InputSignal<string>

The id of the filter. @required

filterItemFn
r
InputSignal<LmnFilterMultipleSelectionFilterFn<SelectionValueType> | undefined>

The filter item function.

items
r
InputSignal<LmnFilterSelectionItem<SelectionValueType>[]>

The items of the filter.

nativeElement
r
HTMLElement

The native element of the filter.

negative
r
InputSignalWithTransform<boolean, unknown>

Whether the filter is negative.

searchAccessibility
r
Signal<{ regionId: string | null; regionAriaLabel: string | null; regionAriaLabelledBy: string | null; regionAriaDescribedBy: string | null; ariaLabel: string | undefined; ariaLabelledBy: string | undefined; ariaDescribedBy: string | undefined; }>

Represent the accessibility for the search. Can be usefull when provide a custom search by LmnFilterCustomSearchDirective

searchConfiguration
r
InputSignal<LmnFilterMultipleSelectionSearchConfiguration | undefined>

The search configuration.

selectedValues
r
implements LmnFilter
Signal<SelectionValueType[]>

The selected values of the filter. @warning You must use this property AFTER the component is initialized by positioning it in the template after the component declaration. If you need to print the selected values before, use the output selectedValuesChange to capture the changes and store the values in a our property.

selectedValuesChange
r
implements LmnFilter
OutputRef<SelectionValueType[]>

The selected values change of the filter.

Methods

clear()

implements LmnFilter

Clear the selected values.

Presentation
clear(): void;
Returns
void

selectValues()

implements LmnFilter

Select the given values.

Presentation
selectValues(values: SelectionValueType[]): void;
Parameters
NameTypeDescription
values
inherited from selectValues
SelectionValueType[]
Returns
void

LmnFilterCustomLabelDirective

import { LmnFilterCustomLabelDirective } from '@elemental/ui';
Decorators:@Directive
Selectors:[lmnFilterCustomLabel]

Properties

NameTypeDescription
template
r
TemplateRef<any>

Static Methods

static

ngTemplateContextGuard()

No documentation has been provided.

Presentation
static ngTemplateContextGuard(dir: LmnFilterCustomLabelDirective, ctx: any): boolean;
Parameters
NameTypeDescription
dir
LmnFilterCustomLabelDirective
ctx
any
Returns
boolean

LmnFilterCustomCheckboxDirective

import { LmnFilterCustomCheckboxDirective } from '@elemental/ui';
Decorators:@Directive
Selectors:[lmnFilterCustomCheckbox]

Properties

NameTypeDescription
template
r
TemplateRef<any>

Static Methods

static

ngTemplateContextGuard()

No documentation has been provided.

Presentation
static ngTemplateContextGuard(dir: LmnFilterCustomCheckboxDirective, ctx: any): boolean;
Parameters
NameTypeDescription
dir
LmnFilterCustomCheckboxDirective
ctx
any
Returns
boolean

LmnFilterCustomSearchDirective

import { LmnFilterCustomSearchDirective } from '@elemental/ui';
Decorators:@Directive
Selectors:[lmnFilterCustomSearch]

Properties

NameTypeDescription
template
r
TemplateRef<any>

Static Methods

static

ngTemplateContextGuard()

No documentation has been provided.

Presentation
static ngTemplateContextGuard(dir: LmnFilterCustomSearchDirective, ctx: any): boolean;
Parameters
NameTypeDescription
dir
LmnFilterCustomSearchDirective
ctx
any
Returns
boolean