@globalpayments/vega 2.28.1 → 2.29.0

package/dist/types/components/vega-sidenav/vega-sidenav-link/vega-sidenav-link.d.ts

@@ -0,0 +1,80 @@
+import { EventEmitter } from '../../../stencil-public-runtime';
+import { GlobalSlimmers } from '../../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaSidenavLinkSubStateController } from './slimmers/controllers/vega-sidenav-link-sub-state.controller';
+import { EventEmitSlimmerBase } from '../../../helpers/event-manager/slimmers/event-emit-slimmer';
+/**
+ * @deprecated This component will be removed soon, please consider using `vega-left-nav-link` component instead.
+ * @vegaVersion 2.29.0
+ */
+export declare class VegaSidenavLink {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaSidenavElement>;
+  protected subStateObserverSlimmer: VegaSidenavLinkSubStateController;
+  protected clickEventEmitter: EventEmitSlimmerBase;
+  private observer;
+  host: HTMLVegaSidenavLinkElement;
+  openState: 'open' | 'hoverOpen' | 'close';
+  /**
+   * Specifies the icon displayed for the side navigation link.
+   *    Icons are only displayed for top-level links.
+   *
+   * @vegaVersion 2.29.0
+   */
+  icon: string;
+  /**
+   * Indicates whether the link item is selected.
+   *
+   * @vegaVersion 2.29.0
+   */
+  selected: boolean;
+  /**
+   * Specifies the destination URL to which the side navigation link
+   *    navigates when clicked.
+   *
+   * @vegaVersion 2.29.0
+   */
+  url: string;
+  /**
+   * Determines if the side nav should stay open when the
+   *    sidenav-link element is clicked.
+   *
+   * @vegaVersion 2.29.0
+   */
+  showSideBarOnClickLink: boolean;
+  /**
+   * An event emitter notifying about the occurrence of a click event.
+   *
+   * @vegaVersion 2.29.0
+   */
+  vegaClick: EventEmitter;
+  /**
+   * An event emitter notifying about the occurrence of a click event.
+   *
+   * @eventSemantics namespace:native
+   * @vegaVersion 2.29.0
+   */
+  click: EventEmitter;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-link-e2e-disconnected}
+   */
+  disconnectedCallback(): void;
+  componentWillLoad(): void;
+  componentDidRender(): void;
+  render(): VegaSidenavLink;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-link-click-event}
+   */
+  private handleClick;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-link-observer-with-click}
+   */
+  private observerListener;
+  /**
+   * Notify the parent sidenav element the child link has been clicked
+   */
+  private notifyParentSidenavClick;
+}

package/dist/types/components/vega-sidenav/vega-sidenav.d.ts

