import { KbqFilterBarModule } from '@koobiq/components/filter-bar';

KbqFilterBar

componentСкопировать ссылку на KbqFilterBar
@Component({ selector: 'kbq-filter-bar, [kbq-filter-bar]' })
class KbqFilterBar implements KbqFilterBarHost {
    readonly selectedAllEqualsSelectedNothing = input<boolean>(true);
    readonly filter = model<KbqFilter | null>(null);
    readonly pipeTemplates = input<KbqPipeTemplate[]>([]);
    readonly onChangePipe = output<KbqPipe>();
    readonly onRemovePipe = output<KbqPipe>();
    readonly onClearPipe = output<KbqPipe>();
    readonly onClosePipe = output<KbqPipe>();
    readonly localeConfiguration: Signal<KbqFilterBarLocaleConfiguration>;
    readonly isSaved: Signal<boolean>;
    readonly isChanged: Signal<boolean>;
    readonly isSavedAndChanged: Signal<boolean>;
    readonly isReadOnly: Signal<boolean>;
    readonly isDisabled: Signal<boolean>;
    readonly onResetFilter: BehaviorSubject<boolean>;
    readonly internalFilterChanges: BehaviorSubject<KbqFilter | null>;
    readonly internalTemplatesChanges: BehaviorSubject<KbqPipeTemplate[] | null>;
    get hasSavedState(): boolean;
    clearSavedState(): void;
    removePipe(pipe: KbqPipe): void;
    saveFilterState(filter?: KbqFilter): void;
    restoreFilterState(filter?: KbqFilter): void;
    resetFilterChangedState(): void;
}
selectedAllEqualsSelectedNothinginputСкопировать ссылку на selectedAllEqualsSelectedNothingboolean

This is special logic that unselect all items when all selected because "all selected = nothing selected". Default is true

filtermodelСкопировать ссылку на filterKbqFilter | null

Filter that is currently selected. A two-way-bindable model(): derived state (isSaved/isChanged/…) is exposed via computed() off it and change detection is driven by signal reactivity. model() auto-provides the filterChange output for [(filter)] two-way binding.

pipeTemplatesinputСкопировать ссылку на pipeTemplatesKbqPipeTemplate[]

An array of templates that are used when adding a pipe. Also contains lists of options to select (values).

useStateSavinginputСкопировать ссылку на useStateSavingboolean

Whether the component remembers its state across reloads and restores it on the next render. Defaults to true, or to whatever KBQ_STATE_SAVING_ENABLED is provided as.

stateSavingKeyinputСкопировать ссылку на stateSavingKeystring

The key the state is persisted under. While it is empty the key is derived from where the component sits in the document, which moves when the surrounding markup is restructured — an id on the component or any ancestor pins it just as well as this input does.

localeOverridesinputСкопировать ссылку на localeOverridesKbqPartialLocaleData | undefined

Localized strings for this element and its subtree, keyed by locale section. Every key is optional at every depth.

onChangePipeoutputСкопировать ссылку на onChangePipeKbqPipe

Event that emits whenever the value of the pipe changes.

onRemovePipeoutputСкопировать ссылку на onRemovePipeKbqPipe

Event that emits whenever the pipe deleted.

onClearPipeoutputСкопировать ссылку на onClearPipeKbqPipe

Event that emits whenever the pipe cleared.

onClosePipeoutputСкопировать ссылку на onClosePipeKbqPipe

Event that emits whenever the select or multiselect pipe closed.

localeConfigurationСкопировать ссылку на localeConfigurationSignal<KbqFilterBarLocaleConfiguration>

Localized strings and configuration for the filter-bar and its pipes.

Read through a signal so that a runtime setLocale() reaches the pipes and the projected sub-components, which render these strings from their own OnPush views.

isSavedСкопировать ссылку на isSavedSignal<boolean>

Whether the current filter is saved

isChangedСкопировать ссылку на isChangedSignal<boolean>

Whether the current filter is changed

isSavedAndChangedСкопировать ссылку на isSavedAndChangedSignal<boolean>

Whether the current filter is saved and changed

isReadOnlyСкопировать ссылку на isReadOnlySignal<boolean>

Whether the current filter is readonly

isDisabledСкопировать ссылку на isDisabledSignal<boolean>

Whether the current filter is disabled

onResetFilterСкопировать ссылку на onResetFilterBehaviorSubject<boolean>

Event that emits whenever the filter is reset.

internalFilterChangesСкопировать ссылку на internalFilterChangesBehaviorSubject<KbqFilter | null>

internal filter changes

internalTemplatesChangesСкопировать ссылку на internalTemplatesChangesBehaviorSubject<KbqPipeTemplate[] | null>

internal changes in templates

hasSavedStateСкопировать ссылку на hasSavedStateboolean

Whether state is currently persisted for this filter bar — restored on init, or written since. Always false while useStateSaving is unset, and false again after clearSavedState().

clearSavedState()Скопировать ссылку на clearSavedState()void

Removes the state persisted for this filter bar.

Persistence itself stays on — the next change is written again. Unset useStateSaving to stop it. Unrelated to restoreFilterState(), which reverts to an in-memory snapshot within one session.

removePipe()Скопировать ссылку на removePipe()void

Remove pipe from current filter and emit event

saveFilterState()Скопировать ссылку на saveFilterState()void

Save current state of filter.

Deep-clones the filter via structuredClone, so any pipe value payload handed to save/restore must be structured-cloneable (plain data — no functions, DOM nodes, class instances or TemplateRefs), otherwise structuredClone throws DataCloneError. All built-in pipes produce cloneable values.

restoreFilterState()Скопировать ссылку на restoreFilterState()void

Restore previously saved filter state. As with saveFilterState, pipe value payloads must be structured-cloneable.

resetFilterChangedState()Скопировать ссылку на resetFilterChangedState()void

Set the filter state "changed" to false

KbqFilterRefresher

componentСкопировать ссылку на KbqFilterRefresher
@Component({ selector: 'kbq-filter-refresher, [kbq-filter-refresher]' })
class KbqFilterRefresher {}

KbqFilterReset

componentСкопировать ссылку на KbqFilterReset
@Component({ selector: 'kbq-filter-reset' })
class KbqFilterReset {
    readonly onResetFilter = output<KbqFilter | null>();
}
onResetFilteroutputСкопировать ссылку на onResetFilterKbqFilter | null

Event that is generated whenever the user reset a filter.

KbqFilters

componentСкопировать ссылку на KbqFilters
@Component({ selector: 'kbq-filters', exportAs: 'kbqFilters' })
class KbqFilters {
    readonly filters = input.required<KbqFilter[]>();
    readonly onSelectFilter = output<KbqFilter>();
    readonly onSave = output<KbqSaveFilterEvent>();
    readonly onChangeFilter = output<KbqSaveFilterEvent>();
    readonly onRemoveFilter = output<KbqFilter>();
    readonly onResetFilterChanges = output<KbqFilter | null>();
    readonly searchControl: FormControl<string | null>;
    readonly filteredOptions: Signal<KbqFilter[]>;
    get opened(): boolean;
    get filterActionsOpened(): boolean;
    get filter(): KbqFilter | null;
    get isEmpty(): boolean;
    selectFilter(filter: KbqFilter): void;
    saveChanges(): void;
    restoreFocus(): void;
    resetFilterChanges(): void;
    removeFilter(): void;
    filterSavedSuccessfully(): void;
    filterSavedUnsuccessfully(error?: KbqSaveFilterError): void;
}
onSelectFilteroutputСкопировать ссылку на onSelectFilterKbqFilter

