@softheon/armature 15.21.2 → 17.1.0

package/lib/navigation/components/navigation/navigation.component.d.ts

@@ -1,200 +1,200 @@
-import { MediaMatcher } from '@angular/cdk/layout';
-import { AfterViewInit, ChangeDetectorRef, EventEmitter, OnDestroy, OnInit, QueryList } from '@angular/core';
-import { MatExpansionPanel } from '@angular/material/expansion';
-import { MatSidenav } from '@angular/material/sidenav';
-import { MatStepper } from '@angular/material/stepper';
-import { Router } from '@angular/router';
-import { Observable, Subscription } from 'rxjs';
-import { BaseConfig } from '../../../core/models/base-config';
-import { AuthorizationService } from '../../../core/services/authorization.service';
-import { BannerService } from '../../../core/services/banner.service';
-import { BaseConfigService } from '../../../core/services/base-config.service';
-import { HeaderLanguageSettings } from '../../../header/models/header-language.settings';
-import { NavigationThemeSettings } from '../../models/nav-theme.settings';
-import { NavigationAdvancedSettings, NavigationSettings } from '../../models/nav.settings';
-import { NavNode, SubNavNodes } from '../../models/navigation';
-import * as i0 from "@angular/core";
-/**
- * The Navigation Component
- */
-export declare class ArmatureNavigationComponent implements OnInit, AfterViewInit, OnDestroy {
-    readonly changeDetectorRef: ChangeDetectorRef;
-    readonly media: MediaMatcher;
-    private readonly router;
-    private bannerService;
-    private readonly authorizationService;
-    private readonly configService;
-    /** The parent stepper */
-    stepper: MatStepper;
-    /** The side mobile nav */
-    sidenav: MatSidenav;
-    /** The mobile expansion panel for progress menu */
-    expansionPanel: MatExpansionPanel;
-    /** The child steppers */
-    innerSteppers: QueryList<MatStepper>;
-    /** Component Input - the navigation data */
-    navigationData: NavNode[];
-    /** Component Input - the navigation settings */
-    settings: NavigationSettings;
-    /** Component Input - the navigation settings */
-    advancedSettings: NavigationAdvancedSettings;
-    /** Component Input - the navigation settings */
-    themeSettings: NavigationThemeSettings;
-    /** Component Input - the navigation language settings */
-    languageSettings: HeaderLanguageSettings;
-    /** Current language **/
-    currentLang: string;
-    /** logOut text **/
-    logOutText: string;
-    /** Sets language **/
-    setLanguage$: EventEmitter<any>;
-    /** gets the non used language */
-    get otherLangText(): string;
-    /** Whether side nav is open or not */
-    isNavOpen: boolean;
-    /** Mobile SubNav - whether or not the mobile SubNav is open */
-    isMobileSubNavOpen: boolean;
-    /** Mobile SubNav -the data to be passed to the mobile SubNav */
-    currentMobileNav: NavNode;
-    /** Settings - the main menu text that appears in the mobile SubNav */
-    mainMenuText: string;
-    /** the mobile query */
-    mobileQuery: MediaQueryList;
-    /** The selected parent index */
-    selectedParentIndex: number;
-    /** The selected child index */
-    selectedChildIndexes: {
-        [key: number]: number;
-    };
-    /** The navigation progress count */
-    navProgressCount: number;
-    /** The current active parent node */
-    activeParentNode: NavNode;
-    /** The current active sub node */
-    activeSubNode: SubNavNodes;
-    /** True if the expansion panel is open */
-    panelOpenState: boolean;
-    /** The footer navigation data */
-    footerNavigationData: NavNode[];
-    /** user name **/
-    userName: string;
-    /** The config observable */
-    config$: Observable<BaseConfig>;
-    /** The parent node index to be set when nav is toggled to progress menu style */
-    toggleProgressNavParentIndex: number;
-    /** The child node index to be set when nav is toggled to progress menu style */
-    toggleProgressNavChildIndex: number;
-    /** the mobile query listener2 */
-    private readonly _mobileQueryListener;
-    /** The nav bind subscription */
-    private navBindSub;
-    /** The message to display */
-    message: string;
-    /** Whether we should the message */
-    showMessage: boolean;
-    /** Whether should show check mark or not */
-    showCheckMark: boolean;
-    /** The nav bind subscription */
-    private logInSubscription;
-    /** The count of footer items*/
-    footerItemCount: number;
-    /** The banner subscription */
-    private bannerSubscription;
-    /** The config subscription */
-    configSubscription: Subscription;
-    /** The sidenav subscription */
-    private sideNavSub;
-    /**
-     * the constructor
-     * @param changeDetectorRef the change detector reference
-     * @param media the media matcher
-     * @param router The router
-     * @param bannerService The Banner Service
-     * @param activatedRoute The activated route
-     * @param configService The config service
-     */
-    constructor(changeDetectorRef: ChangeDetectorRef, media: MediaMatcher, router: Router, bannerService: BannerService, authorizationService: AuthorizationService, configService: BaseConfigService);
-    /** On Init - configure the settings */
-    ngOnInit(): void;
-    /** Life cycle hook for after component view initialization */
-    ngAfterViewInit(): void;
-    /** On Destroy */
-    ngOnDestroy(): void;
-    /**
-     * Mobile SubNav - open the SubNav
-     * @param nav the nav data to be passed to the SubNav
-     */
-    openMobileSubNav(nav: NavNode): void;
-    /**
-     * Mobile SubNav - closes the SubNav
-     */
-    closeMobileSubNav(): void;
-    /**
-     * Sets the theme color
-     * @param variable the css variable name
-     * @param color the color
-     */
-    setThemeColor(variable: string, color: string): void;
-    /**
-     * Determines the step state
-     * @param parentIndex The parent index
-     * @param childIndex The child index
-     * @returns The step state
-     */
-    determineStepState(parentIndex: number, childIndex: number): string;
-    /**
-     * Navigates to the provided route
-     * @param route The route
-     */
-    navigate(route: string): void;
-    /**
-     * Navigates to given step
-     * @param stepNumber The step number to navigate to
-     */
-    navigateToStep(stepNumber: number): void;
-    /**
-     * Gets the active parent and child nodes
-     * @param url The router url
-     */
-    getActiveParentAndChild(url: string): void;
-    /**
-     * Sets the complete and visited states for all NavNodes
-     * @param parentNode The parent node
-     * @param childNode The child node
-     */
-    setNodeStates(parentNode: NavNode, childNode: SubNavNodes): void;
-    /**
-     * Closes the expansion panel and navigates to the given node
-     * @param el The mat expansion panel
-     * @param index The parent node index
-     */
-    disablePanel(el: any, index: number): void;
-    /**
-    * Hides the message
-    */
-    hide(): void;
-    /**
-     * Logs out once user is authorized
-     * */
-    logOut(): void;
-    /**
-     * Closes mobile navigation after selection.
-     */
-    closeNavigationForMobile(): void;
-    /**
-     * Is the navigation selected
-     */
-    isNavSelected(node: NavNode | SubNavNodes): boolean;
-    /** Sets the width for the side nav */
-    setNavWidth(width: string): string;
-    /** Binds the stepper to the router */
-    private bindStepperToRoutes;
-    /** Initializes the advanced nav settings */
-    private initAdvancedSettings;
-    /** Initializes the nav theme settings */
-    private initThemeSettings;
-    /** Initializes the basic nav settings */
-    private initBasicSettings;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ArmatureNavigationComponent, [null, null, null, null, null, { optional: true; }]>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<ArmatureNavigationComponent, "sof-ar-navigation", never, { "navigationData": "navigationData"; "settings": "settings"; "advancedSettings": "advancedSettings"; "themeSettings": "themeSettings"; "languageSettings": "languageSettings"; "currentLang": "currentLang"; "logOutText": "logOutText"; }, { "setLanguage$": "setLanguage$"; }, never, ["[sof-ar-nav-header]", "*", "[sof-ar-nav-mobile-footer]"], false, never>;
-}
+import { MediaMatcher } from '@angular/cdk/layout';
+import { AfterViewInit, ChangeDetectorRef, EventEmitter, OnDestroy, OnInit, QueryList } from '@angular/core';
+import { MatExpansionPanel } from '@angular/material/expansion';
+import { MatSidenav } from '@angular/material/sidenav';
+import { MatStepper } from '@angular/material/stepper';
+import { Router } from '@angular/router';
+import { Observable, Subscription } from 'rxjs';
+import { BaseConfig } from '../../../core/models/base-config';
+import { AuthorizationService } from '../../../core/services/authorization.service';
+import { BannerService } from '../../../core/services/banner.service';
+import { BaseConfigService } from '../../../core/services/base-config.service';
+import { HeaderLanguageSettings } from '../../../header/models/header-language.settings';
+import { NavigationThemeSettings } from '../../models/nav-theme.settings';
+import { NavigationAdvancedSettings, NavigationSettings } from '../../models/nav.settings';
+import { NavNode, SubNavNodes } from '../../models/navigation';
+import * as i0 from "@angular/core";
+/**
+ * The Navigation Component
+ */
+export declare class ArmatureNavigationComponent implements OnInit, AfterViewInit, OnDestroy {
+    readonly changeDetectorRef: ChangeDetectorRef;
+    readonly media: MediaMatcher;
+    private readonly router;
+    private bannerService;
+    private readonly authorizationService;
+    private readonly configService;
+    /** The parent stepper */
+    stepper: MatStepper;
+    /** The side mobile nav */
+    sidenav: MatSidenav;
+    /** The mobile expansion panel for progress menu */
+    expansionPanel: MatExpansionPanel;
+    /** The child steppers */
+    innerSteppers: QueryList<MatStepper>;
+    /** Component Input - the navigation data */
+    navigationData: NavNode[];
+    /** Component Input - the navigation settings */
+    settings: NavigationSettings;
+    /** Component Input - the navigation settings */
+    advancedSettings: NavigationAdvancedSettings;
+    /** Component Input - the navigation settings */
+    themeSettings: NavigationThemeSettings;
+    /** Component Input - the navigation language settings */
+    languageSettings: HeaderLanguageSettings;
+    /** Current language **/
+    currentLang: string;
+    /** logOut text **/
+    logOutText: string;
+    /** Sets language **/
+    setLanguage$: EventEmitter<any>;
+    /** gets the non used language */
+    get otherLangText(): string;
+    /** Whether side nav is open or not */
+    isNavOpen: boolean;
+    /** Mobile SubNav - whether or not the mobile SubNav is open */
+    isMobileSubNavOpen: boolean;
+    /** Mobile SubNav -the data to be passed to the mobile SubNav */
+    currentMobileNav: NavNode;
+    /** Settings - the main menu text that appears in the mobile SubNav */
+    mainMenuText: string;
+    /** the mobile query */
+    mobileQuery: MediaQueryList;
+    /** The selected parent index */
+    selectedParentIndex: number;
+    /** The selected child index */
+    selectedChildIndexes: {
+        [key: number]: number;
+    };
+    /** The navigation progress count */
+    navProgressCount: number;
+    /** The current active parent node */
+    activeParentNode: NavNode;
+    /** The current active sub node */
+    activeSubNode: SubNavNodes;
+    /** True if the expansion panel is open */
+    panelOpenState: boolean;
+    /** The footer navigation data */
+    footerNavigationData: NavNode[];
+    /** user name **/
+    userName: string;
+    /** The config observable */
+    config$: Observable<BaseConfig>;
+    /** The parent node index to be set when nav is toggled to progress menu style */
+    toggleProgressNavParentIndex: number;
+    /** The child node index to be set when nav is toggled to progress menu style */
+    toggleProgressNavChildIndex: number;
+    /** the mobile query listener2 */
+    private readonly _mobileQueryListener;
+    /** The nav bind subscription */
+    private navBindSub;
+    /** The message to display */
+    message: string;
+    /** Whether we should the message */
+    showMessage: boolean;
+    /** Whether should show check mark or not */
+    showCheckMark: boolean;
+    /** The nav bind subscription */
+    private logInSubscription;
+    /** The count of footer items*/
+    footerItemCount: number;
+    /** The banner subscription */
+    private bannerSubscription;
+    /** The config subscription */
+    configSubscription: Subscription;
+    /** The sidenav subscription */
+    private sideNavSub;
+    /**
+     * the constructor
+     * @param changeDetectorRef the change detector reference
+     * @param media the media matcher
+     * @param router The router
+     * @param bannerService The Banner Service
+     * @param activatedRoute The activated route
+     * @param configService The config service
+     */
+    constructor(changeDetectorRef: ChangeDetectorRef, media: MediaMatcher, router: Router, bannerService: BannerService, authorizationService: AuthorizationService, configService: BaseConfigService);
+    /** On Init - configure the settings */
+    ngOnInit(): void;
+    /** Life cycle hook for after component view initialization */
+    ngAfterViewInit(): void;
+    /** On Destroy */
+    ngOnDestroy(): void;
+    /**
+     * Mobile SubNav - open the SubNav
+     * @param nav the nav data to be passed to the SubNav
+     */
+    openMobileSubNav(nav: NavNode): void;
+    /**
+     * Mobile SubNav - closes the SubNav
+     */
+    closeMobileSubNav(): void;
+    /**
+     * Sets the theme color
+     * @param variable the css variable name
+     * @param color the color
+     */
+    setThemeColor(variable: string, color: string): void;
+    /**
+     * Determines the step state
+     * @param parentIndex The parent index
+     * @param childIndex The child index
+     * @returns The step state
+     */
+    determineStepState(parentIndex: number, childIndex: number): string;
+    /**
+     * Navigates to the provided route
+     * @param route The route
+     */
+    navigate(route: string): void;
+    /**
+     * Navigates to given step
+     * @param stepNumber The step number to navigate to
+     */
+    navigateToStep(stepNumber: number): void;
+    /**
+     * Gets the active parent and child nodes
+     * @param url The router url
+     */
+    getActiveParentAndChild(url: string): void;
+    /**
+     * Sets the complete and visited states for all NavNodes
+     * @param parentNode The parent node
+     * @param childNode The child node
+     */
+    setNodeStates(parentNode: NavNode, childNode: SubNavNodes): void;
+    /**
+     * Closes the expansion panel and navigates to the given node
+     * @param el The mat expansion panel
+     * @param index The parent node index
+     */
+    disablePanel(el: any, index: number): void;
+    /**
+    * Hides the message
+    */
+    hide(): void;
+    /**
+     * Logs out once user is authorized
+     * */
+    logOut(): void;
+    /**
+     * Closes mobile navigation after selection.
+     */
+    closeNavigationForMobile(): void;
+    /**
+     * Is the navigation selected
+     */
+    isNavSelected(node: NavNode | SubNavNodes): boolean;
+    /** Sets the width for the side nav */
+    setNavWidth(width: string): string;
+    /** Binds the stepper to the router */
+    private bindStepperToRoutes;
+    /** Initializes the advanced nav settings */
+    private initAdvancedSettings;
+    /** Initializes the nav theme settings */
+    private initThemeSettings;
+    /** Initializes the basic nav settings */
+    private initBasicSettings;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ArmatureNavigationComponent, [null, null, null, null, null, { optional: true; }]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<ArmatureNavigationComponent, "sof-ar-navigation", never, { "navigationData": { "alias": "navigationData"; "required": false; }; "settings": { "alias": "settings"; "required": false; }; "advancedSettings": { "alias": "advancedSettings"; "required": false; }; "themeSettings": { "alias": "themeSettings"; "required": false; }; "languageSettings": { "alias": "languageSettings"; "required": false; }; "currentLang": { "alias": "currentLang"; "required": false; }; "logOutText": { "alias": "logOutText"; "required": false; }; }, { "setLanguage$": "setLanguage$"; }, never, ["[sof-ar-nav-header]", "*", "[sof-ar-nav-mobile-footer]"], false, never>;
+}

