@swisspost/internet-header 1.5.0-beta.0

package/dist/types/components/post-internet-header/post-internet-header.d.ts

@@ -0,0 +1,124 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { DropdownElement, NavMainEntity } from '../../models/header.model';
+import { StickynessOptions } from '../../models/implementor.model';
+import { ActiveRouteProp, Environment, ICustomConfig } from '../../models/general.model';
+import { IAvailableLanguage } from '../../models/language.model';
+export declare class PostInternetHeader {
+  /**
+   * Your project id, previously passed as query string parameter serviceId.
+   */
+  project: string;
+  /**
+   * Sticky behaviour of the header.
+   */
+  stickyness: StickynessOptions;
+  /**
+   * Initial language to be used. Overrides automatic language detection.
+   */
+  language?: string;
+  /**
+   * Toggle the meta navigation.
+   */
+  meta: boolean;
+  /**
+   * Toggle the login link (when logged out) or the user widget (when logged in).
+   */
+  login: boolean;
+  /**
+   * Toggle the search button.
+   */
+  search: boolean;
+  /**
+   * Toggle skiplinks. They help keyboard users to quickly jump to important sections of the page.
+   */
+  skiplinks: boolean;
+  /**
+   * DEPRECATED!: Define a proxy URL for the config fetch request. Will be removed in the next major version
+   */
+  configProxy?: string;
+  /**
+   * Target environment. Choose 'int01' for local testing.
+   */
+  environment: Environment;
+  /**
+   * Override the language switch links with custom URLs. Helpful when your application contains sub-pages and you
+   * would like to stay on subpages when the user changes language.
+   */
+  languageSwitchOverrides?: string | IAvailableLanguage[];
+  /**
+   * Customize the header config loaded from the post portal.
+   */
+  customConfig?: string | ICustomConfig;
+  /**
+   * The header uses this cookie to set the language. Disables automatic language detection.
+   */
+  languageCookieKey?: string;
+  /**
+   * The header uses this local storage key to set the language. Disables automatic language selection.
+   */
+  languageLocalStorageKey?: string;
+  /**
+   * Set the currently activated route. If there is a link matching this URL in the header, it will be highlighted.
+   * Will also highlight partly matching URLs. When set to auto, will use current location.href for comparison.
+   */
+  activeRoute?: 'auto' | false | string;
+  /**
+   * Online Services only: Add custom links to the special online service navigation entry
+   */
+  osFlyoutOverrides?: string | NavMainEntity;
+  /**
+   * Displays the header at full width for full-screen applications
+   */
+  fullWidth?: boolean;
+  /**
+   * Fires when the header has been rendered to the page.
+   */
+  headerLoaded: EventEmitter<void>;
+  activeFlyout: string | null;
+  activeDropdownElement: DropdownElement | null;
+  host: HTMLElement;
+  /**
+   * Get the currently set language as a two letter string ("de", "fr" "it" or "en")
+   * @returns string
+   */
+  getCurrentLanguage(): Promise<'de' | 'fr' | 'it' | 'en' | string>;
+  private mainNav?;
+  private lastScrollTop;
+  private throttledScroll;
+  private debouncedResize;
+  private lastWindowWidth;
+  constructor();
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  componentWillLoad(): Promise<void>;
+  componentDidLoad(): void;
+  handleLanguageChange(newValue: string): Promise<void>;
+  handleAvailableLanguagesChage(newValue: string | IAvailableLanguage[]): void;
+  handleOsFlyoutOverrides(newValue: string | NavMainEntity): Promise<void>;
+  handleActiveRouteChange(newValue: string | ActiveRouteProp): Promise<void>;
+  handleCustomConfigChange(newValue: string | ICustomConfig): Promise<void>;
+  handleSearchChange(newValue: boolean): void;
+  handleLoginChange(newValue: boolean): void;
+  handleMetaChange(newValue: boolean): void;
+  handleLanguageChangeEvent(event: CustomEvent<string>): void;
+  private handleClickOutsideBound;
+  private handleClickOutside;
+  private handleKeyUp;
+  private handleScrollEvent;
+  private handleResize;
+  /**
+   * Close open dropdown menus if another is being opened
+   *
+   * @param event Dropdown toggled event
+   * @returns void
+   */
+  private handleDropdownToggled;
+  /**
+   * Close open dropdowns if the flyout is being opened
+   * @param event Flyout toggle event
+   */
+  private handleFlyoutToggled;
+  private toggleMobileDropdown;
+  private isMainNavOpen;
+  render(): any;
+}

