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
195 lines (191 loc) • 6.45 kB
TypeScript
import { DockPassThrough, DockItemTemplateContext } from 'primeng/types/dock';
export * from 'primeng/types/dock';
import * as i0 from '@angular/core';
import { ChangeDetectorRef, EventEmitter, ElementRef, TemplateRef, QueryList } from '@angular/core';
import * as i2 from 'primeng/api';
import { MenuItem, PrimeTemplate } from 'primeng/api';
import { BaseComponent } from 'primeng/basecomponent';
import * as i1 from 'primeng/bind';
import { Bind } from 'primeng/bind';
import { Nullable } from 'primeng/ts-helpers';
import * as _primeuix_styled from '@primeuix/styled';
import { BaseStyle } from 'primeng/base';
/**
*
* Dock is a navigation component consisting of menuitems.
*
* [Live Demo](https://www.primeng.org/dock/)
*
* @module dockstyle
*
*/
declare enum DockClasses {
/**
* Class name of the root element
*/
root = "p-dock",
/**
* Class name of the list container element
*/
listContainer = "p-dock-list-container",
/**
* Class name of the list element
*/
list = "p-dock-list",
/**
* Class name of the item element
*/
item = "p-dock-item",
/**
* Class name of the item content element
*/
itemContent = "p-dock-item-content",
/**
* Class name of the item link element
*/
itemLink = "p-dock-item-link",
/**
* Class name of the item icon element
*/
itemIcon = "p-dock-item-icon"
}
declare class DockStyle extends BaseStyle {
name: string;
style: _primeuix_styled.StyleType;
classes: {
root: ({ instance }: {
instance: any;
}) => (string | {
'p-dock-mobile': any;
})[];
listContainer: string;
list: string;
item: ({ instance, item, id }: {
instance: any;
item: any;
id: any;
}) => (string | {
'p-focus': any;
'p-disabled': any;
})[];
itemContent: string;
itemLink: string;
itemIcon: string;
};
static ɵfac: i0.ɵɵFactoryDeclaration<DockStyle, never>;
static ɵprov: i0.ɵɵInjectableDeclaration<DockStyle>;
}
interface DockStyle extends BaseStyle {
}
/**
* Dock is a navigation component consisting of menuitems.
* @group Components
*/
declare class Dock extends BaseComponent<DockPassThrough> {
cd: ChangeDetectorRef;
/**
* Current id state as a string.
* @group Props
*/
id: string | undefined;
/**
* Class of the element.
* @deprecated since v20.0.0, use `class` instead.
* @group Props
*/
styleClass: string | undefined;
/**
* MenuModel instance to define the action items.
* @group Props
*/
model: MenuItem[] | undefined | null;
/**
* Position of element.
* @group Props
*/
position: 'bottom' | 'top' | 'left' | 'right';
/**
* Defines a string that labels the input for accessibility.
* @group Props
*/
ariaLabel: string | undefined;
/**
* The breakpoint to define the maximum width boundary.
* @defaultValue 960px
* @group Props
*/
breakpoint: string | undefined;
/**
* Defines a string that labels the dropdown button for accessibility.
* @group Props
*/
ariaLabelledBy: string | undefined;
/**
* Callback to execute when button is focused.
* @param {FocusEvent} event - Focus event.
* @group Emits
*/
onFocus: EventEmitter<FocusEvent>;
/**
* Callback to invoke when the component loses focus.
* @param {FocusEvent} event - Focus event.
* @group Emits
*/
onBlur: EventEmitter<FocusEvent>;
listViewChild: Nullable<ElementRef>;
currentIndex: number;
tabindex: number;
focused: boolean;
focusedOptionIndex: string | number;
_componentStyle: DockStyle;
bindDirectiveInstance: Bind;
$pcDock: Dock | undefined;
matchMediaListener: any;
query: any;
queryMatches: i0.WritableSignal<boolean>;
mobileActive: i0.WritableSignal<boolean>;
get focusedOptionId(): string | null;
constructor(cd: ChangeDetectorRef);
onInit(): void;
onDestroy(): void;
/**
* Custom item template.
* @param {DockItemTemplateContext} context - item template context.
* @group Templates
*/
itemTemplate: TemplateRef<DockItemTemplateContext> | undefined;
_itemTemplate: TemplateRef<DockItemTemplateContext> | undefined;
getItemId(item: any, index: any): any;
getItemProp(processedItem: any, name: any): any;
disabled(item: any): any;
isItemActive(id: any): boolean;
onListMouseLeave(): void;
onItemMouseEnter(index: number): void;
onItemClick(e: Event, item: MenuItem): void;
onListFocus(event: any): void;
onListBlur(event: any): void;
onListKeyDown(event: any): void;
onArrowDownKey(): void;
onArrowUpKey(): void;
onHomeKey(): void;
onEndKey(): void;
onSpaceKey(): void;
findNextOptionIndex(index: any): number;
changeFocusedOptionIndex(index: any): void;
findPrevOptionIndex(index: any): number;
isClickableRouterLink(item: any): boolean;
templates: QueryList<PrimeTemplate> | undefined;
onAfterContentInit(): void;
onAfterViewChecked(): void;
getPTOptions(item: MenuItem, index: number, key: string): any;
bindMatchMediaListener(): void;
unbindMatchMediaListener(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<Dock, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<Dock, "p-dock", never, { "id": { "alias": "id"; "required": false; }; "styleClass": { "alias": "styleClass"; "required": false; }; "model": { "alias": "model"; "required": false; }; "position": { "alias": "position"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "breakpoint": { "alias": "breakpoint"; "required": false; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; }; }, { "onFocus": "onFocus"; "onBlur": "onBlur"; }, ["itemTemplate", "templates"], never, true, [{ directive: typeof i1.Bind; inputs: {}; outputs: {}; }]>;
}
declare class DockModule {
static ɵfac: i0.ɵɵFactoryDeclaration<DockModule, never>;
static ɵmod: i0.ɵɵNgModuleDeclaration<DockModule, never, [typeof Dock, typeof i2.SharedModule], [typeof Dock, typeof i2.SharedModule]>;
static ɵinj: i0.ɵɵInjectorDeclaration<DockModule>;
}
export { Dock, DockClasses, DockModule, DockStyle };