@softheon/armature 17.22.2 → 17.22.4

package/lib/base-components/sof-utility-button/sof-utility-button.component.d.ts

@@ -2,12 +2,12 @@ import * as i0 from "@angular/core";
 export declare class SofUtilityButtonComponent {
     buttonId: string;
     buttonAriaLabel: string;
-    buttonColorText: string;
-    buttonSize: string;
+    buttonTheme: 'primary' | 'neutral' | 'destroy';
+    buttonEmphasis: 'solid' | 'secondary' | 'floating' | 'contained';
     buttonDisabled: boolean;
     buttonIconClass: string;
     menuDropDown: ButtonData[];
-    /** Individual Button Click  */
+    /** Individual Button Click */
     buttonClick: Function;
     /**
      * Any logic related to ag grid cell renderer data can be added here
@@ -15,17 +15,7 @@ export declare class SofUtilityButtonComponent {
     */
     agInit(params: any & SofUtilityButtonComponent): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SofUtilityButtonComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SofUtilityButtonComponent, "sof-utility-button", never, { "buttonId": { "alias": "buttonId"; "required": false; }; "buttonAriaLabel": { "alias": "buttonAriaLabel"; "required": false; }; "buttonColorText": { "alias": "buttonColorText"; "required": false; }; "buttonSize": { "alias": "buttonSize"; "required": false; }; "buttonDisabled": { "alias": "buttonDisabled"; "required": false; }; "buttonIconClass": { "alias": "buttonIconClass"; "required": false; }; "menuDropDown": { "alias": "menuDropDown"; "required": false; }; "buttonClick": { "alias": "buttonClick"; "required": false; }; }, {}, never, never, false, never>;
-}
-export declare enum BUTTON_COLORS_VARIATIONS {
-    PRIMARY = "primary",
-    SECONDARY = "secondary",
-    TERTIARY = "tertiary",
-    ERROR_PRIMARY = "error-primary",
-    ERROR_SECONDARY = "error-secondary",
-    ERROR_TERTIARY = "error-tertiary",
-    CONTAINED = "contained",
-    CONTAINED_ERROR = "contained-error"
+    static ɵcmp: i0.ɵɵComponentDeclaration<SofUtilityButtonComponent, "sof-utility-button", never, { "buttonId": { "alias": "buttonId"; "required": false; }; "buttonAriaLabel": { "alias": "buttonAriaLabel"; "required": false; }; "buttonTheme": { "alias": "buttonTheme"; "required": false; }; "buttonEmphasis": { "alias": "buttonEmphasis"; "required": false; }; "buttonDisabled": { "alias": "buttonDisabled"; "required": false; }; "buttonIconClass": { "alias": "buttonIconClass"; "required": false; }; "menuDropDown": { "alias": "menuDropDown"; "required": false; }; "buttonClick": { "alias": "buttonClick"; "required": false; }; }, {}, never, never, false, never>;
 }
 export interface ButtonData {
     name: string;

package/lib/navigation/components/sof-navigation-panel/sof-nav-panel.component.d.ts

@@ -1,5 +1,6 @@
 import { AfterViewInit, ElementRef, EventEmitter, OnInit, Signal, WritableSignal } from '@angular/core';
 import { BreakpointState } from '@angular/cdk/layout';
+import { MatSidenavContent } from '@angular/material/sidenav';
 import { NavPanelNode } from './models/nav-panel-nodes';
 import { NavPanelSettings } from './models/nav-panel-settings';
 import * as i0 from "@angular/core";
@@ -36,10 +37,15 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
     */
     whatsNewData?: any;
     /**
-     * logout button text
+     * Logout button text
      * @note can be translation key
     */
     logoutText: string;
+    /**
+     * Should scroll to top on `NavigationEnd` event?
+     * @default true
+    */
+    private scrollToTopOnNavigationEndEvent;
     /**
      * Emit this event to show the whats new modal
      * @note this is a w.i.p. awaiting design for `whats new` modal
@@ -54,6 +60,11 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
     logoutEvent: EventEmitter<void>;
     /** Nav panels footer element reference */
     navPanelFooter: ElementRef<HTMLElement>;
+    /**
+     * Main content for scroll position
+     * @note this is the element which has the apps 'main' scrollbar.
+    */
+    sidenavContent: MatSidenavContent;
     /** Utility for checking the matching state of media queries.*/
     private breakpointObserver;
     /** Has the small screen breakpoint been hit */
@@ -67,10 +78,18 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
      * @default 40
     */
     footerSpacePadding: WritableSignal<number>;
+    /** Angular's router */
+    private router;
     /** On Init - Initialize the settings */
     ngOnInit(): void;
-    /** After View Init - Set the footer space */
+    /** After View Init - Set the footer space, scroll to top if needed */
     ngAfterViewInit(): void;
+    /**
+     * Scrolls to the top of page
+     * @note using `window.scrollTo` will not work if using this component as the main scrollbar does not live on the window level.
+     * Configuring `scrollPositionRestoration` in the router module will not work either.
+    */
+    scrollToTop(): void;
     /**
      * Initializes the nav panel settings, defaults will be set if `null` or `undefined`
      * @note The 'nullish coalescing assignment operator' `??=` assigns defaults for `boolean` and `number` types,
@@ -98,5 +117,5 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
     /** Emits event to show the whats new modal */
     showWhatsNew(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SofNavPanelComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SofNavPanelComponent, "sof-nav-panel", never, { "nodes": { "alias": "nodes"; "required": true; }; "settings": { "alias": "settings"; "required": false; }; "whatsNewData": { "alias": "whatsNewData"; "required": false; }; "logoutText": { "alias": "logoutText"; "required": false; }; }, { "showWhatsNewEvent": "showWhatsNewEvent"; "isNavPanelOpenedEvent": "isNavPanelOpenedEvent"; "logoutEvent": "logoutEvent"; }, never, ["[sof-nav-panel-main-content]"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SofNavPanelComponent, "sof-nav-panel", never, { "nodes": { "alias": "nodes"; "required": true; }; "settings": { "alias": "settings"; "required": false; }; "whatsNewData": { "alias": "whatsNewData"; "required": false; }; "logoutText": { "alias": "logoutText"; "required": false; }; "scrollToTopOnNavigationEndEvent": { "alias": "scrollToTopOnNavigationEndEvent"; "required": false; }; }, { "showWhatsNewEvent": "showWhatsNewEvent"; "isNavPanelOpenedEvent": "isNavPanelOpenedEvent"; "logoutEvent": "logoutEvent"; }, never, ["[sof-nav-panel-main-content]"], true, never>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@softheon/armature",
-  "version": "17.22.2",
+  "version": "17.22.4",
   "dependencies": {
     "tslib": "^2.5.0"
   },