{ "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": "autoHideTimeout", "type": { "text": "number" }, "privacy": "private" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "default": "new HasSlotController(this, 'icon', 'suffix')" }, { "kind": "field", "name": "localize", "privacy": "private", "default": "new LocalizeController(this)" }, { "kind": "field", "name": "base", "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' | 'info' | 'secondary'" }, "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": "method", "name": "restartAutoHide", "privacy": "private" }, { "kind": "method", "name": "handleCloseClick", "privacy": "private" }, { "kind": "method", "name": "handleMouseMove", "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" }, { "description": "Emitted after the alert opens and all animations are complete.", "name": "sl-after-show", "reactName": "onSlAfterShow" }, { "description": "Emitted when the alert closes.", "name": "sl-hide", "reactName": "onSlHide" }, { "description": "Emitted after the alert closes and all animations are complete.", "name": "sl-after-hide", "reactName": "onSlAfterHide" } ], "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' | 'info' | 'secondary'" }, "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.", "resolveInitializer": { "module": "src/components/alert/alert.ts" }, "fieldName": "duration" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element" }, "summary": "Alerts are used to display important messages inline or as toast notifications.", "documentation": "https://shoelace.style/components/alert", "status": "stable", "viur": "0.5", "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." } ], "tagName": "sl-alert", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAlert", "module": "components/alert/alert.js" } }, { "kind": "custom-element-definition", "name": "sl-alert", "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" } ], "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": "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" }, { "description": "Emitted when the image fails to load.", "name": "sl-error", "reactName": "onSlError" } ], "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" }, "summary": "A component for displaying animated GIFs and WEBPs that play and pause on interaction.", "documentation": "https://shoelace.style/components/animated-image", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon" ], "tagName": "sl-animated-image", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAnimatedImage", "module": "components/animated-image/animated-image.js" } }, { "kind": "custom-element-definition", "name": "sl-animated-image", "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": "number" }, "description": "Gets and sets the current animation time." }, { "kind": "method", "name": "handleAnimationFinish", "privacy": "private" }, { "kind": "method", "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" }, { "description": "Emitted when the animation finishes.", "name": "sl-finish", "reactName": "onSlFinish" }, { "description": "Emitted when the animation starts or restarts.", "name": "sl-start", "reactName": "onSlStart" } ], "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.", "resolveInitializer": { "module": "src/components/animation/animation.ts" }, "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" }, "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).", "documentation": "https://shoelace.style/components/animation", "status": "stable", "since": "2.0", "tagName": "sl-animation", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAnimation", "module": "components/animation/animation.js" } }, { "kind": "custom-element-definition", "name": "sl-animation", "declaration": { "name": "SlAnimation", "module": "components/animation/animation.js" } } ] }, { "kind": "javascript-module", "path": "components/animation/animations.js", "declarations": [ { "kind": "function", "name": "getAnimationNames", "description": "Gets a list of all supported animation names." }, { "kind": "function", "name": "getEasingNames", "description": "Gets a list of all supported easing function names." } ], "exports": [ { "kind": "js", "name": "animations", "declaration": { "name": "animations", "module": "components/animation/animations.js" } }, { "kind": "js", "name": "getAnimationNames", "declaration": { "name": "getAnimationNames", "module": "components/animation/animations.js" } }, { "kind": "js", "name": "getEasingNames", "declaration": { "name": "getEasingNames", "module": "components/animation/animations.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": "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" } ], "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" }, "summary": "Avatars are used to represent a person or object.", "documentation": "https://shoelace.style/components/avatar", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon" ], "tagName": "sl-avatar", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlAvatar", "module": "components/avatar/avatar.js" } }, { "kind": "custom-element-definition", "name": "sl-avatar", "declaration": { "name": "SlAvatar", "module": "components/avatar/avatar.js" } } ] }, { "kind": "javascript-module", "path": "components/back-to-top/back-to-top.js", "declarations": [ { "kind": "class", "description": "", "name": "SlBackToTop", "cssParts": [ { "description": "The component's base wrapper.", "name": "wrapper" } ], "slots": [ { "description": "The default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "targetElement", "type": { "text": "any" } }, { "kind": "field", "name": "wrapper", "type": { "text": "HTMLElement" } }, { "kind": "field", "name": "target", "type": { "text": "string" }, "default": "\"html\"", "description": "selector for scroll target", "attribute": "target" }, { "kind": "method", "name": "scrollToTop" }, { "kind": "method", "name": "scolling", "parameters": [ { "name": "e", "type": { "text": "any" } } ] }, { "kind": "method", "name": "initSlot" } ], "attributes": [ { "name": "target", "type": { "text": "string" }, "default": "\"html\"", "description": "selector for scroll target", "fieldName": "target" } ], "superclass": { "name": "LitElement", "package": "lit" }, "since": "2.0", "status": "experimental", "viur": "0.5", "tagName": "sl-back-to-top", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBackToTop", "module": "components/back-to-top/back-to-top.js" } }, { "kind": "custom-element-definition", "name": "sl-back-to-top", "declaration": { "name": "SlBackToTop", "module": "components/back-to-top/back-to-top.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' | 'info' | 'secondary'" }, "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' | 'info' | 'secondary'" }, "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" }, "summary": "Badges are used to draw attention and display statuses or counts.", "documentation": "https://shoelace.style/components/badge", "status": "stable", "since": "2.0", "tagName": "sl-badge", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBadge", "module": "components/badge/badge.js" } }, { "kind": "custom-element-definition", "name": "sl-badge", "declaration": { "name": "SlBadge", "module": "components/badge/badge.js" } } ] }, { "kind": "javascript-module", "path": "components/bone/bone.js", "declarations": [ { "kind": "class", "description": "", "name": "SlBone", "cssProperties": [ { "description": "An example CSS custom property.", "name": "--example" } ], "cssParts": [ { "description": "The component's internal wrapper.", "name": "base" } ], "slots": [ { "description": "The default slot.", "name": "" } ], "members": [ { "kind": "field", "name": "bone", "type": { "text": "Object" } }, { "kind": "field", "name": "boneInstance", "type": { "text": "any" } }, { "kind": "field", "name": "initBoneValue", "type": { "text": "any" } }, { "kind": "field", "name": "internboneValue", "type": { "text": "Record" } }, { "kind": "field", "name": "relationalCache", "type": { "text": "Record" }, "default": "{}" }, { "kind": "field", "name": "textboneCache", "type": { "text": "Record" }, "default": "{}" }, { "kind": "field", "name": "jsonboneCache", "type": { "text": "Record" }, "default": "{}" }, { "kind": "field", "name": "previousBoneValues", "type": { "text": "Record" }, "default": "{}" }, { "kind": "field", "name": "initFired", "type": { "text": "boolean" }, "default": "false" }, { "kind": "field", "name": "boneStructure", "type": { "text": "any" }, "description": "If we have a boneStructure we can set it", "attribute": "boneStructure", "reflects": true }, { "kind": "field", "name": "boneValue", "type": { "text": "any" }, "description": "set boneValue", "attribute": "boneValue", "reflects": true }, { "kind": "field", "name": "boneName", "type": { "text": "string" }, "description": "set the boneName", "attribute": "boneName", "reflects": true }, { "kind": "field", "name": "renderType", "type": { "text": "string" }, "default": "\"view\"", "description": "set renderType", "attribute": "renderType", "reflects": true }, { "kind": "field", "name": "renderLabel", "type": { "text": "boolean" }, "default": "false", "description": "set renderLabel", "attribute": "renderLabel", "reflects": true }, { "kind": "field", "name": "rendersaveButton", "type": { "text": "boolean" }, "default": "false", "description": "If true we render the Save Button in the edit view rendersaveButton", "attribute": "rendersaveButton", "reflects": true }, { "kind": "field", "name": "errors", "type": { "text": "BoneError[]" }, "description": "set boneError", "attribute": "errors" }, { "kind": "field", "name": "inTable", "type": { "text": "boolean" }, "default": "false", "description": "If true the Bone will be rendered in the table format" }, { "kind": "field", "name": "inVi", "type": { "text": "boolean" }, "default": "false", "description": "If true the relational bone fire an event for the VI" }, { "kind": "field", "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Can be set to true if the bone should be readonly", "attribute": "disabled", "reflects": true }, { "kind": "field", "name": "changeAllways", "type": { "text": "boolean" }, "default": "false", "description": "If true the change handler call on with type init and edit on start if a value is given", "attribute": "changeAllways", "reflects": true }, { "kind": "field", "name": "apiUrl", "description": "The url for uploading files and update bone values if we are in a table", "attribute": "apiUrl", "reflects": true }, { "kind": "field", "name": "type", "type": { "text": "string" }, "default": "\"\"", "description": "If we have no `boneStructure` we can set the name for a html form", "attribute": "type", "reflects": true }, { "kind": "field", "name": "name", "type": { "text": "null" }, "default": "null", "description": "If we have no `boneStructure` we can set the type to render the right bone ('file' renders a fileBone)", "attribute": "name", "reflects": true }, { "kind": "field", "name": "fromjson", "type": { "text": "boolean" }, "default": "false", "attribute": "fromjson", "reflects": true }, { "kind": "field", "name": "getBoneValue", "type": { "text": "any" }, "description": "Gets boneValue" }, { "kind": "method", "name": "getBoneValueforFormData", "return": { "type": { "text": "any" } }, "parameters": [ { "name": "boneInstance", "type": { "text": "SlBone" } } ] }, { "kind": "method", "name": "toFormValue" }, { "kind": "method", "name": "toFormData" }, { "kind": "method", "name": "getRenderer" }, { "kind": "method", "name": "changeAllwaysUpdate" }, { "kind": "method", "name": "optionUpdate" }, { "kind": "method", "name": "convertboneStructure", "parameters": [ { "name": "boneStructure", "type": { "text": "BoneStructure" } } ] }, { "kind": "method", "name": "handleChange", "parameters": [ { "name": "type", "default": "\"edit\"" } ] }, { "kind": "method", "name": "handleInit", "parameters": [ { "name": "options" } ] }, { "kind": "method", "name": "openVISelect", "parameters": [ { "name": "boneName" } ] }, { "kind": "method", "name": "addRelation", "parameters": [ { "name": "skel", "type": { "text": "Array | SkelValues" } }, { "name": "boneName", "type": { "text": "string" } } ] }, { "kind": "method", "name": "handleError" }, { "kind": "method", "name": "loadDefaultBoneStructure" }, { "kind": "method", "name": "checkValidity" } ], "events": [ { "description": "Emitted when the bonevalues is change.", "name": "sl-bone-change", "reactName": "onSlBoneChange" }, { "description": "Emitted when the bonevalues is set or change the first time.", "name": "sl-bone-init", "reactName": "onSlBoneInit" }, { "description": "If `inVi` is `true` we fire this event on relation selection.", "name": "sl-bone-relational-select", "reactName": "onSlBoneRelationalSelect" } ], "attributes": [ { "name": "boneStructure", "type": { "text": "any" }, "description": "If we have a boneStructure we can set it", "fieldName": "boneStructure" }, { "name": "boneValue", "type": { "text": "any" }, "description": "set boneValue", "fieldName": "boneValue" }, { "name": "boneName", "type": { "text": "string" }, "description": "set the boneName", "fieldName": "boneName" }, { "name": "renderType", "type": { "text": "string" }, "default": "\"view\"", "description": "set renderType", "fieldName": "renderType" }, { "name": "renderLabel", "type": { "text": "boolean" }, "default": "false", "description": "set renderLabel", "fieldName": "renderLabel" }, { "name": "rendersaveButton", "type": { "text": "boolean" }, "default": "false", "description": "If true we render the Save Button in the edit view rendersaveButton", "fieldName": "rendersaveButton" }, { "name": "errors", "type": { "text": "BoneError[]" }, "description": "set boneError", "fieldName": "errors" }, { "name": "disabled", "type": { "text": "boolean" }, "default": "false", "description": "Can be set to true if the bone should be readonly", "fieldName": "disabled" }, { "name": "changeAllways", "type": { "text": "boolean" }, "default": "false", "description": "If true the change handler call on with type init and edit on start if a value is given", "fieldName": "changeAllways" }, { "name": "apiUrl", "description": "The url for uploading files and update bone values if we are in a table", "fieldName": "apiUrl" }, { "name": "type", "type": { "text": "string" }, "default": "\"\"", "description": "If we have no `boneStructure` we can set the name for a html form", "fieldName": "type" }, { "name": "name", "type": { "text": "null" }, "default": "null", "description": "If we have no `boneStructure` we can set the type to render the right bone ('file' renders a fileBone)", "fieldName": "name" }, { "name": "fromjson", "type": { "text": "boolean" }, "default": "false", "fieldName": "fromjson" } ], "superclass": { "name": "ShoelaceElement", "module": "/src/internal/shoelace-element" }, "since": "2.0", "status": "experimental", "viur": "0.5", "dependencies": [ "sl-example" ], "tagName": "sl-bone", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBone", "module": "components/bone/bone.js" } }, { "kind": "custom-element-definition", "name": "sl-bone", "declaration": { "name": "SlBone", "module": "components/bone/bone.js" } } ] }, { "kind": "javascript-module", "path": "components/bone/boneEditRenderer.js", "declarations": [ { "kind": "class", "description": "", "name": "BoneEditRenderer", "members": [ { "kind": "field", "name": "boneValue", "type": { "text": "any | any[]" }, "default": "boneValue" }, { "kind": "field", "name": "boneName", "type": { "text": "string" }, "default": "boneName" }, { "kind": "field", "name": "mainInstance", "type": { "text": "SlBone" }, "default": "mainInstance" }, { "kind": "field", "name": "depth", "type": { "text": "number" }, "default": "0" }, { "kind": "field", "name": "boneStructure", "type": { "text": "BoneStructure" }, "default": "boneStructure" }, { "kind": "field", "name": "boneInstance", "type": { "text": "any" } }, { "kind": "method", "name": "getEditor" }, { "kind": "method", "name": "getBone", "return": { "type": { "text": "object" } } } ] } ], "exports": [ { "kind": "js", "name": "BoneEditRenderer", "declaration": { "name": "BoneEditRenderer", "module": "components/bone/boneEditRenderer.js" } } ] }, { "kind": "javascript-module", "path": "components/bone/boneViewRenderer.js", "declarations": [ { "kind": "class", "description": "", "name": "BoneViewRenderer", "members": [ { "kind": "field", "name": "boneStructure", "type": { "text": "{\n descr: string;\n type: string;\n required: boolean;\n params: object;\n visible: boolean;\n readonly: boolean;\n unique: boolean;\n languages: string[];\n emptyvalue: any;\n multiple: boolean;\n //Optional Fields\n\n //relational\n module: string;\n format: string;\n using: [];\n relskel: object;\n\n //select\n values: [];\n\n //date\n date: boolean;\n time: boolean;\n\n //numeric\n precision: number;\n minAmount: number;\n maxAmount: number;\n\n //text\n valid_html: string[];\n\n //file\n valid_mime_types: string[];\n\n //spatial\n\n }" }, "default": "boneStructure" }, { "kind": "field", "name": "boneValue", "type": { "text": "any" }, "default": "boneValue" }, { "kind": "field", "name": "boneName", "type": { "text": "string" }, "default": "boneName" }, { "kind": "field", "name": "mainInstance", "type": { "text": "any" }, "default": "mainInstance" }, { "kind": "field", "name": "boneInstance", "type": { "text": "any" } }, { "kind": "method", "name": "boneFormatter" }, { "kind": "method", "name": "getBone", "return": { "type": { "text": "object" } } } ] } ], "exports": [ { "kind": "js", "name": "BoneViewRenderer", "declaration": { "name": "BoneViewRenderer", "module": "components/bone/boneViewRenderer.js" } } ] }, { "kind": "javascript-module", "path": "components/bone/interfaces.js", "declarations": [], "exports": [] }, { "kind": "javascript-module", "path": "components/bone/utils.js", "declarations": [ { "kind": "function", "name": "formatstring", "return": { "type": { "text": "BoneValue" } }, "parameters": [ { "name": "data", "type": { "text": "BoneValue" } }, { "name": "boneStructure", "type": { "text": "BoneStructure" } }, { "name": "lang", "default": "null", "type": { "text": "string | null" } }, { "name": "ignoreLang", "default": "false" } ] }, { "kind": "function", "name": "createPath", "parameters": [ { "name": "obj", "type": { "text": "object" } }, { "name": "path", "type": { "text": "string | string[]" } }, { "name": "value", "default": "null", "type": { "text": "any | null" } }, { "name": "mustdelete", "default": "false" }, { "name": "mustsplice", "default": "false" } ] }, { "kind": "function", "name": "getPath", "return": { "type": { "text": "BoneValue | undefined" } }, "parameters": [ { "name": "obj", "type": { "text": "object" } }, { "name": "path", "type": { "text": "string | string[]" } } ] }, { "kind": "function", "name": "escapeString", "return": { "type": { "text": "string | string[]" } }, "parameters": [ { "name": "value", "type": { "text": "BoneValue" } } ] }, { "kind": "function", "name": "getSkey", "parameters": [ { "name": "apiUrl", "type": { "text": "string" } } ] }, { "kind": "function", "name": "translate", "parameters": [ { "name": "args" } ] } ], "exports": [ { "kind": "js", "name": "formatstring", "declaration": { "name": "formatstring", "module": "components/bone/utils.js" } }, { "kind": "js", "name": "createPath", "declaration": { "name": "createPath", "module": "components/bone/utils.js" } }, { "kind": "js", "name": "getPath", "declaration": { "name": "getPath", "module": "components/bone/utils.js" } }, { "kind": "js", "name": "escapeString", "declaration": { "name": "escapeString", "module": "components/bone/utils.js" } }, { "kind": "js", "name": "getSkey", "declaration": { "name": "getSkey", "module": "components/bone/utils.js" } }, { "kind": "js", "name": "translate", "declaration": { "name": "translate", "module": "components/bone/utils.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": "localize", "privacy": "private", "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" }, "summary": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.", "documentation": "https://shoelace.style/components/breadcrumb", "status": "stable", "since": "2.0", "dependencies": [ "sl-icon" ], "tagName": "sl-breadcrumb", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBreadcrumb", "module": "components/breadcrumb/breadcrumb.js" } }, { "kind": "custom-element-definition", "name": "sl-breadcrumb", "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", "default": "new HasSlotController(this, 'prefix', 'suffix')" }, { "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" } ], "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" }, "summary": "Breadcrumb Items are used inside [breadcrumbs](/components/breadcrumb) to represent different links.", "documentation": "https://shoelace.style/components/breadcrumb-item", "status": "stable", "since": "2.0", "tagName": "sl-breadcrumb-item", "customElement": true } ], "exports": [ { "kind": "js", "name": "default", "declaration": { "name": "SlBreadcrumbItem", "module": "components/breadcrumb-item/breadcrumb-item.js" } }, { "kind": "custom-element-definition", "name": "sl-breadcrumb-item", "declaration": { "name": "SlBreadcrumbItem", "module": "components/breadcrumb-item/breadcrumb-item.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" } ], "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": "formControlController", "privacy": "private", "default": "new FormControlController(this, {\n form: input => {\n // Buttons support a form attribute that points to an arbitrary form, so if this attribute is set we need to query\n // the form from the same root using its id\n if (input.hasAttribute('form')) {\n const doc = input.getRootNode() as Document | ShadowRoot;\n const formId = input.getAttribute('form')!;\n return doc.getElementById(formId) as HTMLFormElement;\n }\n\n // Fall back to the closest containing form\n return input.closest('form');\n },\n assumeInteractionOn: ['click']\n })" }, { "kind": "field", "name": "hasSlotController", "privacy": "private", "default": "new HasSlotController(this, '[default]', 'prefix', 'suffix')" }, { "kind": "field", "name": "localize", "privacy": "private", "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' | 'info' | 'secondary'" }, "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`