@gravionlabs/helix-core 22.0.0

package/types/gravionlabs-helix-core-contextmenu.d.ts

@@ -0,0 +1,370 @@
+import { ContextMenuPassThrough, ContextMenuItemTemplateContext, ContextMenuSubmenuIconTemplateContext } from '@gravionlabs/helix-core/types/contextmenu';
+export * from '@gravionlabs/helix-core/types/contextmenu';
+import * as _angular_core from '@angular/core';
+import { AfterViewChecked, ElementRef, Renderer2, TemplateRef } from '@angular/core';
+import { MotionOptions, MotionEvent } from '@gravionlabs/helix-core/uix/motion';
+import * as i1 from '@gravionlabs/helix-core/api';
+import { OverlayService, MenuItem, HelixTemplate } from '@gravionlabs/helix-core/api';
+import { BaseComponent } from '@gravionlabs/helix-core/basecomponent';
+import { VoidListener } from '@gravionlabs/helix-core/ts-helpers';
+import { BaseStyle } from '@gravionlabs/helix-core/base';
+
+/**
+ *
+ * ContextMenu displays an overlay menu on right click of its target. Note that components like DataTable has special integration with ContextMenu.
+ * Refer to documentation of the individual documentation of the with context menu support.
+ *
+ * [Live Demo](https://www.primeng.org/contextmenu/)
+ *
+ * @module contextmenustyle
+ *
+ */
+declare enum ContextMenuClasses {
+    /**
+     * Class name of the root element
+     */
+    root = "h-contextmenu",
+    /**
+     * Class name of the root list element
+     */
+    rootList = "h-contextmenu-root-list",
+    /**
+     * Class name of the item element
+     */
+    item = "h-contextmenu-item",
+    /**
+     * Class name of the item content element
+     */
+    itemContent = "h-contextmenu-item-content",
+    /**
+     * Class name of the item link element
+     */
+    itemLink = "h-contextmenu-item-link",
+    /**
+     * Class name of the item icon element
+     */
+    itemIcon = "h-contextmenu-item-icon",
+    /**
+     * Class name of the item label element
+     */
+    itemLabel = "h-contextmenu-item-label",
+    /**
+     * Class name of the submenu icon element
+     */
+    submenuIcon = "h-contextmenu-submenu-icon",
+    /**
+     * Class name of the submenu element
+     */
+    submenu = "h-contextmenu-submenu",
+    /**
+     * Class name of the separator element
+     */
+    separator = "h-contextmenu-separator"
+}
+declare class ContextMenuStyle extends BaseStyle {
+    name: string;
+    style: string;
+    classes: {
+        root: () => string[];
+        rootList: string;
+        item: ({ instance, processedItem }: {
+            instance: any;
+            processedItem: any;
+        }) => (string | {
+            'h-contextmenu-item-active': any;
+            'h-focus': any;
+            'h-disabled': any;
+            'h-contextmenu-mobile': any;
+        })[];
+        itemContent: string;
+        itemLink: string;
+        itemIcon: string;
+        itemLabel: string;
+        submenuIcon: string;
+        submenu: string;
+        separator: string;
+    };
+    inlineStyles: {
+        root: {
+            position: string;
+        };
+    };
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContextMenuStyle, never>;
+    static ɵprov: _angular_core.ɵɵInjectableDeclaration<any>;
+}
+interface ContextMenuStyle extends BaseStyle {
+}
+
+declare class ContextMenuSub extends BaseComponent<ContextMenuPassThrough> implements AfterViewChecked {
+    el: ElementRef;
+    renderer: Renderer2;
+    contextMenu: ContextMenu;
+    readonly visible: _angular_core.ModelSignal<boolean>;
+    _visibleEffect: _angular_core.EffectRef;
+    readonly items: _angular_core.InputSignal<any[]>;
+    readonly itemTemplate: _angular_core.InputSignal<TemplateRef<ContextMenuItemTemplateContext> | undefined>;
+    readonly root: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
+    readonly autoZIndex: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    readonly baseZIndex: _angular_core.InputSignalWithTransform<number, unknown>;
+    readonly popup: _angular_core.InputSignalWithTransform<boolean | undefined, unknown>;
+    readonly menuId: _angular_core.InputSignal<string | undefined>;
+    readonly ariaLabel: _angular_core.InputSignal<string | undefined>;
+    readonly ariaLabelledBy: _angular_core.InputSignal<string | undefined>;
+    readonly level: _angular_core.InputSignalWithTransform<number, unknown>;
+    readonly focusedItemId: _angular_core.InputSignal<string | undefined>;
+    readonly activeItemPath: _angular_core.InputSignal<any[]>;
+    readonly motionOptions: _angular_core.InputSignal<MotionOptions[] | undefined>;
+    readonly tabindex: _angular_core.InputSignalWithTransform<number, unknown>;
+    readonly itemClick: _angular_core.OutputEmitterRef<any>;
+    readonly itemMouseEnter: _angular_core.OutputEmitterRef<any>;
+    readonly menuFocus: _angular_core.OutputEmitterRef<any>;
+    readonly menuBlur: _angular_core.OutputEmitterRef<any>;
+    readonly menuKeydown: _angular_core.OutputEmitterRef<any>;
+    readonly sublistViewChild: _angular_core.Signal<ElementRef<any>>;
+    render: _angular_core.WritableSignal<boolean>;
+    hostName: string;
+    _componentStyle: ContextMenuStyle;
+    $pcContextMenu: ContextMenu | undefined;
+    $pcContextMenuSub: ContextMenuSub | undefined;
+    constructor(el: ElementRef, renderer: Renderer2, contextMenu: ContextMenu);
+    getItemProp(processedItem: any, name: string, params?: any | null): any;
+    getItemId(processedItem: any): string;
+    getItemKey(processedItem: any): string;
+    getItemLabel(processedItem: any): string;
+    getAriaSetSize(): number;
+    getAriaPosInset(index: number): number;
+    isItemVisible(processedItem: any): boolean;
+    isItemActive(processedItem: any): boolean | undefined;
+    isItemDisabled(processedItem: any): boolean | undefined;
+    isItemFocused(processedItem: any): boolean;
+    isItemGroup(processedItem: any): boolean;
+    onItemMouseEnter(param: any): void;
+    onItemClick(event: any, processedItem: any): void;
+    onBeforeEnter(event: MotionEvent): void;
+    onAfterLeave(): void;
+    _ptm(section: string, options?: any): any;
+    getPTOptions(processedItem: any, index: number, key: string): any;
+    position(sublist: any): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContextMenuSub, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContextMenuSub, "h-contextMenuSub, h-contextmenu-sub", never, { "visible": { "alias": "visible"; "required": false; "isSignal": true; }; "items": { "alias": "items"; "required": false; "isSignal": true; }; "itemTemplate": { "alias": "itemTemplate"; "required": false; "isSignal": true; }; "root": { "alias": "root"; "required": false; "isSignal": true; }; "autoZIndex": { "alias": "autoZIndex"; "required": false; "isSignal": true; }; "baseZIndex": { "alias": "baseZIndex"; "required": false; "isSignal": true; }; "popup": { "alias": "popup"; "required": false; "isSignal": true; }; "menuId": { "alias": "menuId"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; "isSignal": true; }; "level": { "alias": "level"; "required": false; "isSignal": true; }; "focusedItemId": { "alias": "focusedItemId"; "required": false; "isSignal": true; }; "activeItemPath": { "alias": "activeItemPath"; "required": false; "isSignal": true; }; "motionOptions": { "alias": "motionOptions"; "required": false; "isSignal": true; }; "tabindex": { "alias": "tabindex"; "required": false; "isSignal": true; }; }, { "visible": "visibleChange"; "itemClick": "itemClick"; "itemMouseEnter": "itemMouseEnter"; "menuFocus": "menuFocus"; "menuBlur": "menuBlur"; "menuKeydown": "menuKeydown"; }, never, never, true, never>;
+}
+/**
+ * ContextMenu displays an overlay menu on right click of its target. Note that components like Table has special integration with ContextMenu.
+ * @group Components
+ */
+declare class ContextMenu extends BaseComponent<ContextMenuPassThrough> {
+    overlayService: OverlayService;
+    componentName: string;
+    /**
+     * An array of menuitems.
+     * @group Props
+     */
+    readonly model: _angular_core.InputSignal<MenuItem[] | undefined>;
+    _modelEffect: _angular_core.EffectRef;
+    /**
+     * Event for which the menu must be displayed.
+     * @group Props
+     */
+    readonly triggerEvent: _angular_core.InputSignal<string>;
+    /**
+     * Local template variable name of the element to attach the context menu.
+     * @group Props
+     */
+    readonly target: _angular_core.ModelSignal<string | HTMLElement | null | undefined>;
+    /**
+     * Attaches the menu to document instead of a particular item.
+     * @group Props
+     */
+    readonly global: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Inline style of the component.
+     * @group Props
+     */
+    readonly style: _angular_core.InputSignal<{
+        [klass: string]: any;
+    } | null | undefined>;
+    /**
+     * Style class of the component.
+     * @group Props
+     */
+    readonly styleClass: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Whether to automatically manage layering.
+     * @group Props
+     */
+    readonly autoZIndex: _angular_core.InputSignalWithTransform<boolean, unknown>;
+    /**
+     * Base zIndex value to use in layering.
+     * @group Props
+     */
+    readonly baseZIndex: _angular_core.InputSignalWithTransform<number, unknown>;
+    /**
+     * Current id state as a string.
+     * @group Props
+     */
+    readonly id: _angular_core.InputSignal<string | undefined>;
+    private readonly autoId;
+    readonly $id: _angular_core.Signal<string>;
+    /**
+     * The breakpoint to define the maximum width boundary.
+     * @group Props
+     */
+    readonly breakpoint: _angular_core.InputSignal<string>;
+    /**
+     * Defines a string value that labels an interactive element.
+     * @group Props
+     */
+    readonly ariaLabel: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Identifier of the underlying input element.
+     * @group Props
+     */
+    readonly ariaLabelledBy: _angular_core.InputSignal<string | undefined>;
+    /**
+     * Press delay in touch devices as miliseconds.
+     * @group Props
+     */
+    readonly pressDelay: _angular_core.InputSignalWithTransform<number | undefined, unknown>;
+    /**
+     * 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 'self'
+     * @group Props
+     */
+    appendTo: _angular_core.InputSignal<any>;
+    /**
+     * The motion options.
+     * @group Props
+     */
+    motionOptions: _angular_core.InputSignal<MotionOptions | undefined>;
+    computedMotionOptions: _angular_core.Signal<MotionOptions>;
+    /**
+     * Callback to invoke when overlay menu is shown.
+     * @group Emits
+     */
+    readonly onShow: _angular_core.OutputEmitterRef<void>;
+    /**
+     * Callback to invoke when overlay menu is hidden.
+     * @group Emits
+     */
+    readonly onHide: _angular_core.OutputEmitterRef<void>;
+    readonly rootmenu: _angular_core.Signal<ContextMenuSub | undefined>;
+    container: HTMLElement | null | undefined;
+    handleSubmenuAfterLeave: (() => void) | null;
+    outsideClickListener: VoidListener;
+    resizeListener: VoidListener;
+    triggerEventListener: VoidListener;
+    documentClickListener: VoidListener;
+    documentTriggerListener: VoidListener;
+    touchEndListener: VoidListener;
+    pageX: number;
+    pageY: number;
+    visible: _angular_core.WritableSignal<boolean>;
+    render: _angular_core.WritableSignal<boolean>;
+    focused: boolean;
+    activeItemPath: _angular_core.WritableSignal<any>;
+    focusedItemInfo: _angular_core.WritableSignal<any>;
+    submenuVisible: _angular_core.WritableSignal<boolean>;
+    $appendTo: _angular_core.Signal<any>;
+    searchValue: string;
+    searchTimeout: any;
+    _processedItems: any[];
+    pressTimer: any;
+    hideCallback: any;
+    private matchMediaListener;
+    private query;
+    queryMatches: _angular_core.WritableSignal<boolean>;
+    _componentStyle: ContextMenuStyle;
+    get visibleItems(): any;
+    get processedItems(): any[];
+    get focusedItemId(): any;
+    constructor(overlayService: OverlayService);
+    onInit(): void;
+    isMobile(): boolean;
+    bindTriggerEventListener(): void;
+    bindGlobalListeners(): void;
+    /**
+     * Custom item template.
+     * @group Templates
+     */
+    readonly itemTemplate: _angular_core.Signal<TemplateRef<ContextMenuItemTemplateContext> | undefined>;
+    /**
+     * Custom submenu icon template.
+     * @group Templates
+     */
+    readonly submenuIconTemplate: _angular_core.Signal<TemplateRef<ContextMenuSubmenuIconTemplateContext> | undefined>;
+    readonly templates: _angular_core.Signal<readonly HelixTemplate[]>;
+    _submenuIconTemplate: TemplateRef<ContextMenuSubmenuIconTemplateContext> | undefined;
+    _itemTemplate: TemplateRef<ContextMenuItemTemplateContext> | undefined;
+    onAfterContentInit(): void;
+    getPTOptions(key: string, item: any, index: number, id: string): any;
+    isItemFocused(itemInfo: any): boolean;
+    createProcessedItems(items: any, level?: number, parent?: any, parentKey?: any): any[];
+    bindMatchMediaListener(): void;
+    unbindMatchMediaListener(): void;
+    getItemProp(item: any, name: string): any;
+    getProccessedItemLabel(processedItem: any): any;
+    getItemLabel(item: any): any;
+    isProcessedItemGroup(processedItem: any): boolean;
+    isSelected(processedItem: any): boolean;
+    isValidSelectedItem(processedItem: any): boolean;
+    isValidItem(processedItem: any): boolean;
+    isItemDisabled(item: any): boolean;
+    isItemSeparator(item: any): boolean;
+    isItemMatched(processedItem: any): boolean;
+    isProccessedItemGroup(processedItem: any): boolean;
+    onItemClick(event: any): void;
+    onItemMouseEnter(event: any): void;
+    onKeyDown(event: KeyboardEvent): void;
+    onArrowDownKey(event: KeyboardEvent): void;
+    onArrowRightKey(event: KeyboardEvent): void;
+    onArrowUpKey(event: KeyboardEvent): void;
+    onArrowLeftKey(event: KeyboardEvent): void;
+    onHomeKey(event: KeyboardEvent): void;
+    onEndKey(event: KeyboardEvent): void;
+    onSpaceKey(event: KeyboardEvent): void;
+    onEscapeKey(event: KeyboardEvent): void;
+    onTabKey(event: KeyboardEvent): void;
+    onEnterKey(event: KeyboardEvent): void;
+    onItemChange(event: any, type?: string | undefined): void;
+    onMenuFocus(event: any): void;
+    onMenuBlur(event: any): void;
+    onBeforeEnter(event: MotionEvent): void;
+    onAfterEnter(): void;
+    onAfterLeave(): void;
+    appendOverlay(): void;
+    restoreOverlayAppend(): void;
+    moveOnTop(): void;
+    onOverlayHide(): void;
+    onTouchStart(event: MouseEvent): void;
+    onTouchEnd(): void;
+    hide(): void;
+    toggle(event?: any): void;
+    show(event: any): void;
+    position(): void;
+    searchItems(event: any, char: string): boolean;
+    findVisibleItem(index: any): any;
+    findLastFocusedItemIndex(): any;
+    findLastItemIndex(): number;
+    findPrevItemIndex(index: number): number;
+    findNextItemIndex(index: number): any;
+    findFirstFocusedItemIndex(): any;
+    findFirstItemIndex(): any;
+    findSelectedItemIndex(): any;
+    changeFocusedItemIndex(event: any, index: number): void;
+    scrollInView(index?: number): void;
+    bindResizeListener(): void;
+    isOutsideClicked(event: Event): boolean;
+    unbindResizeListener(): void;
+    unbindGlobalListeners(): void;
+    unbindTriggerEventListener(): void;
+    onDestroy(): void;
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContextMenu, never>;
+    static ɵcmp: _angular_core.ɵɵComponentDeclaration<ContextMenu, "h-contextMenu, h-contextmenu, h-context-menu", never, { "model": { "alias": "model"; "required": false; "isSignal": true; }; "triggerEvent": { "alias": "triggerEvent"; "required": false; "isSignal": true; }; "target": { "alias": "target"; "required": false; "isSignal": true; }; "global": { "alias": "global"; "required": false; "isSignal": true; }; "style": { "alias": "style"; "required": false; "isSignal": true; }; "styleClass": { "alias": "styleClass"; "required": false; "isSignal": true; }; "autoZIndex": { "alias": "autoZIndex"; "required": false; "isSignal": true; }; "baseZIndex": { "alias": "baseZIndex"; "required": false; "isSignal": true; }; "id": { "alias": "id"; "required": false; "isSignal": true; }; "breakpoint": { "alias": "breakpoint"; "required": false; "isSignal": true; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; "isSignal": true; }; "ariaLabelledBy": { "alias": "ariaLabelledBy"; "required": false; "isSignal": true; }; "pressDelay": { "alias": "pressDelay"; "required": false; "isSignal": true; }; "appendTo": { "alias": "appendTo"; "required": false; "isSignal": true; }; "motionOptions": { "alias": "motionOptions"; "required": false; "isSignal": true; }; }, { "target": "targetChange"; "onShow": "onShow"; "onHide": "onHide"; }, ["itemTemplate", "submenuIconTemplate", "templates"], never, true, never>;
+}
+declare class ContextMenuModule {
+    static ɵfac: _angular_core.ɵɵFactoryDeclaration<ContextMenuModule, never>;
+    static ɵmod: _angular_core.ɵɵNgModuleDeclaration<ContextMenuModule, never, [typeof ContextMenu, typeof i1.SharedModule], [typeof ContextMenu, typeof i1.SharedModule]>;
+    static ɵinj: _angular_core.ɵɵInjectorDeclaration<ContextMenuModule>;
+}
+
+export { ContextMenu, ContextMenuClasses, ContextMenuModule, ContextMenuStyle, ContextMenuSub };