@zanichelli/albe-web-components 16.4.1 → 17.0.0-RC2

package/dist/types/components.d.ts

@@ -5,10 +5,10 @@
  * It contains typing information for all components that exist in this project.
  */
 import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
-import { AccordionVariant, AvatarSize, BookCardVariant, BreadcrumbHomepageVariant, BreadcrumbPath, BreadcrumbPathStyle, ButtonSize, ButtonType, ButtonVariant, CardVariant, CarouselArrowsPosition, CarouselProgressMode, ComboItem, ControlSize, CoverHeroContentPosition, CoverHeroVariant, DictionaryData, DividerOrientation, DividerSize, ExpandableListButtonAlign, ExpandableListStyle, InfoRevealPosition, InputStatus, InputType, LabelPosition, ListDividerType, ListSize, ListType, NavigationTabsOrientation, NavigationTabsSize, NotificationType, OffCanvasVariant, PopoverPosition, SearchbarItem, SelectItem, SkipToContentLink, SortDirection, ThemeVariant, ToastNotification, ToastNotificationPosition, ToastNotificationTransition, TransitionDirection, VisibilityCondition, ZAriaAlertMode, ZChipType, ZDatePickerMode, ZFileUploadType, ZRangePickerMode, ZSectionTitleDividerPosition } from "./beans";
+import { AccordionVariant, AvatarSize, BookCardDeprecatedVariant, BookCardTag, BookCardVariant, BreadcrumbHomepageVariant, BreadcrumbPath, BreadcrumbPathStyle, ButtonSize, ButtonType, ButtonVariant, CardVariant, CarouselArrowsPosition, CarouselProgressMode, ComboItem, ControlSize, CoverHeroContentPosition, CoverHeroVariant, DictionaryData, DividerOrientation, DividerSize, ExpandableListButtonAlign, ExpandableListStyle, InfoRevealPosition, InputStatus, InputType, LabelPosition, ListDividerType, ListSize, ListType, NavigationTabsOrientation, NavigationTabsSize, NotificationType, OffCanvasVariant, PopoverPosition, SearchbarItem, SelectItem, SkipToContentLink, SortDirection, ThemeVariant, ToastNotification, ToastNotificationPosition, ToastNotificationTransition, TransitionDirection, VisibilityCondition, ZAriaAlertMode, ZChipType, ZDatePickerMode, ZFileUploadType, ZRangePickerMode, ZSectionTitleDividerPosition } from "./beans";
 import { AlertType, LicenseType } from "./beans/index";
 import { ListItem } from "./beans/index.js";