package/dist/types/components/post-klp-login-widget/klp-widget.controller.d.ts

@@ -0,0 +1,3 @@
+import '../../assets/js/klp-login-widget.js';
+import { ILoginWidgetOptions } from '../../models/header.model.js';
+export declare const initializeKLPLoginWidget: (containerId: string, options: ILoginWidgetOptions) => void;

package/dist/types/components/post-klp-login-widget/post-klp-login-widget.d.ts

@@ -0,0 +1,10 @@
+import { IsFocusable } from '../../models/header.model';
+export declare class PostKlpLoginWidget implements IsFocusable {
+  host: HTMLElement;
+  componentDidLoad(): Promise<void>;
+  /**
+   * Sets the focus on the login button
+   */
+  setFocus(): Promise<void>;
+  render(): any;
+}

package/dist/types/components/post-language-switch/components/post-language-switch-list.d.ts

@@ -0,0 +1,6 @@
+import { NavLangEntity } from '../../../models/header.model';
+export declare const PostLanguageSwitchList: (props: {
+  navLang: NavLangEntity[];
+  switchLanguage: (lang: NavLangEntity) => void;
+  dropdownRef: (element: HTMLElement | undefined) => void;
+}) => any;

package/dist/types/components/post-language-switch/post-language-switch.d.ts

@@ -0,0 +1,27 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { DropdownElement, DropdownEvent, HasDropdown, NavLangEntity } from '../../models/header.model';
+export declare class PostLanguageSwitch implements HasDropdown {
+  mode: 'dropdown' | 'list';
+  langSwitchOpen: boolean;
+  host: DropdownElement;
+  dropdownToggled: EventEmitter<DropdownEvent>;
+  languageChanged: EventEmitter<string>;
+  private languageSwitchDropdown;
+  componentWillUpdate(): Promise<boolean> | undefined;
+  componentDidUpdate(): void;
+  /**
+   * Open or close the language switch programatically
+   * @param force Boolean to force a state
+   * @returns Boolean indicating new state
+   */
+  toggleDropdown(force?: boolean): Promise<boolean>;
+  /**
+   * Emit a language change to the parent component
+   *
+   * @param newLang Config of the new language
+   */
+  switchLanguage(newLang: NavLangEntity): void;
+  private getMergedLanguageConfig;
+  private setDropdownRef;
+  render(): any;
+}

package/dist/types/components/post-logo/logo-sprite.component.d.ts

@@ -0,0 +1,4 @@
+export declare const LogoSprite: () => any;
+export declare const FaviconSvg: (props: {
+  className?: string;
+}) => any;

package/dist/types/components/post-logo/post-logo.d.ts

@@ -0,0 +1,11 @@
+export declare class PostLogo {
+  showFaviconLogo: boolean;
+  host: HTMLPostLogoElement;
+  private throttledResize;
+  private resizeObserver;
+  constructor();
+  componentDidLoad(): void;
+  disconnectedCallback(): void;
+  handleResize(): void;
+  render(): any;
+}

package/dist/types/components/post-main-navigation/components/level-one-action.component.d.ts

@@ -0,0 +1,8 @@
+import { NavMainEntity } from '../../../models/header.model';
+export declare const LevelOneAction: (props: {
+  level: NavMainEntity;
+  isOpen: boolean;
+  onTouchEnd: (e: any) => void;
+  onKeyDown: (e: any) => void;
+  onClick: (e: any) => void;
+}) => any;

package/dist/types/components/post-main-navigation/post-main-navigation.d.ts

