@zanichelli/albe-web-components 6.6.0 → 6.6.2

package/dist/types/components/z-carousel/index.d.ts

@@ -1,55 +1,63 @@
-import { EventEmitter } from "../../stencil-public-runtime";
-import { CarouselArrowsPosition, CarouselProgressMode } from "../../beans";
-/**
- * ZCarousel component.
- * @cssprop --z-carousel-gutter - The gutter between items.
- * @slot - carousel items. use `<li>` elements inside this slot as it is wrapped inside an `<ul>`
- */
-export declare class ZCarousel {
-  hostElement: HTMLZCarouselElement;
-  /** The z-carousel is on loading state */
-  isLoading: boolean;
-  /** The z-carousel title, if given. */
-  label?: string;
-  /** Shows only one content at a time */
-  single: boolean;
-  /** Arrow buttons position */
-  arrowsPosition?: CarouselArrowsPosition;
-  /** Progress indicator. Only available for `single` mode */
-  progressMode?: CarouselProgressMode;
-  /** The height of z-carousel ghost loading, this prop is mandatory when isloading is set to true, as otherwise the component won't show. */
-  ghostLoadingHeight: number;
-  /** Current item index for single mode. */
-  current: number;
-  /** Items on the slider. */
-  items: HTMLLIElement[];
-  /** Reference for the items container element. */
-  private itemsContainer;
-  /** Observer that handles current index change when scrolling on single mode. */
-  private intersectionObserver;
-  /** Flag indicating the items container is scrolling programmatically towards the stored index. */
-  private scrollingTo;
-  /** Emitted on index change and only in `single` mode. */
-  indexChange: EventEmitter;
-  onIndexChange(): void;
-  onSingleModeChange(): void;
-  componentDidLoad(): void;
-  /**
-   * Set an intersection observer to show the current index to the indicator when scrolling.
-   */
-  private setIntersectionObserver;
-  private onPrev;
-  private onNext;
-  /**
-   * Check if footer can be rendered.
-   * @returns {boolean}
-   */
-  private canShowFooter;
-  /**
-   * Set current item to passed index.
-   * @param {number} index Index to set
-   * @returns {void}
-   */
-  private goTo;
-  render(): HTMLZCarouselElement;
-}
+import { EventEmitter } from "../../stencil-public-runtime";
+import { CarouselArrowsPosition, CarouselProgressMode } from "../../beans";
+/**
+ * ZCarousel component.
+ * @cssprop --z-carousel-gutter - The gutter between items.
+ * @slot - carousel items. use `<li>` elements inside this slot as it is wrapped inside an `<ul>`
+ */
+export declare class ZCarousel {
+  hostElement: HTMLZCarouselElement;
+  /** The z-carousel is on loading state */
+  isLoading: boolean;
+  /** The z-carousel title, if given. */
+  label?: string;
+  /** Shows only one content at a time */
+  single: boolean;
+  /** Arrow buttons position */
+  arrowsPosition?: CarouselArrowsPosition;
+  /** Progress indicator. Only available for `single` mode */
+  progressMode?: CarouselProgressMode;
+  /** The height of z-carousel ghost loading, this prop is mandatory when isloading is set to true, as otherwise the component won't show. */
+  ghostLoadingHeight: number;
+  /** Current item index for single mode. */
+  current: number;
+  /** Items on the slider. */
+  items: HTMLLIElement[];
+  /** Index of the indicator to highlight. */
+  highlightedIndicator: number;
+  canNavigatePrev: boolean;
+  canNavigateNext: boolean;
+  /** Reference for the items container element. */
+  private itemsContainer;
+  /** Observer that handles current index change when scrolling on single mode. */
+  private intersectionObserver;
+  /** Flag indicating the items container is about to scroll programmatically towards the stored index. */
+  private scrollingTo;
+  /** Emitted on index change and only in `single` mode. */
+  indexChange: EventEmitter;
+  onIndexChange(): void;
+  onSingleModeChange(): void;
+  /**
+   * Set an intersection observer to:
+   * - highlight the indicator of the intersecting item during scroll
+   * - set the current item to the last intersecting item
+   */
+  private setIntersectionObserver;
+  private onPrev;
+  private onNext;
+  /**
+   * Check if navigation buttons can be enabled or not and set local states.
+   */
+  private checkNavigationValidity;
+  /**
+   * Check if footer can be rendered.
+   */
+  private canShowFooter;
+  /**
+   * Set current item to passed index.
+   * @param {number} index Index to set
+   */
+  private goTo;
+  componentDidLoad(): void;
+  render(): HTMLZCarouselElement;
+}

