{ "$schema": "http://json.schemastore.org/web-types", "name": "@jeysonj2/circular", "version": "1.7.0", "description-markup": "markdown", "framework-config": { "enable-when": { "node-packages": [ "@jeysonj2/circular" ] } }, "contributions": { "html": { "elements": [ { "name": "o-alert", "description": "", "doc-url": "https://circular.decodeit.co/alert", "js": { "properties": [ { "name": "dependencies", "value": { "type": "object" } }, { "name": "autoHideTimeout", "value": { "type": "number" } }, { "name": "hasSlotController", "value": {} }, { "name": "localize", "value": {} }, { "name": "toastElement", "value": { "type": "OAlert | undefined" } }, { "name": "base", "value": { "type": "HTMLElement" } }, { "name": "open", "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.", "value": { "type": "boolean" } }, { "name": "closable", "description": "Enables a close button that allows the user to dismiss the alert.", "value": { "type": "boolean" } }, { "name": "variant", "description": "The alert's theme variant.", "value": { "type": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" } }, { "name": "duration", "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.", "value": {} }, { "name": "openToast", "description": "Indicates whether or not the alert should open using toast function. You can toggle this attribute to show the\nalert as toast, or you can use the `toast()` method and this attribute will reflect the alert's open-toast state.", "value": { "type": "boolean" } }, { "name": "restartAutoHide", "value": {} }, { "name": "handleCloseClick", "value": {} }, { "name": "handleMouseMove", "value": {} }, { "name": "handleOpenChange", "value": {} }, { "name": "handleDurationChange", "value": {} }, { "name": "handleOpenToastChange", "value": {} }, { "name": "show", "description": "Shows the alert.", "value": {} }, { "name": "hide", "description": "Hides the alert", "value": {} }, { "name": "toastClone", "value": {} }, { "name": "setToastElement", "value": {} }, { "name": "getToastElement", "value": {} }, { "name": "isToast", "value": {} }, { "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.", "value": {} } ], "events": [ { "name": "o-show", "description": "Emitted when the alert opens." }, { "name": "o-after-show", "description": "Emitted after the alert opens and all animations are complete." }, { "name": "o-hide", "description": "Emitted when the alert closes." }, { "name": "o-after-hide", "description": "Emitted after the alert closes and all animations are complete." }, { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "open", "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.", "value": { "type": "boolean" } }, { "name": "closable", "description": "Enables a close button that allows the user to dismiss the alert.", "value": { "type": "boolean" } }, { "name": "variant", "description": "The alert's theme variant.", "value": { "type": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" } }, { "name": "duration", "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.", "value": {} }, { "name": "open-toast", "description": "Indicates whether or not the alert should open using toast function. You can toggle this attribute to show the\nalert as toast, or you can use the `toast()` method and this attribute will reflect the alert's open-toast state.", "value": { "type": "boolean" } } ] }, { "name": "o-animated-image", "description": "", "doc-url": "https://circular.decodeit.co/animated-image", "js": { "properties": [ { "name": "dependencies", "value": { "type": "object" } }, { "name": "animatedImage", "value": { "type": "HTMLImageElement" } }, { "name": "frozenFrame", "value": { "type": "string" } }, { "name": "isLoaded", "value": { "type": "boolean" } }, { "name": "src", "description": "The path to the image to load.", "value": { "type": "string" } }, { "name": "alt", "description": "A description of the image used by assistive devices.", "value": { "type": "string" } }, { "name": "play", "description": "Plays the animation. When this attribute is remove, the animation will pause.", "value": { "type": "boolean" } }, { "name": "handleClick", "value": {} }, { "name": "handleLoad", "value": {} }, { "name": "handleError", "value": {} }, { "name": "handlePlayChange", "value": {} }, { "name": "handleSrcChange", "value": {} } ], "events": [ { "name": "o-load", "description": "Emitted when the image loads successfully." }, { "name": "o-error", "description": "Emitted when the image fails to load." }, { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "src", "description": "The path to the image to load.", "value": { "type": "string" } }, { "name": "alt", "description": "A description of the image used by assistive devices.", "value": { "type": "string" } }, { "name": "play", "description": "Plays the animation. When this attribute is remove, the animation will pause.", "value": { "type": "boolean" } } ] }, { "name": "o-animation", "description": "", "doc-url": "https://circular.decodeit.co/animation", "js": { "properties": [ { "name": "animation", "value": { "type": "Animation | undefined" } }, { "name": "hasStarted", "value": { "type": "boolean" } }, { "name": "defaultSlot", "value": { "type": "Promise" } }, { "name": "name", "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.", "value": { "type": "string" } }, { "name": "play", "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.", "value": { "type": "boolean" } }, { "name": "delay", "description": "The number of milliseconds to delay the start of the animation.", "value": { "type": "number" } }, { "name": "direction", "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)", "value": { "type": "PlaybackDirection" } }, { "name": "duration", "description": "The number of milliseconds each iteration of the animation takes to complete.", "value": { "type": "number" } }, { "name": "easing", "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)`.", "value": { "type": "string" } }, { "name": "endDelay", "description": "The number of milliseconds to delay after the active period of an animation sequence.", "value": { "type": "number" } }, { "name": "fill", "description": "Sets how the animation applies styles to its target before and after its execution.", "value": { "type": "FillMode" } }, { "name": "iterations", "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.", "value": {} }, { "name": "iterationStart", "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).", "value": { "type": "number" } }, { "name": "keyframes", "description": "The keyframes to use for the animation. If this is set, `name` will be ignored.", "value": { "type": "Keyframe[] | undefined" } }, { "name": "playbackRate", "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.", "value": { "type": "number" } }, { "name": "currentTime", "description": "Gets and sets the current animation time.", "value": { "type": "CSSNumberish" } }, { "name": "handleAnimationFinish", "value": {} }, { "name": "handleAnimationCancel", "value": {} }, { "name": "handleSlotChange", "value": {} }, { "name": "createAnimation", "value": {} }, { "name": "destroyAnimation", "value": {} }, { "name": "handleAnimationChange", "value": {} }, { "name": "handlePlayChange", "value": {} }, { "name": "handlePlaybackRateChange", "value": {} }, { "name": "cancel", "description": "Clears all keyframe effects caused by this animation and aborts its playback.", "value": {} }, { "name": "finish", "description": "Sets the playback time to the end of the animation corresponding to the current playback direction.", "value": {} } ], "events": [ { "name": "o-cancel", "description": "Emitted when the animation is canceled." }, { "name": "o-finish", "description": "Emitted when the animation finishes." }, { "name": "o-start", "description": "Emitted when the animation starts or restarts." }, { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "name", "description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.", "value": { "type": "string" } }, { "name": "play", "description": "Plays the animation. When omitted, the animation will be paused. This attribute will be automatically removed when\nthe animation finishes or gets canceled.", "value": { "type": "boolean" } }, { "name": "delay", "description": "The number of milliseconds to delay the start of the animation.", "value": { "type": "number" } }, { "name": "direction", "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)", "value": { "type": "PlaybackDirection" } }, { "name": "duration", "description": "The number of milliseconds each iteration of the animation takes to complete.", "value": { "type": "number" } }, { "name": "easing", "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)`.", "value": { "type": "string" } }, { "name": "end-delay", "description": "The number of milliseconds to delay after the active period of an animation sequence.", "value": { "type": "number" } }, { "name": "fill", "description": "Sets how the animation applies styles to its target before and after its execution.", "value": { "type": "FillMode" } }, { "name": "iterations", "description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.", "value": {} }, { "name": "iteration-start", "description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).", "value": { "type": "number" } }, { "name": "playback-rate", "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.", "value": { "type": "number" } } ] }, { "name": "o-avatar", "description": "", "doc-url": "https://circular.decodeit.co/avatar", "js": { "properties": [ { "name": "dependencies", "value": { "type": "object" } }, { "name": "hasError", "value": { "type": "boolean" } }, { "name": "image", "description": "The image source to use for the avatar.", "value": { "type": "string" } }, { "name": "label", "description": "A label to use to describe the avatar to assistive devices.", "value": { "type": "string" } }, { "name": "initials", "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).", "value": { "type": "string" } }, { "name": "loading", "description": "Indicates how the browser should load the image.", "value": { "type": "'eager' | 'lazy'" } }, { "name": "shape", "description": "The shape of the avatar.", "value": { "type": "'circle' | 'square' | 'rounded'" } }, { "name": "handleImageChange", "value": {} } ], "events": [ { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "image", "description": "The image source to use for the avatar.", "value": { "type": "string" } }, { "name": "label", "description": "A label to use to describe the avatar to assistive devices.", "value": { "type": "string" } }, { "name": "initials", "description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).", "value": { "type": "string" } }, { "name": "loading", "description": "Indicates how the browser should load the image.", "value": { "type": "'eager' | 'lazy'" } }, { "name": "shape", "description": "The shape of the avatar.", "value": { "type": "'circle' | 'square' | 'rounded'" } } ] }, { "name": "o-badge", "description": "", "doc-url": "https://circular.decodeit.co/badge", "js": { "properties": [ { "name": "variant", "description": "The badge's theme variant.", "value": { "type": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" } }, { "name": "pill", "description": "Draws a pill-style badge with rounded edges.", "value": { "type": "boolean" } }, { "name": "pulse", "description": "Makes the badge pulsate to draw attention.", "value": { "type": "boolean" } } ], "events": [ { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "variant", "description": "The badge's theme variant.", "value": { "type": "'primary' | 'success' | 'neutral' | 'warning' | 'danger'" } }, { "name": "pill", "description": "Draws a pill-style badge with rounded edges.", "value": { "type": "boolean" } }, { "name": "pulse", "description": "Makes the badge pulsate to draw attention.", "value": { "type": "boolean" } } ] }, { "name": "o-breadcrumb", "description": "", "doc-url": "https://circular.decodeit.co/breadcrumb", "js": { "properties": [ { "name": "dependencies", "value": { "type": "object" } }, { "name": "localize", "value": {} }, { "name": "separatorDir", "value": {} }, { "name": "defaultSlot", "value": { "type": "HTMLSlotElement" } }, { "name": "separatorSlot", "value": { "type": "HTMLSlotElement" } }, { "name": "label", "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.", "value": { "type": "string" } }, { "name": "getSeparator", "value": {} }, { "name": "handleSlotChange", "value": {} } ], "events": [ { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "label", "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.", "value": { "type": "string" } } ] }, { "name": "o-breadcrumb-item", "description": "", "doc-url": "https://circular.decodeit.co/breadcrumb-item", "js": { "properties": [ { "name": "hasSlotController", "value": {} }, { "name": "href", "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.", "value": { "type": "string | undefined" } }, { "name": "target", "description": "Tells the browser where to open the link. Only used when `href` is set.", "value": { "type": "'_blank' | '_parent' | '_self' | '_top' | undefined" } }, { "name": "rel", "description": "The `rel` attribute to use on the link. Only used when `href` is set.", "value": { "type": "string" } } ], "events": [ { "name": "o-connected", "description": "Fired when the component is added to the document's DOM." }, { "name": "o-disconnected", "description": "Fired when the component is removed from the document's DOM." } ] }, "attributes": [ { "name": "href", "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.", "value": { "type": "string | undefined" } }, { "name": "target", "description": "Tells the browser where to open the link. Only used when `href` is set.", "value": { "type": "'_blank' | '_parent' | '_self' | '_top' | undefined" } }, { "name": "rel", "description": "The `rel` attribute to use on the link. Only used when `href` is set.", "value": { "type": "string" } } ] }, { "name": "o-button", "description": "", "doc-url": "https://circular.decodeit.co/button", "js": { "properties": [ { "name": "dependencies", "value": { "type": "object" } }, { "name": "formControlController", "value": {} }, { "name": "hasSlotController", "value": {} }, { "name": "localize", "value": {} }, { "name": "button", "value": { "type": "HTMLButtonElement | HTMLLinkElement" } }, { "name": "hasFocus", "value": { "type": "boolean" } }, { "name": "invalid", "value": { "type": "boolean" } }, { "name": "title", "value": { "type": "string" } }, { "name": "variant", "description": "The button's theme variant.", "value": { "type": "'default' | 'primary' | 'success' | 'neutral' | 'warning' | 'danger' | 'text'" } }, { "name": "size", "description": "The button's size.", "value": { "type": "'small' | 'medium' | 'large'" } }, { "name": "caret", "description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.", "value": { "type": "boolean" } }, { "name": "disabled", "description": "Disables the button.", "value": { "type": "boolean" } }, { "name": "loading", "description": "Draws the button in a loading state.", "value": { "type": "boolean" } }, { "name": "outline", "description": "Draws an outlined button.", "value": { "type": "boolean" } }, { "name": "square", "description": "Draws a square button with rounded borders.", "value": { "type": "boolean" } }, { "name": "circle", "description": "Draws a circular icon button. When this attribute is present, the button expects a single `` in the\ndefault slot.", "value": { "type": "boolean" } }, { "name": "type", "description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`