@genesislcap/foundation-header 14.408.0 → 14.409.0

package/docs/api-report.md.api.md

@@ -1,260 +0,0 @@
-## API Report File for "@genesislcap/foundation-header"
-
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-
-```ts
-
-import { AuthRouting } from '@genesislcap/foundation-auth/routing';
-import { Container } from '@genesislcap/web-core';
-import { Controller } from '@microsoft/fast-element';
-import { ElementStyles } from '@microsoft/fast-element';
-import { EmitOptions } from '@genesislcap/foundation-events';
-import { EmitReturn } from '@genesislcap/foundation-events';
-import { FoundationRouteNavItem } from '@genesislcap/foundation-ui';
-import { GenesisElement } from '@genesislcap/web-core';
-import { I18next } from '@genesislcap/foundation-i18n';
-import { InterfaceSymbol } from '@microsoft/fast-foundation';
-import { LoginRouting } from '@genesislcap/foundation-login';
-import { Modal } from '@genesislcap/foundation-ui';
-import { PartialGenesisElementDefinition } from '@genesislcap/web-core';
-import { SyntheticViewTemplate } from '@genesislcap/web-core';
-import { TemplateElementDependency } from '@genesislcap/foundation-ui';
-import { User } from '@genesislcap/foundation-user';
-import { ViewTemplate } from '@genesislcap/web-core';
-
-// @public
-export function configure(config: Partial<HeaderConfig>): Promise<Navigation>;
-
-// Warning: (ae-internal-missing-underscore) The name "ControlPanel" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export class ControlPanel extends GenesisElement {
-    // (undocumented)
-    connectedCallback(): void;
-    // (undocumented)
-    controlPanelModal: Modal;
-    // (undocumented)
-    deleteSelectedFilterModels(): void;
-    // (undocumented)
-    deleteSelectedGridStates(): void;
-    // (undocumented)
-    deleteSelectedKVStorageItems(): Promise<void>;
-    // (undocumented)
-    deleteSelectedLayouts(): void;
-    // (undocumented)
-    disconnectedCallback(): void;
-    // (undocumented)
-    filterModelKeys: SelectableKey[];
-    // Warning: (ae-forgotten-export) The symbol "SelectableKey" needs to be exported by the entry point index.d.ts
-    //
-    // (undocumented)
-    foundationLayoutKeys: SelectableKey[];
-    // (undocumented)
-    gridStateKeys: SelectableKey[];
-    get hasSelectedFilterModels(): boolean;
-    get hasSelectedGridStates(): boolean;
-    get hasSelectedKVStorageItems(): boolean;
-    get hasSelectedLayouts(): boolean;
-    // (undocumented)
-    kvStorageKeys: SelectableKey[];
-    // (undocumented)
-    showDialog(): Promise<void>;
-    // (undocumented)
-    toggleFilterModelSelection(key: string): void;
-    // (undocumented)
-    toggleGridSelection(key: string): void;
-    // (undocumented)
-    toggleKVStorageSelection(key: string): void;
-    // (undocumented)
-    toggleLayoutSelection(key: string): void;
-}
-
-// @public
-export const defaultHeaderConfig: HeaderConfig;
-
-// Warning: (ae-internal-missing-underscore) The name "dynamicTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const dynamicTemplate: ViewTemplate<Navigation>;
-
-// @public
-export type ElementTargetId = HeaderTargetId | NavTargetId | SideNavTargetId;
-
-// @public
-export class FoundationHeader extends Navigation {
-    // (undocumented)
-    loadRemotes(): Promise<void>;
-}
-
-// Warning: (ae-internal-missing-underscore) The name "getTemplateByPrefix" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const getTemplateByPrefix: (prefix: any) => ViewTemplate<any, any>;
-
-// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "HeaderConfig" because one of its declarations is marked as @internal
-//
-// @public
-export interface HeaderConfig extends PartialGenesisElementDefinition {
-    // Warning: (ae-forgotten-export) The symbol "TemplateOptions" needs to be exported by the entry point index.d.ts
-    templateOptions: TemplateOptions;
-}
-
-// @internal
-export const HeaderConfig: InterfaceSymbol<HeaderConfig>;
-
-// @public
-export type HeaderTargetId = 'header-start' | 'header' | 'header-end';
-
-// @public
-export type LanguageOptions = {
-    availableLanguages: string[];
-    selectedLanguage: string;
-};
-
-// Warning: (ae-internal-missing-underscore) The name "LoadingTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const LoadingTemplate: ViewTemplate<Navigation>;
-
-// @public
-export const MainStyles: ElementStyles;
-
-// Warning: (ae-internal-missing-underscore) The name "mainTemplate" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal
-export const mainTemplate: ViewTemplate<Navigation, any>;
-
-// @public
-export type NavEventDetailMap = {
-    'luminance-icon-clicked': void;
-    'logout-clicked': void;
-    'misc-icon-clicked': void;
-    'notification-icon-clicked': void;
-    'language-changed': void;
-    'nav-button-clicked': {
-        item: FoundationRouteNavItem;
-        context: any;
-    };
-};
-
-// Warning: (ae-forgotten-export) The symbol "Navigation_base" needs to be exported by the entry point index.d.ts
-//
-// @public
-export class Navigation extends Navigation_base {
-    // (undocumented)
-    authRouting: AuthRouting;
-    changeLanguage(e: CustomEvent): void;
-    // @internal
-    closeNav(): void;
-    connectedCallback(): Promise<void>;
-    // (undocumented)
-    container: Container;
-    // Warning: (ae-incompatible-release-tags) The symbol "controlPanel" is marked as @public, but its signature references "ControlPanel" which is marked as @internal
-    //
-    // (undocumented)
-    controlPanel: ControlPanel;
-    disconnectedCallback(): void;
-    enableInactivityMonitoring: boolean;
-    handleNavButtonClick(routeNavItem: FoundationRouteNavItem): void;
-    hasActiveChild(navItem: FoundationRouteNavItem): boolean;
-    // (undocumented)
-    headerConfig: HeaderConfig;
-    hideSideBar: boolean;
-    // (undocumented)
-    i18next: I18next;
-    inactivityTimeoutMinutes: number;
-    inactivityWarningMinutes: number;
-    isLayoutItemActive(item: FoundationRouteNavItem): boolean;
-    // @internal (undocumented)
-    isUserPermitted(permission: string): boolean;
-    languageOptions: LanguageOptions;
-    // @beta
-    layoutItemCheck?: (registration: string) => boolean;
-    // @internal
-    loadRemotes(): Promise<void>;
-    // (undocumented)
-    loginRouting: LoginRouting;
-    logoAltText: string;
-    logoSrc: any;
-    logout(): Promise<void>;
-    logoutButtonPosition: 'side-nav' | 'account-menu' | 'none';
-    // @internal
-    luminanceIconEvent(): void;
-    // (undocumented)
-    luminanceToggle: boolean;
-    // @internal
-    miscIconEvent(): void;
-    navigateTo(path: string): void;
-    // @internal
-    notificationIconEvent(): void;
-    get pathName(): string;
-    // @internal
-    ready: boolean;
-    // @deprecated
-    routeButtons: Array<{
-        index: number;
-        path: string;
-        title: string;
-        icon: string;
-        variant: string;
-    }>;
-    // @internal (undocumented)
-    routeButtonsChanged(): void;
-    routeNavItems: FoundationRouteNavItem[];
-    selectTemplate(): ViewTemplate<Navigation>;
-    // (undocumented)
-    setLuminance(): void;
-    get shouldShowAccountMenu(): boolean;
-    showAccountMenu: boolean;
-    showAiIndicator: boolean;
-    showConnectionIndicator: boolean;
-    showControlPanel: boolean;
-    showEnvironmentIndicator: boolean;
-    showLanguageSelector: boolean;
-    showLuminanceToggleButton: boolean;
-    showMiscToggleButton: boolean;
-    // @deprecated
-    showNotificationsButton: boolean;
-    // @internal (undocumented)
-    showNotificationsButtonChanged(): void;
-    // @internal
-    sideNavOpen: boolean;
-    // @internal (undocumented)
-    toggleControlPanel(): void;
-    // @internal
-    toggleNavVisibility(): void;
-    toLocalisedText(text: string): string;
-    // (undocumented)
-    user: User;
-    userName: string;
-}
-
-// @public
-export type NavTargetId = 'nav-start' | 'nav' | 'nav-end';
-
-// @public
-export const navTemplate: ViewTemplate<Navigation, any>;
-
-// @public
-export class RapidHeader extends Navigation {
-    // @internal
-    loadRemotes(): Promise<void>;
-    // (undocumented)
-    selectTemplate(): ViewTemplate<Navigation>;
-}
-
-// @public
-export type SideNavTargetId = 'side-nav-start' | 'side-nav' | 'side-nav-end';
-
-// @public
-export type StyleTargetId = 'header';
-
-// Warning: (ae-internal-missing-underscore) The name "ZeroHeader" should be prefixed with an underscore because the declaration is marked as @internal
-//
-// @internal @deprecated
-export class ZeroHeader extends Navigation {
-}
-
-// (No @packageDocumentation comment for this package)
-
-```