-export { AccordionVariant, AvatarSize, BookCardVariant, BreadcrumbHomepageVariant, BreadcrumbPath, BreadcrumbPathStyle, ButtonSize, ButtonType, ButtonVariant, CardVariant, CarouselArrowsPosition, CarouselProgressMode, ComboItem, ControlSize, CoverHeroContentPosition, CoverHeroVariant, DictionaryData, DividerOrientation, DividerSize, ExpandableListButtonAlign, ExpandableListStyle, InfoRevealPosition, InputStatus, InputType, LabelPosition, ListDividerType, ListSize, ListType, NavigationTabsOrientation, NavigationTabsSize, NotificationType, OffCanvasVariant, PopoverPosition, SearchbarItem, SelectItem, SkipToContentLink, SortDirection, ThemeVariant, ToastNotification, ToastNotificationPosition, ToastNotificationTransition, TransitionDirection, VisibilityCondition, ZAriaAlertMode, ZChipType, ZDatePickerMode, ZFileUploadType, ZRangePickerMode, ZSectionTitleDividerPosition } from "./beans";
+export { AccordionVariant, AvatarSize, BookCardDeprecatedVariant, BookCardTag, BookCardVariant, BreadcrumbHomepageVariant, BreadcrumbPath, BreadcrumbPathStyle, ButtonSize, ButtonType, ButtonVariant, CardVariant, CarouselArrowsPosition, CarouselProgressMode, ComboItem, ControlSize, CoverHeroContentPosition, CoverHeroVariant, DictionaryData, DividerOrientation, DividerSize, ExpandableListButtonAlign, ExpandableListStyle, InfoRevealPosition, InputStatus, InputType, LabelPosition, ListDividerType, ListSize, ListType, NavigationTabsOrientation, NavigationTabsSize, NotificationType, OffCanvasVariant, PopoverPosition, SearchbarItem, SelectItem, SkipToContentLink, SortDirection, ThemeVariant, ToastNotification, ToastNotificationPosition, ToastNotificationTransition, TransitionDirection, VisibilityCondition, ZAriaAlertMode, ZChipType, ZDatePickerMode, ZFileUploadType, ZRangePickerMode, ZSectionTitleDividerPosition } from "./beans";
 export { AlertType, LicenseType } from "./beans/index";
 export { ListItem } from "./beans/index.js";
 export namespace Components {
@@ -251,13 +251,97 @@ export namespace Components {
          */
         "textColor"?: string;
     }
+    interface ZBookCard {
+        /**
+          * [optional] Show adoption badge
+         */
+        "adoption"?: boolean;
+        /**
+          * [optional] Annotated tag
+         */
+        "annotated"?: BookCardTag | string;
+        /**
+          * [optional] Authors
+         */
+        "authors"?: string;
+        /**
+          * [optional] Show catalog link to correspondent resource
+         */
+        "catalogUrl"?: string;
+        /**
+          * Cover URL
+         */
+        "cover": string;
+        /**
+          * [optional] Show link to the ebook resource
+         */
+        "ebookUrl"?: string;
+        /**
+          * [optional] EDI tag
+         */
+        "edi"?: BookCardTag | string;
+        /**
+          * [optional] Fallback cover URL
+         */
+        "fallbackCover"?: string;
+        /**
+          * [optional] Main ISBN
+         */
+        "isbn"?: string;
+        /**
+          * [optional] ISBN label
+         */
+        "isbnLabel": string;
+        /**
+          * [optional] Opera title
+         */
+        "operaTitle"?: string;
+        /**
+          * [optional] Set a specific h level as html tag for opera title
+         */
+        "operaTitleHtmlTag"?: string;
+        /**
+          * [optional] Teacher version tag
+         */
+        "teacherVersion"?: BookCardTag | string;
+        /**
+          * Card variant: landscape, portrait
+         */
+        "variant": BookCardVariant;
+        /**
+          * [optional] Volume title
+         */
+        "volumeTitle"?: string;
+    }
+    interface ZBookCardApp {
+        /**
+          * Info text to show as inforeveal
+         */
+        "info"?: string;
+        /**
+          * Show or hide laZ prefix before app name
+         */
+        "laz"?: boolean;
+        /**
+          * link to the app website
+         */
+        "link": string;
+        /**
+          * App logo url
+         */
+        "logo"?: string;
+        /**
+          * App name
+         */
+        "name": string;
+    }
     /**
      * @cssprop --z-book-card-ribbon-background-color - ribbon backgrund color
      * @cssprop --z-book-card-ribbon-shadow-color - ribbon shadow color
      * @cssprop --z-book-card-compact-width - compact card custom width
      * @cssprop --z-book-card-compact-height - compact card custom height
      */
-    interface ZBookCard {
+    interface ZBookCardDeprecated {
         /**
           * [optional] Authors
          */
@@ -305,7 +389,7 @@ export namespace Components {
         /**
           * Card variant: expanded, compact, search
          */
-        "variant": BookCardVariant;
+        "variant": BookCardDeprecatedVariant;
         /**
           * [optional] Card subtitle
          */
@@ -2063,6 +2147,14 @@ export interface ZBookCardCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLZBookCardElement;
 }
+export interface ZBookCardAppCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLZBookCardAppElement;
+}
+export interface ZBookCardDeprecatedCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLZBookCardDeprecatedElement;
+}
 export interface ZBreadcrumbCustomEvent<T> extends CustomEvent<T> {
     detail: T;
     target: HTMLZBreadcrumbElement;
@@ -2373,6 +2465,43 @@ declare global {
         new (): HTMLZAvatarElement;
     };
     interface HTMLZBookCardElementEventMap {
+        "tagClick": any;
+        "catalogClick": any;
+        "ebookClick": any;
+        "immersiveReaderClick": any;
+    }
+    interface HTMLZBookCardElement extends Components.ZBookCard, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLZBookCardElementEventMap>(type: K, listener: (this: HTMLZBookCardElement, ev: ZBookCardCustomEvent<HTMLZBookCardElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLZBookCardElementEventMap>(type: K, listener: (this: HTMLZBookCardElement, ev: ZBookCardCustomEvent<HTMLZBookCardElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLZBookCardElement: {
+        prototype: HTMLZBookCardElement;
+        new (): HTMLZBookCardElement;
+    };
+    interface HTMLZBookCardAppElementEventMap {
+        "appClick": any;
+    }
+    interface HTMLZBookCardAppElement extends Components.ZBookCardApp, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLZBookCardAppElementEventMap>(type: K, listener: (this: HTMLZBookCardAppElement, ev: ZBookCardAppCustomEvent<HTMLZBookCardAppElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
+        addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLZBookCardAppElementEventMap>(type: K, listener: (this: HTMLZBookCardAppElement, ev: ZBookCardAppCustomEvent<HTMLZBookCardAppElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    }
+    var HTMLZBookCardAppElement: {
+        prototype: HTMLZBookCardAppElement;
+        new (): HTMLZBookCardAppElement;
+    };
+    interface HTMLZBookCardDeprecatedElementEventMap {
         "ribbonClick": any;
     }
     /**
@@ -2381,19 +2510,19 @@ declare global {
      * @cssprop --z-book-card-compact-width - compact card custom width
      * @cssprop --z-book-card-compact-height - compact card custom height
      */
-    interface HTMLZBookCardElement extends Components.ZBookCard, HTMLStencilElement {
-        addEventListener<K extends keyof HTMLZBookCardElementEventMap>(type: K, listener: (this: HTMLZBookCardElement, ev: ZBookCardCustomEvent<HTMLZBookCardElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
+    interface HTMLZBookCardDeprecatedElement extends Components.ZBookCardDeprecated, HTMLStencilElement {
+        addEventListener<K extends keyof HTMLZBookCardDeprecatedElementEventMap>(type: K, listener: (this: HTMLZBookCardDeprecatedElement, ev: ZBookCardDeprecatedCustomEvent<HTMLZBookCardDeprecatedElementEventMap[K]>) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
         addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
-        removeEventListener<K extends keyof HTMLZBookCardElementEventMap>(type: K, listener: (this: HTMLZBookCardElement, ev: ZBookCardCustomEvent<HTMLZBookCardElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
+        removeEventListener<K extends keyof HTMLZBookCardDeprecatedElementEventMap>(type: K, listener: (this: HTMLZBookCardDeprecatedElement, ev: ZBookCardDeprecatedCustomEvent<HTMLZBookCardDeprecatedElementEventMap[K]>) => any, options?: boolean | EventListenerOptions): void;
         removeEventListener<K extends keyof DocumentEventMap>(type: K, listener: (this: Document, ev: DocumentEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
         removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
         removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     }
-    var HTMLZBookCardElement: {
-        prototype: HTMLZBookCardElement;
-        new (): HTMLZBookCardElement;
+    var HTMLZBookCardDeprecatedElement: {
+        prototype: HTMLZBookCardDeprecatedElement;
+        new (): HTMLZBookCardDeprecatedElement;
     };
     interface HTMLZBreadcrumbElementEventMap {
         "clickOnNode": BreadcrumbPath["path"];
@@ -3354,6 +3483,8 @@ declare global {
         "z-aria-alert": HTMLZAriaAlertElement;
         "z-avatar": HTMLZAvatarElement;
         "z-book-card": HTMLZBookCardElement;
+        "z-book-card-app": HTMLZBookCardAppElement;
+        "z-book-card-deprecated": HTMLZBookCardDeprecatedElement;
         "z-breadcrumb": HTMLZBreadcrumbElement;
         "z-button": HTMLZButtonElement;
         "z-button-sort": HTMLZButtonSortElement;
@@ -3678,13 +3809,117 @@ declare namespace LocalJSX {
          */
         "textColor"?: string;
     }
+    interface ZBookCard {
+        /**
+          * [optional] Show adoption badge
+         */
+        "adoption"?: boolean;
+        /**
+          * [optional] Annotated tag
+         */
+        "annotated"?: BookCardTag | string;
+        /**
+          * [optional] Authors
+         */
+        "authors"?: string;
+        /**
+          * [optional] Show catalog link to correspondent resource
+         */
+        "catalogUrl"?: string;
+        /**
+          * Cover URL
+         */
+        "cover"?: string;
+        /**
+          * [optional] Show link to the ebook resource
+         */
+        "ebookUrl"?: string;
+        /**
+          * [optional] EDI tag
+         */
+        "edi"?: BookCardTag | string;
+        /**
+          * [optional] Fallback cover URL
+         */
+        "fallbackCover"?: string;
+        /**
+          * [optional] Main ISBN
+         */
+        "isbn"?: string;
+        /**
+          * [optional] ISBN label
+         */
+        "isbnLabel"?: string;
+        /**
+          * click on catalog link
+         */
+        "onCatalogClick"?: (event: ZBookCardCustomEvent<any>) => void;
+        /**
+          * click on ebook link
+         */
+        "onEbookClick"?: (event: ZBookCardCustomEvent<any>) => void;
+        /**
+          * click on immersive reader
+         */
+        "onImmersiveReaderClick"?: (event: ZBookCardCustomEvent<any>) => void;
+        /**
+          * click on tag
+         */
+        "onTagClick"?: (event: ZBookCardCustomEvent<any>) => void;
+        /**
+          * [optional] Opera title
+         */
+        "operaTitle"?: string;
+        /**
+          * [optional] Set a specific h level as html tag for opera title
+         */
+        "operaTitleHtmlTag"?: string;
+        /**
+          * [optional] Teacher version tag
+         */
+        "teacherVersion"?: BookCardTag | string;
+        /**
+          * Card variant: landscape, portrait
+         */
+        "variant"?: BookCardVariant;
+        /**
+          * [optional] Volume title
+         */
+        "volumeTitle"?: string;
+    }
+    interface ZBookCardApp {
+        /**
+          * Info text to show as inforeveal
+         */
+        "info"?: string;
+        /**
+          * Show or hide laZ prefix before app name
+         */
+        "laz"?: boolean;
+        /**
+          * link to the app website
+         */
+        "link"?: string;
+        /**
+          * App logo url
+         */
+        "logo"?: string;
+        /**
+          * App name
+         */
+        "name"?: string;
+        /**
+          * click on app link
+         */
+        "onAppClick"?: (event: ZBookCardAppCustomEvent<any>) => void;
+    }
     /**
      * @cssprop --z-book-card-ribbon-background-color - ribbon backgrund color
      * @cssprop --z-book-card-ribbon-shadow-color - ribbon shadow color
      * @cssprop --z-book-card-compact-width - compact card custom width
      * @cssprop --z-book-card-compact-height - compact card custom height
      */
-    interface ZBookCard {
+    interface ZBookCardDeprecated {
         /**
           * [optional] Authors
          */
@@ -3712,7 +3947,7 @@ declare namespace LocalJSX {
         /**
           * click on interactive ribbon
          */
-        "onRibbonClick"?: (event: ZBookCardCustomEvent<any>) => void;
+        "onRibbonClick"?: (event: ZBookCardDeprecatedCustomEvent<any>) => void;
         /**
           * Card main title
          */
@@ -3736,7 +3971,7 @@ declare namespace LocalJSX {
         /**
           * Card variant: expanded, compact, search
          */
-        "variant"?: BookCardVariant;
+        "variant"?: BookCardDeprecatedVariant;
         /**
           * [optional] Card subtitle
          */
@@ -5658,6 +5893,8 @@ declare namespace LocalJSX {
         "z-aria-alert": ZAriaAlert;
         "z-avatar": ZAvatar;
         "z-book-card": ZBookCard;
+        "z-book-card-app": ZBookCardApp;
+        "z-book-card-deprecated": ZBookCardDeprecated;
         "z-breadcrumb": ZBreadcrumb;
         "z-button": ZButton;
         "z-button-sort": ZButtonSort;
@@ -5830,13 +6067,15 @@ declare module "@stencil/core" {
             "z-app-header-deprecated": LocalJSX.ZAppHeaderDeprecated & JSXBase.HTMLAttributes<HTMLZAppHeaderDeprecatedElement>;
             "z-aria-alert": LocalJSX.ZAriaAlert & JSXBase.HTMLAttributes<HTMLZAriaAlertElement>;
             "z-avatar": LocalJSX.ZAvatar & JSXBase.HTMLAttributes<HTMLZAvatarElement>;
+            "z-book-card": LocalJSX.ZBookCard & JSXBase.HTMLAttributes<HTMLZBookCardElement>;
+            "z-book-card-app": LocalJSX.ZBookCardApp & JSXBase.HTMLAttributes<HTMLZBookCardAppElement>;
             /**
              * @cssprop --z-book-card-ribbon-background-color - ribbon backgrund color
              * @cssprop --z-book-card-ribbon-shadow-color - ribbon shadow color
              * @cssprop --z-book-card-compact-width - compact card custom width
              * @cssprop --z-book-card-compact-height - compact card custom height
              */
-            "z-book-card": LocalJSX.ZBookCard & JSXBase.HTMLAttributes<HTMLZBookCardElement>;
+            "z-book-card-deprecated": LocalJSX.ZBookCardDeprecated & JSXBase.HTMLAttributes<HTMLZBookCardDeprecatedElement>;
             "z-breadcrumb": LocalJSX.ZBreadcrumb & JSXBase.HTMLAttributes<HTMLZBreadcrumbElement>;
             "z-button": LocalJSX.ZButton & JSXBase.HTMLAttributes<HTMLZButtonElement>;
             "z-button-sort": LocalJSX.ZButtonSort & JSXBase.HTMLAttributes<HTMLZButtonSortElement>;