{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "src/lib/tag-name-map.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/lib/accordion/accordion.ts", "declarations": [ { "kind": "variable", "name": "AccordionExpandMode", "type": { "text": "{\n\t/**\n\t * Designates only a single AccordionItem can be open a time.\n\t */\n\tsingle: 'single',\n\n\t/**\n\t * Designates multiple AccordionItems can be open simultaneously.\n\t */\n\tmulti: 'multi',\n}" }, "default": "{\n\t/**\n\t * Designates only a single AccordionItem can be open a time.\n\t */\n\tsingle: 'single',\n\n\t/**\n\t * Designates multiple AccordionItems can be open simultaneously.\n\t */\n\tmulti: 'multi',\n}", "description": "Expand mode for Accordion", "privacy": "public" }, { "kind": "class", "description": "", "name": "Accordion", "slots": [ { "description": "Default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "expandmode", "type": { "text": "AccordionExpandMode" }, "description": "Determines if multiple items or a single item can opened at once", "privacy": "public" }, { "kind": "field", "name": "activeid", "type": { "text": "string | null" } }, { "kind": "field", "name": "activeItemIndex", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "accordionIds", "type": { "text": "Array" } }, { "kind": "field", "name": "change", "privacy": "private" }, { "kind": "method", "name": "findExpandedItem", "privacy": "private", "return": { "type": { "text": "AccordionItem | null" } } }, { "kind": "field", "name": "setItems", "privacy": "private" }, { "kind": "method", "name": "resetItems", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "removeItemListeners", "privacy": "private" }, { "kind": "field", "name": "activeItemChange", "privacy": "private" }, { "kind": "method", "name": "getItemIds", "privacy": "private", "return": { "type": { "text": "Array" } } }, { "kind": "method", "name": "isSingleExpandMode", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "field", "name": "handleItemKeyDown", "privacy": "private" }, { "kind": "method", "name": "adjust", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "item", "type": { "text": "AccordionItem" } }, { "name": "adjustment", "type": { "text": "number" } } ] }, { "kind": "method", "name": "focusItem", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "index", "type": { "text": "number" } } ] }, { "kind": "method", "name": "closeAll", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "VIVID_VERSION", "static": true, "default": "__PACKAGE_VERSION__", "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `.constructor.VIVID_VERSION`.", "type": { "text": "string" }, "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } }, { "kind": "field", "name": "componentName", "type": { "text": "string" }, "static": true, "description": "Core component name, without prefix", "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Fires a custom 'change' event when the active item changes", "name": "change" } ], "attributes": [ { "name": "expand-mode", "type": { "text": "AccordionExpandMode" }, "description": "Determines if multiple items or a single item can opened at once", "fieldName": "expandmode" } ], "superclass": { "name": "VividElement", "module": "/src/shared/foundation/vivid-element/vivid-element" }, "vividComponent": { "public": true, "name": "accordion" } } ], "exports": [ { "kind": "js", "name": "AccordionExpandMode", "declaration": { "name": "AccordionExpandMode", "module": "src/lib/accordion/accordion.ts" } }, { "kind": "js", "name": "Accordion", "declaration": { "name": "Accordion", "module": "src/lib/accordion/accordion.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/accordion/definition.ts", "declarations": [ { "kind": "variable", "name": "AccordionExpandMode", "type": { "text": "{\n\tsingle: 'single',\n\tmulti: 'multi',\n}" }, "default": "{\n\tsingle: 'single',\n\tmulti: 'multi',\n}" }, { "kind": "variable", "name": "registerAccordion", "description": "Registers the accordion elements with the design system.", "parameters": [ { "description": "the prefix to use for the component name", "name": "prefix" } ] } ], "exports": [ { "kind": "js", "name": "AccordionExpandMode", "declaration": { "name": "AccordionExpandMode", "module": "src/lib/accordion/definition.ts" } }, { "kind": "js", "name": "registerAccordion", "declaration": { "name": "registerAccordion", "module": "src/lib/accordion/definition.ts" } }, { "kind": "js", "name": "VwcAccordionElement", "declaration": { "name": "Accordion", "module": "src/lib/accordion/definition.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/accordion-item/accordion-item.ts", "declarations": [ { "kind": "class", "description": "", "name": "AccordionItem", "cssProperties": [ { "name": "--vvd-accordion-item-accent-primary", "default": "var(--vvd-color-canvas-text)" }, { "name": "--vvd-accordion-item-accent-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-accordion-item-accent-primary-increment", "default": "var(--vvd-color-neutral-800)" }, { "name": "--vvd-accordion-item-accent-fierce", "default": "var(--vvd-color-neutral-700)" }, { "name": "--vvd-accordion-item-accent-faint", "default": "var(--vvd-color-neutral-50)" }, { "name": "--vvd-accordion-item-accent-soft", "default": "var(--vvd-color-neutral-100)" }, { "name": "--vvd-accordion-item-accent-firm", "default": "var(--vvd-color-canvas-text)" } ], "slots": [ { "description": "Default slot.", "name": "" }, { "description": "The preferred way to add an icon to the component.", "name": "icon" }, { "description": "Used to add additional content to the heading.", "name": "meta" }, { "description": "Used to add content to the heading.", "name": "heading" } ], "members": [ { "kind": "field", "name": "headinglevel", "type": { "text": "1 | 2 | 3 | 4 | 5 | 6" }, "default": "2", "description": "Configures the https://www.w3.org/TR/wai-aria-1.1/#aria-level | level of the\nheading element.", "privacy": "public" }, { "kind": "field", "name": "appearance", "type": { "text": "AccordionItemAppearance | undefined" }, "description": "The appearance the button should have.", "privacy": "public" }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Expands or collapses the item.", "privacy": "public" }, { "kind": "field", "name": "id", "type": { "text": "string" }, "description": "The item ID", "privacy": "public" }, { "kind": "field", "name": "heading", "type": { "text": "string | undefined" }, "privacy": "public", "description": "" }, { "kind": "field", "name": "noIndicator", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the accordion-item has indicator", "privacy": "public" }, { "kind": "field", "name": "meta", "type": { "text": "string | undefined" }, "privacy": "public", "description": "" }, { "kind": "field", "name": "size", "type": { "text": "AccordionItemSize | undefined" }, "description": "The size the accordion-item should have.", "privacy": "public" }, { "kind": "field", "name": "change", "privacy": "private" }, { "kind": "field", "name": "iconTrailing", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the icon affix alignment.", "privacy": "public", "inheritedFrom": { "name": "AffixIconWithTrailing", "module": "src/shared/patterns/affix.ts" } }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "A decorative icon the custom element should have. See the [Vivid Icon\nGallery](/icons/icons-gallery/) for available icons and `icon-name`s", "privacy": "public", "inheritedFrom": { "name": "AffixIcon", "module": "src/shared/patterns/affix.ts" } }, { "kind": "field", "name": "VIVID_VERSION", "static": true, "default": "__PACKAGE_VERSION__", "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `.constructor.VIVID_VERSION`.", "type": { "text": "string" }, "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } }, { "kind": "field", "name": "componentName", "type": { "text": "string" }, "static": true, "description": "Core component name, without prefix", "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Fires a custom 'change' event when the button is invoked", "name": "change" } ], "attributes": [ { "name": "heading-level", "type": { "text": "1 | 2 | 3 | 4 | 5 | 6" }, "default": "2", "description": "Configures the https://www.w3.org/TR/wai-aria-1.1/#aria-level | level of the\nheading element.", "fieldName": "headinglevel" }, { "name": "appearance", "type": { "text": "AccordionItemAppearance | undefined" }, "description": "The appearance the button should have.", "fieldName": "appearance" }, { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Expands or collapses the item.", "fieldName": "expanded" }, { "name": "id", "type": { "text": "string" }, "description": "The item ID", "fieldName": "id" }, { "name": "heading", "type": { "text": "string | undefined" }, "fieldName": "heading" }, { "name": "no-indicator", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether the accordion-item has indicator", "fieldName": "noIndicator" }, { "name": "meta", "type": { "text": "string | undefined" }, "fieldName": "meta" }, { "name": "size", "type": { "text": "AccordionItemSize | undefined" }, "description": "The size the accordion-item should have.", "fieldName": "size" }, { "name": "icon-trailing", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the icon affix alignment.", "fieldName": "iconTrailing", "inheritedFrom": { "name": "AffixIconWithTrailing", "module": "src/shared/patterns/affix.ts" } }, { "name": "icon", "type": { "text": "string | undefined" }, "description": "A decorative icon the custom element should have. See the [Vivid Icon\nGallery](/icons/icons-gallery/) for available icons and `icon-name`s", "fieldName": "icon", "inheritedFrom": { "name": "AffixIcon", "module": "src/shared/patterns/affix.ts" } } ], "mixins": [ { "name": "AffixIconWithTrailing", "module": "/src/shared/patterns/affix" } ], "superclass": { "name": "VividElement", "module": "/src/shared/foundation/vivid-element/vivid-element" }, "vividComponent": { "public": true, "name": "accordion-item" }, "vividTesting": { "selectors": [ { "name": "byHeading", "args": [ "byHeading" ] } ], "actions": [ { "name": "expand", "args": [ "toggleAccordionItem", "true" ] }, { "name": "collapse", "args": [ "toggleAccordionItem", "false" ] } ], "queries": [ { "name": "expanded", "args": [ "expanded", "true" ] }, { "name": "collapsed", "args": [ "expanded", "false" ] } ], "refs": [ { "name": "button", "args": [ "shadow", ".heading-button" ] } ] } } ], "exports": [ { "kind": "js", "name": "AccordionItem", "declaration": { "name": "AccordionItem", "module": "src/lib/accordion-item/accordion-item.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/accordion-item/definition.ts", "declarations": [ { "kind": "variable", "name": "registerAccordionItem", "description": "Registers the accordion item elements with the design system.", "parameters": [ { "description": "the prefix to use for the component name", "name": "prefix" } ] } ], "exports": [ { "kind": "js", "name": "registerAccordionItem", "declaration": { "name": "registerAccordionItem", "module": "src/lib/accordion-item/definition.ts" } }, { "kind": "js", "name": "VwcAccordionItemElement", "declaration": { "name": "AccordionItem", "module": "src/lib/accordion-item/definition.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/action-group/action-group.ts", "declarations": [ { "kind": "class", "description": "", "name": "ActionGroup", "cssProperties": [ { "name": "--vvd-action-group-accent-primary", "default": "var(--vvd-color-canvas-text)" }, { "name": "--vvd-action-group-accent-intermediate", "default": "var(--vvd-color-neutral-500)" }, { "name": "--vvd-action-group-accent-faint", "default": "var(--vvd-color-neutral-50)" } ], "slots": [ { "description": "Default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "shape", "type": { "text": "ActionGroupShape | undefined" }, "description": "Sets the element's border-radius", "privacy": "public" }, { "kind": "field", "name": "appearance", "type": { "text": "ActionGroupAppearance | undefined" }, "description": "Sets the element's appearance", "privacy": "public" }, { "kind": "field", "name": "tight", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether action group should have padding.", "privacy": "public" }, { "kind": "field", "name": "VIVID_VERSION", "static": true, "default": "__PACKAGE_VERSION__", "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `.constructor.VIVID_VERSION`.", "type": { "text": "string" }, "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } }, { "kind": "field", "name": "componentName", "type": { "text": "string" }, "static": true, "description": "Core component name, without prefix", "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } } ], "attributes": [ { "name": "shape", "type": { "text": "ActionGroupShape | undefined" }, "description": "Sets the element's border-radius", "fieldName": "shape" }, { "name": "appearance", "type": { "text": "ActionGroupAppearance | undefined" }, "description": "Sets the element's appearance", "fieldName": "appearance" }, { "name": "tight", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether action group should have padding.", "fieldName": "tight" } ], "mixins": [ { "name": "DelegatesAria", "module": "/src/shared/aria/delegates-aria" } ], "superclass": { "name": "VividElement", "module": "/src/shared/foundation/vivid-element/vivid-element" }, "vividComponent": { "public": true, "name": "action-group" } } ], "exports": [ { "kind": "js", "name": "ActionGroup", "declaration": { "name": "ActionGroup", "module": "src/lib/action-group/action-group.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/action-group/definition.ts", "declarations": [ { "kind": "variable", "name": "registerActionGroup", "description": "Registers the action-group elements with the design system.", "parameters": [ { "description": "the prefix to use for the component name", "name": "prefix" } ] } ], "exports": [ { "kind": "js", "name": "ActionGroupShape", "declaration": { "name": "ActionGroupShape", "module": "./action-group" } }, { "kind": "js", "name": "ActionGroupAppearance", "declaration": { "name": "ActionGroupAppearance", "module": "./action-group" } }, { "kind": "js", "name": "registerActionGroup", "declaration": { "name": "registerActionGroup", "module": "src/lib/action-group/definition.ts" } }, { "kind": "js", "name": "VwcActionGroupElement", "declaration": { "name": "ActionGroup", "module": "src/lib/action-group/definition.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/alert/alert.ts", "declarations": [ { "kind": "variable", "name": "CONNOTATION_ICON_MAP", "type": { "text": "{\n\t[Connotation.Accent]: 'megaphone-line',\n\t[Connotation.Information]: 'info-line',\n\t[Connotation.Success]: 'check-circle-line',\n\t[Connotation.Warning]: 'warning-line',\n\t[Connotation.Announcement]: 'sparkles-line',\n\t[Connotation.Alert]: 'error-line',\n}" }, "default": "{\n\t[Connotation.Accent]: 'megaphone-line',\n\t[Connotation.Information]: 'info-line',\n\t[Connotation.Success]: 'check-circle-line',\n\t[Connotation.Warning]: 'warning-line',\n\t[Connotation.Announcement]: 'sparkles-line',\n\t[Connotation.Alert]: 'error-line',\n}" }, { "kind": "class", "description": "", "name": "Alert", "cssProperties": [ { "name": "--vvd-alert-success-primary", "default": "var(--vvd-color-success-500)" }, { "name": "--vvd-alert-success-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-alert-information-primary", "default": "var(--vvd-color-information-500)" }, { "name": "--vvd-alert-information-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-alert-alert-primary", "default": "var(--vvd-color-alert-500)" }, { "name": "--vvd-alert-alert-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-alert-warning-primary", "default": "var(--vvd-color-warning-300)" }, { "name": "--vvd-alert-warning-primary-text", "default": "var(--vvd-color-canvas-text)" }, { "name": "--vvd-alert-announcement-primary", "default": "var(--vvd-color-announcement-500)" }, { "name": "--vvd-alert-announcement-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-alert-accent-primary", "default": "var(--vvd-color-canvas-text)" }, { "name": "--vvd-alert-accent-primary-text", "default": "var(--vvd-color-canvas)" } ], "slots": [ { "description": "The main content of the Alert.", "name": "main" }, { "description": "Add action items to the Alert using this slot.", "name": "action-items" }, { "description": "The preferred way to add an icon to the component.", "name": "icon" } ], "members": [ { "kind": "field", "name": "dismissButtonAriaLabel", "type": { "text": "| string\n\t\t| null" }, "default": "null", "description": "Allows setting a custom aria-label for the dismiss button.", "privacy": "public" }, { "kind": "field", "name": "#timeoutID", "privacy": "private", "type": { "text": "ReturnType | undefined" } }, { "kind": "field", "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Adds a close button to the Alert.", "privacy": "public" }, { "kind": "field", "name": "placement", "type": { "text": "AlertPlacement | undefined" }, "default": "'bottom'", "description": "The placement of the Alert on the screen.", "privacy": "public" }, { "kind": "field", "name": "headline", "type": { "text": "string | undefined" }, "description": "Adds a headline to the Alert.", "privacy": "public" }, { "kind": "field", "name": "text", "type": { "text": "string | undefined" }, "description": "The main text of the Alert.", "privacy": "public" }, { "kind": "field", "name": "timeoutms", "type": { "text": "number" }, "default": "0", "description": "Timeout after which the Alert will close.", "privacy": "public" }, { "kind": "field", "name": "connotation", "type": { "text": "AlertConnotation | undefined" }, "description": "Sets an appropriate icon / icon color for the connotation.", "privacy": "public" }, { "kind": "field", "name": "strategy", "type": { "text": "AlertStrategy | undefined" }, "description": "Controls the `position` of the Alert.", "privacy": "public" }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Open state of the Alert.", "privacy": "public" }, { "kind": "field", "name": "conditionedIcon", "readonly": true }, { "kind": "method", "name": "#setupTimeout" }, { "kind": "field", "name": "#closeOnEscape", "privacy": "private" }, { "kind": "field", "name": "#onTransitionEnd", "privacy": "private" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "A decorative icon the custom element should have. See the [Vivid Icon\nGallery](/icons/icons-gallery/) for available icons and `icon-name`s", "privacy": "public", "inheritedFrom": { "name": "AffixIcon", "module": "src/shared/patterns/affix.ts" } }, { "kind": "field", "name": "VIVID_VERSION", "static": true, "default": "__PACKAGE_VERSION__", "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `.constructor.VIVID_VERSION`.", "type": { "text": "string" }, "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } }, { "kind": "field", "name": "componentName", "type": { "text": "string" }, "static": true, "description": "Core component name, without prefix", "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Fired when the Alert is opened", "name": "open" }, { "type": { "text": "CustomEvent" }, "description": "Fired when the Alert is closed", "name": "close" } ], "attributes": [ { "name": "dismiss-button-aria-label", "type": { "text": "| string\n\t\t| null" }, "default": "null", "description": "Allows setting a custom aria-label for the dismiss button.", "fieldName": "dismissButtonAriaLabel" }, { "name": "removable", "type": { "text": "boolean" }, "default": "false", "description": "Adds a close button to the Alert.", "fieldName": "removable" }, { "name": "placement", "type": { "text": "AlertPlacement | undefined" }, "default": "'bottom'", "description": "The placement of the Alert on the screen.", "fieldName": "placement" }, { "name": "headline", "type": { "text": "string | undefined" }, "description": "Adds a headline to the Alert.", "fieldName": "headline" }, { "name": "text", "type": { "text": "string | undefined" }, "description": "The main text of the Alert.", "fieldName": "text" }, { "name": "timeoutms", "type": { "text": "number" }, "default": "0", "description": "Timeout after which the Alert will close.", "fieldName": "timeoutms" }, { "name": "connotation", "type": { "text": "AlertConnotation | undefined" }, "description": "Sets an appropriate icon / icon color for the connotation.", "fieldName": "connotation" }, { "name": "strategy", "type": { "text": "AlertStrategy | undefined" }, "description": "Controls the `position` of the Alert.", "fieldName": "strategy" }, { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Open state of the Alert.", "fieldName": "open" }, { "name": "icon", "type": { "text": "string | undefined" }, "description": "A decorative icon the custom element should have. See the [Vivid Icon\nGallery](/icons/icons-gallery/) for available icons and `icon-name`s", "fieldName": "icon", "inheritedFrom": { "name": "AffixIcon", "module": "src/shared/patterns/affix.ts" } } ], "mixins": [ { "name": "AffixIcon", "module": "/src/shared/patterns/affix" }, { "name": "Localized", "module": "/src/shared/patterns" } ], "superclass": { "name": "VividElement", "module": "/src/shared/foundation/vivid-element/vivid-element" }, "vividComponent": { "public": true, "name": "alert" }, "vividTesting": { "selectors": [ { "name": "byHeadline", "args": [ "byHeadline" ] } ], "actions": [], "queries": [ { "name": "open", "args": [ "open", "true" ] }, { "name": "closed", "args": [ "open", "false" ] } ], "refs": [] } } ], "exports": [ { "kind": "js", "name": "CONNOTATION_ICON_MAP", "declaration": { "name": "CONNOTATION_ICON_MAP", "module": "src/lib/alert/alert.ts" } }, { "kind": "js", "name": "Alert", "declaration": { "name": "Alert", "module": "src/lib/alert/alert.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/alert/definition.ts", "declarations": [ { "kind": "variable", "name": "registerAlert", "description": "Registers the alert elements with the design system.", "parameters": [ { "description": "the prefix to use for the component name", "name": "prefix" } ] } ], "exports": [ { "kind": "js", "name": "AlertConnotation", "declaration": { "name": "AlertConnotation", "module": "./alert" } }, { "kind": "js", "name": "registerAlert", "declaration": { "name": "registerAlert", "module": "src/lib/alert/definition.ts" } }, { "kind": "js", "name": "VwcAlertElement", "declaration": { "name": "Alert", "module": "src/lib/alert/definition.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/alert/locale.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/lib/audio-player/audio-player.ts", "declarations": [ { "kind": "variable", "name": "SKIP_DIRECTIONS", "type": { "text": "object" }, "default": "{\n\tFORWARD: 1,\n\tBACKWARD: -1,\n}" }, { "kind": "function", "name": "formatTime", "parameters": [ { "name": "time", "type": { "text": "number" } } ] }, { "kind": "class", "description": "", "name": "AudioPlayer", "members": [ { "kind": "field", "name": "playButtonAriaLabel", "type": { "text": "| string\n\t\t| null" }, "default": "null" }, { "kind": "field", "name": "pauseButtonAriaLabel", "type": { "text": "| string\n\t\t| null" }, "default": "null" }, { "kind": "field", "name": "sliderAriaLabel", "type": { "text": "string | null" }, "default": "null" }, { "kind": "field", "name": "skipForwardButtonAriaLabel", "type": { "text": "| string\n\t\t| null" }, "default": "null" }, { "kind": "field", "name": "skipBackwardButtonAriaLabel", "type": { "text": "| string\n\t\t| null" }, "default": "null" }, { "kind": "field", "name": "connotation", "type": { "text": "AudioPlayerConnotation | undefined" }, "description": "Sets the color of the audio player", "privacy": "public" }, { "kind": "field", "name": "src", "type": { "text": "string | undefined" }, "description": "Sets the audio source URL", "privacy": "public" }, { "kind": "method", "name": "revokeSrc", "privacy": "private" }, { "kind": "method", "name": "getCurrentSrc", "privacy": "private", "return": { "type": { "text": "string" } } }, { "kind": "method", "name": "canPlayType", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "type", "type": { "text": "string" } } ] }, { "kind": "method", "name": "setSrc", "privacy": "private", "parameters": [ { "name": "url", "type": { "text": "string" } }, { "name": "blob", "optional": true, "type": { "text": "Blob" } } ] }, { "kind": "field", "name": "playbackRate" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Sets the disabled state of the audio player", "privacy": "public" }, { "kind": "field", "name": "notime", "type": { "text": "boolean" }, "default": "false", "description": "Hides the time stamp", "privacy": "public" }, { "kind": "field", "name": "skipBy", "type": { "text": "AudioPlayerMediaSkipBy | undefined" }, "description": "Allows the audio to skip back or forward", "privacy": "public" }, { "kind": "field", "name": "playbackRates", "type": { "text": "string | null" }, "default": "null", "description": "Comma-separated string of numbers to define playback speeds", "privacy": "public" }, { "kind": "field", "name": "paused", "type": { "text": "boolean" } }, { "kind": "field", "name": "#audioBuffer", "privacy": "private", "type": { "text": "AudioBuffer | undefined" } }, { "kind": "field", "name": "#fetchAbortController", "privacy": "private", "type": { "text": "AbortController | undefined" } }, { "kind": "method", "name": "#fetchAndCacheAudioBuffer", "async": true }, { "kind": "field", "name": "duration" }, { "kind": "field", "name": "currentTime" }, { "kind": "field", "name": "#sliderEl", "privacy": "private", "type": { "text": "Slider | null" }, "readonly": true }, { "kind": "field", "name": "#playerEl", "privacy": "private", "default": "new Audio()" }, { "kind": "field", "name": "#isProgrammaticSliderUpdate", "privacy": "private", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "durationFallback", "type": { "text": "boolean" }, "default": "false", "description": "Enables fallback logic to fetch and decode audio buffer for duration when metadata is missing.", "privacy": "public" }, { "kind": "method", "name": "play" }, { "kind": "method", "name": "pause" }, { "kind": "field", "name": "#onPlay", "privacy": "private" }, { "kind": "field", "name": "#onPause", "privacy": "private" }, { "kind": "method", "name": "#setSliderInteractionListeners", "parameters": [ { "name": "add", "default": "true" } ] }, { "kind": "field", "name": "#pausedChanged", "privacy": "private" }, { "kind": "field", "name": "#updateProgress", "privacy": "private" }, { "kind": "field", "name": "#updateTotalTime", "privacy": "private" }, { "kind": "field", "name": "#dragInterval", "privacy": "private", "type": { "text": "number | undefined" } }, { "kind": "field", "name": "#updateCurrentTimeOnSliderChange", "privacy": "private" }, { "kind": "field", "name": "#setPausedState", "privacy": "private" }, { "kind": "field", "name": "VIVID_VERSION", "static": true, "default": "__PACKAGE_VERSION__", "description": "The current version of the Vivid library, which is useful for debugging.\nIt can be accessed from any Vivid element via `.constructor.VIVID_VERSION`.", "type": { "text": "string" }, "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } }, { "kind": "field", "name": "componentName", "type": { "text": "string" }, "static": true, "description": "Core component name, without prefix", "inheritedFrom": { "name": "VividElement", "module": "src/shared/foundation/vivid-element/vivid-element.ts" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Fires when the audio playback is started.", "name": "play" }, { "type": { "text": "CustomEvent" }, "description": "Fires when the audio playback is paused.", "name": "pause" } ], "attributes": [ { "name": "play-button-aria-label", "type": { "text": "| string\n\t\t| null" }, "default": "null", "fieldName": "playButtonAriaLabel" }, { "name": "pause-button-aria-label", "type": { "text": "| string\n\t\t| null" }, "default": "null", "fieldName": "pauseButtonAriaLabel" }, { "name": "slider-aria-label", "type": { "text": "string | null" }, "default": "null", "fieldName": "sliderAriaLabel" }, { "name": "skip-forward-aria-label", "type": { "text": "| string\n\t\t| null" }, "default": "null", "fieldName": "skipForwardButtonAriaLabel" }, { "name": "skip-backward-aria-label", "type": { "text": "| string\n\t\t| null" }, "default": "null", "fieldName": "skipBackwardButtonAriaLabel" }, { "name": "connotation", "type": { "text": "AudioPlayerConnotation | undefined" }, "description": "Sets the color of the audio player", "fieldName": "connotation" }, { "name": "src", "type": { "text": "string | undefined" }, "description": "Sets the audio source URL", "fieldName": "src" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Sets the disabled state of the audio player", "fieldName": "disabled" }, { "name": "notime", "type": { "text": "boolean" }, "default": "false", "description": "Hides the time stamp", "fieldName": "notime" }, { "name": "skip-by", "type": { "text": "AudioPlayerMediaSkipBy | undefined" }, "description": "Allows the audio to skip back or forward", "fieldName": "skipBy" }, { "name": "playback-rates", "type": { "text": "string | null" }, "default": "null", "description": "Comma-separated string of numbers to define playback speeds", "fieldName": "playbackRates" }, { "name": "duration-fallback", "type": { "text": "boolean" }, "default": "false", "description": "Enables fallback logic to fetch and decode audio buffer for duration when metadata is missing.", "fieldName": "durationFallback" } ], "mixins": [ { "name": "Localized", "module": "/src/shared/patterns" } ], "superclass": { "name": "VividElement", "module": "/src/shared/foundation/vivid-element/vivid-element" }, "vividComponent": { "public": true, "name": "audio-player" } } ], "exports": [ { "kind": "js", "name": "SKIP_DIRECTIONS", "declaration": { "name": "SKIP_DIRECTIONS", "module": "src/lib/audio-player/audio-player.ts" } }, { "kind": "js", "name": "formatTime", "declaration": { "name": "formatTime", "module": "src/lib/audio-player/audio-player.ts" } }, { "kind": "js", "name": "AudioPlayer", "declaration": { "name": "AudioPlayer", "module": "src/lib/audio-player/audio-player.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/audio-player/definition.ts", "declarations": [ { "kind": "variable", "name": "registerAudioPlayer", "description": "Registers the audio-player element with the design system.", "parameters": [ { "description": "the prefix to use for the component name", "name": "prefix" } ] } ], "exports": [ { "kind": "js", "name": "AudioPlayerConnotation", "declaration": { "name": "AudioPlayerConnotation", "module": "./audio-player" } }, { "kind": "js", "name": "registerAudioPlayer", "declaration": { "name": "registerAudioPlayer", "module": "src/lib/audio-player/definition.ts" } }, { "kind": "js", "name": "VwcAudioPlayerElement", "declaration": { "name": "AudioPlayer", "module": "src/lib/audio-player/definition.ts" } } ] }, { "kind": "javascript-module", "path": "src/lib/audio-player/locale.ts", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "src/lib/avatar/avatar.ts", "declarations": [ { "kind": "class", "description": "", "name": "Avatar", "cssProperties": [ { "name": "--vvd-avatar-cta-primary", "default": "var(--vvd-color-cta-500)" }, { "name": "--vvd-avatar-cta-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-avatar-cta-firm", "default": "var(--vvd-color-cta-600)" }, { "name": "--vvd-avatar-cta-firm-all", "default": "var(--vvd-color-cta-600)" }, { "name": "--vvd-avatar-cta-fierce", "default": "var(--vvd-color-cta-700)" }, { "name": "--vvd-avatar-cta-pale", "default": "var(--vvd-color-cta-300)" }, { "name": "--vvd-avatar-cta-soft", "default": "var(--vvd-color-cta-100)" }, { "name": "--vvd-avatar-cta-contrast", "default": "var(--vvd-color-cta-800)" }, { "name": "--vvd-avatar-accent-primary", "default": "var(--vvd-color-canvas-text)" }, { "name": "--vvd-avatar-accent-primary-text", "default": "var(--vvd-color-canvas)" }, { "name": "--vvd-avatar-accent-firm", "default": "var(--vvd-color-canvas-text)" }, { "name": "--vvd-avatar-accent-firm-all", "default": "var(--vvd-color-neutral-600)" }, { "name": "--vvd-avatar-accent-fierce", "default": "var(--vvd-color-neutral-700)" }, { "name": "--vvd-avatar-accent-pale", "default": "var(--vvd-color-neutral-300)" }, { "name": "--vvd-avatar-accent-soft", "default": "var(--vvd-color-neutral-100)" }, { "name": "--vvd-avatar-accent-contrast", "default": "var(--vvd-color-neutral-800)" } ], "slots": [ { "description": "Assign nodes to the graphic slot to set a graphic media of any kind (e.g. image, illustration etc).", "name": "graphic" }, { "description": "The preferred way to add an icon to the component.", "name": "icon" } ], "members": [ { "kind": "field", "name": "connotation", "type": { "text": "AvatarConnotation | undefined" }, "description": "Sets the element's connotation", "privacy": "public" }, { "kind": "field", "name": "shape", "type": { "text": "AvatarShape | undefined" }, "description": "Sets the element's shape", "privacy": "public" }, { "kind": "field", "name": "appearance", "type": { "text": "AvatarAppearance | undefined" }, "description": "Sets the element's appearance", "privacy": "public" }, { "kind": "field", "name": "size", "type": { "text": "AvatarSize | undefined" }, "description": "Sets the element's size", "privacy": "public" }, { "kind": "field", "name": "icon", "type": { "text": "string | undefined" }, "description": "Sets the element's icon", "privacy": "public" }, { "kind": "field", "name": "initials", "type": { "text": "string | undefined" }, "description": "Sets the initials on the Avatar", "privacy": "public" }, { "kind": "field", "name": "clickable", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether avatar should be a clickable