wj-elements
Version:
WebJET Elements is a modern set of user interface tools harnessing the power of web components designed to simplify web application development.
1,532 lines (1,531 loc) • 825 kB
JSON
{
"schemaVersion": "1.0.0",
"readme": "",
"modules": [
{
"kind": "javascript-module",
"path": "packages/wje-accordion/accordion.element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "Accordion",
"slots": [
{
"description": "Slot for direct `wje-accordion-item` children.",
"name": "default"
}
],
"members": [
{
"kind": "field",
"name": "multiple",
"description": "Determines whether the element has the `multiple` attribute.",
"parameters": [
{
"description": "A boolean value indicating whether the element should support multiple selections.",
"name": "value",
"type": {
"text": "boolean"
}
}
],
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "field",
"name": "index",
"description": "Retrieves the value of the `index` attribute as a number.",
"parameters": [
{
"description": "The value to set for the `index` attribute.",
"name": "value",
"type": {
"text": "number|string"
}
}
],
"return": {
"type": {
"text": "number"
}
}
},
{
"kind": "field",
"name": "className",
"type": {
"text": "string"
},
"default": "'Accordion'",
"description": "The class name for the Accordion element."
},
{
"kind": "field",
"name": "cssStyleSheet",
"static": true,
"description": "Getter for the CSS stylesheet.",
"return": {
"type": {
"text": "object"
}
},
"readonly": true
},
{
"kind": "method",
"name": "setupAttributes",
"description": "Method to setup attributes for the Accordion element."
},
{
"kind": "method",
"name": "beforeDraw",
"description": "Method to run before the element is drawn."
},
{
"kind": "method",
"name": "draw",
"description": "Method to draw the Accordion element.",
"return": {
"type": {
"text": "object"
}
}
},
{
"kind": "method",
"name": "afterDraw",
"description": "Method to run after the element is drawn."
},
{
"kind": "method",
"name": "collapseAll",
"parameters": [
{
"name": "exception"
}
],
"description": "Method to run after the element is drawn."
},
{
"kind": "method",
"name": "getAccordions",
"description": "Method to get the accordions.",
"return": {
"type": {
"text": "Array"
}
}
}
],
"attributes": [
{
"type": {
"text": "boolean"
},
"description": "Allows multiple accordion items to stay expanded at the same time.",
"name": "multiple"
},
{
"type": {
"text": "number"
},
"description": "Sets which child accordion item should start expanded based on DOM order.",
"name": "index"
}
],
"superclass": {
"name": "WJElement",
"module": "/packages/wje-element/element.js"
},
"tagName": "wje-accordion",
"summary": "This class represents an Accordion element, extending the WJElement class.",
"documentation": "https://elements.webjet.sk/components/accordion",
"status": "stable",
"tagNameWithoutPrefix": "accordion",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "Accordion",
"module": "packages/wje-accordion/accordion.element.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "packages/wje-accordion-item/accordion-item.element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "AccordionItem",
"cssProperties": [
{
"description": "Background color of the collapsed item wrapper.",
"name": "--wje-accordion-background",
"default": "var(--wje-color-contrast-0)"
},
{
"description": "Border color of the collapsed item wrapper.",
"name": "--wje-accordion-border",
"default": "var(--wje-color-contrast-0)"
},
{
"description": "Border radius of the item wrapper.",
"name": "--wje-accordion-border-radius",
"default": "var(--wje-border-radius-large)"
},
{
"description": "Background color used when the headline is hovered.",
"name": "--wje-accordion-background-hover",
"default": "var(--wje-color-contrast-1)"
},
{
"description": "Border color used when the headline is hovered.",
"name": "--wje-accordion-border-hover",
"default": "var(--wje-color-contrast-2)"
},
{
"description": "Background color of the expanded item wrapper.",
"name": "--wje-accordion-background-expanded",
"default": "var(--wje-color-contrast-0)"
},
{
"description": "Border color of the expanded item wrapper.",
"name": "--wje-accordion-border-expanded",
"default": "var(--wje-color-contrast-0)"
},
{
"description": "Text color of the headline area.",
"name": "--wje-accordion-headline-color",
"default": "var(--wje-color-contrast-11)"
},
{
"description": "Text color of the expandable content area.",
"name": "--wje-accordion-content-color",
"default": "var(--wje-color-contrast-6)"
},
{
"description": "Rotation applied to the toggle marker icon. // @fires wje-accordion-item:open - Dispatched when the item is expanded. // @fires wje-accordion-item:close - Dispatched when the item is collapsed.",
"name": "--wje-accordion-marker-rotate",
"default": "0deg"
}
],
"cssParts": [
{
"description": "The wrapper of the whole accordion item.",
"name": "native"
},
{
"description": "The clickable headline area.",
"name": "headline"
},
{
"description": "The description slot container inside the headline.",
"name": "description"
},
{
"description": "The toggle slot container and fallback chevron area.",
"name": "toggle"
},
{
"description": "The expandable content panel.",
"name": "content"
}
],
"slots": [
{
"description": "Slot for the clickable accordion headline content.",
"name": "headline"
},
{
"description": "Slot for supporting text shown below the headline.",
"name": "description"
},
{
"description": "Slot for a custom toggle icon or toggle content.",
"name": "toggle"
},
{
"description": "Slot for the expandable panel body.",
"name": "content"
}
],
"members": [
{
"kind": "field",
"name": "_instanceId",
"type": {
"text": "number"
},
"static": true,
"default": "++AccordionItem._instanceId"
},
{
"kind": "field",
"name": "className",
"type": {
"text": "string"
},
"default": "'AccordionItem'",
"description": "The class name for the Accordion Item element."
},
{
"kind": "field",
"name": "cssStyleSheet",
"static": true,
"description": "Getter for the CSS stylesheet.",
"return": {
"type": {
"text": "object"
}
},
"readonly": true
},
{
"kind": "method",
"name": "setupAttributes",
"description": "Method to setup attributes for the Accordion Item element."
},
{
"kind": "method",
"name": "draw",
"description": "Method to draw the Accordion Item element. This method returns a document fragment containing the drawn element.",
"return": {
"type": {
"text": "object"
}
}
},
{
"kind": "method",
"name": "afterDraw",
"description": "Method to execute after the Accordion Item element is drawn."
},
{
"kind": "method",
"name": "collapse",
"description": "Collapses the accordion item and updates the headline ARIA state."
},
{
"kind": "method",
"name": "expand",
"description": "Expands the accordion item and updates the headline ARIA state."
}
],
"attributes": [
{
"type": {
"text": "string"
},
"description": "Applies a contextual color variant such as `primary`, `success`, `danger`, `warning`, `info`, or `complete`.",
"name": "color"
}
],
"superclass": {
"name": "WJElement",
"module": "/packages/wje-element/element.js"
},
"tagName": "wje-accordion-item",
"summary": "This class represents an Accordion Item element, extending the WJElement class.",
"documentation": "https://elements.webjet.sk/components/accordion-item",
"status": "stable",
"tagNameWithoutPrefix": "accordion-item",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "AccordionItem",
"module": "packages/wje-accordion-item/accordion-item.element.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "packages/wje-animation/animation.element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "Animation",
"slots": [
{
"description": "The animation main content.",
"name": ""
}
],
"members": [
{
"kind": "field",
"name": "name",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "duration",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "number"
}
}
},
{
"kind": "field",
"name": "delay",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "number"
}
}
},
{
"kind": "field",
"name": "endDelay",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "number"
}
}
},
{
"kind": "field",
"name": "fill",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "iterations",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "string|number"
}
}
},
{
"kind": "field",
"name": "iterationStart",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "number"
}
}
},
{
"kind": "field",
"name": "direction",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "easing",
"description": "Getter for the name attribute.",
"parameters": [
{
"name": "value"
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "animations",
"description": "Getter for the animations' property.",
"parameters": [
{
"description": "The new value for the animations property.",
"name": "value",
"type": {
"text": "Array"
}
}
],
"return": {
"type": {
"text": "Array"
}
}
},
{
"kind": "field",
"name": "className",
"type": {
"text": "string"
},
"default": "'Animation'",
"description": "The class name for the Animation element."
},
{
"kind": "field",
"name": "cssStyleSheet",
"static": true,
"description": "Getter for the CSS stylesheet.",
"return": {
"type": {
"text": "object"
}
},
"readonly": true
},
{
"kind": "method",
"name": "setupAttributes",
"description": "Method to setup attributes for the Animation element."
},
{
"kind": "method",
"name": "draw",
"description": "Method to draw the Animation element.",
"return": {
"type": {
"text": "object"
}
}
},
{
"kind": "method",
"name": "afterDraw",
"description": "Method to perform actions after the Animation element is drawn.\nThis method destroys any existing animation, fetches a new animations array,\nselects the appropriate animation, and applies it to the element."
},
{
"kind": "method",
"name": "getAnimationsArray",
"description": "Method to fetch and parse the animations array from a CSS file.",
"return": {
"type": {
"text": "Array"
}
}
},
{
"kind": "method",
"name": "destroyAnimation",
"description": "Terminates and cleans up the currently active animation if it exists.\nCalls the `cancel` method to stop the animation process.",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "play",
"description": "Plays the currently assigned animation, if available.",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "method",
"name": "cancel",
"description": "Cancels the current animation if it is initialized and has a cancel method.\nLogs a warning if the animation is not initialized or the cancel method is unavailable.",
"return": {
"type": {
"text": "void"
}
}
},
{
"kind": "field",
"name": "_animations",
"type": {
"text": "array"
},
"default": "[]"
}
],
"attributes": [
{
"type": {
"text": "string"
},
"description": "The Animate.css animation name played on the slotted element.",
"name": "name"
},
{
"type": {
"text": "number"
},
"description": "The animation playback duration in milliseconds.",
"name": "duration"
},
{
"type": {
"text": "number"
},
"description": "The delay before the animation starts.",
"name": "delay"
},
{
"type": {
"text": "number"
},
"description": "The delay applied after the animation completes.",
"name": "endDelay"
},
{
"type": {
"text": "string"
},
"description": "The fill mode used by the animation playback.",
"name": "fill"
},
{
"type": {
"text": "string|number"
},
"description": "The number of animation repetitions.",
"name": "iterations"
},
{
"type": {
"text": "number"
},
"description": "The starting offset for the first animation iteration.",
"name": "iterationStart"
},
{
"type": {
"text": "string"
},
"description": "The playback direction of the animation.",
"name": "direction"
},
{
"type": {
"text": "string"
},
"description": "The easing function used by the animation playback.",
"name": "easing"
}
],
"superclass": {
"name": "WJElement",
"module": "/packages/wje-element/element.js"
},
"tagName": "wje-animation",
"summary": "This class represents an Animation element, extending the WJElement class.",
"documentation": "https://elements.webjet.sk/components/animation",
"status": "stable",
"tagNameWithoutPrefix": "animation",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "Animation",
"module": "packages/wje-animation/animation.element.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "packages/wje-aside/aside.element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "Aside",
"cssProperties": [
{
"description": "Controls the width of the aside column.",
"name": "--wje-aside-width"
},
{
"description": "Controls the top offset of a fixed aside.",
"name": "--wje-aside-top"
},
{
"description": "Controls the border color of the aside.",
"name": "--wje-aside-border-color",
"default": "var(--wje-border-color)"
},
{
"description": "Controls the border width of the aside.",
"name": "--wje-aside-border-width"
},
{
"description": "Controls the border style of the aside.",
"name": "--wje-aside-border-style"
}
],
"slots": [
{
"description": "Slot for the aside content.",
"name": "default"
}
],
"members": [
{
"kind": "field",
"name": "className",
"type": {
"text": "string"
},
"default": "'Aside'",
"description": "The class name for the Aside element."
},
{
"kind": "field",
"name": "cssStyleSheet",
"static": true,
"description": "Getter for the CSS stylesheet.",
"return": {
"type": {
"text": "object"
}
},
"readonly": true
},
{
"kind": "method",
"name": "setupAttributes",
"description": "Method to setup attributes for the Aside element."
},
{
"kind": "method",
"name": "draw",
"description": "Method to draw the Aside element.",
"return": {
"type": {
"text": "object"
}
}
}
],
"attributes": [
{
"type": {
"text": "string"
},
"description": "Sets the width of the aside column, typically through a CSS length or design token.",
"name": "width"
},
{
"type": {
"text": "string"
},
"description": "Sets the top offset used together with the `fixed` layout mode.",
"name": "top"
},
{
"type": {
"text": "boolean"
},
"description": "Pins the aside in a fixed desktop position instead of keeping it in normal flow.",
"name": "fixed"
},
{
"type": {
"text": "string"
},
"description": "Selects an alternate layout variant such as the mobile `top-start` drawer style.",
"name": "variant"
}
],
"superclass": {
"name": "WJElement",
"module": "/packages/wje-element/element.js"
},
"tagName": "wje-aside",
"summary": "This class represents an Aside element, extending the WJElement class.",
"documentation": "https://elements.webjet.sk/components/aside",
"status": "stable",
"tagNameWithoutPrefix": "aside",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "Aside",
"module": "packages/wje-aside/aside.element.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "packages/wje-avatar/avatar.element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "Avatar",
"cssProperties": [
{
"description": "Controls the overall rendered size of the avatar shell.",
"name": "--wje-avatar-size"
},
{
"description": "Controls the font size used for initials and text content.",
"name": "--wje-avatar-font-size"
},
{
"description": "Controls the font weight used for initials and text content.",
"name": "--wje-avatar-font-weight"
},
{
"description": "Controls the text color inside the avatar.",
"name": "--wje-avatar-color"
},
{
"description": "Controls the background color of the avatar surface.",
"name": "--wje-avatar-background-color"
},
{
"description": "Controls the avatar border radius.",
"name": "--wje-avatar-border-radius"
},
{
"description": "Controls the avatar border color when a border is applied.",
"name": "--wje-avatar-border-color"
},
{
"description": "Controls the avatar border width when a border is applied.",
"name": "--wje-avatar-border-width"
},
{
"description": "Controls the avatar border style when a border is applied.",
"name": "--wje-avatar-border-style"
}
],
"cssParts": [
{
"description": "The component's native wrapper.",
"name": "native"
},
{
"description": "The positioned slot container for status content.",
"name": "status"
},
{
"description": "The slot container for secondary avatar content.",
"name": "secondary"
}
],
"slots": [
{
"description": "Slot for the main avatar content, typically an image.",
"name": "default"
},
{
"description": "Slot for an icon rendered inside the avatar.",
"name": "icon"
},
{
"description": "Slot for a status badge or indicator positioned on the avatar edge.",
"name": "status"
},
{
"description": "Slot for additional secondary content rendered with the avatar.",
"name": "secondary"
}
],
"members": [
{
"kind": "field",
"name": "label",
"description": "Retrieves the value of the 'label' attribute for the element.\nIf the attribute is not set, it defaults to an empty string.",
"parameters": [
{
"description": "The new value to be set for the 'label' attribute.",
"name": "value",
"type": {
"text": "string"
}
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "initials",
"description": "Retrieves the value of the 'initials' attribute if it exists.",
"parameters": [
{
"description": "The value to be set as the initials.",
"name": "value",
"type": {
"text": "string"
}
}
],
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "field",
"name": "size",
"description": "Retrieves the size attribute of the element. If the size attribute\nis not defined, it returns the default value 'medium'.",
"parameters": [
{
"description": "The value to set for the size attribute.",
"name": "value",
"type": {
"text": "string | number"
}
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "className",
"type": {
"text": "string"
},
"default": "'Avatar'",
"description": "Class name for the Avatar element."
},
{
"kind": "field",
"name": "cssStyleSheet",
"static": true,
"description": "Getter for cssStyleSheet.",
"return": {
"type": {
"text": "string"
}
},
"readonly": true
},
{
"kind": "method",
"name": "setupAttributes",
"description": "Method to setup attributes."
},
{
"kind": "method",
"name": "draw",
"description": "Method to draw the avatar element and return a document fragment.",
"return": {
"type": {
"text": "object"
}
}
},
{
"kind": "method",
"name": "syncAria",
"description": "Syncs ARIA attributes on the host element."
},
{
"kind": "method",
"name": "isImage",
"description": "Method to check if the avatar is an image.",
"return": {
"type": {
"text": "boolean"
}
}
}
],
"attributes": [
{
"name": "initials",
"type": {
"text": "boolean"
},
"description": "Renders generated initials from `label` instead of the default slotted content."
},
{
"name": "label",
"type": {
"text": "string"
},
"description": "Provides the source text for generated initials and the accessible label of the avatar."
},
{
"type": {
"text": "string"
},
"description": "Selects a predefined avatar size such as `small`, `medium`, `normal`, `large`, or larger variants.",
"name": "size"
},
{
"type": {
"text": "string"
},
"description": "Positions the `status` slot on one of the avatar corners.",
"name": "status-placement"
}
],
"superclass": {
"name": "WJElement",
"module": "/packages/wje-element/element.js"
},
"tagName": "wje-avatar",
"summary": "This class represents an Avatar element, extending the WJElement class.",
"documentation": "https://elements.webjet.sk/components/avatar",
"status": "stable",
"tagNameWithoutPrefix": "avatar",
"customElement": true
}
],
"exports": [
{
"kind": "js",
"name": "default",
"declaration": {
"name": "Avatar",
"module": "packages/wje-avatar/avatar.element.js"
}
}
]
},
{
"kind": "javascript-module",
"path": "packages/wje-breadcrumb/breadcrumb.element.js",
"declarations": [
{
"kind": "class",
"description": "",
"name": "Breadcrumb",
"cssProperties": [
{
"description": "The color of the breadcrumb text.",
"name": "--wje-breadcrumb-a",
"default": "var(--wje-color-contrast-8)"
},
{
"description": "The color of the breadcrumb separator line.",
"name": "--wje-breadcrumb-a-hover",
"default": "var(--wje-color-contrast-6)"
},
{
"description": "Controls the vertical rhythm of breadcrumb text.",
"name": "--wje-breadcrumb-line-height",
"default": "1.5"
},
{
"description": "Controls the line height of the native breadcrumb wrapper.",
"name": "--wje-breadcrumb-native-line-height",
"default": "var(--wje-breadcrumb-line-height)"
},
{
"description": "Sets outer spacing around the native breadcrumb wrapper.",
"name": "--wje-breadcrumb-native-margin",
"default": "0"
},
{
"description": "Sets inner spacing inside the native breadcrumb wrapper.",
"name": "--wje-breadcrumb-native-padding",
"default": "0.25rem 0.75rem"
},
{
"description": "Backwards-compatible alias for native breadcrumb margin.",
"name": "--wje-breadcrumb-margin",
"default": "var(--wje-breadcrumb-native-margin)"
},
{
"description": "Backwards-compatible alias for native breadcrumb padding.",
"name": "--wje-breadcrumb-padding",
"default": "var(--wje-breadcrumb-native-padding)"
}
],
"cssParts": [
{
"description": "The native wrapper of the breadcrumb component.",
"name": "native"
},
{
"description": "The separator between breadcrumb items.",
"name": "separator"
}
],
"slots": [
{
"description": "The main content of the breadcrumb.",
"name": ""
},
{
"description": "Slot for content at the start of the breadcrumb.",
"name": "start"
},
{
"description": "Slot for content at the end of the breadcrumb.",
"name": "end"
},
{
"description": "Slot for a custom separator between breadcrumb items.",
"name": "separator"
}
],
"members": [
{
"kind": "field",
"name": "href",
"description": "Gets the breadcrumb link URL.",
"parameters": [
{
"description": "Link URL.",
"name": "value",
"type": {
"text": "string|null"
}
}
],
"return": {
"type": {
"text": "string|null"
}
}
},
{
"kind": "field",
"name": "disabled",
"description": "Gets the disabled state.",
"parameters": [
{
"description": "Disabled state.",
"name": "value",
"type": {
"text": "boolean"
}
}
],
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "field",
"name": "showSeparator",
"description": "Set show separator flag.",
"return": {
"type": {
"text": "boolean"
}
},
"parameters": [
{
"description": "The value to set",
"name": "value",
"type": {
"text": "boolean"
}
}
]
},
{
"kind": "field",
"name": "collapsedVariant",
"description": "Get collapsed variant.",
"parameters": [
{
"description": "The value to set",
"name": "value",
"type": {
"text": "string"
}
}
],
"return": {
"type": {
"text": "string"
}
}
},
{
"kind": "field",
"name": "collapsedVariantName",
"description": "Get collapsed variant token.",
"return": {
"type": {
"text": "string"
}
},
"readonly": true
},
{
"kind": "field",
"name": "className",
"type": {
"text": "string"
},
"default": "'Breadcrumb'",
"description": "Class name for the Breadcrumb element."
},
{
"kind": "field",
"name": "cssStyleSheet",
"static": true,
"description": "Get CSS stylesheet for the Breadcrumb element.",
"return": {
"type": {
"text": "object"
}
},
"readonly": true
},
{
"kind": "method",
"name": "setupAttributes",
"description": "Setup attributes for the Breadcrumb element."
},
{
"kind": "method",
"name": "syncAria"
},
{
"kind": "method",
"name": "draw",
"description": "Draw method for the Breadcrumb element.",
"return": {
"type": {
"text": "object"
}
}
},
{
"kind": "method",
"name": "shouldRenderSeparator",
"description": "Returns whether the separator should be visible after this breadcrumb.",
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "method",
"name": "hasVisibleBreadcrumbAfter",
"description": "Returns whether any later breadcrumb is still visible in the rendered trail.",
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "method",
"name": "isBreadcrumbVisibleInTrail",
"parameters": [
{
"name": "breadcrumb",
"description": "Breadcrumb element to inspect.",
"type": {
"text": "Element"
}
}
],
"description": "Returns whether a breadcrumb is visible in the rendered trail.",
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "method",
"name": "syncNativeAttributes",
"description": "Synchronizes host attributes to the internal anchor."
},
{
"kind": "method",
"name": "afterDraw",
"description": "Sets up native anchor listeners after render."
},
{
"kind": "method",
"name": "beforeDisconnect",
"description": "Removes native anchor listeners before redraw/disconnect."
},
{
"kind": "method",
"name": "handleDisabledNativeClick",
"parameters": [
{
"name": "e",
"description": "Click event.",
"type": {
"text": "MouseEvent"
}
}
],
"description": "Prevents disabled breadcrumbs from navigating or bubbling click handlers."
},
{
"kind": "method",
"name": "drawCollapsedIndicator",
"description": "Renders the collapsed indicator based on the current collapsed variant.\nIf the collapsed variant is 'DROPDOWN', it invokes the collapseDropdown method.\nMobile breakpoint variants render compact breadcrumb summaries, otherwise the default button is used.",
"return": {
"type": {
"text": "any"
}
}
},
{
"kind": "method",
"name": "isMobileCollapsedVariant",
"description": "Returns whether the current collapsed variant is a compact mobile layout.",
"return": {
"type": {
"text": "boolean"
}
}
},
{
"kind": "method",
"name": "collapseDropdown",
"description": "Creates and returns a dropdown UI component for collapsed breadcrumbs.\nThis method generates a dropdown element with a button trigger and a menu populated with items corresponding\nto the collapsed breadcrumbs. The dropdown is configured to handle specific interactions and ensure that\nevents are appropriately managed to avoid propagation issues. Menu items are linked to their corresponding\nbreadcrumbs, enabling the same functionality as clicking on the original breadcrumb.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "createBreadcrumbDropdown",
"parameters": [
{
"name": "{ breadcrumbs, trigger, placement = 'bottom' }"
},
{
"description": "Configuration for the dropdown shell.",
"name": "options",
"type": {
"text": "@param {Array<HTMLElement>} options.breadcrumbs Breadcrumb elements to mirror in the menu.\n * @param {HTMLElement} options.trigger Element assigned to the dropdown trigger slot.\n * @param {string} options.placement Floating UI placement token for the popup.\n * "
}
}
],
"description": "Creates a dropdown containing breadcrumb menu items.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "createCollapsedBreadcrumbMenu",
"parameters": [
{
"name": "breadcrumbs",
"description": "Breadcrumb items represented by menu items.",
"type": {
"text": "Array<HTMLElement>"
}
}
],
"description": "Creates the menu used by collapsed dropdown variants.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "getCollapsedMenuBreadcrumbs",
"parameters": [
{
"name": "isBreakpointMenuIndicator",
"description": "Whether this trigger controls the full breakpoint menu.",
"type": {
"text": "boolean"
}
}
],
"description": "Returns breadcrumbs that should be exposed in a collapsed menu.",
"return": {
"type": {
"text": "Array<HTMLElement>"
}
}
},
{
"kind": "method",
"name": "collapseMobileVariant",
"parameters": [
{
"name": "variant",
"description": "Normalized uppercase variant token.",
"type": {
"text": "string"
}
}
],
"description": "Renders one of the compact mobile breakpoint variants.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "collapseMobileText",
"description": "Renders only the current breadcrumb title.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "collapseMobileBack",
"description": "Renders a parent back action above the current title.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "collapseMobileParentTitle",
"description": "Renders parent context above the current title.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "collapseMobileMenuTitle",
"description": "Renders a menu trigger with the current title.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "collapseMobileSheet",
"description": "Renders the future sheet variant using the dropdown fallback for now.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "createMobileDropdown",
"parameters": [
{
"name": "trigger",
"description": "Element that opens the fallback dropdown.",
"type": {
"text": "HTMLElement"
}
}
],
"description": "Creates a dropdown fallback for mobile menu-like variants.",
"return": {
"type": {
"text": "HTMLElement"
}
}
},
{
"kind": "method",
"name": "createMobileDropdownTrigger",
"parameters": [
{
"name": "{ icon, iconPosition = 'start', label, ariaLabel, className }"