package/dist/types/components/z-contextual-menu/index.d.ts

@@ -1,26 +1,26 @@
-import { EventEmitter } from "../../stencil-public-runtime";
-import { PopoverPosition } from "../../beans";
-export declare class ZContextualMenu {
-  /**
-   * Elements of ZContextualMenu
-   */
-  elements?: string;
-  /**
-   * [optional] Sets text color of ZContextualMenu's content
-   */
-  color?: string;
-  /**
-   * [optional] Sets the position of the popover
-   */
-  popoverPosition?: PopoverPosition;
-  private triggerButton?;
-  private popover?;
-  /** remove filter click event, returns filterid */
-  clickContextualMenu: EventEmitter;
-  private jsonElements;
-  componentWillRender(): void;
-  componentDidLoad(): void;
-  private showIcon;
-  private togglePopover;
-  render(): HTMLZContextualMenuElement;
-}
+import { EventEmitter } from "../../stencil-public-runtime";
+import { PopoverPosition } from "../../beans";
+export declare class ZContextualMenu {
+  /**
+   * Elements of ZContextualMenu
+   */
+  elements?: string;
+  /**
+   * [optional] Sets text color of ZContextualMenu's content
+   */
+  color?: string;
+  /**
+   * [optional] Sets the position of the popover
+   */
+  popoverPosition?: PopoverPosition;
+  private triggerButton?;
+  private popover?;
+  /** remove filter click event, returns filterid */
+  clickContextualMenu: EventEmitter;
+  private jsonElements;
+  componentWillRender(): void;
+  componentDidLoad(): void;
+  private showIcon;
+  private togglePopover;
+  render(): HTMLZContextualMenuElement;
+}

package/dist/types/components/z-cover-hero/index.d.ts

@@ -1,29 +1,29 @@
-import { CoverHeroVariant, CoverHeroContentPosition } from "../../beans";
-/**
- * Cover hero component.
- * Component to display a hero image with content.
- *
- * @slot cover - slot for the cover image.
- * @slot content - slot for the content.
- * @slot info-reveal - slot for the info reveal.
- * @cssprop --cover-hero-height - height of the cover hero.
- * @cssprop --cover-hero-overlay - overlay color of the cover hero (CSS background property).
- * @cssprop --cover-hero-text-color - color of the text.
- */
-export declare class ZCoverHero {
-  el: HTMLZCoverHeroElement;
-  /**
-   * Cover hero variant.
-   * Can be one of "OVERLAY", "STACKED".
-   */
-  variant: CoverHeroVariant;
-  /**
-   * Cover hero content position (only for STACKED variant).
-   */
-  contentPosition: CoverHeroContentPosition;
-  /**
-   * Template for the content.
-   */
-  private renderContent;
-  render(): HTMLZCoverHeroElement;
-}
+import { CoverHeroVariant, CoverHeroContentPosition } from "../../beans";
+/**
+ * Cover hero component.
+ * Component to display a hero image with content.
+ *
+ * @slot cover - slot for the cover image.
+ * @slot content - slot for the content.
+ * @slot info-reveal - slot for the info reveal.
+ * @cssprop --cover-hero-height - height of the cover hero.
+ * @cssprop --cover-hero-overlay - overlay color of the cover hero (CSS background property).
+ * @cssprop --cover-hero-text-color - color of the text.
+ */
+export declare class ZCoverHero {
+  el: HTMLZCoverHeroElement;
+  /**
+   * Cover hero variant.
+   * Can be one of "OVERLAY", "STACKED".
+   */
+  variant: CoverHeroVariant;
+  /**
+   * Cover hero content position (only for STACKED variant).
+   */
+  contentPosition: CoverHeroContentPosition;
+  /**
+   * Template for the content.
+   */
+  private renderContent;
+  render(): HTMLZCoverHeroElement;
+}

