/* 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 { CarbonBreakdown, CarbonBreakdownLocalization, CarbonBreakdownSorting, CarbonFootprint, LinkOrAction, ModalType, PcfType } from "./util/CommonProps"; import { ColorScheme, ViewportConfig } from "./util/Theme"; import { BreakdownPosition, CarbonBreakdownDetailsConfig, PublicPcfData } from "./util/pcf"; import { ComponentScope } from "./util/context"; import { ControlledState } from "./util/ControllerUtils"; export namespace Components { interface YookBadge { /** * Determines a link to navigate to or action to perform when clicked */ "action": LinkOrAction; /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Determines the size of the badge. Choose from two predefined sizes "small" (s) and "large" (l) */ "size": "s" | "l"; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; } interface YookCarbonBreakdown { "assetsDir"?: string; "benchmarkActualText"?: string; "benchmarkComparisonText"?: string; /** * @deprecated use 'type="compensated"' instead */ "compensated"?: boolean; "contextId"?: string; "data"?: CarbonFootprint; "locale"?: string; "localization"?: CarbonBreakdownLocalization; "sorting": CarbonBreakdownSorting; "theme"?: ColorScheme; "type"?: PcfType; } interface YookCarbonBreakdownDetails { "benchmarkActualText"?: string; "benchmarkComparison"?: CarbonFootprint["benchmarkComparison"]; "benchmarkComparisonText"?: string; "breakdown": CarbonBreakdown; "config"?: CarbonBreakdownDetailsConfig; "locale"?: string; "localization"?: CarbonBreakdownLocalization; "totalFootprintInGrams": number; "type"?: PcfType; } interface YookCarbonBreakdownGraphic { "breakdown": CarbonBreakdown; "type"?: PcfType; } interface YookComponentPreview { "background": string; "theme": ColorScheme; "type": ComponentScope; } interface YookContext { "apiBasePath"?: string; "assetsDir"?: string; "element"?: string; "scope"?: ComponentScope; "test"?: boolean; "theme"?: ColorScheme; } interface YookContribution { /** * Determines a link to navigate to or action to perform when the primary dialog option is clicked */ "action": LinkOrAction; /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * Determines whether to display this component in a compact/non-responsive way or not. In this mode the contents will remain in a compact centered block rather than scaling with the viewport size. */ "compact"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; } interface YookContributionButton { "action": LinkOrAction; "assetsDir"?: string; "compact"?: boolean; "contextId"?: string; "theme"?: ColorScheme; } interface YookFootprintInfo { /** * Determines whether the product footprint was already compensated by the shop */ "compensated"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; } interface YookLearnMore { "assetsDir"?: string; "contextId"?: string; "info": "always" | "never" | ViewportConfig; "theme"?: ColorScheme; } interface YookModal { "action": LinkOrAction; "assetsDir"?: string; "open": () => Promise; "type": ModalType; } interface YookPcfController { /** * Determines the base path of the Yook API */ "apiBasePath"?: string; /** * Determines an ID for referencing a context */ "contextId"?: string; "refresh": () => Promise; /** * ShopID of the shop the product to fetch PCF data for belongs to */ "shopId": string; /** * ShopProductID of the product to fetch PCF data for */ "shopProductId": string; /** * Determines whether to fetch testing data instead of production */ "test"?: boolean; } interface YookPcfModal { /** * Determines the link target for the default dialog option */ "actionTarget": string; /** * Determines the text for the default dialog option */ "actionText": string; /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * text to display above the actual products values */ "benchmarkActualText"?: string; /** * text to display above the standard products values */ "benchmarkComparisonText"?: string; /** * @deprecated use 'type="compensated"' instead */ "compensated"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Controlled State when attached to a controller */ "controlledState"?: ControlledState; /** * Determines whether the product footprint is an estimated instead of an actual calculated one */ "estimated"?: boolean; /** * Determines the footprint+breakdown to display */ "footprint"?: string|CarbonFootprint; /** * Shows/Controls the current open-state of the modal */ "isOpen"?: boolean; /** * optional: used for localization */ "locale"?: string; /** * Determines the footprint+breakdown to display */ "localization"?: string|CarbonBreakdownLocalization; "open": () => Promise; /** * Determines the sorting for the breakdown positions */ "sorting": CarbonBreakdownSorting; /** * Determines the special type of this modal */ "type"?: PcfType; } interface YookProductLabel { /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * @deprecated use 'type="compensated"' instead */ "compensated"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Controlled State when attached to a controller */ "controlledState"?: ControlledState; /** * allows for a selector to specifically target a distinct pcf modal (otherwise uses first available tag one on page) * @see document.querySelector */ "target"?: string; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; /** * Determines the special type of this modal */ "type"?: PcfType; } interface YookSscContext { "element"?: string; "scope"?: ComponentScope; "staging"?: boolean; "test"?: boolean; "theme"?: ColorScheme; } interface YookSscProductCarbonFootprint { /** * Determines whether the footprint of this product was compensated */ "compensated"?: boolean; /** * ShopID of the shop the product to fetch PCF data for belongs to */ "shopId": string; /** * ShopProductID of the product to fetch PCF data for */ "shopProductId": string; } } declare global { interface HTMLYookBadgeElement extends Components.YookBadge, HTMLStencilElement { } var HTMLYookBadgeElement: { prototype: HTMLYookBadgeElement; new (): HTMLYookBadgeElement; }; interface HTMLYookCarbonBreakdownElement extends Components.YookCarbonBreakdown, HTMLStencilElement { } var HTMLYookCarbonBreakdownElement: { prototype: HTMLYookCarbonBreakdownElement; new (): HTMLYookCarbonBreakdownElement; }; interface HTMLYookCarbonBreakdownDetailsElement extends Components.YookCarbonBreakdownDetails, HTMLStencilElement { } var HTMLYookCarbonBreakdownDetailsElement: { prototype: HTMLYookCarbonBreakdownDetailsElement; new (): HTMLYookCarbonBreakdownDetailsElement; }; interface HTMLYookCarbonBreakdownGraphicElement extends Components.YookCarbonBreakdownGraphic, HTMLStencilElement { } var HTMLYookCarbonBreakdownGraphicElement: { prototype: HTMLYookCarbonBreakdownGraphicElement; new (): HTMLYookCarbonBreakdownGraphicElement; }; interface HTMLYookComponentPreviewElement extends Components.YookComponentPreview, HTMLStencilElement { } var HTMLYookComponentPreviewElement: { prototype: HTMLYookComponentPreviewElement; new (): HTMLYookComponentPreviewElement; }; interface HTMLYookContextElement extends Components.YookContext, HTMLStencilElement { } var HTMLYookContextElement: { prototype: HTMLYookContextElement; new (): HTMLYookContextElement; }; interface HTMLYookContributionElement extends Components.YookContribution, HTMLStencilElement { } var HTMLYookContributionElement: { prototype: HTMLYookContributionElement; new (): HTMLYookContributionElement; }; interface HTMLYookContributionButtonElement extends Components.YookContributionButton, HTMLStencilElement { } var HTMLYookContributionButtonElement: { prototype: HTMLYookContributionButtonElement; new (): HTMLYookContributionButtonElement; }; interface HTMLYookFootprintInfoElement extends Components.YookFootprintInfo, HTMLStencilElement { } var HTMLYookFootprintInfoElement: { prototype: HTMLYookFootprintInfoElement; new (): HTMLYookFootprintInfoElement; }; interface HTMLYookLearnMoreElement extends Components.YookLearnMore, HTMLStencilElement { } var HTMLYookLearnMoreElement: { prototype: HTMLYookLearnMoreElement; new (): HTMLYookLearnMoreElement; }; interface HTMLYookModalElement extends Components.YookModal, HTMLStencilElement { } var HTMLYookModalElement: { prototype: HTMLYookModalElement; new (): HTMLYookModalElement; }; interface HTMLYookPcfControllerElement extends Components.YookPcfController, HTMLStencilElement { } var HTMLYookPcfControllerElement: { prototype: HTMLYookPcfControllerElement; new (): HTMLYookPcfControllerElement; }; interface HTMLYookPcfModalElement extends Components.YookPcfModal, HTMLStencilElement { } var HTMLYookPcfModalElement: { prototype: HTMLYookPcfModalElement; new (): HTMLYookPcfModalElement; }; interface HTMLYookProductLabelElement extends Components.YookProductLabel, HTMLStencilElement { } var HTMLYookProductLabelElement: { prototype: HTMLYookProductLabelElement; new (): HTMLYookProductLabelElement; }; interface HTMLYookSscContextElement extends Components.YookSscContext, HTMLStencilElement { } var HTMLYookSscContextElement: { prototype: HTMLYookSscContextElement; new (): HTMLYookSscContextElement; }; interface HTMLYookSscProductCarbonFootprintElement extends Components.YookSscProductCarbonFootprint, HTMLStencilElement { } var HTMLYookSscProductCarbonFootprintElement: { prototype: HTMLYookSscProductCarbonFootprintElement; new (): HTMLYookSscProductCarbonFootprintElement; }; interface HTMLElementTagNameMap { "yook-badge": HTMLYookBadgeElement; "yook-carbon-breakdown": HTMLYookCarbonBreakdownElement; "yook-carbon-breakdown-details": HTMLYookCarbonBreakdownDetailsElement; "yook-carbon-breakdown-graphic": HTMLYookCarbonBreakdownGraphicElement; "yook-component-preview": HTMLYookComponentPreviewElement; "yook-context": HTMLYookContextElement; "yook-contribution": HTMLYookContributionElement; "yook-contribution-button": HTMLYookContributionButtonElement; "yook-footprint-info": HTMLYookFootprintInfoElement; "yook-learn-more": HTMLYookLearnMoreElement; "yook-modal": HTMLYookModalElement; "yook-pcf-controller": HTMLYookPcfControllerElement; "yook-pcf-modal": HTMLYookPcfModalElement; "yook-product-label": HTMLYookProductLabelElement; "yook-ssc-context": HTMLYookSscContextElement; "yook-ssc-product-carbon-footprint": HTMLYookSscProductCarbonFootprintElement; } } declare namespace LocalJSX { interface YookBadge { /** * Determines a link to navigate to or action to perform when clicked */ "action"?: LinkOrAction; /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Determines the size of the badge. Choose from two predefined sizes "small" (s) and "large" (l) */ "size"?: "s" | "l"; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; } interface YookCarbonBreakdown { "assetsDir"?: string; "benchmarkActualText"?: string; "benchmarkComparisonText"?: string; /** * @deprecated use 'type="compensated"' instead */ "compensated"?: boolean; "contextId"?: string; "data"?: CarbonFootprint; "locale"?: string; "localization"?: CarbonBreakdownLocalization; "sorting"?: CarbonBreakdownSorting; "theme"?: ColorScheme; "type"?: PcfType; } interface YookCarbonBreakdownDetails { "benchmarkActualText"?: string; "benchmarkComparison"?: CarbonFootprint["benchmarkComparison"]; "benchmarkComparisonText"?: string; "breakdown"?: CarbonBreakdown; "config"?: CarbonBreakdownDetailsConfig; "locale"?: string; "localization"?: CarbonBreakdownLocalization; "onDetails"?: (event: CustomEvent<{ type: BreakdownPosition, index: number }>) => void; "totalFootprintInGrams"?: number; "type"?: PcfType; } interface YookCarbonBreakdownGraphic { "breakdown"?: CarbonBreakdown; "type"?: PcfType; } interface YookComponentPreview { "background"?: string; "onSelected"?: (event: CustomEvent<{ selectedTheme: ColorScheme, selectedBackground: string }>) => void; "theme"?: ColorScheme; "type"?: ComponentScope; } interface YookContext { "apiBasePath"?: string; "assetsDir"?: string; "element"?: string; "scope"?: ComponentScope; "test"?: boolean; "theme"?: ColorScheme; } interface YookContribution { /** * Determines a link to navigate to or action to perform when the primary dialog option is clicked */ "action"?: LinkOrAction; /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * Determines whether to display this component in a compact/non-responsive way or not. In this mode the contents will remain in a compact centered block rather than scaling with the viewport size. */ "compact"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; } interface YookContributionButton { "action"?: LinkOrAction; "assetsDir"?: string; "compact"?: boolean; "contextId"?: string; "theme"?: ColorScheme; } interface YookFootprintInfo { /** * Determines whether the product footprint was already compensated by the shop */ "compensated"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; } interface YookLearnMore { "assetsDir"?: string; "contextId"?: string; "info"?: "always" | "never" | ViewportConfig; "theme"?: ColorScheme; } interface YookModal { "action"?: LinkOrAction; "assetsDir"?: string; "onClose"?: (event: CustomEvent) => void; "onOpen"?: (event: CustomEvent) => void; "type"?: ModalType; } interface YookPcfController { /** * Determines the base path of the Yook API */ "apiBasePath"?: string; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Event that is raised after data is fetched */ "onLoaded"?: (event: CustomEvent) => void; /** * ShopID of the shop the product to fetch PCF data for belongs to */ "shopId"?: string; /** * ShopProductID of the product to fetch PCF data for */ "shopProductId"?: string; /** * Determines whether to fetch testing data instead of production */ "test"?: boolean; } interface YookPcfModal { /** * Determines the link target for the default dialog option */ "actionTarget"?: string; /** * Determines the text for the default dialog option */ "actionText"?: string; /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * text to display above the actual products values */ "benchmarkActualText"?: string; /** * text to display above the standard products values */ "benchmarkComparisonText"?: string; /** * @deprecated use 'type="compensated"' instead */ "compensated"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Controlled State when attached to a controller */ "controlledState"?: ControlledState; /** * Determines whether the product footprint is an estimated instead of an actual calculated one */ "estimated"?: boolean; /** * Determines the footprint+breakdown to display */ "footprint"?: string|CarbonFootprint; /** * Shows/Controls the current open-state of the modal */ "isOpen"?: boolean; /** * optional: used for localization */ "locale"?: string; /** * Determines the footprint+breakdown to display */ "localization"?: string|CarbonBreakdownLocalization; /** * Determines the sorting for the breakdown positions */ "sorting"?: CarbonBreakdownSorting; /** * Determines the special type of this modal */ "type"?: PcfType; } interface YookProductLabel { /** * Overrides the "assets-dir" information from the relevant context */ "assetsDir"?: string; /** * @deprecated use 'type="compensated"' instead */ "compensated"?: boolean; /** * Determines an ID for referencing a context */ "contextId"?: string; /** * Controlled State when attached to a controller */ "controlledState"?: ControlledState; /** * allows for a selector to specifically target a distinct pcf modal (otherwise uses first available tag one on page) * @see document.querySelector */ "target"?: string; /** * Overrides the "theme" information from the relevant context */ "theme"?: ColorScheme; /** * Determines the special type of this modal */ "type"?: PcfType; } interface YookSscContext { "element"?: string; "scope"?: ComponentScope; "staging"?: boolean; "test"?: boolean; "theme"?: ColorScheme; } interface YookSscProductCarbonFootprint { /** * Determines whether the footprint of this product was compensated */ "compensated"?: boolean; /** * ShopID of the shop the product to fetch PCF data for belongs to */ "shopId"?: string; /** * ShopProductID of the product to fetch PCF data for */ "shopProductId"?: string; } interface IntrinsicElements { "yook-badge": YookBadge; "yook-carbon-breakdown": YookCarbonBreakdown; "yook-carbon-breakdown-details": YookCarbonBreakdownDetails; "yook-carbon-breakdown-graphic": YookCarbonBreakdownGraphic; "yook-component-preview": YookComponentPreview; "yook-context": YookContext; "yook-contribution": YookContribution; "yook-contribution-button": YookContributionButton; "yook-footprint-info": YookFootprintInfo; "yook-learn-more": YookLearnMore; "yook-modal": YookModal; "yook-pcf-controller": YookPcfController; "yook-pcf-modal": YookPcfModal; "yook-product-label": YookProductLabel; "yook-ssc-context": YookSscContext; "yook-ssc-product-carbon-footprint": YookSscProductCarbonFootprint; } } export { LocalJSX as JSX }; declare module "@stencil/core" { export namespace JSX { interface IntrinsicElements { "yook-badge": LocalJSX.YookBadge & JSXBase.HTMLAttributes; "yook-carbon-breakdown": LocalJSX.YookCarbonBreakdown & JSXBase.HTMLAttributes; "yook-carbon-breakdown-details": LocalJSX.YookCarbonBreakdownDetails & JSXBase.HTMLAttributes; "yook-carbon-breakdown-graphic": LocalJSX.YookCarbonBreakdownGraphic & JSXBase.HTMLAttributes; "yook-component-preview": LocalJSX.YookComponentPreview & JSXBase.HTMLAttributes; "yook-context": LocalJSX.YookContext & JSXBase.HTMLAttributes; "yook-contribution": LocalJSX.YookContribution & JSXBase.HTMLAttributes; "yook-contribution-button": LocalJSX.YookContributionButton & JSXBase.HTMLAttributes; "yook-footprint-info": LocalJSX.YookFootprintInfo & JSXBase.HTMLAttributes; "yook-learn-more": LocalJSX.YookLearnMore & JSXBase.HTMLAttributes; "yook-modal": LocalJSX.YookModal & JSXBase.HTMLAttributes; "yook-pcf-controller": LocalJSX.YookPcfController & JSXBase.HTMLAttributes; "yook-pcf-modal": LocalJSX.YookPcfModal & JSXBase.HTMLAttributes; "yook-product-label": LocalJSX.YookProductLabel & JSXBase.HTMLAttributes; "yook-ssc-context": LocalJSX.YookSscContext & JSXBase.HTMLAttributes; "yook-ssc-product-carbon-footprint": LocalJSX.YookSscProductCarbonFootprint & JSXBase.HTMLAttributes; } } }