/* eslint-disable */
/* tslint:disable */
/**
* This is an autogenerated file created by the Stencil compiler.
* It contains typing information for all components that exist in this project.
*/
import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
import { AccordionVariant, AvatarSize, BookCardDeprecatedVariant, 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, TreeListItem, VisibilityCondition, ZAriaAlertMode, ZChipType, ZDatePickerMode, ZFileUploadType, ZRangePickerMode, ZSectionTitleDividerPosition } from "./beans";
import { AlertType, LicenseType } from "./beans/index";
import { ZFileUploadError } from "./components/file-upload/z-file-upload/index";
import { ListItem } from "./beans/index.js";
export { AccordionVariant, AvatarSize, BookCardDeprecatedVariant, 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, TreeListItem, VisibilityCondition, ZAriaAlertMode, ZChipType, ZDatePickerMode, ZFileUploadType, ZRangePickerMode, ZSectionTitleDividerPosition } from "./beans";
export { AlertType, LicenseType } from "./beans/index";
export { ZFileUploadError } from "./components/file-upload/z-file-upload/index";
export { ListItem } from "./beans/index.js";
export namespace Components {
/**
* Accordion component.
* @cssprop --z-accordion-highlight-color - Color of the highlight band on the summary's left edge. Only applies when `highlight` is true. Default: `transparent`.
* @cssprop --z-accordion-bg - Background color of the summary. Default: `--color-surface02`.
* @cssprop --z-accordion-label-color - Label color. Default: `--color-default-text`.
* @cssprop --z-accordion-disabled-label-color - Label color when disabled. Default: `--color-text03`.
* @cssprop --z-accordion-content-bg - Background color of the accordion. Default: `--color-surface02`.
* @cssprop --z-accordion-content-fg - Content text color. Default: `--color-default-text`.
* @cssprop --z-accordion-hover-color - Hover color of the summary. Default: `--color-surface03`.
* @cssprop --z-accordion-left-padding - Left padding of the summary. Default: `--space-unit` * 2.
* @cssprop --z-accordion-right-padding - Right padding of the summary. Default: `--space-unit`.
* @cssprop --z-accordion-label-font-weight - Font weight of the summary label. Default: `--font-sb`.
*/
interface ZAccordion {
/**
* Enable highlight band on the `summary`'s left edge.
*/
"highlight": boolean;
/**
* Name of the z-icon to display before the label's text.
*/
"icon": string;
/**
* Disabled state of the accordion.
*/
"isDisabled": boolean;
/**
* Text label.
*/
"label": string;
/**
* The open state of the accordion.
*/
"open": boolean;
/**
* Enable box-shadow on the accordion. Only applies when `variant` is `BACKGROUND`.
*/
"shadow": boolean;
/**
* Size of the component.
*/
"size": ControlSize;
/**
* Accordion variant.
*/
"variant": AccordionVariant;
}
interface ZAlert {
/**
* alert variant type
*/
"type": AlertType;
}
/**
* Anchor navigation component.
* @example ```
*
*
*
* ```
*/
interface ZAnchorNavigation {
/**
* Enables automatic inference of the current item, listening for hash change and checking the `href` of the slotted anchors. When disabled, the highlight of current item must be handled manually by setting the `data-current` attribute to the correct slotted items and the `aria-current` attribute to the anchors.
*/
"autoCurrent": boolean;
/**
* Sets the label of the button displayed on mobile viewport when the anchor navigation is collapsed
*/
"collapsedLabel": string;
/**
* If enabled, the text of each anchor will be hidden unless for the current one or the one the user is hovering.
*/
"hideUnselected": boolean;
}
/**
* @cssprop --app-header-content-max-width - Use it to set header's content max width. Useful when the project use a fixed width layout. Defaults to `100%`.
* @cssprop --app-header-top-offset - Top offset for the stuck header. Useful when there are other fixed elements above the header. Defaults to `48px` (the height of the main topbar).
* @cssprop --app-header-bg - Header background color. Defaults to `--color-surface01`.
* @cssprop --app-header-text-color - Header text color. Defaults to `--color-default-text`.
* @cssprop --app-header-stucked-bg - Stuck header background color. Defaults to `--color-surface01`.
* @cssprop --app-header-stucked-text-color - Stuck header text color. Defaults to `--color-default-text`.
*/
interface ZAppHeader {
/**
* The opening state of the drawer.
*/
"drawerOpen": boolean;
/**
* When enabled, the menu bar is not displayed and a burger icon appears to open the offcanvas menu. Automatically enabled on mobile and when the menu items overflow the container.
*/
"enableOffcanvas": boolean;
/**
* Enable the search bar.
*/
"enableSearch": boolean;
/**
* Enable laZ logo.
*/
"enableZLogo": boolean;
/**
* Url to the search page. Set this prop and `enableSearch` to show a link-button on mobile and tablet viewports, instead of the normal searchbar. The link will also appear on the sticky header.
*/
"searchPageUrl": string;
/**
* Placeholder text for the search bar.
*/
"searchPlaceholder": string;
/**
* Search string for the search bar.
*/
"searchString": string;
/**
* Stuck mode for the header. You can programmatically set it using an IntersectionObserver.
*/
"stuck": boolean;
}
/**
* @cssprop --app-header-typography-1-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `24px`.
* @cssprop --app-header-typography-2-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `28px`.
* @cssprop --app-header-typography-3-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `32px`.
* @cssprop --app-header-typography-4-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `36px`.
* @cssprop --app-header-typography-5-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `42px`.
* @cssprop --app-header-typography-6-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `48px`.
* @cssprop --app-header-typography-7-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `54px`.
* @cssprop --app-header-typography-8-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `60px`.
* @cssprop --app-header-typography-9-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `68px`.
* @cssprop --app-header-typography-10-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `76px`.
* @cssprop --app-header-typography-11-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `84px`.
* @cssprop --app-header-typography-12-size - Part of the heading typography's scale. Use it if you have to override the default value. Value: `92px`.
* @cssprop --app-header-typography-1-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.33`.
* @cssprop --app-header-typography-2-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.29`.
* @cssprop --app-header-typography-3-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.25`.
* @cssprop --app-header-typography-4-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.24`.
* @cssprop --app-header-typography-5-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.24`.
* @cssprop --app-header-typography-6-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.25`.
* @cssprop --app-header-typography-7-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.2`.
* @cssprop --app-header-typography-8-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.26`.
* @cssprop --app-header-typography-9-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.24`.
* @cssprop --app-header-typography-10-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.26`.
* @cssprop --app-header-typography-11-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.2`.
* @cssprop --app-header-typography-12-lineheight - Part of the heading typography's scale. Use it if you have to override the default value. Value: `1.2`.
* @cssprop --app-header-typography-1-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-0.2 / 1em)`.
* @cssprop --app-header-typography-2-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-0.4 / 1em)`.
* @cssprop --app-header-typography-3-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-0.6 / 1em)`.
* @cssprop --app-header-typography-4-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-0.8 / 1em)`.
* @cssprop --app-header-typography-5-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-1 / 1em)`.
* @cssprop --app-header-typography-6-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-1.2 / 1em)`.
* @cssprop --app-header-typography-7-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-1.4 / 1em)`.
* @cssprop --app-header-typography-8-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-1.6 / 1em)`.
* @cssprop --app-header-typography-9-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-1.8 / 1em)`.
* @cssprop --app-header-typography-10-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-2 / 1em)`.
* @cssprop --app-header-typography-11-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-2.2 / 1em)`.
* @cssprop --app-header-typography-12-tracking - Part of the heading typography's scale. Use it if you have to override the default value. Value: `calc(-2.4 / 1em)`.
* @cssprop --app-header-content-max-width - Use it to set header's content max width. Useful when the project use a fixed width layout. Defaults to `100%`.
* @cssprop --app-header-height - Defaults to `auto`.
* @cssprop --app-header-top-offset - Top offset for the stuck header. Useful when there are other fixed elements above the header. Defaults to `48px` (the height of the main topbar).
* @cssprop --app-header-drawer-trigger-size - The size of the drawer icon. Defaults to `--space-unit * 4`.
* @cssprop --app-header-bg - Header background color. Defaults to `--color-surface01`.
* @cssprop --app-header-stucked-bg - Stuck header background color. Defaults to `--color-surface01`.
* @cssprop --app-header-text-color - Text color. Useful on `hero` variant to set text color based on the colors of the background image. Defaults to `--color-default-text`.
* @cssprop --app-header-title-font-size - Variable to customize the title's font size.
* NOTE: Only use one of the exported `--app-header-typography-*-size` as a value.
* Defaults to `--app-header-typography-3-size`.
* @cssprop --app-header-title-lineheight - Variable to customize the title's line-height.
* NOTE: Only use one of the exported `--app-header-typography-*-lineheight` as a value and use the same level as the one of the font size.
* Defaults to `--app-header-typography-3-lineheight`.
* @cssprop --app-header-title-letter-spacing - Variable to customize the title's letter-spacing.
* NOTE: Only use one of the exported `--app-header-typography-*-tracking` as a value and use the same level as the one of the font size.
* Defaults to `--app-header-typography-3-tracking`.
* @cssprop --app-header-stucked-text-color - Stuck header text color. Defaults to `--color-default-text`.
*/
interface ZAppHeaderDeprecated {
/**
* The opening state of the drawer.
*/
"drawerOpen": boolean;
/**
* Enable the search bar.
*/
"enableSearch": boolean;
/**
* Control menu bar position in the header. - auto: the menu bar is positioned near the title - stack: the menu bar is positioned below the title - offcanvas: the menu bar is not displayed and a burger icon appears to open the offcanvas menu
*/
"flow": "auto" | "stack" | "offcanvas";
/**
* Set the hero image source for the header. You can also use a [slot="hero"] node for advanced customization.
*/
"hero": string;
/**
* Should place an overlay over the hero image. Useful for legibility purpose.
*/
"overlay": boolean;
/**
* Url to the search page. Set this prop and `enableSearch` to show a link-button on mobile and tablet viewports, instead of the normal searchbar. The link will also appear on the sticky header.
*/
"searchPageUrl": string;
/**
* Placeholder text for the search bar.
*/
"searchPlaceholder": string;
/**
* Search string for the search bar.
*/
"searchString": string;
/**
* Stuck mode for the header. You can programmatically set it using an IntersectionObserver.
*/
"stuck": boolean;
}
interface ZAriaAlert {
/**
* Aria live mode
*/
"mode": ZAriaAlertMode;
}
interface ZAvatar {
/**
* [optional] Avatar background color
*/
"backgroundColor"?: string;
/**
* [optional] Avatar image
*/
"image"?: string;
/**
* [optional] Avatar size
*/
"size"?: AvatarSize;
/**
* [optional] Avatar text
*/
"text"?: string;
/**
* [optional] Avatar text color
*/
"textColor"?: string;
}
/**
* @cssprop --z-book-card-portrait-cover-height - set custom cover height for portrait variant - default 378px
* @cssprop --z-book-card-title-lines - set title avilable lines - default 2
* @cssprop --z-book-card-title-word-break - set title word-break rule - default initial
* @cssprop --z-book-card-subtitle-lines - set subtitle available lines - default 1
* @cssprop --z-book-card-subtitle-word-break - set subtitle word-break rule - default break-all
* @cssprop --z-book-card-authors-lines - set authors available lines - default 1
* @cssprop --z-book-card-authors-word-break - set authors word-break rule - default break-all
*/
interface ZBookCard {
/**
* [optional] Authors
*/
"authors"?: string;
/**
* Cover URL
*/
"cover": string;
/**
* [optional] Show link to the ebook resource
*/
"ebookUrl"?: string;
/**
* [optional] Fallback cover URL
*/
"fallbackCover"?: string;
/**
* [optional] Main ISBN
*/
"isbn"?: string;
/**
* [optional] ISBN label
*/
"isbnLabel": string;
/**
* Opera title (card title)
*/
"operaTitle": string;
/**
* [optional] Set a specific h level as html tag for opera title
*/
"titleHtmlTag"?: string;
/**
* Card variant: landscape, portrait
*/
"variant": BookCardVariant;
/**
* [optional] Volume title (card subvolume)
*/
"volumeTitle"?: string;
/**
* [optional] year
*/
"year"?: string;
}
/**
* ZBookCardApp component
* @cssprop --z-book-card-app-padding-x - set left and right padding
* @cssprop --z-book-card-app-padding-y - set top and bottom padding
*/
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 ZBookCardDeprecated {
/**
* [optional] Authors
*/
"authors"?: string;
/**
* [optional] Borderless card - compact variant only
*/
"borderless"?: boolean;
/**
* Cover URL
*/
"cover": string;
/**
* [optional] Fallback cover URL
*/
"fallbackCover"?: string;
/**
* [optional] Main ISBN
*/
"isbn"?: string;
/**
* [optional] ISBN label
*/
"isbnLabel": string;
/**
* Card main title
*/
"operaTitle": string;
/**
* [optional] [accessibility] Card title HTML tag
*/
"operaTitleTag"?: string;
/**
* [optional] Ribbon label - expanded and search variant only
*/
"ribbon"?: string;
/**
* [optional] Ribbon icon - expanded and search variant only
*/
"ribbonIcon"?: string;
/**
* [optional] Ribbon interactive - expanded and search variant only
*/
"ribbonInteractive"?: boolean;
/**
* Card variant: expanded, compact, search
*/
"variant": BookCardDeprecatedVariant;
/**
* [optional] Card subtitle
*/
"volumeTitle"?: string;
}
interface ZBreadcrumb {
/**
* [optional] Variant of first node
*/
"homepageVariant"?: BreadcrumbHomepageVariant;
/**
* [optional] Sets max number of element to show
*/
"maxNodesToShow"?: number;
/**
* [optional] Sets max number of row for each path inside the popover. Zero equals unlimited
*/
"overflowMenuItemRows"?: number;
/**
* [optional] Sets the path style
*/
"pathStyle"?: BreadcrumbPathStyle;
/**
* [optional] Controls the behaviour on tag click/enter
*/
"preventFollowUrl"?: boolean;
/**
* [optional] Sets the maximun number of chars per single node
*/
"truncateChar"?: number;
}
interface ZButton {
/**
* defines a string value that labels the internal interactive element. Used for accessibility.
*/
"ariaLabel": string | undefined;
/**
* HTML button disabled attribute.
*/
"disabled"?: boolean;
/**
* HTML href attribute. If it is set, it renders an HTML tag.
*/
"href"?: string;
/**
* Identifier, should be unique.
*/
"htmlid"?: string;
/**
* defines role attribute, used for accessibility.
*/
"htmlrole"?: string;
/**
* `z-icon` name to use (optional).
*/
"icon"?: string;
/**
* HTML button name attribute.
*/
"name"?: string;
/**
* **Deprecated:** Use `htmlrole` instead.
* @deprecated This prop has been deprecated in favor of `htmlrole` for better accessibility.
*/
"role": string;
/**
* Available sizes: `big`, `small` and `x-small`. Defaults to `big`.
*/
"size"?: ButtonSize | ControlSize;
/**
* HTML a target attribute.
*/
"target"?: string;
/**
* HTML button type attribute.
*/
"type"?: ButtonType;
/**
* Graphical variant: `primary`, `secondary`, `tertiary`. Defaults to `primary`.
*/
"variant"?: ButtonVariant;
}
interface ZButtonSort {
/**
* id, should be unique
*/
"buttonid": string;
/**
* occurrences counter (optional)
*/
"counter"?: number;
/**
* label content (descending)
*/
"desclabel"?: string;
/**
* selected flag (optional)
*/
"isselected"?: boolean;
/**
* label content (ascending)
*/
"label": string;
/**
* sortable flag (optional)
*/
"sortasc"?: boolean;
/**
* sort label content (ascending) (optional)
*/
"sortlabelasc"?: string;
/**
* sort label content (descending) (optional)
*/
"sortlabeldesc"?: string;
}
/**
* 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`
* @cssprop --z-card--text-padding - Configure CSS `padding`. Default: `none`
*/
interface ZCard {
/**
* Enable "clickable" styles like hover background and cursor, focus shadow on the whole card, etc.
*/
"clickable": boolean;
/**
* Name of the icon to place over the image cover
*/
"coverIcon": string;
/**
* Enable shadow. Default: false.
*/
"showShadow": boolean;
/**
* Card variant. Can be one of "text", "border", "shadow", "overlay". Leave it undefined for the default card.
*/
"variant": CardVariant;
}
/**
* ZCarousel component.
* @cssprop --z-carousel-gutter - The gutter between items.
* @cssprop --z-carousel-items-shadow - The shadow around the items.
*/
interface ZCarousel {
/**
* Arrow buttons position
*/
"arrowsPosition"?: CarouselArrowsPosition;
/**
* Whether the navigation arrow buttons over the items are always visible or only on mouse hover. If set to `false`, the arrows will not be visible on mobile. Only meaningful with `arrowsPosition` set to `OVER`.
*/
"fixedArrows": boolean;
/**
* The height of the ghost loader (only visible when `isLoading` is set to `true`)
*/
"ghostLoadingHeight": number;
/**
* When enabled, navigating next the last item will go back to the first item and vice versa.
*/
"infinite": boolean;
/**
* The z-carousel is on loading state
*/
"isLoading": boolean;
/**
* The z-carousel title
*/
"label"?: string;
/**
* Progress indicator type. Only available for `single` mode
*/
"progressMode"?: CarouselProgressMode;
/**
* Shows only one content at a time
*/
"single": boolean;
}
interface ZChip {
/**
* z-chip aria-label string
*/
"ariaLabel": string;
/**
* set z-chip as disabled
*/
"disabled"?: boolean;
/**
* Non interactive icon
*/
"icon"?: string;
/**
* z-chip interactive icon
*/
"interactiveIcon"?: string;
/**
* z-chip size type, can be default, medium or small
*/
"type"?: ZChipType;
}
interface ZCombobox {
/**
* check all label (optional)
*/
"checkalltext"?: string;
/**
* close combobox list text
*/
"closesearchtext"?: string;
/**
* the combobox is disabled
*/
"disabled"?: boolean;
/**
* show "check all" checkbox (optional)
*/
"hascheckall"?: boolean;
/**
* group items by category
*/
"hasgroupitems"?: boolean;
/**
* show search input flag (optional)
*/
"hassearch"?: boolean;
/**
* input unique id
*/
"inputid": string;
/**
* fixed style flag
*/
"isfixed": boolean;
/**
* toggle combo list opening flag
*/
"isopen": boolean;
/**
* list items array
*/
"items": ComboItem[] | string;
/**
* label text
*/
"label": string;
/**
* max number of checkable items (0 = unlimited)
*/
"maxcheckableitems": number;
/**
* no result text message
*/
"noresultslabel"?: string;
/**
* search input label text (optional)
*/
"searchlabel"?: string;
/**
* search input placeholder text (optional)
*/
"searchplaceholder"?: string;
/**
* search input title text (optional)
*/
"searchtitle"?: string;
/**
* Available sizes: `big`, `small` and `x-small`. Defaults to `big`.
*/
"size"?: ControlSize;
/**
* uncheck all label (optional)
*/
"uncheckalltext"?: string;
}
/**
* Cover hero component.
* Component to display a hero image with content.
* @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`.
*/
interface ZCoverHero {
/**
* 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;
/**
* Cover hero variant. Can be `OVERLAY` or `STACKED`.
*/
"variant": CoverHeroVariant;
}
interface ZDatePicker {
/**
* z-input aria label
*/
"ariaLabel": string;
/**
* unique id
*/
"datePickerId": string;
/**
* z-input label
*/
"label"?: string;
/**
* [Optional] datepicker mode: date, datetime, only months
*/
"mode": ZDatePickerMode;
/**
* [Optional] the datepicker input name
*/
"name"?: string;
/**
* [Optional] the datepicker input value
*/
"value"?: string;
}
interface ZDivider {
/**
* [optional] Divider color
*/
"color"?: string;
/**
* [optional] Divider orintation
*/
"orientation"?: DividerOrientation;
/**
* [optional] Divider size
*/
"size"?: DividerSize;
}
interface ZDragdropArea {
/**
* drag & drop button label
*/
"dragAndDropLabel": string;
}
interface ZFile {
/**
* File name
*/
"fileName": string;
/**
* File chip id
*/
"fileNumber": number;
}
interface ZFileUpload {
/**
* Prop indicating the accepted file type: ex ".pdf, .doc, .jpg"
*/
"acceptedFormat"?: string;
/**
* allowed file message
*/
"allowedFilesMessage"?: string;
/**
* Prop indicating the button variant
*/
"buttonVariant"?: ButtonVariant;
/**
* Description
*/
"description"?: string;
/**
* drag & drop button label
*/
"dragAndDropLabel"?: string;
/**
* error modal message
*/
"errorModalMessage"?: string;
/**
* error modal title
*/
"errorModalTitle"?: string;
/**
* Max file dimension in Megabyte
*/
"fileMaxSize"?: number;
/**
* Get the list of uploaded files
*/
"getFiles": () => Promise;
/**
* uploaded files history rendering
*/
"hasFileSection"?: boolean;
/**
* Value to set on the file input's `name` attribute (for use with forms)
*/
"inputName"?: string;
/**
* Title
*/
"mainTitle"?: string;
/**
* Remove a previously uploaded file
*/
"removeFile": (fileName: string) => Promise;
/**
* Whether to show errors in the internal modal or leave the handling to the app. Errors will still be emitted.
*/
"showErrors": boolean;
/**
* Prop indicating the file upload type - can be default or dragdrop
*/
"type": ZFileUploadType;
/**
* upoload button label
*/
"uploadBtnLabel"?: string;
/**
* upload clickable message
*/
"uploadClickableMessage"?: string;
/**
* upload message
*/
"uploadMessage"?: string;
/**
* loaded files label
*/
"uploadedFilesLabel"?: string;
}
interface ZGhostLoading {
}
interface ZIcon {
/**
* icon fill (optional)
*/
"fill"?: string;
/**
* icon height (optional)
*/
"height"?: number | string;
/**
* icon id (optional)
*/
"iconid"?: string;
/**
* icon name
*/
"name": string;
/**
* icon width (optional)
*/
"width"?: number | string;
}
interface ZInfoBox {
/**
* info box unique id
*/
"boxid": string;
/**
* render close icon flag
*/
"isclosable": boolean;
}
/**
* Info reveal component.
* @cssprop --z-info-reveal-panel-width - Width of the info panel.
* @cssprop --trigger-icon-size - Size of the trigger icon for big size.
* @cssprop --trigger-icon-size-small - Size of the trigger icon for small size.
* @cssprop --trigger-icon-size-x-small - Size of the trigger icon for x-small size.
*/
interface ZInfoReveal {
/**
* Aria label of the trigger button. It will be only used when `label` prop is empty.
*/
"ariaLabel": string;
/**
* Name of the icon for the trigger button
*/
"icon"?: string;
/**
* Label of the trigger button.
*/
"label"?: string;
/**
* The position of the z-info-reveal in the page. This helps to correctly place the info panel. The panel will grow in the opposite direction of the position. For example, with the default position `BOTTOM_RIGHT`, the panel will grow vertically upwards and horizontally to the left.
*/
"position"?: InfoRevealPosition;
/**
* Size of the trigger button
*/
"size"?: ControlSize;
}
interface ZInput {
/**
* the input aria-activedescendant (optional): available for text, password, number, email
*/
"ariaActivedescendant"?: string;
/**
* the input aria-autocomplete (optional): available for text, password, number, email
*/
"ariaAutocomplete"?: string;
/**
* the input aria-controls (optional): available for text, password, number, email
*/
"ariaControls"?: string;
/**
* the input aria-expaded: available for text, password, number, email
*/
"ariaExpanded": string;
/**
* the input aria-label
*/
"ariaLabel": string;
/**
* the input has autocomplete option (optional): available for text, password, number, email
*/
"autocomplete"?: string;
/**
* checked: available for checkbox, radio
*/
"checked"?: boolean;
/**
* the input is disabled
*/
"disabled"?: boolean;
/**
* render clear icon when typing (optional): available for text
*/
"hasclearicon"?: boolean;
/**
* the id of the input element
*/
"htmlid": string;
/**
* the input html title (optional)
*/
"htmltitle"?: string;
/**
* render icon (optional): available for text
*/
"icon"?: string;
/**
* get checked status
*/
"isChecked": () => Promise;
/**
* the input label
*/
"label"?: string;
/**
* the input label position: available for checkbox, radio
*/
"labelPosition"?: LabelPosition;
/**
* max number value (optional): available for number
*/
"max"?: number;
/**
* Max length value (optional): available for text
*/
"maxlength"?: number;
/**
* input helper message (optional): available for text, password, number, email, textarea - if set to `false` message won't be displayed
*/
"message"?: string | boolean;
/**
* min number value (optional): available for number
*/
"min"?: number;
/**
* Min length value (optional): available for text
*/
"minlength"?: number;
/**
* the input name
*/
"name"?: string;
/**
* pattern value (optional): available for tel, text, search, url, email, password
*/
"pattern"?: string;
/**
* the input placeholder (optional)
*/
"placeholder"?: string;
/**
* the input is readonly
*/
"readonly"?: boolean;
/**
* the input is required (optional): available for text, password, number, email, textarea, checkbox
*/
"required"?: boolean;
/**
* the input role
*/
"role": string;
/**
* Available sizes: `big`, `small` and `x-small`. Defaults to `big`.
*/
"size"?: ControlSize;
/**
* the input status (optional): available for text, password, number, email, textarea
*/
"status"?: InputStatus;
/**
* step number value (optional): available for number
*/
"step"?: number;
/**
* input types
*/
"type": InputType;
/**
* the input value
*/
"value"?: string;
}
interface ZInputMessage {
/**
* input disabled status (optional)
*/
"disabled"?: boolean;
/**
* input helper message
*/
"message": string;
/**
* input status (optional)
*/
"status"?: InputStatus;
}
interface ZList {
/**
* [optional] type of the list marker for each element
*/
"listType"?: ListType;
/**
* Sets role of the element.
*/
"role": string;
/**
* [optional] Sets size of inside elements.
*/
"size"?: ListSize;
}
interface ZListElement {
/**
* [optional] Align expandable button left or right.
*/
"alignButton"?: ExpandableListButtonAlign;
/**
* [optional] Sets element clickable.
*/
"clickable"?: boolean;
/**
* [optional] Sets text color of the element.
*/
"color"?: string;
/**
* [optional] Sets disabled style of the element.
*/
"disabled"?: boolean;
/**
* [optional] Sets the divider color.
*/
"dividerColor"?: string;
/**
* [optional] Sets the divider size.
*/
"dividerSize"?: DividerSize;
/**
* [optional] Sets the position where to insert the divider.
*/
"dividerType"?: ListDividerType;
/**
* [optional] Sets element as expandable.
*/
"expandable"?: boolean;
/**
* [optional] Sets expandable style to element.
*/
"expandableStyle"?: ExpandableListStyle;
/**
* [optional] Sets element as tree item.
*/
"hasTreeItems"?: boolean;
/**
* set tabindex to Host tag (optional). Defaults to 0.
*/
"htmlTabindex"?: number | null;
/**
* [optional] List element id.
*/
"listElementId"?: number;
/**
* [optional] position of the list element inside the list or the group
*/
"listElementPosition"?: string;
/**
* [optional] type of the list marker for each element
*/
"listType"?: ListType;
/**
* Sets element role.
*/
"role": string;
/**
* [optional] Sets size of inside elements.
*/
"size"?: ListSize;
}
interface ZListGroup {
/**
* [optional] Sets the divider color.
*/
"dividerColor"?: string;
/**
* [optional] Sets the divider size.
*/
"dividerSize"?: DividerSize;
/**
* [optional] Sets the position where to insert the divider.
*/
"dividerType"?: ListDividerType;
/**
* [optional] check for tree items in grouped lists
*/
"hasTreeItems"?: boolean;
/**
* [optional] type of the list marker for each element
*/
"listType"?: ListType;
/**
* [optional] Sets size of inside elements.
*/
"size"?: ListSize;
}
interface ZLogo {
/**
* image height
*/
"height"?: number;
/**
* alternative image text
*/
"imageAlt"?: string;
/**
* link url (optional)
*/
"link"?: string;
/**
* if true, the mobile logo is displayed, otherwise the desktop one
*/
"mobileLogo"?: boolean;
/**
* link target: true means _blank, false means _self
*/
"targetBlank"?: boolean;
/**
* image width
*/
"width"?: number;
}
/**
* @cssprop --z-menu-label-color - Color of the label's text.
*/
interface ZMenu {
/**
* Flag to set the active status of the menu.
*/
"active"?: boolean;
/**
* Flag to set the display mode of the list. If true, the list will be absolutely positioned under the menu label, stacked beneath it otherwise.
*/
"floating"?: boolean;
/**
* Focus the last item.
*/
"focusLastItem": () => Promise;
/**
* Tabindex value to set on the menu label. Useful to manage keyboard navigation focus with roving tabindex handled by this component's parent (usually ZAppHeader).
*/
"htmlTabindex": number;
/**
* The opening state of the menu.
*/
"open": boolean;
/**
* Set tabindex of the label to 0, then focus it.
*/
"setFocus": () => Promise;
/**
* Tells the component that it's placed in a vertical context with other `ZMenu`s (usually in the ZAppHeader's offcanvas). A small border is placed under it as a separator from other elements.
*/
"verticalContext": boolean;
}
/**
* @cssprop --z-menu-label-color - Color of the label's text.
*/
interface ZMenuDeprecated {
/**
* Flag to set the active status of the menu.
*/
"active"?: boolean;
/**
* Flag to set the display mode of the list. If true, the list will be absolutely positioned under the menu label, stacked beneath it otherwise.
*/
"floating"?: boolean;
/**
* The opening state of the menu.
*/
"open": boolean;
/**
* Tells the component that it's placed in a vertical context with other `ZMenu`s (e.g. in the ZAppHeader's offcanvas). A small border is placed under it as a separator from other elements.
*/
"verticalContext": boolean;
}
/**
* A component to create submenus inside the ZMenu.
*/
interface ZMenuSection {
/**
* Active state
*/
"active"?: boolean;
/**
* Focus the last item.
*/
"focusLastItem": () => Promise;
/**
* Tabindex value to set on the label button. Useful to manage keyboard navigation focus with roving tabindex handled by this component's parent (usually ZMenu).
*/
"htmlTabindex": number;
/**
* The opening state of the section.
*/
"open": boolean;
/**
* Set tabindex of the label to 0, then focus it.
*/
"setFocus": () => Promise;
}
/**
* A component to create submenus inside the ZMenu.
*/
interface ZMenuSectionDeprecated {
/**
* Active state
*/
"active"?: boolean;
}
/**
* @cssprop --z-modal-content-padding - padding of the modal's content. The default is 16px (--space-unit * 2)
*/
interface ZModal {
/**
* add role "alertdialog" to dialog (optional, default is false)
*/
"alertdialog"?: boolean;
/**
* if true, the modal is closable (optional, default is true)
*/
"closable"?: boolean;
/**
* close modal
*/
"close": () => Promise;
/**
* aria-label for close button (optional)
*/
"closeButtonLabel": string;
/**
* if true, the page scroll is locked when the modal is open (optional, default is true)
*/
"lockPageScroll"?: boolean;
/**
* unique id
*/
"modalid": string;
/**
* subtitle (optional)
*/
"modalsubtitle"?: string;
/**
* title text (optional)
*/
"modaltitle"?: string;
/**
* open modal
*/
"open": () => Promise;
/**
* if true, the modal can scroll inside, if false the viewport can scroll
*/
"scrollInside"?: boolean;
}
interface ZMyzCard {
/**
* graphic variant (optional)
*/
"cardtype"?: LicenseType;
/**
* faded status
*/
"faded": boolean;
/**
* highlighted status
*/
"ishighlighted": boolean;
/**
* pressed status
*/
"ispressed": boolean;
}
interface ZMyzCardAlert {
/**
* action button text
*/
"actiontext"?: string;
/**
* content text
*/
"contenttext": string;
/**
* icon name
*/
"iconname": string;
/**
* alert variant type
*/
"type": string;
}
interface ZMyzCardBody {
}
interface ZMyzCardCover {
/**
* default error image source
*/
"defaultimg": string;
/**
* faded status
*/
"faded": boolean;
/**
* image source
*/
"img": string;
/**
* cover alt title
*/
"titolo": string;
}
interface ZMyzCardDictionary {
/**
* card cover
*/
"cover": string;
/**
* card is disabled
*/
"disabled": boolean;
/**
* flip button label
*/
"flipbuttonlabel": string;
/**
* card is flipped
*/
"flipped": boolean;
/**
* hide info button
*/
"hideinfobtn": boolean;
/**
* card title
*/
"name": string;
}
interface ZMyzCardFooter {
/**
* authors name text
*/
"autori": string;
/**
* card graphic variant (optional)
*/
"cardtype"?: LicenseType;
/**
* display footer custom slotted content
*/
"customContent": boolean;
/**
* faded status
*/
"faded": boolean;
/**
* volume isbn
*/
"isbn": string;
/**
* footer opened by default (optional)
*/
"opened"?: boolean;
/**
* volume title
*/
"titolo": string;
}
interface ZMyzCardFooterSections {
}
interface ZMyzCardHeader {
/**
* card graphic variant (optional)
*/
"cardtype"?: LicenseType;
/**
* faded status
*/
"faded": boolean;
/**
* volume title
*/
"titolo": string;
}
interface ZMyzCardIcon {
/**
* description of the icon
*/
"ariaLabel": string;
/**
* icon name
*/
"icon": string;
/**
* disabled status flag
*/
"isdisabled": boolean;
}
interface ZMyzCardInfo {
/**
* dictionary info
*/
"data": string | DictionaryData;
/**
* tabindex link attribute (optional)
*/
"htmltabindex"?: number;
}
interface ZMyzCardList {
/**
* list data stringified array
*/
"listdata": string;
}
interface ZMyzList {
/**
* json stringified list data (mutable, optional)
*/
"inputrawdata"?: string;
/**
* list item data (mutable, optional)
*/
"list"?: ListItem[];
}
interface ZMyzListItem {
/**
* data-action attribute (optional)
*/
"action"?: string;
/**
* icon name (optional)
*/
"icon"?: string;
/**
* link url (optional)
*/
"link"?: string;
/**
* link target (optional)
*/
"linktarget"?: string;
/**
* id (optional)
*/
"listitemid"?: string;
/**
* content text
*/
"text": string;
/**
* underlined style flag
*/
"underlined": boolean;
}
/**
* Navigation tabs component.
* To select a specific tab programmatically, set the `aria-selected` attribute to `true` on the desired tab.
* @cssprop --z-navigation-tabs-nav-buttons-bg - Navigation buttons background color.
* @cssprop --z-navigation-tabs-nav-buttons-fg - Navigation buttons foreground color.
*/
interface ZNavigationTabs {
/**
* Set `aria-label` attribute to the internal `