package/dist/types/components/z-divider/index.d.ts

@@ -1,10 +1,10 @@
-import { DividerSize, DividerOrientation } from "../../beans";
-export declare class ZDivider {
-  /** [optional] Divider size */
-  size?: DividerSize;
-  /** [optional] Divider color */
-  color?: string;
-  /** [optional] Divider orintation */
-  orientation?: DividerOrientation;
-  render(): HTMLZDividerElement;
-}
+import { DividerSize, DividerOrientation } from "../../beans";
+export declare class ZDivider {
+  /** [optional] Divider size */
+  size?: DividerSize;
+  /** [optional] Divider color */
+  color?: string;
+  /** [optional] Divider orintation */
+  orientation?: DividerOrientation;
+  render(): HTMLZDividerElement;
+}

package/dist/types/components/z-ghost-loading/index.d.ts

@@ -1,3 +1,3 @@
-export declare class ZGhostLoading {
-  render(): HTMLZGhostLoadingElement;
-}
+export declare class ZGhostLoading {
+  render(): HTMLZGhostLoadingElement;
+}

package/dist/types/components/z-info-reveal/index.d.ts

@@ -1,29 +1,29 @@
-import { InfoRevealPosition } from "../../beans";
-export declare class ZInfoReveal {
-  el: HTMLZInfoRevealElement;
-  /** Name of the icon for the open button */
-  icon?: string;
-  /** Info reveal's position */
-  position?: InfoRevealPosition;
-  /** Text that appears on closed panel next to the open button. */
-  label?: string;
-  /** Whether the info panel is open. */
-  open: boolean;
-  /** Current index for the info queue. */
-  currentIndex: number;
-  watchItems(): void;
-  /**
-   * Open the info box.
-   */
-  private openInfoBox;
-  /**
-   * Close the info box.
-   */
-  private closeInfoBox;
-  /**
-   * Navigate slotted info.
-   * It closes the info box after the last info has been navigated.
-   */
-  private next;
-  render(): HTMLZInfoRevealElement;
-}
+import { InfoRevealPosition } from "../../beans";
+export declare class ZInfoReveal {
+  el: HTMLZInfoRevealElement;
+  /** Name of the icon for the open button */
+  icon?: string;
+  /** Info reveal's position */
+  position?: InfoRevealPosition;
+  /** Text that appears on closed panel next to the open button. */
+  label?: string;
+  /** Whether the info panel is open. */
+  open: boolean;
+  /** Current index for the info queue. */
+  currentIndex: number;
+  watchItems(): void;
+  /**
+   * Open the info box.
+   */
+  private openInfoBox;
+  /**
+   * Close the info box.
+   */
+  private closeInfoBox;
+  /**
+   * Navigate slotted info.
+   * It closes the info box after the last info has been navigated.
+   */
+  private next;
+  render(): HTMLZInfoRevealElement;
+}

package/dist/types/components/z-offcanvas/index.d.ts

