@softheon/armature 17.23.0 → 17.23.1

package/lib/base-components/sof-callout/sof-callout.component.d.ts

@@ -10,6 +10,8 @@ import * as i0 from "@angular/core";
  * and must be included in the `imports` array of your module.
 */
 export declare class SofCalloutComponent {
+    /** The callout id */
+    id: string;
     /** The callout type */
     type: 'info' | 'warning' | 'error' | 'success' | 'neutral';
     /**
@@ -52,5 +54,5 @@ export declare class SofCalloutComponent {
     /** Close the callout */
     dismissCallout(): void;
     static ɵfac: i0.ɵɵFactoryDeclaration<SofCalloutComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<SofCalloutComponent, "sof-callout", never, { "type": { "alias": "type"; "required": true; }; "text": { "alias": "text"; "required": true; }; "extendedText": { "alias": "extendedText"; "required": false; }; "textSize": { "alias": "textSize"; "required": false; }; "canDismiss": { "alias": "canDismiss"; "required": false; }; }, { "dismissEvent": "dismissEvent"; }, never, ["[callout-custom-content]"], true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SofCalloutComponent, "sof-callout", never, { "id": { "alias": "id"; "required": false; }; "type": { "alias": "type"; "required": true; }; "text": { "alias": "text"; "required": true; }; "extendedText": { "alias": "extendedText"; "required": false; }; "textSize": { "alias": "textSize"; "required": false; }; "canDismiss": { "alias": "canDismiss"; "required": false; }; }, { "dismissEvent": "dismissEvent"; }, never, ["[callout-custom-content]"], true, never>;
 }

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

@@ -0,0 +1,12 @@
+/**
+ * Navigation panel logo
+ */
+export interface NavPanelLogo {
+    /** The url address */
+    url: string;
+    /**
+     * The alt text for screen reader
+     * @note Should be the brand name + 'logo'
+    */
+    altText: string;
+}

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

@@ -8,19 +8,4 @@ export interface NavPanelSettings {
      * @default true
     */
     allowNavToggle?: boolean;
-    /**
-     * To show the login/logout button
-     * @default false
-    */
-    showAuthButton?: boolean;
-    /**
-     * To show the language settings button
-     * @default false
-    */
-    showLanguageButton?: boolean;
-    /**
-     * To show the whats new button
-     * @default false
-    */
-    showWhatsNewButton?: boolean;
 }

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

@@ -1,8 +1,9 @@
-import { AfterViewInit, ElementRef, EventEmitter, OnInit, Signal, WritableSignal } from '@angular/core';
+import { EventEmitter, OnInit, Signal } 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 { NavPanelLogo } from './models/nav-panel-logo';
 import * as i0 from "@angular/core";
 /**
  * The Navigation Panel Component
@@ -10,15 +11,9 @@ import * as i0 from "@angular/core";
  * @note Designed to be used with the 'SofHeaderPortalComponent' component as its child.
  * @see [Figma/portal-ui-shell]({@link https://www.figma.com/design/W5HVNCcN9HafDRvc5N7Z28/%5BWIP%5D-Softheon-Unified-Design-System-v1.0?node-id=14089-118395&t=G5IKDvYHpwU0vOFq-0})
  *
- * @todo `language settings` - awaiting design ( its own component, modal )
- * @see [Figma/language-switcher]({@link https://www.figma.com/design/W5HVNCcN9HafDRvc5N7Z28/%5BWIP%5D-Softheon-Unified-Design-System-v1.0?node-id=14089-118249&t=qMyPFk9iMfbU6iRS-0})
- * @todo `mobile styling` - awaiting design
- * @todo `whats new` - awaiting design ( its own component, modal )
- * @note _this component should need 2 data points when the 'what's new' flow is implemented_ -
- * - does the user have unread release notes? - if so style the button appropriately
- * - what is the current version? - to display on badge
+ * @todo `mobile styling` - awaiting design, minor adjustments have been made - 1/2/25 ...
 */
-export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
+export declare class SofNavPanelComponent implements OnInit {
     /**
      * Component Input (required) - Navigation node data
      * @see {@link NavPanelNode}
@@ -31,35 +26,18 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
      * @see {@link initSettings()}
     */
     settings?: NavPanelSettings;
-    /**
-     * Whats new data
-     * @note this is a w.i.p. awaiting design for `whats new` modal
-    */
-    whatsNewData?: any;
-    /**
-     * 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
-     */
-    showWhatsNewEvent: EventEmitter<void>;
+    /** The brand logo config */
+    brandLogo?: NavPanelLogo;
     /**
      * Is the nav panel open
      * @note this is needed to pass panel opened state to the SofHeaderPortalComponent
     */
     isNavPanelOpenedEvent: EventEmitter<boolean>;
-    /** Logout event, the application consuming this component is responsible for the actual logout */
-    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.
@@ -69,27 +47,10 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
     private breakpointObserver;
     /** Has the small screen breakpoint been hit */
     isSmallScreen: Signal<BreakpointState>;
-    /** Inject the translate service */
-    private translateService;
-    /** Current language to display */
-    currentLangLabel: string;
-    /**
-     * How much padding-bottom.px to add, depending on footer content/height
-     * @default 40
-    */
-    footerSpacePadding: WritableSignal<number>;
     /** Angular's router */
     private router;
     /** On Init - Initialize the settings */
     ngOnInit(): void;
-    /** 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,
@@ -100,22 +61,11 @@ export declare class SofNavPanelComponent implements OnInit, AfterViewInit {
     */
     private initSettings;
     /**
-     * Calculate the padding based on the footer height depending on how many buttons are present
-     * @note If no buttons, the footer is removed and the default padding is returned
-     * @returns `padding: number` the number of pixels to add to the `<nav>` elements `[style.paddingBottom.px]`
-     * @default 40
-    */
-    private calcFooterSpacePadding;
-    /** Emits the logout event */
-    logout(): void;
-    /**
-     * Applies the language to the translate service
-     * Sets local storage for preferred language
-     * @todo right now portals are only using 'en' & 'es', will need to update if more langs are added.
+     * 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.
     */
-    toggleLanguage(): void;
-    /** Emits event to show the whats new modal */
-    showWhatsNew(): void;
+    scrollToTop(): 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; }; "scrollToTopOnNavigationEndEvent": { "alias": "scrollToTopOnNavigationEndEvent"; "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; }; "scrollToTopOnNavigationEndEvent": { "alias": "scrollToTopOnNavigationEndEvent"; "required": false; }; "brandLogo": { "alias": "brandLogo"; "required": false; }; }, { "isNavPanelOpenedEvent": "isNavPanelOpenedEvent"; }, never, ["[sof-nav-panel-main-content]"], true, never>;
 }

package/lib/navigation/navigation-api.d.ts

@@ -6,6 +6,7 @@ export * from './models/nav-theme.settings';
 export * from './models/breadcrumb';
 export * from './components/sof-navigation-panel/models/nav-panel-nodes';
 export * from './components/sof-navigation-panel/models/nav-panel-settings';
+export * from './components/sof-navigation-panel/models/nav-panel-logo';
 export * from './components/navigation/navigation.component';
 export * from './components/sof-breadcrumbs/sof-breadcrumbs-hierarchy/sof-breadcrumbs-hierarchy.component';
 export * from './components/sof-breadcrumbs/sof-breadcrumbs-history/sof-breadcrumbs-history.component';

package/package.json

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