primeng
Version:
PrimeNG is an open source UI library for Angular featuring a rich set of 80+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeB
1,629 lines (1,601 loc) • 55.4 kB
TypeScript
import * as i0 from '@angular/core';
import { EventEmitter, ElementRef, TemplateRef } from '@angular/core';
import * as rxjs from 'rxjs';
import { Nullable } from 'primeng/ts-helpers';
import { QueryParamsHandling } from '@angular/router';
import { AnimationEvent } from '@angular/animations';
import * as i1 from '@angular/common';
/**
* Represents a blockable user interface element.
*/
interface BlockableUI {
/**
* Retrieves the blockable element associated with the UI.
* @returns The HTML element that can be blocked.
*/
getBlockableElement(): HTMLElement;
}
/**
* Type of the confirm event.
*/
declare enum ConfirmEventType {
ACCEPT = 0,
REJECT = 1,
CANCEL = 2
}
/**
* Represents a confirmation dialog configuration.
* @group Interface
*/
interface Confirmation {
/**
* The message to be displayed in the confirmation dialog.
*/
message?: string;
/**
* A unique key to identify the confirmation dialog.
*/
key?: string;
/**
* The name of the icon to be displayed in the confirmation dialog.
*/
icon?: string;
/**
* The header text of the confirmation dialog.
*/
header?: string;
/**
* The callback function to be executed when the accept button is clicked.
*/
accept?: Function;
/**
* The callback function to be executed when the reject button is clicked.
*/
reject?: Function;
/**
* The label text for the accept button.
*/
acceptLabel?: string;
/**
* The label text for the reject button.
*/
rejectLabel?: string;
/**
* The name of the icon to be displayed on the accept button.
*/
acceptIcon?: string;
/**
* The name of the icon to be displayed on the reject button.
*/
rejectIcon?: string;
/**
* Specifies whether the accept button should be visible.
*/
acceptVisible?: boolean;
/**
* Specifies whether the reject button should be visible.
*/
rejectVisible?: boolean;
/**
* Specifies whether to block scrolling on the page when the confirmation dialog is displayed.
*/
blockScroll?: boolean;
/**
* Specifies whether the confirmation dialog should be closed when the escape key is pressed.
*/
closeOnEscape?: boolean;
/**
* Specifies whether clicking outside the confirmation dialog should dismiss it.
*/
dismissableMask?: boolean;
/**
* The ID or class name of the element to receive focus by default when the confirmation dialog is opened.
*/
defaultFocus?: string;
/**
* The CSS class name to be applied to the accept button.
*/
acceptButtonStyleClass?: string;
/**
* The CSS class name to be applied to the reject button.
*/
rejectButtonStyleClass?: string;
/**
* The target event where the confirmation dialog is triggered from.
*/
target?: EventTarget;
/**
* An event emitter for the accept event.
*/
acceptEvent?: EventEmitter<any>;
/**
* An event emitter for the reject event.
*/
rejectEvent?: EventEmitter<any>;
acceptButtonProps?: any;
rejectButtonProps?: any;
closeButtonProps?: any;
closable?: boolean;
position?: string;
}
/**
* Methods used in confirmation service.
* @group Service
*/
declare class ConfirmationService {
private requireConfirmationSource;
private acceptConfirmationSource;
requireConfirmation$: rxjs.Observable<Confirmation>;
accept: rxjs.Observable<Confirmation>;
/**
* Callback to invoke on confirm.
* @param {Confirmation} confirmation - Represents a confirmation dialog configuration.
* @group Method
*/
confirm(confirmation: Confirmation): this;
/**
* Closes the dialog.
* @group Method
*/
close(): this;
/**
* Accepts the dialog.
* @group Method
*/
onAccept(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<ConfirmationService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<ConfirmationService>;
}
declare class ContextMenuService {
private activeItemKeyChange;
activeItemKeyChange$: rxjs.Observable<string>;
activeItemKey: Nullable<string>;
changeKey(key: string): void;
reset(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<ContextMenuService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<ContextMenuService>;
}
declare class FilterMatchMode {
static readonly STARTS_WITH = "startsWith";
static readonly CONTAINS = "contains";
static readonly NOT_CONTAINS = "notContains";
static readonly ENDS_WITH = "endsWith";
static readonly EQUALS = "equals";
static readonly NOT_EQUALS = "notEquals";
static readonly IN = "in";
static readonly LESS_THAN = "lt";
static readonly LESS_THAN_OR_EQUAL_TO = "lte";
static readonly GREATER_THAN = "gt";
static readonly GREATER_THAN_OR_EQUAL_TO = "gte";
static readonly BETWEEN = "between";
static readonly IS = "is";
static readonly IS_NOT = "isNot";
static readonly BEFORE = "before";
static readonly AFTER = "after";
static readonly DATE_IS = "dateIs";
static readonly DATE_IS_NOT = "dateIsNot";
static readonly DATE_BEFORE = "dateBefore";
static readonly DATE_AFTER = "dateAfter";
}
/**
* Represents metadata for filtering a data set.
* @group Interface
*/
interface FilterMetadata {
/**
* The value used for filtering.
*/
value?: any;
/**
* The match mode for filtering.
*/
matchMode?: string;
/**
* The operator for filtering.
*/
operator?: string;
}
declare class FilterOperator {
static readonly AND = "and";
static readonly OR = "or";
}
declare class FilterService {
filter(value: any[], fields: any[], filterValue: any, filterMatchMode: string, filterLocale?: string): any[];
filters: {
[rule: string]: Function;
};
register(rule: string, fn: Function): void;
static ɵfac: i0.ɵɵFactoryDeclaration<FilterService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<FilterService>;
}
/**
* Represents metadata for sorting.
* @group Interface
*/
interface SortMeta {
field: string;
order: number;
}
/**
* Represents an event object for lazy loading data.
* @group Interface
*/
interface LazyLoadEvent {
/**
* The index of the first record to be loaded.
*/
first?: number;
/**
* The index of the last record to be loaded.
*/
last?: number;
/**
* The number of rows to load.
*/
rows?: number;
/**
* The field to be used for sorting.
*/
sortField?: string;
/**
* The sort order for the field.
*/
sortOrder?: number;
/**
* An array of sort metadata objects for multiple column sorting.
*/
multiSortMeta?: SortMeta[];
/**
* An object containing filter metadata for filtering the data.
* The keys represent the field names, and the values represent the corresponding filter metadata.
*/
filters?: {
[s: string]: FilterMetadata;
};
/**
* The global filter value for filtering across all columns.
*/
globalFilter?: any;
/**
* A function that can be called to force an update in the lazy loaded data.
*/
forceUpdate?: () => void;
}
/**
* Meta data for lazy load event.
* @group Interface
*/
interface LazyLoadMeta {
first?: number | undefined | null;
rows?: number | undefined | null;
sortField?: string | string[] | null | undefined;
sortOrder?: number | undefined | null;
filters?: {
[s: string]: FilterMetadata | FilterMetadata[] | undefined;
};
globalFilter?: string | string[] | undefined | null;
multiSortMeta?: SortMeta[] | undefined | null;
forceUpdate?: Function;
last?: number | undefined | null;
}
/**
* Defines options of Tooltip.
* @group Interface
*/
interface TooltipOptions {
/**
* Label of tooltip.
*/
tooltipLabel?: string;
/**
* Position of tooltip.
*/
tooltipPosition?: 'right' | 'left' | 'top' | 'bottom';
/**
* Event to show the tooltip.
*/
tooltipEvent?: 'hover' | 'focus';
/**
* Target element to attach the overlay, valid values are "body" or a local ng-template variable of another element (note: use binding with brackets for template variables, e.g. [appendTo]="mydiv" for a div element having #mydiv as variable name).
* @defaultValue body
*/
appendTo?: HTMLElement | ElementRef | TemplateRef<any> | string | null | undefined | any;
/**
* Type of CSS position.
*/
positionStyle?: string;
/**
* Style class of the tooltip.
*/
tooltipStyleClass?: string;
/**
* Whether the z-index should be managed automatically to always go on top or have a fixed value.
* @defaultValue auto
*/
tooltipZIndex?: string;
/**
* By default the tooltip contents are rendered as text. Set to false to support html tags in the content.
*/
escape?: boolean;
/**
* When present, it specifies that the component should be disabled.
*/
disabled?: boolean;
/**
* Specifies the additional vertical offset of the tooltip from its default position.
*/
positionTop?: number;
/**
* Specifies the additional horizontal offset of the tooltip from its default position.
*/
positionLeft?: number;
/**
* Delay to show the tooltip in milliseconds.
*/
showDelay?: number;
/**
* Delay to hide the tooltip in milliseconds.
*/
hideDelay?: number;
/**
* Time to wait in milliseconds to hide the tooltip even it is active.
*/
life?: number;
/**
* When present, it adds a custom id to the tooltip.
*/
id?: string;
}
/**
* MenuItem provides the following properties. Note that not all of them may be utilized by the tabmenu component.
* @group Interface
*/
interface MenuItem {
/**
* Text of the item.
*/
label?: string;
/**
* Icon of the item.
*/
icon?: string;
/**
* Callback to execute when item is clicked.
*/
command?(event: MenuItemCommandEvent): void;
/**
* External link to navigate when item is clicked.
*/
url?: string;
/**
* An array of children menuitems.
*/
items?: MenuItem[];
/**
* Visibility of submenu.
*/
expanded?: boolean;
/**
* When set as true, disables the menuitem.
*/
disabled?: boolean;
/**
* Whether the dom element of menuitem is created or not.
*/
visible?: boolean;
/**
* Specifies where to open the linked document.
*/
target?: string;
/**
* Whether to escape the label or not. Set to false to display html content.
*/
escape?: boolean;
/**
* Configuration for active router link.
*/
routerLinkActiveOptions?: any;
/**
* Defines the item as a separator.
*/
separator?: boolean;
/**
* Value of the badge.
*/
badge?: string;
/**
* Tooltip of the item.
*/
tooltip?: string;
/**
* Position of the tooltip item.
*/
tooltipPosition?: string;
/**
* Style class of the badge.
*/
badgeStyleClass?: string;
/**
* Inline style of the menuitem.
*/
style?: {
[klass: string]: any;
} | null | undefined;
/**
* Style class of the menuitem.
*/
styleClass?: string;
/**
* Tooltip text of the item.
*/
title?: string;
/**
* Identifier of the element.
*/
id?: string;
/**
* Value of HTML data-* attribute.
*/
automationId?: any;
/**
* Specifies tab order of the item.
*/
tabindex?: string;
/**
* RouterLink definition for internal navigation.
*/
routerLink?: any;
/**
* Query parameters for internal navigation via routerLink.
*/
queryParams?: {
[k: string]: any;
};
/**
* Sets the hash fragment for the URL.
*/
fragment?: string;
/**
* How to handle query parameters in the router link for the next navigation. One of:
merge : Merge new with current parameters.
preserve : Preserve current parameters.k.
*/
queryParamsHandling?: QueryParamsHandling;
/**
* When true, preserves the URL fragment for the next navigation.
*/
preserveFragment?: boolean;
/**
* When true, navigates without pushing a new state into history.
*/
skipLocationChange?: boolean;
/**
* When true, navigates while replacing the current state in history.
*/
replaceUrl?: boolean;
/**
* Inline style of the item's icon.
*/
iconStyle?: {
[klass: string]: any;
} | null | undefined;
/**
* Class of the item's icon.
*/
iconClass?: string;
/**
* Developer-defined state that can be passed to any navigation.
* @see {MenuItemState}
*/
state?: {
[k: string]: any;
};
/**
* Options of the item's tooltip.
* @see {TooltipOptions}
*/
tooltipOptions?: TooltipOptions;
/**
* Optional
*/
[key: string]: any;
}
/**
* Custom command event
* @see {@link MenuItem.command}
* @group Events
*/
interface MenuItemCommandEvent {
/**
* Browser event.
*/
originalEvent?: Event;
/**
* Selected menu item.
*/
item?: MenuItem | MegaMenuItem;
/**
* Index of the selected item.
*/
index?: number;
}
/**
* MegaMenuItem API provides the following properties.
* @group Interface
*/
interface MegaMenuItem {
/**
* Text of the item.
*/
label?: string;
/**
* Icon of the item.
*/
icon?: string;
/**
* Callback to execute when item is clicked.
*/
command?: (event?: any) => void;
/**
* External link to navigate when item is clicked.
*/
url?: string;
/**
* An array of children menuitems.
*/
items?: MenuItem[][];
/**
* Specifies whether the mega menu item is expanded.
*/
expanded?: boolean;
/**
* When set as true, disables the menuitem.
*/
disabled?: boolean;
/**
* Whether the dom element of menuitem is created or not.
*/
visible?: boolean;
/**
* Specifies where to open the linked document.
*/
target?: string;
/**
* Configuration for active router link.
*/
routerLinkActiveOptions?: any;
/**
* Defines the item as a separator.
*/
separator?: boolean;
/**
* Value of the badge.
*/
badge?: string;
/**
* Style class of the badge.
*/
badgeStyleClass?: string;
/**
* Inline style of the menuitem.
*/
style?: any;
/**
* Style class of the menuitem.
*/
styleClass?: string;
/**
* Inline style of the item's icon.
*/
iconStyle?: any;
/**
* Tooltip text of the item.
*/
title?: string;
/**
* Identifier of the element.
*/
id?: string;
/**
* Value of HTML data-* attribute.
*/
automationId?: any;
/**
* Specifies tab order of the item.
*/
tabindex?: string;
/**
* RouterLink definition for internal navigation.
*/
routerLink?: any;
/**
* Query parameters for internal navigation via routerLink.
*/
queryParams?: {
[k: string]: any;
};
/**
* Sets the hash fragment for the URL.
*/
fragment?: string;
/**
* How to handle query parameters in the router link for the next navigation. One of:
merge : Merge new with current parameters.
preserve : Preserve current parameters.k.
*/
queryParamsHandling?: QueryParamsHandling;
/**
* When true, preserves the URL fragment for the next navigation.
*/
preserveFragment?: boolean;
/**
* When true, navigates without pushing a new state into history.
*/
skipLocationChange?: boolean;
/**
* When true, navigates while replacing the current state in history.
*/
replaceUrl?: boolean;
/**
* Developer-defined state that can be passed to any navigation.
*/
state?: {
[k: string]: any;
};
/**
* Optional
*/
[key: string]: any;
}
/**
* Deines valid options for the toast message.
* @group Interface
*/
interface ToastMessageOptions {
text?: any;
severity?: string;
summary?: string;
detail?: string;
id?: any;
key?: string;
life?: number;
sticky?: boolean;
closable?: boolean;
data?: any;
icon?: string;
contentStyleClass?: string;
styleClass?: string;
closeIcon?: string;
}
/**
* Message service used in messages and toast components.
* @group Service
*/
declare class MessageService {
private messageSource;
private clearSource;
messageObserver: rxjs.Observable<ToastMessageOptions | ToastMessageOptions[]>;
clearObserver: rxjs.Observable<string>;
/**
* Inserts single message.
* @param {ToastMessageOptions} message - Message to be added.
* @group Method
*/
add(message: ToastMessageOptions): void;
/**
* Inserts new messages.
* @param {Message[]} messages - Messages to be added.
* @group Method
*/
addAll(messages: ToastMessageOptions[]): void;
/**
* Clears the message with the given key.
* @param {string} key - Key of the message to be cleared.
* @group Method
*/
clear(key?: string): void;
static ɵfac: i0.ɵɵFactoryDeclaration<MessageService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<MessageService>;
}
/**
* Represents the type of overlay mode, which can be 'modal', 'overlay', or undefined.
* @group Types
*/
type OverlayModeType = 'modal' | 'overlay' | undefined;
/**
* Represents the type of direction for a responsive overlay, which can be one of the specified values or undefined.
* @group Types
*/
type ResponsiveOverlayDirectionType = 'center' | 'top' | 'top-start' | 'top-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end' | 'right' | 'right-start' | 'right-end' | undefined;
/**
* Represents the options for an overlay listener.
* @group Interface
*/
interface OverlayListenerOptions {
/**
* The type of listener, which can be 'scroll', 'outside', 'resize', or undefined.
*/
type?: 'scroll' | 'outside' | 'resize' | undefined;
/**
* The mode of the overlay listener.
*/
mode?: OverlayModeType;
/**
* Indicates whether the overlay listener is valid.
*/
valid?: boolean;
}
/**
* Represents the options for a responsive overlay.
* @group Events
*/
interface ResponsiveOverlayOptions {
/**
* The inline style for the responsive overlay.
*/
style?: any;
/**
* The CSS class for the responsive overlay.
*/
styleClass?: string;
/**
* The inline style for the content of the responsive overlay.
*/
contentStyle?: any;
/**
* The CSS class for the content of the responsive overlay.
*/
contentStyleClass?: string;
/**
* The breakpoint for the responsive overlay.
*/
breakpoint?: string;
/**
* The media query for the responsive overlay.
*/
media?: string;
/**
* The direction for the responsive overlay.
*/
direction?: ResponsiveOverlayDirectionType;
}
/**
* Represents an event that occurs when an overlay is shown.
* @group Events
*/
interface OverlayOnShowEvent {
/**
* The overlay element.
*/
overlay?: HTMLElement | undefined;
/**
* The target element.
*/
target?: HTMLElement | undefined;
/**
* The mode of the overlay.
*/
mode?: OverlayModeType;
}
/**
* Represents an event that occurs before an overlay is shown.
* @extends {OverlayOnShowEvent}
* @group Events
*/
interface OverlayOnBeforeShowEvent extends OverlayOnShowEvent {
}
/**
* Represents an event that occurs before an overlay is hidden.
* @extends {OverlayOnBeforeShowEvent}
* @group Events
*/
interface OverlayOnBeforeHideEvent extends OverlayOnBeforeShowEvent {
}
/**
* Represents an event that occurs when an overlay is hidden.
* @extends {OverlayOnShowEvent}
* @group Events
*/
interface OverlayOnHideEvent extends OverlayOnShowEvent {
}
/**
* Represents the options for an overlay.
* @group Interface
*/
interface OverlayOptions {
/**
* The mode of the overlay.
*/
mode?: OverlayModeType;
/**
* The inline style for the overlay.
*/
style?: any;
/**
* The CSS class for the overlay.
*/
styleClass?: string;
/**
* The inline style for the content of the overlay.
*/
contentStyle?: any;
/**
* The CSS class for the content of the overlay.
*/
contentStyleClass?: string;
/**
* The target element.
*/
target?: any;
/**
* The element or location where the overlay should be appended.
*/
appendTo?: 'body' | HTMLElement | undefined;
/**
* Indicates whether the overlay should have an auto-generated z-index.
*/
autoZIndex?: boolean;
/**
* The base z-index value for the overlay.
*/
baseZIndex?: number;
/**
* The transition options for showing the overlay.
*/
showTransitionOptions?: string;
/**
* The transition options for hiding the overlay.
*/
hideTransitionOptions?: string;
/**
* Indicates whether the overlay should be hidden when the escape key is pressed.
*/
hideOnEscape?: boolean;
/**
* A listener function for handling events related to the overlay.
*/
listener?: (event: Event, options?: OverlayListenerOptions) => boolean | void;
/**
* The options for a responsive overlay.
*/
responsive?: ResponsiveOverlayOptions | undefined;
/**
* A callback function that is invoked before the overlay is shown.
*/
onBeforeShow?: (event?: OverlayOnBeforeShowEvent) => void;
/**
* A callback function that is invoked when the overlay is shown.
*/
onShow?: (event?: OverlayOnShowEvent) => void;
/**
* A callback function that is invoked before the overlay is hidden.
*/
onBeforeHide?: (event?: OverlayOnBeforeHideEvent) => void;
/**
* A callback function that is invoked when the overlay is hidden.
*/
onHide?: (event?: OverlayOnHideEvent) => void;
/**
* A callback function that is invoked when the overlay's animation starts.
*/
onAnimationStart?: (event?: AnimationEvent) => void;
/**
* A callback function that is invoked when the overlay's animation is done.
*/
onAnimationDone?: (event?: AnimationEvent) => void;
}
declare class OverlayService {
private clickSource;
clickObservable: rxjs.Observable<any>;
add(event: any): void;
static ɵfac: i0.ɵɵFactoryDeclaration<OverlayService, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<OverlayService>;
}
declare class PrimeIcons {
static readonly ADDRESS_BOOK = "pi pi-address-book";
static readonly ALIGN_CENTER = "pi pi-align-center";
static readonly ALIGN_JUSTIFY = "pi pi-align-justify";
static readonly ALIGN_LEFT = "pi pi-align-left";
static readonly ALIGN_RIGHT = "pi pi-align-right";
static readonly AMAZON = "pi pi-amazon";
static readonly ANDROID = "pi pi-android";
static readonly ANGLE_DOUBLE_DOWN = "pi pi-angle-double-down";
static readonly ANGLE_DOUBLE_LEFT = "pi pi-angle-double-left";
static readonly ANGLE_DOUBLE_RIGHT = "pi pi-angle-double-right";
static readonly ANGLE_DOUBLE_UP = "pi pi-angle-double-up";
static readonly ANGLE_DOWN = "pi pi-angle-down";
static readonly ANGLE_LEFT = "pi pi-angle-left";
static readonly ANGLE_RIGHT = "pi pi-angle-right";
static readonly ANGLE_UP = "pi pi-angle-up";
static readonly APPLE = "pi pi-apple";
static readonly ARROWS_ALT = "pi pi-arrows-alt";
static readonly ARROW_CIRCLE_DOWN = "pi pi-arrow-circle-down";
static readonly ARROW_CIRCLE_LEFT = "pi pi-arrow-circle-left";
static readonly ARROW_CIRCLE_RIGHT = "pi pi-arrow-circle-right";
static readonly ARROW_CIRCLE_UP = "pi pi-arrow-circle-up";
static readonly ARROW_DOWN = "pi pi-arrow-down";
static readonly ARROW_DOWN_LEFT = "pi pi-arrow-down-left";
static readonly ARROW_DOWN_LEFT_AND_ARROW_UP_RIGHT_TO_CENTER = "pi pi-arrow-down-left-and-arrow-up-right-to-center";
static readonly ARROW_DOWN_RIGHT = "pi pi-arrow-down-right";
static readonly ARROW_LEFT = "pi pi-arrow-left";
static readonly ARROW_RIGHT_ARROW_LEFT = "pi pi-arrow-right-arrow-left";
static readonly ARROW_RIGHT = "pi pi-arrow-right";
static readonly ARROW_UP = "pi pi-arrow-up";
static readonly ARROW_UP_LEFT = "pi pi-arrow-up-left";
static readonly ARROW_UP_RIGHT = "pi pi-arrow-up-right";
static readonly ARROW_UP_RIGHT_AND_ARROW_DOWN_LEFT_FROM_CENTER = "pi pi-arrow-up-right-and-arrow-down-left-from-center";
static readonly ARROWS_H = "pi pi-arrows-h";
static readonly ARROWS_V = "pi pi-arrows-v";
static readonly ASTERISK = "pi pi-asterisk";
static readonly AT = "pi pi-at";
static readonly BACKWARD = "pi pi-backward";
static readonly BAN = "pi pi-ban";
static readonly BARCODE = "pi pi-barcode";
static readonly BARS = "pi pi-bars";
static readonly BELL = "pi pi-bell";
static readonly BELL_SLASH = "pi pi-bell-slash";
static readonly BITCOIN = "pi pi-bitcoin";
static readonly BOLT = "pi pi-bolt";
static readonly BOOK = "pi pi-book";
static readonly BOOKMARK = "pi pi-bookmark";
static readonly BOOKMARK_FILL = "pi pi-bookmark-fill";
static readonly BOX = "pi pi-box";
static readonly BRIEFCASE = "pi pi-briefcase";
static readonly BUILDING = "pi pi-building";
static readonly BUILDING_COLUMNS = "pi pi-building-columns";
static readonly BULLSEYE = "pi pi-bullseye";
static readonly CALCULATOR = "pi pi-calculator";
static readonly CALENDAR = "pi pi-calendar";
static readonly CALENDAR_CLOCK = "pi pi-calendar-clock";
static readonly CALENDAR_MINUS = "pi pi-calendar-minus";
static readonly CALENDAR_PLUS = "pi pi-calendar-plus";
static readonly CALENDAR_TIMES = "pi pi-calendar-times";
static readonly CAMERA = "pi pi-camera";
static readonly CAR = "pi pi-car";
static readonly CARET_DOWN = "pi pi-caret-down";
static readonly CARET_LEFT = "pi pi-caret-left";
static readonly CARET_RIGHT = "pi pi-caret-right";
static readonly CARET_UP = "pi pi-caret-up";
static readonly CART_ARROW_DOWN = "pi pi-cart-arrow-down";
static readonly CART_MINUS = "pi pi-cart-minus";
static readonly CART_PLUS = "pi pi-cart-plus";
static readonly CHART_BAR = "pi pi-chart-bar";
static readonly CHART_LINE = "pi pi-chart-line";
static readonly CHART_PIE = "pi pi-chart-pie";
static readonly CHART_SCATTER = "pi pi-chart-scatter";
static readonly CHECK = "pi pi-check";
static readonly CHECK_CIRCLE = "pi pi-check-circle";
static readonly CHECK_SQUARE = "pi pi-check-square";
static readonly CHEVRON_CIRCLE_DOWN = "pi pi-chevron-circle-down";
static readonly CHEVRON_CIRCLE_LEFT = "pi pi-chevron-circle-left";
static readonly CHEVRON_CIRCLE_RIGHT = "pi pi-chevron-circle-right";
static readonly CHEVRON_CIRCLE_UP = "pi pi-chevron-circle-up";
static readonly CHEVRON_DOWN = "pi pi-chevron-down";
static readonly CHEVRON_LEFT = "pi pi-chevron-left";
static readonly CHEVRON_RIGHT = "pi pi-chevron-right";
static readonly CHEVRON_UP = "pi pi-chevron-up";
static readonly CIRCLE = "pi pi-circle";
static readonly CIRCLE_FILL = "pi pi-circle-fill";
static readonly CLIPBOARD = "pi pi-clipboard";
static readonly CLOCK = "pi pi-clock";
static readonly CLONE = "pi pi-clone";
static readonly CLOUD = "pi pi-cloud";
static readonly CLOUD_DOWNLOAD = "pi pi-cloud-download";
static readonly CLOUD_UPLOAD = "pi pi-cloud-upload";
static readonly CODE = "pi pi-code";
static readonly COG = "pi pi-cog";
static readonly COMMENT = "pi pi-comment";
static readonly COMMENTS = "pi pi-comments";
static readonly COMPASS = "pi pi-compass";
static readonly COPY = "pi pi-copy";
static readonly CREDIT_CARD = "pi pi-credit-card";
static readonly CROWN = "pi pi-crown";
static readonly DATABASE = "pi pi-database";
static readonly DESKTOP = "pi pi-desktop";
static readonly DELETE_LEFT = "pi pi-delete-left";
static readonly DIRECTIONS = "pi pi-directions";
static readonly DIRECTIONS_ALT = "pi pi-directions-alt";
static readonly DISCORD = "pi pi-discord";
static readonly DOLLAR = "pi pi-dollar";
static readonly DOWNLOAD = "pi pi-download";
static readonly EJECT = "pi pi-eject";
static readonly ELLIPSIS_H = "pi pi-ellipsis-h";
static readonly ELLIPSIS_V = "pi pi-ellipsis-v";
static readonly ENVELOPE = "pi pi-envelope";
static readonly EQUALS = "pi pi-equals";
static readonly ERASER = "pi pi-eraser";
static readonly ETHEREUM = "pi pi-ethereum";
static readonly EURO = "pi pi-euro";
static readonly EXCLAMATION_CIRCLE = "pi pi-exclamation-circle";
static readonly EXCLAMATION_TRIANGLE = "pi pi-exclamation-triangle";
static readonly EXPAND = "pi pi-expand";
static readonly EXTERNAL_LINK = "pi pi-external-link";
static readonly EYE = "pi pi-eye";
static readonly EYE_SLASH = "pi pi-eye-slash";
static readonly FACE_SMILE = "pi pi-face-smile";
static readonly FACEBOOK = "pi pi-facebook";
static readonly FAST_BACKWARD = "pi pi-fast-backward";
static readonly FAST_FORWARD = "pi pi-fast-forward";
static readonly FILE = "pi pi-file";
static readonly FILE_ARROW_UP = "pi pi-file-arrow-up";
static readonly FILE_CHECK = "pi pi-file-check";
static readonly FILE_EDIT = "pi pi-file-edit";
static readonly FILE_IMPORT = "pi pi-file-import";
static readonly FILE_PDF = "pi pi-file-pdf";
static readonly FILE_PLUS = "pi pi-file-plus";
static readonly FILE_EXCEL = "pi pi-file-excel";
static readonly FILE_EXPORT = "pi pi-file-export";
static readonly FILE_WORD = "pi pi-file-word";
static readonly FILTER = "pi pi-filter";
static readonly FILTER_FILL = "pi pi-filter-fill";
static readonly FILTER_SLASH = "pi pi-filter-slash";
static readonly FLAG = "pi pi-flag";
static readonly FLAG_FILL = "pi pi-flag-fill";
static readonly FOLDER = "pi pi-folder";
static readonly FOLDER_OPEN = "pi pi-folder-open";
static readonly FOLDER_PLUS = "pi pi-folder-plus";
static readonly FORWARD = "pi pi-forward";
static readonly GAUGE = "pi pi-gauge";
static readonly GIFT = "pi pi-gift";
static readonly GITHUB = "pi pi-github";
static readonly GLOBE = "pi pi-globe";
static readonly GOOGLE = "pi pi-google";
static readonly GRADUATION_CAP = "pi pi-graduation-cap";
static readonly HAMMER = "pi pi-hammer";
static readonly HASHTAG = "pi pi-hashtag";
static readonly HEADPHONES = "pi pi-headphones";
static readonly HEART = "pi pi-heart";
static readonly HEART_FILL = "pi pi-heart-fill";
static readonly HISTORY = "pi pi-history";
static readonly HOME = "pi pi-home";
static readonly HOURGLASS = "pi pi-hourglass";
static readonly ID_CARD = "pi pi-id-card";
static readonly IMAGE = "pi pi-image";
static readonly IMAGES = "pi pi-images";
static readonly INBOX = "pi pi-inbox";
static readonly INDIAN_RUPEE = "pi pi-indian-rupee";
static readonly INFO = "pi pi-info";
static readonly INFO_CIRCLE = "pi pi-info-circle";
static readonly INSTAGRAM = "pi pi-instagram";
static readonly KEY = "pi pi-key";
static readonly LANGUAGE = "pi pi-language";
static readonly LIGHTBULB = "pi pi-lightbulb";
static readonly LINK = "pi pi-link";
static readonly LINKEDIN = "pi pi-linkedin";
static readonly LIST = "pi pi-list";
static readonly LIST_CHECK = "pi pi-list-check";
static readonly LOCK = "pi pi-lock";
static readonly LOCK_OPEN = "pi pi-lock-open";
static readonly MAP = "pi pi-map";
static readonly MAP_MARKER = "pi pi-map-marker";
static readonly MARS = "pi pi-mars";
static readonly MEGAPHONE = "pi pi-megaphone";
static readonly MICROCHIP = "pi pi-microchip";
static readonly MICROCHIP_AI = "pi pi-microchip-ai";
static readonly MICROPHONE = "pi pi-microphone";
static readonly MICROSOFT = "pi pi-microsoft";
static readonly MINUS = "pi pi-minus";
static readonly MINUS_CIRCLE = "pi pi-minus-circle";
static readonly MOBILE = "pi pi-mobile";
static readonly MONEY_BILL = "pi pi-money-bill";
static readonly MOON = "pi pi-moon";
static readonly OBJECTS_COLUMN = "pi pi-objects-column";
static readonly PALETTE = "pi pi-palette";
static readonly PAPERCLIP = "pi pi-paperclip";
static readonly PAUSE = "pi pi-pause";
static readonly PAUSE_CIRCLE = "pi pi-pause-circle";
static readonly PAYPAL = "pi pi-paypal";
static readonly PEN_TO_SQUARE = "pi pi-pen-to-square";
static readonly PENCIL = "pi pi-pencil";
static readonly PERCENTAGE = "pi pi-percentage";
static readonly PHONE = "pi pi-phone";
static readonly PINTEREST = "pi pi-pinterest";
static readonly PLAY = "pi pi-play";
static readonly PLAY_CIRCLE = "pi pi-play-circle";
static readonly PLUS = "pi pi-plus";
static readonly PLUS_CIRCLE = "pi pi-plus-circle";
static readonly POUND = "pi pi-pound";
static readonly POWER_OFF = "pi pi-power-off";
static readonly PRIME = "pi pi-prime";
static readonly PRINT = "pi pi-print";
static readonly QRCODE = "pi pi-qrcode";
static readonly QUESTION = "pi pi-question";
static readonly QUESTION_CIRCLE = "pi pi-question-circle";
static readonly RECEIPT = "pi pi-receipt";
static readonly REDDIT = "pi pi-reddit";
static readonly REFRESH = "pi pi-refresh";
static readonly REPLAY = "pi pi-replay";
static readonly REPLY = "pi pi-reply";
static readonly SAVE = "pi pi-save";
static readonly SEARCH = "pi pi-search";
static readonly SEARCH_MINUS = "pi pi-search-minus";
static readonly SEARCH_PLUS = "pi pi-search-plus";
static readonly SEND = "pi pi-send";
static readonly SERVER = "pi pi-server";
static readonly SHARE_ALT = "pi pi-share-alt";
static readonly SHIELD = "pi pi-shield";
static readonly SHOP = "pi pi-shop";
static readonly SHOPPING_BAG = "pi pi-shopping-bag";
static readonly SHOPPING_CART = "pi pi-shopping-cart";
static readonly SIGN_IN = "pi pi-sign-in";
static readonly SIGN_OUT = "pi pi-sign-out";
static readonly SITEMAP = "pi pi-sitemap";
static readonly SLACK = "pi pi-slack";
static readonly SLIDERS_H = "pi pi-sliders-h";
static readonly SLIDERS_V = "pi pi-sliders-v";
static readonly SORT = "pi pi-sort";
static readonly SORT_ALPHA_DOWN = "pi pi-sort-alpha-down";
static readonly SORT_ALPHA_DOWN_ALT = "pi pi-sort-alpha-down-alt";
static readonly SORT_ALPHA_UP = "pi pi-sort-alpha-up";
static readonly SORT_ALPHA_UP_ALT = "pi pi-sort-alpha-up-alt";
static readonly SORT_ALT = "pi pi-sort-alt";
static readonly SORT_ALT_SLASH = "pi pi-sort-alt-slash";
static readonly SORT_AMOUNT_DOWN = "pi pi-sort-amount-down";
static readonly SORT_AMOUNT_DOWN_ALT = "pi pi-sort-amount-down-alt";
static readonly SORT_AMOUNT_UP = "pi pi-sort-amount-up";
static readonly SORT_AMOUNT_UP_ALT = "pi pi-sort-amount-up-alt";
static readonly SORT_DOWN = "pi pi-sort-down";
static readonly SORT_DOWN_FILL = "pi pi-sort-down-fill";
static readonly SORT_NUMERIC_DOWN = "pi pi-sort-numeric-down";
static readonly SORT_NUMERIC_DOWN_ALT = "pi pi-sort-numeric-down-alt";
static readonly SORT_NUMERIC_UP = "pi pi-sort-numeric-up";
static readonly SORT_NUMERIC_UP_ALT = "pi pi-sort-numeric-up-alt";
static readonly SORT_UP = "pi pi-sort-up";
static readonly SORT_UP_FILL = "pi pi-sort-up-fill";
static readonly SPARKLES = "pi pi-sparkles";
static readonly SPINNER = "pi pi-spinner";
static readonly SPINNER_DOTTED = "pi pi-spinner-dotted";
static readonly STAR = "pi pi-star";
static readonly STAR_FILL = "pi pi-star-fill";
static readonly STAR_HALF = "pi pi-star-half";
static readonly STAR_HALF_FILL = "pi pi-star-half-fill";
static readonly STEP_BACKWARD = "pi pi-step-backward";
static readonly STEP_BACKWARD_ALT = "pi pi-step-backward-alt";
static readonly STEP_FORWARD = "pi pi-step-forward";
static readonly STEP_FORWARD_ALT = "pi pi-step-forward-alt";
static readonly STOP = "pi pi-stop";
static readonly STOP_CIRCLE = "pi pi-stop-circle";
static readonly STOPWATCH = "pi pi-stopwatch";
static readonly SUN = "pi pi-sun";
static readonly SYNC = "pi pi-sync";
static readonly TABLE = "pi pi-table";
static readonly TABLET = "pi pi-tablet";
static readonly TAG = "pi pi-tag";
static readonly TAGS = "pi pi-tags";
static readonly TELEGRAM = "pi pi-telegram";
static readonly TH_LARGE = "pi pi-th-large";
static readonly THUMBS_DOWN = "pi pi-thumbs-down";
static readonly THUMBS_DOWN_FILL = "pi pi-thumbs-down-fill";
static readonly THUMBS_UP = "pi pi-thumbs-up";
static readonly THUMBS_UP_FILL = "pi pi-thumbs-up-fill";
static readonly THUMBTACK = "pi pi-thumbtack";
static readonly TICKET = "pi pi-ticket";
static readonly TIKTOK = "pi pi-tiktok";
static readonly TIMES = "pi pi-times";
static readonly TIMES_CIRCLE = "pi pi-times-circle";
static readonly TRASH = "pi pi-trash";
static readonly TROPHY = "pi pi-trophy";
static readonly TRUCK = "pi pi-truck";
static readonly TURKISH_LIRA = "pi pi-turkish-lira";
static readonly TWITCH = "pi pi-twitch";
static readonly TWITTER = "pi pi-twitter";
static readonly UNDO = "pi pi-undo";
static readonly UNLOCK = "pi pi-unlock";
static readonly UPLOAD = "pi pi-upload";
static readonly USER = "pi pi-user";
static readonly USER_EDIT = "pi pi-user-edit";
static readonly USER_MINUS = "pi pi-user-minus";
static readonly USER_PLUS = "pi pi-user-plus";
static readonly USERS = "pi pi-users";
static readonly VENUS = "pi pi-venus";
static readonly VERIFIED = "pi pi-verified";
static readonly VIDEO = "pi pi-video";
static readonly VIMEO = "pi pi-vimeo";
static readonly VOLUME_DOWN = "pi pi-volume-down";
static readonly VOLUME_OFF = "pi pi-volume-off";
static readonly VOLUME_UP = "pi pi-volume-up";
static readonly WALLET = "pi pi-wallet";
static readonly WAREHOUSE = "pi pi-warehouse";
static readonly WAVE_PULSE = "pi pi-wave-pulse";
static readonly WHATSAPP = "pi pi-whatsapp";
static readonly WIFI = "pi pi-wifi";
static readonly WINDOW_MAXIMIZE = "pi pi-window-maximize";
static readonly WINDOW_MINIMIZE = "pi pi-window-minimize";
static readonly WRENCH = "pi pi-wrench";
static readonly YOUTUBE = "pi pi-youtube";
}
/**
* Options for the scroller.
* @group Interface
*/
interface ScrollerOptions {
/**
* Unique identifier of the element.
*/
id?: string | undefined;
/**
* Inline style of the component.
*/
style?: {
[klass: string]: any;
} | null | undefined;
/**
* Style class of the element.
*/
styleClass?: string | undefined;
/**
* Inline style of the content.
*/
contentStyle?: {
[klass: string]: any;
} | null | undefined;
/**
* Style class of the content.
*/
contentStyleClass?: string | undefined;
/**
* Index of the element in tabbing order.
*/
tabindex?: number | undefined;
/**
* An array of objects to display.
*/
items?: any[];
/**
* The height/width of item according to orientation.
*/
itemSize?: any;
/**
* Height of the scroll viewport.
*/
scrollHeight?: string | undefined;
/**
* Width of the scroll viewport.
*/
scrollWidth?: string | undefined;
/**
* The orientation of scrollbar.
*/
orientation?: 'vertical' | 'horizontal' | 'both';
/**
* Used to specify how many items to load in each load method in lazy mode.
*/
step?: number | undefined;
/**
* Delay in scroll before new data is loaded.
*/
delay?: number | undefined;
/**
* Delay after window's resize finishes.
*/
resizeDelay?: number | undefined;
/**
* Used to append each loaded item to top without removing any items from the DOM. Using very large data may cause the browser to crash.
*/
appendOnly?: boolean;
/**
* Specifies whether the scroller should be displayed inline or not.
*/
inline?: boolean;
/**
* Defines if data is loaded and interacted with in lazy manner.
*/
lazy?: boolean;
/**
* If disabled, the scroller feature is eliminated and the content is displayed directly.
*/
disabled?: boolean;
/**
* Used to implement a custom loader instead of using the loader feature in the scroller.
*/
loaderDisabled?: boolean;
/**
* Columns to display.
*/
columns?: any[] | undefined;
/**
* Used to implement a custom spacer instead of using the spacer feature in the scroller.
*/
showSpacer?: boolean;
/**
* Defines whether to show loader.
*/
showLoader?: boolean;
/**
* Determines how many additional elements to add to the DOM outside of the view. According to the scrolls made up and down, extra items are added in a certain algorithm in the form of multiples of this number. Default value is half the number of items shown in the view.
*/
numToleratedItems?: any;
/**
* Defines whether the data is loaded.
*/
loading?: boolean;
/**
* Defines whether to dynamically change the height or width of scrollable container.
*/
autoSize?: boolean;
/**
* Function to optimize the dom operations by delegating to ngForTrackBy, default algoritm checks for object identity.
*/
trackBy?: Function;
/**
* Callback to invoke in lazy mode to load new data.
*/
onLazyLoad?: Function | undefined;
/**
* Callback to invoke when scroll position changes.
*/
onScroll?: Function | undefined;
/**
* Callback to invoke when scroll position and item's range in view changes.
*/
onScrollIndexChange?: Function | undefined;
}
/**
* Represents an option item.
* @group Interface
*/
interface SelectItem<T = any> {
label?: string;
value: T;
styleClass?: string;
icon?: string;
title?: string;
disabled?: boolean;
}
/**
* Represents a group of select items.
* @group Interface
*/
interface SelectItemGroup<T = any> {
label: string;
value?: any;
items: SelectItem<T>[];
}
declare class Header {
static ɵfac: i0.ɵɵFactoryDeclaration<Header, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<Header, "p-header", never, {}, {}, never, ["*"], false, never>;
}
declare class Footer {
static ɵfac: i0.ɵɵFactoryDeclaration<Footer, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<Footer, "p-footer", never, {}, {}, never, ["*"], false, never>;
}
declare class PrimeTemplate {
template: TemplateRef<any>;
type: string | undefined;
name: string | undefined;
constructor(template: TemplateRef<any>);
getType(): string;
static ɵfac: i0.ɵɵFactoryDeclaration<PrimeTemplate, never>;
static ɵdir: i0.ɵɵDirectiveDeclaration<PrimeTemplate, "[pTemplate]", never, { "type": { "alias": "type"; "required": false; }; "name": { "alias": "pTemplate"; "required": false; }; }, {}, never, never, true, never>;
}
declare class SharedModule {
static ɵfac: i0.ɵɵFactoryDeclaration<SharedModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<SharedModule, [typeof Header, typeof Footer], [typeof i1.CommonModule, typeof PrimeTemplate], [typeof Header, typeof Footer, typeof PrimeTemplate]>;
static ɵinj: i0.ɵɵInjectorDeclaration<SharedModule>;
}
/**
* Represents an event triggered when sorting is applied.
* @group Interface
*/
interface SortEvent {
data?: any[];
mode?: string;
field?: string;
order?: number;
multiSortMeta?: SortMeta[];
}
/**
* Represents the state of a table component.
* @group Interface
*/
interface TableState {
/**
* The index of the first row to be displayed.
*/
first?: number;
/**
* The number of rows to be displayed per page.
*/
rows?: number;
/**
* The field used for sorting.
*/
sortField?: string;
/**
* The sort order.
*/
sortOrder?: number;
/**
* An array of sort metadata when multiple sorting is applied.
*/
multiSortMeta?: SortMeta[];
/**
* The filters to be applied to the table.
*/
filters?: {
[s: string]: FilterMetadata | FilterMetadata[];
};
/**
* The column widths for the table.
*/
columnWidths?: string;
/**
* The width of the table.
*/
tableWidth?: string;
/**
* The width of the wrapper element containing the table.
*/
wrapperWidth?: string;
/**
* The selected item(s) in the table.
*/
selection?: any;
/**
* The order of the columns in the table.
*/
columnOrder?: string[];
/**
* The keys of the expanded rows in the table.
*/
expandedRowKeys?: {
[s: string]: boolean;
};
}
/**
* Represents a set of translated strings used in a component or application.
* @group Interface
*/
interface Translation {
startsWith?: string;
contains?: string;
notContains?: string;
endsWith?: string;
equals?: string;
completed?: string;
notEquals?: string;
noFilter?: string;
lt?: string;
lte?: string;
gt?: string;
gte?: string;
is?: string;
isNot?: string;
before?: string;
after?: string;
dateIs?: string;
dateIsNot?: string;
dateBefore?: string;
dateAfter?: string;
clear?: string;
apply?: string;
matchAll?: string;
matchAny?: string;
addRule?: string;
removeRule?: string;
accept?: string;
reject?: string;
choose?: string;
upload?: string;
cancel?: string;
fileSizeTypes?: string[];
dayNames?: string[];
dayNamesShort?: string[];
dayNamesMin?: string[];
monthNames?: string[];
monthNamesShort?: string[];
dateFormat?: string;
firstDayOfWeek?: number;
today?: string;
weekHeader?: string;
weak?: string;
medium?: string;
strong?: string;
passwordPrompt?: string;
emptyMessage?: string;
emptyFilterMessage?: string;
fileChosenMessage?: string;
noFileChosenMessage?: string;
pending?: string;
chooseYear?: string;
chooseMonth?: string;
chooseDate?: string;
prevDecade?: string;
nextDecade?: string;
prevYear?: string;
nextYear?: string;
prevMonth?: string;
nextMonth?: string;
prevHour?: string;
nextHour?: string;
prevMinute?: string;
nextMinute?: string;
prevSecond?: string;
nextSecond?: string;
am?: string;
pm?: string;
searchMessage?: string;
selectionMessage?: string;
emptySelectionMessage?: string;
emptySearchMessage?: string;
aria?: Aria;
}
/**
* Represents a set of translated HTML attributes used in a component or application.
* @group Interface
*/
interface Aria {
trueLabel?: string;
falseLabel?: string;
nullLabel?: string;
star?: string;
stars?: string;
selectAll?: string;
unselectAll?: string;
close?: string;
previous?: string;
next?: string;
navigation?: string;
scrollTop?: string;
moveTop?: string;
moveUp?: string;
moveDown?: string;
moveBottom?: string;
moveToTarget?: string;
moveToSource?: string;
moveAllToTarget?: string;
moveAllToSource?: string;
pageLabel?: string;
firstPageLabel?: string;
lastPageLabel?: string;
nextPageLabel?: string;
prevPageLabel?: string;
rowsPerPageLabel?: string;
previousPageLabel?: string;
jumpToPageDropdownLabel?: string;
jumpToPageInputLabel?: string;
selectRow?: string;
unselectRow?: string;
expandRow?: string;
collapseRow?: string;
showFilterMenu?: string;
hideFilterMenu?: string;
filterOperator?: string;
filterConstraint?: string;
editRow?: string;
saveEdit?: string;
cancelEdit?: string;
listView?: string;
gridView?: string;
slide?: string;
slideNumber?: string;
zoomImage?: string;
zoomIn?: string;
zoomOut?: string;
rotateRight?: string;
rotateLeft?: string;
listLabel?: string;
selectColor?: string;
removeLabel?: string;
browseFiles?: string;
maximizeLabel?: string;
}
declare class TranslationKeys {
static readonly STARTS_WITH = "startsWith";
static readonly CONTAINS = "contains";
static readonly NOT_CONTAINS = "notContains";
static readonly ENDS_WITH = "endsWith";
static readonly EQUALS = "equals";
static readonly NOT_EQUALS = "notEquals";
static readonly NO_FILTER = "noFilter";
static readonly LT = "lt";
static readonly LTE = "lte";
static readonly GT = "gt";
static readonly GTE = "gte";
static readonly IS = "is";
static readonly IS_NOT = "isNot";
static readonly BEFORE = "before";
static readonly AFTER = "after";
static readonly CLEAR = "clear";
static readonly APPLY = "apply";
static readonly MATCH_ALL