npm - @genesislcap/foundation-header - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-header 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (66) hide show

package/docs/api/foundation-header.navigation.md DELETED Viewed

@@ -1,793 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-header](./foundation-header.md) &gt; [Navigation](./foundation-header.navigation.md)
-## Navigation class
-Navigation micro-frontend includes navigation bar and flyout menu
-**Signature:**
-```typescript
-export declare class Navigation extends Navigation_base
-```
-**Extends:** Navigation\_base
-## Remarks
-`foundation-header` micro-frontend can be added to the project to include a navigation bar and flyout menu. There are multiple ways that the behaviour of the component can be configured - the icon shown on the navigation bar and flyout menu (this shows the Genesis logo by default). - navigation links at the left-hand side of the navigation bar. - the control buttons on the right-hand side of the navigation bar can be shown or hidden, and their behaviour controlled via event listeners - The contents of the flyout menu.
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[authRouting](./foundation-header.navigation.authrouting.md)
-</td><td>
-</td><td>
-AuthRouting
-</td><td>
-</td></tr>
-<tr><td>
-[container](./foundation-header.navigation.container.md)
-</td><td>
-</td><td>
-Container
-</td><td>
-</td></tr>
-<tr><td>
-[controlPanel](./foundation-header.navigation.controlpanel.md)
-</td><td>
-</td><td>
-ControlPanel
-</td><td>
-</td></tr>
-<tr><td>
-[enableInactivityMonitoring](./foundation-header.navigation.enableinactivitymonitoring.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to enable inactivity monitoring Control via `enable-inactivity-monitoring`
-</td></tr>
-<tr><td>
-[headerConfig](./foundation-header.navigation.headerconfig.md)
-</td><td>
-</td><td>
-[HeaderConfig](./foundation-header.headerconfig.md)
-</td><td>
-</td></tr>
-<tr><td>
-[hideSideBar](./foundation-header.navigation.hidesidebar.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to include the sideNav component Control via`hide-side-bar`
-</td></tr>
-<tr><td>
-[i18next](./foundation-header.navigation.i18next.md)
-</td><td>
-</td><td>
-I18next
-</td><td>
-</td></tr>
-<tr><td>
-[inactivityTimeoutMinutes](./foundation-header.navigation.inactivitytimeoutminutes.md)
-</td><td>
-</td><td>
-number
-</td><td>
-Number attribute which sets the inactivity timeout in minutes Control via `inactivity-timeout-minutes`
-</td></tr>
-<tr><td>
-[inactivityWarningMinutes](./foundation-header.navigation.inactivitywarningminutes.md)
-</td><td>
-</td><td>
-number
-</td><td>
-Number attribute which sets the inactivity warning time in minutes before timeout Control via `inactivity-warning-minutes`
-</td></tr>
-<tr><td>
-[languageOptions](./foundation-header.navigation.languageoptions.md)
-</td><td>
-</td><td>
-[LanguageOptions](./foundation-header.languageoptions.md)
-</td><td>
-Object which defines the language options to be displayed in the language selector
-</td></tr>
-<tr><td>
-[layoutItemCheck?](./foundation-header.navigation.layoutitemcheck.md)
-</td><td>
-</td><td>
-(registration: string) =&gt; boolean
-</td><td>
-**_(BETA)_** _(Optional)_ Callback function to check if a layout item is currently active in the layout. Used with nav items that have `isLayoutItem: true` and `layoutRegistration` set.
-</td></tr>
-<tr><td>
-[loginRouting](./foundation-header.navigation.loginrouting.md)
-</td><td>
-</td><td>
-LoginRouting
-</td><td>
-</td></tr>
-<tr><td>
-[logoAltText](./foundation-header.navigation.logoalttext.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Optional attribute which controls the alt text of the logo Control via `logo-alt-text`
-</td></tr>
-<tr><td>
-[logoSrc](./foundation-header.navigation.logosrc.md)
-</td><td>
-</td><td>
-any
-</td><td>
-Optional attribute which controls the icon to show on the navigation bar and flyout Control via `logo-src`
-</td></tr>
-<tr><td>
-[logoutButtonPosition](./foundation-header.navigation.logoutbuttonposition.md)
-</td><td>
-</td><td>
-'side-nav' \| 'account-menu' \| 'none'
-</td><td>
-String attribute which controls the position of the logout button in the header Control via `logout-button-position`
-</td></tr>
-<tr><td>
-[luminanceToggle](./foundation-header.navigation.luminancetoggle.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-</td></tr>
-<tr><td>
-[pathName](./foundation-header.navigation.pathname.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-Current pathname for route highlighting
-</td></tr>
-<tr><td>
-[routeButtons](./foundation-header.navigation.routebuttons.md)
-</td><td>
-</td><td>
-Array&lt;{ index: number; path: string; title: string; icon: string; variant: string; }&gt;
-</td><td>
-If present the defined route buttons will be rendered in the header 'routes' slot
-</td></tr>
-<tr><td>
-[routeNavItems](./foundation-header.navigation.routenavitems.md)
-</td><td>
-</td><td>
-FoundationRouteNavItem\[\]
-</td><td>
-If present the defined  will be rendered in the header 'routes' slot
-</td></tr>
-<tr><td>
-[shouldShowAccountMenu](./foundation-header.navigation.shouldshowaccountmenu.md)
-</td><td>
-`readonly`
-</td><td>
-boolean
-</td><td>
-Computed property that determines if the account menu should be shown
-</td></tr>
-<tr><td>
-[showAccountMenu](./foundation-header.navigation.showaccountmenu.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the account menu on the navigation bar Control via `show-account-menu`
-</td></tr>
-<tr><td>
-[showAiIndicator](./foundation-header.navigation.showaiindicator.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the AI indicator on the navigation bar Control via `show-ai-indicator`
-</td></tr>
-<tr><td>
-[showConnectionIndicator](./foundation-header.navigation.showconnectionindicator.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the connection indicator on the navigation bar Control via `show-connection-indicator`
-</td></tr>
-<tr><td>
-[showControlPanel](./foundation-header.navigation.showcontrolpanel.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the control panel toggle on the navigation bar Control via `show-control-panel`
-</td></tr>
-<tr><td>
-[showEnvironmentIndicator](./foundation-header.navigation.showenvironmentindicator.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the environment indicator on the navigation bar Control via `show-environment-indicator`
-</td></tr>
-<tr><td>
-[showLanguageSelector](./foundation-header.navigation.showlanguageselector.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the language selector on the navigation bar Control via `show-language-selector`
-</td></tr>
-<tr><td>
-[showLuminanceToggleButton](./foundation-header.navigation.showluminancetogglebutton.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the luminance (moon) icon on the navigation bar Control via`show-luminance-toggle-button`
-</td></tr>
-<tr><td>
-[showMiscToggleButton](./foundation-header.navigation.showmisctogglebutton.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the miscellaneous (menu) icon on the navigation bar Control via `show-luminance-toggle-button`
-</td></tr>
-<tr><td>
-[showNotificationsButton](./foundation-header.navigation.shownotificationsbutton.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-Boolean attribute which controls whether to show the notification (bell) icon on the navigation bar Control via `show-notification-button`
-</td></tr>
-<tr><td>
-[user](./foundation-header.navigation.user.md)
-</td><td>
-</td><td>
-User
-</td><td>
-</td></tr>
-<tr><td>
-[userName](./foundation-header.navigation.username.md)
-</td><td>
-</td><td>
-string
-</td><td>
-Username of the logged in user Control via `user-name` attribute
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[changeLanguage(e)](./foundation-header.navigation.changelanguage.md)
-</td><td>
-</td><td>
-Changes the language of the application
-</td></tr>
-<tr><td>
-[connectedCallback()](./foundation-header.navigation.connectedcallback.md)
-</td><td>
-</td><td>
-Called when the component is connected to the DOM
-</td></tr>
-<tr><td>
-[disconnectedCallback()](./foundation-header.navigation.disconnectedcallback.md)
-</td><td>
-</td><td>
-Called when the component is disconnected from the DOM
-</td></tr>
-<tr><td>
-[handleNavButtonClick(routeNavItem)](./foundation-header.navigation.handlenavbuttonclick.md)
-</td><td>
-</td><td>
-Handles the click event for a navigation button
-</td></tr>
-<tr><td>
-[hasActiveChild(navItem)](./foundation-header.navigation.hasactivechild.md)
-</td><td>
-</td><td>
-Check if any child nav item matches the current route
-</td></tr>
-<tr><td>
-[isLayoutItemActive(item)](./foundation-header.navigation.islayoutitemactive.md)
-</td><td>
-</td><td>
-Check if a layout item is currently active in the layout
-</td></tr>
-<tr><td>
-[logout()](./foundation-header.navigation.logout.md)
-</td><td>
-</td><td>
-Logs the user out of their session
-</td></tr>
-<tr><td>
-[navigateTo(path)](./foundation-header.navigation.navigateto.md)
-</td><td>
-</td><td>
-Changes the route of the current page
-</td></tr>
-<tr><td>
-[selectTemplate()](./foundation-header.navigation.selecttemplate.md)
-</td><td>
-</td><td>
-Selects the appropriate template based on the component's state
-</td></tr>
-<tr><td>
-[setLuminance()](./foundation-header.navigation.setluminance.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[toLocalisedText(text)](./foundation-header.navigation.tolocalisedtext.md)
-</td><td>
-</td><td>
-To localised text
-</td></tr>
-</tbody></table>