@energycap/components 0.39.16-ECAP-23124-menu-item-divider-improvements.20240516-1629 → 0.39.16-ECAP-23124-menu-item-divider-improvements.20240523-1101

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/form-control-base.d.ts

@@ -3,6 +3,7 @@ import { AbstractControl } from "@angular/forms";
 import { Subject } from "rxjs";
 import { ValidationMessageService } from "../core/validation-message.service";
 import { FormGroupHelper } from '../shared/form-group.helper';
+import { PopoverContentPosition } from './popover/popover.component';
 import * as i0 from "@angular/core";
 export type ControlLabelPosition = "top" | "bottom" | "left";
 /**
@@ -54,6 +55,14 @@ export declare abstract class FormControlBase implements OnInit, OnDestroy, OnCh
      * Conditionally show a tooltip on the form control's input.
      */
     tooltip?: string;
+    /**
+     * Conditionally show a help popover next to the controls label.
+     */
+    helpPopover?: string;
+    /**
+     * When a help popover is present, allows the popover to be positioned in different locations.
+     */
+    helpPopoverPosition?: PopoverContentPosition;
     /**
      * All current validation errors
      */
@@ -97,5 +106,5 @@ export declare abstract class FormControlBase implements OnInit, OnDestroy, OnCh
      */
     protected translateValidationMessages(data?: any): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<FormControlBase, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<FormControlBase, never, never, { "autofocus": "autofocus"; "formModel": "formModel"; "label": "label"; "labelPosition": "labelPosition"; "id": "id"; "pending": "pending"; "required": "required"; "tabindex": "tabindex"; "readonly": "readonly"; "tooltip": "tooltip"; }, {}, never, never, false, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<FormControlBase, never, never, { "autofocus": "autofocus"; "formModel": "formModel"; "label": "label"; "labelPosition": "labelPosition"; "id": "id"; "pending": "pending"; "required": "required"; "tabindex": "tabindex"; "readonly": "readonly"; "tooltip": "tooltip"; "helpPopover": "helpPopover"; "helpPopoverPosition": "helpPopoverPosition"; }, {}, never, never, false, never>;
 }

package/lib/controls/form-group/form-group.component.d.ts

@@ -3,6 +3,7 @@ import { UntypedFormGroup, UntypedFormArray, AbstractControl } from "@angular/fo
 import { TranslateService } from "@ngx-translate/core";
 import { ValidationMessageService } from "../../core/validation-message.service";
 import { ControlLabelPosition } from "../form-control-base";
+import { PopoverContentPosition } from "../popover/popover.component";
 import * as i0 from "@angular/core";
 /** Function to iterate over form controls and
  *  ensure they contain unique values.  If any are duplicated all offending
@@ -61,6 +62,14 @@ export declare class FormGroupComponent implements OnInit {
     /**An optional flag to hide the validation messages.
      */
     hideValidationMessage?: boolean;
+    /**
+     * Conditionally show a help popover next to the controls label.
+     */
+    helpPopover?: string;
+    /**
+    * When a help popover is present, allows the popover to be positioned in different locations.
+    */
+    helpPopoverPosition?: PopoverContentPosition;
     /**
      * All current validation errors
      *
@@ -92,5 +101,5 @@ export declare class FormGroupComponent implements OnInit {
      */
     private translateValidationMessages;
     static ɵfac: i0.ɵɵFactoryDeclaration<FormGroupComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<FormGroupComponent, "ec-form-group", never, { "id": "id"; "label": "label"; "formGroup": "formGroup"; "labelPosition": "labelPosition"; "overrideValidationError": "overrideValidationError"; "hideValidationMessage": "hideValidationMessage"; }, {}, never, ["*"], false, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<FormGroupComponent, "ec-form-group", never, { "id": "id"; "label": "label"; "formGroup": "formGroup"; "labelPosition": "labelPosition"; "overrideValidationError": "overrideValidationError"; "hideValidationMessage": "hideValidationMessage"; "helpPopover": "helpPopover"; "helpPopoverPosition": "helpPopoverPosition"; }, {}, never, ["*"], false, never>;
 }

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' | 'divider-top';
+    display?: 'default' | 'heading' | 'divider' | 'divided-section';
     value?: TValue;
     classList?: string;
     disabled?: boolean;
@@ -29,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;
@@ -162,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.
@@ -216,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-ECAP-23124-menu-item-divider-improvements.20240516-1629",
+  "version": "0.39.16-ECAP-23124-menu-item-divider-improvements.20240523-1101",
   "dependencies": {
     "tslib": "^2.0.0"
   },