package/lib/navigation/models/nav-theme.settings.d.ts

@@ -1,25 +1,25 @@
-/** The Theme Settings */
-export interface NavigationThemeSettings {
-    /** the content background color */
-    contentBgColor?: string;
-    /** the navigation overall font color */
-    fontColor?: string;
-    /** the background gradient color 2 */
-    bgGradientColor1?: string;
-    /** the background gradient color 2 */
-    bgGradientColor2?: string;
-    /** the overall border right color */
-    borderRightColor?: string;
-    /** the list border color */
-    listBorderColor?: string;
-    /** the nav highlight gradient color 1 */
-    highlightGradient1?: string;
-    /** the nav highlight gradient color 2 */
-    highlightGradient2?: string;
-    /** the SubNav highlight border color */
-    subHighlightBorderColor?: string;
-    /** the SubNav highlight bg color */
-    subHighlightBgColor?: string;
-    /** The mobile background color */
-    mobileBgColor?: string;
-}
+/** The Theme Settings */
+export interface NavigationThemeSettings {
+    /** the content background color */
+    contentBgColor?: string;
+    /** the navigation overall font color */
+    fontColor?: string;
+    /** the background gradient color 2 */
+    bgGradientColor1?: string;
+    /** the background gradient color 2 */
+    bgGradientColor2?: string;
+    /** the overall border right color */
+    borderRightColor?: string;
+    /** the list border color */
+    listBorderColor?: string;
+    /** the nav highlight gradient color 1 */
+    highlightGradient1?: string;
+    /** the nav highlight gradient color 2 */
+    highlightGradient2?: string;
+    /** the SubNav highlight border color */
+    subHighlightBorderColor?: string;
+    /** the SubNav highlight bg color */
+    subHighlightBgColor?: string;
+    /** The mobile background color */
+    mobileBgColor?: string;
+}