@@ -1,26 +1,26 @@
-import { EventEmitter } from "../../stencil-public-runtime";
-import { OffCanvasVariant, TransitionDirection } from "../../beans";
-/**
- * @slot canvasContent - set the content of the canvas
- */
-export declare class ZOffcanvas {
-  hostElement: HTMLZOffcanvasElement;
-  /**
-   * Offcanvas variant.
-   * Can be one of "overlay", "pushcontent"
-   * Default variant: pushcontent
-   */
-  variant?: OffCanvasVariant;
-  /** open component. Default: false */
-  open: boolean;
-  /** open content transitioning in a specified direction left | right. Default: left */
-  transitiondirection?: TransitionDirection;
-  /** emitted when open prop changes */
-  canvasOpenStatusChanged: EventEmitter;
-  componentWillLoad(): void;
-  onOpenChanged(): void;
-  private handleOpenStatus;
-  private handleAnimationEnd;
-  private handleAnimationStart;
-  render(): HTMLZOffcanvasElement;
-}
+import { EventEmitter } from "../../stencil-public-runtime";
+import { OffCanvasVariant, TransitionDirection } from "../../beans";
+/**
+ * @slot canvasContent - set the content of the canvas
+ */
+export declare class ZOffcanvas {
+  hostElement: HTMLZOffcanvasElement;
+  /**
+   * Offcanvas variant.
+   * Can be one of "overlay", "pushcontent"
+   * Default variant: pushcontent
+   */
+  variant?: OffCanvasVariant;
+  /** open component. Default: false */
+  open: boolean;
+  /** open content transitioning in a specified direction left | right. Default: left */
+  transitiondirection?: TransitionDirection;
+  /** emitted when open prop changes */
+  canvasOpenStatusChanged: EventEmitter;
+  componentWillLoad(): void;
+  onOpenChanged(): void;
+  private handleOpenStatus;
+  private handleAnimationEnd;
+  private handleAnimationStart;
+  render(): HTMLZOffcanvasElement;
+}

package/dist/types/components/z-pagination/index.d.ts