Event that is generated whenever the user selects a filter.

onSaveoutputСкопировать ссылку на onSaveKbqSaveFilterEvent

Event that is generated whenever the user save a filter.

The emitted filter shares its pipe objects with the live filter by design (so the rendered pipes keep their identity across a save instead of being destroyed and recreated). Consumers that persist event.filter as an immutable record should snapshot it first (e.g. via KbqFilterBar.saveFilterState or a structural copy) — otherwise later in-place pipe edits will mutate the stored reference.

onChangeFilteroutputСкопировать ссылку на onChangeFilterKbqSaveFilterEvent

Event that is generated whenever the user change a filter.

onRemoveFilteroutputСкопировать ссылку на onRemoveFilterKbqFilter

Event that is generated whenever the user remove a filter.

onResetFilterChangesoutputСкопировать ссылку на onResetFilterChangesKbqFilter | null

Event that is generated whenever the user reset a filter changes.

searchControlСкопировать ссылку на searchControlFormControl<string | null>

control for search filter

filteredOptionsСкопировать ссылку на filteredOptionsSignal<KbqFilter[]>

Saved filters whose name matches the search query.

openedСкопировать ссылку на openedboolean

Component state. true if opened dropdown or popup

filterActionsOpenedСкопировать ссылку на filterActionsOpenedboolean

Component state. true if opened dropdown or popup of filterActions

filterСкопировать ссылку на filterKbqFilter | null

Selected filter. Kept as a plain getter facade over the bar's filter model.

isEmptyСкопировать ссылку на isEmptyboolean

Component state. True if 'filters' input contains no elements.

filterSavedSuccessfully()Скопировать ссылку на filterSavedSuccessfully()void

Hide the popup and restore focus. Use this method in the onSave or onChangeFilter events after the data has been successfully saved.

filterSavedUnsuccessfully()Скопировать ссылку на filterSavedUnsuccessfully()void

Shows an error. Use this method in the onSave or onChangeFilter events if saving data failed.

KbqPipeAdd

componentСкопировать ссылку на KbqPipeAdd
@Component({ selector: 'kbq-pipe-add' })
class KbqPipeAdd {
    readonly filterTemplate = input<KbqFilter>(
        {
            name: '',
            pipes: [],
            readonly: false,
            disabled: false,
            changed: false,
            saved: false
        }
    );
    readonly onAddPipe = output<KbqPipeTemplate>();
    readonly addedPipes: Signal<(string | number | (string & {}))[]>;
    addPipeFromTemplate(option: KbqOption): void;
    compareWith(o1: KbqPipe, o2: string): boolean;
}
onAddPipeoutputСкопировать ссылку на onAddPipeKbqPipeTemplate

Event that is generated after add pipe.

addedPipesСкопировать ссылку на addedPipesSignal<(string | number | (string & {}))[]>

Ids of the pipes already added to the current filter. Used to open an already-added pipe. Derived from the filter signal so it stays in sync without the retired changes bus.

compareWith()Скопировать ссылку на compareWith()boolean

Function to compare the option values with the selected values. The first argument is a value from an option. The second is a value from the selection. A boolean should be returned.

KbqPipeButton

componentСкопировать ссылку на KbqPipeButton
@Component({ selector: 'kbq-pipe-button' })
class KbqPipeButton {
    readonly readonly = input<boolean>(false);
}
readonlyinputСкопировать ссылку на readonlyboolean

enables/disables read-only state

KbqPipeDateComponent

