@zanichelli/albe-web-components 7.3.2 → 7.3.4

package/dist/types/components/z-anchor-navigation/index.d.ts

@@ -1,39 +1,39 @@
-/**
- * * Anchor navigation component.
- * @slot Main slot. Put some `<a>` tags inside. If you need an action button/icon, wrap it and the <a> inside another tag.
- * @example
- * ```
- * <z-anchor-navigation>
- *  <div>
- *    <a href="#section-id">Section name</a>
- *    <button type="button">
- *      <z-icon name="share" />
- *    </button>
- *  </div>
- * </z-anchor-navigation>
- * ```
- */
-export declare class ZAnchorNavigation {
-  /**
-   * If enabled, the text of each anchor will be hidden unless
-   * for the current one or the one the user is hovering.
-   */
-  hideUnselected: boolean;
-  /**
-   * Whether the mobile list is collapsed.
-   */
-  collapsed: boolean;
-  /** Reference to the nav element. */
-  private nav;
-  /**
-   * Set aria-current attribute to the anchors and `current` to nav children.
-   */
-  private setAriaCurrent;
-  /**
-   * Toggle collapsed state.
-   */
-  private toggleCollapsed;
-  componentDidLoad(): void;
-  disconnectedCallback(): void;
-  render(): HTMLZAnchorNavigationElement;
-}
+/**
+ * * Anchor navigation component.
+ * @slot Main slot. Put some `<a>` tags inside. If you need an action button/icon, wrap it and the <a> inside another tag.
+ * @example
+ * ```
+ * <z-anchor-navigation>
+ *  <div>
+ *    <a href="#section-id">Section name</a>
+ *    <button type="button">
+ *      <z-icon name="share" />
+ *    </button>
+ *  </div>
+ * </z-anchor-navigation>
+ * ```
+ */
+export declare class ZAnchorNavigation {
+  /**
+   * If enabled, the text of each anchor will be hidden unless
+   * for the current one or the one the user is hovering.
+   */
+  hideUnselected: boolean;
+  /**
+   * Whether the mobile list is collapsed.
+   */
+  collapsed: boolean;
+  /** Reference to the nav element. */
+  private nav;
+  /**
+   * Set aria-current attribute to the anchors and `current` to nav children.
+   */
+  private setAriaCurrent;
+  /**
+   * Toggle collapsed state.
+   */
+  private toggleCollapsed;
+  componentDidLoad(): void;
+  disconnectedCallback(): void;
+  render(): HTMLZAnchorNavigationElement;
+}

package/dist/types/components/z-aria-alert/index.d.ts

@@ -1,6 +1,6 @@
-import { ZAriaAlertMode } from "../../beans";
-export declare class ZAriaAlert {
-  /** Aria live mode */
-  mode: ZAriaAlertMode;
-  render(): HTMLZAriaAlertElement;
-}
+import { ZAriaAlertMode } from "../../beans";
+export declare class ZAriaAlert {
+  /** Aria live mode */
+  mode: ZAriaAlertMode;
+  render(): HTMLZAriaAlertElement;
+}

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

@@ -1,16 +1,16 @@
-import { AvatarSize } from "../../beans";
-export declare class ZAvatar {
-  /** [optional] Avatar size */
-  size?: AvatarSize;
-  /** [optional] Avatar text */
-  text?: string;
-  /** [optional] Avatar text color */
-  textColor?: string;
-  /** [optional] Avatar background color */
-  backgroundColor?: string;
-  /** [optional] Avatar image */
-  image?: string;
-  constructor();
-  private getTextSize;
-  render(): HTMLZAvatarElement;
-}
+import { AvatarSize } from "../../beans";
+export declare class ZAvatar {
+  /** [optional] Avatar size */
+  size?: AvatarSize;
+  /** [optional] Avatar text */
+  text?: string;
+  /** [optional] Avatar text color */
+  textColor?: string;
+  /** [optional] Avatar background color */
+  backgroundColor?: string;
+  /** [optional] Avatar image */
+  image?: string;
+  constructor();
+  private getTextSize;
+  render(): HTMLZAvatarElement;
+}

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