@@ -0,0 +1,137 @@
+import { EventEmitter } from '../../stencil-public-runtime';
+import { ResponsiveType } from '../../types/ui.type';
+import { OpenByDefaultType, SidebarHeaderConfig, SidebarTopLevelItem } from './types';
+import { GlobalSlimmers } from '../../vega-slimmer/vega-slimmer-core';
+import { VegaComponentUsageRuntimeMetricsSlimmer } from '../../helpers/slimmers/component-usage-runtime-metrics';
+import { VegaSidenavBackdropController } from './slimmers/controllers/vega-sidenav-backdrop-controller';
+import { VegaSidenavCollapseButtonRenderer } from './slimmers/renderers/vega-sidenav-collapse-button-renderer';
+import { SubStateNotifySlimmerBase } from '../../helpers/slimmers/sub-state/sub-state-notify-slimmer-base';
+import { VegaSidenavOpenStatusController } from './slimmers/controllers/vega-sidenav-open-status-controller';
+import { EventEmitSlimmerBase } from '../../helpers/event-manager/slimmers/event-emit-slimmer';
+/**
+ * @deprecated This component will be removed soon, please consider using `vega-left-nav` component instead.
+ * @vegaVersion 2.29.0
+ */
+export declare class VegaSidenav {
+  protected readonly globalSlimmers: GlobalSlimmers;
+  protected vegaComponentUsageRuntimeMetricsSlimmer: VegaComponentUsageRuntimeMetricsSlimmer<HTMLVegaSidenavElement>;
+  protected readonly openStateNotifySlimmer: SubStateNotifySlimmerBase;
+  protected backdropController: VegaSidenavBackdropController;
+  protected collapseButtonRenderer: VegaSidenavCollapseButtonRenderer;
+  protected openStatusController: VegaSidenavOpenStatusController;
+  protected stateUpdateEmitter: EventEmitSlimmerBase;
+  private content;
+  host: HTMLVegaSidenavElement;
+  openState: 'open' | 'hoverOpen' | 'close';
+  /**
+   * The method to used notify the sub state the parent state value changed
+   */
+  watchOpenState(): void;
+  /**
+   * Defines the data that is used to generate the items
+   *    in the side nav list.
+   *
+   * @vegaVersion 2.29.0
+   */
+  source: SidebarTopLevelItem[];
+  /**
+   * clear inner content in `div.vega-nav-list` if previousSource is empty.
+   * to avoid untracked sidenav items (render by slot) keeping existed while source updated.
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-with-source-with-child}
+   */
+  watchSourceChange(currentSource: SidebarTopLevelItem[] | undefined, previousSource: SidebarTopLevelItem[] | undefined): void;
+  /**
+   * Provides additional information or context in the form of
+   *    a footnote in the side nav footer.
+   *
+   * @vegaVersion 2.29.0
+   */
+  footnote: string;
+  /**
+   * Specifies the configuration for the header of the side nav,
+   *    allowing customization of the logo and headline.
+   *
+   * @vegaVersion 2.29.0
+   */
+  headerConfig: SidebarHeaderConfig;
+  /**
+   * Specifies the default open behavior for the side nav across
+   *    different screen sizes and disables collapse for
+   *    large screens.
+   *
+   * @vegaVersion 2.29.0
+   */
+  openByDefault: ResponsiveType<OpenByDefaultType>;
+  watchOpenByDefaultChange(): void;
+  /**
+   * An event emitter notifying the completion of a navigation menu state change (open or close).
+   *
+   * @vegaVersion 2.29.0
+   */
+  vegaStateUpdate: EventEmitter<string>;
+  /**
+   * An event emitter notifying the completion of a navigation menu state change (open or close).
+   *
+   * @eventSemantics namespace:native
+   * @vegaVersion 2.29.0
+   */
+  stateUpdate: EventEmitter<string>;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-with-source-with-duplicated-selected}
+   * @see{module:vega-sidenav-e2e-with-source-without-child}
+   */
+  componentWillLoad(): void;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-vega-resize-with-desktop}
+   * @see{module:vega-sidenav-e2e-vega-resize-with-desktop-to-mobile}
+   */
+  componentDidLoad(): void;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-vega-click-backdrop-mobile}
+   */
+  collapseSidenavByBackDropClick(e: MouseEvent): void;
+  /**
+   * Invoke this method to toggle the side navigation menu.
+   *
+   * @vegaVersion 2.29.0
+   */
+  toggle(): Promise<void>;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-desktop-not-show-backdrop}
+   * @see{module:vega-sidenav-mobile-show-backdrop}
+   */
+  render(): VegaSidenav;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-with-source-with-duplicated-selected}
+   * @see{module:vega-sidenav-e2e-with-source-without-child}
+   */
+  private validSource;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-mouse-enter-and-mouse-leave-and-click}
+   */
+  private attachMouseEventToContent;
+  /**
+   * The current div uses a named slot and has a sibling above it, if you skip rendering this whole element by checking a variable,
+   * it will cause the slot's position to move into the sibling.
+   * For specific examples, see the documentation of stencil_slot_bug.md
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-with-source-with-child}
+   * @see{module:vega-sidenav-e2e-with-source-without-length}
+   */
+  private renderSideBarList;
+  /**
+   * The below method is e2e-test covered in
+   * @see{module:vega-sidenav-e2e-with-source-with-child}
+   * @see{module:vega-sidenav-e2e-with-source-without-child}
+   */
+  private renderSideBarListBySource;
+  private renderSideBarHeader;
+  private renderSideBarFooter;
+}