primeng
Version:
PrimeNG is a premium UI library for Angular featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock,
803 lines (799 loc) • 34.2 kB
TypeScript
import { ListBoxPassThrough, ListboxChangeEvent, ListboxClickEvent, ListboxDoubleClickEvent, ListboxFilterEvent, ListboxSelectAllChangeEvent, ListboxItemTemplateContext, ListboxGroupTemplateContext, ListboxHeaderTemplateContext, ListboxFilterTemplateContext, ListboxFooterTemplateContext, ListboxCheckIconTemplateContext, ListboxCheckmarkTemplateContext, ListboxLoaderTemplateContext, ListboxFilterOptions } from 'primeng/types/listbox';
export * from 'primeng/types/listbox';
import * as _angular_core from '@angular/core';
import { ElementRef, TemplateRef } from '@angular/core';
import { CdkDragDrop } from '@angular/cdk/drag-drop';
import * as i2 from 'primeng/api';
import { FilterService, ScrollerOptions, FilterMatchModeType, Header, Footer } from 'primeng/api';
import { BaseEditableHolder } from 'primeng/baseeditableholder';
import * as i1 from 'primeng/bind';
import { Bind } from 'primeng/bind';
import { ScrollerLazyLoadEvent, Scroller } from 'primeng/scroller';
import { CSSProperties } from 'primeng/types/shared';
import { BaseStyle } from 'primeng/base';
declare class ListBoxStyle extends BaseStyle {
name: string;
style: string;
classes: {
root: ({ instance }: {
instance: any;
}) => (string | {
'p-listbox-striped': any;
'p-disabled': any;
'p-invalid': any;
'p-listbox-fluid': any;
'p-listbox-dragging': any;
'p-listbox-flex-scrollable': boolean;
})[];
header: string;
pcFilter: string;
listContainer: string;
list: string;
optionGroup: string;
option: ({ instance, option, i, scrollerOptions }: {
instance: any;
option: any;
i: any;
scrollerOptions: any;
}) => (string | {
'p-listbox-option-selected': any;
'p-focus': boolean;
'p-disabled': any;
})[];
optionCheckIcon: string;
optionBlankIcon: string;
emptyMessage: string;
dragPreview: string;
dragPreviewOption: string;
dragPreviewMore: string;
};
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ListBoxStyle, never>;
static ɵprov: _angular_core.ɵɵInjectableDeclaration<ListBoxStyle>;
}
/**
*
* ListBox is used to select one or more values from a list of items.
*
* [Live Demo](https://www.primeng.org/listbox/)
*
* @module listboxstyle
*
*/
declare enum ListboxClasses {
/**
* Class name of the root element
*/
root = "p-listbox",
/**
* Class name of the header element
*/
header = "p-listbox-header",
/**
* Class name of the filter element
*/
pcFilter = "p-listbox-filter",
/**
* Class name of the list container element
*/
listContainer = "p-listbox-list-container",
/**
* Class name of the list element
*/
list = "p-listbox-list",
/**
* Class name of the option group element
*/
optionGroup = "p-listbox-option-group",
/**
* Class name of the option element
*/
option = "p-listbox-option",
/**
* Class name of the option check icon element
*/
optionCheckIcon = "p-listbox-option-check-icon",
/**
* Class name of the option blank icon element
*/
optionBlankIcon = "p-listbox-option-blank-icon",
/**
* Class name of the empty message element
*/
emptyMessage = "p-listbox-empty-message",
/**
* Class name of the multi-selection drag preview container
*/
dragPreview = "p-listbox-drag-preview",
/**
* Class name of the overflow row in the multi-selection drag preview
*/
dragPreviewMore = "p-listbox-drag-preview-more"
}
interface ListboxStyle extends BaseStyle {
}
declare const LISTBOX_VALUE_ACCESSOR: any;
/**
* ListBox is used to select one or more values from a list of items.
* @group Components
*/
declare class Listbox extends BaseEditableHolder<ListBoxPassThrough> {
componentName: string;
hostName: _angular_core.InputSignal<string>;
bindDirectiveInstance: Bind;
$pcListbox: Listbox | undefined;
filterService: FilterService;
onAfterViewChecked(): void;
/**
* Unique identifier of the component.
* @group Props
*/
id: _angular_core.InputSignal<string | undefined>;
/**
* Text to display when the search is active. Defaults to global value in i18n translation configuration.
* @group Props
* @defaultValue '{0} results are available'
*/
searchMessage: _angular_core.InputSignal<string | undefined>;
/**
* Text to display when filtering does not return any results. Defaults to global value in i18n translation configuration.
* @group Props
* @defaultValue 'No selected item'
*/
emptySelectionMessage: _angular_core.InputSignal<string | undefined>;
/**
* Text to be displayed in hidden accessible field when options are selected. Defaults to global value in i18n translation configuration.
* @group Props
* @defaultValue '{0} items selected'
*/
selectionMessage: _angular_core.InputSignal<string | undefined>;
/**
* Whether to focus on the first visible or selected element when the overlay panel is shown.
* @group Props
*/
autoOptionFocus: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Defines a string that labels the input for accessibility.
* @group Props
*/
ariaLabel: _angular_core.InputSignal<string | undefined>;
/**
* When enabled, the focused option is selected.
* @group Props
*/
selectOnFocus: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* Locale to use in searching. The default locale is the host environment's current locale.
* @group Props
*/
searchLocale: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* When enabled, the hovered option will be focused.
* @group Props
*/
focusOnHover: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Text to display when filtering.
* @group Props
*/
filterMessage: _angular_core.InputSignal<string | undefined>;
/**
* Fields used when filtering the options, defaults to optionLabel.
* @group Props
*/
filterFields: _angular_core.InputSignal<any[] | undefined>;
/**
* Defines if data is loaded and interacted with in lazy manner.
* @group Props
*/
lazy: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Whether the data should be loaded on demand during scroll.
* @group Props
*/
virtualScroll: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* Height of an item in the list for VirtualScrolling.
* @group Props
*/
virtualScrollItemSize: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
/**
* Whether to use the scroller feature. The properties of scroller component can be used like an object in it.
* @group Props
*/
virtualScrollOptions: _angular_core.InputSignal<ScrollerOptions | undefined>;
/**
* Height of the viewport in pixels, a scrollbar is defined if height of list exceeds this value.
* @group Props
*/
scrollHeight: _angular_core.InputSignal<string>;
/**
* Index of the element in tabbing order.
* @group Props
*/
tabindex: _angular_core.InputSignalWithTransform<number, unknown>;
/**
* When specified, allows selecting multiple values.
* @group Props
*/
multiple: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* Inline style of the list element.
* @group Props
*/
listStyle: _angular_core.InputSignal<CSSProperties>;
/**
* Style class of the list element.
* @group Props
*/
listStyleClass: _angular_core.InputSignal<string | undefined>;
/**
* When present, it specifies that the element value cannot be changed.
* @group Props
*/
readonly: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* When specified, allows selecting items with checkboxes.
* @group Props
*/
checkbox: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* When specified, displays a filter input at header.
* @group Props
*/
filter: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.
* @group Props
*/
filterBy: _angular_core.InputSignal<string | undefined>;
/**
* Defines how the items are filtered.
* @group Props
*/
filterMatchMode: _angular_core.InputSignal<FilterMatchModeType>;
/**
* Locale to use in filtering. The default locale is the host environment's current locale.
* @group Props
*/
filterLocale: _angular_core.InputSignal<string | undefined>;
/**
* Defines how multiple items can be selected, when true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
* @group Props
*/
metaKeySelection: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* A property to uniquely identify a value in options.
* @group Props
*/
dataKey: _angular_core.InputSignal<string | undefined>;
/**
* Whether header checkbox is shown in multiple mode.
* @group Props
*/
showToggleAll: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Name of the label field of an option.
* @group Props
*/
optionLabel: _angular_core.InputSignal<string | undefined>;
/**
* Name of the value field of an option.
* @group Props
*/
optionValue: _angular_core.InputSignal<string | undefined>;
/**
* Name of the options field of an option group.
* @group Props
*/
optionGroupChildren: _angular_core.InputSignal<string>;
/**
* Name of the label field of an option group.
* @group Props
*/
optionGroupLabel: _angular_core.InputSignal<string>;
/**
* Name of the disabled field of an option or function to determine disabled state.
* @group Props
*/
optionDisabled: _angular_core.InputSignal<string | ((item: any) => boolean) | undefined>;
/**
* Defines a string that labels the filter input.
* @group Props
*/
ariaFilterLabel: _angular_core.InputSignal<string | undefined>;
/**
* Defines placeholder of the filter input.
* @group Props
*/
filterPlaceHolder: _angular_core.InputSignal<string | undefined>;
/**
* Text to display when filtering does not return any results.
* @group Props
*/
emptyFilterMessage: _angular_core.InputSignal<string | undefined>;
/**
* Text to display when there is no data. Defaults to global value in i18n translation configuration.
* @group Props
*/
emptyMessage: _angular_core.InputSignal<string | undefined>;
/**
* Whether to display options as grouped when nested options are provided.
* @group Props
*/
group: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* An array of selectitems to display as the available options.
* @group Props
*/
options: _angular_core.InputSignal<any[] | undefined>;
/**
* When specified, filter displays with this value.
* @group Props
*/
filterValue: _angular_core.InputSignal<string | undefined>;
/**
* Whether all data is selected.
* @group Props
*/
selectAll: _angular_core.InputSignal<boolean | undefined>;
/**
* Whether to displays rows with alternating colors.
* @group Props
* @defaultValue false
*/
striped: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Whether the selected option will be add highlight class.
* @group Props
* @defaultValue true
*/
highlightOnSelect: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Whether the selected option will be shown with a check mark.
* @group Props
* @defaultValue false
*/
checkmark: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Whether to enable dragdrop based reordering.
* @group Props
*/
dragdrop: _angular_core.InputSignalWithTransform<boolean, unknown>;
/**
* Array to use for CDK drop list data binding. When not provided, uses options array.
* @group Props
*/
dropListData: _angular_core.InputSignal<any[] | undefined>;
/**
* Spans 100% width of the container when enabled.
* @defaultValue undefined
* @group Props
*/
fluid: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
/**
* Callback to invoke on value change.
* @param {ListboxChangeEvent} event - Custom change event.
* @group Emits
*/
onChange: _angular_core.OutputEmitterRef<ListboxChangeEvent>;
/**
* Callback to invoke when option is clicked.
* @param {ListboxClickEvent} event - Custom click event.
* @group Emits
*/
onClick: _angular_core.OutputEmitterRef<ListboxClickEvent>;
/**
* Callback to invoke when option is double clicked.
* @param {ListboxDoubleClickEvent} event - Custom double click event.
* @group Emits
*/
onDblClick: _angular_core.OutputEmitterRef<ListboxDoubleClickEvent>;
/**
* Callback to invoke when data is filtered.
* @param {ListboxFilterEvent} event - Custom filter event.
* @group Emits
*/
onFilter: _angular_core.OutputEmitterRef<ListboxFilterEvent>;
/**
* Callback to invoke when component receives focus.
* @param {FocusEvent} event - Focus event.
* @group Emits
*/
onFocus: _angular_core.OutputEmitterRef<FocusEvent>;
/**
* Callback to invoke when component loses focus.
* @param {FocusEvent} event - Blur event.
* @group Emits
*/
onBlur: _angular_core.OutputEmitterRef<FocusEvent>;
/**
* Callback to invoke when all data is selected.
* @param {ListboxSelectAllChangeEvent} event - Custom select event.
* @group Emits
*/
onSelectAllChange: _angular_core.OutputEmitterRef<ListboxSelectAllChangeEvent>;
/**
* Emits on lazy load.
* @param {ScrollerLazyLoadEvent} event - Scroller lazy load event.
* @group Emits
*/
onLazyLoad: _angular_core.OutputEmitterRef<ScrollerLazyLoadEvent>;
/**
* Emits on item is dropped.
* @param {CdkDragDrop<string[]>} event - Scroller lazy load event.
* @group Emits
*/
onDrop: _angular_core.OutputEmitterRef<CdkDragDrop<string[], string[], any>>;
headerCheckboxViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
filterViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
lastHiddenFocusableElement: _angular_core.Signal<ElementRef<any> | undefined>;
firstHiddenFocusableElement: _angular_core.Signal<ElementRef<any> | undefined>;
scroller: _angular_core.Signal<Scroller | undefined>;
listViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
containerViewChild: _angular_core.Signal<ElementRef<any> | undefined>;
headerFacet: _angular_core.Signal<Header | undefined>;
footerFacet: _angular_core.Signal<Footer | undefined>;
/**
* Custom item template.
* @param {ListboxItemTemplateContext} context - item context.
* @see {@link ListboxItemTemplateContext}
* @group Templates
*/
itemTemplate: _angular_core.Signal<TemplateRef<ListboxItemTemplateContext<any>> | undefined>;
/**
* Custom group template.
* @param {ListboxGroupTemplateContext} context - group context.
* @see {@link ListboxGroupTemplateContext}
* @group Templates
*/
groupTemplate: _angular_core.Signal<TemplateRef<ListboxGroupTemplateContext<any>> | undefined>;
/**
* Custom header template.
* @param {ListboxHeaderTemplateContext} context - header context.
* @see {@link ListboxHeaderTemplateContext}
* @group Templates
*/
headerTemplate: _angular_core.Signal<TemplateRef<ListboxHeaderTemplateContext<any>> | undefined>;
/**
* Custom filter template.
* @param {ListboxFilterTemplateContext} context - filter context.
* @see {@link ListboxFilterTemplateContext}
* @group Templates
*/
filterTemplate: _angular_core.Signal<TemplateRef<ListboxFilterTemplateContext> | undefined>;
/**
* Custom footer template.
* @param {ListboxFooterTemplateContext} context - footer context.
* @see {@link ListboxFooterTemplateContext}
* @group Templates
*/
footerTemplate: _angular_core.Signal<TemplateRef<ListboxFooterTemplateContext<any>> | undefined>;
/**
* Custom empty filter message template.
* @group Templates
*/
emptyFilterTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Custom empty message template.
* @group Templates
*/
emptyTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Custom filter icon template.
* @group Templates
*/
filterIconTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Custom check icon template.
* @param {ListboxCheckIconTemplateContext} context - check icon context.
* @see {@link ListboxCheckIconTemplateContext}
* @group Templates
*/
checkIconTemplate: _angular_core.Signal<TemplateRef<ListboxCheckIconTemplateContext> | undefined>;
/**
* Custom checkmark icon template.
* @param {ListboxCheckmarkTemplateContext} context - checkmark context.
* @see {@link ListboxCheckmarkTemplateContext}
* @group Templates
*/
checkmarkTemplate: _angular_core.Signal<TemplateRef<ListboxCheckmarkTemplateContext> | undefined>;
/**
* Custom loader template.
* @param {ListboxLoaderTemplateContext} context - loader context.
* @see {@link ListboxLoaderTemplateContext}
* @group Templates
*/
loaderTemplate: _angular_core.Signal<TemplateRef<ListboxLoaderTemplateContext> | undefined>;
_filterValue: _angular_core.WritableSignal<string | null | undefined>;
_filteredOptions: any[] | undefined | null;
filterOptions: ListboxFilterOptions | undefined;
filtered: boolean | undefined | null;
value: any | undefined | null;
optionTouched: boolean | undefined | null;
focus: boolean | undefined | null;
headerCheckboxFocus: boolean | undefined | null;
private translation;
focused: boolean | undefined;
scrollerTabIndex: string;
_componentStyle: ListBoxStyle;
_options: _angular_core.WritableSignal<any>;
startRangeIndex: _angular_core.WritableSignal<number>;
focusedOptionIndex: _angular_core.WritableSignal<number>;
isDragging: _angular_core.WritableSignal<boolean>;
searchValue: string | undefined;
searchTimeout: any;
private _internalId;
$id: _angular_core.Signal<string>;
$tabindex: _angular_core.Signal<number>;
/**
* Computed property for hidden focusable element tabindex
*/
hiddenFocusableTabindex: _angular_core.Signal<number>;
/**
* Computed property for header section visibility
*/
hasHeader: _angular_core.Signal<boolean>;
/**
* Computed property for footer section visibility
*/
hasFooter: _angular_core.Signal<boolean>;
/**
* Computed property for checkbox/filter header visibility
*/
hasCheckboxOrFilter: _angular_core.Signal<boolean>;
/**
* Computed property for showing checkbox toggle all
*/
showCheckboxToggleAll: _angular_core.Signal<boolean | undefined>;
/**
* Computed property for showing option checkbox
*/
showOptionCheckbox: _angular_core.Signal<boolean | undefined>;
/**
* Computed property for showing filtered empty message
*/
showFilteredEmptyMessage: _angular_core.Signal<boolean | "" | null | undefined>;
/**
* Computed property for showing empty message
*/
showEmptyMessage: _angular_core.Signal<boolean>;
/**
* Computed property for aria-activedescendant
*/
ariaActiveDescendant: _angular_core.Signal<string | null | undefined>;
/**
* Computed property for header template context
*/
headerTemplateContext: _angular_core.Signal<{
$implicit: any;
options: any;
}>;
/**
* Computed property for footer template context
*/
footerTemplateContext: _angular_core.Signal<{
$implicit: any;
options: any;
}>;
/**
* Computed property for filter input value
*/
filterInputValue: _angular_core.Signal<string>;
/**
* Computed property for disabled attribute
*/
disabledAttr: _angular_core.Signal<"" | undefined>;
/**
* Computed property for list id
*/
listId: _angular_core.Signal<string>;
/**
* Computed property for scroller style
*/
scrollerStyle: _angular_core.Signal<{
height: string;
}>;
/**
* Computed property for showing default filter empty message
*/
showDefaultFilterEmptyMessage: _angular_core.Signal<boolean>;
/**
* Computed property for empty or filter template
*/
emptyOrFilterTemplate: _angular_core.Signal<TemplateRef<void> | undefined>;
/**
* Computed property for build in items context
*/
buildInItemsContext: _angular_core.Signal<{
$implicit: any;
options: {};
}>;
/**
* Computed property for dragdrop disabled
*/
dragdropDisabled: _angular_core.Signal<boolean>;
/**
* Computed property for check icon context
*/
allSelectedContext: _angular_core.Signal<{
$implicit: any;
}>;
/**
* Computed property for showing default checkmark
*/
showDefaultCheckmark: _angular_core.Signal<boolean>;
/**
* Computed property for showing default item label
*/
showDefaultItemLabel: _angular_core.Signal<boolean>;
/**
* Computed property for showing default group label
*/
showDefaultGroupLabel: _angular_core.Signal<boolean>;
/**
* Computed property for showing filter icon
*/
showDefaultFilterIcon: _angular_core.Signal<boolean>;
/**
* Computed property for stable CDK drop list data reference
*/
cdkDropData: _angular_core.Signal<any>;
checkboxVariant: _angular_core.Signal<"outlined" | "filled">;
listContainerStyle: _angular_core.Signal<{
'max-height': string;
}>;
focusedOptionId: _angular_core.Signal<string | null>;
filterTabindex: _angular_core.Signal<number>;
filterResultMessageText: _angular_core.Signal<any>;
filterMessageText: _angular_core.Signal<any>;
searchMessageText: _angular_core.Signal<any>;
emptyFilterMessageText: _angular_core.Signal<any>;
selectionMessageText: _angular_core.Signal<any>;
emptySelectionMessageText: _angular_core.Signal<any>;
selectedMessageText: _angular_core.Signal<any>;
ariaSetSize: _angular_core.Signal<any>;
virtualScrollerDisabled: _angular_core.Signal<boolean>;
searchFields: _angular_core.Signal<any[]>;
toggleAllAriaLabel: _angular_core.Signal<any>;
onHostFocusOut(event: FocusEvent): void;
visibleOptions: _angular_core.Signal<any>;
constructor();
onInit(): void;
flatOptions(options: any): any;
autoUpdateModel(): void;
/**
* Updates the model value.
* @group Method
*/
updateModel(value: any, event?: any): void;
removeOption(option: any): any;
onOptionSelect(event: any, option: any, index?: number): void;
onOptionSelectMultiple(event: any, option: any): void;
onOptionSelectSingle(event: any, option: any): void;
onOptionSelectRange(event: any, start?: number, end?: number): void;
onToggleAll(event: any): void;
allSelected(): any;
onOptionTouchEnd(): void;
onOptionMouseDown(event: MouseEvent, index: number): void;
onOptionMouseEnter(event: MouseEvent, index: number): void;
onOptionDoubleClick(event: MouseEvent, option: any): void;
onFirstHiddenFocus(event: FocusEvent): void;
onLastHiddenFocus(event: FocusEvent): void;
onFocusout(event: FocusEvent): void;
onListFocus(event: FocusEvent): void;
onListBlur(event: FocusEvent): void;
onHeaderCheckboxKeyDown(event: any): void;
onHeaderCheckboxTabKeyDown(event: any): void;
onFilterChange(event: Event): void;
onFilterBlur(event: FocusEvent): void;
onListKeyDown(event: KeyboardEvent): void;
onFilterKeyDown(event: KeyboardEvent): void;
onArrowDownKey(event: KeyboardEvent): void;
onArrowUpKey(event: KeyboardEvent): void;
onArrowLeftKey(event: KeyboardEvent, pressedInInputText?: boolean): void;
onHomeKey(event: KeyboardEvent, pressedInInputText?: boolean): void;
onEndKey(event: KeyboardEvent, pressedInInputText?: boolean): void;
onPageDownKey(event: KeyboardEvent): void;
onPageUpKey(event: KeyboardEvent): void;
onEnterKey(event: any): void;
onSpaceKey(event: KeyboardEvent): void;
onShiftKey(): void;
getOptionGroupChildren(optionGroup: any): any;
getOptionGroupLabel(optionGroup: any): any;
getOptionLabel(option: any): any;
getOptionIndex(index: any, scrollerOptions: any): any;
getOptionValue(option: any): any;
getOptionTrackKey(option: any, index: number): string;
getAriaPosInset(index: number): number;
getPTOptions(option: any, itemOptions: any, index: number, key: string): any;
getOptionId(index: number, scrollerOptions: any): string;
getOptionCheckboxDisabled(option: any): any;
getCheckIconContext(option: any): {
$implicit: any;
};
getCheckmarkContext(option: any): {
implicit: any;
};
getGroupTemplateContext(optionGroup: any): {
$implicit: any;
};
getItemTemplateContext(option: any, index: number, scrollerOptions: any): {
$implicit: any;
index: any;
selected: any;
disabled: any;
};
/** Options shown in the multi-drag preview before collapsing into a "+N" row. */
readonly dragPreviewLimit = 4;
/**
* The options a multi-drag would carry: this list's selected options, in list order.
* Drives the drag preview when an option inside a multi-selection is dragged.
*/
dragPreviewOptions(): any[];
/** True when dragging this option effectively drags the whole multi-selection. */
isMultiDrag(option: any): boolean;
getDragPreviewTemplateContext(option: any): {
$implicit: any;
index: any;
selected: boolean;
disabled: any;
};
getFilterTemplateContext(): {
options: ListboxFilterOptions | undefined;
};
getBuildInItemsContext(items: any[], scrollerOptions: any): {
$implicit: any[];
options: any;
};
getLoaderTemplateContext(scrollerOptions: any): {
options: any;
};
isOptionFocused(index: number, scrollerOptions: any): boolean;
hasSelectedOption(): boolean;
isOptionGroup(option: any): any;
changeFocusedOptionIndex(event: any, index: any): void;
searchOptions(event: any, char: any): boolean;
isOptionMatched(option: any): any;
scrollInView(index?: number): void;
findFirstOptionIndex(): any;
findLastOptionIndex(): number;
findFirstFocusedOptionIndex(): any;
findLastFocusedOptionIndex(): number;
findLastSelectedOptionIndex(): number;
findNextOptionIndex(index: any): any;
findNextSelectedOptionIndex(index: any): any;
findPrevSelectedOptionIndex(index: any): number;
findFirstSelectedOptionIndex(): any;
findPrevOptionIndex(index: any): any;
findSelectedOptionIndex(): any;
findNearestSelectedOptionIndex(index: any, firstCheckUp?: boolean): any;
equalityKey(): string | null | undefined;
isValidSelectedOption(option: any): any;
isOptionDisabled(option: any): any;
isEquals(value1: any, value2: any): boolean;
isSelected(option: any): any;
isValidOption(option: any): any;
isEmpty(): boolean;
hasFilter(): boolean | "" | null | undefined;
resetFilter(): void;
onDragEntered(): void;
onDragExited(): void;
drop(event: CdkDragDrop<string[]>): void;
get containerDataP(): string;
/**
* @override
*
* @see {@link BaseEditableHolder.writeControlValue}
* Writes the value to the control.
*/
writeControlValue(value: any, setModelValue: (value: any) => void): void;
static ɵfac: _angular_core.ɵɵFactoryDeclaration<Listbox, never>;
static ɵcmp: _angular_core.ɵɵComponentDeclaration<Listbox, "p-listbox, p-list-box", never, { "hostName": { "alias": "hostName"; "required": false; "isSignal": true; }; "id": { "alias": "id"; "required": false; "isSignal": true; }; "searchMessage": { "alias": "searchMessage"; "required": false; "isSignal": true; }; "emptySelectionMessage": { "alias": "emptySelectionMessage"; "required": false; "isSignal": true; }; "selectionMessage": { "alias": "selectionMessage"; "required": false; "isSignal": true; }; "autoOptionFocus": { "alias": "autoOptionFocus"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "selectOnFocus": { "alias": "selectOnFocus"; "required": false; "isSignal": true; }; "searchLocale": { "alias": "searchLocale"; "required": false; "isSignal": true; }; "focusOnHover": { "alias": "focusOnHover"; "required": false; "isSignal": true; }; "filterMessage": { "alias": "filterMessage"; "required": false; "isSignal": true; }; "filterFields": { "alias": "filterFields"; "required": false; "isSignal": true; }; "lazy": { "alias": "lazy"; "required": false; "isSignal": true; }; "virtualScroll": { "alias": "virtualScroll"; "required": false; "isSignal": true; }; "virtualScrollItemSize": { "alias": "virtualScrollItemSize"; "required": false; "isSignal": true; }; "virtualScrollOptions": { "alias": "virtualScrollOptions"; "required": false; "isSignal": true; }; "scrollHeight": { "alias": "scrollHeight"; "required": false; "isSignal": true; }; "tabindex": { "alias": "tabindex"; "required": false; "isSignal": true; }; "multiple": { "alias": "multiple"; "required": false; "isSignal": true; }; "listStyle": { "alias": "listStyle"; "required": false; "isSignal": true; }; "listStyleClass": { "alias": "listStyleClass"; "required": false; "isSignal": true; }; "readonly": { "alias": "readonly"; "required": false; "isSignal": true; }; "checkbox": { "alias": "checkbox"; "required": false; "isSignal": true; }; "filter": { "alias": "filter"; "required": false; "isSignal": true; }; "filterBy": { "alias": "filterBy"; "required": false; "isSignal": true; }; "filterMatchMode": { "alias": "filterMatchMode"; "required": false; "isSignal": true; }; "filterLocale": { "alias": "filterLocale"; "required": false; "isSignal": true; }; "metaKeySelection": { "alias": "metaKeySelection"; "required": false; "isSignal": true; }; "dataKey": { "alias": "dataKey"; "required": false; "isSignal": true; }; "showToggleAll": { "alias": "showToggleAll"; "required": false; "isSignal": true; }; "optionLabel": { "alias": "optionLabel"; "required": false; "isSignal": true; }; "optionValue": { "alias": "optionValue"; "required": false; "isSignal": true; }; "optionGroupChildren": { "alias": "optionGroupChildren"; "required": false; "isSignal": true; }; "optionGroupLabel": { "alias": "optionGroupLabel"; "required": false; "isSignal": true; }; "optionDisabled": { "alias": "optionDisabled"; "required": false; "isSignal": true; }; "ariaFilterLabel": { "alias": "ariaFilterLabel"; "required": false; "isSignal": true; }; "filterPlaceHolder": { "alias": "filterPlaceHolder"; "required": false; "isSignal": true; }; "emptyFilterMessage": { "alias": "emptyFilterMessage"; "required": false; "isSignal": true; }; "emptyMessage": { "alias": "emptyMessage"; "required": false; "isSignal": true; }; "group": { "alias": "group"; "required": false; "isSignal": true; }; "options": { "alias": "options"; "required": false; "isSignal": true; }; "filterValue": { "alias": "filterValue"; "required": false; "isSignal": true; }; "selectAll": { "alias": "selectAll"; "required": false; "isSignal": true; }; "striped": { "alias": "striped"; "required": false; "isSignal": true; }; "highlightOnSelect": { "alias": "highlightOnSelect"; "required": false; "isSignal": true; }; "checkmark": { "alias": "checkmark"; "required": false; "isSignal": true; }; "dragdrop": { "alias": "dragdrop"; "required": false; "isSignal": true; }; "dropListData": { "alias": "dropListData"; "required": false; "isSignal": true; }; "fluid": { "alias": "fluid"; "required": false; "isSignal": true; }; }, { "onChange": "onChange"; "onClick": "onClick"; "onDblClick": "onDblClick"; "onFilter": "onFilter"; "onFocus": "onFocus"; "onBlur": "onBlur"; "onSelectAllChange": "onSelectAllChange"; "onLazyLoad": "onLazyLoad"; "onDrop": "onDrop"; }, ["headerFacet", "footerFacet", "itemTemplate", "groupTemplate", "headerTemplate", "filterTemplate", "footerTemplate", "emptyFilterTemplate", "emptyTemplate", "filterIconTemplate", "checkIconTemplate", "checkmarkTemplate", "loaderTemplate"], ["p-header", "p-footer"], true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
declare class ListboxModule {
static ɵfac: _angular_core.ɵɵFactoryDeclaration<ListboxModule, never>;
static ɵmod: _angular_core.ɵɵNgModuleDeclaration<ListboxModule, never, [typeof Listbox, typeof i2.SharedModule], [typeof Listbox, typeof i2.SharedModule]>;
static ɵinj: _angular_core.ɵɵInjectorDeclaration<ListboxModule>;
}
export { LISTBOX_VALUE_ACCESSOR, ListBoxStyle, Listbox, ListboxClasses, ListboxModule };
export type { ListboxStyle };