@@ -1,44 +1,44 @@
-import { EventEmitter } from "../../stencil-public-runtime";
-import { CardVariant } from "../../beans";
-/**
- * ZCard component.
- * @cssprop --aspect-ratio - Cover aspect ratio. Default: `1.62`
- * @cssprop --z-card--border-color - Default: `var(--gray200)`
- * @cssprop --z-card--color-cover-background - Cover color. Default: `var(--color-surface01)`
- * @cssprop --z-card--text-background - Background color for the `text` variant. Default: `var(--color-surface01)`
- * @cssprop --z-card--text-border-radius - Default: `none`
- * @cssprop --z-card--text-border - Configure CSS `border`. Default: `none`
- */
-export declare class ZCard {
-  /**
-   * Card variant.
-   * Can be one of "text", "border", "shadow", "overlay".
-   * Leave it undefined for the default card.
-   */
-  variant: CardVariant;
-  /** Name of the icon to place over the image cover */
-  coverIcon: string;
-  /** Enable click interactions on the card. Default: false */
-  clickable: boolean;
-  /** Enable shadow. Default: false. */
-  showshadow: boolean;
-  host: HTMLZCardElement;
-  hasCoverImage: boolean;
-  /**
-   * Card click event.
-   * Fired only if `clickable` is true.
-   */
-  cardClicked: EventEmitter;
-  onClick(ev: MouseEvent): void;
-  componentWillLoad(): void;
-  /**
-   * Template for a card without image cover.
-   * A colored background replaces the image and some data is moved over it.
-   */
-  private renderColorCoverCard;
-  /**
-   * Template for the content div.
-   */
-  private renderContentDiv;
-  render(): HTMLZCardElement;
-}
+import { EventEmitter } from "../../stencil-public-runtime";
+import { CardVariant } from "../../beans";
+/**
+ * ZCard component.
+ * @cssprop --aspect-ratio - Cover aspect ratio. Default: `1.62`
+ * @cssprop --z-card--border-color - Default: `var(--gray200)`
+ * @cssprop --z-card--color-cover-background - Cover color. Default: `var(--color-surface01)`
+ * @cssprop --z-card--text-background - Background color for the `text` variant. Default: `var(--color-surface01)`
+ * @cssprop --z-card--text-border-radius - Default: `none`
+ * @cssprop --z-card--text-border - Configure CSS `border`. Default: `none`
+ */
+export declare class ZCard {
+  /**
+   * Card variant.
+   * Can be one of "text", "border", "shadow", "overlay".
+   * Leave it undefined for the default card.
+   */
+  variant: CardVariant;
+  /** Name of the icon to place over the image cover */
+  coverIcon: string;
+  /** Enable click interactions on the card. Default: false */
+  clickable: boolean;
+  /** Enable shadow. Default: false. */
+  showshadow: boolean;
+  host: HTMLZCardElement;
+  hasCoverImage: boolean;
+  /**
+   * Card click event.
+   * Fired only if `clickable` is true.
+   */
+  cardClicked: EventEmitter;
+  onClick(ev: MouseEvent): void;
+  componentWillLoad(): void;
+  /**
+   * Template for a card without image cover.
+   * A colored background replaces the image and some data is moved over it.
+   */
+  private renderColorCoverCard;
+  /**
+   * Template for the content div.
+   */
+  private renderContentDiv;
+  render(): HTMLZCardElement;
+}

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

