7021 lines
355 KiB
JSON
7021 lines
355 KiB
JSON
{
|
||
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
|
||
"name": "@awesome.me/webawesome-pro",
|
||
"version": "3.1.0",
|
||
"description-markup": "markdown",
|
||
"contributions": {
|
||
"html": {
|
||
"elements": [
|
||
{
|
||
"name": "wa-animated-image",
|
||
"description": "A component for displaying animated GIFs and WEBPs that play and pause on interaction.\n---\n\n\n### **Events:**\n - **wa-load** - Emitted when the image loads successfully.\n- **wa-error** - Emitted when the image fails to load.\n\n### **Slots:**\n - **play-icon** - Optional play icon to use instead of the default. Works best with `<wa-icon>`.\n- **pause-icon** - Optional pause icon to use instead of the default. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--control-box-size** - The size of the icon box. _(default: undefined)_\n- **--icon-size** - The size of the play/pause icons. _(default: undefined)_\n\n### **CSS Parts:**\n - **control-box** - The container that surrounds the pause/play icons and provides their background.",
|
||
"doc-url": "",
|
||
"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" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "play-icon",
|
||
"description": "Optional play icon to use instead of the default. Works best with `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "pause-icon",
|
||
"description": "Optional pause icon to use instead of the default. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-load",
|
||
"description": "Emitted when the image loads successfully."
|
||
},
|
||
{
|
||
"name": "wa-error",
|
||
"description": "Emitted when the image fails to load."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "animatedImage", "type": "HTMLImageElement" },
|
||
{ "name": "frozenFrame", "type": "string" },
|
||
{ "name": "isLoaded", "type": "boolean" },
|
||
{
|
||
"name": "src",
|
||
"description": "The path to the image to load.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "alt",
|
||
"description": "A description of the image used by assistive devices.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "play",
|
||
"description": "Plays the animation. When this attribute is remove, the animation will pause.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-load",
|
||
"description": "Emitted when the image loads successfully."
|
||
},
|
||
{
|
||
"name": "wa-error",
|
||
"description": "Emitted when the image fails to load."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-animation",
|
||
"description": "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---\n\n\n### **Events:**\n - **wa-cancel** - Emitted when the animation is canceled.\n- **wa-finish** - Emitted when the animation finishes.\n- **wa-start** - Emitted when the animation starts or restarts.\n\n### **Methods:**\n - **cancel()** - Clears all keyframe effects caused by this animation and aborts its playback.\n- **finish()** - Sets the playback time to the end of the animation corresponding to the current playback direction.\n\n### **Slots:**\n - _default_ - 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 `<wa-animation>` elements.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.",
|
||
"value": { "type": "string", "default": "'none'" }
|
||
},
|
||
{
|
||
"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", "default": "false" }
|
||
},
|
||
{
|
||
"name": "delay",
|
||
"description": "The number of milliseconds to delay the start of the animation.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"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", "default": "'normal'" }
|
||
},
|
||
{
|
||
"name": "duration",
|
||
"description": "The number of milliseconds each iteration of the animation takes to complete.",
|
||
"value": { "type": "number", "default": "1000" }
|
||
},
|
||
{
|
||
"name": "easing",
|
||
"description": "The easing function to use for the animation. This can be a Web Awesome easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
|
||
"value": { "type": "string", "default": "'linear'" }
|
||
},
|
||
{
|
||
"name": "end-delay",
|
||
"description": "The number of milliseconds to delay after the active period of an animation sequence.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "fill",
|
||
"description": "Sets how the animation applies styles to its target before and after its execution.",
|
||
"value": { "type": "FillMode", "default": "'auto'" }
|
||
},
|
||
{
|
||
"name": "iterations",
|
||
"description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
|
||
"value": { "type": "number", "default": "Infinity" }
|
||
},
|
||
{
|
||
"name": "iteration-start",
|
||
"description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"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", "default": "1" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"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 `<wa-animation>` elements."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-cancel",
|
||
"description": "Emitted when the animation is canceled."
|
||
},
|
||
{
|
||
"name": "wa-finish",
|
||
"description": "Emitted when the animation finishes."
|
||
},
|
||
{
|
||
"name": "wa-start",
|
||
"description": "Emitted when the animation starts or restarts."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "Promise<HTMLSlotElement>" },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the built-in animation to use. For custom animations, use the `keyframes` prop.",
|
||
"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.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "delay",
|
||
"description": "The number of milliseconds to delay the start of the animation.",
|
||
"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)",
|
||
"type": "PlaybackDirection"
|
||
},
|
||
{
|
||
"name": "duration",
|
||
"description": "The number of milliseconds each iteration of the animation takes to complete.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "easing",
|
||
"description": "The easing function to use for the animation. This can be a Web Awesome easing function or a custom easing function\nsuch as `cubic-bezier(0, 1, .76, 1.14)`.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "endDelay",
|
||
"description": "The number of milliseconds to delay after the active period of an animation sequence.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "fill",
|
||
"description": "Sets how the animation applies styles to its target before and after its execution.",
|
||
"type": "FillMode"
|
||
},
|
||
{
|
||
"name": "iterations",
|
||
"description": "The number of iterations to run before the animation completes. Defaults to `Infinity`, which loops.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "iterationStart",
|
||
"description": "The offset at which to start the animation, usually between 0 (start) and 1 (end).",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "keyframes",
|
||
"description": "The keyframes to use for the animation. If this is set, `name` will be ignored.",
|
||
"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.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "currentTime",
|
||
"description": "Gets and sets the current animation time.",
|
||
"type": "CSSNumberish"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-cancel",
|
||
"description": "Emitted when the animation is canceled."
|
||
},
|
||
{
|
||
"name": "wa-finish",
|
||
"description": "Emitted when the animation finishes."
|
||
},
|
||
{
|
||
"name": "wa-start",
|
||
"description": "Emitted when the animation starts or restarts."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-avatar",
|
||
"description": "Avatars are used to represent a person or object.\n---\n\n\n### **Events:**\n - **wa-error** - The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause.\n\n### **Slots:**\n - **icon** - The default icon to use when no image or initials are present. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--size** - The size of the avatar. _(default: undefined)_\n\n### **CSS Parts:**\n - **icon** - The container that wraps the avatar's icon.\n- **initials** - The container that wraps the avatar's initials.\n- **image** - The avatar image. Only shown when the `image` attribute is set.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "image",
|
||
"description": "The image source to use for the avatar.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "A label to use to describe the avatar to assistive devices.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "initials",
|
||
"description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "loading",
|
||
"description": "Indicates how the browser should load the image.",
|
||
"value": { "type": "'eager' | 'lazy'", "default": "'eager'" }
|
||
},
|
||
{
|
||
"name": "shape",
|
||
"description": "The shape of the avatar.",
|
||
"value": {
|
||
"type": "'circle' | 'square' | 'rounded'",
|
||
"default": "'circle'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "icon",
|
||
"description": "The default icon to use when no image or initials are present. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-error",
|
||
"description": "The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "image",
|
||
"description": "The image source to use for the avatar.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "A label to use to describe the avatar to assistive devices.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "initials",
|
||
"description": "Initials to use as a fallback when no image is available (1-2 characters max recommended).",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "loading",
|
||
"description": "Indicates how the browser should load the image.",
|
||
"type": "'eager' | 'lazy'"
|
||
},
|
||
{
|
||
"name": "shape",
|
||
"description": "The shape of the avatar.",
|
||
"type": "'circle' | 'square' | 'rounded'"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-error",
|
||
"description": "The image could not be loaded. This may because of an invalid URL, a temporary network condition, or some unknown cause."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-badge",
|
||
"description": "Badges are used to draw attention and display statuses or counts.\n---\n\n\n### **Slots:**\n - _default_ - The badge's content.\n\n### **CSS Properties:**\n - **--pulse-color** - The color of the badge's pulse effect when using `attention=\"pulse\"`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The badge's theme variant. Defaults to `brand` if not within another element with a variant.",
|
||
"value": {
|
||
"type": "'brand' | 'neutral' | 'success' | 'warning' | 'danger'",
|
||
"default": "'brand'"
|
||
}
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The badge's visual appearance.",
|
||
"value": {
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined'",
|
||
"default": "'accent'"
|
||
}
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style badge with rounded edges.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "attention",
|
||
"description": "Adds an animation to draw attention to the badge.",
|
||
"value": {
|
||
"type": "'none' | 'pulse' | 'bounce'",
|
||
"default": "'none'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [{ "name": "", "description": "The badge's content." }],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The badge's theme variant. Defaults to `brand` if not within another element with a variant.",
|
||
"type": "'brand' | 'neutral' | 'success' | 'warning' | 'danger'"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The badge's visual appearance.",
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style badge with rounded edges.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "attention",
|
||
"description": "Adds an animation to draw attention to the badge.",
|
||
"type": "'none' | 'pulse' | 'bounce'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-breadcrumb-item",
|
||
"description": "Breadcrumb Items are used inside breadcrumbs to represent different links.\n---\n\n\n### **Slots:**\n - _default_ - The breadcrumb item's label.\n- **start** - An element, such as `<wa-icon>`, placed before the label.\n- **end** - An element, such as `<wa-icon>`, placed after the label.\n- **separator** - 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 `<wa-breadcrumb>` instead.\n\n### **CSS Parts:**\n - **label** - The breadcrumb item's label.\n- **start** - The container that wraps the `start` slot.\n- **end** - The container that wraps the `end` slot.\n- **separator** - The container that wraps the separator.",
|
||
"doc-url": "",
|
||
"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", "default": "'noreferrer noopener'" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The breadcrumb item's label." },
|
||
{
|
||
"name": "start",
|
||
"description": "An element, such as `<wa-icon>`, placed before the label."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "An element, such as `<wa-icon>`, placed after the label."
|
||
},
|
||
{
|
||
"name": "separator",
|
||
"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 `<wa-breadcrumb>` instead."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{
|
||
"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.",
|
||
"type": "string | undefined"
|
||
},
|
||
{
|
||
"name": "target",
|
||
"description": "Tells the browser where to open the link. Only used when `href` is set.",
|
||
"type": "'_blank' | '_parent' | '_self' | '_top' | undefined"
|
||
},
|
||
{
|
||
"name": "rel",
|
||
"description": "The `rel` attribute to use on the link. Only used when `href` is set.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-breadcrumb",
|
||
"description": "Breadcrumbs provide a group of links so users can easily navigate a website's hierarchy.\n---\n\n\n### **Slots:**\n - _default_ - One or more breadcrumb items to display.\n- **separator** - The separator to use between breadcrumb items. Works best with `<wa-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"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", "default": "''" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "One or more breadcrumb items to display."
|
||
},
|
||
{
|
||
"name": "separator",
|
||
"description": "The separator to use between breadcrumb items. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "separatorSlot", "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.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-button-group",
|
||
"description": "Button groups can be used to group related buttons into sections.\n---\n\n\n### **Slots:**\n - _default_ - One or more `<wa-button>` elements to display in the button group.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "label",
|
||
"description": "A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive\ndevices when interacting with the control and is strongly recommended.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "The button group's orientation.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'horizontal'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "One or more `<wa-button>` elements to display in the button group."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "disableRole", "type": "boolean" },
|
||
{ "name": "hasOutlined", "type": "boolean" },
|
||
{
|
||
"name": "label",
|
||
"description": "A label to use for the button group. This won't be displayed on the screen, but it will be announced by assistive\ndevices when interacting with the control and is strongly recommended.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "The button group's orientation.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-button",
|
||
"description": "Buttons represent actions that are available to the user.\n---\n\n\n### **Events:**\n - **blur** - Emitted when the button loses focus.\n- **focus** - Emitted when the button gains focus.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n\n### **Slots:**\n - _default_ - The button's label.\n- **start** - An element, such as `<wa-icon>`, placed before the label.\n- **end** - An element, such as `<wa-icon>`, placed after the label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **start** - The container that wraps the `start` slot.\n- **label** - The button's label.\n- **end** - The container that wraps the `end` slot.\n- **caret** - The button's caret icon, a `<wa-icon>` element.\n- **spinner** - The spinner that shows when the button is in the loading state.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
||
{
|
||
"name": "variant",
|
||
"description": "The button's theme variant. Defaults to `neutral` if not within another element with a variant.",
|
||
"value": {
|
||
"type": "'neutral' | 'brand' | 'success' | 'warning' | 'danger'",
|
||
"default": "'neutral'"
|
||
}
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The button's visual appearance.",
|
||
"value": {
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined' | 'plain'",
|
||
"default": "'accent'"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The button's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "with-caret",
|
||
"description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the button. Does not apply to link buttons.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "loading",
|
||
"description": "Draws the button in a loading state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style button with rounded edges.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "type",
|
||
"description": "The type of button. Note that the default value is `button` instead of `submit`, which is opposite of how native\n`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
|
||
"value": {
|
||
"type": "'button' | 'submit' | 'reset'",
|
||
"default": "'button'"
|
||
}
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "href",
|
||
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "target",
|
||
"description": "Tells the browser where to open the link. Only used when `href` is present.",
|
||
"value": { "type": "'_blank' | '_parent' | '_self' | '_top'" }
|
||
},
|
||
{
|
||
"name": "rel",
|
||
"description": "When using `href`, this attribute will map to the underlying link's `rel` attribute.",
|
||
"value": { "type": "string | undefined" }
|
||
},
|
||
{
|
||
"name": "download",
|
||
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
|
||
"value": { "type": "string | undefined" }
|
||
},
|
||
{
|
||
"name": "formaction",
|
||
"description": "Used to override the form owner's `action` attribute.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "formenctype",
|
||
"description": "Used to override the form owner's `enctype` attribute.",
|
||
"value": {
|
||
"type": "'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'"
|
||
}
|
||
},
|
||
{
|
||
"name": "formmethod",
|
||
"description": "Used to override the form owner's `method` attribute.",
|
||
"value": { "type": "'post' | 'get'" }
|
||
},
|
||
{
|
||
"name": "formnovalidate",
|
||
"description": "Used to override the form owner's `novalidate` attribute.",
|
||
"value": { "type": "boolean" }
|
||
},
|
||
{
|
||
"name": "formtarget",
|
||
"description": "Used to override the form owner's `target` attribute.",
|
||
"value": {
|
||
"type": "'_self' | '_blank' | '_parent' | '_top' | string"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The button's label." },
|
||
{
|
||
"name": "start",
|
||
"description": "An element, such as `<wa-icon>`, placed before the label."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "An element, such as `<wa-icon>`, placed after the label."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the button loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the button gains focus."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "assumeInteractionOn", "type": "array" },
|
||
{
|
||
"name": "button",
|
||
"type": "HTMLButtonElement | HTMLLinkElement"
|
||
},
|
||
{ "name": "labelSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "invalid", "type": "boolean" },
|
||
{ "name": "isIconButton", "type": "boolean" },
|
||
{ "name": "title", "type": "string" },
|
||
{
|
||
"name": "variant",
|
||
"description": "The button's theme variant. Defaults to `neutral` if not within another element with a variant.",
|
||
"type": "'neutral' | 'brand' | 'success' | 'warning' | 'danger'"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The button's visual appearance.",
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined' | 'plain'"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The button's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "withCaret",
|
||
"description": "Draws the button with a caret. Used to indicate that the button triggers a dropdown menu or similar behavior.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the button. Does not apply to link buttons.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "loading",
|
||
"description": "Draws the button in a loading state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style button with rounded edges.",
|
||
"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`<button>` elements behave. When the type is `submit`, the button will submit the surrounding form.",
|
||
"type": "'button' | 'submit' | 'reset'"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the button, submitted as a name/value pair with form data, but only when this button is the submitter.\nThis attribute is ignored when `href` is present.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The value of the button, submitted as a pair with the button's name as part of the form data, but only when this\nbutton is the submitter. This attribute is ignored when `href` is present.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "href",
|
||
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "target",
|
||
"description": "Tells the browser where to open the link. Only used when `href` is present.",
|
||
"type": "'_blank' | '_parent' | '_self' | '_top'"
|
||
},
|
||
{
|
||
"name": "rel",
|
||
"description": "When using `href`, this attribute will map to the underlying link's `rel` attribute.",
|
||
"type": "string | undefined"
|
||
},
|
||
{
|
||
"name": "download",
|
||
"description": "Tells the browser to download the linked file as this filename. Only used when `href` is present.",
|
||
"type": "string | undefined"
|
||
},
|
||
{
|
||
"name": "formAction",
|
||
"description": "Used to override the form owner's `action` attribute.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "formEnctype",
|
||
"description": "Used to override the form owner's `enctype` attribute.",
|
||
"type": "'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain'"
|
||
},
|
||
{
|
||
"name": "formMethod",
|
||
"description": "Used to override the form owner's `method` attribute.",
|
||
"type": "'post' | 'get'"
|
||
},
|
||
{
|
||
"name": "formNoValidate",
|
||
"description": "Used to override the form owner's `novalidate` attribute.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "formTarget",
|
||
"description": "Used to override the form owner's `target` attribute.",
|
||
"type": "'_self' | '_blank' | '_parent' | '_top' | string"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the button loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the button gains focus."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-callout",
|
||
"description": "Callouts are used to display important messages inline.\n---\n\n\n### **Slots:**\n - _default_ - The callout's main content.\n- **icon** - An icon to show in the callout. Works best with `<wa-icon>`.\n\n### **CSS Parts:**\n - **icon** - The container that wraps the optional icon.\n- **message** - The container that wraps the callout's main content.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The callout's theme variant. Defaults to `brand` if not within another element with a variant.",
|
||
"value": {
|
||
"type": "'brand' | 'neutral' | 'success' | 'warning' | 'danger'",
|
||
"default": "'brand'"
|
||
}
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The callout's visual appearance.",
|
||
"value": {
|
||
"type": "'accent' | 'filled' | 'outlined' | 'plain' | 'filled-outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The callout's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The callout's main content." },
|
||
{
|
||
"name": "icon",
|
||
"description": "An icon to show in the callout. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The callout's theme variant. Defaults to `brand` if not within another element with a variant.",
|
||
"type": "'brand' | 'neutral' | 'success' | 'warning' | 'danger'"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The callout's visual appearance.",
|
||
"type": "'accent' | 'filled' | 'outlined' | 'plain' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The callout's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-card",
|
||
"description": "Cards can be used to group related subjects in a container.\n---\n\n\n### **Slots:**\n - _default_ - The card's main content.\n- **header** - An optional header for the card.\n- **footer** - An optional footer for the card.\n- **media** - An optional media section to render at the start of the card.\n- **actions** - An optional actions section to render at the end for the horizontal card.\n- **header-actions** - An optional actions section to render in the header of the vertical card.\n- **footer-actions** - An optional actions section to render in the footer of the vertical card.\n\n### **CSS Properties:**\n - **--spacing** - The amount of space around and between sections of the card. Expects a single value. _(default: var(--wa-space-l))_\n\n### **CSS Parts:**\n - **media** - The container that wraps the card's media.\n- **header** - The container that wraps the card's header.\n- **body** - The container that wraps the card's main content.\n- **footer** - The container that wraps the card's footer.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "appearance",
|
||
"description": "The card's visual appearance.",
|
||
"value": {
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined' | 'plain'",
|
||
"default": "'outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "with-header",
|
||
"description": "Renders the card with a header. Only needed for SSR, otherwise is automatically added.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-media",
|
||
"description": "Renders the card with an image. Only needed for SSR, otherwise is automatically added.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-footer",
|
||
"description": "Renders the card with a footer. Only needed for SSR, otherwise is automatically added.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "Renders the card's orientation *",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'vertical'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The card's main content." },
|
||
{
|
||
"name": "header",
|
||
"description": "An optional header for the card."
|
||
},
|
||
{
|
||
"name": "footer",
|
||
"description": "An optional footer for the card."
|
||
},
|
||
{
|
||
"name": "media",
|
||
"description": "An optional media section to render at the start of the card."
|
||
},
|
||
{
|
||
"name": "actions",
|
||
"description": "An optional actions section to render at the end for the horizontal card."
|
||
},
|
||
{
|
||
"name": "header-actions",
|
||
"description": "An optional actions section to render in the header of the vertical card."
|
||
},
|
||
{
|
||
"name": "footer-actions",
|
||
"description": "An optional actions section to render in the footer of the vertical card."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "appearance",
|
||
"description": "The card's visual appearance.",
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined' | 'plain'"
|
||
},
|
||
{
|
||
"name": "withHeader",
|
||
"description": "Renders the card with a header. Only needed for SSR, otherwise is automatically added.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withMedia",
|
||
"description": "Renders the card with an image. Only needed for SSR, otherwise is automatically added.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withFooter",
|
||
"description": "Renders the card with a footer. Only needed for SSR, otherwise is automatically added.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "Renders the card's orientation *",
|
||
"type": "'horizontal' | 'vertical'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-carousel",
|
||
"description": "Carousels display an arbitrary number of content slides along a horizontal or vertical axis.\n---\n\n\n### **Events:**\n - **wa-slide-change** - Emitted when the active slide changes.\n\n### **Methods:**\n - **previous(behavior: _ScrollBehavior_)** - Move the carousel backward by `slides-per-move` slides.\n- **next(behavior: _ScrollBehavior_)** - Move the carousel forward by `slides-per-move` slides.\n- **goToSlide(index: _number_, behavior: _ScrollBehavior_)** - Scrolls the carousel to the slide specified by `index`.\n\n### **Slots:**\n - _default_ - The carousel's main content, one or more `<wa-carousel-item>` elements.\n- **next-icon** - Optional next icon to use instead of the default. Works best with `<wa-icon>`.\n- **previous-icon** - Optional previous icon to use instead of the default. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--aspect-ratio** - The aspect ratio of each slide. _(default: 16/9)_\n- **--scroll-hint** - The amount of padding to apply to the scroll area, allowing adjacent slides to become partially visible as a scroll hint. _(default: undefined)_\n- **--slide-gap** - The space between each slide. _(default: var(--wa-space-m))_\n\n### **CSS Parts:**\n - **base** - The carousel's internal wrapper.\n- **scroll-container** - The scroll container that wraps the slides.\n- **pagination** - The pagination indicators wrapper.\n- **pagination-item** - The pagination indicator.\n- **pagination-item-active** - Applied when the item is active.\n- **navigation** - The navigation wrapper.\n- **navigation-button** - The navigation button.\n- **navigation-button-previous** - Applied to the previous button.\n- **navigation-button-next** - Applied to the next button.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "loop",
|
||
"description": "When set, allows the user to navigate the carousel in the same direction indefinitely.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{ "name": "slides", "value": { "type": "number", "default": "0" } },
|
||
{
|
||
"name": "currentSlide",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "navigation",
|
||
"description": "When set, show the carousel's navigation.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"description": "When set, show the carousel's pagination indicators.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "autoplay",
|
||
"description": "When set, the slides will scroll automatically when the user is not interacting with them.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "autoplay-interval",
|
||
"description": "Specifies the amount of time, in milliseconds, between each automatic scroll.",
|
||
"value": { "type": "number", "default": "3000" }
|
||
},
|
||
{
|
||
"name": "slides-per-page",
|
||
"description": "Specifies how many slides should be shown at a given time.",
|
||
"value": { "type": "number", "default": "1" }
|
||
},
|
||
{
|
||
"name": "slides-per-move",
|
||
"description": "Specifies the number of slides the carousel will advance when scrolling, useful when specifying a `slides-per-page`\ngreater than one. It can't be higher than `slides-per-page`.",
|
||
"value": { "type": "number", "default": "1" }
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "Specifies the orientation in which the carousel will lay out.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'horizontal'"
|
||
}
|
||
},
|
||
{
|
||
"name": "mouse-dragging",
|
||
"description": "When set, it is possible to scroll through the slides by dragging them with the mouse.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The carousel's main content, one or more `<wa-carousel-item>` elements."
|
||
},
|
||
{
|
||
"name": "next-icon",
|
||
"description": "Optional next icon to use instead of the default. Works best with `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "previous-icon",
|
||
"description": "Optional previous icon to use instead of the default. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-slide-change",
|
||
"type": "{ index: number, slide: WaCarouselItem }",
|
||
"description": "Emitted when the active slide changes."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "loop",
|
||
"description": "When set, allows the user to navigate the carousel in the same direction indefinitely.",
|
||
"type": "boolean"
|
||
},
|
||
{ "name": "slides", "type": "number" },
|
||
{ "name": "currentSlide", "type": "number" },
|
||
{
|
||
"name": "navigation",
|
||
"description": "When set, show the carousel's navigation.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "pagination",
|
||
"description": "When set, show the carousel's pagination indicators.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "autoplay",
|
||
"description": "When set, the slides will scroll automatically when the user is not interacting with them.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "autoplayInterval",
|
||
"description": "Specifies the amount of time, in milliseconds, between each automatic scroll.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "slidesPerPage",
|
||
"description": "Specifies how many slides should be shown at a given time.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "slidesPerMove",
|
||
"description": "Specifies the number of slides the carousel will advance when scrolling, useful when specifying a `slides-per-page`\ngreater than one. It can't be higher than `slides-per-page`.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "Specifies the orientation in which the carousel will lay out.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
},
|
||
{
|
||
"name": "mouseDragging",
|
||
"description": "When set, it is possible to scroll through the slides by dragging them with the mouse.",
|
||
"type": "boolean"
|
||
},
|
||
{ "name": "scrollContainer", "type": "HTMLElement" },
|
||
{ "name": "paginationContainer", "type": "HTMLElement" },
|
||
{ "name": "activeSlide", "type": "number" },
|
||
{ "name": "scrolling", "type": "boolean" },
|
||
{ "name": "dragging", "type": "boolean" }
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-slide-change",
|
||
"type": "{ index: number, slide: WaCarouselItem }",
|
||
"description": "Emitted when the active slide changes."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-carousel-item",
|
||
"description": "A carousel item represent a slide within a carousel.\n---\n\n\n### **Slots:**\n - _default_ - The carousel item's content..\n\n### **CSS Properties:**\n - **--aspect-ratio** - The slide's aspect ratio. Inherited from the carousel by default. _(default: undefined)_",
|
||
"doc-url": "",
|
||
"attributes": [],
|
||
"slots": [
|
||
{ "name": "", "description": "The carousel item's content.." }
|
||
],
|
||
"events": [],
|
||
"js": { "properties": [], "events": [] }
|
||
},
|
||
{
|
||
"name": "wa-checkbox",
|
||
"description": "Checkboxes allow the user to toggle an option on or off.\n---\n\n\n### **Events:**\n - **change** - Emitted when the checked state changes.\n- **blur** - Emitted when the checkbox loses focus.\n- **focus** - Emitted when the checkbox gains focus.\n- **input** - Emitted when the checkbox receives input.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the checkbox.\n- **focus(options: _FocusOptions_)** - Sets focus on the checkbox.\n- **blur()** - Removes focus from the checkbox.\n\n### **Slots:**\n - _default_ - The checkbox's label.\n- **hint** - Text that describes how to use the checkbox. Alternatively, you can use the `hint` attribute.\n\n### **CSS Properties:**\n - **--checked-icon-color** - The color of the checked and indeterminate icons. _(default: undefined)_\n- **--checked-icon-scale** - The size of the checked and indeterminate icons relative to the checkbox. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's label .\n- **control** - The square container that wraps the checkbox's checked state.\n- **checked-icon** - The checked icon, a `<wa-icon>` element.\n- **indeterminate-icon** - The indeterminate icon, a `<wa-icon>` element.\n- **label** - The container that wraps the checkbox's label.\n- **hint** - The hint's wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the checkbox, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The value of the checkbox, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string | null" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The checkbox's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the checkbox.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "indeterminate",
|
||
"description": "Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a \"select\nall/none\" behavior when associated checkboxes have a mix of checked and unchecked states.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "checked",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "boolean" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the checkbox a required field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The checkbox's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The checkbox's label." },
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the checkbox. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the checked state changes."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the checkbox loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the checkbox gains focus."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"description": "Emitted when the checkbox receives input."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "input", "type": "HTMLInputElement" },
|
||
{ "name": "title", "type": "string" },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the checkbox, submitted as a name/value pair with form data.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The value of the checkbox, submitted as a name/value pair with form data.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The checkbox's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the checkbox.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "indeterminate",
|
||
"description": "Draws the checkbox in an indeterminate state. This is usually applied to checkboxes that represents a \"select\nall/none\" behavior when associated checkboxes have a mix of checked and unchecked states.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "checked",
|
||
"description": "Draws the checkbox in a checked state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "defaultChecked",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the checkbox a required field.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The checkbox's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the checked state changes."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the checkbox loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the checkbox gains focus."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"description": "Emitted when the checkbox receives input."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-color-picker",
|
||
"description": "Color pickers allow the user to select a color.\n---\n\n\n### **Events:**\n - **change** - Emitted when the color picker's value changes.\n- **input** - Emitted when the color picker receives input.\n- **wa-show**\n- **wa-after-show**\n- **wa-hide**\n- **wa-after-hide**\n- **blur** - Emitted when the color picker loses focus.\n- **focus** - Emitted when the color picker receives focus.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **getHexString(hue: _number_, saturation: _number_, brightness: _number_, alpha)** - Generates a hex string from HSV values. Hue must be 0-360. All other arguments must be 0-100.\n- **focus(options: _FocusOptions_)** - Sets focus on the color picker.\n- **blur()** - Removes focus from the color picker.\n- **getFormattedValue(format: _'hex' | 'hexa' | 'rgb' | 'rgba' | 'hsl' | 'hsla' | 'hsv' | 'hsva'_)** - Returns the current value as a string in the specified format.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **show()** - Shows the color picker panel.\n- **hide()** - Hides the color picker panel\n\n### **Slots:**\n - **label** - The color picker's form label. Alternatively, you can use the `label` attribute.\n- **hint** - The color picker's form hint. Alternatively, you can use the `hint` attribute.\n\n### **CSS Properties:**\n - **--grid-width** - The width of the color grid. _(default: undefined)_\n- **--grid-height** - The height of the color grid. _(default: undefined)_\n- **--grid-handle-size** - The size of the color grid's handle. _(default: undefined)_\n- **--slider-height** - The height of the hue and alpha sliders. _(default: undefined)_\n- **--slider-handle-size** - The diameter of the slider's handle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **trigger** - The color picker's dropdown trigger.\n- **swatches** - The container that holds the swatches.\n- **swatch** - Each individual swatch.\n- **grid** - The color grid.\n- **grid-handle** - The color grid's handle.\n- **slider** - Hue and opacity sliders.\n- **slider-handle** - Hue and opacity slider handles.\n- **hue-slider** - The hue slider.\n- **hue-slider-handle** - The hue slider's handle.\n- **opacity-slider** - The opacity slider.\n- **opacity-slider-handle** - The opacity slider's handle.\n- **preview** - The preview color.\n- **input** - The text input.\n- **eyedropper-button** - The eye dropper button.\n- **eyedropper-button__base** - The eye dropper button's exported `button` part.\n- **eyedropper-button__start** - The eye dropper button's exported `start` part.\n- **eyedropper-button__label** - The eye dropper button's exported `label` part.\n- **eyedropper-button__end** - The eye dropper button's exported `end` part.\n- **eyedropper-button__caret** - The eye dropper button's exported `caret` part.\n- **format-button** - The format button.\n- **format-button__base** - The format button's exported `button` part.\n- **format-button__start** - The format button's exported `start` part.\n- **format-button__label** - The format button's exported `label` part.\n- **format-button__end** - The format button's exported `end` part.\n- **format-button__caret** - The format button's exported `caret` part.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "string | null" }
|
||
},
|
||
{
|
||
"name": "with-label",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The color picker's label. This will not be displayed, but it will be announced by assistive devices. If you need to\ndisplay HTML, you can use the `label` slot` instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The color picker's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "format",
|
||
"description": "The format to use. If opacity is enabled, these will translate to HEXA, RGBA, HSLA, and HSVA respectively. The color\npicker will accept user input in any format (including CSS color names) and convert it to the desired format.",
|
||
"value": {
|
||
"type": "'hex' | 'rgb' | 'hsl' | 'hsv'",
|
||
"default": "'hex'"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "Determines the size of the color picker's trigger",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "without-format-toggle",
|
||
"description": "Removes the button that lets users toggle between format.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the form control, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the color picker.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the popup is open. You can toggle this attribute to show and hide the popup, or you\ncan use the `show()` and `hide()` methods and this attribute will reflect the popup's open state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "opacity",
|
||
"description": "Shows the opacity slider. Enabling this will cause the formatted value to be HEXA, RGBA, or HSLA.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "uppercase",
|
||
"description": "By default, values are lowercase. With this attribute, values will be uppercase instead.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "swatches",
|
||
"description": "One or more predefined color swatches to display as presets in the color picker. Can include any format the color\npicker can parse, including HEX(A), RGB(A), HSL(A), HSV(A), and CSS color names. Each color must be separated by a\nsemicolon (`;`). Alternatively, you can pass an array of color values to this property using JavaScript.",
|
||
"value": { "type": "string | string[]", "default": "''" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the color picker a required field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "label",
|
||
"description": "The color picker's form label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The color picker's form hint. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the color picker's value changes."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the color picker receives input."
|
||
},
|
||
{ "name": "wa-show", "type": "CustomEvent" },
|
||
{ "name": "wa-after-show", "type": "CustomEvent" },
|
||
{ "name": "wa-hide", "type": "CustomEvent" },
|
||
{ "name": "wa-after-hide", "type": "CustomEvent" },
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the color picker loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the color picker receives focus."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "base", "type": "HTMLElement" },
|
||
{ "name": "input", "type": "WaInput" },
|
||
{ "name": "triggerLabel", "type": "HTMLElement" },
|
||
{ "name": "triggerButton", "type": "HTMLButtonElement" },
|
||
{ "name": "validationTarget" },
|
||
{ "name": "popup", "type": "WaPopup" },
|
||
{ "name": "previewButton", "type": "HTMLButtonElement" },
|
||
{ "name": "trigger", "type": "HTMLButtonElement" },
|
||
{
|
||
"name": "value",
|
||
"description": "The current value of the color picker. The value's format will vary based the `format` attribute. To get the value\nin a specific format, use the `getFormattedValue()` method. The value is submitted as a name/value pair with form\ndata."
|
||
},
|
||
{
|
||
"name": "defaultValue",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "string | null"
|
||
},
|
||
{ "name": "withLabel", "type": "boolean" },
|
||
{ "name": "withHint", "type": "boolean" },
|
||
{
|
||
"name": "label",
|
||
"description": "The color picker's label. This will not be displayed, but it will be announced by assistive devices. If you need to\ndisplay HTML, you can use the `label` slot` instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The color picker's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "format",
|
||
"description": "The format to use. If opacity is enabled, these will translate to HEXA, RGBA, HSLA, and HSVA respectively. The color\npicker will accept user input in any format (including CSS color names) and convert it to the desired format.",
|
||
"type": "'hex' | 'rgb' | 'hsl' | 'hsv'"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "Determines the size of the color picker's trigger",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "withoutFormatToggle",
|
||
"description": "Removes the button that lets users toggle between format.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the form control, submitted as a name/value pair with form data.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the color picker.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the popup is open. You can toggle this attribute to show and hide the popup, or you\ncan use the `show()` and `hide()` methods and this attribute will reflect the popup's open state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "opacity",
|
||
"description": "Shows the opacity slider. Enabling this will cause the formatted value to be HEXA, RGBA, or HSLA.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "uppercase",
|
||
"description": "By default, values are lowercase. With this attribute, values will be uppercase instead.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "swatches",
|
||
"description": "One or more predefined color swatches to display as presets in the color picker. Can include any format the color\npicker can parse, including HEX(A), RGB(A), HSL(A), HSV(A), and CSS color names. Each color must be separated by a\nsemicolon (`;`). Alternatively, you can pass an array of color values to this property using JavaScript.",
|
||
"type": "string | string[]"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the color picker a required field.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the color picker's value changes."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the color picker receives input."
|
||
},
|
||
{ "name": "wa-show", "type": "CustomEvent" },
|
||
{ "name": "wa-after-show", "type": "CustomEvent" },
|
||
{ "name": "wa-hide", "type": "CustomEvent" },
|
||
{ "name": "wa-after-hide", "type": "CustomEvent" },
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the color picker loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the color picker receives focus."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-combobox",
|
||
"description": "Comboboxes combine a text input with a listbox, allowing users to filter and select from predefined options or enter custom values.\n---\n\n\n### **Events:**\n - **input** - Emitted when the control receives input.\n- **change** - Emitted when the control's value changes.\n- **focus** - Emitted when the control gains focus.\n- **blur** - Emitted when the control loses focus.\n- **wa-clear** - Emitted when the control's value is cleared.\n- **wa-show** - Emitted when the combobox's menu opens.\n- **wa-after-show** - Emitted after the combobox's menu opens and all animations are complete.\n- **wa-hide** - Emitted when the combobox's menu closes.\n- **wa-after-hide** - Emitted after the combobox's menu closes and all animations are complete.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the listbox.\n- **hide()** - Hides the listbox.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The listbox options. Must be `<wa-option>` elements. You can use `<wa-divider>` to group items visually.\n- **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **start** - An element, such as `<wa-icon>`, placed at the start of the combobox.\n- **end** - An element, such as `<wa-icon>`, placed at the end of the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n- **hint** - Text that describes how to use the input. Alternatively, you can use the `hint` attribute.\n\n### **CSS Properties:**\n - **--show-duration** - The duration of the show animation. _(default: 100ms)_\n- **--hide-duration** - The duration of the hide animation. _(default: 100ms)_\n- **--tag-max-size** - When using `multiple`, the max size of tags before their content is truncated. _(default: 10ch)_\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and hint.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The combobox's wrapper.\n- **hint** - The hint's wrapper.\n- **combobox** - The container the wraps the start, end, value, clear icon, and expand button.\n- **start** - The container that wraps the `start` slot.\n- **end** - The container that wraps the `end` slot.\n- **combobox-input** - The text input element.\n- **listbox** - The listbox container where options are slotted.\n- **tags** - The container that houses option tags when `multiselect` is used.\n- **tag** - The individual tags that represent each multiselect option.\n- **tag__content** - The tag's content part.\n- **tag__remove-button** - The tag's remove button.\n- **tag__remove-button__base** - The tag's remove button base part.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the combobox, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The combobox's value. This will be a string for single select or an array for multi-select.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The combobox's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the combobox is empty.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "multiple",
|
||
"description": "Allows more than one option to be selected.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "max-options-visible",
|
||
"description": "The maximum number of selected options to show when `multiple` is true. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
||
"value": { "type": "number", "default": "3" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the combobox control.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-clear",
|
||
"description": "Adds a clear button when the combobox is not empty.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the combobox is open. You can toggle this attribute to show and hide the menu, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the combobox's open state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The combobox's visual appearance.",
|
||
"value": {
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'",
|
||
"default": "'outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style combobox with rounded edges.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The combobox's label. If you need to display HTML, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the combobox's menu. Note that the actual placement may vary as needed to keep the\nlistbox inside of the viewport.",
|
||
"value": { "type": "'top' | 'bottom'", "default": "'bottom'" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The combobox's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "with-label",
|
||
"description": "Used for SSR purposes when a label is slotted in. Will show the label on first render.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"description": "Used for SSR purposes when hint is slotted in. Will show the hint on first render.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "The combobox's required attribute.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "autocomplete",
|
||
"description": "The autocomplete behavior of the combobox.\n- `list`: When the popup is triggered, it presents suggested values that complete or logically correspond to the\n characters typed in the combobox. The character string the user has typed will become the value of the combobox\n unless the user selects a value in the popup.\n- `none`: The combobox is editable, and when the popup is triggered, the suggested values it contains are the same\n regardless of the characters typed in the combobox.",
|
||
"value": { "type": "'list' | 'none'", "default": "'list'" }
|
||
},
|
||
{
|
||
"name": "allow-custom-value",
|
||
"description": "When true, allows the user to enter a value that doesn't match any of the options. Only applies to single-select\ncomboboxes. When false, the combobox will only accept values that match an option.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The listbox options. Must be `<wa-option>` elements. You can use `<wa-divider>` to group items visually."
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The input's label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "start",
|
||
"description": "An element, such as `<wa-icon>`, placed at the start of the combobox."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "An element, such as `<wa-icon>`, placed at the end of the combobox."
|
||
},
|
||
{
|
||
"name": "clear-icon",
|
||
"description": "An icon to use in lieu of the default clear icon."
|
||
},
|
||
{
|
||
"name": "expand-icon",
|
||
"description": "The icon to show when the control is expanded and collapsed. Rotates on open and close."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the input. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the control's value changes."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "wa-clear",
|
||
"description": "Emitted when the control's value is cleared."
|
||
},
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the combobox's menu opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the combobox's menu opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the combobox's menu closes."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the combobox's menu closes and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "assumeInteractionOn", "type": "array" },
|
||
{ "name": "popup", "type": "WaPopup" },
|
||
{ "name": "combobox", "type": "HTMLSlotElement" },
|
||
{ "name": "comboboxInput", "type": "HTMLInputElement" },
|
||
{ "name": "valueInput", "type": "HTMLInputElement" },
|
||
{ "name": "listbox", "type": "HTMLSlotElement" },
|
||
{ "name": "liveRegion", "type": "HTMLElement" },
|
||
{
|
||
"name": "validationTarget",
|
||
"description": "Where to anchor native constraint validation"
|
||
},
|
||
{ "name": "currentOption", "type": "WaOption" },
|
||
{ "name": "selectedOptions", "type": "WaOption[]" },
|
||
{
|
||
"name": "optionValues",
|
||
"type": "Set<string | null> | undefined"
|
||
},
|
||
{ "name": "filteredOptions", "type": "WaOption[]" },
|
||
{
|
||
"name": "inputValue",
|
||
"description": "The current text value in the input field.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the combobox, submitted as a name/value pair with form data.",
|
||
"type": "string"
|
||
},
|
||
{ "name": "defaultValue" },
|
||
{
|
||
"name": "value",
|
||
"description": "The combobox's value. This will be a string for single select or an array for multi-select."
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The combobox's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the combobox is empty.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "multiple",
|
||
"description": "Allows more than one option to be selected.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "maxOptionsVisible",
|
||
"description": "The maximum number of selected options to show when `multiple` is true. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the combobox control.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withClear",
|
||
"description": "Adds a clear button when the combobox is not empty.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the combobox is open. You can toggle this attribute to show and hide the menu, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the combobox's open state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The combobox's visual appearance.",
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style combobox with rounded edges.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The combobox's label. If you need to display HTML, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the combobox's menu. Note that the actual placement may vary as needed to keep the\nlistbox inside of the viewport.",
|
||
"type": "'top' | 'bottom'"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The combobox's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withLabel",
|
||
"description": "Used for SSR purposes when a label is slotted in. Will show the label on first render.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withHint",
|
||
"description": "Used for SSR purposes when hint is slotted in. Will show the hint on first render.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "The combobox's required attribute.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "autocomplete",
|
||
"description": "The autocomplete behavior of the combobox.\n- `list`: When the popup is triggered, it presents suggested values that complete or logically correspond to the\n characters typed in the combobox. The character string the user has typed will become the value of the combobox\n unless the user selects a value in the popup.\n- `none`: The combobox is editable, and when the popup is triggered, the suggested values it contains are the same\n regardless of the characters typed in the combobox.",
|
||
"type": "'list' | 'none'"
|
||
},
|
||
{
|
||
"name": "allowCustomValue",
|
||
"description": "When true, allows the user to enter a value that doesn't match any of the options. Only applies to single-select\ncomboboxes. When false, the combobox will only accept values that match an option.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "filter",
|
||
"description": "A function that customizes how options are filtered based on the input value. The function receives the option\nand the current input query string. Return `true` to include the option in the filtered list, `false` to exclude.\nBy default, options are filtered by checking if the option's label contains the query (case-insensitive).",
|
||
"type": "((option: WaOption, query: string) => boolean) | null"
|
||
},
|
||
{
|
||
"name": "getTag",
|
||
"description": "A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second\nis the current tag's index. The function should return either a Lit TemplateResult or a string containing trusted\nHTML of the symbol to render at the specified value.",
|
||
"type": "(option: WaOption, index: number) => TemplateResult | string | HTMLElement"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the control's value changes."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "wa-clear",
|
||
"description": "Emitted when the control's value is cleared."
|
||
},
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the combobox's menu opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the combobox's menu opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the combobox's menu closes."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the combobox's menu closes and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-comparison",
|
||
"description": "Compare visual differences between similar content with a sliding panel.\n---\n\n\n### **Events:**\n - **change** - Emitted when the position changes.\n\n### **Slots:**\n - **before** - The before content, often an `<img>` or `<svg>` element.\n- **after** - The after content, often an `<img>` or `<svg>` element.\n- **handle** - The icon used inside the handle.\n\n### **CSS Properties:**\n - **--divider-width** - The width of the dividing line. _(default: undefined)_\n- **--handle-size** - The size of the compare handle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The container that wraps the before and after content.\n- **before** - The container that wraps the before content.\n- **after** - The container that wraps the after content.\n- **divider** - The divider that separates the before and after content.\n- **handle** - The handle that the user drags to expose the after content.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "position",
|
||
"description": "The position of the divider as a percentage.",
|
||
"value": { "type": "number", "default": "50" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "before",
|
||
"description": "The before content, often an `<img>` or `<svg>` element."
|
||
},
|
||
{
|
||
"name": "after",
|
||
"description": "The after content, often an `<img>` or `<svg>` element."
|
||
},
|
||
{
|
||
"name": "handle",
|
||
"description": "The icon used inside the handle."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the position changes."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "handle", "type": "HTMLElement" },
|
||
{
|
||
"name": "position",
|
||
"description": "The position of the divider as a percentage.",
|
||
"type": "number"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the position changes."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-copy-button",
|
||
"description": "Copies text data to the clipboard when the user clicks the trigger.\n---\n\n\n### **Events:**\n - **wa-copy** - Emitted when the data has been copied.\n- **wa-error** - Emitted when the data could not be copied.\n\n### **Slots:**\n - **copy-icon** - The icon to show in the default copy state. Works best with `<wa-icon>`.\n- **success-icon** - The icon to show when the content is copied. Works best with `<wa-icon>`.\n- **error-icon** - The icon to show when a copy error occurs. Works best with `<wa-icon>`.\n\n### **CSS Parts:**\n - **button** - The internal `<button>` element.\n- **copy-icon** - The container that holds the copy icon.\n- **success-icon** - The container that holds the success icon.\n- **error-icon** - The container that holds the error icon.\n- **tooltip__base** - The tooltip's exported `base` part.\n- **tooltip__base__popup** - The tooltip's exported `popup` part.\n- **tooltip__base__arrow** - The tooltip's exported `arrow` part.\n- **tooltip__body** - The tooltip's exported `body` part.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The text value to copy.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "from",
|
||
"description": "An id that references an element in the same document from which data will be copied. If both this and `value` are\npresent, this value will take precedence. By default, the target element's `textContent` will be copied. To copy an\nattribute, append the attribute name wrapped in square brackets, e.g. `from=\"el[value]\"`. To copy a property,\nappend a dot and the property name, e.g. `from=\"el.value\"`.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the copy button.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "copy-label",
|
||
"description": "A custom label to show in the tooltip.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "success-label",
|
||
"description": "A custom label to show in the tooltip after copying.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "error-label",
|
||
"description": "A custom label to show in the tooltip when a copy error occurs.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "feedback-duration",
|
||
"description": "The length of time to show feedback before restoring the default trigger.",
|
||
"value": { "type": "number", "default": "1000" }
|
||
},
|
||
{
|
||
"name": "tooltip-placement",
|
||
"description": "The preferred placement of the tooltip.",
|
||
"value": {
|
||
"type": "'top' | 'right' | 'bottom' | 'left'",
|
||
"default": "'top'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "copy-icon",
|
||
"description": "The icon to show in the default copy state. Works best with `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "success-icon",
|
||
"description": "The icon to show when the content is copied. Works best with `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "error-icon",
|
||
"description": "The icon to show when a copy error occurs. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-copy",
|
||
"description": "Emitted when the data has been copied."
|
||
},
|
||
{
|
||
"name": "wa-error",
|
||
"description": "Emitted when the data could not be copied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "copyIcon", "type": "HTMLSlotElement" },
|
||
{ "name": "successIcon", "type": "HTMLSlotElement" },
|
||
{ "name": "errorIcon", "type": "HTMLSlotElement" },
|
||
{ "name": "tooltip", "type": "WaTooltip" },
|
||
{ "name": "isCopying", "type": "boolean" },
|
||
{ "name": "status", "type": "'rest' | 'success' | 'error'" },
|
||
{
|
||
"name": "value",
|
||
"description": "The text value to copy.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "from",
|
||
"description": "An id that references an element in the same document from which data will be copied. If both this and `value` are\npresent, this value will take precedence. By default, the target element's `textContent` will be copied. To copy an\nattribute, append the attribute name wrapped in square brackets, e.g. `from=\"el[value]\"`. To copy a property,\nappend a dot and the property name, e.g. `from=\"el.value\"`.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the copy button.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "copyLabel",
|
||
"description": "A custom label to show in the tooltip.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "successLabel",
|
||
"description": "A custom label to show in the tooltip after copying.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "errorLabel",
|
||
"description": "A custom label to show in the tooltip when a copy error occurs.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "feedbackDuration",
|
||
"description": "The length of time to show feedback before restoring the default trigger.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "tooltipPlacement",
|
||
"description": "The preferred placement of the tooltip.",
|
||
"type": "'top' | 'right' | 'bottom' | 'left'"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-copy",
|
||
"description": "Emitted when the data has been copied."
|
||
},
|
||
{
|
||
"name": "wa-error",
|
||
"description": "Emitted when the data could not be copied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-details",
|
||
"description": "Details show a brief summary and expand to show additional content.\n---\n\n\n### **Events:**\n - **wa-show** - Emitted when the details opens.\n- **wa-after-show** - Emitted after the details opens and all animations are complete.\n- **wa-hide** - Emitted when the details closes.\n- **wa-after-hide** - Emitted after the details closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the details.\n- **hide()** - Hides the details\n\n### **Slots:**\n - _default_ - The details' main content.\n- **summary** - The details' summary. Alternatively, you can use the `summary` attribute.\n- **expand-icon** - Optional expand icon to use instead of the default. Works best with `<wa-icon>`.\n- **collapse-icon** - Optional collapse icon to use instead of the default. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--spacing** - The amount of space around and between the details' content. Expects a single value. _(default: undefined)_\n- **--show-duration** - The show duration to use when applying built-in animation classes. _(default: 200ms)_\n- **--hide-duration** - The hide duration to use when applying built-in animation classes. _(default: 200ms)_\n\n### **CSS Parts:**\n - **base** - The inner `<details>` element used to render the component. Styles you apply to the component are automatically applied to this part, so you usually don't need to deal with it unless you need to set the `display` property.\n- **header** - The header that wraps both the summary and the expand/collapse icon.\n- **summary** - The container that wraps the summary.\n- **icon** - The container that wraps the expand/collapse icons.\n- **content** - The details content.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you\ncan use the `show()` and `hide()` methods and this attribute will reflect the details' open state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "summary",
|
||
"description": "The summary to show in the header. If you need to display HTML, use the `summary` slot instead.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "Groups related details elements. When one opens, others with the same name will close.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the details so it can't be toggled.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The element's visual appearance.",
|
||
"value": {
|
||
"type": "'filled' | 'outlined' | 'filled-outlined' | 'plain'",
|
||
"default": "'outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "icon-placement",
|
||
"description": "The location of the expand/collapse icon.",
|
||
"value": { "type": "'start' | 'end'", "default": "'end'" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The details' main content." },
|
||
{
|
||
"name": "summary",
|
||
"description": "The details' summary. Alternatively, you can use the `summary` attribute."
|
||
},
|
||
{
|
||
"name": "expand-icon",
|
||
"description": "Optional expand icon to use instead of the default. Works best with `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "collapse-icon",
|
||
"description": "Optional collapse icon to use instead of the default. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the details opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the details opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the details closes."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the details closes and all animations are complete."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "details", "type": "HTMLDetailsElement" },
|
||
{ "name": "header", "type": "HTMLElement" },
|
||
{ "name": "body", "type": "HTMLElement" },
|
||
{ "name": "expandIconSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "isAnimating", "type": "boolean" },
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the details is open. You can toggle this attribute to show and hide the details, or you\ncan use the `show()` and `hide()` methods and this attribute will reflect the details' open state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "summary",
|
||
"description": "The summary to show in the header. If you need to display HTML, use the `summary` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "Groups related details elements. When one opens, others with the same name will close.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the details so it can't be toggled.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The element's visual appearance.",
|
||
"type": "'filled' | 'outlined' | 'filled-outlined' | 'plain'"
|
||
},
|
||
{
|
||
"name": "iconPlacement",
|
||
"description": "The location of the expand/collapse icon.",
|
||
"type": "'start' | 'end'"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the details opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the details opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the details closes."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the details closes and all animations are complete."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-dialog",
|
||
"description": "Dialogs, sometimes called \"modals\", appear above the page and require the user's immediate attention.\n---\n\n\n### **Events:**\n - **wa-show** - Emitted when the dialog opens.\n- **wa-after-show** - Emitted after the dialog opens and all animations are complete.\n- **wa-hide** - Emitted when the dialog is requested to close. Calling `event.preventDefault()` will prevent the dialog from closing. You can inspect `event.detail.source` to see which element caused the dialog to close. If the source is the dialog element itself, the user has pressed [[Escape]] or the dialog has been closed programmatically. Avoid using this unless closing the dialog will result in destructive behavior such as data loss.\n- **wa-after-hide** - Emitted after the dialog closes and all animations are complete.\n\n### **Slots:**\n - _default_ - The dialog's main content.\n- **label** - The dialog's label. Alternatively, you can use the `label` attribute.\n- **header-actions** - Optional actions to add to the header. Works best with `<wa-button>`.\n- **footer** - The dialog's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--spacing** - The amount of space around and between the dialog's content. _(default: undefined)_\n- **--width** - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens. _(default: undefined)_\n- **--show-duration** - The animation duration when showing the dialog. _(default: 200ms)_\n- **--hide-duration** - The animation duration when hiding the dialog. _(default: 200ms)_\n\n### **CSS Parts:**\n - **dialog** - The dialog's internal `<dialog>` element.\n- **header** - The dialog's header. This element wraps the title and header actions.\n- **header-actions** - Optional actions to add to the header. Works best with `<wa-button>`.\n- **title** - The dialog's title.\n- **close-button** - The close button, a `<wa-button>`.\n- **close-button__base** - The close button's exported `base` part.\n- **body** - The dialog's body.\n- **footer** - The dialog's footer.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the dialog is open. Toggle this attribute to show and hide the dialog.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The dialog's label as displayed in the header. You should always include a relevant label, as it is required for\nproper accessibility. If you need to display HTML, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "without-header",
|
||
"description": "Disables the header. This will also remove the default close button.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "light-dismiss",
|
||
"description": "When enabled, the dialog will be closed when the user clicks outside of it.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The dialog's main content." },
|
||
{
|
||
"name": "label",
|
||
"description": "The dialog's label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "header-actions",
|
||
"description": "Optional actions to add to the header. Works best with `<wa-button>`."
|
||
},
|
||
{
|
||
"name": "footer",
|
||
"description": "The dialog's footer, usually one or more buttons representing various options."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the dialog opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the dialog opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"type": "{ source: Element }",
|
||
"description": "Emitted when the dialog is requested to close. Calling `event.preventDefault()` will prevent the dialog from closing. You can inspect `event.detail.source` to see which element caused the dialog to close. If the source is the dialog element itself, the user has pressed [[Escape]] or the dialog has been closed programmatically. Avoid using this unless closing the dialog will result in destructive behavior such as data loss."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the dialog closes and all animations are complete."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "dialog", "type": "HTMLDialogElement" },
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the dialog is open. Toggle this attribute to show and hide the dialog.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The dialog's label as displayed in the header. You should always include a relevant label, as it is required for\nproper accessibility. If you need to display HTML, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withoutHeader",
|
||
"description": "Disables the header. This will also remove the default close button.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "lightDismiss",
|
||
"description": "When enabled, the dialog will be closed when the user clicks outside of it.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the dialog opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the dialog opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"type": "{ source: Element }",
|
||
"description": "Emitted when the dialog is requested to close. Calling `event.preventDefault()` will prevent the dialog from closing. You can inspect `event.detail.source` to see which element caused the dialog to close. If the source is the dialog element itself, the user has pressed [[Escape]] or the dialog has been closed programmatically. Avoid using this unless closing the dialog will result in destructive behavior such as data loss."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the dialog closes and all animations are complete."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-divider",
|
||
"description": "Dividers are used to visually separate or group elements.\n---\n\n\n### **CSS Properties:**\n - **--color** - The color of the divider. _(default: undefined)_\n- **--width** - The width of the divider. _(default: undefined)_\n- **--spacing** - The spacing of the divider. _(default: undefined)_",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "orientation",
|
||
"description": "Sets the divider's orientation.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'horizontal'"
|
||
}
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "orientation",
|
||
"description": "Sets the divider's orientation.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-drawer",
|
||
"description": "Drawers slide in from a container to expose additional options and information.\n---\n\n\n### **Events:**\n - **wa-show** - Emitted when the drawer opens.\n- **wa-after-show** - Emitted after the drawer opens and all animations are complete.\n- **wa-hide** - Emitted when the drawer is requesting to close. Calling `event.preventDefault()` will prevent the drawer from closing. You can inspect `event.detail.source` to see which element caused the drawer to close. If the source is the drawer element itself, the user has pressed [[Escape]] or the drawer has been closed programmatically. Avoid using this unless closing the drawer will result in destructive behavior such as data loss.\n- **wa-after-hide** - Emitted after the drawer closes and all animations are complete.\n\n### **Slots:**\n - _default_ - The drawer's main content.\n- **label** - The drawer's label. Alternatively, you can use the `label` attribute.\n- **header-actions** - Optional actions to add to the header. Works best with `<wa-button>`.\n- **footer** - The drawer's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--spacing** - The amount of space around and between the drawer's content. _(default: undefined)_\n- **--size** - The preferred size of the drawer. This will be applied to the drawer's width or height depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens. _(default: undefined)_\n- **--show-duration** - The animation duration when showing the drawer. _(default: 200ms)_\n- **--hide-duration** - The animation duration when hiding the drawer. _(default: 200ms)_\n\n### **CSS Parts:**\n - **dialog** - The drawer's internal `<dialog>` element.\n- **header** - The drawer's header. This element wraps the title and header actions.\n- **header-actions** - Optional actions to add to the header. Works best with `<wa-button>`.\n- **title** - The drawer's title.\n- **close-button** - The close button, a `<wa-button>`.\n- **close-button__base** - The close button's exported `base` part.\n- **body** - The drawer's body.\n- **footer** - The drawer's footer.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the drawer is open. Toggle this attribute to show and hide the drawer.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The drawer's label as displayed in the header. You should always include a relevant label, as it is required for\nproper accessibility. If you need to display HTML, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The direction from which the drawer will open.",
|
||
"value": {
|
||
"type": "'top' | 'end' | 'bottom' | 'start'",
|
||
"default": "'end'"
|
||
}
|
||
},
|
||
{
|
||
"name": "without-header",
|
||
"description": "Disables the header. This will also remove the default close button.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "light-dismiss",
|
||
"description": "When enabled, the drawer will be closed when the user clicks outside of it.",
|
||
"value": { "type": "boolean", "default": "true" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The drawer's main content." },
|
||
{
|
||
"name": "label",
|
||
"description": "The drawer's label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "header-actions",
|
||
"description": "Optional actions to add to the header. Works best with `<wa-button>`."
|
||
},
|
||
{
|
||
"name": "footer",
|
||
"description": "The drawer's footer, usually one or more buttons representing various options."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the drawer opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the drawer opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"type": "{ source: Element }",
|
||
"description": "Emitted when the drawer is requesting to close. Calling `event.preventDefault()` will prevent the drawer from closing. You can inspect `event.detail.source` to see which element caused the drawer to close. If the source is the drawer element itself, the user has pressed [[Escape]] or the drawer has been closed programmatically. Avoid using this unless closing the drawer will result in destructive behavior such as data loss."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the drawer closes and all animations are complete."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "drawer", "type": "HTMLDialogElement" },
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the drawer is open. Toggle this attribute to show and hide the drawer.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The drawer's label as displayed in the header. You should always include a relevant label, as it is required for\nproper accessibility. If you need to display HTML, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The direction from which the drawer will open.",
|
||
"type": "'top' | 'end' | 'bottom' | 'start'"
|
||
},
|
||
{
|
||
"name": "withoutHeader",
|
||
"description": "Disables the header. This will also remove the default close button.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "lightDismiss",
|
||
"description": "When enabled, the drawer will be closed when the user clicks outside of it.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "modal",
|
||
"description": "Exposes the internal modal utility that controls focus trapping. To temporarily disable focus trapping and allow third-party modals spawned from an active Shoelace modal, call `modal.activateExternal()` when the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Shoelace's focus trapping."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the drawer opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the drawer opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"type": "{ source: Element }",
|
||
"description": "Emitted when the drawer is requesting to close. Calling `event.preventDefault()` will prevent the drawer from closing. You can inspect `event.detail.source` to see which element caused the drawer to close. If the source is the drawer element itself, the user has pressed [[Escape]] or the drawer has been closed programmatically. Avoid using this unless closing the drawer will result in destructive behavior such as data loss."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the drawer closes and all animations are complete."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-dropdown",
|
||
"description": "Dropdowns display a list of options that can be triggered by a button or other element. They support\nkeyboard navigation, submenus, and various customization options.\n---\n\n\n### **Events:**\n - **wa-show** - Emitted when the dropdown is about to show.\n- **wa-after-show** - Emitted after the dropdown has been shown.\n- **wa-hide** - Emitted when the dropdown is about to hide.\n- **wa-after-hide** - Emitted after the dropdown has been hidden.\n- **wa-select** - Emitted when an item in the dropdown is selected.\n\n### **Slots:**\n - _default_ - The dropdown's items, typically `<wa-dropdown-item>` elements.\n- **trigger** - The element that triggers the dropdown, such as a `<wa-button>` or `<button>`.\n\n### **CSS Properties:**\n - **--show-duration** - The duration of the show animation. _(default: undefined)_\n- **--hide-duration** - The duration of the hide animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's host element.\n- **menu** - The dropdown menu container.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "open",
|
||
"description": "Opens or closes the dropdown.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The dropdown's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The placement of the dropdown menu in reference to the trigger. The menu will shift to a more optimal location if\nthe preferred placement doesn't have enough room.",
|
||
"value": {
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'",
|
||
"default": "'bottom-start'"
|
||
}
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance of the dropdown menu from its trigger.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The offset of the dropdown menu along its trigger.",
|
||
"value": { "type": "number", "default": "0" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The dropdown's items, typically `<wa-dropdown-item>` elements."
|
||
},
|
||
{
|
||
"name": "trigger",
|
||
"description": "The element that triggers the dropdown, such as a `<wa-button>` or `<button>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the dropdown is about to show."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the dropdown has been shown."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the dropdown is about to hide."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the dropdown has been hidden."
|
||
},
|
||
{
|
||
"name": "wa-select",
|
||
"description": "Emitted when an item in the dropdown is selected."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{
|
||
"name": "open",
|
||
"description": "Opens or closes the dropdown.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The dropdown's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The placement of the dropdown menu in reference to the trigger. The menu will shift to a more optimal location if\nthe preferred placement doesn't have enough room.",
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance of the dropdown menu from its trigger.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The offset of the dropdown menu along its trigger.",
|
||
"type": "number"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the dropdown is about to show."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the dropdown has been shown."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the dropdown is about to hide."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the dropdown has been hidden."
|
||
},
|
||
{
|
||
"name": "wa-select",
|
||
"description": "Emitted when an item in the dropdown is selected."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-dropdown-item",
|
||
"description": "Represents an individual item within a dropdown menu, supporting standard items, checkboxes, and submenus.\n---\n\n\n### **Events:**\n - **blur** - Emitted when the dropdown item loses focus.\n- **focus** - Emitted when the dropdown item gains focus.\n\n### **Methods:**\n - **openSubmenu()** - Opens the submenu.\n- **closeSubmenu()** - Closes the submenu.\n\n### **Slots:**\n - _default_ - The dropdown item's label.\n- **icon** - An optional icon to display before the label.\n- **details** - Additional content or details to display after the label.\n- **submenu** - Submenu items, typically `<wa-dropdown-item>` elements, to create a nested menu.\n\n### **CSS Parts:**\n - **checkmark** - The checkmark icon (a `<wa-icon>` element) when the item is a checkbox.\n- **icon** - The container for the icon slot.\n- **label** - The container for the label slot.\n- **details** - The container for the details slot.\n- **submenu-icon** - The submenu indicator icon (a `<wa-icon>` element).\n- **submenu** - The submenu container.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The type of menu item to render.",
|
||
"value": {
|
||
"type": "'danger' | 'default'",
|
||
"default": "'default'"
|
||
}
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "An optional value for the menu item. This is useful for determining which item was selected when listening to the\ndropdown's `wa-select` event.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "type",
|
||
"description": "Set to `checkbox` to make the item a checkbox.",
|
||
"value": {
|
||
"type": "'normal' | 'checkbox'",
|
||
"default": "'normal'"
|
||
}
|
||
},
|
||
{
|
||
"name": "checked",
|
||
"description": "Set to true to check the dropdown item. Only valid when `type` is `checkbox`.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the dropdown item.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "submenuOpen",
|
||
"description": "Whether the submenu is currently open.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The dropdown item's label." },
|
||
{
|
||
"name": "icon",
|
||
"description": "An optional icon to display before the label."
|
||
},
|
||
{
|
||
"name": "details",
|
||
"description": "Additional content or details to display after the label."
|
||
},
|
||
{
|
||
"name": "submenu",
|
||
"description": "Submenu items, typically `<wa-dropdown-item>` elements, to create a nested menu."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the dropdown item loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the dropdown item gains focus."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "submenuElement", "type": "HTMLDivElement" },
|
||
{
|
||
"name": "variant",
|
||
"description": "The type of menu item to render.",
|
||
"type": "'danger' | 'default'"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "An optional value for the menu item. This is useful for determining which item was selected when listening to the\ndropdown's `wa-select` event.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"description": "Set to `checkbox` to make the item a checkbox.",
|
||
"type": "'normal' | 'checkbox'"
|
||
},
|
||
{
|
||
"name": "checked",
|
||
"description": "Set to true to check the dropdown item. Only valid when `type` is `checkbox`.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the dropdown item.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "submenuOpen",
|
||
"description": "Whether the submenu is currently open.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the dropdown item loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the dropdown item gains focus."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-format-bytes",
|
||
"description": "Formats a number as a human readable bytes value.\n---\n",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The number to format in bytes.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "unit",
|
||
"description": "The type of unit to display.",
|
||
"value": { "type": "'byte' | 'bit'", "default": "'byte'" }
|
||
},
|
||
{
|
||
"name": "display",
|
||
"description": "Determines how to display the result, e.g. \"100 bytes\", \"100 b\", or \"100b\".",
|
||
"value": {
|
||
"type": "'long' | 'short' | 'narrow'",
|
||
"default": "'short'"
|
||
}
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "value",
|
||
"description": "The number to format in bytes.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "unit",
|
||
"description": "The type of unit to display.",
|
||
"type": "'byte' | 'bit'"
|
||
},
|
||
{
|
||
"name": "display",
|
||
"description": "Determines how to display the result, e.g. \"100 bytes\", \"100 b\", or \"100b\".",
|
||
"type": "'long' | 'short' | 'narrow'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-format-date",
|
||
"description": "Formats a date/time using the specified locale and options.\n---\n",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "date",
|
||
"description": "The date/time to format. If not set, the current date and time will be used. When passing a string, it's strongly\nrecommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format\nin JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).",
|
||
"value": { "type": "Date | string", "default": "new Date()" }
|
||
},
|
||
{
|
||
"name": "weekday",
|
||
"description": "The format for displaying the weekday.",
|
||
"value": { "type": "'narrow' | 'short' | 'long'" }
|
||
},
|
||
{
|
||
"name": "era",
|
||
"description": "The format for displaying the era.",
|
||
"value": { "type": "'narrow' | 'short' | 'long'" }
|
||
},
|
||
{
|
||
"name": "year",
|
||
"description": "The format for displaying the year.",
|
||
"value": { "type": "'numeric' | '2-digit'" }
|
||
},
|
||
{
|
||
"name": "month",
|
||
"description": "The format for displaying the month.",
|
||
"value": {
|
||
"type": "'numeric' | '2-digit' | 'narrow' | 'short' | 'long'"
|
||
}
|
||
},
|
||
{
|
||
"name": "day",
|
||
"description": "The format for displaying the day.",
|
||
"value": { "type": "'numeric' | '2-digit'" }
|
||
},
|
||
{
|
||
"name": "hour",
|
||
"description": "The format for displaying the hour.",
|
||
"value": { "type": "'numeric' | '2-digit'" }
|
||
},
|
||
{
|
||
"name": "minute",
|
||
"description": "The format for displaying the minute.",
|
||
"value": { "type": "'numeric' | '2-digit'" }
|
||
},
|
||
{
|
||
"name": "second",
|
||
"description": "The format for displaying the second.",
|
||
"value": { "type": "'numeric' | '2-digit'" }
|
||
},
|
||
{
|
||
"name": "time-zone-name",
|
||
"description": "The format for displaying the time.",
|
||
"value": { "type": "'short' | 'long'" }
|
||
},
|
||
{
|
||
"name": "time-zone",
|
||
"description": "The time zone to express the time in.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "hour-format",
|
||
"description": "The format for displaying the hour.",
|
||
"value": { "type": "'auto' | '12' | '24'", "default": "'auto'" }
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "date",
|
||
"description": "The date/time to format. If not set, the current date and time will be used. When passing a string, it's strongly\nrecommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert a date to this format\nin JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).",
|
||
"type": "Date | string"
|
||
},
|
||
{
|
||
"name": "weekday",
|
||
"description": "The format for displaying the weekday.",
|
||
"type": "'narrow' | 'short' | 'long'"
|
||
},
|
||
{
|
||
"name": "era",
|
||
"description": "The format for displaying the era.",
|
||
"type": "'narrow' | 'short' | 'long'"
|
||
},
|
||
{
|
||
"name": "year",
|
||
"description": "The format for displaying the year.",
|
||
"type": "'numeric' | '2-digit'"
|
||
},
|
||
{
|
||
"name": "month",
|
||
"description": "The format for displaying the month.",
|
||
"type": "'numeric' | '2-digit' | 'narrow' | 'short' | 'long'"
|
||
},
|
||
{
|
||
"name": "day",
|
||
"description": "The format for displaying the day.",
|
||
"type": "'numeric' | '2-digit'"
|
||
},
|
||
{
|
||
"name": "hour",
|
||
"description": "The format for displaying the hour.",
|
||
"type": "'numeric' | '2-digit'"
|
||
},
|
||
{
|
||
"name": "minute",
|
||
"description": "The format for displaying the minute.",
|
||
"type": "'numeric' | '2-digit'"
|
||
},
|
||
{
|
||
"name": "second",
|
||
"description": "The format for displaying the second.",
|
||
"type": "'numeric' | '2-digit'"
|
||
},
|
||
{
|
||
"name": "timeZoneName",
|
||
"description": "The format for displaying the time.",
|
||
"type": "'short' | 'long'"
|
||
},
|
||
{
|
||
"name": "timeZone",
|
||
"description": "The time zone to express the time in.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "hourFormat",
|
||
"description": "The format for displaying the hour.",
|
||
"type": "'auto' | '12' | '24'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-format-number",
|
||
"description": "Formats a number using the specified locale and options.\n---\n",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The number to format.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "type",
|
||
"description": "The formatting style to use.",
|
||
"value": {
|
||
"type": "'currency' | 'decimal' | 'percent'",
|
||
"default": "'decimal'"
|
||
}
|
||
},
|
||
{
|
||
"name": "without-grouping",
|
||
"description": "Turns off grouping separators.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "currency",
|
||
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use when formatting.",
|
||
"value": { "type": "string", "default": "'USD'" }
|
||
},
|
||
{
|
||
"name": "currency-display",
|
||
"description": "How to display the currency.",
|
||
"value": {
|
||
"type": "'symbol' | 'narrowSymbol' | 'code' | 'name'",
|
||
"default": "'symbol'"
|
||
}
|
||
},
|
||
{
|
||
"name": "minimum-integer-digits",
|
||
"description": "The minimum number of integer digits to use. Possible values are 1-21.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "minimum-fraction-digits",
|
||
"description": "The minimum number of fraction digits to use. Possible values are 0-100.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "maximum-fraction-digits",
|
||
"description": "The maximum number of fraction digits to use. Possible values are 0-100.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "minimum-significant-digits",
|
||
"description": "The minimum number of significant digits to use. Possible values are 1-21.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "maximum-significant-digits",
|
||
"description": "The maximum number of significant digits to use,. Possible values are 1-21.",
|
||
"value": { "type": "number" }
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "value",
|
||
"description": "The number to format.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "type",
|
||
"description": "The formatting style to use.",
|
||
"type": "'currency' | 'decimal' | 'percent'"
|
||
},
|
||
{
|
||
"name": "withoutGrouping",
|
||
"description": "Turns off grouping separators.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "currency",
|
||
"description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code to use when formatting.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "currencyDisplay",
|
||
"description": "How to display the currency.",
|
||
"type": "'symbol' | 'narrowSymbol' | 'code' | 'name'"
|
||
},
|
||
{
|
||
"name": "minimumIntegerDigits",
|
||
"description": "The minimum number of integer digits to use. Possible values are 1-21.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "minimumFractionDigits",
|
||
"description": "The minimum number of fraction digits to use. Possible values are 0-100.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "maximumFractionDigits",
|
||
"description": "The maximum number of fraction digits to use. Possible values are 0-100.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "minimumSignificantDigits",
|
||
"description": "The minimum number of significant digits to use. Possible values are 1-21.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "maximumSignificantDigits",
|
||
"description": "The maximum number of significant digits to use,. Possible values are 1-21.",
|
||
"type": "number"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-icon",
|
||
"description": "Icons are symbols that can be used to represent various options within an application.\n---\n\n\n### **Events:**\n - **wa-load** - Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit.\n- **wa-error** - Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit.\n\n### **CSS Properties:**\n - **--primary-color** - Sets a duotone icon's primary color. _(default: currentColor)_\n- **--primary-opacity** - Sets a duotone icon's primary opacity. _(default: 1)_\n- **--secondary-color** - Sets a duotone icon's secondary color. _(default: currentColor)_\n- **--secondary-opacity** - Sets a duotone icon's secondary opacity. _(default: 0.4)_\n\n### **CSS Parts:**\n - **svg** - The internal SVG element.\n- **use** - The `<use>` element generated when using `spriteSheet: true`",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
||
"value": { "type": "string | undefined" }
|
||
},
|
||
{
|
||
"name": "family",
|
||
"description": "The family of icons to choose from. For Font Awesome Free, valid options include `classic` and `brands`. For\nFont Awesome Pro subscribers, valid options include, `classic`, `sharp`, `duotone`, `sharp-duotone`, and `brands`.\nA valid kit code must be present to show pro icons via CDN. You can set `<html data-fa-kit-code=\"...\">` to provide\none.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "variant",
|
||
"description": "The name of the icon's variant. For Font Awesome, valid options include `thin`, `light`, `regular`, and `solid` for\nthe `classic` and `sharp` families. Some variants require a Font Awesome Pro subscription. Custom icon libraries\nmay or may not use this property.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "auto-width",
|
||
"description": "Sets the width of the icon to match the cropped SVG viewBox. This operates like the Font `fa-width-auto` class.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "swap-opacity",
|
||
"description": "Swaps the opacity of duotone icons.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "src",
|
||
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
||
"value": { "type": "string | undefined" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "library",
|
||
"description": "The name of a registered custom icon library.",
|
||
"value": { "type": "string", "default": "'default'" }
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-load",
|
||
"description": "Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit."
|
||
},
|
||
{
|
||
"name": "wa-error",
|
||
"description": "Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the icon to draw. Available names depend on the icon library being used.",
|
||
"type": "string | undefined"
|
||
},
|
||
{
|
||
"name": "family",
|
||
"description": "The family of icons to choose from. For Font Awesome Free, valid options include `classic` and `brands`. For\nFont Awesome Pro subscribers, valid options include, `classic`, `sharp`, `duotone`, `sharp-duotone`, and `brands`.\nA valid kit code must be present to show pro icons via CDN. You can set `<html data-fa-kit-code=\"...\">` to provide\none.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "variant",
|
||
"description": "The name of the icon's variant. For Font Awesome, valid options include `thin`, `light`, `regular`, and `solid` for\nthe `classic` and `sharp` families. Some variants require a Font Awesome Pro subscription. Custom icon libraries\nmay or may not use this property.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "autoWidth",
|
||
"description": "Sets the width of the icon to match the cropped SVG viewBox. This operates like the Font `fa-width-auto` class.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "swapOpacity",
|
||
"description": "Swaps the opacity of duotone icons.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "src",
|
||
"description": "An external URL of an SVG file. Be sure you trust the content you are including, as it will be executed as code and\ncan result in XSS attacks.",
|
||
"type": "string | undefined"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "An alternate description to use for assistive devices. If omitted, the icon will be considered presentational and\nignored by assistive devices.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "library",
|
||
"description": "The name of a registered custom icon library.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-load",
|
||
"description": "Emitted when the icon has loaded. When using `spriteSheet: true` this will not emit."
|
||
},
|
||
{
|
||
"name": "wa-error",
|
||
"description": "Emitted when the icon fails to load due to an error. When using `spriteSheet: true` this will not emit."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-include",
|
||
"description": "Includes give you the power to embed external HTML files into the page.\n---\n\n\n### **Events:**\n - **wa-load** - Emitted when the included file is loaded.\n- **wa-include-error** - Emitted when the included file fails to load due to an error.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "src",
|
||
"description": "The location of the HTML file to include. Be sure you trust the content you are including as it will be executed as\ncode and can result in XSS attacks.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "mode",
|
||
"description": "The fetch mode to use.",
|
||
"value": {
|
||
"type": "'cors' | 'no-cors' | 'same-origin'",
|
||
"default": "'cors'"
|
||
}
|
||
},
|
||
{
|
||
"name": "allow-scripts",
|
||
"description": "Allows included scripts to be executed. Be sure you trust the content you are including as it will be executed as\ncode and can result in XSS attacks.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-load",
|
||
"description": "Emitted when the included file is loaded."
|
||
},
|
||
{
|
||
"name": "wa-include-error",
|
||
"type": "{ status: number }",
|
||
"description": "Emitted when the included file fails to load due to an error."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "src",
|
||
"description": "The location of the HTML file to include. Be sure you trust the content you are including as it will be executed as\ncode and can result in XSS attacks.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "mode",
|
||
"description": "The fetch mode to use.",
|
||
"type": "'cors' | 'no-cors' | 'same-origin'"
|
||
},
|
||
{
|
||
"name": "allowScripts",
|
||
"description": "Allows included scripts to be executed. Be sure you trust the content you are including as it will be executed as\ncode and can result in XSS attacks.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-load",
|
||
"description": "Emitted when the included file is loaded."
|
||
},
|
||
{
|
||
"name": "wa-include-error",
|
||
"type": "{ status: number }",
|
||
"description": "Emitted when the included file fails to load due to an error."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-input",
|
||
"description": "Inputs collect data from the user.\n---\n\n\n### **Events:**\n - **input** - Emitted when the control receives input.\n- **change** - Emitted when an alteration to the control's value is committed by the user.\n- **blur** - Emitted when the control loses focus.\n- **focus** - Emitted when the control gains focus.\n- **wa-clear** - Emitted when the clear button is activated.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the input.\n- **blur()** - Removes focus from the input.\n- **select()** - Selects all the text in the input.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n- **showPicker()** - Displays the browser picker for an input element (only works if the browser supports it for the input type).\n- **stepUp()** - Increments the value of a numeric input type by the value of the step attribute.\n- **stepDown()** - Decrements the value of a numeric input type by the value of the step attribute.\n\n### **Slots:**\n - **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **start** - An element, such as `<wa-icon>`, placed at the start of the input control.\n- **end** - An element, such as `<wa-icon>`, placed at the end of the input control.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **show-password-icon** - An icon to use in lieu of the default show password icon.\n- **hide-password-icon** - An icon to use in lieu of the default hide password icon.\n- **hint** - Text that describes how to use the input. Alternatively, you can use the `hint` attribute.\n\n### **CSS Parts:**\n - **label** - The label\n- **hint** - The hint's wrapper.\n- **base** - The wrapper being rendered as an input\n- **input** - The internal `<input>` control.\n- **start** - The container that wraps the `start` slot.\n- **clear-button** - The clear button.\n- **password-toggle-button** - The password toggle button.\n- **end** - The container that wraps the `end` slot.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
||
{
|
||
"name": "type",
|
||
"description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
|
||
"value": {
|
||
"type": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'",
|
||
"default": "'text'"
|
||
}
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "string | null" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The input's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The input's visual appearance.",
|
||
"value": {
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'",
|
||
"default": "'outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style input with rounded edges.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The input's label. If you need to display HTML, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The input's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "with-clear",
|
||
"description": "Adds a clear button when the input is not empty.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the input is empty.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the input readonly.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "password-toggle",
|
||
"description": "Adds a button to toggle the password's visibility. Only applies to password types.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "password-visible",
|
||
"description": "Determines whether or not the password is currently visible. Only applies to password input types.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "without-spin-buttons",
|
||
"description": "Hides the browser's built-in increment/decrement spin buttons for number inputs.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the input a required field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "pattern",
|
||
"description": "A regular expression pattern to validate input against.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "minlength",
|
||
"description": "The minimum length of input that will be considered valid.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "maxlength",
|
||
"description": "The maximum length of input that will be considered valid.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "min",
|
||
"description": "The input's minimum value. Only applies to date and number input types.",
|
||
"value": { "type": "number | string" }
|
||
},
|
||
{
|
||
"name": "max",
|
||
"description": "The input's maximum value. Only applies to date and number input types.",
|
||
"value": { "type": "number | string" }
|
||
},
|
||
{
|
||
"name": "step",
|
||
"description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
|
||
"value": { "type": "number | 'any'" }
|
||
},
|
||
{
|
||
"name": "autocapitalize",
|
||
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
||
"value": {
|
||
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
||
}
|
||
},
|
||
{
|
||
"name": "autocorrect",
|
||
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
||
"value": { "type": "'off' | 'on'" }
|
||
},
|
||
{
|
||
"name": "autocomplete",
|
||
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "autofocus",
|
||
"description": "Indicates that the input should receive focus on page load.",
|
||
"value": { "type": "boolean" }
|
||
},
|
||
{
|
||
"name": "enterkeyhint",
|
||
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
||
"value": {
|
||
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
||
}
|
||
},
|
||
{
|
||
"name": "spellcheck",
|
||
"description": "Enables spell checking on the input.",
|
||
"value": { "type": "boolean", "default": "true" }
|
||
},
|
||
{
|
||
"name": "inputmode",
|
||
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
||
"value": {
|
||
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
||
}
|
||
},
|
||
{
|
||
"name": "with-label",
|
||
"description": "Used for SSR. Will determine if the SSRed component will have the label slot rendered on initial paint.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"description": "Used for SSR. Will determine if the SSRed component will have the hint slot rendered on initial paint.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "label",
|
||
"description": "The input's label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "start",
|
||
"description": "An element, such as `<wa-icon>`, placed at the start of the input control."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "An element, such as `<wa-icon>`, placed at the end of the input control."
|
||
},
|
||
{
|
||
"name": "clear-icon",
|
||
"description": "An icon to use in lieu of the default clear icon."
|
||
},
|
||
{
|
||
"name": "show-password-icon",
|
||
"description": "An icon to use in lieu of the default show password icon."
|
||
},
|
||
{
|
||
"name": "hide-password-icon",
|
||
"description": "An icon to use in lieu of the default hide password icon."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the input. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when an alteration to the control's value is committed by the user."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "wa-clear",
|
||
"description": "Emitted when the clear button is activated."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "assumeInteractionOn", "type": "array" },
|
||
{ "name": "input", "type": "HTMLInputElement" },
|
||
{ "name": "title", "type": "string" },
|
||
{
|
||
"name": "type",
|
||
"description": "The type of input. Works the same as a native `<input>` element, but only a subset of types are supported. Defaults\nto `text`.",
|
||
"type": "| 'date'\n | 'datetime-local'\n | 'email'\n | 'number'\n | 'password'\n | 'search'\n | 'tel'\n | 'text'\n | 'time'\n | 'url'"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The current value of the input, submitted as a name/value pair with form data."
|
||
},
|
||
{
|
||
"name": "defaultValue",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The input's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The input's visual appearance.",
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style input with rounded edges.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The input's label. If you need to display HTML, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The input's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withClear",
|
||
"description": "Adds a clear button when the input is not empty.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the input is empty.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the input readonly.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "passwordToggle",
|
||
"description": "Adds a button to toggle the password's visibility. Only applies to password types.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "passwordVisible",
|
||
"description": "Determines whether or not the password is currently visible. Only applies to password input types.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withoutSpinButtons",
|
||
"description": "Hides the browser's built-in increment/decrement spin buttons for number inputs.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the input a required field.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "pattern",
|
||
"description": "A regular expression pattern to validate input against.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "minlength",
|
||
"description": "The minimum length of input that will be considered valid.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "maxlength",
|
||
"description": "The maximum length of input that will be considered valid.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "min",
|
||
"description": "The input's minimum value. Only applies to date and number input types.",
|
||
"type": "number | string"
|
||
},
|
||
{
|
||
"name": "max",
|
||
"description": "The input's maximum value. Only applies to date and number input types.",
|
||
"type": "number | string"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"description": "Specifies the granularity that the value must adhere to, or the special value `any` which means no stepping is\nimplied, allowing any numeric value. Only applies to date and number input types.",
|
||
"type": "number | 'any'"
|
||
},
|
||
{
|
||
"name": "autocapitalize",
|
||
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
||
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
||
},
|
||
{
|
||
"name": "autocorrect",
|
||
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
||
"type": "'off' | 'on'"
|
||
},
|
||
{
|
||
"name": "autocomplete",
|
||
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "autofocus",
|
||
"description": "Indicates that the input should receive focus on page load.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "enterkeyhint",
|
||
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
||
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
||
},
|
||
{
|
||
"name": "spellcheck",
|
||
"description": "Enables spell checking on the input.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "inputmode",
|
||
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
||
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
||
},
|
||
{
|
||
"name": "withLabel",
|
||
"description": "Used for SSR. Will determine if the SSRed component will have the label slot rendered on initial paint.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withHint",
|
||
"description": "Used for SSR. Will determine if the SSRed component will have the hint slot rendered on initial paint.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when an alteration to the control's value is committed by the user."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "wa-clear",
|
||
"description": "Emitted when the clear button is activated."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-intersection-observer",
|
||
"description": "Tracks immediate child elements and fires events as they move in and out of view.\n---\n\n\n### **Events:**\n - **wa-intersect** - Fired when a tracked element begins or ceases intersecting.\n\n### **Slots:**\n - _default_ - Elements to track. Only immediate children of the host are monitored.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "root",
|
||
"description": "Element ID to define the viewport boundaries for tracked targets.",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
},
|
||
{
|
||
"name": "root-margin",
|
||
"description": "Offset space around the root boundary. Accepts values like CSS margin syntax.",
|
||
"value": { "type": "string", "default": "'0px'" }
|
||
},
|
||
{
|
||
"name": "threshold",
|
||
"description": "One or more space-separated values representing visibility percentages that trigger the observer callback.",
|
||
"value": { "type": "string", "default": "'0'" }
|
||
},
|
||
{
|
||
"name": "intersect-class",
|
||
"description": "CSS class applied to elements during intersection. Automatically removed when elements leave\nthe viewport, enabling pure CSS styling based on visibility state.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "once",
|
||
"description": "If enabled, observation ceases after initial intersection.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Deactivates the intersection observer functionality.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "Elements to track. Only immediate children of the host are monitored."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-intersect",
|
||
"type": "{ entry: IntersectionObserverEntry }",
|
||
"description": "Fired when a tracked element begins or ceases intersecting."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "root",
|
||
"description": "Element ID to define the viewport boundaries for tracked targets.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "rootMargin",
|
||
"description": "Offset space around the root boundary. Accepts values like CSS margin syntax.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "threshold",
|
||
"description": "One or more space-separated values representing visibility percentages that trigger the observer callback.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "intersectClass",
|
||
"description": "CSS class applied to elements during intersection. Automatically removed when elements leave\nthe viewport, enabling pure CSS styling based on visibility state.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "once",
|
||
"description": "If enabled, observation ceases after initial intersection.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Deactivates the intersection observer functionality.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-intersect",
|
||
"type": "{ entry: IntersectionObserverEntry }",
|
||
"description": "Fired when a tracked element begins or ceases intersecting."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-mutation-observer",
|
||
"description": "The Mutation Observer component offers a thin, declarative interface to the [`MutationObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver).\n---\n\n\n### **Events:**\n - **wa-mutation** - Emitted when a mutation occurs.\n\n### **Slots:**\n - _default_ - The content to watch for mutations.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "attr",
|
||
"description": "Watches for changes to attributes. To watch only specific attributes, separate them by a space, e.g.\n`attr=\"class id title\"`. To watch all attributes, use `*`.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "attr-old-value",
|
||
"description": "Indicates whether or not the attribute's previous value should be recorded when monitoring changes.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "char-data",
|
||
"description": "Watches for changes to the character data contained within the node.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "char-data-old-value",
|
||
"description": "Indicates whether or not the previous value of the node's text should be recorded.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "child-list",
|
||
"description": "Watches for the addition or removal of new child nodes.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the observer.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The content to watch for mutations." }
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-mutation",
|
||
"type": "{ mutationList: MutationRecord[] }",
|
||
"description": "Emitted when a mutation occurs."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "attr",
|
||
"description": "Watches for changes to attributes. To watch only specific attributes, separate them by a space, e.g.\n`attr=\"class id title\"`. To watch all attributes, use `*`.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "attrOldValue",
|
||
"description": "Indicates whether or not the attribute's previous value should be recorded when monitoring changes.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "charData",
|
||
"description": "Watches for changes to the character data contained within the node.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "charDataOldValue",
|
||
"description": "Indicates whether or not the previous value of the node's text should be recorded.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "childList",
|
||
"description": "Watches for the addition or removal of new child nodes.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the observer.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-mutation",
|
||
"type": "{ mutationList: MutationRecord[] }",
|
||
"description": "Emitted when a mutation occurs."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-option",
|
||
"description": "Options define the selectable items within a select component.\n---\n\n\n### **Slots:**\n - _default_ - The option's label.\n- **start** - An element, such as `<wa-icon>`, placed before the label.\n- **end** - An element, such as `<wa-icon>`, placed after the label.\n\n### **CSS Parts:**\n - **checked-icon** - The checked icon, a `<wa-icon>` element.\n- **label** - The option's label.\n- **start** - The container that wraps the `start` slot.\n- **end** - The container that wraps the `end` slot.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The option's value. When selected, the containing form control will receive this value. The value must be unique\nfrom other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Draws the option in a disabled state, preventing selection.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "selected",
|
||
"description": "Selects an option initially.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The option’s plain text label.\nUsually automatically generated, but can be useful to provide manually for cases involving complex content.",
|
||
"value": { "type": "string" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The option's label." },
|
||
{
|
||
"name": "start",
|
||
"description": "An element, such as `<wa-icon>`, placed before the label."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "An element, such as `<wa-icon>`, placed after the label."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "current", "type": "boolean" },
|
||
{
|
||
"name": "value",
|
||
"description": "The option's value. When selected, the containing form control will receive this value. The value must be unique\nfrom other options in the same group. Values may not contain spaces, as spaces are used as delimiters when listing\nmultiple values.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Draws the option in a disabled state, preventing selection.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "defaultSelected",
|
||
"description": "Selects an option initially.",
|
||
"type": "boolean"
|
||
},
|
||
{ "name": "_label", "type": "string" },
|
||
{
|
||
"name": "label",
|
||
"description": "The option’s plain text label.\nUsually automatically generated, but can be useful to provide manually for cases involving complex content.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "defaultLabel",
|
||
"description": "The default label, generated from the element contents. Will be equal to `label` in most cases.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-page",
|
||
"description": "Pages offer an easy way to scaffold entire page layouts using minimal markup.\n---\n\n\n### **Methods:**\n - **visiblePixelsInViewport(element: _HTMLElement | null_)** - https://stackoverflow.com/a/26831113\nThis prevents awkward gaps when scrolling the page and the aside / menu dont \"fill\" the gaps.\n- **showNavigation()** - Shows the mobile navigation drawer\n- **hideNavigation()** - Hides the mobile navigation drawer\n- **toggleNavigation()** - Toggles the mobile navigation drawer\n\n### **Slots:**\n - _default_ - The page's main content.\n- **banner** - The banner that gets display above the header. The banner will not be shown if no content is provided.\n- **header** - The header to display at the top of the page. If a banner is present, the header will appear below the banner. The header will not be shown if there is no content.\n- **subheader** - A subheader to display below the `header`. This is a good place to put things like breadcrumbs.\n- **menu** - The left side of the page. If you slot an element in here, you will override the default `navigation` slot and will be handling navigation on your own. This also will not disable the fallback behavior of the navigation button. This section \"sticks\" to the top as the page scrolls.\n- **navigation-header** - The header for a navigation area. On mobile this will be the header for `<wa-drawer>`.\n- **navigation** - The main content to display in the navigation area. This is displayed on the left side of the page, if `menu` is not used. This section \"sticks\" to the top as the page scrolls.\n- **navigation-footer** - The footer for a navigation area. On mobile this will be the footer for `<wa-drawer>`.\n- **navigation-toggle** - Use this slot to slot in your own button + icon for toggling the navigation drawer. By default it is a `<wa-button>` + a 3 bars `<wa-icon>`\n- **navigation-toggle-icon** - Use this to slot in your own icon for toggling the navigation drawer. By default it is 3 bars `<wa-icon>`.\n- **main-header** - Header to display inline above the main content.\n- **main-footer** - Footer to display inline below the main content.\n- **aside** - Content to be shown on the right side of the page. Typically contains a table of contents, ads, etc. This section \"sticks\" to the top as the page scrolls.\n- **skip-to-content** - The \"skip to content\" slot. You can override this If you would like to override the `Skip to content` button and add additional \"Skip to X\", they can be inserted here.\n- **footer** - The content to display in the footer. This is always displayed underneath the viewport so will always make the page \"scrollable\".\n\n### **CSS Properties:**\n - **--menu-width** - The width of the page's \"menu\" section. _(default: auto)_\n- **--main-width** - The width of the page's \"main\" section. _(default: 1fr)_\n- **--aside-width** - The wide of the page's \"aside\" section. _(default: auto)_\n- **--banner-height** - The height of the banner. This gets calculated when the page initializes. If the height is known, you can set it here to prevent shifting when the page loads. _(default: 0px)_\n- **--header-height** - The height of the header. This gets calculated when the page initializes. If the height is known, you can set it here to prevent shifting when the page loads. _(default: 0px)_\n- **--subheader-height** - The height of the subheader. This gets calculated when the page initializes. If the height is known, you can set it here to prevent shifting when the page loads. _(default: 0px)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **banner** - The banner to show above header.\n- **header** - The header, usually for top level navigation / branding.\n- **subheader** - Shown below the header, usually intended for things like breadcrumbs and other page level navigation.\n- **body** - The wrapper around menu, main, and aside.\n- **menu** - The left hand side of the page. Generally intended for navigation.\n- **navigation** - The `<nav>` that wraps the navigation slots on desktop viewports.\n- **navigation-header** - The header for a navigation area. On mobile this will be the header for `<wa-drawer>`.\n- **navigation-footer** - The footer for a navigation area. On mobile this will be the footer for `<wa-drawer>`.\n- **navigation-toggle** - The default `<wa-button>` that will toggle the `<wa-drawer>` for mobile viewports.\n- **navigation-toggle-icon** - The default `<wa-icon>` displayed inside of the navigation-toggle button.\n- **main-header** - The header above main content.\n- **main-content** - The main content.\n- **main-footer** - The footer below main content.\n- **aside** - The right hand side of the page. Used for things like table of contents, ads, etc.\n- **skip-links** - Wrapper around skip-link\n- **skip-link** - The \"skip to main content\" link\n- **footer** - The footer of the page. This is always below the initial viewport size.\n- **dialog-wrapper** - A wrapper around elements such as dialogs or other modal-like elements.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "view",
|
||
"description": "The view is a reflection of the \"mobileBreakpoint\", when the page is larger than the `mobile-breakpoint` (768px by\ndefault), it is considered to be a \"desktop\" view. The view is merely a way to distinguish when to show/hide the\nnavigation. You can use additional media queries to make other adjustments to content as necessary.\nThe default is \"desktop\" because the \"mobile navigation drawer\" isn't accessible via SSR due to drawer requiring JS.",
|
||
"value": {
|
||
"type": "'mobile' | 'desktop'",
|
||
"default": "'desktop'"
|
||
}
|
||
},
|
||
{
|
||
"name": "nav-open",
|
||
"description": "Whether or not the navigation drawer is open. Note, the navigation drawer is only \"open\" on mobile views.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "mobile-breakpoint",
|
||
"description": "At what page width to hide the \"navigation\" slot and collapse into a hamburger button.\nAccepts both numbers (interpreted as px) and CSS lengths (e.g. `50em`), which are resolved based on the root element.",
|
||
"value": { "type": "string", "default": "'768px'" }
|
||
},
|
||
{
|
||
"name": "navigation-placement",
|
||
"description": "Where to place the navigation when in the mobile viewport.",
|
||
"value": { "type": "'start' | 'end'", "default": "'start'" }
|
||
},
|
||
{
|
||
"name": "disable-navigation-toggle",
|
||
"description": "Determines whether or not to hide the default hamburger button.\nThis will automatically flip to \"true\" if you add an element with `data-toggle-nav` anywhere in the element light DOM.\nGenerally this will be set for you and you don't need to do anything, unless you're using SSR, in which case you should set this manually for initial page loads.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The page's main content." },
|
||
{
|
||
"name": "banner",
|
||
"description": "The banner that gets display above the header. The banner will not be shown if no content is provided."
|
||
},
|
||
{
|
||
"name": "header",
|
||
"description": "The header to display at the top of the page. If a banner is present, the header will appear below the banner. The header will not be shown if there is no content."
|
||
},
|
||
{
|
||
"name": "subheader",
|
||
"description": "A subheader to display below the `header`. This is a good place to put things like breadcrumbs."
|
||
},
|
||
{
|
||
"name": "menu",
|
||
"description": "The left side of the page. If you slot an element in here, you will override the default `navigation` slot and will be handling navigation on your own. This also will not disable the fallback behavior of the navigation button. This section \"sticks\" to the top as the page scrolls."
|
||
},
|
||
{
|
||
"name": "navigation-header",
|
||
"description": "The header for a navigation area. On mobile this will be the header for `<wa-drawer>`."
|
||
},
|
||
{
|
||
"name": "navigation",
|
||
"description": "The main content to display in the navigation area. This is displayed on the left side of the page, if `menu` is not used. This section \"sticks\" to the top as the page scrolls."
|
||
},
|
||
{
|
||
"name": "navigation-footer",
|
||
"description": "The footer for a navigation area. On mobile this will be the footer for `<wa-drawer>`."
|
||
},
|
||
{
|
||
"name": "navigation-toggle",
|
||
"description": "Use this slot to slot in your own button + icon for toggling the navigation drawer. By default it is a `<wa-button>` + a 3 bars `<wa-icon>`"
|
||
},
|
||
{
|
||
"name": "navigation-toggle-icon",
|
||
"description": "Use this to slot in your own icon for toggling the navigation drawer. By default it is 3 bars `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "main-header",
|
||
"description": "Header to display inline above the main content."
|
||
},
|
||
{
|
||
"name": "main-footer",
|
||
"description": "Footer to display inline below the main content."
|
||
},
|
||
{
|
||
"name": "aside",
|
||
"description": "Content to be shown on the right side of the page. Typically contains a table of contents, ads, etc. This section \"sticks\" to the top as the page scrolls."
|
||
},
|
||
{
|
||
"name": "skip-to-content",
|
||
"description": "The \"skip to content\" slot. You can override this If you would like to override the `Skip to content` button and add additional \"Skip to X\", they can be inserted here."
|
||
},
|
||
{
|
||
"name": "footer",
|
||
"description": "The content to display in the footer. This is always displayed underneath the viewport so will always make the page \"scrollable\"."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "header", "type": "HTMLElement" },
|
||
{ "name": "menu", "type": "HTMLElement" },
|
||
{ "name": "main", "type": "HTMLElement" },
|
||
{ "name": "aside", "type": "HTMLElement" },
|
||
{ "name": "subheader", "type": "HTMLElement" },
|
||
{ "name": "footer", "type": "HTMLElement" },
|
||
{ "name": "banner", "type": "HTMLElement" },
|
||
{ "name": "navigationDrawer", "type": "WaDrawer" },
|
||
{ "name": "navigationToggleSlot", "type": "HTMLSlotElement" },
|
||
{
|
||
"name": "view",
|
||
"description": "The view is a reflection of the \"mobileBreakpoint\", when the page is larger than the `mobile-breakpoint` (768px by\ndefault), it is considered to be a \"desktop\" view. The view is merely a way to distinguish when to show/hide the\nnavigation. You can use additional media queries to make other adjustments to content as necessary.\nThe default is \"desktop\" because the \"mobile navigation drawer\" isn't accessible via SSR due to drawer requiring JS.",
|
||
"type": "'mobile' | 'desktop'"
|
||
},
|
||
{
|
||
"name": "navOpen",
|
||
"description": "Whether or not the navigation drawer is open. Note, the navigation drawer is only \"open\" on mobile views.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "mobileBreakpoint",
|
||
"description": "At what page width to hide the \"navigation\" slot and collapse into a hamburger button.\nAccepts both numbers (interpreted as px) and CSS lengths (e.g. `50em`), which are resolved based on the root element.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "navigationPlacement",
|
||
"description": "Where to place the navigation when in the mobile viewport.",
|
||
"type": "'start' | 'end'"
|
||
},
|
||
{
|
||
"name": "disableNavigationToggle",
|
||
"description": "Determines whether or not to hide the default hamburger button.\nThis will automatically flip to \"true\" if you add an element with `data-toggle-nav` anywhere in the element light DOM.\nGenerally this will be set for you and you don't need to do anything, unless you're using SSR, in which case you should set this manually for initial page loads.",
|
||
"type": "boolean"
|
||
},
|
||
{ "name": "pageResizeObserver" },
|
||
{ "name": "updateAsideAndMenuHeights" }
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-popover",
|
||
"description": "Popovers display contextual content and interactive elements in a floating panel.\n---\n\n\n### **Events:**\n - **wa-show** - Emitted when the popover begins to show. Canceling this event will stop the popover from showing.\n- **wa-after-show** - Emitted after the popover has shown and all animations are complete.\n- **wa-hide** - Emitted when the popover begins to hide. Canceling this event will stop the popover from hiding.\n- **wa-after-hide** - Emitted after the popover has hidden and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the popover.\n- **hide()** - Hides the popover.\n\n### **Slots:**\n - _default_ - The popover's content. Interactive elements such as buttons and links are supported.\n\n### **CSS Properties:**\n - **--arrow-size** - The size of the tiny arrow that points to the popover (set to zero to remove). _(default: 0.375rem)_\n- **--max-width** - The maximum width of the popover's body content. _(default: 25rem)_\n- **--show-duration** - The speed of the show animation. _(default: 100ms)_\n- **--hide-duration** - The speed of the hide animation. _(default: 100ms)_\n\n### **CSS Parts:**\n - **dialog** - The native dialog element that contains the popover content.\n- **body** - The popover's body where its content is rendered.\n- **popup** - The internal `<wa-popup>` element that positions the popover.\n- **popup__popup** - The popup's exported `popup` part. Use this to target the popover's popup container.\n- **popup__arrow** - The popup's exported `arrow` part. Use this to target the popover's arrow.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the popover. Note that the actual placement may vary as needed to keep the popover\ninside of the viewport.",
|
||
"value": {
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'",
|
||
"default": "'top'"
|
||
}
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Shows or hides the popover.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance in pixels from which to offset the popover away from its target.",
|
||
"value": { "type": "number", "default": "8" }
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The distance in pixels from which to offset the popover along its target.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "for",
|
||
"description": "The ID of the popover's anchor element. This must be an interactive/focusable element such as a button.",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
},
|
||
{
|
||
"name": "without-arrow",
|
||
"description": "Removes the arrow from the popover.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The popover's content. Interactive elements such as buttons and links are supported."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the popover begins to show. Canceling this event will stop the popover from showing."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the popover has shown and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the popover begins to hide. Canceling this event will stop the popover from hiding."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the popover has hidden and all animations are complete."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "dialog", "type": "HTMLDialogElement" },
|
||
{ "name": "body", "type": "HTMLElement" },
|
||
{ "name": "popup", "type": "WaPopup" },
|
||
{ "name": "anchor", "type": "null | Element" },
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the popover. Note that the actual placement may vary as needed to keep the popover\ninside of the viewport.",
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Shows or hides the popover.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance in pixels from which to offset the popover away from its target.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The distance in pixels from which to offset the popover along its target.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "for",
|
||
"description": "The ID of the popover's anchor element. This must be an interactive/focusable element such as a button.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "withoutArrow",
|
||
"description": "Removes the arrow from the popover.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the popover begins to show. Canceling this event will stop the popover from showing."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the popover has shown and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the popover begins to hide. Canceling this event will stop the popover from hiding."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the popover has hidden and all animations are complete."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-popup",
|
||
"description": "Popup is a utility that lets you declaratively anchor \"popup\" containers to another element.\n---\n\n\n### **Events:**\n - **wa-reposition** - Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it.\n\n### **Methods:**\n - **reposition()** - Forces the popup to recalculate and reposition itself.\n\n### **Slots:**\n - _default_ - The popup's content.\n- **anchor** - The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead.\n\n### **CSS Properties:**\n - **--arrow-size** - The size of the arrow. Note that an arrow won't be shown unless the `arrow` attribute is used. _(default: 6px)_\n- **--arrow-color** - The color of the arrow. _(default: black)_\n- **--auto-size-available-width** - A read-only custom property that determines the amount of width the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n- **--auto-size-available-height** - A read-only custom property that determines the amount of height the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n- **--show-duration** - The show duration to use when applying built-in animation classes. _(default: 100ms)_\n- **--hide-duration** - The hide duration to use when applying built-in animation classes. _(default: 100ms)_\n\n### **CSS Parts:**\n - **arrow** - The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.\n- **popup** - The popup's container. Useful for setting a background color, box shadow, etc.\n- **hover-bridge** - The hover bridge element. Only available when the `hover-bridge` option is enabled.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "anchor",
|
||
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
||
"value": { "type": "Element | string | VirtualElement" }
|
||
},
|
||
{
|
||
"name": "active",
|
||
"description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
|
||
"value": {
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'",
|
||
"default": "'top'"
|
||
}
|
||
},
|
||
{
|
||
"name": "boundary",
|
||
"description": "The bounding box to use for flipping, shifting, and auto-sizing.",
|
||
"value": {
|
||
"type": "'viewport' | 'scroll'",
|
||
"default": "'viewport'"
|
||
}
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance in pixels from which to offset the panel away from its anchor.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "arrow",
|
||
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "arrow-placement",
|
||
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
||
"value": {
|
||
"type": "'start' | 'end' | 'center' | 'anchor'",
|
||
"default": "'anchor'"
|
||
}
|
||
},
|
||
{
|
||
"name": "arrow-padding",
|
||
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
||
"value": { "type": "number", "default": "10" }
|
||
},
|
||
{
|
||
"name": "flip",
|
||
"description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "flip-fallback-placements",
|
||
"description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "flip-fallback-strategy",
|
||
"description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
|
||
"value": {
|
||
"type": "'best-fit' | 'initial'",
|
||
"default": "'best-fit'"
|
||
}
|
||
},
|
||
{
|
||
"name": "flipBoundary",
|
||
"description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
||
"value": { "type": "Element | Element[]" }
|
||
},
|
||
{
|
||
"name": "flip-padding",
|
||
"description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "shift",
|
||
"description": "Moves the popup along the axis to keep it in view when clipped.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "shiftBoundary",
|
||
"description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
||
"value": { "type": "Element | Element[]" }
|
||
},
|
||
{
|
||
"name": "shift-padding",
|
||
"description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "auto-size",
|
||
"description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
|
||
"value": { "type": "'horizontal' | 'vertical' | 'both'" }
|
||
},
|
||
{
|
||
"name": "sync",
|
||
"description": "Syncs the popup's width or height to that of the anchor element.",
|
||
"value": { "type": "'width' | 'height' | 'both'" }
|
||
},
|
||
{
|
||
"name": "autoSizeBoundary",
|
||
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
||
"value": { "type": "Element | Element[]" }
|
||
},
|
||
{
|
||
"name": "auto-size-padding",
|
||
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "hover-bridge",
|
||
"description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The popup's content." },
|
||
{
|
||
"name": "anchor",
|
||
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-reposition",
|
||
"description": "Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "popup",
|
||
"description": "A reference to the internal popup container. Useful for animating and styling the popup with JavaScript.",
|
||
"type": "HTMLElement"
|
||
},
|
||
{
|
||
"name": "anchor",
|
||
"description": "The element the popup will be anchored to. If the anchor lives outside of the popup, you can provide the anchor\nelement `id`, a DOM element reference, or a `VirtualElement`. If the anchor lives inside the popup, use the\n`anchor` slot instead.",
|
||
"type": "Element | string | VirtualElement"
|
||
},
|
||
{
|
||
"name": "active",
|
||
"description": "Activates the positioning logic and shows the popup. When this attribute is removed, the positioning logic is torn\ndown and the popup will be hidden.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the popup. Note that the actual placement will vary as configured to keep the\npanel inside of the viewport.",
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
||
},
|
||
{
|
||
"name": "boundary",
|
||
"description": "The bounding box to use for flipping, shifting, and auto-sizing.",
|
||
"type": "'viewport' | 'scroll'"
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance in pixels from which to offset the panel away from its anchor.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The distance in pixels from which to offset the panel along its anchor.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "arrow",
|
||
"description": "Attaches an arrow to the popup. The arrow's size and color can be customized using the `--arrow-size` and\n`--arrow-color` custom properties. For additional customizations, you can also target the arrow using\n`::part(arrow)` in your stylesheet.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "arrowPlacement",
|
||
"description": "The placement of the arrow. The default is `anchor`, which will align the arrow as close to the center of the\nanchor as possible, considering available space and `arrow-padding`. A value of `start`, `end`, or `center` will\nalign the arrow to the start, end, or center of the popover instead.",
|
||
"type": "'start' | 'end' | 'center' | 'anchor'"
|
||
},
|
||
{
|
||
"name": "arrowPadding",
|
||
"description": "The amount of padding between the arrow and the edges of the popup. If the popup has a border-radius, for example,\nthis will prevent it from overflowing the corners.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "flip",
|
||
"description": "When set, placement of the popup will flip to the opposite site to keep it in view. You can use\n`flipFallbackPlacements` to further configure how the fallback placement is determined.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "flipFallbackPlacements",
|
||
"description": "If the preferred placement doesn't fit, popup will be tested in these fallback placements until one fits. Must be a\nstring of any number of placements separated by a space, e.g. \"top bottom left\". If no placement fits, the flip\nfallback strategy will be used instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "flipFallbackStrategy",
|
||
"description": "When neither the preferred placement nor the fallback placements fit, this value will be used to determine whether\nthe popup should be positioned using the best available fit based on available space or as it was initially\npreferred.",
|
||
"type": "'best-fit' | 'initial'"
|
||
},
|
||
{
|
||
"name": "flipBoundary",
|
||
"description": "The flip boundary describes clipping element(s) that overflow will be checked relative to when flipping. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
||
"type": "Element | Element[]"
|
||
},
|
||
{
|
||
"name": "flipPadding",
|
||
"description": "The amount of padding, in pixels, to exceed before the flip behavior will occur.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "shift",
|
||
"description": "Moves the popup along the axis to keep it in view when clipped.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "shiftBoundary",
|
||
"description": "The shift boundary describes clipping element(s) that overflow will be checked relative to when shifting. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
||
"type": "Element | Element[]"
|
||
},
|
||
{
|
||
"name": "shiftPadding",
|
||
"description": "The amount of padding, in pixels, to exceed before the shift behavior will occur.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "autoSize",
|
||
"description": "When set, this will cause the popup to automatically resize itself to prevent it from overflowing.",
|
||
"type": "'horizontal' | 'vertical' | 'both'"
|
||
},
|
||
{
|
||
"name": "sync",
|
||
"description": "Syncs the popup's width or height to that of the anchor element.",
|
||
"type": "'width' | 'height' | 'both'"
|
||
},
|
||
{
|
||
"name": "autoSizeBoundary",
|
||
"description": "The auto-size boundary describes clipping element(s) that overflow will be checked relative to when resizing. By\ndefault, the boundary includes overflow ancestors that will cause the element to be clipped. If needed, you can\nchange the boundary by passing a reference to one or more elements to this property.",
|
||
"type": "Element | Element[]"
|
||
},
|
||
{
|
||
"name": "autoSizePadding",
|
||
"description": "The amount of padding, in pixels, to exceed before the auto-size behavior will occur.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "hoverBridge",
|
||
"description": "When a gap exists between the anchor and the popup element, this option will add a \"hover bridge\" that fills the\ngap using an invisible element. This makes listening for events such as `mouseenter` and `mouseleave` more sane\nbecause the pointer never technically leaves the element. The hover bridge will only be drawn when the popover is\nactive.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-reposition",
|
||
"description": "Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-progress-bar",
|
||
"description": "Progress bars are used to show the status of an ongoing operation.\n---\n\n\n### **Slots:**\n - _default_ - A label to show inside the progress indicator.\n\n### **CSS Properties:**\n - **--track-height** - The color of the track. _(default: 1rem)_\n- **--track-color** - The color of the track. _(default: var(--wa-color-neutral-fill-normal))_\n- **--indicator-color** - The color of the indicator. _(default: var(--wa-color-brand-fill-loud))_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **indicator** - The progress bar's indicator.\n- **label** - The progress bar's label.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The current progress as a percentage, 0 to 100.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "indeterminate",
|
||
"description": "When true, percentage is ignored, the label is hidden, and the progress bar is drawn in an indeterminate state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "A custom label for assistive devices.",
|
||
"value": { "type": "string", "default": "''" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "A label to show inside the progress indicator."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "value",
|
||
"description": "The current progress as a percentage, 0 to 100.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "indeterminate",
|
||
"description": "When true, percentage is ignored, the label is hidden, and the progress bar is drawn in an indeterminate state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "A custom label for assistive devices.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-qr-code",
|
||
"description": "Generates a [QR code](https://www.qrcode.com/) and renders it using the [Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API).\n---\n\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The QR code's value.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The label for assistive devices to announce. If unspecified, the value will be used instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The size of the QR code, in pixels.",
|
||
"value": { "type": "number", "default": "128" }
|
||
},
|
||
{
|
||
"name": "fill",
|
||
"description": "The fill color. This can be any valid CSS color, but not a CSS custom property.",
|
||
"value": { "type": "string", "default": "'black'" }
|
||
},
|
||
{
|
||
"name": "background",
|
||
"description": "The background color. This can be any valid CSS color or `transparent`. It cannot be a CSS custom property.",
|
||
"value": { "type": "string", "default": "'white'" }
|
||
},
|
||
{
|
||
"name": "radius",
|
||
"description": "The edge radius of each module. Must be between 0 and 0.5.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "error-correction",
|
||
"description": "The level of error correction to use. [Learn more](https://www.qrcode.com/en/about/error_correction.html)",
|
||
"value": { "type": "'L' | 'M' | 'Q' | 'H'", "default": "'H'" }
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "canvas", "type": "HTMLElement" },
|
||
{
|
||
"name": "value",
|
||
"description": "The QR code's value.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The label for assistive devices to announce. If unspecified, the value will be used instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The size of the QR code, in pixels.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "fill",
|
||
"description": "The fill color. This can be any valid CSS color, but not a CSS custom property.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "background",
|
||
"description": "The background color. This can be any valid CSS color or `transparent`. It cannot be a CSS custom property.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "radius",
|
||
"description": "The edge radius of each module. Must be between 0 and 0.5.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "errorCorrection",
|
||
"description": "The level of error correction to use. [Learn more](https://www.qrcode.com/en/about/error_correction.html)",
|
||
"type": "'L' | 'M' | 'Q' | 'H'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-progress-ring",
|
||
"description": "Progress rings are used to show the progress of a determinate operation in a circular fashion.\n---\n\n\n### **Slots:**\n - _default_ - A label to show inside the ring.\n\n### **CSS Properties:**\n - **--size** - The diameter of the progress ring (cannot be a percentage). _(default: undefined)_\n- **--track-width** - The width of the track. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-width** - The width of the indicator. Defaults to the track width. _(default: undefined)_\n- **--indicator-color** - The color of the indicator. _(default: undefined)_\n- **--indicator-transition-duration** - The duration of the indicator's transition when the value changes. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label** - The progress ring label.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The current progress as a percentage, 0 to 100.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "A custom label for assistive devices.",
|
||
"value": { "type": "string", "default": "''" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "A label to show inside the ring." }
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "indicator", "type": "SVGCircleElement" },
|
||
{ "name": "indicatorOffset", "type": "string" },
|
||
{
|
||
"name": "value",
|
||
"description": "The current progress as a percentage, 0 to 100.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "A custom label for assistive devices.",
|
||
"type": "string"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-radio",
|
||
"description": "Radios allow the user to select a single option from a group.\n---\n\n\n### **Events:**\n - **blur** - Emitted when the control loses focus.\n- **focus** - Emitted when the control gains focus.\n\n### **Slots:**\n - _default_ - The radio's label.\n\n### **CSS Properties:**\n - **--checked-icon-color** - The color of the checked icon. _(default: undefined)_\n- **--checked-icon-scale** - The size of the checked icon relative to the radio. _(default: undefined)_\n\n### **CSS Parts:**\n - **control** - The circular container that wraps the radio's checked state.\n- **checked-icon** - The checked icon.\n- **label** - The container that wraps the radio's label.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "value",
|
||
"description": "The radio's value. When selected, the radio group will receive this value.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The radio's visual appearance.",
|
||
"value": {
|
||
"type": "'default' | 'button'",
|
||
"default": "'default'"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the radio.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [{ "name": "", "description": "The radio's label." }],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "checked", "type": "boolean" },
|
||
{
|
||
"name": "value",
|
||
"description": "The radio's value. When selected, the radio group will receive this value.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The radio's visual appearance.",
|
||
"type": "'default' | 'button'"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The radio's size. When used inside a radio group, the size will be determined by the radio group's size so this\nattribute can typically be omitted.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the radio.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-radio-group",
|
||
"description": "Radio groups are used to group multiple [radios](/docs/components/radio) so they function as a single form control.\n---\n\n\n### **Events:**\n - **input** - Emitted when the radio group receives user input.\n- **change** - Emitted when the radio group's selected value changes.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the radio group.\n\n### **Slots:**\n - _default_ - The default slot where `<wa-radio>` elements are placed.\n- **label** - The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute.\n- **hint** - Text that describes how to use the radio group. Alternatively, you can use the `hint` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and hint.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **radios** - The wrapper than surrounds radio items, styled as a flex container by default.\n- **hint** - The hint's wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "label",
|
||
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The radio groups's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the radio group and all child radios.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "The orientation in which to show radio items.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'vertical'"
|
||
}
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "string | null" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The radio group's size. This size will be applied to all child radios and radio buttons, except when explicitly overridden.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-label",
|
||
"description": "Used for SSR. if true, will show slotted label on initial render.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"description": "Used for SSR. if true, will show slotted hint on initial render.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The default slot where `<wa-radio>` elements are placed."
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the radio group. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the radio group receives user input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the radio group's selected value changes."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{
|
||
"name": "label",
|
||
"description": "The radio group's label. Required for proper accessibility. If you need to display HTML, use the `label` slot\ninstead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The radio groups's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the radio group, submitted as a name/value pair with form data.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the radio group and all child radios.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "The orientation in which to show radio items.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The current value of the radio group, submitted as a name/value pair with form data."
|
||
},
|
||
{
|
||
"name": "defaultValue",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The radio group's size. This size will be applied to all child radios and radio buttons, except when explicitly overridden.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Ensures a child radio is checked before allowing the containing form to submit.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withLabel",
|
||
"description": "Used for SSR. if true, will show slotted label on initial render.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withHint",
|
||
"description": "Used for SSR. if true, will show slotted hint on initial render.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "validationTarget",
|
||
"description": "We use the first available radio as the validationTarget similar to native HTML that shows the validation popup on\nthe first radio element."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the radio group receives user input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the radio group's selected value changes."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-rating",
|
||
"description": "Ratings give users a way to quickly view and provide feedback.\n---\n\n\n### **Events:**\n - **change** - Emitted when the rating's value changes.\n- **wa-hover** - Emitted when the user hovers over a value. The `phase` property indicates when hovering starts, moves to a new value, or ends. The `value` property tells what the rating's value would be if the user were to commit to the hovered value.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the rating.\n- **blur()** - Removes focus from the rating.\n\n### **CSS Properties:**\n - **--symbol-color** - The inactive color for symbols. _(default: undefined)_\n- **--symbol-color-active** - The active color for symbols. _(default: undefined)_\n- **--symbol-spacing** - The spacing to use around symbols. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "label",
|
||
"description": "A label that describes the rating to assistive devices.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The current rating.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "max",
|
||
"description": "The highest rating to show.",
|
||
"value": { "type": "number", "default": "5" }
|
||
},
|
||
{
|
||
"name": "precision",
|
||
"description": "The precision at which the rating will increase and decrease. For example, to allow half-star ratings, set this\nattribute to `0.5`.",
|
||
"value": { "type": "number", "default": "1" }
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the rating readonly.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the rating.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "getSymbol",
|
||
"description": "A function that customizes the symbol to be rendered. The first and only argument is the rating's current value.\nThe function should return a string containing trusted HTML of the symbol to render at the specified value. Works\nwell with `<wa-icon>` elements.",
|
||
"value": {
|
||
"type": "(value: number, isSelected: boolean) => string"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The component's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the rating's value changes."
|
||
},
|
||
{
|
||
"name": "wa-hover",
|
||
"type": "{ phase: 'start' | 'move' | 'end', value: number }",
|
||
"description": "Emitted when the user hovers over a value. The `phase` property indicates when hovering starts, moves to a new value, or ends. The `value` property tells what the rating's value would be if the user were to commit to the hovered value."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "rating", "type": "HTMLElement" },
|
||
{
|
||
"name": "label",
|
||
"description": "A label that describes the rating to assistive devices.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The current rating.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "max",
|
||
"description": "The highest rating to show.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "precision",
|
||
"description": "The precision at which the rating will increase and decrease. For example, to allow half-star ratings, set this\nattribute to `0.5`.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the rating readonly.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the rating.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "getSymbol",
|
||
"description": "A function that customizes the symbol to be rendered. The first and only argument is the rating's current value.\nThe function should return a string containing trusted HTML of the symbol to render at the specified value. Works\nwell with `<wa-icon>` elements.",
|
||
"type": "(value: number, isSelected: boolean) => string"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The component's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the rating's value changes."
|
||
},
|
||
{
|
||
"name": "wa-hover",
|
||
"type": "{ phase: 'start' | 'move' | 'end', value: number }",
|
||
"description": "Emitted when the user hovers over a value. The `phase` property indicates when hovering starts, moves to a new value, or ends. The `value` property tells what the rating's value would be if the user were to commit to the hovered value."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-relative-time",
|
||
"description": "Outputs a localized time phrase relative to the current date and time.\n---\n",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "date",
|
||
"description": "The date from which to calculate time from. If not set, the current date and time will be used. When passing a\nstring, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert\na date to this format in JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).",
|
||
"value": { "type": "Date | string", "default": "new Date()" }
|
||
},
|
||
{
|
||
"name": "format",
|
||
"description": "The formatting style to use.",
|
||
"value": {
|
||
"type": "'long' | 'short' | 'narrow'",
|
||
"default": "'long'"
|
||
}
|
||
},
|
||
{
|
||
"name": "numeric",
|
||
"description": "When `auto`, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When `always`, values such as\n\"1 day ago\" and \"in 1 day\" will be shown.",
|
||
"value": { "type": "'always' | 'auto'", "default": "'auto'" }
|
||
},
|
||
{
|
||
"name": "sync",
|
||
"description": "Keep the displayed value up to date as time passes.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "date",
|
||
"description": "The date from which to calculate time from. If not set, the current date and time will be used. When passing a\nstring, it's strongly recommended to use the ISO 8601 format to ensure timezones are handled correctly. To convert\na date to this format in JavaScript, use [`date.toISOString()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).",
|
||
"type": "Date | string"
|
||
},
|
||
{
|
||
"name": "format",
|
||
"description": "The formatting style to use.",
|
||
"type": "'long' | 'short' | 'narrow'"
|
||
},
|
||
{
|
||
"name": "numeric",
|
||
"description": "When `auto`, values such as \"yesterday\" and \"tomorrow\" will be shown when possible. When `always`, values such as\n\"1 day ago\" and \"in 1 day\" will be shown.",
|
||
"type": "'always' | 'auto'"
|
||
},
|
||
{
|
||
"name": "sync",
|
||
"description": "Keep the displayed value up to date as time passes.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-resize-observer",
|
||
"description": "The Resize Observer component offers a thin, declarative interface to the [`ResizeObserver API`](https://developer.mozilla.org/en-US/docs/Web/API/ResizeObserver).\n---\n\n\n### **Events:**\n - **wa-resize** - Emitted when the element is resized.\n\n### **Slots:**\n - _default_ - One or more elements to watch for resizing.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the observer.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "One or more elements to watch for resizing."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-resize",
|
||
"type": "{ entries: ResizeObserverEntry[] }",
|
||
"description": "Emitted when the element is resized."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the observer.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-resize",
|
||
"type": "{ entries: ResizeObserverEntry[] }",
|
||
"description": "Emitted when the element is resized."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-scroller",
|
||
"description": "Scrollers create an accessible container while providing visual cues that help users identify and navigate\nthrough content that scrolls.\n---\n\n\n### **Slots:**\n - _default_ - The content to show inside the scroller.\n\n### **CSS Properties:**\n - **--shadow-color** - The base color of the shadow. _(default: var(--wa-color-surface-default))_\n- **--shadow-size** - The size of the shadow. _(default: 2rem)_\n\n### **CSS Parts:**\n - **content** - The container that wraps the slotted content.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "orientation",
|
||
"description": "The scroller's orientation.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'horizontal'"
|
||
}
|
||
},
|
||
{
|
||
"name": "without-scrollbar",
|
||
"description": "Removes the visible scrollbar.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "without-shadow",
|
||
"description": "Removes the shadows.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The content to show inside the scroller."
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "content", "type": "HTMLElement" },
|
||
{ "name": "canScroll", "type": "boolean" },
|
||
{
|
||
"name": "orientation",
|
||
"description": "The scroller's orientation.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
},
|
||
{
|
||
"name": "withoutScrollbar",
|
||
"description": "Removes the visible scrollbar.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withoutShadow",
|
||
"description": "Removes the shadows.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-skeleton",
|
||
"description": "Skeletons are used to provide a visual representation of where content will eventually be drawn.\n---\n\n\n### **CSS Properties:**\n - **--color** - The color of the skeleton. _(default: undefined)_\n- **--sheen-color** - The sheen color when the skeleton is in its loading state. _(default: undefined)_\n\n### **CSS Parts:**\n - **indicator** - The skeleton's indicator which is responsible for its color and animation.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "effect",
|
||
"description": "Determines which effect the skeleton will use.",
|
||
"value": {
|
||
"type": "'pulse' | 'sheen' | 'none'",
|
||
"default": "'none'"
|
||
}
|
||
}
|
||
],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "effect",
|
||
"description": "Determines which effect the skeleton will use.",
|
||
"type": "'pulse' | 'sheen' | 'none'"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-select",
|
||
"description": "Selects allow you to choose items from a menu of predefined options.\n---\n\n\n### **Events:**\n - **input** - Emitted when the control receives input.\n- **change** - Emitted when the control's value changes.\n- **focus** - Emitted when the control gains focus.\n- **blur** - Emitted when the control loses focus.\n- **wa-clear** - Emitted when the control's value is cleared.\n- **wa-show** - Emitted when the select's menu opens.\n- **wa-after-show** - Emitted after the select's menu opens and all animations are complete.\n- **wa-hide** - Emitted when the select's menu closes.\n- **wa-after-hide** - Emitted after the select's menu closes and all animations are complete.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the listbox.\n- **hide()** - Hides the listbox.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The listbox options. Must be `<wa-option>` elements. You can use `<wa-divider>` to group items visually.\n- **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **start** - An element, such as `<wa-icon>`, placed at the start of the combobox.\n- **end** - An element, such as `<wa-icon>`, placed at the end of the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n- **hint** - Text that describes how to use the input. Alternatively, you can use the `hint` attribute.\n\n### **CSS Properties:**\n - **--show-duration** - The duration of the show animation. _(default: 100ms)_\n- **--hide-duration** - The duration of the hide animation. _(default: 100ms)_\n- **--tag-max-size** - When using `multiple`, the max size of tags before their content is truncated. _(default: 10ch)_\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and hint.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The select's wrapper.\n- **hint** - The hint's wrapper.\n- **combobox** - The container the wraps the start, end, value, clear icon, and expand button.\n- **start** - The container that wraps the `start` slot.\n- **end** - The container that wraps the `end` slot.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where options are slotted.\n- **tags** - The container that houses option tags when `multiselect` is used.\n- **tag** - The individual tags that represent each multiselect option.\n- **tag__content** - The tag's content part.\n- **tag__remove-button** - The tag's remove button.\n- **tag__remove-button__base** - The tag's remove button base part.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the select, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The select's value. This will be a string for single select or an array for multi-select.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The select's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the select is empty.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "multiple",
|
||
"description": "Allows more than one option to be selected.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "max-options-visible",
|
||
"description": "The maximum number of selected options to show when `multiple` is true. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
||
"value": { "type": "number", "default": "3" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the select control.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-clear",
|
||
"description": "Adds a clear button when the select is not empty.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the select's open state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The select's visual appearance.",
|
||
"value": {
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'",
|
||
"default": "'outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style select with rounded edges.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The select's label. If you need to display HTML, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the select's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
|
||
"value": { "type": "'top' | 'bottom'", "default": "'bottom'" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The select's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "with-label",
|
||
"description": "Used for SSR purposes when a label is slotted in. Will show the label on first render.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"description": "Used for SSR purposes when hint is slotted in. Will show the hint on first render.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "The select's required attribute.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The listbox options. Must be `<wa-option>` elements. You can use `<wa-divider>` to group items visually."
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The input's label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "start",
|
||
"description": "An element, such as `<wa-icon>`, placed at the start of the combobox."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "An element, such as `<wa-icon>`, placed at the end of the combobox."
|
||
},
|
||
{
|
||
"name": "clear-icon",
|
||
"description": "An icon to use in lieu of the default clear icon."
|
||
},
|
||
{
|
||
"name": "expand-icon",
|
||
"description": "The icon to show when the control is expanded and collapsed. Rotates on open and close."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the input. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the control's value changes."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "wa-clear",
|
||
"description": "Emitted when the control's value is cleared."
|
||
},
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the select's menu opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the select's menu opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the select's menu closes."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the select's menu closes and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "assumeInteractionOn", "type": "array" },
|
||
{ "name": "popup", "type": "WaPopup" },
|
||
{ "name": "combobox", "type": "HTMLSlotElement" },
|
||
{ "name": "displayInput", "type": "HTMLInputElement" },
|
||
{ "name": "valueInput", "type": "HTMLInputElement" },
|
||
{ "name": "listbox", "type": "HTMLSlotElement" },
|
||
{
|
||
"name": "validationTarget",
|
||
"description": "Where to anchor native constraint validation"
|
||
},
|
||
{ "name": "displayLabel", "type": "string" },
|
||
{ "name": "currentOption", "type": "WaOption" },
|
||
{ "name": "selectedOptions", "type": "WaOption[]" },
|
||
{
|
||
"name": "optionValues",
|
||
"type": "Set<string | null> | undefined"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the select, submitted as a name/value pair with form data.",
|
||
"type": "string"
|
||
},
|
||
{ "name": "defaultValue" },
|
||
{
|
||
"name": "value",
|
||
"description": "The select's value. This will be a string for single select or an array for multi-select."
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The select's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the select is empty.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "multiple",
|
||
"description": "Allows more than one option to be selected.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "maxOptionsVisible",
|
||
"description": "The maximum number of selected options to show when `multiple` is true. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the select control.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withClear",
|
||
"description": "Adds a clear button when the select is not empty.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the select is open. You can toggle this attribute to show and hide the menu, or you can\nuse the `show()` and `hide()` methods and this attribute will reflect the select's open state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The select's visual appearance.",
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style select with rounded edges.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The select's label. If you need to display HTML, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the select's menu. Note that the actual placement may vary as needed to keep the listbox\ninside of the viewport.",
|
||
"type": "'top' | 'bottom'"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The select's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withLabel",
|
||
"description": "Used for SSR purposes when a label is slotted in. Will show the label on first render.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withHint",
|
||
"description": "Used for SSR purposes when hint is slotted in. Will show the hint on first render.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "The select's required attribute.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "getTag",
|
||
"description": "A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second\nis the current tag's index. The function should return either a Lit TemplateResult or a string containing trusted\nHTML of the symbol to render at the specified value.",
|
||
"type": "(option: WaOption, index: number) => TemplateResult | string | HTMLElement"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the control's value changes."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "wa-clear",
|
||
"description": "Emitted when the control's value is cleared."
|
||
},
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the select's menu opens."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the select's menu opens and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the select's menu closes."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the select's menu closes and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-slider",
|
||
"description": "Ranges allow the user to select a single value within a given range using a slider.\n---\n\n\n### **Events:**\n - **change** - Emitted when an alteration to the control's value is committed by the user.\n- **blur** - Emitted when the control loses focus.\n- **focus** - Emitted when the control gains focus.\n- **input** - Emitted when the control receives input.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus()** - Sets focus to the slider.\n- **blur()** - Removes focus from the slider.\n- **stepDown()** - Decreases the slider's value by `step`. This is a programmatic change, so `input` and `change` events will not be\nemitted when this is called.\n- **stepUp()** - Increases the slider's value by `step`. This is a programmatic change, so `input` and `change` events will not be\nemitted when this is called.\n\n### **Slots:**\n - **label** - The slider label. Alternatively, you can use the `label` attribute.\n- **hint** - Text that describes how to use the input. Alternatively, you can use the `hint` attribute. instead.\n- **reference** - One or more reference labels to show visually below the slider.\n\n### **CSS Properties:**\n - **--track-size** - The height or width of the slider's track. _(default: 0.75em)_\n- **--marker-width** - The width of each individual marker. _(default: 0.1875em)_\n- **--marker-height** - The height of each individual marker. _(default: 0.1875em)_\n- **--thumb-width** - The width of the thumb. _(default: 1.25em)_\n- **--thumb-height** - The height of the thumb. _(default: 1.25em)_\n\n### **CSS Parts:**\n - **label** - The element that contains the sliders's label.\n- **hint** - The element that contains the slider's description.\n- **slider** - The focusable element with `role=\"slider\"`. Contains the track and reference slot.\n- **track** - The slider's track.\n- **indicator** - The colored indicator that shows from the start of the slider to the current value.\n- **markers** - The container that holds all the markers when `with-markers` is used.\n- **marker** - The individual markers that are shown when `with-markers` is used.\n- **references** - The container that holds references that get slotted in.\n- **thumb** - The slider's thumb.\n- **thumb-min** - The min value thumb in a range slider.\n- **thumb-max** - The max value thumb in a range slider.\n- **tooltip** - The tooltip, a `<wa-tooltip>` element.\n- **tooltip__tooltip** - The tooltip's `tooltip` part.\n- **tooltip__content** - The tooltip's `content` part.\n- **tooltip__arrow** - The tooltip's `arrow` part.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "label",
|
||
"description": "The slider's label. If you need to provide HTML in the label, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The slider hint. If you need to display HTML, use the hint slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the slider. This will be submitted with the form as a name/value pair.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "min-value",
|
||
"description": "The minimum value of a range selection. Used only when range attribute is set.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "max-value",
|
||
"description": "The maximum value of a range selection. Used only when range attribute is set.",
|
||
"value": { "type": "number", "default": "50" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "range",
|
||
"description": "Converts the slider to a range slider with two thumbs.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the slider.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the slider a read-only field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "The orientation of the slider.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'horizontal'"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The slider's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "indicator-offset",
|
||
"description": "The starting value from which to draw the slider's fill, which is based on its current value.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "min",
|
||
"description": "The minimum value allowed.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "max",
|
||
"description": "The maximum value allowed.",
|
||
"value": { "type": "number", "default": "100" }
|
||
},
|
||
{
|
||
"name": "step",
|
||
"description": "The granularity the value must adhere to when incrementing and decrementing.",
|
||
"value": { "type": "number", "default": "1" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the slider a required field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "autofocus",
|
||
"description": "Tells the browser to focus the slider when the page loads or a dialog is shown.",
|
||
"value": { "type": "boolean" }
|
||
},
|
||
{
|
||
"name": "tooltip-distance",
|
||
"description": "The distance of the tooltip from the slider's thumb.",
|
||
"value": { "type": "number", "default": "8" }
|
||
},
|
||
{
|
||
"name": "tooltip-placement",
|
||
"description": "The placement of the tooltip in reference to the slider's thumb.",
|
||
"value": {
|
||
"type": "'top' | 'right' | 'bottom' | 'left'",
|
||
"default": "'top'"
|
||
}
|
||
},
|
||
{
|
||
"name": "with-markers",
|
||
"description": "Draws markers at each step along the slider.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-tooltip",
|
||
"description": "Draws a tooltip above the thumb when the control has focus or is dragged.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "label",
|
||
"description": "The slider label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the input. Alternatively, you can use the `hint` attribute. instead."
|
||
},
|
||
{
|
||
"name": "reference",
|
||
"description": "One or more reference labels to show visually below the slider."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when an alteration to the control's value is committed by the user."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"type": "FocusEvent",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"type": "FocusEvent",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "validationTarget",
|
||
"description": "Override validation target to point to the focusable element"
|
||
},
|
||
{ "name": "slider", "type": "HTMLElement" },
|
||
{ "name": "thumb", "type": "HTMLElement" },
|
||
{ "name": "thumbMin", "type": "HTMLElement" },
|
||
{ "name": "thumbMax", "type": "HTMLElement" },
|
||
{ "name": "track", "type": "HTMLElement" },
|
||
{ "name": "tooltip", "type": "WaTooltip" },
|
||
{
|
||
"name": "label",
|
||
"description": "The slider's label. If you need to provide HTML in the label, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The slider hint. If you need to display HTML, use the hint slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the slider. This will be submitted with the form as a name/value pair.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "minValue",
|
||
"description": "The minimum value of a range selection. Used only when range attribute is set.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "maxValue",
|
||
"description": "The maximum value of a range selection. Used only when range attribute is set.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "defaultValue",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The current value of the slider, submitted as a name/value pair with form data.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "range",
|
||
"description": "Converts the slider to a range slider with two thumbs.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "isRange",
|
||
"description": "Get if this is a range slider",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the slider.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the slider a read-only field.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "The orientation of the slider.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The slider's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "indicatorOffset",
|
||
"description": "The starting value from which to draw the slider's fill, which is based on its current value.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "min",
|
||
"description": "The minimum value allowed.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "max",
|
||
"description": "The maximum value allowed.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "step",
|
||
"description": "The granularity the value must adhere to when incrementing and decrementing.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the slider a required field.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "autofocus",
|
||
"description": "Tells the browser to focus the slider when the page loads or a dialog is shown.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "tooltipDistance",
|
||
"description": "The distance of the tooltip from the slider's thumb.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "tooltipPlacement",
|
||
"description": "The placement of the tooltip in reference to the slider's thumb.",
|
||
"type": "'top' | 'right' | 'bottom' | 'left'"
|
||
},
|
||
{
|
||
"name": "withMarkers",
|
||
"description": "Draws markers at each step along the slider.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withTooltip",
|
||
"description": "Draws a tooltip above the thumb when the control has focus or is dragged.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "valueFormatter",
|
||
"description": "A custom formatting function to apply to the value. This will be shown in the tooltip and announced by screen\nreaders. Must be set with JavaScript. Property only.",
|
||
"type": "(value: number) => string"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when an alteration to the control's value is committed by the user."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"type": "FocusEvent",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"type": "FocusEvent",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-spinner",
|
||
"description": "Spinners are used to show the progress of an indeterminate operation.\n---\n\n\n### **CSS Properties:**\n - **--track-width** - The width of the track. _(default: undefined)_\n- **--track-color** - The color of the track. _(default: undefined)_\n- **--indicator-color** - The color of the spinner's indicator. _(default: undefined)_\n- **--speed** - The time it takes for the spinner to complete one animation cycle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [],
|
||
"events": [],
|
||
"js": { "properties": [], "events": [] }
|
||
},
|
||
{
|
||
"name": "wa-split-panel",
|
||
"description": "Split panels display two adjacent panels, allowing the user to reposition them.\n---\n\n\n### **Events:**\n - **wa-reposition** - Emitted when the divider's position changes.\n\n### **Slots:**\n - **start** - Content to place in the start panel.\n- **end** - Content to place in the end panel.\n- **divider** - The divider. Useful for slotting in a custom icon that renders as a handle.\n\n### **CSS Properties:**\n - **--divider-width** - The width of the visible divider. _(default: 4px)_\n- **--divider-hit-area** - The invisible region around the divider where dragging can occur. This is usually wider than the divider to facilitate easier dragging. _(default: 12px)_\n- **--min** - The minimum allowed size of the primary panel. _(default: 0)_\n- **--max** - The maximum allowed size of the primary panel. _(default: 100%)_\n\n### **CSS Parts:**\n - **start** - The start panel.\n- **end** - The end panel.\n- **panel** - Targets both the start and end panels.\n- **divider** - The divider that separates the start and end panels.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "position",
|
||
"description": "The current position of the divider from the primary panel's edge as a percentage 0-100. Defaults to 50% of the\ncontainer's initial size.",
|
||
"value": { "type": "number", "default": "50" }
|
||
},
|
||
{
|
||
"name": "position-in-pixels",
|
||
"description": "The current position of the divider from the primary panel's edge in pixels.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "Sets the split panel's orientation.",
|
||
"value": {
|
||
"type": "'horizontal' | 'vertical'",
|
||
"default": "'horizontal'"
|
||
}
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables resizing. Note that the position may still change as a result of resizing the host element.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "primary",
|
||
"description": "If no primary panel is designated, both panels will resize proportionally when the host element is resized. If a\nprimary panel is designated, it will maintain its size and the other panel will grow or shrink as needed when the\nhost element is resized.",
|
||
"value": { "type": "'start' | 'end' | undefined" }
|
||
},
|
||
{
|
||
"name": "snap",
|
||
"description": "One or more space-separated values at which the divider should snap. Values can be in pixels or percentages, e.g.\n`\"100px 50%\"`.",
|
||
"value": { "type": "string | undefined" }
|
||
},
|
||
{
|
||
"name": "snap-threshold",
|
||
"description": "How close the divider must be to a snap point until snapping occurs.",
|
||
"value": { "type": "number", "default": "12" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "start",
|
||
"description": "Content to place in the start panel."
|
||
},
|
||
{
|
||
"name": "end",
|
||
"description": "Content to place in the end panel."
|
||
},
|
||
{
|
||
"name": "divider",
|
||
"description": "The divider. Useful for slotting in a custom icon that renders as a handle."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-reposition",
|
||
"description": "Emitted when the divider's position changes."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "divider", "type": "HTMLElement" },
|
||
{
|
||
"name": "position",
|
||
"description": "The current position of the divider from the primary panel's edge as a percentage 0-100. Defaults to 50% of the\ncontainer's initial size.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "positionInPixels",
|
||
"description": "The current position of the divider from the primary panel's edge in pixels.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "orientation",
|
||
"description": "Sets the split panel's orientation.",
|
||
"type": "'horizontal' | 'vertical'"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables resizing. Note that the position may still change as a result of resizing the host element.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "primary",
|
||
"description": "If no primary panel is designated, both panels will resize proportionally when the host element is resized. If a\nprimary panel is designated, it will maintain its size and the other panel will grow or shrink as needed when the\nhost element is resized.",
|
||
"type": "'start' | 'end' | undefined"
|
||
},
|
||
{
|
||
"name": "snap",
|
||
"description": "One or more space-separated values at which the divider should snap. Values can be in pixels or percentages, e.g.\n`\"100px 50%\"`.",
|
||
"type": "string | undefined"
|
||
},
|
||
{
|
||
"name": "snapThreshold",
|
||
"description": "How close the divider must be to a snap point until snapping occurs.",
|
||
"type": "number"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-reposition",
|
||
"description": "Emitted when the divider's position changes."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-switch",
|
||
"description": "Switches allow the user to toggle an option on or off.\n---\n\n\n### **Events:**\n - **change** - Emitted when the control's checked state changes.\n- **input** - Emitted when the control receives input.\n- **blur** - Emitted when the control loses focus.\n- **focus** - Emitted when the control gains focus.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the switch.\n- **focus(options: _FocusOptions_)** - Sets focus on the switch.\n- **blur()** - Removes focus from the switch.\n\n### **Slots:**\n - _default_ - The switch's label.\n- **hint** - Text that describes how to use the switch. Alternatively, you can use the `hint` attribute.\n\n### **CSS Properties:**\n - **--width** - The width of the switch. _(default: undefined)_\n- **--height** - The height of the switch. _(default: undefined)_\n- **--thumb-size** - The size of the thumb. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The control that houses the switch's thumb.\n- **thumb** - The switch's thumb.\n- **label** - The switch's label.\n- **hint** - The hint's wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the switch, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The value of the switch, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string | null" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The switch's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the switch.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "checked",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "boolean" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the switch a required field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The switch's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"description": "Used for SSR. If you slot in hint, make sure to add `with-hint` to your component to get it to properly render with SSR.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The switch's label." },
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the switch. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the control's checked state changes."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "input", "type": "HTMLInputElement" },
|
||
{ "name": "title", "type": "string" },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the switch, submitted as a name/value pair with form data.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The value of the switch, submitted as a name/value pair with form data.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The switch's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the switch.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "checked",
|
||
"description": "Draws the switch in a checked state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "defaultChecked",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the switch a required field.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The switch's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withHint",
|
||
"description": "Used for SSR. If you slot in hint, make sure to add `with-hint` to your component to get it to properly render with SSR.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "change",
|
||
"type": "Event",
|
||
"description": "Emitted when the control's checked state changes."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"type": "InputEvent",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tab",
|
||
"description": "Tabs are used inside [tab groups](/docs/components/tab-group) to represent and activate [tab panels](/docs/components/tab-panel).\n---\n\n\n### **Slots:**\n - _default_ - The tab's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "panel",
|
||
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the tab and prevents selection.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [{ "name": "", "description": "The tab's label." }],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "tab", "type": "HTMLElement" },
|
||
{
|
||
"name": "panel",
|
||
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the tab and prevents selection.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tab-group",
|
||
"description": "Tab groups organize content into a container that shows one section at a time.\n---\n\n\n### **Events:**\n - **wa-tab-show** - Emitted when a tab is shown.\n- **wa-tab-hide** - Emitted when a tab is hidden.\n\n### **Slots:**\n - _default_ - Used for grouping tab panels in the tab group. Must be `<wa-tab-panel>` elements.\n- **nav** - Used for grouping tabs in the tab group. Must be `<wa-tab>` elements. Note that `<wa-tab>` will set this slot on itself automatically.\n\n### **CSS Properties:**\n - **--indicator-color** - The color of the active tab indicator. _(default: undefined)_\n- **--track-color** - The color of the indicator's track (the line that separates tabs from panels). _(default: undefined)_\n- **--track-width** - The width of the indicator's track (the line that separates tabs from panels). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **nav** - The tab group's navigation container where tabs are slotted in.\n- **tabs** - The container that wraps the tabs.\n- **body** - The tab group's body where tab panels are slotted in.\n- **scroll-button** - The previous/next scroll buttons that show when tabs are scrollable, a `<wa-button>`.\n- **scroll-button-start** - The starting scroll button.\n- **scroll-button-end** - The ending scroll button.\n- **scroll-button__base** - The scroll button's exported `base` part.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "active",
|
||
"description": "Sets the active tab.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The placement of the tabs.",
|
||
"value": {
|
||
"type": "'top' | 'bottom' | 'start' | 'end'",
|
||
"default": "'top'"
|
||
}
|
||
},
|
||
{
|
||
"name": "activation",
|
||
"description": "When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel. When set to\nmanual, the tab will receive focus but will not show until the user presses spacebar or enter.",
|
||
"value": { "type": "'auto' | 'manual'", "default": "'auto'" }
|
||
},
|
||
{
|
||
"name": "without-scroll-controls",
|
||
"description": "Disables the scroll arrows that appear when tabs overflow.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "Used for grouping tab panels in the tab group. Must be `<wa-tab-panel>` elements."
|
||
},
|
||
{
|
||
"name": "nav",
|
||
"description": "Used for grouping tabs in the tab group. Must be `<wa-tab>` elements. Note that `<wa-tab>` will set this slot on itself automatically."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-tab-show",
|
||
"type": "{ name: String }",
|
||
"description": "Emitted when a tab is shown."
|
||
},
|
||
{
|
||
"name": "wa-tab-hide",
|
||
"type": "{ name: String }",
|
||
"description": "Emitted when a tab is hidden."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "tabGroup", "type": "HTMLElement" },
|
||
{ "name": "body", "type": "HTMLSlotElement" },
|
||
{ "name": "nav", "type": "HTMLElement" },
|
||
{
|
||
"name": "active",
|
||
"description": "Sets the active tab.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "placement",
|
||
"description": "The placement of the tabs.",
|
||
"type": "'top' | 'bottom' | 'start' | 'end'"
|
||
},
|
||
{
|
||
"name": "activation",
|
||
"description": "When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel. When set to\nmanual, the tab will receive focus but will not show until the user presses spacebar or enter.",
|
||
"type": "'auto' | 'manual'"
|
||
},
|
||
{
|
||
"name": "withoutScrollControls",
|
||
"description": "Disables the scroll arrows that appear when tabs overflow.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-tab-show",
|
||
"type": "{ name: String }",
|
||
"description": "Emitted when a tab is shown."
|
||
},
|
||
{
|
||
"name": "wa-tab-hide",
|
||
"type": "{ name: String }",
|
||
"description": "Emitted when a tab is hidden."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tab-panel",
|
||
"description": "Tab panels are used inside [tab groups](/docs/components/tab-group) to display tabbed content.\n---\n\n\n### **Slots:**\n - _default_ - The tab panel's content.\n\n### **CSS Properties:**\n - **--padding** - The tab panel's padding. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "name",
|
||
"description": "The tab panel's name.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "active",
|
||
"description": "When true, the tab panel will be shown.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [{ "name": "", "description": "The tab panel's content." }],
|
||
"events": [],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "name",
|
||
"description": "The tab panel's name.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "active",
|
||
"description": "When true, the tab panel will be shown.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": []
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tag",
|
||
"description": "Tags are used as labels to organize things or to indicate a selection.\n---\n\n\n### **Events:**\n - **wa-remove** - Emitted when the remove button is activated.\n\n### **Slots:**\n - _default_ - The tag's content.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **content** - The tag's content.\n- **remove-button** - The tag's remove button, a `<wa-button>`.\n- **remove-button__base** - The remove button's exported `base` part.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The tag's theme variant. Defaults to `neutral` if not within another element with a variant.",
|
||
"value": {
|
||
"type": "'brand' | 'neutral' | 'success' | 'warning' | 'danger'",
|
||
"default": "'neutral'"
|
||
}
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The tag's visual appearance.",
|
||
"value": {
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined'",
|
||
"default": "'filled-outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The tag's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style tag with rounded edges.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-remove",
|
||
"description": "Makes the tag removable and shows a remove button.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [{ "name": "", "description": "The tag's content." }],
|
||
"events": [
|
||
{
|
||
"name": "wa-remove",
|
||
"description": "Emitted when the remove button is activated."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{
|
||
"name": "variant",
|
||
"description": "The tag's theme variant. Defaults to `neutral` if not within another element with a variant.",
|
||
"type": "'brand' | 'neutral' | 'success' | 'warning' | 'danger'"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The tag's visual appearance.",
|
||
"type": "'accent' | 'filled' | 'outlined' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The tag's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "pill",
|
||
"description": "Draws a pill-style tag with rounded edges.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withRemove",
|
||
"description": "Makes the tag removable and shows a remove button.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-remove",
|
||
"description": "Emitted when the remove button is activated."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-textarea",
|
||
"description": "Textareas collect data from the user and allow multiple lines of text.\n---\n\n\n### **Events:**\n - **blur** - Emitted when the control loses focus.\n- **change** - Emitted when an alteration to the control's value is committed by the user.\n- **focus** - Emitted when the control gains focus.\n- **input** - Emitted when the control receives input.\n- **wa-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the textarea.\n- **blur()** - Removes focus from the textarea.\n- **select()** - Selects all the text in the textarea.\n- **scrollPosition(position: _{ top?: number; left?: number }_): _{ top: number; left: number } | undefined_** - Gets or sets the textarea's scroll position.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n\n### **Slots:**\n - **label** - The textarea's label. Alternatively, you can use the `label` attribute.\n- **hint** - Text that describes how to use the input. Alternatively, you can use the `hint` attribute.\n\n### **CSS Parts:**\n - **label** - The label\n- **form-control-input** - The input's wrapper.\n- **hint** - The hint's wrapper.\n- **textarea** - The internal `<textarea>` control.\n- **base** - The wrapper around the `<textarea>` control.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{ "name": "title", "value": { "type": "string", "default": "''" } },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the textarea, submitted as a name/value pair with form data.",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The textarea's size.",
|
||
"value": {
|
||
"type": "'small' | 'medium' | 'large'",
|
||
"default": "'medium'"
|
||
}
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The textarea's visual appearance.",
|
||
"value": {
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'",
|
||
"default": "'outlined'"
|
||
}
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The textarea's label. If you need to display HTML, use the `label` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The textarea's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the input is empty.",
|
||
"value": { "type": "string", "default": "''" }
|
||
},
|
||
{
|
||
"name": "rows",
|
||
"description": "The number of rows to display by default.",
|
||
"value": { "type": "number", "default": "4" }
|
||
},
|
||
{
|
||
"name": "resize",
|
||
"description": "Controls how the textarea can be resized.",
|
||
"value": {
|
||
"type": "'none' | 'vertical' | 'horizontal' | 'both' | 'auto'",
|
||
"default": "'vertical'"
|
||
}
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the textarea.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the textarea readonly.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the textarea a required field.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "minlength",
|
||
"description": "The minimum length of input that will be considered valid.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "maxlength",
|
||
"description": "The maximum length of input that will be considered valid.",
|
||
"value": { "type": "number" }
|
||
},
|
||
{
|
||
"name": "autocapitalize",
|
||
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
||
"value": {
|
||
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
||
}
|
||
},
|
||
{
|
||
"name": "autocorrect",
|
||
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "autocomplete",
|
||
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "autofocus",
|
||
"description": "Indicates that the input should receive focus on page load.",
|
||
"value": { "type": "boolean" }
|
||
},
|
||
{
|
||
"name": "enterkeyhint",
|
||
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
||
"value": {
|
||
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
||
}
|
||
},
|
||
{
|
||
"name": "spellcheck",
|
||
"description": "Enables spell checking on the textarea.",
|
||
"value": { "type": "boolean", "default": "true" }
|
||
},
|
||
{
|
||
"name": "inputmode",
|
||
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
||
"value": {
|
||
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
||
}
|
||
},
|
||
{
|
||
"name": "with-label",
|
||
"description": "Used for SSR. If you're slotting in a `label` element, make sure to set this to `true`.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "with-hint",
|
||
"description": "Used for SSR. If you're slotting in a `hint` element, make sure to set this to `true`.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "label",
|
||
"description": "The textarea's label. Alternatively, you can use the `label` attribute."
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "Text that describes how to use the input. Alternatively, you can use the `hint` attribute."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"description": "Emitted when an alteration to the control's value is committed by the user."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "assumeInteractionOn", "type": "array" },
|
||
{ "name": "input", "type": "HTMLTextAreaElement" },
|
||
{ "name": "base", "type": "HTMLDivElement" },
|
||
{ "name": "sizeAdjuster", "type": "HTMLTextAreaElement" },
|
||
{ "name": "title", "type": "string" },
|
||
{
|
||
"name": "name",
|
||
"description": "The name of the textarea, submitted as a name/value pair with form data.",
|
||
"type": "string | null"
|
||
},
|
||
{
|
||
"name": "value",
|
||
"description": "The current value of the input, submitted as a name/value pair with form data."
|
||
},
|
||
{
|
||
"name": "defaultValue",
|
||
"description": "The default value of the form control. Primarily used for resetting the form control.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "size",
|
||
"description": "The textarea's size.",
|
||
"type": "'small' | 'medium' | 'large'"
|
||
},
|
||
{
|
||
"name": "appearance",
|
||
"description": "The textarea's visual appearance.",
|
||
"type": "'filled' | 'outlined' | 'filled-outlined'"
|
||
},
|
||
{
|
||
"name": "label",
|
||
"description": "The textarea's label. If you need to display HTML, use the `label` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "hint",
|
||
"description": "The textarea's hint. If you need to display HTML, use the `hint` slot instead.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "placeholder",
|
||
"description": "Placeholder text to show as a hint when the input is empty.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "rows",
|
||
"description": "The number of rows to display by default.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "resize",
|
||
"description": "Controls how the textarea can be resized.",
|
||
"type": "'none' | 'vertical' | 'horizontal' | 'both' | 'auto'"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the textarea.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "readonly",
|
||
"description": "Makes the textarea readonly.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "required",
|
||
"description": "Makes the textarea a required field.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "minlength",
|
||
"description": "The minimum length of input that will be considered valid.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "maxlength",
|
||
"description": "The maximum length of input that will be considered valid.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "autocapitalize",
|
||
"description": "Controls whether and how text input is automatically capitalized as it is entered by the user.",
|
||
"type": "'off' | 'none' | 'on' | 'sentences' | 'words' | 'characters'"
|
||
},
|
||
{
|
||
"name": "autocorrect",
|
||
"description": "Indicates whether the browser's autocorrect feature is on or off.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "autocomplete",
|
||
"description": "Specifies what permission the browser has to provide assistance in filling out form field values. Refer to\n[this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for available values.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "autofocus",
|
||
"description": "Indicates that the input should receive focus on page load.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "enterkeyhint",
|
||
"description": "Used to customize the label or icon of the Enter key on virtual keyboards.",
|
||
"type": "'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send'"
|
||
},
|
||
{
|
||
"name": "spellcheck",
|
||
"description": "Enables spell checking on the textarea.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "inputmode",
|
||
"description": "Tells the browser what type of data will be entered by the user, allowing it to display the appropriate virtual\nkeyboard on supportive devices.",
|
||
"type": "'none' | 'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'"
|
||
},
|
||
{
|
||
"name": "withLabel",
|
||
"description": "Used for SSR. If you're slotting in a `label` element, make sure to set this to `true`.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withHint",
|
||
"description": "Used for SSR. If you're slotting in a `hint` element, make sure to set this to `true`.",
|
||
"type": "boolean"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "blur",
|
||
"description": "Emitted when the control loses focus."
|
||
},
|
||
{
|
||
"name": "change",
|
||
"description": "Emitted when an alteration to the control's value is committed by the user."
|
||
},
|
||
{
|
||
"name": "focus",
|
||
"description": "Emitted when the control gains focus."
|
||
},
|
||
{
|
||
"name": "input",
|
||
"description": "Emitted when the control receives input."
|
||
},
|
||
{
|
||
"name": "wa-invalid",
|
||
"description": "Emitted when the form control has been checked for validity and its constraints aren't satisfied."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tooltip",
|
||
"description": "Tooltips display additional information based on a specific action.\n---\n\n\n### **Events:**\n - **wa-show** - Emitted when the tooltip begins to show.\n- **wa-after-show** - Emitted after the tooltip has shown and all animations are complete.\n- **wa-hide** - Emitted when the tooltip begins to hide.\n- **wa-after-hide** - Emitted after the tooltip has hidden and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the tooltip.\n- **hide()** - Hides the tooltip\n\n### **Slots:**\n - _default_ - The tooltip's default slot where any content should live. Interactive content should be avoided.\n\n### **CSS Properties:**\n - **--max-width** - The maximum width of the tooltip before its content will wrap. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper, an `<wa-popup>` element.\n- **base__popup** - The popup's exported `popup` part. Use this to target the tooltip's popup container.\n- **base__arrow** - The popup's exported `arrow` part. Use this to target the tooltip's arrow.\n- **body** - The tooltip's body where its content is rendered.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
||
"value": {
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'",
|
||
"default": "'top'"
|
||
}
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the tooltip so it won't show when triggered.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance in pixels from which to offset the tooltip away from its target.",
|
||
"value": { "type": "number", "default": "8" }
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The distance in pixels from which to offset the tooltip along its target.",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "show-delay",
|
||
"description": "The amount of time to wait before showing the tooltip when the user mouses in.",
|
||
"value": { "type": "number", "default": "150" }
|
||
},
|
||
{
|
||
"name": "hide-delay",
|
||
"description": "The amount of time to wait before hiding the tooltip when the user mouses out..",
|
||
"value": { "type": "number", "default": "0" }
|
||
},
|
||
{
|
||
"name": "trigger",
|
||
"description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.",
|
||
"value": { "type": "string", "default": "'hover focus'" }
|
||
},
|
||
{
|
||
"name": "without-arrow",
|
||
"description": "Removes the arrow from the tooltip.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "for",
|
||
"value": { "type": "string | null", "default": "null" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "",
|
||
"description": "The tooltip's default slot where any content should live. Interactive content should be avoided."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the tooltip begins to show."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the tooltip has shown and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the tooltip begins to hide."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the tooltip has hidden and all animations are complete."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "body", "type": "HTMLElement" },
|
||
{ "name": "popup", "type": "WaPopup" },
|
||
{
|
||
"name": "placement",
|
||
"description": "The preferred placement of the tooltip. Note that the actual placement may vary as needed to keep the tooltip\ninside of the viewport.",
|
||
"type": "| 'top'\n | 'top-start'\n | 'top-end'\n | 'right'\n | 'right-start'\n | 'right-end'\n | 'bottom'\n | 'bottom-start'\n | 'bottom-end'\n | 'left'\n | 'left-start'\n | 'left-end'"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the tooltip so it won't show when triggered.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "distance",
|
||
"description": "The distance in pixels from which to offset the tooltip away from its target.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "open",
|
||
"description": "Indicates whether or not the tooltip is open. You can use this in lieu of the show/hide methods.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "skidding",
|
||
"description": "The distance in pixels from which to offset the tooltip along its target.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "showDelay",
|
||
"description": "The amount of time to wait before showing the tooltip when the user mouses in.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "hideDelay",
|
||
"description": "The amount of time to wait before hiding the tooltip when the user mouses out..",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "trigger",
|
||
"description": "Controls how the tooltip is activated. Possible options include `click`, `hover`, `focus`, and `manual`. Multiple\noptions can be passed by separating them with a space. When manual is used, the tooltip must be activated\nprogrammatically.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withoutArrow",
|
||
"description": "Removes the arrow from the tooltip.",
|
||
"type": "boolean"
|
||
},
|
||
{ "name": "for", "type": "string | null" },
|
||
{ "name": "anchor", "type": "null | Element" }
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-show",
|
||
"description": "Emitted when the tooltip begins to show."
|
||
},
|
||
{
|
||
"name": "wa-after-show",
|
||
"description": "Emitted after the tooltip has shown and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-hide",
|
||
"description": "Emitted when the tooltip begins to hide."
|
||
},
|
||
{
|
||
"name": "wa-after-hide",
|
||
"description": "Emitted after the tooltip has hidden and all animations are complete."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tree",
|
||
"description": "Trees allow you to display a hierarchical list of selectable [tree items](/docs/components/tree-item). Items with children can be expanded and collapsed as desired by the user.\n---\n\n\n### **Events:**\n - **wa-selection-change** - Emitted when a tree item is selected or deselected.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded. Works best with `<wa-icon>`.\n- **collapse-icon** - The icon to show when the tree item is collapsed. Works best with `<wa-icon>`.\n\n### **CSS Properties:**\n - **--indent-size** - The size of the indentation for nested items. _(default: var(--wa-space-m))_\n- **--indent-guide-color** - The color of the indentation line. _(default: var(--wa-color-surface-border))_\n- **--indent-guide-offset** - The amount of vertical spacing to leave between the top and bottom of the indentation line's starting position. _(default: 0)_\n- **--indent-guide-style** - The style of the indentation line, e.g. solid, dotted, dashed. _(default: solid)_\n- **--indent-guide-width** - The width of the indentation line. _(default: 0)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "selection",
|
||
"description": "The selection behavior of the tree. Single selection allows only one node to be selected at a time. Multiple\ndisplays checkboxes and allows more than one node to be selected. Leaf allows only leaf nodes to be selected.",
|
||
"value": {
|
||
"type": "'single' | 'multiple' | 'leaf'",
|
||
"default": "'single'"
|
||
}
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The default slot." },
|
||
{
|
||
"name": "expand-icon",
|
||
"description": "The icon to show when the tree item is expanded. Works best with `<wa-icon>`."
|
||
},
|
||
{
|
||
"name": "collapse-icon",
|
||
"description": "The icon to show when the tree item is collapsed. Works best with `<wa-icon>`."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-selection-change",
|
||
"type": "{ selection: WaTreeItem[] }",
|
||
"description": "Emitted when a tree item is selected or deselected."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "expandedIconSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "collapsedIconSlot", "type": "HTMLSlotElement" },
|
||
{
|
||
"name": "selection",
|
||
"description": "The selection behavior of the tree. Single selection allows only one node to be selected at a time. Multiple\ndisplays checkboxes and allows more than one node to be selected. Leaf allows only leaf nodes to be selected.",
|
||
"type": "'single' | 'multiple' | 'leaf'"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-selection-change",
|
||
"type": "{ selection: WaTreeItem[] }",
|
||
"description": "Emitted when a tree item is selected or deselected."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-tree-item",
|
||
"description": "A tree item serves as a hierarchical node that lives inside a [tree](/docs/components/tree).\n---\n\n\n### **Events:**\n - **wa-expand** - Emitted when the tree item expands.\n- **wa-after-expand** - Emitted after the tree item expands and all animations are complete.\n- **wa-collapse** - Emitted when the tree item collapses.\n- **wa-after-collapse** - Emitted after the tree item collapses and all animations are complete.\n- **wa-lazy-change** - Emitted when the tree item's lazy state changes.\n- **wa-lazy-load** - Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree.\n\n### **Methods:**\n - **getChildrenItems({ includeDisabled = true }: _{ includeDisabled?: boolean }_): _WaTreeItem[]_** - Gets all the nested tree items in this node.\n\n### **Slots:**\n - _default_ - The default slot.\n- **expand-icon** - The icon to show when the tree item is expanded.\n- **collapse-icon** - The icon to show when the tree item is collapsed.\n\n### **CSS Properties:**\n - **--show-duration** - The animation duration when expanding tree items. _(default: 200ms)_\n- **--hide-duration** - The animation duration when collapsing tree items. _(default: 200ms)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **item** - The tree item's container. This element wraps everything except slotted tree item children.\n- **indentation** - The tree item's indentation container.\n- **expand-button** - The container that wraps the tree item's expand button and spinner.\n- **spinner** - The spinner that shows when a lazy tree item is in the loading state.\n- **spinner__base** - The spinner's base part.\n- **label** - The tree item's label.\n- **children** - The container that wraps the tree item's nested children.\n- **checkbox** - The checkbox that shows when using multiselect.\n- **checkbox__base** - The checkbox's exported `base` part.\n- **checkbox__control** - The checkbox's exported `control` part.\n- **checkbox__checked-icon** - The checkbox's exported `checked-icon` part.\n- **checkbox__indeterminate-icon** - The checkbox's exported `indeterminate-icon` part.\n- **checkbox__label** - The checkbox's exported `label` part.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "expanded",
|
||
"description": "Expands the tree item.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "selected",
|
||
"description": "Draws the tree item in a selected state.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the tree item.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "lazy",
|
||
"description": "Enables lazy loading behavior.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{ "name": "", "description": "The default slot." },
|
||
{
|
||
"name": "expand-icon",
|
||
"description": "The icon to show when the tree item is expanded."
|
||
},
|
||
{
|
||
"name": "collapse-icon",
|
||
"description": "The icon to show when the tree item is collapsed."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-expand",
|
||
"description": "Emitted when the tree item expands."
|
||
},
|
||
{
|
||
"name": "wa-after-expand",
|
||
"description": "Emitted after the tree item expands and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-collapse",
|
||
"description": "Emitted when the tree item collapses."
|
||
},
|
||
{
|
||
"name": "wa-after-collapse",
|
||
"description": "Emitted after the tree item collapses and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-lazy-change",
|
||
"description": "Emitted when the tree item's lazy state changes."
|
||
},
|
||
{
|
||
"name": "wa-lazy-load",
|
||
"description": "Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "indeterminate", "type": "boolean" },
|
||
{ "name": "isLeaf", "type": "boolean" },
|
||
{ "name": "loading", "type": "boolean" },
|
||
{ "name": "selectable", "type": "boolean" },
|
||
{
|
||
"name": "expanded",
|
||
"description": "Expands the tree item.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "selected",
|
||
"description": "Draws the tree item in a selected state.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "disabled",
|
||
"description": "Disables the tree item.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "lazy",
|
||
"description": "Enables lazy loading behavior.",
|
||
"type": "boolean"
|
||
},
|
||
{ "name": "defaultSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "childrenSlot", "type": "HTMLSlotElement" },
|
||
{ "name": "itemElement", "type": "HTMLDivElement" },
|
||
{ "name": "childrenContainer", "type": "HTMLDivElement" },
|
||
{ "name": "expandButtonSlot", "type": "HTMLSlotElement" }
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "wa-expand",
|
||
"description": "Emitted when the tree item expands."
|
||
},
|
||
{
|
||
"name": "wa-after-expand",
|
||
"description": "Emitted after the tree item expands and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-collapse",
|
||
"description": "Emitted when the tree item collapses."
|
||
},
|
||
{
|
||
"name": "wa-after-collapse",
|
||
"description": "Emitted after the tree item collapses and all animations are complete."
|
||
},
|
||
{
|
||
"name": "wa-lazy-change",
|
||
"description": "Emitted when the tree item's lazy state changes."
|
||
},
|
||
{
|
||
"name": "wa-lazy-load",
|
||
"description": "Emitted when a lazy item is selected. Use this event to asynchronously load data and append items to the tree before expanding. After appending new items, remove the `lazy` attribute to remove the loading state and update the tree."
|
||
}
|
||
]
|
||
}
|
||
},
|
||
{
|
||
"name": "wa-zoomable-frame",
|
||
"description": "Zoomable frames render iframe content with zoom and interaction controls.\n---\n\n\n### **Events:**\n - **load** - Emitted when the internal iframe when it finishes loading.\n- **error** - Emitted from the internal iframe when it fails to load.\n\n### **Methods:**\n - **zoomIn()** - Zooms in to the next available zoom level.\n- **zoomOut()** - Zooms out to the previous available zoom level.\n\n### **Slots:**\n - **zoom-in-icon** - The slot that contains the zoom in icon.\n- **zoom-out-icon** - The slot that contains the zoom out icon.\n\n### **CSS Parts:**\n - **iframe** - The internal `<iframe>` element.\n- **controls** - The container that surrounds zoom control buttons.\n- **zoom-in-button** - The zoom in button.\n- **zoom-out-button** - The zoom out button.",
|
||
"doc-url": "",
|
||
"attributes": [
|
||
{
|
||
"name": "src",
|
||
"description": "The URL of the content to display.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "srcdoc",
|
||
"description": "Inline HTML to display.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "allowfullscreen",
|
||
"description": "Allows fullscreen mode.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "loading",
|
||
"description": "Controls iframe loading behavior.",
|
||
"value": { "type": "'eager' | 'lazy'", "default": "'eager'" }
|
||
},
|
||
{
|
||
"name": "referrerpolicy",
|
||
"description": "Controls referrer information.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "sandbox",
|
||
"description": "Security restrictions for the iframe.",
|
||
"value": { "type": "string" }
|
||
},
|
||
{
|
||
"name": "zoom",
|
||
"description": "The current zoom of the frame, e.g. 0 = 0% and 1 = 100%.",
|
||
"value": { "type": "number", "default": "1" }
|
||
},
|
||
{
|
||
"name": "zoom-levels",
|
||
"description": "The zoom levels to step through when using zoom controls. This does not restrict programmatic changes to the zoom.",
|
||
"value": {
|
||
"type": "string",
|
||
"default": "'25% 50% 75% 100% 125% 150% 175% 200%'"
|
||
}
|
||
},
|
||
{
|
||
"name": "without-controls",
|
||
"description": "Removes the zoom controls.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
},
|
||
{
|
||
"name": "without-interaction",
|
||
"description": "Disables interaction when present.",
|
||
"value": { "type": "boolean", "default": "false" }
|
||
}
|
||
],
|
||
"slots": [
|
||
{
|
||
"name": "zoom-in-icon",
|
||
"description": "The slot that contains the zoom in icon."
|
||
},
|
||
{
|
||
"name": "zoom-out-icon",
|
||
"description": "The slot that contains the zoom out icon."
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "load",
|
||
"type": "Event",
|
||
"description": "Emitted when the internal iframe when it finishes loading."
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "Event",
|
||
"description": "Emitted from the internal iframe when it fails to load."
|
||
}
|
||
],
|
||
"js": {
|
||
"properties": [
|
||
{ "name": "iframe", "type": "HTMLIFrameElement" },
|
||
{
|
||
"name": "src",
|
||
"description": "The URL of the content to display.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "srcdoc",
|
||
"description": "Inline HTML to display.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "allowfullscreen",
|
||
"description": "Allows fullscreen mode.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "loading",
|
||
"description": "Controls iframe loading behavior.",
|
||
"type": "'eager' | 'lazy'"
|
||
},
|
||
{
|
||
"name": "referrerpolicy",
|
||
"description": "Controls referrer information.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "sandbox",
|
||
"description": "Security restrictions for the iframe.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "zoom",
|
||
"description": "The current zoom of the frame, e.g. 0 = 0% and 1 = 100%.",
|
||
"type": "number"
|
||
},
|
||
{
|
||
"name": "zoomLevels",
|
||
"description": "The zoom levels to step through when using zoom controls. This does not restrict programmatic changes to the zoom.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"name": "withoutControls",
|
||
"description": "Removes the zoom controls.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "withoutInteraction",
|
||
"description": "Disables interaction when present.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"name": "contentWindow",
|
||
"description": "Returns the internal iframe's `window` object. (Readonly property)",
|
||
"type": "Window | null"
|
||
},
|
||
{
|
||
"name": "contentDocument",
|
||
"description": "Returns the internal iframe's `document` object. (Readonly property)",
|
||
"type": "Document | null"
|
||
}
|
||
],
|
||
"events": [
|
||
{
|
||
"name": "load",
|
||
"type": "Event",
|
||
"description": "Emitted when the internal iframe when it finishes loading."
|
||
},
|
||
{
|
||
"name": "error",
|
||
"type": "Event",
|
||
"description": "Emitted from the internal iframe when it fails to load."
|
||
}
|
||
]
|
||
}
|
||
}
|
||
]
|
||
}
|
||
}
|
||
}
|