package/lib/navigation/models/nav.settings.d.ts

@@ -1,64 +1,64 @@
-/** the Navigation Settings */
-export interface NavigationSettings {
-    /** the Header Menu FontAwesome icon when the navigation bar is open */
-    fontAwesomeMenuIcon?: string;
-    /** the Header Menu FontAwesome icon when the navigation bar is closed */
-    fontAwesomeMenuIconClosed?: string;
-    /** the main menu text that appears in the mobile SubNav */
-    mainMenuText?: string;
-    /** the header height */
-    headerHeight?: number;
-    /** menu button screen reader text */
-    menuButtonSRText?: string;
-    /** The menu style */
-    menuStyle?: 'static' | 'stepper' | 'progress';
-    /** True if navigation is hidden */
-    hideNavigation?: boolean;
-    /** True if the navigation should show numbers for the sections */
-    displayNumbers?: boolean;
-    /** The icon for progress menu completed section */
-    progressSectionCompleteIcon?: string;
-    /** The icon for progress menu future section */
-    progressSectionFutureIcon?: string;
-    /** The icon for progress menu current section */
-    progressSectionCurrentIcon?: string;
-    /** The icon for progress menu complete item */
-    progressMenuCompleteIcon?: string;
-    /** True if the progress bar should be displayed */
-    showProgressBar?: boolean;
-    /** The width of the side navigation for mobile */
-    sideNavWidthMobile?: string;
-    /** The width of side navigation for desktop */
-    sideNavWidthDesktop?: string;
-    /** The width of the progress drop down menu */
-    progressMenuWidth?: string;
-    /** Config to override the navigation and enable all routes. To be used for testing only */
-    overrideNavigation?: boolean;
-    /** The max content width for desktop */
-    maxContentWidthDesktop?: number;
-    /** The max content width for mobile */
-    maxContentWidthMobile?: number;
-    /** True if the mobile navigation uses custom footer. This will hide the language and signout buttons  */
-    useCustomMobileFooter?: boolean;
-    /** The custom user name to be displayed for mobile side nav */
-    customUserName?: string;
-    /** The custom parent node index to be set when nav is toggled to progress menu style */
-    toggleProgressNavParentIndex?: number;
-    /** The custom child node index to be set when nav is toggled to progress menu style */
-    toggleProgressNavChildIndex?: number;
-    /** True when resetting the navigation */
-    resetNav?: boolean;
-    /** Whether to allow navigation toggle on non-mobile */
-    allowNavToggle?: boolean;
-}
-/** The Advanced Settings */
-export interface NavigationAdvancedSettings {
-    /** the top gap on desktop screens for the MD component */
-    topGapDesktop?: number;
-    /** the top gap on mobile screens for the MD component */
-    topGapMobile?: number;
-    /** the margin on desktop screens for the MD component */
-    marginTopDesktop?: number;
-    /** the margin on mobile screens for the MD component */
-    marginTopMobile?: number;
-}
+/** the Navigation Settings */
+export interface NavigationSettings {
+    /** the Header Menu FontAwesome icon when the navigation bar is open */
+    fontAwesomeMenuIcon?: string;
+    /** the Header Menu FontAwesome icon when the navigation bar is closed */
+    fontAwesomeMenuIconClosed?: string;
+    /** the main menu text that appears in the mobile SubNav */
+    mainMenuText?: string;
+    /** the header height */
+    headerHeight?: number;
+    /** menu button screen reader text */
+    menuButtonSRText?: string;
+    /** The menu style */
+    menuStyle?: 'static' | 'stepper' | 'progress';
+    /** True if navigation is hidden */
+    hideNavigation?: boolean;
+    /** True if the navigation should show numbers for the sections */
+    displayNumbers?: boolean;
+    /** The icon for progress menu completed section */
+    progressSectionCompleteIcon?: string;
+    /** The icon for progress menu future section */
+    progressSectionFutureIcon?: string;
+    /** The icon for progress menu current section */
+    progressSectionCurrentIcon?: string;
+    /** The icon for progress menu complete item */
+    progressMenuCompleteIcon?: string;
+    /** True if the progress bar should be displayed */
+    showProgressBar?: boolean;
+    /** The width of the side navigation for mobile */
+    sideNavWidthMobile?: string;
+    /** The width of side navigation for desktop */
+    sideNavWidthDesktop?: string;
+    /** The width of the progress drop down menu */
+    progressMenuWidth?: string;
+    /** Config to override the navigation and enable all routes. To be used for testing only */
+    overrideNavigation?: boolean;
+    /** The max content width for desktop */
+    maxContentWidthDesktop?: number;
+    /** The max content width for mobile */
+    maxContentWidthMobile?: number;
+    /** True if the mobile navigation uses custom footer. This will hide the language and signout buttons  */
+    useCustomMobileFooter?: boolean;
+    /** The custom user name to be displayed for mobile side nav */
+    customUserName?: string;
+    /** The custom parent node index to be set when nav is toggled to progress menu style */
+    toggleProgressNavParentIndex?: number;
+    /** The custom child node index to be set when nav is toggled to progress menu style */
+    toggleProgressNavChildIndex?: number;
+    /** True when resetting the navigation */
+    resetNav?: boolean;
+    /** Whether to allow navigation toggle on non-mobile */
+    allowNavToggle?: boolean;
+}
+/** The Advanced Settings */
+export interface NavigationAdvancedSettings {
+    /** the top gap on desktop screens for the MD component */
+    topGapDesktop?: number;
+    /** the top gap on mobile screens for the MD component */
+    topGapMobile?: number;
+    /** the margin on desktop screens for the MD component */
+    marginTopDesktop?: number;
+    /** the margin on mobile screens for the MD component */
+    marginTopMobile?: number;
+}