@@ -1,63 +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[];
-  /** 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;
-}
+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,41 +1,41 @@
-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-overlay - overlay color of the cover hero (CSS `background` property). **Default**: `linear-gradient(270deg, #0000 0%, #000000e6 100%)`.
- * @cssprop --cover-hero-text-color - color of the text.
- * @cssprop --cover-hero-aspect-ratio - aspect ratio to use for the image. You can pass a fraction or a number representing the ratio. **Default**: the intrinsic aspect ratio of the slotted image or `16/9`.
- */
-export declare class ZCoverHero {
-  host: HTMLZCoverHeroElement;
-  /**
-   * Cover hero variant. Can be `OVERLAY` or `STACKED`.
-   */
-  variant: CoverHeroVariant;
-  /**
-   * Vertical content position (for `STACKED` variant).
-   */
-  contentPosition: CoverHeroContentPosition;
-  /**
-   * Whether to keep the image aspect ratio.
-   * If set to `false`, the cssprop `--cover-hero-aspect-ratio` will not affect the component's size;
-   * instead, the height of the component follows the content's one.
-   * Note: it may be necessary to set a min and/or max height to the component.
-   */
-  preserveAspectRatio: boolean;
-  /**
-   * Store the intrinsic aspect ratio of the slotted image when loaded,
-   * to have a default when `--cover-hero-aspect-ratio` is not set.
-   * @param target The event target
-   */
-  protected onImgLoad({ target }: Event): void;
-  /**
-   * 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-overlay - overlay color of the cover hero (CSS `background` property). **Default**: `linear-gradient(270deg, #0000 0%, #000000e6 100%)`.
+ * @cssprop --cover-hero-text-color - color of the text.
+ * @cssprop --cover-hero-aspect-ratio - aspect ratio to use for the image. You can pass a fraction or a number representing the ratio. **Default**: the intrinsic aspect ratio of the slotted image or `16/9`.
+ */
+export declare class ZCoverHero {
+  host: HTMLZCoverHeroElement;
+  /**
+   * Cover hero variant. Can be `OVERLAY` or `STACKED`.
+   */
+  variant: CoverHeroVariant;
+  /**
+   * Vertical content position (for `STACKED` variant).
+   */
+  contentPosition: CoverHeroContentPosition;
+  /**
+   * Whether to keep the image aspect ratio.
+   * If set to `false`, the cssprop `--cover-hero-aspect-ratio` will not affect the component's size;
+   * instead, the height of the component follows the content's one.
+   * Note: it may be necessary to set a min and/or max height to the component.
+   */
+  preserveAspectRatio: boolean;
+  /**
+   * Store the intrinsic aspect ratio of the slotted image when loaded,
+   * to have a default when `--cover-hero-aspect-ratio` is not set.
+   * @param target The event target
+   */
+  protected onImgLoad({ target }: Event): void;
+  /**
+   * 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,29 +1,27 @@
-import { EventEmitter } from "../../stencil-public-runtime";
-import { OffCanvasVariant, TransitionDirection } from "../../beans";
-/**
- * @slot canvasContent - set the content of the canvas
- * @method setSkipAanimationOnLoad - set skipAnimation
- */
-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;
-  /** manages the skip for the entry animation*/
-  skipanimationonload: boolean;
-  /** emitted when open prop changes */
-  canvasOpenStatusChanged: EventEmitter;
-  /** this method allows you to skip the page loading animation, to be used with the prop set to true */
-  setSkipAanimationOnLoad(value: boolean): Promise<void>;
-  onOpenChanged(): void;
-  private handleOverflowProperty;
-  private handledTransitionEnd;
-  render(): HTMLZOffcanvasElement;
-}
+import { EventEmitter } from "../../stencil-public-runtime";
+import { OffCanvasVariant, TransitionDirection } from "../../beans";
+/**
+ * @slot canvasContent - Slot for the main content.
+ */
+export declare class ZOffcanvas {
+  /**
+   * Offcanvas variant.
+   * Can be one `overlay` or `pushcontent`.
+   * Default variant: pushcontent
+   */
+  variant?: OffCanvasVariant;
+  /** Whether the offcanvas is open. Default: false */
+  open: boolean;
+  /** open content transitioning in a specified direction left | right. Default: left */
+  transitiondirection?: TransitionDirection;
+  /**
+   * Whether to skip the initial animation.
+   * Useful when the initial value of the `open` prop is set to `true`.
+   */
+  skipLoadAnimation: boolean;
+  /** emitted when `open` prop changes */
+  canvasOpenStatusChanged: EventEmitter;
+  onOpenChanged(): void;
+  private handlePageOverflow;
+  render(): HTMLZOffcanvasElement;
+}