@@ -1,109 +1,109 @@
-import { EventEmitter } from "../../stencil-public-runtime";
-/**
- * Pagination bar component.
- */
-export declare class ZPagination {
-  host: HTMLZPaginationElement;
-  /** Pagination label placed before the bar. */
-  label?: string;
-  /** Enable navigation arrows. */
-  navArrows: boolean;
-  /** Total number of pages. Required. */
-  totalPages: number;
-  /** Number of pages to skip. */
-  skip: number;
-  /** Enable buttons to go to the first and last pages. */
-  edges: boolean;
-  /** Number of pages to show left/right of the current, before showing "load more" symbol (…). */
-  split?: number;
-  /** Number of pages to show at a time. If not set, all pages will be shown. */
-  visiblePages?: number;
-  /** Current page. */
-  currentPage: number;
-  /** Whether to show "go to page" feature. */
-  goToPage: boolean;
-  /**
-   * Internal visible pages variable.
-   * Needed to better handle conflicting props like `visiblePages` and `split`.
-   * This state will change based on props values and validation,
-   * keeping original `visiblePages` value intact.
-   */
-  private _visiblePages;
-  /** Used to hides/change some functionalities on smaller screen sizes */
-  isMobile: boolean;
-  /** Value of the go to page input */
-  goToPageValue: any;
-  /** Event emitted when the current page has changed. */
-  pageChanged: EventEmitter;
-  /**
-   * Set the max width of the pages container.
-   */
-  setPagesContainerWidth(): void;
-  /**
-   * Set visible pages.
-   * Ensure that the visible pages are always <= the total pages.
-   * If `visiblePages` isn't set, fallback to the total pages.
-   */
-  setVisiblePages(): void;
-  /**
-   * On page changed.
-   * @emits pageChanged
-   */
-  onPageChanged(): void;
-  /**
-   * On split changed.
-   * Empty `edges` value. The split feature wins over the pages chunks and edges.
-   */
-  onSplitChanged(): void;
-  /**
-   * Hide stuff on mobile.
-   */
-  onResize(): void;
-  /**
-   * Set functionalities according to screen size.
-   */
-  private setMobile;
-  /**
-   * Get a list of pages chunks, each of `visiblePages` length.
-   * @returns {number[][]}
-   */
-  private getPagesChunks;
-  /**
-   * Scroll to the left the chunk of pages containing the current page.
-   */
-  private scrollToPage;
-  /**
-   * Select a page.
-   * Do validations on the passed value before assigning it to `currentPage`.
-   * @param {number} page Page number to set
-   */
-  private selectPage;
-  /**
-   * Render page number button.
-   * @param {number} page Page number to render
-   * @returns {HTMLButtonElement}
-   */
-  private renderPage;
-  /**
-   * Render split button.
-   * @param {number} page Page to select on click.
-   * @returns {HTMLButtonElement}
-   */
-  private renderEllipsisButton;
-  /**
-   * Render chunked page buttons.
-   * @returns {HTMLDivElement[]}
-   */
-  private renderPages;
-  /**
-   * Render page buttons when split feature is enabled.
-   * @returns {HTMLButtonElement[]}
-   */
-  private renderSplitPages;
-  private renderBackButton;
-  private renderForwardButton;
-  private renderMobile;
-  componentDidLoad(): void;
-  componentDidRender(): void;
-  render(): HTMLZPaginationElement;
-}
+import { EventEmitter } from "../../stencil-public-runtime";
+/**
+ * Pagination bar component.
+ */
+export declare class ZPagination {
+  host: HTMLZPaginationElement;
+  /** Pagination label placed before the bar. */
+  label?: string;
+  /** Enable navigation arrows. */
+  navArrows: boolean;
+  /** Total number of pages. Required. */
+  totalPages: number;
+  /** Number of pages to skip. */
+  skip: number;
+  /** Enable buttons to go to the first and last pages. */
+  edges: boolean;
+  /** Number of pages to show left/right of the current, before showing "load more" symbol (…). */
+  split?: number;
+  /** Number of pages to show at a time. If not set, all pages will be shown. */
+  visiblePages?: number;
+  /** Current page. */
+  currentPage: number;
+  /** Whether to show "go to page" feature. */
+  goToPage: boolean;
+  /**
+   * Internal visible pages variable.
+   * Needed to better handle conflicting props like `visiblePages` and `split`.
+   * This state will change based on props values and validation,
+   * keeping original `visiblePages` value intact.
+   */
+  private _visiblePages;
+  /** Used to hides/change some functionalities on smaller screen sizes */
+  isMobile: boolean;
+  /** Value of the go to page input */
+  goToPageValue: any;
+  /** Event emitted when the current page has changed. */
+  pageChanged: EventEmitter;
+  /**
+   * Set the max width of the pages container.
+   */
+  setPagesContainerWidth(): void;
+  /**
+   * Set visible pages.
+   * Ensure that the visible pages are always <= the total pages.
+   * If `visiblePages` isn't set, fallback to the total pages.
+   */
+  setVisiblePages(): void;
+  /**
+   * On page changed.
+   * @emits pageChanged
+   */
+  onPageChanged(): void;
+  /**
+   * On split changed.
+   * Empty `edges` value. The split feature wins over the pages chunks and edges.
+   */
+  onSplitChanged(): void;
+  /**
+   * Hide stuff on mobile.
+   */
+  onResize(): void;
+  /**
+   * Set functionalities according to screen size.
+   */
+  private setMobile;
+  /**
+   * Get a list of pages chunks, each of `visiblePages` length.
+   * @returns {number[][]}
+   */
+  private getPagesChunks;
+  /**
+   * Scroll to the left the chunk of pages containing the current page.
+   */
+  private scrollToPage;
+  /**
+   * Select a page.
+   * Do validations on the passed value before assigning it to `currentPage`.
+   * @param {number} page Page number to set
+   */
+  private selectPage;
+  /**
+   * Render page number button.
+   * @param {number} page Page number to render
+   * @returns {HTMLButtonElement}
+   */
+  private renderPage;
+  /**
+   * Render split button.
+   * @param {number} page Page to select on click.
+   * @returns {HTMLButtonElement}
+   */
+  private renderEllipsisButton;
+  /**
+   * Render chunked page buttons.
+   * @returns {HTMLDivElement[]}
+   */
+  private renderPages;
+  /**
+   * Render page buttons when split feature is enabled.
+   * @returns {HTMLButtonElement[]}
+   */
+  private renderSplitPages;
+  private renderBackButton;
+  private renderForwardButton;
+  private renderMobile;
+  componentDidLoad(): void;
+  componentDidRender(): void;
+  render(): HTMLZPaginationElement;
+}