componentСкопировать ссылку на KbqPipeDateComponent
@Component({ selector: 'kbq-pipe-date' })
class KbqPipeDateComponent<D> extends KbqPipeDateBaseComponent<D> {
    get formattedValue(): string;
    get disabled(): boolean;
    get start(): D;
    get defaultStart(): D;
    get end(): D;
    get defaultEnd(): D;
    get isEmpty(): boolean;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    onApplyPeriod(): void;
    onSelect(item: KbqDateTimeValue): void;
    showPeriod(): void;
    showList(): void;
    open(): void;
    onSelectStartDate(value: D): void;
    onSelectEndDate(value: D): void;
    onFocusStartInput(): void;
    onFocusEndInput(): void;
    hideCalendars(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
formattedValueСкопировать ссылку на formattedValuestring

formatted value for period

disabledСкопировать ссылку на disabledboolean

Whether the current pipe is disabled.

defaultStartСкопировать ссылку на defaultStartD

default object for start

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqPipeDatetimeComponent

componentСкопировать ссылку на KbqPipeDatetimeComponent
@Component({ selector: 'kbq-pipe-datetime' })
class KbqPipeDatetimeComponent<D> extends KbqPipeDateBaseComponent<D> {
    get formattedValue(): string;
    get disabled(): boolean;
    get start(): D;
    get defaultStart(): D;
    get end(): D;
    get defaultEnd(): D;
    get isEmpty(): boolean;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    onApplyPeriod(): void;
    onSelect(item: KbqDateTimeValue): void;
    showPeriod(): void;
    showList(): void;
    open(): void;
    onSelectStartDate(value: D): void;
    onSelectEndDate(value: D): void;
    onFocusStartInput(): void;
    onFocusEndInput(): void;
    hideCalendars(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
formattedValueСкопировать ссылку на formattedValuestring

formatted value for period

disabledСкопировать ссылку на disabledboolean

Whether the current pipe is disabled.

defaultStartСкопировать ссылку на defaultStartD

default object for start

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqPipeInputComponent

componentСкопировать ссылку на KbqPipeInputComponent
@Component({ selector: 'kbq-pipe-input' })
class KbqPipeInputComponent extends KbqBasePipe<string | null> {
    readonly control: FormControl<string | null>;
    debounceTime: number;
    minLength: number;
    get isEmpty(): boolean;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    onClear(): void;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
}
controlСкопировать ссылку на controlFormControl<string | null>

Input control.

Must stay nullable: KbqCleaner resets the control, and reset() resolves to defaultValue, which is null only while nonNullable is unset. { nonNullable: true } would make reset() yield '' and silently break the cleaner bridge below.

debounceTimeСкопировать ссылку на debounceTimenumber

Debounce in milliseconds between the last keystroke and the typed value being applied to the filter. Matches defaultEmitValueTimeout of kbq-search-expandable, so both search fields of a bar feel the same. Enter and blur apply immediately and cancel a pending apply.

minLengthСкопировать ссылку на minLengthnumber

Minimum number of characters before typing applies the value to the filter. Anything shorter — including an emptied field — is applied as null, so the filter never keeps text the user has already erased. Enter and blur ignore the threshold. Set to 0 to apply every keystroke.

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty. Used for apply style modifier

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

KbqPipeMultiSelectComponent

componentСкопировать ссылку на KbqPipeMultiSelectComponent
@Component({ selector: 'kbq-pipe-multi-select' })
class KbqPipeMultiSelectComponent extends KbqBasePipe<KbqSelectValue[]> {
    readonly searchControl: FormControl<string | null>;
    readonly searchTokens: Signal<string[]>;
    readonly filteredOptions: Signal<KbqSelectValue[]>;
    get selected(): KbqSelectValue[] | null;
    get isEmpty(): boolean;
    get checkboxState(): KbqPseudoCheckboxState;
    get allVisibleOptionsSelected(): boolean;
    get allOptionsSelected(): boolean;
    get selectedAllEqualsSelectedNothing(): boolean;
    compareByValue: (o1: Pick<KbqSelectValue, "id"> | null, o2: Pick<KbqSelectValue, "id"> | null) => boolean;
    selectAllHandler: (event: KeyboardEvent) => void;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
}
searchControlСкопировать ссылку на searchControlFormControl<string | null>

control for search options

searchTokensСкопировать ссылку на searchTokensSignal<string[]>

Query tokens for option highlighting: tokenized like the filter, so every matched token is marked.

filteredOptionsСкопировать ссылку на filteredOptionsSignal<KbqSelectValue[]>

Options of the pipe template that match the search query. Follows the templates too, so options supplied after initialization render on first open.

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

allVisibleOptionsSelectedСкопировать ссылку на allVisibleOptionsSelectedboolean

true if all visible options selected

allOptionsSelectedСкопировать ссылку на allOptionsSelectedboolean

true if all options selected

compareByValueСкопировать ссылку на compareByValue(o1: Pick<KbqSelectValue, "id"> | null, o2: Pick<KbqSelectValue, "id"> | null) => boolean

Comparator of selected options. Two null/absent values never match (aligned with the select pipe).

selectAllHandlerСкопировать ссылку на selectAllHandler(event: KeyboardEvent) => void

handler for select all options in select

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

KbqPipeMultiTreeSelectComponent

componentСкопировать ссылку на KbqPipeMultiTreeSelectComponent
@Component({ selector: 'kbq-pipe-multi-tree-select' })
class KbqPipeMultiTreeSelectComponent extends KbqTreeSelectPipeBase<KbqSelectValue[]> {
    get selected(): KbqSelectValue[] | null;
    get isEmpty(): boolean;
    get selectAllCheckboxState(): KbqPseudoCheckboxState;
    get numberOfSelectedLeaves(): number;
    get allOptionsSelected(): boolean;
    get selectedAllEqualsSelectedNothing(): boolean;
    get allVisibleOptionsSelected(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    selectAllHandler: (event: KeyboardEvent) => void;
    readonly searchControl: FormControl<string | null>;
    treeControl: FlatTreeControl<KbqTreeSelectFlatNode>;
    treeFlattener: KbqTreeFlattener<KbqTreeSelectNode, KbqTreeSelectFlatNode>;
    dataSource: KbqTreeFlatDataSource<KbqTreeSelectNode, KbqTreeSelectFlatNode>;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    isNodeSelectAll(
        _: number,
        nodeData: KbqTreeSelectFlatNode
    ): boolean;
    onSelect({ value: option }: { value: any; }): void;
    searchKeydownHandler(): void;
    toggleSelectAllNode(emitEvent?: boolean): void;
    onClear(): void;
    hasChild(_: number, nodeData: KbqTreeSelectFlatNode): boolean;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
}
isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

allOptionsSelectedСкопировать ссылку на allOptionsSelectedboolean

true if all options selected

allVisibleOptionsSelectedСкопировать ссылку на allVisibleOptionsSelectedboolean

true if all visible options selected

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

Populates the tree data source from the pipe template. The shared values/valueTemplate assignment is already performed by the base subscription, so this override only does the tree-specific work and avoids a redundant double assignment.

selectAllHandlerСкопировать ссылку на selectAllHandler(event: KeyboardEvent) => void

handler for select all options in select

searchControlСкопировать ссылку на searchControlFormControl<string | null>

control for search options

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

hasChild()Скопировать ссылку на hasChild()boolean

tree-node predicate: whether the node has children

open()Скопировать ссылку на open()void

opens the tree-select panel

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

KbqPipeReadonlyComponent

componentСкопировать ссылку на KbqPipeReadonlyComponent
@Component({ selector: 'kbq-pipe-readonly' })
class KbqPipeReadonlyComponent extends KbqBasePipe<string | null> {
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get isEmpty(): boolean;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty. Used for apply style modifier

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqPipeSelectComponent

componentСкопировать ссылку на KbqPipeSelectComponent
@Component({ selector: 'kbq-pipe-select' })
class KbqPipeSelectComponent extends KbqBasePipe<KbqSelectValue> {
    readonly searchControl: FormControl<string | null>;
    readonly searchTokens: Signal<string[]>;
    readonly filteredOptions: Signal<KbqSelectValue[]>;
    get selected(): KbqSelectValue | null;
    get isEmpty(): boolean;
    compareByValue: (o1: Pick<KbqSelectValue, "id"> | null, o2: Pick<KbqSelectValue, "id"> | null) => boolean;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    onSelect(item: KbqSelectValue): void;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
searchControlСкопировать ссылку на searchControlFormControl<string | null>

control for search options

searchTokensСкопировать ссылку на searchTokensSignal<string[]>

Query tokens for option highlighting: tokenized like the filter, so every matched token is marked.

filteredOptionsСкопировать ссылку на filteredOptionsSignal<KbqSelectValue[]>

Options of the pipe template that match the search query. Follows the templates too, so options supplied after initialization render on first open.

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

compareByValueСкопировать ссылку на compareByValue(o1: Pick<KbqSelectValue, "id"> | null, o2: Pick<KbqSelectValue, "id"> | null) => boolean

Comparator of selected options

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqPipeTextComponent

componentСкопировать ссылку на KbqPipeTextComponent
@Component({ selector: 'kbq-pipe-text' })
class KbqPipeTextComponent extends KbqBasePipe<string | null> {
    readonly placements: typeof PopUpPlacements;
    get disabled(): boolean;
    control: FormControl<typeof this.data.value>;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get isEmpty(): boolean;
    get showRemoveButton(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    onApply(): void;
    onClear(): void;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
}
disabledСкопировать ссылку на disabledboolean

Whether the current pipe is disabled.

controlСкопировать ссылку на controlFormControl<typeof this.data.value>

textarea control

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty. Used for apply style modifier

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

KbqPipeTreeSelectComponent

componentСкопировать ссылку на KbqPipeTreeSelectComponent
@Component({ selector: 'kbq-pipe-tree-select' })
class KbqPipeTreeSelectComponent extends KbqTreeSelectPipeBase<KbqSelectValue> {
    get selected(): KbqSelectValue | null;
    get isEmpty(): boolean;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    readonly searchControl: FormControl<string | null>;
    treeControl: FlatTreeControl<KbqTreeSelectFlatNode>;
    treeFlattener: KbqTreeFlattener<KbqTreeSelectNode, KbqTreeSelectFlatNode>;
    dataSource: KbqTreeFlatDataSource<KbqTreeSelectNode, KbqTreeSelectFlatNode>;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    get showRemoveButton(): boolean;
    onSelect(item: KbqTreeOption): void;
    hasChild(_: number, nodeData: KbqTreeSelectFlatNode): boolean;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

Populates the tree data source from the pipe template. The shared values/valueTemplate assignment is already performed by the base subscription, so this override only does the tree-specific work and avoids a redundant double assignment.

searchControlСкопировать ссылку на searchControlFormControl<string | null>

control for search options

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

hasChild()Скопировать ссылку на hasChild()boolean

tree-node predicate: whether the node has children

open()Скопировать ссылку на open()void

opens the tree-select panel

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqBasePipe

directiveСкопировать ссылку на KbqBasePipe
@Directive()
abstract class KbqBasePipe<V> {
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    protected values: any;
    protected valueTemplate?: TemplateRef<any> | string;
    protected optionCompareWith?: ( o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined ) => boolean;
    protected lockedValues?: unknown[];
    protected panelMaxHeight?: KbqPanelMaxHeight;
    protected multilineOptions?: boolean;
    protected noOptionsText?: string;
    get isEmpty(): boolean;
    get showRemoveButton(): boolean;
    protected get noOptions(): boolean;
    protected get noOptionsMessage(): string;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

valuesСкопировать ссылку на valuesany

values to select from the pipe template

valueTemplateoptionalСкопировать ссылку на valueTemplateTemplateRef<any> | string

TemplateRef for selecting an option

optionCompareWithoptionalСкопировать ссылку на optionCompareWith( o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined ) => boolean

Optional equality comparator forwarded from the pipe template to the underlying kbq-select. Only consumed by the select / multi-select pipe components; when unset they fall back to their own id-based compareByValue.

lockedValuesoptionalСкопировать ссылку на lockedValuesunknown[]

Values forwarded from the pipe template whose selection the user cannot remove. Only consumed by the multi-select pipe components; other pipe types ignore it.

panelMaxHeightoptionalСкопировать ссылку на panelMaxHeightKbqPanelMaxHeight

Maximum height of the dropdown panel's scrollable list, forwarded from the pipe template to the underlying kbq-select / kbq-tree-select. Only consumed by the select-family pipe components; undefined leaves the list at the select-family default of 256px.

multilineOptionsoptionalСкопировать ссылку на multilineOptionsboolean

Whether the dropdown's option names and captions wrap instead of being truncated, forwarded from the pipe template. Only consumed by the select-family pipe components.

noOptionsTextoptionalСкопировать ссылку на noOptionsTextstring

Message shown in place of the options when the pipe template has none, forwarded from the pipe template. Only consumed by the select-family pipe components; undefined falls back to the localized pipe.noOptions string.

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty. Used for apply style modifier

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

noOptionsСкопировать ссылку на noOptionsboolean

Whether the pipe template provides no values to choose from. The select-family pipe components then show noOptionsMessage instead of the list; the date pipes open straight on the custom period.

noOptionsMessageСкопировать ссылку на noOptionsMessagestring

Message the select-family pipe components show when there are no options.

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqFilterBarButton

directiveСкопировать ссылку на KbqFilterBarButton
@Directive({ selector: '[kbqFilterBarButton]' })
class KbqFilterBarButton {}

KbqPipeDateBaseComponent

directiveСкопировать ссылку на KbqPipeDateBaseComponent

Shared implementation for the date and datetime pipes. The two pipes differ only in how a range is formatted and in their default start/end values, exposed here as the formatRange, getDefaultStart and getDefaultEnd hooks. Everything else — the period list / custom period flow, calendar handling and form group — is common.

@Directive()
abstract class KbqPipeDateBaseComponent<D> extends KbqBasePipe<KbqDateTimeValue> {
    protected readonly adapter: DateAdapter<any>;
    protected readonly formatter: DateFormatter<any>;
    protected readonly isListMode: WritableSignal<boolean>;
    get formattedValue(): string;
    get disabled(): boolean;
    get start(): D;
    get defaultStart(): D;
    get end(): D;
    get defaultEnd(): D;
    get isEmpty(): boolean;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    protected values: any;
    protected valueTemplate?: TemplateRef<any> | string;
    protected optionCompareWith?: ( o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined ) => boolean;
    protected lockedValues?: unknown[];
    protected panelMaxHeight?: KbqPanelMaxHeight;
    protected multilineOptions?: boolean;
    protected noOptionsText?: string;
    get showRemoveButton(): boolean;
    protected get noOptions(): boolean;
    protected get noOptionsMessage(): string;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    onApplyPeriod(): void;
    onSelect(item: KbqDateTimeValue): void;
    showPeriod(): void;
    showList(): void;
    open(): void;
    onSelectStartDate(value: D): void;
    onSelectEndDate(value: D): void;
    onFocusStartInput(): void;
    onFocusEndInput(): void;
    hideCalendars(): void;
    protected abstract usesTime(): boolean;
    protected abstract formatRange(start: D, end: D): string;
    protected abstract getDefaultStart(): D;
    protected abstract getDefaultEnd(): D;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
isListModeСкопировать ссылку на isListModeWritableSignal<boolean>

Whether the current state is list of periods. When false will displayed control for set custom period

formattedValueСкопировать ссылку на formattedValuestring

formatted value for period

disabledСкопировать ссылку на disabledboolean

Whether the current pipe is disabled.

defaultStartСкопировать ссылку на defaultStartD

default object for start

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty.

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

valuesСкопировать ссылку на valuesany

values to select from the pipe template

valueTemplateoptionalСкопировать ссылку на valueTemplateTemplateRef<any> | string

TemplateRef for selecting an option

optionCompareWithoptionalСкопировать ссылку на optionCompareWith( o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined ) => boolean

Optional equality comparator forwarded from the pipe template to the underlying kbq-select. Only consumed by the select / multi-select pipe components; when unset they fall back to their own id-based compareByValue.

lockedValuesoptionalСкопировать ссылку на lockedValuesunknown[]

Values forwarded from the pipe template whose selection the user cannot remove. Only consumed by the multi-select pipe components; other pipe types ignore it.

panelMaxHeightoptionalСкопировать ссылку на panelMaxHeightKbqPanelMaxHeight

Maximum height of the dropdown panel's scrollable list, forwarded from the pipe template to the underlying kbq-select / kbq-tree-select. Only consumed by the select-family pipe components; undefined leaves the list at the select-family default of 256px.

multilineOptionsoptionalСкопировать ссылку на multilineOptionsboolean

Whether the dropdown's option names and captions wrap instead of being truncated, forwarded from the pipe template. Only consumed by the select-family pipe components.

noOptionsTextoptionalСкопировать ссылку на noOptionsTextstring

Message shown in place of the options when the pipe template has none, forwarded from the pipe template. Only consumed by the select-family pipe components; undefined falls back to the localized pipe.noOptions string.

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

noOptionsСкопировать ссылку на noOptionsboolean

Whether the pipe template provides no values to choose from. The select-family pipe components then show noOptionsMessage instead of the list; the date pipes open straight on the custom period.

noOptionsMessageСкопировать ссылку на noOptionsMessagestring

Message the select-family pipe components show when there are no options.

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

usesTime()Скопировать ссылку на usesTime()boolean

Whether this pipe edits the time part (datetime) or only the date (date). Gates whether the minDateTime / maxDateTime bounds keep their time or are pinned to day edges.

formatRange()Скопировать ссылку на formatRange()string

Formats the selected range for display.

getDefaultStart()Скопировать ссылку на getDefaultStart()D

Default start value used when the pipe has no stored start.

getDefaultEnd()Скопировать ссылку на getDefaultEnd()D

Default end value used when the pipe has no stored start.

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqPipeDirective

directiveСкопировать ссылку на KbqPipeDirective
@Directive({ selector: '[kbqPipe]' })
class KbqPipeDirective<T extends KbqPipe> {
    readonly pipe = input<T>(undefined, { alias: 'kbqPipe' });
}

KbqPipeState

directiveСкопировать ссылку на KbqPipeState
@Directive({ selector: '[kbqPipeState]' })
class KbqPipeState<T> {
    readonly state = input<T | null>(null, { alias: 'kbqPipeState' });
}
kbqPipeStateinputСкопировать ссылку на kbqPipeStateT | null

Pipe state the styled button belongs to.

Carries the binding this directive's selector matches. Every binding passes the pipe's own data, which is mutated in place, so this value is a constant for the life of the pipe and the style is derived from pipe.isEmpty instead.

KbqTreeSelectPipeBase

directiveСкопировать ссылку на KbqTreeSelectPipeBase

Shared scaffolding for the tree-based select pipes (kbq-pipe-tree-select, kbq-pipe-multi-tree-select): the flat-tree control / flattener / data source, the node accessors, search-driven filtering and open handling. Subclasses provide the value-specific pieces (selected, isEmpty, onSelect, updateTemplates).

The internalTemplatesChanges subscription is intentionally left in each subclass constructor: it must be set up after the subclass's updateTemplates field initializer runs, so the initial BehaviorSubject replay dispatches to the subclass override (which writes dataSource.data) rather than the base one.

@Directive()
abstract class KbqTreeSelectPipeBase<V> extends KbqBasePipe<V> {
    readonly searchControl: FormControl<string | null>;
    treeControl: FlatTreeControl<KbqTreeSelectFlatNode>;
    treeFlattener: KbqTreeFlattener<KbqTreeSelectNode, KbqTreeSelectFlatNode>;
    dataSource: KbqTreeFlatDataSource<KbqTreeSelectNode, KbqTreeSelectFlatNode>;
    protected transformer: (node: KbqTreeSelectNode, level: number, parent: KbqTreeSelectFlatNode | null) => KbqTreeSelectFlatNode;
    protected getLevel: (node: KbqTreeSelectFlatNode) => number;
    protected isExpandable: (node: KbqTreeSelectFlatNode) => boolean;
    protected getChildren: (node: KbqTreeSelectNode) => KbqTreeSelectNode[] | null;
    protected getValue: (node: KbqTreeSelectFlatNode) => unknown;
    protected getViewValue: (node: KbqTreeSelectFlatNode) => string;
    readonly stateChanges: Subject<void>;
    readonly data: KbqPipeData<V>;
    protected values: any;
    protected valueTemplate?: TemplateRef<any> | string;
    protected optionCompareWith?: ( o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined ) => boolean;
    protected lockedValues?: unknown[];
    protected panelMaxHeight?: KbqPanelMaxHeight;
    protected multilineOptions?: boolean;
    protected noOptionsText?: string;
    get isEmpty(): boolean;
    get showRemoveButton(): boolean;
    protected get noOptions(): boolean;
    protected get noOptionsMessage(): string;
    updateTemplates: (templates: KbqPipeTemplate[] | null) => void;
    hasChild(_: number, nodeData: KbqTreeSelectFlatNode): boolean;
    open(): void;
    isTemplateRef(value: unknown): boolean;
    onRemove(): void;
    onClear(): void;
}
searchControlСкопировать ссылку на searchControlFormControl<string | null>

control for search options

stateChangesСкопировать ссылку на stateChangesSubject<void>

changes of state

dataСкопировать ссылку на dataKbqPipeData<V>

pipe data. Provided from subclass

valuesСкопировать ссылку на valuesany

values to select from the pipe template

valueTemplateoptionalСкопировать ссылку на valueTemplateTemplateRef<any> | string

TemplateRef for selecting an option

optionCompareWithoptionalСкопировать ссылку на optionCompareWith( o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined ) => boolean

Optional equality comparator forwarded from the pipe template to the underlying kbq-select. Only consumed by the select / multi-select pipe components; when unset they fall back to their own id-based compareByValue.

lockedValuesoptionalСкопировать ссылку на lockedValuesunknown[]

Values forwarded from the pipe template whose selection the user cannot remove. Only consumed by the multi-select pipe components; other pipe types ignore it.

panelMaxHeightoptionalСкопировать ссылку на panelMaxHeightKbqPanelMaxHeight

Maximum height of the dropdown panel's scrollable list, forwarded from the pipe template to the underlying kbq-select / kbq-tree-select. Only consumed by the select-family pipe components; undefined leaves the list at the select-family default of 256px.

multilineOptionsoptionalСкопировать ссылку на multilineOptionsboolean

Whether the dropdown's option names and captions wrap instead of being truncated, forwarded from the pipe template. Only consumed by the select-family pipe components.

noOptionsTextoptionalСкопировать ссылку на noOptionsTextstring

Message shown in place of the options when the pipe template has none, forwarded from the pipe template. Only consumed by the select-family pipe components; undefined falls back to the localized pipe.noOptions string.

isEmptyСкопировать ссылку на isEmptyboolean

Whether the current pipe is empty. Used for apply style modifier

showRemoveButtonСкопировать ссылку на showRemoveButtonboolean

Whether the current pipe is removable or cleanable. Used for apply style modifier

noOptionsСкопировать ссылку на noOptionsboolean

Whether the pipe template provides no values to choose from. The select-family pipe components then show noOptionsMessage instead of the list; the date pipes open straight on the custom period.

noOptionsMessageСкопировать ссылку на noOptionsMessagestring

Message the select-family pipe components show when there are no options.

updateTemplatesСкопировать ссылку на updateTemplates(templates: KbqPipeTemplate[] | null) => void

updates values for selection and value template

hasChild()Скопировать ссылку на hasChild()boolean

tree-node predicate: whether the node has children

open()Скопировать ссылку на open()void

opens the tree-select panel

isTemplateRef()Скопировать ссылку на isTemplateRef()boolean

templateRef checker utility

onRemove()Скопировать ссылку на onRemove()void

removes pipe from filter-bar and triggers changes

onClear()Скопировать ссылку на onClear()void

clears the pipe and triggers changes

KbqTreeSelectFlatNode

classСкопировать ссылку на KbqTreeSelectFlatNode

Flattened node

class KbqTreeSelectFlatNode {
    name: string;
    value: unknown;
    level: number;
    expandable: boolean;
    parent?: KbqTreeSelectFlatNode;
    caption?: string;
}
captionoptionalСкопировать ссылку на captionstring

Second line under name in the dropdown of the tree-select pipes.

getId

functionСкопировать ссылку на getId

function to get unique identifier of an element

function getId(item: KbqPipeTemplate): KbqPipeType | string | number;

kbqBuildTree

functionСкопировать ссылку на kbqBuildTree

Build the file structure tree. The value is the Json object, or a sub-tree of a Json object. The return value is the list of extends KbqTreeSelectNode.

function kbqBuildTree<T extends KbqTreeSelectNode>(
    value: Record<string, unknown>,
    level: number
): T[];

KbqDateTimeValue

interfaceСкопировать ссылку на KbqDateTimeValue
interface KbqDateTimeValue {
    name?: string;
    start?: string;
    end?: string;
}

KbqFilter

interfaceСкопировать ссылку на KbqFilter
interface KbqFilter {
    name: string;
    pipes: KbqPipe[];
    readonly: boolean;
    disabled: boolean;
    changed: boolean;
    saved: boolean;
}

KbqFilterBarHost

interfaceСкопировать ссылку на KbqFilterBarHost

Contract a pipe (or filter-bar sub-component) depends on instead of the concrete KbqFilterBar. KbqFilterBar provides itself as KBQ_FILTER_BAR_HOST, so a pipe can be unit-tested against a lightweight mock of this seam rather than a full bar. Members mirror the current KbqFilterBar surface; they are expected to slim down once the state model moves to signals.

interface KbqFilterBarHost {
    readonly localeConfiguration: Signal<KbqFilterBarLocaleConfiguration>;
    readonly filter: ModelSignal<KbqFilter | null>;
    readonly pipeTemplates: Signal<KbqPipeTemplate[]>;
    readonly selectedAllEqualsSelectedNothing: Signal<boolean>;
    readonly isSaved: Signal<boolean>;
    readonly isChanged: Signal<boolean>;
    readonly isSavedAndChanged: Signal<boolean>;
    readonly isReadOnly: Signal<boolean>;
    readonly onChangePipe: OutputEmitterRef<KbqPipe>;
    readonly onClearPipe: OutputEmitterRef<KbqPipe>;
    readonly onClosePipe: OutputEmitterRef<KbqPipe>;
    readonly internalFilterChanges: BehaviorSubject<KbqFilter | null>;
    readonly internalTemplatesChanges: BehaviorSubject<KbqPipeTemplate[] | null>;
    readonly openPipe: BehaviorSubject<string | number | null>;
    readonly onResetFilter: BehaviorSubject<boolean>;
    removePipe(pipe: KbqPipe): void;
    resetFilterChangedState(): void;
}
localeConfigurationСкопировать ссылку на localeConfigurationSignal<KbqFilterBarLocaleConfiguration>

Localized strings and configuration for the filter-bar and its pipes. Read via localeConfiguration(): the bar derives it from the active locale, so an override is registered with kbqFilterBarLocaleConfigurationProvider or bound as [localeOverrides].

filterСкопировать ссылку на filterModelSignal<KbqFilter | null>

Currently selected filter. A two-way-bindable model(): read via filter(), write via filter.set().

pipeTemplatesСкопировать ссылку на pipeTemplatesSignal<KbqPipeTemplate[]>

Templates used when adding a pipe (also hold the option lists). Read via pipeTemplates().

selectedAllEqualsSelectedNothingСкопировать ссылку на selectedAllEqualsSelectedNothingSignal<boolean>

Whether selecting all options counts as selecting nothing.

isSavedСкопировать ссылку на isSavedSignal<boolean>

Whether the current filter is saved.

isChangedСкопировать ссылку на isChangedSignal<boolean>

Whether the current filter is changed.

isSavedAndChangedСкопировать ссылку на isSavedAndChangedSignal<boolean>

Whether the current filter is both saved and changed.

isReadOnlyСкопировать ссылку на isReadOnlySignal<boolean>

Whether the current filter is readonly.

onChangePipeСкопировать ссылку на onChangePipeOutputEmitterRef<KbqPipe>

Emits whenever a pipe value changes. (The two-way-bound filter value is emitted by the filter model's filterChange output.)

onClearPipeСкопировать ссылку на onClearPipeOutputEmitterRef<KbqPipe>

Emits whenever a pipe is cleared.

onClosePipeСкопировать ссылку на onClosePipeOutputEmitterRef<KbqPipe>

Emits whenever a select/multiselect pipe closes.

internalFilterChangesСкопировать ссылку на internalFilterChangesBehaviorSubject<KbqFilter | null>

Internal filter changes.

internalTemplatesChangesСкопировать ссылку на internalTemplatesChangesBehaviorSubject<KbqPipeTemplate[] | null>

Internal pipe-template changes.

openPipeСкопировать ссылку на openPipeBehaviorSubject<string | number | null>

Requests that an already-added pipe open its pop-up. A one-shot command handled synchronously by the pipes that exist when it is dispatched, not retained state — clear it back to null after next. A pipe that has not been rendered yet is opened with openOnAdd on the pipe itself, not through this.

onResetFilterСкопировать ссылку на onResetFilterBehaviorSubject<boolean>

Emits when the filter is reset.

removePipe()Скопировать ссылку на removePipe()void

Removes a pipe from the current filter and emits the change.

resetFilterChangedState()Скопировать ссылку на resetFilterChangedState()void

Clears the current filter's "changed" flag.

KbqFilterBarPipeState

interfaceСкопировать ссылку на KbqFilterBarPipeState

One pipe as it is persisted: what identifies it, and what the user put in it.

Deliberately not the pipe itself. A pipe built from a template keeps whatever that template carried (pipe-add.ts strips only values and valueTemplate), so it can hold a compareWith function or a DateTime bound — things JSON.stringify drops silently rather than rejecting. Everything but the value is rebuilt from the application's own filters and templates while restoring.

interface KbqFilterBarPipeState {
    id: string | number;
    value: unknown;
}
idСкопировать ссылку на idstring | number

getId(pipe) — the pipe's id, or its name when it has none.

valueСкопировать ссылку на valueunknown

The pipe's value, in whatever shape the pipe stores it. Has to survive JSON.stringify.

KbqFilterBarState

interfaceСкопировать ссылку на KbqFilterBarState

The persisted state of a filter bar: which filter was selected, and the edits made to it.

interface KbqFilterBarState {
    name: string;
    changed: boolean;
    pipes: KbqFilterBarPipeState[];
}
nameСкопировать ссылку на namestring

KbqFilter.name, the only identity a filter has. Empty for a filter the user never saved.

changedСкопировать ссылку на changedboolean

Whether the filter carried unsaved changes.

KbqFiltersHost

interfaceСкопировать ссылку на KbqFiltersHost

Contract a projected child depends on instead of the concrete KbqFilters. KbqFilters provides itself as KBQ_FILTERS, so a child declared in its template does not import the component that declares it.

interface KbqFiltersHost {
    saveFocusedElement(button?: KbqButton): void;
}
saveFocusedElement()Скопировать ссылку на saveFocusedElement()void

Remembers the control focus returns to once the save popover closes.

KbqMultiTreeSelectValueTemplateContext

interfaceСкопировать ссылку на KbqMultiTreeSelectValueTemplateContext

Context available to a custom multi-tree-select value template.

interface KbqMultiTreeSelectValueTemplateContext<T extends KbqTreeSelectNode = KbqTreeSelectNode> {
    $implicit: KbqPipeMultiTreeSelectComponent;
    option: T;
    search: string | null;
}
$implicitСкопировать ссылку на $implicitKbqPipeMultiTreeSelectComponent

Pipe component instance, matching the implicit context of the flat select pipes.

optionСкопировать ссылку на optionT

Original node, including consumer-defined fields omitted from the flattened tree model.

KbqPipe

interfaceСкопировать ссылку на KbqPipe
interface KbqPipe {
    name: string;
    id?: string | number;
    type: KbqPipeType;
    value: unknown | null;
    search?: boolean;
    selectAll?: boolean;
    selectAllCounter?: boolean;
    defaultExpanded?: boolean;
    openOnAdd?: boolean;
    openOnReset?: boolean;
    selectedAllEqualsSelectedNothing?: boolean;
    cleanable: boolean;
    removable: boolean;
    disabled: boolean;
}
selectAllCounteroptionalСкопировать ссылку на selectAllCounterboolean

multiselect / multi-tree-select pipes only: shows a counter of the elements "Select all" would toggle next to its row — all of them, or only the ones matching the search while searching. Locked values are not counted. Ignored by other pipe types. Default is false.

defaultExpandedoptionalСкопировать ссылку на defaultExpandedboolean

Tree-based pipes only (tree-select, multi-tree-select): whether the panel opens with every branch expanded. When false, all branches start collapsed except the ancestors of the selected node(s). Default is true.

selectedAllEqualsSelectedNothingoptionalСкопировать ссылку на selectedAllEqualsSelectedNothingboolean

This is special logic that unselect all items when all selected because "all selected = nothing selected". Default is true

KbqPipeData

interfaceСкопировать ссылку на KbqPipeData
interface KbqPipeData<V> extends KbqPipe {
    value: V | null;
    name: string;
    id?: string | number;
    type: KbqPipeType;
    search?: boolean;
    selectAll?: boolean;
    selectAllCounter?: boolean;
    defaultExpanded?: boolean;
    openOnAdd?: boolean;
    openOnReset?: boolean;
    selectedAllEqualsSelectedNothing?: boolean;
    cleanable: boolean;
    removable: boolean;
    disabled: boolean;
}
selectAllCounteroptionalСкопировать ссылку на selectAllCounterboolean

multiselect / multi-tree-select pipes only: shows a counter of the elements "Select all" would toggle next to its row — all of them, or only the ones matching the search while searching. Locked values are not counted. Ignored by other pipe types. Default is false.

defaultExpandedoptionalСкопировать ссылку на defaultExpandedboolean

Tree-based pipes only (tree-select, multi-tree-select): whether the panel opens with every branch expanded. When false, all branches start collapsed except the ancestors of the selected node(s). Default is true.

selectedAllEqualsSelectedNothingoptionalСкопировать ссылку на selectedAllEqualsSelectedNothingboolean

This is special logic that unselect all items when all selected because "all selected = nothing selected". Default is true

KbqPipeTemplate

interfaceСкопировать ссылку на KbqPipeTemplate
interface KbqPipeTemplate extends Omit<KbqPipe, 'value'> {
    values?: unknown[];
    valueTemplate?: TemplateRef<any> | string;
    compareWith?: (o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined) => boolean;
    lockedValues?: unknown[];
    panelMaxHeight?: KbqPanelMaxHeight;
    multilineOptions?: boolean;
    noOptionsText?: string;
    minDateTime?: unknown;
    maxDateTime?: unknown;
    minInterval?: unknown;
    maxInterval?: unknown;
    disabled: boolean;
    name: string;
    selectAll?: boolean;
    search?: boolean;
    id?: string | number;
    type: KbqPipeType;
    selectAllCounter?: boolean;
    defaultExpanded?: boolean;
    openOnAdd?: boolean;
    openOnReset?: boolean;
    selectedAllEqualsSelectedNothing?: boolean;
    cleanable: boolean;
    removable: boolean;
}
valueTemplateoptionalСкопировать ссылку на valueTemplateTemplateRef<any> | string

Custom option content for select and multiselect, or custom leaf and branch content for tree-select and multi-tree-select. Tree templates receive a KbqMultiTreeSelectValueTemplateContext with the original option and current search; filtering and the trigger still use the node's name. Ignored by other pipe types.

compareWithoptionalСкопировать ссылку на compareWith(o1: KbqSelectValue | null | undefined, o2: KbqSelectValue | null | undefined) => boolean

Custom equality comparator forwarded to the underlying kbq-select of the select / multiselect pipes. When omitted, the pipe's default id-based comparator (compareByValue) is used. Ignored by other pipe types.

lockedValuesoptionalСкопировать ссылку на lockedValuesunknown[]

Options whose selection cannot be removed by the user: they are always selected, render as disabled with a checked checkbox, and survive both "select all" toggling and clearing the pipe.

Entries have the same shape as the entries of the owning pipe's value: KbqSelectValue objects for the multiselect pipe (matched with compareWith, falling back to the pipe's id-based comparator), and raw node values for the multi-tree-select pipe. Locking a tree branch locks its whole subtree. Ignored by other pipe types.

panelMaxHeightoptionalСкопировать ссылку на panelMaxHeightKbqPanelMaxHeight

Maximum height of the dropdown panel's scrollable list, in pixels, forwarded to the underlying kbq-select / kbq-tree-select of the select, multiselect, tree-select and multi-tree-select pipes. Omitting it — or passing null — keeps the select-family default of 256px, i.e. exactly eight 32px options.

The cap covers the scrollable list only, and the list's own padding is added on top of it, so a multiple of the option height fits without a scrollbar. The pipe's search field is rendered above the list and adds to the panel's total height, while the "select all" row scrolls with the options and is counted by the cap. A value taller than the room left in the viewport is clipped by the overlay rather than scrolled. Ignored by other pipe types.

multilineOptionsoptionalСкопировать ссылку на multilineOptionsboolean

Whether option names and captions in the dropdown wrap instead of being truncated to one line. Applies to the select, multiselect, tree-select and multi-tree-select pipes independently of valueTemplate; ignored by the other pipe types. Unrelated to KbqSelect.multiline, which lays the trigger's values out in rows.

noOptionsTextoptionalСкопировать ссылку на noOptionsTextstring

Message shown in the dropdown of the select, multiselect, tree-select and multi-tree-select pipes when values is empty. Defaults to the localized pipe.noOptions string. Ignored by other pipe types.

minDateTimeoptionalСкопировать ссылку на minDateTimeunknown

Earliest selectable instant for the date / datetime pipe custom period. Accepts any value the configured DateAdapter can deserialize (with the default Luxon adapter: an ISO-8601 string, a Date, or a DateTime). The date pipe uses only its day (pinned to the start of day). Ignored by other pipe types.

maxDateTimeoptionalСкопировать ссылку на maxDateTimeunknown

Latest selectable instant for the date / datetime pipe custom period. See KbqPipeTemplate.minDateTime. The date pipe uses only its day (pinned to the end of day). Ignored by other pipe types.

minIntervaloptionalСкопировать ссылку на minIntervalunknown

Minimum length of the date / datetime pipe custom period (end − start), as a Luxon duration-like object, e.g. { days: 1 } or { hours: 2 }. When the selected period is shorter, the editor shows an error and disables Apply. Ignored by other pipe types.

Unlike KbqPipeTemplate.minDateTime, this value is NOT deserialized through the configured DateAdapter — it is applied directly via the date value's own .plus(), so this option currently assumes the default Luxon adapter and is not portable to other DateAdapter implementations (e.g. the Moment adapter).

maxIntervaloptionalСкопировать ссылку на maxIntervalunknown

Maximum length of the date / datetime pipe custom period (end − start). See KbqPipeTemplate.minInterval. When the selected period is longer, the editor shows an error and disables Apply. Ignored by other pipe types.

selectAllCounteroptionalСкопировать ссылку на selectAllCounterboolean

multiselect / multi-tree-select pipes only: shows a counter of the elements "Select all" would toggle next to its row — all of them, or only the ones matching the search while searching. Locked values are not counted. Ignored by other pipe types. Default is false.

defaultExpandedoptionalСкопировать ссылку на defaultExpandedboolean

Tree-based pipes only (tree-select, multi-tree-select): whether the panel opens with every branch expanded. When false, all branches start collapsed except the ancestors of the selected node(s). Default is true.

selectedAllEqualsSelectedNothingoptionalСкопировать ссылку на selectedAllEqualsSelectedNothingboolean

This is special logic that unselect all items when all selected because "all selected = nothing selected". Default is true

KbqPipeType

typeСкопировать ссылку на KbqPipeType
type KbqPipeType = `${KbqPipeTypes}` | (string & {});

KbqSaveFilterError

interfaceСкопировать ссылку на KbqSaveFilterError
interface KbqSaveFilterError {
    text?: string;
    nameAlreadyExists?: boolean;
}

KbqSaveFilterEvent

interfaceСкопировать ссылку на KbqSaveFilterEvent
interface KbqSaveFilterEvent {
    filter: KbqFilter;
    filterBar: KbqFilterBar;
    status?: KbqSaveFilterStatuses;
}

KbqSelectValue

interfaceСкопировать ссылку на KbqSelectValue
interface KbqSelectValue {
    name: string;
    value: unknown;
    id?: string | number;
    caption?: string;
}
idoptionalСкопировать ссылку на idstring | number

Optional stable identifier used by the select/multi-select pipe comparators.

captionoptionalСкопировать ссылку на captionstring

Second line under name in the dropdown of the select / multiselect pipes. Ignored where a valueTemplate owns the option.

KbqTreeSelectNode

interfaceСкопировать ссылку на KbqTreeSelectNode
interface KbqTreeSelectNode {
    children: KbqTreeSelectNode[] | null;
    name: string;
    value: unknown;
    caption?: string;
}
captionoptionalСкопировать ссылку на captionstring

Second line under name in the dropdown of the tree-select pipes. Ignored when valueTemplate is used.

KbqPipeTypes

enumСкопировать ссылку на KbqPipeTypes

list of pipe types available out of the box

enum KbqPipeTypes {
    ReadOnly = 'readonly',
    Text = 'text',
    Input = 'input',
    Select = 'select',
    TreeSelect = 'tree-select',
    MultiSelect = 'multiselect',
    MultiTreeSelect = 'multi-tree-select',
    Date = 'date',
    Datetime = 'datetime'
}
InputСкопировать ссылку на Input'input'

Renders a bare input: no popover, never opens. Commits while typing (debounced), on Enter and on blur.

KbqSaveFilterStatuses

enumСкопировать ссылку на KbqSaveFilterStatuses

saving statuses for KbqSaveFilterEvent

enum KbqSaveFilterStatuses {
    OnlyChanges = 'onlyChanges',
    NewName = 'newName',
    NewFilter = 'newFilter'
}

defaultFilterBarPipes

constСкопировать ссылку на defaultFilterBarPipes

list of pipes available out of the box.

const defaultFilterBarPipes: [KbqPipeType, Type<KbqBasePipe<unknown>>][];

KBQ_FILTER_BAR_CONFIGURATION

constDeprecatedСкопировать ссылку на KBQ_FILTER_BAR_CONFIGURATION

Use KBQ_FILTER_BAR_LOCALE_CONFIGURATION. Will be removed in 22.0.0.

const KBQ_FILTER_BAR_CONFIGURATION: InjectionToken<KbqFilterBarLocaleConfiguration>;

KBQ_FILTER_BAR_DEFAULT_CONFIGURATION

constDeprecatedСкопировать ссылку на KBQ_FILTER_BAR_DEFAULT_CONFIGURATION

Use KBQ_FILTER_BAR_DEFAULT_LOCALE_CONFIGURATION. Will be removed in 22.0.0.

const KBQ_FILTER_BAR_DEFAULT_CONFIGURATION: KbqFilterBarLocaleConfiguration;

KBQ_FILTER_BAR_DEFAULT_LOCALE_CONFIGURATION

constСкопировать ссылку на KBQ_FILTER_BAR_DEFAULT_LOCALE_CONFIGURATION

Default localized strings for the filter-bar, used when no KBQ_LOCALE_SERVICE (nor an explicit KBQ_FILTER_BAR_LOCALE_CONFIGURATION) is provided. These are the Russian (ru-RU) strings, matching the library-wide default-locale convention (every KBQ_*_DEFAULT_LOCALE_CONFIGURATION resolves to ruRULocaleData). Provide KBQ_LOCALE_SERVICE at the application root to localize the filter-bar for other locales.

const KBQ_FILTER_BAR_DEFAULT_LOCALE_CONFIGURATION: KbqFilterBarLocaleConfiguration;

KBQ_FILTER_BAR_HOST

constСкопировать ссылку на KBQ_FILTER_BAR_HOST

Injection token exposing the KbqFilterBarHost seam. KbqFilterBar provides itself via useExisting, so pipes inject(KBQ_FILTER_BAR_HOST) instead of depending on the concrete bar.

const KBQ_FILTER_BAR_HOST: InjectionToken<KbqFilterBarHost>;

KBQ_FILTER_BAR_LOCALE_CONFIGURATION

constСкопировать ссылку на KBQ_FILTER_BAR_LOCALE_CONFIGURATION

Injection Token for providing configuration of filter-bar

const KBQ_FILTER_BAR_LOCALE_CONFIGURATION: InjectionToken<KbqFilterBarLocaleConfiguration>;

KBQ_FILTER_BAR_PIPES

constСкопировать ссылку на KBQ_FILTER_BAR_PIPES

Injection Token for providing pipes in filter-bar. Defaults to defaultFilterBarPipes so the standalone KbqFilterBar works without KbqFilterBarModule; override it with kbqFilterBarPipesProvider or a provider of your own.

const KBQ_FILTER_BAR_PIPES: InjectionToken<Map<KbqPipeType, Type<KbqBasePipe<unknown>>>>;

KBQ_FILTERS

constСкопировать ссылку на KBQ_FILTERS

Injection token exposing the KbqFiltersHost seam.

const KBQ_FILTERS: InjectionToken<KbqFiltersHost>;

KBQ_PIPE_DATA

constСкопировать ссылку на KBQ_PIPE_DATA

Injection Token for providing configuration of filter-bar

const KBQ_PIPE_DATA: InjectionToken<unknown>;

kbqFilterBarLocaleConfigurationProvider

constСкопировать ссылку на kbqFilterBarLocaleConfigurationProvider

Utility provider for KBQ_FILTER_BAR_LOCALE_CONFIGURATION. Only the strings you pass are overridden; the rest keep following the active locale.

const kbqFilterBarLocaleConfigurationProvider: (
    configuration: KbqDeepPartial<KbqFilterBarLocaleConfiguration>
) => Provider;

kbqFilterBarPipesProvider

constСкопировать ссылку на kbqFilterBarPipesProvider

Utility provider for KBQ_FILTER_BAR_PIPES.

const kbqFilterBarPipesProvider: () => Provider;
Предложения по улучшению
Если вы нашли ошибку или хотите доработать статью, создайте запрос на GitHub.