@@ -0,0 +1,48 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { DropdownElement, DropdownEvent, HasDropdown, IsFocusable, NavMainEntity } from '../../models/header.model';
+export declare class PostMainNavigation implements HasDropdown, IsFocusable {
+  activeFlyout: string | null;
+  mobileMenuOpen: boolean;
+  dropdownToggled: EventEmitter<DropdownEvent>;
+  flyoutToggled: EventEmitter<string | null>;
+  host: DropdownElement;
+  private throttledResize;
+  private resizeTimer;
+  private mouseLeaveTimer;
+  private mouseEnterTimer;
+  private flyoutElement;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  handleResize(): void;
+  setWindowHeight(): void;
+  openFlyout(id: string): void;
+  closeFlyout(id?: string): void;
+  addFlyoutAnimation(flyout: HTMLElement): void;
+  removeFlyoutAnimation(flyout: HTMLElement): void;
+  isActiveFlyout(id?: string): boolean;
+  handleMouseEnter(level: NavMainEntity): void;
+  handleMouseLeave(level: NavMainEntity): void;
+  handleTouchEnd(event: TouchEvent, level: NavMainEntity): void;
+  handleKeyPress(event: KeyboardEvent, level: NavMainEntity): void;
+  handleClick(event: MouseEvent, level: NavMainEntity): void;
+  /**
+   * Disable or re-enable body scrolling, depending on whether mobile menu is open or closed
+   */
+  setBodyScroll(): void;
+  /**
+   * Toggle the main navigation (only visible on mobile)
+   * @param force Force a state
+   * @returns Boolean indicating new state
+   */
+  toggleDropdown(force?: boolean): Promise<boolean>;
+  /**
+   * Focus the main navigation toggle button
+   */
+  setFocus(): Promise<void>;
+  /**
+   * Open a specific flyout
+   * @param id Flyout ID
+   */
+  setActiveFlyout(id: string | null): Promise<void>;
+  render(): any;
+}

package/dist/types/components/post-meta-navigation/post-meta-navigation.d.ts

@@ -0,0 +1,5 @@
+export declare class PostMetaNavigation {
+  orientation: 'horizontal' | 'vertical';
+  fullWidth?: boolean;
+  render(): any;
+}

package/dist/types/components/post-search/post-search.d.ts

@@ -0,0 +1,61 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { CoveoCompletion } from '../../models/coveo.model';
+import { GeocodeLocation } from '../../models/geocode.model';
+import { DropdownElement, DropdownEvent, HasDropdown, IsFocusable } from '../../models/header.model';
+import { TrackAndTraceInfo } from '../../models/track-and-trace.model';
+export declare class PostSearch implements HasDropdown, IsFocusable {
+  searchDropdownOpen: boolean;
+  coveoSuggestions: CoveoCompletion[];
+  placeSuggestions: GeocodeLocation[];
+  parcelSuggestion: (TrackAndTraceInfo & {
+    url: string;
+  }) | null;
+  dropdownToggled: EventEmitter<DropdownEvent>;
+  host: DropdownElement;
+  private searchBox?;
+  private searchFlyout;
+  private throttledResize;
+  connectedCallback(): void;
+  disconnectedCallback(): void;
+  componentWillUpdate(): Promise<boolean> | undefined;
+  componentDidUpdate(): void;
+  toggleDropdown(event?: Event): Promise<boolean>;
+  toggleDropdown(force?: boolean): Promise<boolean>;
+  /**
+   * Sets the focus on the search button
+   */
+  setFocus(): Promise<void>;
+  private handleResize;
+  /**
+   * Disable or re-enable body scrolling, depending on whether search dropdown is open or closed in mobile view (width < 1024px)
+   */
+  private setBodyScroll;
+  /**
+   * Fetch suggestions from all available sources
+   */
+  private handleSearchInput;
+  /**
+   * Start search on enter
+   * @param event
+   */
+  private handleKeyDown;
+  /**
+   * Set selected suggestion on mouse enter
+   * @param event
+   */
+  private handleMouseEnterSuggestion;
+  /**
+   * Set selected suggestion on mouse enter
+   * @param event
+   */
+  private handleMouseLeaveSuggestions;
+  /**
+   * Deselect any previously selected suggestion
+   */
+  private deselectSuggestion;
+  /**
+   * Redirect to the post search page
+   */
+  private startSearch;
+  render(): any;
+}

package/dist/types/components/post-skiplinks/post-skiplinks.d.ts

@@ -0,0 +1,9 @@
+export declare class PostSkiplinks {
+  host: HTMLElement;
+  private getMainId;
+  private setFocus;
+  private focusMain;
+  private focusSearch;
+  private focusLogin;
+  render(): any;
+}