{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "components/alert/alert.js", "declarations": [ { "kind": "class", "description": "", "name": "SlAlert", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The container that wraps the optional icon.", "name": "icon" }, { "description": "The container that wraps the alert's main content.", "name": "message" }, { "description": "The close button, an ``.", "name": "close-button" }, { "description": "The close button's exported `base` part.", "name": "close-button__base" } ], "slots": [ { "description": "The alert's main content.", "name": "" }, { "description": "An icon to show in the alert. Works best with ``.", "name": "icon" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{ 'sl-icon-button': SlIconButton }" }, { "kind": "field", "name": "autoHideTimeout", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "remainingTimeInterval", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "countdownAnimation", "type": { "text": "Animation | undefined" }, "privacy": "private" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'icon', 'suffix')" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "currentToastStack", "type": { "text": "HTMLDivElement" }, "privacy": "private", "static": true }, { "kind": "field", "name": "toastStack", "privacy": "private", "static": true, "readonly": true }, { "kind": "field", "name": "base", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "countdownElement", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the alert's open state.", "attribute": "open", "reflects": true }, { "kind": "field", "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Enables a close button that allows the user to dismiss the alert.", "attribute": "closable", "reflects": true }, { "kind": "field", "name": "variant", "type": { "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The alert's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "duration", "default": "Infinity", "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`, meaning\nthe alert will not close on its own.", "attribute": "duration" }, { "kind": "field", "name": "countdown", "type": { "text": "'rtl' | 'ltr' | undefined" }, "description": "Enables a countdown that indicates the remaining time the alert will be displayed.\nTypically used to indicate the remaining time before a whole app refresh.", "attribute": "countdown", "reflects": true }, { "kind": "field", "name": "remainingTime", "privacy": "private" }, { "kind": "method", "name": "restartAutoHide", "privacy": "private" }, { "kind": "method", "name": "pauseAutoHide", "privacy": "private" }, { "kind": "method", "name": "resumeAutoHide", "privacy": "private" }, { "kind": "method", "name": "handleCountdownChange", "privacy": "private" }, { "kind": "method", "name": "handleCloseClick", "privacy": "private" }, { "kind": "method", "name": "handleOpenChange" }, { "kind": "method", "name": "handleDurationChange" }, { "kind": "method", "name": "show", "description": "Shows the alert." }, { "kind": "method", "name": "hide", "description": "Hides the alert" }, { "kind": "method", "name": "toast", "description": "Displays the alert as a toast notification. This will move the alert out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the alert, you can reuse it by\ncalling this method again. The returned promise will resolve after the alert is hidden." } ], "events": [ { "description": "Emitted when the alert opens.", "name": "sl-show", "reactName": "onSlShow", "eventName": "SlShowEvent" }, { "description": "Emitted after the alert opens and all animations are complete.", "name": "sl-after-show", "reactName": "onSlAfterShow", "eventName": "SlAfterShowEvent" }, { "description": "Emitted when the alert closes.", "name": "sl-hide", "reactName": "onSlHide", "eventName": "SlHideEvent" }, { "description": "Emitted after the alert closes and all animations are complete.", "name": "sl-after-hide", "reactName": "onSlAfterHide", "eventName": "SlAfterHideEvent" } ], "attributes": [ { "name": "open", "type": { "text": "boolean" }, "default": "false", "description": "Indicates whether or not the alert is open. You can toggle this attribute to show and hide the alert, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the alert's open state.", "fieldName": "open" }, { "name": "closable", "type": { "text": "boolean" }, "default": "false", "description": "Enables a close button that allows the user to dismiss the alert.", "fieldName": "closable" }, { "name": "variant", "type": { "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The alert's theme variant.", "fieldName": "variant" }, { "name": "duration", "default": "Infinity", "description": "The length of time, in milliseconds, the alert will show before closing itself. If the user interacts with\nthe alert before it closes (e.g. moves the mouse over it), the timer will restart. Defaults to `Infinity`, meaning\nthe alert will not close on its own.", "fieldName": "duration" }, { "name": "countdown", "type": { "text": "'rtl' | 'ltr' | undefined" }, "description": "Enables a countdown that indicates the remaining time the alert will be displayed.\nTypically used to indicate the remaining time before a whole app refresh.", "fieldName": "countdown" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Alerts are used to display important messages inline or as toast notifications.", "tagNameWithoutPrefix": "alert", "tagName": "sl-alert", "customElement": true, "jsDoc": "/**\n * @summary Alerts are used to display important messages inline or as toast notifications.\n * @documentation https://shoelace.style/components/alert\n * @status stable\n * @since 2.0\n *\n * @dependency sl-icon-button\n *\n * @slot - The alert's main content.\n * @slot icon - An icon to show in the alert. Works best with ``.\n *\n * @event sl-show - Emitted when the alert opens.\n * @event sl-after-show - Emitted after the alert opens and all animations are complete.\n * @event sl-hide - Emitted when the alert closes.\n * @event sl-after-hide - Emitted after the alert closes and all animations are complete.\n *\n * @csspart base - The component's base wrapper.\n * @csspart icon - The container that wraps the optional icon.\n * @csspart message - The container that wraps the alert's main content.\n * @csspart close-button - The close button, an ``.\n * @csspart close-button__base - The close button's exported `base` part.\n *\n * @animation alert.show - The animation to use when showing the alert.\n * @animation alert.hide - The animation to use when hiding the alert.\n */", "documentation": "https://shoelace.style/components/alert", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon-button" ], "animations": [ { "name": "alert.show", "description": "The animation to use when showing the alert." }, { "name": "alert.hide", "description": "The animation to use when hiding the alert." } ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAlert", "module": "components/alert/alert.js" } } ] }, { "kind": "javascript-module", "path": "components/animated-image/animated-image.js", "declarations": [ { "kind": "class", "description": "", "name": "SlAnimatedImage", "cssProperties": [ { "description": "The size of the icon box.", "name": "--control-box-size" }, { "description": "The size of the play/pause icons.", "name": "--icon-size" } ], "cssParts": [ { "description": "The container that surrounds the pause/play icons and provides their background.", "name": "control-box" } ], "slots": [ { "description": "Optional play icon to use instead of the default. Works best with ``.", "name": "play-icon" }, { "description": "Optional pause icon to use instead of the default. Works best with ``.", "name": "pause-icon" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{ 'sl-icon': SlIcon }" }, { "kind": "field", "name": "animatedImage", "type": { "text": "HTMLImageElement" } }, { "kind": "field", "name": "frozenFrame", "type": { "text": "string" } }, { "kind": "field", "name": "isLoaded", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "src", "type": { "text": "string" }, "description": "The path to the image to load.", "attribute": "src" }, { "kind": "field", "name": "alt", "type": { "text": "string" }, "description": "A description of the image used by assistive devices.", "attribute": "alt" }, { "kind": "field", "name": "play", "type": { "text": "boolean" }, "description": "Plays the animation. When this attribute is remove, the animation will pause.", "attribute": "play", "reflects": true }, { "kind": "method", "name": "handleClick", "privacy": "private" }, { "kind": "method", "name": "handleLoad", "privacy": "private" }, { "kind": "method", "name": "handleError", "privacy": "private" }, { "kind": "method", "name": "handlePlayChange" }, { "kind": "method", "name": "handleSrcChange" } ], "events": [ { "description": "Emitted when the image loads successfully.", "name": "sl-load", "reactName": "onSlLoad", "eventName": "SlLoadEvent" }, { "description": "Emitted when the image fails to load.", "name": "sl-error", "reactName": "onSlError", "eventName": "SlErrorEvent" } ], "attributes": [ { "name": "src", "type": { "text": "string" }, "description": "The path to the image to load.", "fieldName": "src" }, { "name": "alt", "type": { "text": "string" }, "description": "A description of the image used by assistive devices.", "fieldName": "alt" }, { "name": "play", "type": { "text": "boolean" }, "description": "Plays the animation. When this attribute is remove, the animation will pause.", "fieldName": "play" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "A component for displaying animated GIFs and WEBPs that play and pause on interaction.", "tagNameWithoutPrefix": "animated-image", "tagName": "sl-animated-image", "customElement": true, "jsDoc": "/**\n * @summary A component for displaying animated GIFs and WEBPs that play and pause on interaction.\n * @documentation https://shoelace.style/components/animated-image\n * @status stable\n * @since 2.0\n *\n * @dependency sl-icon\n *\n * @event sl-load - Emitted when the image loads successfully.\n * @event sl-error - Emitted when the image fails to load.\n *\n * @slot play-icon - Optional play icon to use instead of the default. Works best with ``.\n * @slot pause-icon - Optional pause icon to use instead of the default. Works best with ``.\n *\n * @part control-box - The container that surrounds the pause/play icons and provides their background.\n *\n * @cssproperty --control-box-size - The size of the icon box.\n * @cssproperty --icon-size - The size of the play/pause icons.\n */", "documentation": "https://shoelace.style/components/animated-image", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon" ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAnimatedImage", "module": "components/animated-image/animated-image.js" } } ] }, { "kind": "javascript-module", "path": "components/animation/animation.js", "declarations": [ { "kind": "class", "description": "", "name": "SlAnimation", "slots": [ { "description": "The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To animate multiple elements, either wrap them in a single container or use multiple `` elements.", "name": "" } ], "members": [ { "kind": "field", "name": "animation", "type": { "text": "Animation | undefined" }, "privacy": "private" }, { "kind": "field", "name": "hasStarted", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "defaultSlot", "type": { "text": "Promise" } }, { "kind": "field", "name": "name", "type": { "text": "string" }, "default": "'none'", "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.", "attribute": "name" }, { "kind": "field", "name": "play", "type": { "text": "boolean" }, "default": "false", "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.", "attribute": "play", "reflects": true }, { "kind": "field", "name": "delay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay the start of the animation.", "attribute": "delay" }, { "kind": "field", "name": "direction", "type": { "text": "PlaybackDirection" }, "default": "'normal'", "description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)", "attribute": "direction" }, { "kind": "field", "name": "duration", "type": { "text": "number" }, "default": "1000", "description": "The number of milliseconds each iteration of the animation takes to complete.", "attribute": "duration" }, { "kind": "field", "name": "easing", "type": { "text": "string" }, "default": "'linear'", "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.", "attribute": "easing" }, { "kind": "field", "name": "endDelay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay after the active period of an animation sequence.", "attribute": "end-delay" }, { "kind": "field", "name": "fill", "type": { "text": "FillMode" }, "default": "'auto'", "description": "Sets how the animation applies styles to its target before and after its execution.", "attribute": "fill" }, { "kind": "field", "name": "iterations", "default": "Infinity", "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.", "attribute": "iterations" }, { "kind": "field", "name": "iterationStart", "type": { "text": "number" }, "default": "0", "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).", "attribute": "iteration-start" }, { "kind": "field", "name": "keyframes", "type": { "text": "Keyframe[] | undefined" }, "description": "The keyframes to use for the animation. If this is set, `name` will be ignored." }, { "kind": "field", "name": "playbackRate", "type": { "text": "number" }, "default": "1", "description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.", "attribute": "playback-rate" }, { "kind": "field", "name": "currentTime", "type": { "text": "CSSNumberish" }, "description": "Gets and sets the current animation time." }, { "kind": "field", "name": "handleAnimationFinish", "privacy": "private" }, { "kind": "field", "name": "handleAnimationCancel", "privacy": "private" }, { "kind": "method", "name": "handleSlotChange", "privacy": "private" }, { "kind": "method", "name": "createAnimation", "privacy": "private" }, { "kind": "method", "name": "destroyAnimation", "privacy": "private" }, { "kind": "method", "name": "handleAnimationChange" }, { "kind": "method", "name": "handlePlayChange" }, { "kind": "method", "name": "handlePlaybackRateChange" }, { "kind": "method", "name": "cancel", "description": "Clears all keyframe effects caused by this animation and aborts its playback." }, { "kind": "method", "name": "finish", "description": "Sets the playback time to the end of the animation corresponding to the current playback direction." } ], "events": [ { "description": "Emitted when the animation is canceled.", "name": "sl-cancel", "reactName": "onSlCancel", "eventName": "SlCancelEvent" }, { "description": "Emitted when the animation finishes.", "name": "sl-finish", "reactName": "onSlFinish", "eventName": "SlFinishEvent" }, { "description": "Emitted when the animation starts or restarts.", "name": "sl-start", "reactName": "onSlStart", "eventName": "SlStartEvent" } ], "attributes": [ { "name": "name", "type": { "text": "string" }, "default": "'none'", "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.", "fieldName": "name" }, { "name": "play", "type": { "text": "boolean" }, "default": "false", "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.", "fieldName": "play" }, { "name": "delay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay the start of the animation.", "fieldName": "delay" }, { "name": "direction", "type": { "text": "PlaybackDirection" }, "default": "'normal'", "description": "Determines the direction of playback as well as the behavior when reaching the end of an iteration.\n[Learn more](https://developer.mozilla.org/en-US/docs/Web/CSS/animation-direction)", "fieldName": "direction" }, { "name": "duration", "type": { "text": "number" }, "default": "1000", "description": "The number of milliseconds each iteration of the animation takes to complete.", "fieldName": "duration" }, { "name": "easing", "type": { "text": "string" }, "default": "'linear'", "description": "The easing function to use for the animation. This can be a Shoelace easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.", "fieldName": "easing" }, { "name": "end-delay", "type": { "text": "number" }, "default": "0", "description": "The number of milliseconds to delay after the active period of an animation sequence.", "fieldName": "endDelay" }, { "name": "fill", "type": { "text": "FillMode" }, "default": "'auto'", "description": "Sets how the animation applies styles to its target before and after its execution.", "fieldName": "fill" }, { "name": "iterations", "default": "Infinity", "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.", "fieldName": "iterations" }, { "name": "iteration-start", "type": { "text": "number" }, "default": "0", "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).", "fieldName": "iterationStart" }, { "name": "playback-rate", "type": { "text": "number" }, "default": "1", "description": "Sets the animation's playback rate. The default is `1`, which plays the animation at a normal speed. Setting this\nto `2`, for example, will double the animation's speed. A negative value can be used to reverse the animation. This\nvalue can be changed without causing the animation to restart.", "fieldName": "playbackRate" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).", "tagNameWithoutPrefix": "animation", "tagName": "sl-animation", "customElement": true, "jsDoc": "/**\n * @summary Animate elements declaratively with nearly 100 baked-in presets, or roll your own with custom keyframes. Powered by the [Web Animations API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API).\n * @documentation https://shoelace.style/components/animation\n * @status stable\n * @since 2.0\n *\n * @event sl-cancel - Emitted when the animation is canceled.\n * @event sl-finish - Emitted when the animation finishes.\n * @event sl-start - Emitted when the animation starts or restarts.\n *\n * @slot - The element to animate. Avoid slotting in more than one element, as subsequent ones will be ignored. To\n * animate multiple elements, either wrap them in a single container or use multiple `` elements.\n */", "documentation": "https://shoelace.style/components/animation", "status": "stable", "since": "2.0" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAnimation", "module": "components/animation/animation.js" } } ] }, { "kind": "javascript-module", "path": "components/badge/badge.js", "declarations": [ { "kind": "class", "description": "", "name": "SlBadge", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" } ], "slots": [ { "description": "The badge's content.", "name": "" } ], "members": [ { "kind": "field", "name": "variant", "type": { "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The badge's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style badge with rounded edges.", "attribute": "pill", "reflects": true }, { "kind": "field", "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulsate to draw attention.", "attribute": "pulse", "reflects": true } ], "attributes": [ { "name": "variant", "type": { "text": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" }, "default": "'primary'", "description": "The badge's theme variant.", "fieldName": "variant" }, { "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style badge with rounded edges.", "fieldName": "pill" }, { "name": "pulse", "type": { "text": "boolean" }, "default": "false", "description": "Makes the badge pulsate to draw attention.", "fieldName": "pulse" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Badges are used to draw attention and display statuses or counts.", "tagNameWithoutPrefix": "badge", "tagName": "sl-badge", "customElement": true, "jsDoc": "/**\n * @summary Badges are used to draw attention and display statuses or counts.\n * @documentation https://shoelace.style/components/badge\n * @status stable\n * @since 2.0\n *\n * @slot - The badge's content.\n *\n * @csspart base - The component's base wrapper.\n */", "documentation": "https://shoelace.style/components/badge", "status": "stable", "since": "2.0" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBadge", "module": "components/badge/badge.js" } } ] }, { "kind": "javascript-module", "path": "components/breadcrumb/breadcrumb.js", "declarations": [ { "kind": "class", "description": "", "name": "SlBreadcrumb", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" } ], "slots": [ { "description": "One or more breadcrumb items to display.", "name": "" }, { "description": "The separator to use between breadcrumb items. Works best with ``.", "name": "separator" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{ 'sl-icon': SlIcon }" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "separatorDir", "privacy": "private" }, { "kind": "field", "name": "defaultSlot", "type": { "text": "HTMLSlotElement" } }, { "kind": "field", "name": "separatorSlot", "type": { "text": "HTMLSlotElement" } }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.", "attribute": "label" }, { "kind": "method", "name": "getSeparator", "privacy": "private" }, { "kind": "method", "name": "handleSlotChange", "privacy": "private" } ], "attributes": [ { "name": "label", "type": { "text": "string" }, "default": "''", "description": "The label to use for the breadcrumb control. This will not be shown on the screen, but it will be announced by\nscreen readers and other assistive devices to provide more context for users.", "fieldName": "label" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.", "tagNameWithoutPrefix": "breadcrumb", "tagName": "sl-breadcrumb", "customElement": true, "jsDoc": "/**\n * @summary Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n * @documentation https://shoelace.style/components/breadcrumb\n * @status stable\n * @since 2.0\n *\n * @slot - One or more breadcrumb items to display.\n * @slot separator - The separator to use between breadcrumb items. Works best with ``.\n *\n * @dependency sl-icon\n *\n * @csspart base - The component's base wrapper.\n */", "documentation": "https://shoelace.style/components/breadcrumb", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon" ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBreadcrumb", "module": "components/breadcrumb/breadcrumb.js" } } ] }, { "kind": "javascript-module", "path": "components/breadcrumb-item/breadcrumb-item.js", "declarations": [ { "kind": "class", "description": "", "name": "SlBreadcrumbItem", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The breadcrumb item's label.", "name": "label" }, { "description": "The container that wraps the prefix.", "name": "prefix" }, { "description": "The container that wraps the suffix.", "name": "suffix" }, { "description": "The container that wraps the separator.", "name": "separator" } ], "slots": [ { "description": "The breadcrumb item's label.", "name": "" }, { "description": "An optional prefix, usually an icon or icon button.", "name": "prefix" }, { "description": "An optional suffix, usually an icon or icon button.", "name": "suffix" }, { "description": "The separator to use for the breadcrumb item. This will only change the separator for this item. If you want to change it for all items in the group, set the separator on `` instead.", "name": "separator" } ], "members": [ { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'prefix', 'suffix')" }, { "kind": "field", "name": "defaultSlot", "type": { "text": "HTMLSlotElement" } }, { "kind": "field", "name": "renderType", "type": { "text": "'button' | 'link' | 'dropdown'" }, "privacy": "private", "default": "'button'" }, { "kind": "field", "name": "href", "type": { "text": "string | undefined" }, "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.", "attribute": "href" }, { "kind": "field", "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Tells the browser where to open the link. Only used when `href` is set.", "attribute": "target" }, { "kind": "field", "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The `rel` attribute to use on the link. Only used when `href` is set.", "attribute": "rel" }, { "kind": "method", "name": "setRenderType", "privacy": "private" }, { "kind": "method", "name": "hrefChanged" }, { "kind": "method", "name": "handleSlotChange" } ], "attributes": [ { "name": "href", "type": { "text": "string | undefined" }, "description": "Optional URL to direct the user to when the breadcrumb item is activated. When set, a link will be rendered\ninternally. When unset, a button will be rendered instead.", "fieldName": "href" }, { "name": "target", "type": { "text": "'_blank' | '_parent' | '_self' | '_top' | undefined" }, "description": "Tells the browser where to open the link. Only used when `href` is set.", "fieldName": "target" }, { "name": "rel", "type": { "text": "string" }, "default": "'noreferrer noopener'", "description": "The `rel` attribute to use on the link. Only used when `href` is set.", "fieldName": "rel" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.", "tagNameWithoutPrefix": "breadcrumb-item", "tagName": "sl-breadcrumb-item", "customElement": true, "jsDoc": "/**\n * @summary Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.\n * @documentation https://shoelace.style/components/breadcrumb-item\n * @status stable\n * @since 2.0\n *\n * @slot - The breadcrumb item's label.\n * @slot prefix - An optional prefix, usually an icon or icon button.\n * @slot suffix - An optional suffix, usually an icon or icon button.\n * @slot separator - The separator to use for the breadcrumb item. This will only change the separator for this item. If\n * you want to change it for all items in the group, set the separator on `` instead.\n *\n * @csspart base - The component's base wrapper.\n * @csspart label - The breadcrumb item's label.\n * @csspart prefix - The container that wraps the prefix.\n * @csspart suffix - The container that wraps the suffix.\n * @csspart separator - The container that wraps the separator.\n */", "documentation": "https://shoelace.style/components/breadcrumb-item", "status": "stable", "since": "2.0" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBreadcrumbItem", "module": "components/breadcrumb-item/breadcrumb-item.js" } } ] }, { "kind": "javascript-module", "path": "components/avatar/avatar.js", "declarations": [ { "kind": "class", "description": "", "name": "SlAvatar", "cssProperties": [ { "description": "The size of the avatar.", "name": "--size" } ], "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The container that wraps the avatar's icon.", "name": "icon" }, { "description": "The container that wraps the avatar's initials.", "name": "initials" }, { "description": "The avatar image. Only shown when the `image` attribute is set.", "name": "image" } ], "slots": [ { "description": "The default icon to use when no image or initials are present. Works best with ``.", "name": "icon" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{ 'sl-icon': SlIcon }" }, { "kind": "field", "name": "hasError", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "image", "type": { "text": "string" }, "default": "''", "description": "The image source to use for the avatar.", "attribute": "image" }, { "kind": "field", "name": "label", "type": { "text": "string" }, "default": "''", "description": "A label to use to describe the avatar to assistive devices.", "attribute": "label" }, { "kind": "field", "name": "initials", "type": { "text": "string" }, "default": "''", "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).", "attribute": "initials" }, { "kind": "field", "name": "loading", "type": { "text": "'eager' | 'lazy'" }, "default": "'eager'", "description": "Indicates how the browser should load the image.", "attribute": "loading" }, { "kind": "field", "name": "shape", "type": { "text": "'circle' | 'square' | 'rounded'" }, "default": "'circle'", "description": "The shape of the avatar.", "attribute": "shape", "reflects": true }, { "kind": "method", "name": "handleImageChange" }, { "kind": "method", "name": "handleImageLoadError", "privacy": "private" } ], "events": [ { "description": "The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.", "name": "sl-error", "reactName": "onSlError", "eventName": "SlErrorEvent" } ], "attributes": [ { "name": "image", "type": { "text": "string" }, "default": "''", "description": "The image source to use for the avatar.", "fieldName": "image" }, { "name": "label", "type": { "text": "string" }, "default": "''", "description": "A label to use to describe the avatar to assistive devices.", "fieldName": "label" }, { "name": "initials", "type": { "text": "string" }, "default": "''", "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).", "fieldName": "initials" }, { "name": "loading", "type": { "text": "'eager' | 'lazy'" }, "default": "'eager'", "description": "Indicates how the browser should load the image.", "fieldName": "loading" }, { "name": "shape", "type": { "text": "'circle' | 'square' | 'rounded'" }, "default": "'circle'", "description": "The shape of the avatar.", "fieldName": "shape" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Avatars are used to represent a person or object.", "tagNameWithoutPrefix": "avatar", "tagName": "sl-avatar", "customElement": true, "jsDoc": "/**\n * @summary Avatars are used to represent a person or object.\n * @documentation https://shoelace.style/components/avatar\n * @status stable\n * @since 2.0\n *\n * @dependency sl-icon\n *\n * @event sl-error - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some\n * unknown cause.\n *\n * @slot icon - The default icon to use when no image or initials are present. Works best with ``.\n *\n * @csspart base - The component's base wrapper.\n * @csspart icon - The container that wraps the avatar's icon.\n * @csspart initials - The container that wraps the avatar's initials.\n * @csspart image - The avatar image. Only shown when the `image` attribute is set.\n *\n * @cssproperty --size - The size of the avatar.\n */", "documentation": "https://shoelace.style/components/avatar", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon" ] } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAvatar", "module": "components/avatar/avatar.js" } } ] }, { "kind": "javascript-module", "path": "components/bubble/bubble.js", "declarations": [ { "kind": "class", "description": "", "name": "SlBubble", "cssProperties": [ { "description": "Background color for the `filled` variant (start placement).", "name": "--sl-bubble-filled-background" }, { "description": "Text color for the `filled` variant.", "name": "--sl-bubble-filled-color" }, { "description": "Background color for the `filled` variant when placement is `end`.", "name": "--sl-bubble-filled-background-end" }, { "description": "Text color for the `filled` variant when placement is `end`.", "name": "--sl-bubble-filled-color-end" }, { "description": "Background color for the `outlined` variant.", "name": "--sl-bubble-outlined-background" }, { "description": "Border color for the `outlined` variant.", "name": "--sl-bubble-outlined-border-color" }, { "description": "Text color for the `outlined` variant.", "name": "--sl-bubble-outlined-color" }, { "description": "Background color for the `shadow` variant.", "name": "--sl-bubble-shadow-background" }, { "description": "Box shadow for the `shadow` variant.", "name": "--sl-bubble-shadow-box-shadow" }, { "description": "Text color for the `shadow` variant.", "name": "--sl-bubble-shadow-color" }, { "description": "Text color for the `borderless` variant.", "name": "--sl-bubble-borderless-color" }, { "description": "Color of the loading indicator dots.", "name": "--sl-bubble-loading-dot-color" }, { "description": "Color of the typing cursor indicator.", "name": "--sl-bubble-cursor-color" } ], "cssParts": [ { "description": "The component's outermost wrapper.", "name": "base" }, { "description": "The container that wraps the avatar slot.", "name": "avatar" }, { "description": "The body wrapper containing header, content, and footer.", "name": "body" }, { "description": "The header container.", "name": "header" }, { "description": "The main content bubble area.", "name": "content" }, { "description": "The footer container.", "name": "footer" }, { "description": "The extra content container.", "name": "extra" }, { "description": "The default loading indicator container.", "name": "loading" } ], "slots": [ { "description": "The default slot for bubble content. Used when the `content` attribute is not set.", "name": "" }, { "description": "An avatar to display beside the bubble. Works well with ``.", "name": "avatar" }, { "description": "Header content displayed above the bubble content area.", "name": "header" }, { "description": "Footer content displayed below the bubble content area.", "name": "footer" }, { "description": "Extra content displayed on the opposite side of the avatar.", "name": "extra" }, { "description": "Custom loading indicator. Overrides the default loading dots.", "name": "loading" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{ 'sl-avatar': SlAvatar, 'sl-button': SlButton, 'sl-spinner': SlSpinner }" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, 'avatar', 'header', 'footer', 'extra')" }, { "kind": "field", "name": "editableInput", "type": { "text": "HTMLDivElement" }, "privacy": "private" }, { "kind": "field", "name": "typingTimer", "type": { "text": "ReturnType | null" }, "privacy": "private", "default": "null", "description": "Typing animation timer handle" }, { "kind": "field", "name": "typingIndex", "type": { "text": "number" }, "privacy": "private", "default": "0", "description": "Current position in the typing animation" }, { "kind": "field", "name": "isTyping", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "description": "Whether the typing animation is currently running" }, { "kind": "field", "name": "typingText", "type": { "text": "string" }, "privacy": "private", "default": "''", "description": "Internal rendered string for typing animation" }, { "kind": "field", "name": "placement", "type": { "text": "'start' | 'end'" }, "default": "'start'", "description": "The position of the bubble. Use `start` for messages from others (left-aligned)\nand `end` for messages from the current user (right-aligned).", "attribute": "placement", "reflects": true }, { "kind": "field", "name": "content", "type": { "text": "string" }, "default": "''", "description": "The text content to display in the bubble. If omitted, the default slot content is rendered instead.\nWhen `typing` is enabled, the content will be animated character by character.", "attribute": "content" }, { "kind": "field", "name": "variant", "type": { "text": "'filled' | 'outlined' | 'shadow' | 'borderless'" }, "default": "'filled'", "description": "The visual style variant of the bubble.\n- `filled`: Solid background (default)\n- `outlined`: Border with transparent background\n- `shadow`: White background with drop shadow\n- `borderless`: No background or border", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "shape", "type": { "text": "'default' | 'round' | 'corner'" }, "default": "'default'", "description": "The shape of the bubble.\n- `default`: Standard rounded corners\n- `round`: Pill-shaped corners\n- `corner`: Asymmetric corner (chat-style notch)", "attribute": "shape", "reflects": true }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When true, shows a loading indicator instead of content.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "typing", "type": { "text": "boolean" }, "default": "false", "description": "Enables a character-by-character typing animation for the `content` attribute.\nOnly works with string content set via the `content` attribute.", "attribute": "typing", "reflects": true }, { "kind": "field", "name": "typingStep", "type": { "text": "number" }, "default": "2", "description": "Number of characters to reveal per animation step during typing.", "attribute": "typing-step" }, { "kind": "field", "name": "typingInterval", "type": { "text": "number" }, "default": "50", "description": "Interval in milliseconds between each typing animation step.", "attribute": "typing-interval" }, { "kind": "field", "name": "streaming", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the content is being streamed. When typing is enabled and streaming is true,\nthe typing animation keeps running as new content arrives. The `sl-typing-complete` event\nis only emitted after streaming ends.", "attribute": "streaming", "reflects": true }, { "kind": "field", "name": "footerPlacement", "type": { "text": "'outer-start' | 'outer-end' | 'inner-start' | 'inner-end' | undefined" }, "description": "Controls the position of the footer slot relative to the content bubble.\n- `outer-start`: Footer outside the content area, aligned to start (default when placement is `start`)\n- `outer-end`: Footer outside the content area, aligned to end (default when placement is `end`)\n- `inner-start`: Footer inside the content area (shares background), aligned to start\n- `inner-end`: Footer inside the content area (shares background), aligned to end\n\nWhen not set, defaults to `outer-start` if placement is `start`, or `outer-end` if placement is `end`.", "attribute": "footer-placement" }, { "kind": "field", "name": "editable", "type": { "text": "boolean" }, "default": "false", "description": "Enables editing mode on the bubble content. When true, the content area becomes\na contentEditable region with OK and Cancel buttons.", "attribute": "editable", "reflects": true }, { "kind": "field", "name": "okText", "type": { "text": "string" }, "default": "'OK'", "description": "Custom text for the edit confirm button.", "attribute": "ok-text" }, { "kind": "field", "name": "cancelText", "type": { "text": "string" }, "default": "'Cancel'", "description": "Custom text for the edit cancel button.", "attribute": "cancel-text" }, { "kind": "method", "name": "startTypingAnimation", "privacy": "private" }, { "kind": "method", "name": "stepTyping", "privacy": "private" }, { "kind": "method", "name": "stopTypingAnimation", "privacy": "private" }, { "kind": "method", "name": "stopTypingTimer", "privacy": "private" }, { "kind": "method", "name": "initEditable", "privacy": "private", "description": "Initialize the contentEditable div with current content, focus and place cursor at end" }, { "kind": "method", "name": "getPlainText", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "root", "type": { "text": "HTMLElement" } } ], "description": "Extract plain text from a contentEditable div, converting block elements\nand
tags into newlines (mirrors React's getPlainTextWithFormat)." }, { "kind": "method", "name": "isBlockElement", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "el", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "handleEditConfirm", "privacy": "private" }, { "kind": "method", "name": "handleEditCancel", "privacy": "private" }, { "kind": "method", "name": "renderLoading", "privacy": "private" }, { "kind": "method", "name": "renderContent", "privacy": "private" }, { "kind": "method", "name": "renderEditable", "privacy": "private" }, { "kind": "field", "name": "effectiveFooterPlacement", "type": { "text": "'outer-start' | 'outer-end' | 'inner-start' | 'inner-end'" }, "privacy": "private", "description": "Compute the effective footer placement, with default based on placement", "readonly": true }, { "kind": "method", "name": "renderFooter", "privacy": "private", "parameters": [ { "name": "hasFooter", "type": { "text": "boolean" } } ] } ], "events": [ { "description": "Emitted when the typing animation finishes rendering all content.", "name": "sl-typing-complete", "reactName": "onSlTypingComplete", "eventName": "SlTypingCompleteEvent" }, { "description": "Emitted when the user confirms an edit. `event.detail.content` contains the edited text.", "name": "sl-edit-confirm", "reactName": "onSlEditConfirm", "eventName": "SlEditConfirmEvent" }, { "description": "Emitted when the user cancels editing.", "name": "sl-edit-cancel", "reactName": "onSlEditCancel", "eventName": "SlEditCancelEvent" } ], "attributes": [ { "name": "placement", "type": { "text": "'start' | 'end'" }, "default": "'start'", "description": "The position of the bubble. Use `start` for messages from others (left-aligned)\nand `end` for messages from the current user (right-aligned).", "fieldName": "placement" }, { "name": "content", "type": { "text": "string" }, "default": "''", "description": "The text content to display in the bubble. If omitted, the default slot content is rendered instead.\nWhen `typing` is enabled, the content will be animated character by character.", "fieldName": "content" }, { "name": "variant", "type": { "text": "'filled' | 'outlined' | 'shadow' | 'borderless'" }, "default": "'filled'", "description": "The visual style variant of the bubble.\n- `filled`: Solid background (default)\n- `outlined`: Border with transparent background\n- `shadow`: White background with drop shadow\n- `borderless`: No background or border", "fieldName": "variant" }, { "name": "shape", "type": { "text": "'default' | 'round' | 'corner'" }, "default": "'default'", "description": "The shape of the bubble.\n- `default`: Standard rounded corners\n- `round`: Pill-shaped corners\n- `corner`: Asymmetric corner (chat-style notch)", "fieldName": "shape" }, { "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "When true, shows a loading indicator instead of content.", "fieldName": "loading" }, { "name": "typing", "type": { "text": "boolean" }, "default": "false", "description": "Enables a character-by-character typing animation for the `content` attribute.\nOnly works with string content set via the `content` attribute.", "fieldName": "typing" }, { "name": "typing-step", "type": { "text": "number" }, "default": "2", "description": "Number of characters to reveal per animation step during typing.", "fieldName": "typingStep" }, { "name": "typing-interval", "type": { "text": "number" }, "default": "50", "description": "Interval in milliseconds between each typing animation step.", "fieldName": "typingInterval" }, { "name": "streaming", "type": { "text": "boolean" }, "default": "false", "description": "Indicates the content is being streamed. When typing is enabled and streaming is true,\nthe typing animation keeps running as new content arrives. The `sl-typing-complete` event\nis only emitted after streaming ends.", "fieldName": "streaming" }, { "name": "footer-placement", "type": { "text": "'outer-start' | 'outer-end' | 'inner-start' | 'inner-end' | undefined" }, "description": "Controls the position of the footer slot relative to the content bubble.\n- `outer-start`: Footer outside the content area, aligned to start (default when placement is `start`)\n- `outer-end`: Footer outside the content area, aligned to end (default when placement is `end`)\n- `inner-start`: Footer inside the content area (shares background), aligned to start\n- `inner-end`: Footer inside the content area (shares background), aligned to end\n\nWhen not set, defaults to `outer-start` if placement is `start`, or `outer-end` if placement is `end`.", "fieldName": "footerPlacement" }, { "name": "editable", "type": { "text": "boolean" }, "default": "false", "description": "Enables editing mode on the bubble content. When true, the content area becomes\na contentEditable region with OK and Cancel buttons.", "fieldName": "editable" }, { "name": "ok-text", "type": { "text": "string" }, "default": "'OK'", "description": "Custom text for the edit confirm button.", "fieldName": "okText" }, { "name": "cancel-text", "type": { "text": "string" }, "default": "'Cancel'", "description": "Custom text for the edit cancel button.", "fieldName": "cancelText" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element.js" }, "summary": "Bubble is a chat bubble component commonly used in conversational UIs.", "tagNameWithoutPrefix": "bubble", "tagName": "sl-bubble", "customElement": true, "jsDoc": "/**\n * @summary Bubble is a chat bubble component commonly used in conversational UIs.\n * @documentation https://shoelace.style/components/bubble\n * @status experimental\n * @since 2.0\n *\n * @slot - The default slot for bubble content. Used when the `content` attribute is not set.\n * @slot avatar - An avatar to display beside the bubble. Works well with ``.\n * @slot header - Header content displayed above the bubble content area.\n * @slot footer - Footer content displayed below the bubble content area.\n * @slot extra - Extra content displayed on the opposite side of the avatar.\n * @slot loading - Custom loading indicator. Overrides the default loading dots.\n *\n * @event sl-typing-complete - Emitted when the typing animation finishes rendering all content.\n * @event sl-edit-confirm - Emitted when the user confirms an edit. `event.detail.content` contains the edited text.\n * @event sl-edit-cancel - Emitted when the user cancels editing.\n *\n * @csspart base - The component's outermost wrapper.\n * @csspart avatar - The container that wraps the avatar slot.\n * @csspart body - The body wrapper containing header, content, and footer.\n * @csspart header - The header container.\n * @csspart content - The main content bubble area.\n * @csspart footer - The footer container.\n * @csspart extra - The extra content container.\n * @csspart loading - The default loading indicator container.\n *\n * @cssproperty --sl-bubble-filled-background - Background color for the `filled` variant (start placement).\n * @cssproperty --sl-bubble-filled-color - Text color for the `filled` variant.\n * @cssproperty --sl-bubble-filled-background-end - Background color for the `filled` variant when placement is `end`.\n * @cssproperty --sl-bubble-filled-color-end - Text color for the `filled` variant when placement is `end`.\n * @cssproperty --sl-bubble-outlined-background - Background color for the `outlined` variant.\n * @cssproperty --sl-bubble-outlined-border-color - Border color for the `outlined` variant.\n * @cssproperty --sl-bubble-outlined-color - Text color for the `outlined` variant.\n * @cssproperty --sl-bubble-shadow-background - Background color for the `shadow` variant.\n * @cssproperty --sl-bubble-shadow-box-shadow - Box shadow for the `shadow` variant.\n * @cssproperty --sl-bubble-shadow-color - Text color for the `shadow` variant.\n * @cssproperty --sl-bubble-borderless-color - Text color for the `borderless` variant.\n * @cssproperty --sl-bubble-loading-dot-color - Color of the loading indicator dots.\n * @cssproperty --sl-bubble-cursor-color - Color of the typing cursor indicator.\n */", "documentation": "https://shoelace.style/components/bubble", "status": "experimental", "since": "2.0" } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBubble", "module": "components/bubble/bubble.js" } } ] }, { "kind": "javascript-module", "path": "components/button/button.js", "declarations": [ { "kind": "class", "description": "", "name": "SlButton", "cssParts": [ { "description": "The component's base wrapper.", "name": "base" }, { "description": "The container that wraps the prefix.", "name": "prefix" }, { "description": "The button's label.", "name": "label" }, { "description": "The container that wraps the suffix.", "name": "suffix" }, { "description": "The button's caret icon, an `` element.", "name": "caret" }, { "description": "The spinner that shows when the button is in the loading state.", "name": "spinner" } ], "slots": [ { "description": "The button's label.", "name": "" }, { "description": "A presentational prefix icon or similar element.", "name": "prefix" }, { "description": "A presentational suffix icon or similar element.", "name": "suffix" } ], "members": [ { "kind": "field", "name": "dependencies", "type": { "text": "object" }, "static": true, "default": "{ 'sl-icon': SlIcon, 'sl-spinner': SlSpinner }" }, { "kind": "field", "name": "formControlController", "privacy": "private", "readonly": true, "default": "new FormControlController(this, { assumeInteractionOn: ['click'] })" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "readonly": true, "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')" }, { "kind": "field", "name": "localize", "privacy": "private", "readonly": true, "default": "new LocalizeController(this)" }, { "kind": "field", "name": "button", "type": { "text": "HTMLButtonElement | HTMLLinkElement" } }, { "kind": "field", "name": "hasFocus", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "invalid", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "title", "type": { "text": "string" }, "default": "''", "attribute": "title" }, { "kind": "field", "name": "variant", "type": { "text": "'default' | 'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'text'" }, "default": "'default'", "description": "The button's theme variant.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "size", "type": { "text": "'small' | 'medium' | 'large'" }, "default": "'medium'", "description": "The button's size.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "caret", "type": { "text": "boolean" }, "default": "false", "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.", "attribute": "caret", "reflects": true }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Disables the button.", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "loading", "type": { "text": "boolean" }, "default": "false", "description": "Draws the button in a loading state.", "attribute": "loading", "reflects": true }, { "kind": "field", "name": "outline", "type": { "text": "boolean" }, "default": "false", "description": "Draws an outlined button.", "attribute": "outline", "reflects": true }, { "kind": "field", "name": "pill", "type": { "text": "boolean" }, "default": "false", "description": "Draws a pill-style button with rounded edges.", "attribute": "pill", "reflects": true }, { "kind": "field", "name": "circle", "type": { "text": "boolean" }, "default": "false", "description": "Draws a circular icon button. When this attribute is present, the button expects a single `` in the\ndefault slot.", "attribute": "circle", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "'button' | 'submit' | 'reset'" }, "default": "'button'", "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`