@energycap/components 0.39.16 → 0.39.17-ECAP-23124-menu-item-divider-improvements.20240523-1134

package/lib/controls/combobox/combobox.component.d.ts

@@ -212,6 +212,11 @@ export declare class ComboboxComponent extends FormControlBase implements OnInit
      * Number of filtered options to display in the footer.  Excludes headings.
      */
     filteredOptionCount: number;
+    /**
+     * Flat list of selectable items in the combobox.
+     * Does not include headings or divider-section items.
+     */
+    private selectableItems;
     /**
      * Index of the currently-selected options
      */

package/lib/controls/menu/menu.component.d.ts

@@ -1,4 +1,4 @@
-import { AfterContentInit, ElementRef, EventEmitter, OnDestroy, Renderer2, TemplateRef } from '@angular/core';
+import { AfterContentInit, ElementRef, EventEmitter, OnChanges, OnDestroy, Renderer2, SimpleChanges, TemplateRef } from '@angular/core';
 import { ScrollService } from '../../core/scroll.service';
 import { WindowService } from '../../core/window.service';
 import { LinkTarget } from '../../display/tags/tag';
@@ -11,7 +11,7 @@ export interface MenuItem<TValue = any, SItems = any> extends NavItem {
     caption?: string;
     items?: MenuItem<SItems>[];
     checked?: boolean;
-    display?: 'default' | 'heading' | 'divider';
+    display?: 'default' | 'heading' | 'divider' | 'divided-section';
     value?: TValue;
     classList?: string;
     disabled?: boolean;
@@ -21,6 +21,7 @@ export interface MenuItem<TValue = any, SItems = any> extends NavItem {
     externalLink?: boolean;
     /** Optional text to display in-place of the default label when the MenuItem is selected. */
     selectedLabel?: string;
+    hideIfNoItems?: boolean;
 }
 export declare const menuAnimationSpeed = 350;
 /**
@@ -28,7 +29,7 @@ export declare const menuAnimationSpeed = 350;
  *
  * @export
  */
-export declare class MenuComponent implements AfterContentInit, OnDestroy {
+export declare class MenuComponent implements AfterContentInit, OnDestroy, OnChanges {
     private el;
     private renderer;
     private windowService;
@@ -161,7 +162,29 @@ export declare class MenuComponent implements AfterContentInit, OnDestroy {
      * This allows us to prevent double-calls to selectItem() with the same input.
      */
     private lastSelected;
+    /**
+     * Flattened array of all selectable items in the menu. Makes it easier to keep track of the currently highlighted item for keyboard navigation.
+     */
+    private selectableItems;
+    /**
+     * Helper function to return a flat list of all selectable items in the provided menu items. Filters out headings and divided-sections.
+     * This makes it much easier to keep track of currently highlighted items for keyboard navigation.
+     */
+    static getSelectableItems(items: MenuItem[]): MenuItem[];
+    /**
+     * Returns an ID for the provided item based on its index in the provided items array. This mimics the behavior of the MenuComponent's
+     * generated IDs for items that don't have provided IDs. This is used in MenuComponent and ComboboxComponent to scroll to specific items.
+     * NOTE: If the items array does not match what is displayed in the menu, this function will not return the correct ID.
+     *
+     * Returns null if the not found
+     * @param items The MenuItems array to search through.
+     * @param item The item to generate the ID for.
+     * @param menuComponentId Used to prefix the generated ID. This should be the ID of the menu component the item is present in.
+     * @memberof MenuComponent
+     */
+    static getIndexedItemId(items: MenuItem[], item?: MenuItem | null, menuComponentId?: string): string | null;
     constructor(el: ElementRef, renderer: Renderer2, windowService: WindowService, scrollService: ScrollService);
+    ngOnChanges(changes: SimpleChanges): void;
     /**
      * Sets & displays the interalized template based on
      * the set template.
@@ -215,14 +238,6 @@ export declare class MenuComponent implements AfterContentInit, OnDestroy {
      */
     private scrollMenu;
     private scrollToHighlightedItem;
-    /**
-     * Find a given item's index in the filtered items array.
-     *
-     * Returns -1 if not found
-     * @param itemToFind The matching item to find in the items array.
-     * @memberof MenuComponent
-     */
-    private findItemIndex;
     private addKeydownListener;
     /**
      * Sets the menu item ids using its index if item doesn't already have one

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@energycap/components",
-  "version": "0.39.16",
+  "version": "0.39.17-ECAP-23124-menu-item-divider-improvements.20240523-1134",
   "dependencies": {
     "tslib": "^2.0.0"
   },