` text.\n\nReads the `lang` attribute from `<html>`, falls back to 'en'.", "value": { "type": "string" } } ], "events": [], "js": { "properties": [ { "name": "name", "description": "Icon filename (without .svg)", "type": "string" }, { "name": "size", "description": "Size: small, medium, large or pixel value (e.g. \"32px\").", "type": "\"small\" | \"medium\" | \"large\" | PixelValue | undefined" }, { "name": "locale", "description": "Locale used for `<title>` text.\n\nReads the `lang` attribute from `<html>`, falls back to 'en'.", "type": "string" } ], "events": [] } }, { "name": "w-tooltip", "description": "A tooltip is a message box that is displayed when a user hovers over or gives focus to a UI element.\n\nTooltips should be used sparingly and contain succinct, supplementary information.\n---\n", "doc-url": "", "attributes": [ { "name": "for", "description": "ID of the element that triggers the tooltip on hover or focus.", "value": { "type": "string", "default": "\"\"" } }, { "name": "no-arrow", "description": "Hide the arrow pointing toward the tooltip target.", "value": { "type": "boolean", "default": "false" } }, { "name": "open", "description": "Indicates whether the tooltip is visible or not.", "value": { "type": "boolean", "default": "false" } }, { "name": "placement", "description": "Sets the placement of the tooltip relative to its target.\n\nThe tooltip will try to position itself at the given placement. If there is no room it will flip to the opposite side automatically.", "value": { "type": "'top' | 'bottom' | 'left' | 'right'", "default": "\"top\"" } }, { "name": "show-delay", "description": "Milliseconds to wait before showing the tooltip on hover.\n\nKeep at a non-zero value to avoid flickering the tooltip on and off when cursors move quickly past the target element.\n\nFocusing the target element shows the tooltip immediately.", "value": { "type": "number", "default": "150" } }, { "name": "hide-delay", "description": "Milliseconds to wait before hiding the tooltip on mouseout.", "value": { "type": "number", "default": "0" } } ], "events": [], "js": { "properties": [ { "name": "for", "description": "ID of the element that triggers the tooltip on hover or focus.", "type": "string" }, { "name": "noArrow", "description": "Hide the arrow pointing toward the tooltip target.", "type": "boolean" }, { "name": "open", "description": "Indicates whether the tooltip is visible or not.", "type": "boolean" }, { "name": "placement", "description": "Sets the placement of the tooltip relative to its target.\n\nThe tooltip will try to position itself at the given placement. If there is no room it will flip to the opposite side automatically.", "type": "'top' | 'bottom' | 'left' | 'right'" }, { "name": "showDelay", "description": "Milliseconds to wait before showing the tooltip on hover.\n\nKeep at a non-zero value to avoid flickering the tooltip on and off when cursors move quickly past the target element.\n\nFocusing the target element shows the tooltip immediately.", "type": "number" }, { "name": "hideDelay", "description": "Milliseconds to wait before hiding the tooltip on mouseout.", "type": "number" } ], "events": [] } }, { "name": "w-textfield", "description": "A single-line input component used for entering and editing textual or numeric data.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)\n---\n\n\n### **Slots:**\n - **suffix** - Use with `<w-affix>` to include a suffix, for example the unit for a number (e. g. km or sek).\n- **prefix** - Use with `<w-affix>` to include a prefix, for example a search icon.", "doc-url": "", "attributes": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Mark the form field as invalid. Make sure to also set a `help-text` to help users fix the validation problem.", "value": { "type": "boolean", "default": "false" } }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "value": { "type": "string | undefined" } }, { "name": "help-text", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "size", "description": "Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs.", "value": { "type": "string | undefined" } }, { "name": "max", "description": "Use with `type=\"number\"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength).", "value": { "type": "number | undefined" } }, { "name": "min", "description": "Use with `type=\"number\"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength).", "value": { "type": "number | undefined" } }, { "name": "min-length", "value": { "type": "number | undefined" } }, { "name": "minlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required.", "value": { "type": "number | undefined" } }, { "name": "max-length", "value": { "type": "number | undefined" } }, { "name": "maxlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed.", "value": { "type": "number | undefined" } }, { "name": "pattern", "description": "Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern)", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Set a text that is shown in the textfield when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "value": { "type": "string | undefined" } }, { "name": "read-only", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether user input is required on the input before form submission.", "value": { "type": "boolean", "default": "false" } }, { "name": "type", "description": "The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Lets you set the current value.", "value": { "type": "string | undefined" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form.", "value": { "type": "string | undefined" } }, { "name": "step", "description": "When used with `number` this attribute forces inputs to be a whole number of `step`.\n\nFor example with a `step=\"5\"` only values that divide evenly on 5 are allowed.\nUsing arrow up and down in the input field increments and decrements by 5.", "value": { "type": "number | undefined" } }, { "name": "autocomplete", "description": "A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill.", "value": { "type": "HTMLInputElement[\"autocomplete\"] | undefined" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } } ], "slots": [ { "name": "suffix", "description": "Use with `<w-affix>` to include a suffix, for example the unit for a number (e. g. km or sek)." }, { "name": "prefix", "description": "Use with `<w-affix>` to include a prefix, for example a search icon." } ], "events": [], "js": { "properties": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "type": "boolean" }, { "name": "invalid", "description": "Mark the form field as invalid. Make sure to also set a `help-text` to help users fix the validation problem.", "type": "boolean" }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "type": "string | undefined" }, { "name": "helpText", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "type": "string | undefined" }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "type": "boolean" }, { "name": "size", "description": "Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs.", "type": "string | undefined" }, { "name": "max", "description": "Use with `type=\"number\"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength).", "type": "number | undefined" }, { "name": "min", "description": "Use with `type=\"number\"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength).", "type": "number | undefined" }, { "name": "minLength", "type": "number | undefined" }, { "name": "minlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required.", "type": "number | undefined" }, { "name": "maxLength", "type": "number | undefined" }, { "name": "maxlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed.", "type": "number | undefined" }, { "name": "pattern", "description": "Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern)", "type": "string | undefined" }, { "name": "placeholder", "description": "Set a text that is shown in the textfield when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "type": "string | undefined" }, { "name": "readOnly", "type": "boolean" }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user.", "type": "boolean" }, { "name": "required", "description": "Whether user input is required on the input before form submission.", "type": "boolean" }, { "name": "type", "description": "The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).", "type": "string | undefined" }, { "name": "value", "description": "Lets you set the current value.", "type": "string | undefined" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form.", "type": "string | undefined" }, { "name": "step", "description": "When used with `number` this attribute forces inputs to be a whole number of `step`.\n\nFor example with a `step=\"5\"` only values that divide evenly on 5 are allowed.\nUsing arrow up and down in the input field increments and decrements by 5.", "type": "number | undefined" }, { "name": "autocomplete", "description": "A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill.", "type": "HTMLInputElement[\"autocomplete\"] | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "formatter", "description": "Function to format value when the input field.\n\nOnly active when the input field does not have focus,\nsimilar to the accessible input [masking example from Filament Group](https://filamentgroup.github.io/politespace/demo/demo.html).", "type": "((value: string) => string) | undefined" } ], "events": [] } }, { "name": "w-affix", "description": "This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-field/frameworks/elements#prefix-label)\n---\n", "doc-url": "", "attributes": [ { "name": "aria-label", "value": { "type": "string | null", "default": "null" } }, { "name": "clear", "description": "Add this property to render a clickable Warp close icon.\n\nSet an `aria-label` that explains the action when using this.", "value": { "type": "boolean", "default": "false" } }, { "name": "search", "description": "Add this property to render a clickable Warp search icon.", "value": { "type": "boolean", "default": "false" } }, { "name": "label", "value": { "type": "string", "default": "\"\"" } }, { "name": "icon", "value": { "type": "string | null", "default": "null" } } ], "events": [], "js": { "properties": [ { "name": "ariaLabel", "type": "string | null" }, { "name": "clear", "description": "Add this property to render a clickable Warp close icon.\n\nSet an `aria-label` that explains the action when using this.", "type": "boolean" }, { "name": "search", "description": "Add this property to render a clickable Warp search icon.", "type": "boolean" }, { "name": "label", "type": "string" }, { "name": "icon", "type": "string | null" }, { "name": "_icon" } ], "events": [] } }, { "name": "w-alert", "description": "Alert is an inline component used for displaying different types of messages.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/alert/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "variant", "value": { "type": "'negative' | 'positive' | 'warning' | 'info'", "default": "\"info\"" } }, { "name": "show", "value": { "type": "boolean", "default": "false" } }, { "name": "role", "value": { "type": "string", "default": "\"alert\"" } } ], "events": [], "js": { "properties": [ { "name": "variant", "type": "'negative' | 'positive' | 'warning' | 'info'" }, { "name": "show", "type": "boolean" }, { "name": "role", "type": "string" } ], "events": [] } }, { "name": "w-link", "description": "Link component to use when creating links that look like buttons.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/link/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "autofocus", "description": "Focus the link after it is rendered", "value": { "type": "boolean", "default": "false" } }, { "name": "variant", "description": "Visual style for the link/button.", "value": { "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | undefined" } }, { "name": "small", "description": "Render a smaller version", "value": { "type": "boolean", "default": "false" } }, { "name": "href", "description": "The URL the link points to", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Applies disabled styling, but you need to disable clicks on your own.\n\nThe component renders an `<a>` element; `disabled` affects styling, but does not inherently prevent navigation. If you need to fully disable interaction, omit `href` and/or prevent default click behavior.", "value": { "type": "boolean", "default": "false" } }, { "name": "target", "description": "Where to display the linked URL (e.g. `_blank`)", "value": { "type": "string | undefined" } }, { "name": "rel", "description": "Relationship of the linked URL.\n\nIf `target=\"_blank\"` and `rel` is not provided, the component uses `noopener`.", "value": { "type": "string | undefined" } }, { "name": "full-width", "description": "Makes the link take up the full width of its parent", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "autofocus", "description": "Focus the link after it is rendered", "type": "boolean" }, { "name": "variant", "description": "Visual style for the link/button.", "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | undefined" }, { "name": "small", "description": "Render a smaller version", "type": "boolean" }, { "name": "href", "description": "The URL the link points to", "type": "string | undefined" }, { "name": "disabled", "description": "Applies disabled styling, but you need to disable clicks on your own.\n\nThe component renders an `<a>` element; `disabled` affects styling, but does not inherently prevent navigation. If you need to fully disable interaction, omit `href` and/or prevent default click behavior.", "type": "boolean" }, { "name": "target", "description": "Where to display the linked URL (e.g. `_blank`)", "type": "string | undefined" }, { "name": "rel", "description": "Relationship of the linked URL.\n\nIf `target=\"_blank\"` and `rel` is not provided, the component uses `noopener`.", "type": "string | undefined" }, { "name": "fullWidth", "description": "Makes the link take up the full width of its parent", "type": "boolean" } ], "events": [] } }, { "name": "w-button", "description": "Performs an action or renders a link with button styling.\n\nUse button variants to match action priority, risk, and context.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/button/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "type", "description": "Native button type.\nControls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.", "value": { "type": "'button' | 'submit' | 'reset' | undefined" } }, { "name": "autofocus", "description": "Focuses the button when it is first rendered.\nApplies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.", "value": { "type": "boolean", "default": "false" } }, { "name": "variant", "description": "Visual style of the button.\nDefaults to `secondary`. Use the variant that matches the action priority, risk, and placement.", "value": { "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link' | undefined" } }, { "name": "quiet", "description": "Deprecated quiet visual treatment flag\nUse `variant=\"quiet\"` instead.", "value": { "type": "boolean", "default": "false" } }, { "name": "icon-only", "description": "Marks the button as icon-only.\nUse this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.", "value": { "type": "boolean", "default": "false" } }, { "name": "small", "description": "Renders the compact button size.\nUse this in dense layouts where the default button size is too large.", "value": { "type": "boolean", "default": "false" } }, { "name": "loading", "description": "Shows the loading state.\nUse after the user has triggered an action and the action is in progress.", "value": { "type": "boolean", "default": "false" } }, { "name": "href", "description": "URL for rendering the button as a link.\nWhen set, the component renders `w-link` instead of a native `button`.", "value": { "type": "string | undefined" } }, { "name": "target", "description": "Link browsing context.\nPassed to the rendered link when `href` is set.", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Visually disables the button.\nDisabled buttons are discouraged because they can hide the reason an action is unavailable.", "value": { "type": "boolean", "default": "false" } }, { "name": "rel", "description": "Link relationship.\nPassed to the rendered link when `href` is set. If `target=\"_blank\"` is set and `rel` is omitted, `noopener` is used.", "value": { "type": "string | undefined" } }, { "name": "full-width", "description": "Makes the button fill its parent width.\nUseful in narrow layouts where the button should span the available inline space.", "value": { "type": "boolean", "default": "false" } }, { "name": "button-class", "description": "Deprecated class applied to the internal control\nThis class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.", "value": { "type": "string | undefined" } }, { "name": "name", "description": "Form control name.\nUsed when the button participates in form handling.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Form control value.\nUsed with `name` when the button participates in form handling. Resets to its initial value when the form is reset.", "value": { "type": "string | undefined" } }, { "name": "commandfor", "description": "The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "value": { "type": "string | undefined" } }, { "name": "command", "description": "The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "value": { "type": "string | undefined" } } ], "events": [], "js": { "properties": [ { "name": "type", "description": "Native button type.\nControls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.", "type": "'button' | 'submit' | 'reset' | undefined" }, { "name": "autofocus", "description": "Focuses the button when it is first rendered.\nApplies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.", "type": "boolean" }, { "name": "variant", "description": "Visual style of the button.\nDefaults to `secondary`. Use the variant that matches the action priority, risk, and placement.", "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link' | undefined" }, { "name": "quiet", "description": "Deprecated quiet visual treatment flag\nUse `variant=\"quiet\"` instead.", "type": "boolean" }, { "name": "iconOnly", "description": "Marks the button as icon-only.\nUse this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.", "type": "boolean" }, { "name": "small", "description": "Renders the compact button size.\nUse this in dense layouts where the default button size is too large.", "type": "boolean" }, { "name": "loading", "description": "Shows the loading state.\nUse after the user has triggered an action and the action is in progress.", "type": "boolean" }, { "name": "href", "description": "URL for rendering the button as a link.\nWhen set, the component renders `w-link` instead of a native `button`.", "type": "string | undefined" }, { "name": "target", "description": "Link browsing context.\nPassed to the rendered link when `href` is set.", "type": "string | undefined" }, { "name": "disabled", "description": "Visually disables the button.\nDisabled buttons are discouraged because they can hide the reason an action is unavailable.", "type": "boolean" }, { "name": "rel", "description": "Link relationship.\nPassed to the rendered link when `href` is set. If `target=\"_blank\"` is set and `rel` is omitted, `noopener` is used.", "type": "string | undefined" }, { "name": "fullWidth", "description": "Makes the button fill its parent width.\nUseful in narrow layouts where the button should span the available inline space.", "type": "boolean" }, { "name": "buttonClass", "description": "Deprecated class applied to the internal control\nThis class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.", "type": "string | undefined" }, { "name": "name", "description": "Form control name.\nUsed when the button participates in form handling.", "type": "string | undefined" }, { "name": "value", "description": "Form control value.\nUsed with `name` when the button participates in form handling. Resets to its initial value when the form is reset.", "type": "string | undefined" }, { "name": "commandfor", "description": "The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "type": "string | undefined" }, { "name": "command", "description": "The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "type": "string | undefined" } ], "events": [] } }, { "name": "w-attention", "description": "Note: attention will soon be split into multiple components (tooltip, callout, popover, highlight) at which time this component will be deprecated. For now, use the `tooltip`, `callout`, `popover`, and `highlight` boolean properties to achieve the desired style and behavior.\n\nAttention is a versatile component for displaying contextual information and messages. It can be used for a wide range of purposes, such as tooltips, callouts, popovers, and highlights.\n\nThe component is designed to be anchored to a trigger element, providing contextual information related to that element. It supports various placements and styling options to accommodate different use cases and design needs.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tooltip/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "show", "description": "Controls whether the attention panel is visible.\nSet to `true` to show the attention content and `false` to hide it.", "value": { "type": "boolean", "default": "false" } }, { "name": "placement", "description": "Preferred placement relative to the trigger element.\nSets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants.", "value": { "type": "'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end'", "default": "\"bottom\"" } }, { "name": "tooltip", "description": "Renders the component with tooltip styling and behavior.\nUse for compact, non-modal contextual hints anchored to another element.", "value": { "type": "boolean", "default": "false" } }, { "name": "callout", "description": "Renders the component as an inline callout.\nCallout mode is used for always-in-flow informational content instead of floating overlay behavior.", "value": { "type": "boolean", "default": "false" } }, { "name": "popover", "description": "Enables native popover behavior for the attention element.\nWhen enabled, the component uses popover semantics and styling suitable for floating surface UI.", "value": { "type": "boolean", "default": "false" } }, { "name": "highlight", "description": "Renders the component with highlight styling.\nUse highlight mode to visually emphasize important contextual information.", "value": { "type": "boolean", "default": "false" } }, { "name": "can-close", "description": "Shows a close button inside the attention component.\nAdds an internal dismiss action that lets users close the attention panel.", "value": { "type": "boolean", "default": "false" } }, { "name": "no-arrow", "description": "Hides the directional arrow of the attention component.\nDisable the arrow when the visual connection to the trigger should not be shown.", "value": { "type": "boolean", "default": "false" } }, { "name": "distance", "description": "Distance offset between trigger and attention panel.\nDefines the main-axis spacing in pixels from the anchor element.", "value": { "type": "number", "default": "8" } }, { "name": "skidding", "description": "Cross-axis offset for fine-grained positioning.\nMoves the panel along the cross axis in pixels to adjust alignment with the trigger.", "value": { "type": "number", "default": "0" } }, { "name": "flip", "description": "Enables automatic flipping when placement has no space.\nAllows the component to choose an alternative side if the preferred placement would overflow.", "value": { "type": "boolean", "default": "false" } }, { "name": "cross-axis", "description": "Allows overflow checks on the cross axis when flipping.\nUse with `flip` to improve collision handling when space is constrained horizontally or vertically.", "value": { "type": "boolean", "default": "false" } }, { "name": "fallback-placements", "description": "Ordered list of fallback placements.\nProvides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit.", "value": { "type": "Directions[]", "default": "[]" } } ], "events": [], "js": { "properties": [ { "name": "show", "description": "Controls whether the attention panel is visible.\nSet to `true` to show the attention content and `false` to hide it.", "type": "boolean" }, { "name": "placement", "description": "Preferred placement relative to the trigger element.\nSets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants.", "type": "'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end'" }, { "name": "tooltip", "description": "Renders the component with tooltip styling and behavior.\nUse for compact, non-modal contextual hints anchored to another element.", "type": "boolean" }, { "name": "callout", "description": "Renders the component as an inline callout.\nCallout mode is used for always-in-flow informational content instead of floating overlay behavior.", "type": "boolean" }, { "name": "popover", "description": "Enables native popover behavior for the attention element.\nWhen enabled, the component uses popover semantics and styling suitable for floating surface UI.", "type": "boolean" }, { "name": "highlight", "description": "Renders the component with highlight styling.\nUse highlight mode to visually emphasize important contextual information.", "type": "boolean" }, { "name": "canClose", "description": "Shows a close button inside the attention component.\nAdds an internal dismiss action that lets users close the attention panel.", "type": "boolean" }, { "name": "noArrow", "description": "Hides the directional arrow of the attention component.\nDisable the arrow when the visual connection to the trigger should not be shown.", "type": "boolean" }, { "name": "distance", "description": "Distance offset between trigger and attention panel.\nDefines the main-axis spacing in pixels from the anchor element.", "type": "number" }, { "name": "skidding", "description": "Cross-axis offset for fine-grained positioning.\nMoves the panel along the cross axis in pixels to adjust alignment with the trigger.", "type": "number" }, { "name": "flip", "description": "Enables automatic flipping when placement has no space.\nAllows the component to choose an alternative side if the preferred placement would overflow.", "type": "boolean" }, { "name": "crossAxis", "description": "Allows overflow checks on the cross axis when flipping.\nUse with `flip` to improve collision handling when space is constrained horizontally or vertically.", "type": "boolean" }, { "name": "fallbackPlacements", "description": "Ordered list of fallback placements.\nProvides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit.", "type": "Directions[]" }, { "name": "_initialPlacement" }, { "name": "_actualDirection" } ], "events": [] } }, { "name": "w-badge", "description": "`w-badge` is used for showing a small amount of non-interactive color-categorized metadata, like a status or count.\n---\n\n\n### **Slots:**\n - _default_ - The content of the badge, which is typically a short string like \"New\" or \"4\".", "doc-url": "", "attributes": [ { "name": "variant", "description": "Controls the badge color treatment.\nIf omitted, the badge uses neutral styling without reflecting a `variant` attribute.\nAccepted values are `neutral`, `info`, `positive`, `warning`, `negative`, `disabled`, `price`, and `sponsored`. If omitted, the badge uses neutral styling without reflecting a `variant` attribute.", "value": { "type": "'neutral' | 'info' | 'positive' | 'warning' | 'negative' | 'disabled' | 'price' | 'sponsored' | undefined", "default": "\"neutral\"" } }, { "name": "position", "description": "Positions the badge in a corner of a parent element.\nUse this with a parent element that has `position: relative`. When set, the badge uses absolute positioning and adjusts its corner radii so it sits flush against the selected corner.\nUse this with a parent element that has `position: relative`. Accepted values are `top-left`, `top-right`, `bottom-right`, and `bottom-left`.", "value": { "type": "\"top-left\" | \"top-right\" | \"bottom-right\" | \"bottom-left\" | undefined" } } ], "slots": [ { "name": "", "description": "The content of the badge, which is typically a short string like \"New\" or \"4\"." } ], "events": [], "js": { "properties": [ { "name": "variant", "description": "Controls the badge color treatment.\nIf omitted, the badge uses neutral styling without reflecting a `variant` attribute.\nAccepted values are `neutral`, `info`, `positive`, `warning`, `negative`, `disabled`, `price`, and `sponsored`. If omitted, the badge uses neutral styling without reflecting a `variant` attribute.", "type": "'neutral' | 'info' | 'positive' | 'warning' | 'negative' | 'disabled' | 'price' | 'sponsored' | undefined" }, { "name": "position", "description": "Positions the badge in a corner of a parent element.\nUse this with a parent element that has `position: relative`. When set, the badge uses absolute positioning and adjusts its corner radii so it sits flush against the selected corner.\nUse this with a parent element that has `position: relative`. Accepted values are `top-left`, `top-right`, `bottom-right`, and `bottom-left`.", "type": "\"top-left\" | \"top-right\" | \"bottom-right\" | \"bottom-left\" | undefined" } ], "events": [] } }, { "name": "w-box", "description": "Box is a layout component used for separating content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/box/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "bleed", "description": "Makes the box bleed to the container edge.\nExtends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up.", "value": { "type": "boolean", "default": "false" } }, { "name": "bordered", "description": "Shows the box as a bordered surface.\nUse this when the content needs a clear visual boundary from the surrounding page.", "value": { "type": "boolean", "default": "false" } }, { "name": "info", "description": "Shows the box with information styling.\nUse this for supporting informational content that should be visually separated from the surrounding page.", "value": { "type": "boolean", "default": "false" } }, { "name": "neutral", "description": "Shows the box with neutral styling.\nUse this for quiet grouped content that needs a background without strong emphasis.", "value": { "type": "boolean", "default": "false" } }, { "name": "role", "description": "ARIA role for the box wrapper.\nDefaults to a role of `region`. Set `role=\"none\"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose.", "value": { "type": "string", "default": "\"region\"" } } ], "events": [], "js": { "properties": [ { "name": "bleed", "description": "Makes the box bleed to the container edge.\nExtends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up.", "type": "boolean" }, { "name": "bordered", "description": "Shows the box as a bordered surface.\nUse this when the content needs a clear visual boundary from the surrounding page.", "type": "boolean" }, { "name": "info", "description": "Shows the box with information styling.\nUse this for supporting informational content that should be visually separated from the surrounding page.", "type": "boolean" }, { "name": "neutral", "description": "Shows the box with neutral styling.\nUse this for quiet grouped content that needs a background without strong emphasis.", "type": "boolean" }, { "name": "role", "description": "ARIA role for the box wrapper.\nDefaults to a role of `region`. Set `role=\"none\"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose.", "type": "string" } ], "events": [] } }, { "name": "w-breadcrumb-item", "description": "Represents one item in a `w-breadcrumbs` trail.\nRenders the slotted label as a link when `href` is set, or as text when it is not, and adds a separator after non-current items.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)\n---\n\n\n### **Slots:**\n - _default_ - The breadcrumb label content.", "doc-url": "", "attributes": [ { "name": "current-page", "description": "Marks this item as the current page.\nUse this on the final breadcrumb item so it exposes `aria-current=\"page\"` and does not render a trailing separator.", "value": { "type": "boolean", "default": "false" } }, { "name": "href", "description": "URL for linked breadcrumb items.\nWhen omitted, the item renders as non-focusable text.", "value": { "type": "string | null", "default": "null" } } ], "slots": [ { "name": "", "description": "The breadcrumb label content." } ], "events": [], "js": { "properties": [ { "name": "currentPage", "description": "Marks this item as the current page.\nUse this on the final breadcrumb item so it exposes `aria-current=\"page\"` and does not render a trailing separator.", "type": "boolean" }, { "name": "href", "description": "URL for linked breadcrumb items.\nWhen omitted, the item renders as non-focusable text.", "type": "string | null" } ], "events": [] } }, { "name": "w-breadcrumbs", "description": "Shows the navigation structure for the current page.\n\nRenders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)\n---\n", "doc-url": "", "attributes": [], "events": [], "js": { "properties": [ { "name": "ariaLabel", "description": "Accessible label for the breadcrumb navigation.\nDefaults to the localized \"You are here\" label. Set `aria-label` when the default label is not specific enough for the page.", "type": "string | null" } ], "events": [] } }, { "name": "w-card", "description": "Card is a layout component used for grouping interactive content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/card/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "selected", "description": "Whether the card is visually selected.\n\nUse this when the card represents a selected item or choice. This only controls the visual selected state; update it from your application state when the selection changes.", "value": { "type": "boolean", "default": "false" } }, { "name": "flat", "description": "Whether the card uses the flat visual treatment.\n\nFlat cards use a bordered surface instead of the default elevated surface. Use this for denser layouts or when the card sits inside another surface.", "value": { "type": "boolean", "default": "false" } }, { "name": "clickable", "description": "Whether the whole card is interactive.\n\nWhen set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "selected", "description": "Whether the card is visually selected.\n\nUse this when the card represents a selected item or choice. This only controls the visual selected state; update it from your application state when the selection changes.", "type": "boolean" }, { "name": "flat", "description": "Whether the card uses the flat visual treatment.\n\nFlat cards use a bordered surface instead of the default elevated surface. Use this for denser layouts or when the card sits inside another surface.", "type": "boolean" }, { "name": "clickable", "description": "Whether the whole card is interactive.\n\nWhen set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice.", "type": "boolean" } ], "events": [] } }, { "name": "w-checkbox", "description": "Checkboxes allow users to select one or more options from a number of choices.\n\nWrap individual checkboxes in a checkbox group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the checkbox passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the browser's validation message if invalid", "doc-url": "", "attributes": [ { "name": "name", "description": "The name of the checkbox.\n\nWhen the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "The value submitted when the checkbox is checked.\n\nIf no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.", "value": { "type": "string | null", "default": "null" } }, { "name": "indeterminate", "description": "Whether the checkbox is visually indeterminate.\n\nUse this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.", "value": { "type": "boolean", "default": "false" } }, { "name": "checked", "description": "Whether the checkbox is checked.\n\nChecked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.", "value": { "type": "boolean", "default": "false" } }, { "name": "disabled", "description": "Whether the checkbox is disabled.\n\nDisabled checkboxes cannot be focused, changed, or submitted with form data.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether the checkbox must be checked before form submission.\n\nA required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Whether the checkbox is visually invalid.\n\nUse this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "input", "type": "HTMLInputElement" }, { "name": "name", "description": "The name of the checkbox.\n\nWhen the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.", "type": "string | undefined" }, { "name": "value", "description": "The value submitted when the checkbox is checked.\n\nIf no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.", "type": "string | null" }, { "name": "indeterminate", "description": "Whether the checkbox is visually indeterminate.\n\nUse this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.", "type": "boolean" }, { "name": "checked", "description": "Whether the checkbox is checked.\n\nChecked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.", "type": "boolean" }, { "name": "disabled", "description": "Whether the checkbox is disabled.\n\nDisabled checkboxes cannot be focused, changed, or submitted with form data.", "type": "boolean" }, { "name": "required", "description": "Whether the checkbox must be checked before form submission.\n\nA required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.", "type": "boolean" }, { "name": "invalid", "description": "Whether the checkbox is visually invalid.\n\nUse this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.", "type": "boolean" }, { "name": "_computedInvalid", "description": "Computed invalid state: combines own invalid with group invalid", "type": "boolean" }, { "name": "validationMessage", "description": "Returns the validation message if the checkbox is invalid, otherwise an empty string", "type": "string" }, { "name": "validity", "description": "Returns the validity state of the checkbox", "type": "ValidityState" } ], "events": [] } }, { "name": "w-checkbox-group", "description": "Checkboxes allow users to select one or more options from a number of choices.\n\nWrap individual checkboxes in a checkbox group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the group passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the validation message if invalid\n- **focus(options: _FocusOptions_)** - Sets focus on the checkbox group.", "doc-url": "", "attributes": [ { "name": "label", "description": "The group label displayed above the checkboxes.\n\nUse this to describe the shared question or topic for the checkbox options. The label is connected to the internal group for assistive technologies.", "value": { "type": "string | undefined" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "name", "description": "The name applied to child checkboxes when they do not provide one.\n\nUse this when the grouped checkboxes should submit values under the same form field name. Individual checkboxes can still override the group name with their own `name`.", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that selecting an option from the group is not required.", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "Help text displayed below the checkbox group.\n\nUse this for supporting guidance or validation feedback. When required validation fails, the group replaces this text with the localized required message.", "value": { "type": "string | undefined" } }, { "name": "required", "description": "Whether at least one checkbox in the group must be selected.\n\nRequired validation is managed by the group. The individual checkboxes provide the submitted form values.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Whether the checkbox group is visually invalid.\n\nUse this to show an externally managed validation error for the group. The invalid state is also shared with child checkboxes for consistent styling and accessibility state.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "label", "description": "The group label displayed above the checkboxes.\n\nUse this to describe the shared question or topic for the checkbox options. The label is connected to the internal group for assistive technologies.", "type": "string | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "name", "description": "The name applied to child checkboxes when they do not provide one.\n\nUse this when the grouped checkboxes should submit values under the same form field name. Individual checkboxes can still override the group name with their own `name`.", "type": "string | undefined" }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that selecting an option from the group is not required.", "type": "boolean" }, { "name": "helpText", "description": "Help text displayed below the checkbox group.\n\nUse this for supporting guidance or validation feedback. When required validation fails, the group replaces this text with the localized required message.", "type": "string | undefined" }, { "name": "required", "description": "Whether at least one checkbox in the group must be selected.\n\nRequired validation is managed by the group. The individual checkboxes provide the submitted form values.", "type": "boolean" }, { "name": "invalid", "description": "Whether the checkbox group is visually invalid.\n\nUse this to show an externally managed validation error for the group. The invalid state is also shared with child checkboxes for consistent styling and accessibility state.", "type": "boolean" } ], "events": [] } }, { "name": "w-combobox", "description": "A combobox element for text input with selectable options.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/combo-box/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "options", "description": "The available options to select from.\n\nUse this for framework usage, application state, or remote search results. When `options` contains entries, it is used instead of child `<option>` elements.", "value": { "type": "ComboboxOption[]", "default": "[]" } }, { "name": "label", "description": "The label displayed above the input.\n\nUse this to give the combobox a visible and accessible name.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Placeholder text displayed when the input is empty.\n\nUse this as a short hint for the expected input. Do not use placeholder text as a replacement for a label.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "value", "description": "The selected or typed value.\n\nWhen an option is selected, this is set to the option value. The displayed text may differ when the option has a separate label.", "value": { "type": "string", "default": "\"\"" } }, { "name": "open-on-focus", "description": "Whether the option list opens when the input receives focus.\n\nUse this when users should see available options before they start typing.", "value": { "type": "boolean", "default": "false" } }, { "name": "select-on-blur", "description": "Whether the active option is selected when the input loses focus.\n\nWhen enabled, the combobox selects the keyboard-highlighted option, or an option whose value exactly matches the current input value, on blur.", "value": { "type": "boolean", "default": "true" } }, { "name": "match-text-segments", "description": "Whether matching text segments in options are highlighted.\n\nUse this to visually emphasize the part of each option that matches the current input value.", "value": { "type": "boolean", "default": "false" } }, { "name": "disable-static-filtering", "description": "Whether built-in client-side filtering is disabled.\n\nUse this for remote search or externally filtered results. When disabled, all entries in `options` are rendered as provided.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Whether the combobox is visually invalid.\n\nUse this to show an externally managed validation error. Pair it with `help-text` to explain how to fix the error.", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "Help text displayed below the input.\n\nUse this for supporting guidance or validation feedback.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "disabled", "description": "Whether the combobox is disabled.\n\nDisabled comboboxes cannot be focused, changed, or submitted with form data.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether the combobox is required before form submission.\n\nUse this when the user must provide a value before submitting the form.", "value": { "type": "boolean", "default": "false" } }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that the combobox is not required.", "value": { "type": "boolean", "default": "false" } }, { "name": "name", "description": "The name submitted with the combobox value.\n\nUse this when the combobox belongs to a form and its value should be included in form data.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "autocomplete", "description": "The autocomplete attribute passed to the internal input.\n\nDefaults to `off`. Set this when browser autocomplete should be enabled or scoped to a specific autocomplete token.", "value": { "type": "string | undefined", "default": "\"off\"" } } ], "events": [], "js": { "properties": [ { "name": "options", "description": "The available options to select from.\n\nUse this for framework usage, application state, or remote search results. When `options` contains entries, it is used instead of child `<option>` elements.", "type": "ComboboxOption[]" }, { "name": "label", "description": "The label displayed above the input.\n\nUse this to give the combobox a visible and accessible name.", "type": "string | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "placeholder", "description": "Placeholder text displayed when the input is empty.\n\nUse this as a short hint for the expected input. Do not use placeholder text as a replacement for a label.", "type": "string | undefined" }, { "name": "value", "description": "The selected or typed value.\n\nWhen an option is selected, this is set to the option value. The displayed text may differ when the option has a separate label.", "type": "string" }, { "name": "openOnFocus", "description": "Whether the option list opens when the input receives focus.\n\nUse this when users should see available options before they start typing.", "type": "boolean" }, { "name": "selectOnBlur", "description": "Whether the active option is selected when the input loses focus.\n\nWhen enabled, the combobox selects the keyboard-highlighted option, or an option whose value exactly matches the current input value, on blur.", "type": "boolean" }, { "name": "matchTextSegments", "description": "Whether matching text segments in options are highlighted.\n\nUse this to visually emphasize the part of each option that matches the current input value.", "type": "boolean" }, { "name": "disableStaticFiltering", "description": "Whether built-in client-side filtering is disabled.\n\nUse this for remote search or externally filtered results. When disabled, all entries in `options` are rendered as provided.", "type": "boolean" }, { "name": "invalid", "description": "Whether the combobox is visually invalid.\n\nUse this to show an externally managed validation error. Pair it with `help-text` to explain how to fix the error.", "type": "boolean" }, { "name": "helpText", "description": "Help text displayed below the input.\n\nUse this for supporting guidance or validation feedback.", "type": "string | undefined" }, { "name": "disabled", "description": "Whether the combobox is disabled.\n\nDisabled comboboxes cannot be focused, changed, or submitted with form data.", "type": "boolean" }, { "name": "required", "description": "Whether the combobox is required before form submission.\n\nUse this when the user must provide a value before submitting the form.", "type": "boolean" }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that the combobox is not required.", "type": "boolean" }, { "name": "name", "description": "The name submitted with the combobox value.\n\nUse this when the combobox belongs to a form and its value should be included in form data.", "type": "string | undefined" }, { "name": "autocomplete", "description": "The autocomplete attribute passed to the internal input.\n\nDefaults to `off`. Set this when browser autocomplete should be enabled or scoped to a specific autocomplete token.", "type": "string | undefined" } ], "events": [] } }, { "name": "w-datepicker", "description": "A date picker allows the user to select a specific calendar date.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/date-picker/frameworks/elements)\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the textarea passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the browser's validation message if invalid\n- **setCustomValidity(message: _string_): _void_** - Sets a custom validation message. Pass an empty string to clear.", "doc-url": "", "attributes": [ { "name": "label", "description": "The label displayed above the date input.\n\nUse this to give the datepicker a visible and accessible name.", "value": { "type": "string | undefined" } }, { "name": "required", "description": "Whether user input is required on the input before form submission", "value": { "type": "boolean", "default": "false" } }, { "name": "optional", "description": "Indicate visually that the field is optional", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "lang", "description": "The locale used for calendar labels and date formatting.\n\nThis takes precedence over the `<html>` `lang` attribute. Supported built-in locales are `en`, `nb`, `sv`, `da`, and `fi`.", "value": { "type": "string" } }, { "name": "name", "description": "The name submitted with the date value.\n\nUse this when the datepicker belongs to a form and its value should be included in form data.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "The selected date value.\n\nUse an ISO date string in `YYYY-MM-DD` format. The value is submitted with the form and is reset to its initial value when the form resets.", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "value": { "type": "boolean", "default": "false" } }, { "name": "header-format", "description": "The date format used in the calendar header.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "value": { "type": "string", "default": "\"MMMM yyyy\"" } }, { "name": "weekday-format", "description": "The weekday format shown above the calendar grid.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "value": { "type": "string", "default": "\"EEEEEE\"" } }, { "name": "day-format", "description": "The date format used for calendar day accessible names.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "value": { "type": "string", "default": "\"PPPP\"" } } ], "events": [], "js": { "properties": [ { "name": "label", "description": "The label displayed above the date input.\n\nUse this to give the datepicker a visible and accessible name.", "type": "string | undefined" }, { "name": "required", "description": "Whether user input is required on the input before form submission", "type": "boolean" }, { "name": "optional", "description": "Indicate visually that the field is optional", "type": "boolean" }, { "name": "helpText", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "type": "string | undefined" }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "lang", "description": "The locale used for calendar labels and date formatting.\n\nThis takes precedence over the `<html>` `lang` attribute. Supported built-in locales are `en`, `nb`, `sv`, `da`, and `fi`.", "type": "string" }, { "name": "name", "description": "The name submitted with the date value.\n\nUse this when the datepicker belongs to a form and its value should be included in form data.", "type": "string | undefined" }, { "name": "value", "description": "The selected date value.\n\nUse an ISO date string in `YYYY-MM-DD` format. The value is submitted with the form and is reset to its initial value when the form resets.", "type": "string | undefined" }, { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "type": "boolean" }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "type": "boolean" }, { "name": "headerFormat", "description": "The date format used in the calendar header.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "type": "string" }, { "name": "weekdayFormat", "description": "The weekday format shown above the calendar grid.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "type": "string" }, { "name": "isDayDisabled", "description": "Function used to disable dates in the calendar.\n\nSet this on the element instance in JavaScript, not as an HTML attribute. Disabled dates cannot be selected from the calendar.", "type": "((day: Date) => boolean) | undefined" }, { "name": "dayFormat", "description": "The date format used for calendar day accessible names.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "type": "string" }, { "name": "isCalendarOpen", "type": "boolean" }, { "name": "navigationDate", "type": "Date" }, { "name": "selectedDate", "type": "Date | null" }, { "name": "month" }, { "name": "weeks" }, { "name": "calendar", "type": "HTMLDivElement" }, { "name": "input", "type": "HTMLInputElement" }, { "name": "toggleButton", "type": "HTMLButtonElement" }, { "name": "wrapper", "type": "HTMLDivElement" }, { "name": "previousMonthButton", "description": "This is the first focusable element, needed for the modal focus trap.\n\nDon't cache this and other `@query` fields from inside the calendar modal.\nThey work the first time, but once the calendar is closed and reopened\nthe query will point to an element that doesn't exist anymore.", "type": "HTMLButtonElement" }, { "name": "todayCell", "type": "HTMLTableCellElement" }, { "name": "selectedCell", "type": "HTMLTableCellElement" }, { "name": "validationMessage", "description": "Returns the validation message if the textarea is invalid, otherwise an empty string", "type": "string" }, { "name": "validity", "description": "Returns the validity state of the textarea", "type": "ValidityState" } ], "events": [] } }, { "name": "w-expandable", "description": "Expandable is a layout component used for creating expandable content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/expandable/frameworks/elements)\n---\n\n\n### **Slots:**\n - **title** - Alternative to the `title` attribute should you need to provide some additional markup.\n\n### **CSS Parts:**\n - **base** - the root wrapper element inside the component.\n- **chevron** - the chevron container.", "doc-url": "", "attributes": [ { "name": "expanded", "description": "Controls component's expanded state", "value": { "type": "boolean", "default": "false" } }, { "name": "title", "description": "Component title. Used to display the title value which is always present regardless of whether the component is open or closed.", "value": { "type": "string" } }, { "name": "box", "description": "Will make the expandable a Box", "value": { "type": "boolean", "default": "false" } }, { "name": "bleed", "description": "Will make the expandable full-width on the sm breakpoint size", "value": { "type": "boolean", "default": "false" } }, { "name": "button-class", "value": { "type": "string | undefined" } }, { "name": "content-class", "value": { "type": "string | undefined" } }, { "name": "no-chevron", "description": "Controls chevron visibility", "value": { "type": "boolean", "default": "false" } }, { "name": "animated", "description": "Will animate the expansion/collapse", "value": { "type": "boolean", "default": "false" } }, { "name": "heading-level", "description": "Wrap the toggle button in a heading element with the specified level. If headingLevel is not specified, the button will not be wrapped by a heading element.", "value": { "type": "number | undefined" } }, { "name": "_hasTitle", "value": { "type": "boolean", "default": "true" } }, { "name": "_showChevronUp", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "title", "description": "Alternative to the `title` attribute should you need to provide some additional markup." } ], "events": [], "js": { "properties": [ { "name": "expanded", "description": "Controls component's expanded state", "type": "boolean" }, { "name": "title", "description": "Component title. Used to display the title value which is always present regardless of whether the component is open or closed.", "type": "string" }, { "name": "box", "description": "Will make the expandable a Box", "type": "boolean" }, { "name": "bleed", "description": "Will make the expandable full-width on the sm breakpoint size", "type": "boolean" }, { "name": "buttonClass", "type": "string | undefined" }, { "name": "contentClass", "type": "string | undefined" }, { "name": "noChevron", "description": "Controls chevron visibility", "type": "boolean" }, { "name": "animated", "description": "Will animate the expansion/collapse", "type": "boolean" }, { "name": "headingLevel", "description": "Wrap the toggle button in a heading element with the specified level. If headingLevel is not specified, the button will not be wrapped by a heading element.", "type": "number | undefined" } ], "events": [] } }, { "name": "w-modal", "description": "Modals (or dialogs) display important information that users need to acknowledge.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)\n---\n\n\n### **Events:**\n - **shown**\n- **hidden**\n\n### **Slots:**\n - **header** - Typically where you would use the `w-modal-header` component.\n- **content** - The main content of the modal.\n- **footer** - Typically where you would use the `w-modal-footer` component, for things like actions.\n\n### **CSS Properties:**\n - **--w-c-modal-backdrop-color** - undefined _(default: undefined)_\n- **--w-c-modal-bg** - undefined _(default: undefined)_\n- **--w-c-modal-box-shadow** - undefined _(default: undefined)_\n- **--w-c-modal-color** - undefined _(default: undefined)_\n- **--w-c-modal-height** - undefined _(default: undefined)_\n- **--w-c-modal-max-height** - undefined _(default: undefined)_\n- **--w-c-modal-min-height** - undefined _(default: undefined)_\n- **--w-c-modal-translate-distance** - undefined _(default: undefined)_\n- **--w-c-modal-padding-bottom** - undefined _(default: undefined)_\n- **--w-c-modal-width** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **dialog** - the root element inside the component (`<dialog>` element).\n- **wrapper** - container for all elements, direct child of `<dialog>`.\n- **content** - the container for the `content` slot items (children).", "doc-url": "", "attributes": [ { "name": "show", "description": "Controls if the modal should show or hide.\n\nYou can also call the `open()` and `close()` methods.", "value": { "type": "boolean", "default": "false" } }, { "name": "content-id", "value": { "type": "string | undefined" } }, { "name": "ignore-backdrop-clicks", "description": "Ignores clicks to the backdrop when set", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "header", "description": "Typically where you would use the `w-modal-header` component." }, { "name": "content", "description": "The main content of the modal." }, { "name": "footer", "description": "Typically where you would use the `w-modal-footer` component, for things like actions." } ], "events": [ { "name": "shown", "type": "CustomEvent" }, { "name": "hidden", "type": "CustomEvent" } ], "js": { "properties": [ { "name": "show", "description": "Controls if the modal should show or hide.\n\nYou can also call the `open()` and `close()` methods.", "type": "boolean" }, { "name": "contentId", "type": "string | undefined" }, { "name": "ignoreBackdropClicks", "description": "Ignores clicks to the backdrop when set", "type": "boolean" } ], "events": [ { "name": "shown", "type": "CustomEvent" }, { "name": "hidden", "type": "CustomEvent" } ] } }, { "name": "w-modal-footer", "description": "The footer section of a modal, typically where you place actions.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)\n---\n\n\n### **CSS Properties:**\n - **--w-c-modal-footer-gap** - adjusts the flex gap between actions in the footer. _(default: undefined)_\n\n### **CSS Parts:**\n - **footer** - the container for slotted items (children).", "doc-url": "", "attributes": [], "events": [], "js": { "properties": [], "events": [] } }, { "name": "w-modal-header", "description": "The header section of a modal, typically where you place the title and a close button.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)\n---\n\n\n### **Events:**\n - **backClicked**\n\n### **Slots:**\n - **top** - Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example.\n\n### **CSS Properties:**\n - **--w-c-modal-header-font-size** - undefined _(default: undefined)_\n- **--w-c-modal-header-line-height** - undefined _(default: undefined)_\n- **--w-c-modal-header-margin-bottom** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **header** - the root element inside the component.\n- **top** - the container for the image (`top` slot).\n- **back** - the back button, if visible.\n- **title** - the title element.\n- **close** - the close button, if visible.", "doc-url": "", "attributes": [ { "name": "title", "description": "A short but descriptive title for the modal", "value": { "type": "string" } }, { "name": "back", "description": "Whether the modal header should have a back button", "value": { "type": "boolean", "default": "false" } }, { "name": "no-close", "description": "Lets you hide the close button in the header", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "top", "description": "Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example." } ], "events": [{ "name": "backClicked", "type": "CustomEvent" }], "js": { "properties": [ { "name": "title", "description": "A short but descriptive title for the modal", "type": "string" }, { "name": "back", "description": "Whether the modal header should have a back button", "type": "boolean" }, { "name": "noClose", "description": "Lets you hide the close button in the header", "type": "boolean" } ], "events": [{ "name": "backClicked", "type": "CustomEvent" }] } }, { "name": "w-page-indicator", "description": "A page indicator component that displays a series of dots representing pages.\n\nOne dot is highlighted to indicate the currently selected page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/page-indicator/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "selected-page", "description": "Currently selected page (1-based index)", "value": { "type": "number", "default": "1" } }, { "name": "page-count", "description": "Total number of pages", "value": { "type": "number", "default": "1" } } ], "events": [], "js": { "properties": [ { "name": "selectedPage", "description": "Currently selected page (1-based index)", "type": "number" }, { "name": "pageCount", "description": "Total number of pages", "type": "number" } ], "events": [] } }, { "name": "w-pagination", "description": "Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/pagination/frameworks/elements)\n---\n\n\n### **Events:**\n - **page-click** - Triggered when a link in the pagination is clicked. Contains the page number in `string` form.", "doc-url": "", "attributes": [ { "name": "base-url", "description": "The base URL used to construct page links, for example `/search?page=`.\n\nThe page number is appended to this URL.", "value": { "type": "string | undefined" } }, { "name": "pages", "description": "The total number of pages.", "value": { "type": "number", "default": "0" } }, { "name": "current-page", "description": "The currently active page number.", "value": { "type": "number", "default": "1" } }, { "name": "visible-pages", "description": "The maximum number of page numbers visible.", "value": { "type": "number", "default": "7" } } ], "events": [ { "name": "page-click", "type": "CustomEvent", "description": "Triggered when a link in the pagination is clicked. Contains the page number in `string` form." } ], "js": { "properties": [ { "name": "baseUrl", "description": "The base URL used to construct page links, for example `/search?page=`.\n\nThe page number is appended to this URL.", "type": "string | undefined" }, { "name": "pages", "description": "The total number of pages.", "type": "number" }, { "name": "currentPageNumber", "description": "The currently active page number.", "type": "number" }, { "name": "visiblePages", "description": "The maximum number of page numbers visible.", "type": "number" } ], "events": [ { "name": "page-click", "type": "CustomEvent", "description": "Triggered when a link in the pagination is clicked. Contains the page number in `string` form." } ] } }, { "name": "w-pill", "description": "Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/pill/frameworks/elements)\n---\n\n\n### **Events:**\n - **w-pill-click** - Fires when the pill itself is clicked.\n- **w-pill-close** - Fires when the pill's close button is clicked.", "doc-url": "", "attributes": [ { "name": "can-close", "description": "Whether the pill should be removable via a close button.", "value": { "type": "boolean", "default": "false" } }, { "name": "suggestion", "description": "Whether the pill should be rendered as a suggestion.", "value": { "type": "boolean", "default": "false" } }, { "name": "open-sr-label", "value": { "type": "string | undefined" } }, { "name": "open-aria-label", "description": "Label read by screen readers when targeting the pill.", "value": { "type": "string | undefined" } }, { "name": "close-sr-label", "value": { "type": "string | undefined" } }, { "name": "close-aria-label", "description": "Label read by screen readers when targeting the close button.", "value": { "type": "string | undefined" } } ], "events": [ { "name": "w-pill-click", "type": "CustomEvent", "description": "Fires when the pill itself is clicked." }, { "name": "w-pill-close", "type": "CustomEvent", "description": "Fires when the pill's close button is clicked." } ], "js": { "properties": [ { "name": "canClose", "description": "Whether the pill should be removable via a close button.", "type": "boolean" }, { "name": "suggestion", "description": "Whether the pill should be rendered as a suggestion.", "type": "boolean" }, { "name": "openSrLabel", "type": "string | undefined" }, { "name": "openAriaLabel", "description": "Label read by screen readers when targeting the pill.", "type": "string | undefined" }, { "name": "closeSrLabel", "type": "string | undefined" }, { "name": "closeAriaLabel", "description": "Label read by screen readers when targeting the close button.", "type": "string | undefined" } ], "events": [ { "name": "w-pill-click", "type": "CustomEvent", "description": "Fires when the pill itself is clicked." }, { "name": "w-pill-close", "type": "CustomEvent", "description": "Fires when the pill's close button is clicked." } ] } }, { "name": "w-radio", "description": "Radios allow users to select a single option from a list of choices.\n\nWrap individual radio components in a radio group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "name", "description": "The name of the radio, submitted as a name/value pair with form data.", "value": { "type": "string" } }, { "name": "value", "description": "The radio's value. When selected, the radio group will receive this value.", "value": { "type": "string | null", "default": "null" } }, { "name": "checked", "description": "Draws the radio in a checked state (reflected to attribute).", "value": { "type": "boolean", "default": "false" } }, { "name": "disabled", "description": "Disables the radio.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Makes the radio a required field.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Draws the radio in an invalid state.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "name", "description": "The name of the radio, submitted as a name/value pair with form data.", "type": "string" }, { "name": "value", "description": "The radio's value. When selected, the radio group will receive this value.", "type": "string | null" }, { "name": "checked", "description": "Draws the radio in a checked state (reflected to attribute).", "type": "boolean" }, { "name": "disabled", "description": "Disables the radio.", "type": "boolean" }, { "name": "required", "description": "Makes the radio a required field.", "type": "boolean" }, { "name": "invalid", "description": "Draws the radio in an invalid state.", "type": "boolean" } ], "events": [] } }, { "name": "w-radio-group", "description": "Radios allow users to select a single option from a list of choices.\n\nWrap individual radio components in a radio group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)\n---\n\n\n### **Slots:**\n - **label** - Alternative to the `label` attribute should you need custom HTML.\n- **help-text** - Alternative to the `help-text` attribute should you need custom HTML.", "doc-url": "", "attributes": [ { "name": "label", "description": "Label for the radio group.", "value": { "type": "string", "default": "\"\"" } }, { "name": "help-text", "description": "Help text for the radio group.\n\nIf you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.", "value": { "type": "string", "default": "\"\"" } }, { "name": "optional", "description": "Whether to show optional text next to the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Marks the radio group as invalid.", "value": { "type": "boolean", "default": "false" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "value": { "type": "string | null", "default": "null" } }, { "name": "disabled", "description": "Disables the radio group and all child radios.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Makes selecting a radio in the the group required.", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "label", "description": "Alternative to the `label` attribute should you need custom HTML." }, { "name": "help-text", "description": "Alternative to the `help-text` attribute should you need custom HTML." } ], "events": [], "js": { "properties": [ { "name": "label", "description": "Label for the radio group.", "type": "string" }, { "name": "helpText", "description": "Help text for the radio group.\n\nIf you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.", "type": "string" }, { "name": "optional", "description": "Whether to show optional text next to the label.", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "invalid", "description": "Marks the radio group as invalid.", "type": "boolean" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "type": "string | null" }, { "name": "disabled", "description": "Disables the radio group and all child radios.", "type": "boolean" }, { "name": "required", "description": "Makes selecting a radio in the the group required.", "type": "boolean" } ], "events": [] } }, { "name": "w-select", "description": "A dropdown component for selecting a single value.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/select/frameworks/elements)\n---\n\n\n### **Events:**\n - **change**", "doc-url": "", "attributes": [ { "name": "auto-focus", "description": "Whether the element should receive focus on render.", "value": { "type": "boolean", "default": "false" } }, { "name": "autofocus", "description": "Whether the element should receive focus on render", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.", "value": { "type": "boolean", "default": "false" } }, { "name": "always", "description": "Whether to always show a hint.", "value": { "type": "boolean", "default": "false" } }, { "name": "hint", "description": "The content displayed as the help text.", "value": { "type": "string | undefined" } }, { "name": "label", "description": "The content to display as the label.", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Renders the field in a disabled state.", "value": { "type": "boolean", "default": "false" } }, { "name": "read-only", "description": "Renders the field in a readonly state.", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Renders the field in a readonly state.", "value": { "type": "boolean", "default": "false" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Lets you set the current value.", "value": { "type": "string | undefined" } } ], "events": [{ "name": "change", "type": "CustomEvent" }], "js": { "properties": [ { "name": "autoFocus", "description": "Whether the element should receive focus on render.", "type": "boolean" }, { "name": "autofocus", "description": "Whether the element should receive focus on render", "type": "boolean" }, { "name": "helpText", "description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.", "type": "string | undefined" }, { "name": "invalid", "description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.", "type": "boolean" }, { "name": "always", "description": "Whether to always show a hint.", "type": "boolean" }, { "name": "hint", "description": "The content displayed as the help text.", "type": "string | undefined" }, { "name": "label", "description": "The content to display as the label.", "type": "string | undefined" }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "disabled", "description": "Renders the field in a disabled state.", "type": "boolean" }, { "name": "readOnly", "description": "Renders the field in a readonly state.", "type": "boolean" }, { "name": "readonly", "description": "Renders the field in a readonly state.", "type": "boolean" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "type": "string | undefined" }, { "name": "value", "description": "Lets you set the current value.", "type": "string | undefined" } ], "events": [{ "name": "change", "type": "CustomEvent" }] } }, { "name": "w-slider-thumb", "description": "Component to place inside a `<w-slider>`.\n---\n\n\n### **Events:**\n - **thumbreset** - Internal event used by (and stopped by) `w-slider`.\n- **slidervalidity** - Internal event used by (and stopped by) `w-slider`.", "doc-url": "", "attributes": [ { "name": "aria-label", "description": "Label for the range input.", "value": { "type": "string | null", "default": "null" } }, { "name": "aria-description", "description": "Contextual information for assistive technology, should it be needed", "value": { "type": "string | null", "default": "null" } }, { "name": "name", "description": "The name of this input field in the form. The canonical source of the value is the text field.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "The initial value, if any", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Placeholder in empty text fields", "value": { "type": "string | undefined" } } ], "events": [ { "name": "thumbreset", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." }, { "name": "slidervalidity", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." } ], "js": { "properties": [ { "name": "ariaLabel", "description": "Label for the range input.", "type": "string | null" }, { "name": "ariaDescription", "description": "Contextual information for assistive technology, should it be needed", "type": "string | null" }, { "name": "name", "description": "The name of this input field in the form. The canonical source of the value is the text field.", "type": "string | undefined" }, { "name": "value", "description": "The initial value, if any", "type": "string | undefined" }, { "name": "placeholder", "description": "Placeholder in empty text fields", "type": "string | undefined" } ], "events": [ { "name": "thumbreset", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." }, { "name": "slidervalidity", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." } ] } }, { "name": "w-slider", "description": "Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/slider/frameworks/elements)\n---\n\n\n### **Slots:**\n - _default_ - For single sliders place a `<w-slider-thumb>` in the default slot.\n- **label** - Label for the slider or range slider as a whole.\n- **description** - Optional description between the label and slider.\n- **from** - Range sliders need to place a `<w-slider-thumb>` in the from and to slots.\n- **to** - Range sliders need to place a `<w-slider-thumb>` in the from and to slots.", "doc-url": "", "attributes": [ { "name": "label", "description": "The slider fieldset label. Required for proper accessibility.\n\nIf you need to display HTML, use the `label` slot instead (f. ex. `<legend class=\"sr-only\" slot=\"label\">Production year</legend>`)", "value": { "type": "string | undefined" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.", "value": { "type": "string | undefined" } }, { "name": "disabled", "value": { "type": "boolean", "default": "false" } }, { "name": "open-ended", "description": "Whether or not to allow values outside the range such as \"Before 1950\" and \"2025+\".", "value": { "type": "boolean", "default": "false" } }, { "name": "error", "description": "Validation error text, if any", "value": { "type": "string | undefined" } }, { "name": "help-text", "description": "Additional description to show below the fieldset", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Sets the form fields and fieldset in an invalid state", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Ensures a child slider thumb has a value before allowing the containing form to submit", "value": { "type": "boolean", "default": "false" } }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "min", "description": "The minimum allowed value in the range inputs", "value": { "type": "string | undefined", "default": "0" } }, { "name": "max", "description": "The maximum allowed value in the range inputs", "value": { "type": "string | undefined", "default": "100" } }, { "name": "markers", "description": "Pass a value similar to step to create visual markers at that interval", "value": { "type": "number | undefined" } }, { "name": "step", "description": "ets step on the range input to jump between values when dragging", "value": { "type": "number | undefined" } }, { "name": "suffix", "description": "Suffix used in text input fields and for the min and max values of the slider", "value": { "type": "string | undefined" } }, { "name": "hidden-textfield", "description": "Should only be used in special cases", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "", "description": "For single sliders place a `<w-slider-thumb>` in the default slot." }, { "name": "label", "description": "Label for the slider or range slider as a whole." }, { "name": "description", "description": "Optional description between the label and slider." }, { "name": "from", "description": "Range sliders need to place a `<w-slider-thumb>` in the from and to slots." }, { "name": "to", "description": "Range sliders need to place a `<w-slider-thumb>` in the from and to slots." } ], "events": [], "js": { "properties": [ { "name": "label", "description": "The slider fieldset label. Required for proper accessibility.\n\nIf you need to display HTML, use the `label` slot instead (f. ex. `<legend class=\"sr-only\" slot=\"label\">Production year</legend>`)", "type": "string | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.", "type": "string | undefined" }, { "name": "disabled", "type": "boolean" }, { "name": "openEnded", "description": "Whether or not to allow values outside the range such as \"Before 1950\" and \"2025+\".", "type": "boolean" }, { "name": "error", "description": "Validation error text, if any", "type": "string | undefined" }, { "name": "helpText", "description": "Additional description to show below the fieldset", "type": "string | undefined" }, { "name": "invalid", "description": "Sets the form fields and fieldset in an invalid state", "type": "boolean" }, { "name": "required", "description": "Ensures a child slider thumb has a value before allowing the containing form to submit", "type": "boolean" }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "type": "boolean" }, { "name": "min", "description": "The minimum allowed value in the range inputs", "type": "string | undefined" }, { "name": "max", "description": "The maximum allowed value in the range inputs", "type": "string | undefined" }, { "name": "markers", "description": "Pass a value similar to step to create visual markers at that interval", "type": "number | undefined" }, { "name": "step", "description": "ets step on the range input to jump between values when dragging", "type": "number | undefined" }, { "name": "suffix", "description": "Suffix used in text input fields and for the min and max values of the slider", "type": "string | undefined" }, { "name": "hiddenTextfield", "description": "Should only be used in special cases", "type": "boolean" }, { "name": "valueFormatter", "description": "Formatter for the tooltip and input mask values", "type": "((value: string, slot: SliderSlot) => string) | undefined" }, { "name": "tooltipFormatter", "description": "Overrides valueFormatter for the tooltip.\n\nUse in open-ended sliders to show for example \"300+ hk\" instead of \"Max\" in the tooltip.", "type": "((value: string, slot: SliderSlot) => string) | undefined" }, { "name": "labelFormatter", "description": "Formatter for the min and max labels below the range.", "type": "((slot: SliderSlot) => string) | undefined" }, { "name": "_label" } ], "events": [] } }, { "name": "w-snackbar-item", "description": "An item to show in a `w-snackbar`.\n\nSee the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)\n---\n\n\n### **Methods:**\n - **close(): _void_** - Remove the snackbar item from the document.\n\nMoves focus to the last focused element outside of the snackbar item, if available.\n\n### **Slots:**\n - **default** - the snackbar message.\n- **icon** - icon preceeding the message.\n- **action** - action following the message.\n\n### **CSS Properties:**\n - **--w-c-snackbar-item-radius** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-max-width** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-min-width** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-padding** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-bg** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-bg-active** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-bg-hover** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-color** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-color-active** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-color-hover** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-box-shadow** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **item** - the container wrapping the message, icon and actions.\n- **icon** - the icon for the variant.\n- **message** - the default slot, body of the snackbar item.\n- **action** - close and action button.", "doc-url": "", "attributes": [ { "name": "action-placement", "description": "The placement of the action and close buttons.", "value": { "type": "'inline' | 'block'", "default": "\"inline\"" } }, { "name": "duration", "description": "How long the message should stay in the document before removing itself.", "value": { "type": "number" } } ], "slots": [ { "name": "default", "description": "the snackbar message." }, { "name": "icon", "description": "icon preceeding the message." }, { "name": "action", "description": "action following the message." } ], "events": [], "js": { "properties": [ { "name": "actionPlacement", "description": "The placement of the action and close buttons.", "type": "'inline' | 'block'" }, { "name": "duration", "description": "How long the message should stay in the document before removing itself.", "type": "number" } ], "events": [] } }, { "name": "w-snackbar", "description": "A Snackbar shows brief user feedback messages that overlay content, with an optional action such as Undo.\n\nInclude one `<w-snackbar></w-snackbar>` in the document `<body>`. Use the `create` function to create messages.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)\n---\n\n\n### **Methods:**\n - **create(message: _string_, options: _CreateSnackbarOptions_): __** - Creates a snackbar item and immediately adds it to the snackbar.\n\nBy default the snackbar item automatically closes after 4 seconds (`SnackbarDuration.Short`).\n\nIf you include an `action` in the options the default `duration` is\nset to 10 seconds (`SnackbarDuration.Long`) and can not be made shorter.\n\nA `duration` of 10 seconds or longer forces the close button to be visible.\n\nThe default `variant` is `neutral` which does not have an icon.\n\nSet `duration` to `SnackbarDuration.Infinite` if you want a persistent message.\n\n### **Slots:**\n - **default** - `w-snackbar-item` gets placed inside the default slot by the `create` function.\n\n### **CSS Properties:**\n - **--w-c-snackbar-container-gap** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-bottom** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-left** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-right** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-top** - undefined _(default: undefined)_\n- **--w-c-snackbar-z-index** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **container** - the live region that positions messages on the screen.", "doc-url": "", "attributes": [], "slots": [ { "name": "default", "description": "`w-snackbar-item` gets placed inside the default slot by the `create` function." } ], "events": [], "js": { "properties": [], "events": [] } }, { "name": "w-step", "description": "Individual step component that shows a single step in a process.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "active", "description": "Whether this step is active.\n\nThe active step displays a filled indicator.", "value": { "type": "boolean", "default": "false" } }, { "name": "completed", "description": "Whether this step is completed.\n\nCompleted steps display a checkmark icon and a filled indicator.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "active", "description": "Whether this step is active.\n\nThe active step displays a filled indicator.", "type": "boolean" }, { "name": "completed", "description": "Whether this step is completed.\n\nCompleted steps display a checkmark icon and a filled indicator.", "type": "boolean" } ], "events": [] } }, { "name": "w-step-indicator", "description": "Steps are used to show progress through a process or to guide users through a multi-step task.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "horizontal", "description": "Display steps horizontally instead of vertically", "value": { "type": "boolean", "default": "false" } }, { "name": "right", "description": "Align steps to the right (vertical layout only)", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "horizontal", "description": "Display steps horizontally instead of vertically", "type": "boolean" }, { "name": "right", "description": "Align steps to the right (vertical layout only)", "type": "boolean" } ], "events": [] } }, { "name": "w-switch", "description": "The Switch component allows users to toggle between two states.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/switch/frameworks/elements)\n---\n\n\n### **Events:**\n - **change** - Dispatched when the switch toggles. Includes boolean `checked` and string/null `value` on `details`.", "doc-url": "", "attributes": [ { "name": "name", "description": "Name used when submitting an HTML form.", "value": { "type": "string" } }, { "name": "value", "description": "Value submitted when the switch is checked.\n\nThe component reports `null` as the value in the `change` event when `value` is an empty string.", "value": { "type": "string" } }, { "name": "checked", "description": "Whether the switch is on (checked).", "value": { "type": "boolean", "default": "false" } }, { "name": "disabled", "description": "Whether the switch is disabled.", "value": { "type": "boolean", "default": "false" } } ], "events": [ { "name": "change", "type": "WarpSwitchChangeEvent", "description": "Dispatched when the switch toggles. Includes boolean `checked` and string/null `value` on `details`." } ], "js": { "properties": [ { "name": "name", "description": "Name used when submitting an HTML form.", "type": "string" }, { "name": "value", "description": "Value submitted when the switch is checked.\n\nThe component reports `null` as the value in the `change` event when `value` is an empty string.", "type": "string" }, { "name": "checked", "description": "Whether the switch is on (checked).", "type": "boolean" }, { "name": "disabled", "description": "Whether the switch is disabled.", "type": "boolean" } ], "events": [ { "name": "change", "type": "WarpSwitchChangeEvent", "description": "Dispatched when the switch toggles. Includes boolean `checked` and string/null `value` on `details`." } ] } }, { "name": "w-tab", "description": "Individual tab component used within w-tabs container.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "tabindex", "description": "The host element (`<w-tab>`), the one with `role=tab`, must be the focusable element for assistive technology.", "value": { "type": "number", "default": "0" } }, { "name": "for", "description": "The `id` of the `<w-tab-panel>` this tab controls.", "value": { "type": "string | undefined" } }, { "name": "over", "description": "Whether to show the `icon` slot over the tab title instead of inline.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "tabindex", "description": "The host element (`<w-tab>`), the one with `role=tab`, must be the focusable element for assistive technology.", "type": "number" }, { "name": "for", "description": "The `id` of the `<w-tab-panel>` this tab controls.", "type": "string | undefined" }, { "name": "over", "description": "Whether to show the `icon` slot over the tab title instead of inline.", "type": "boolean" }, { "name": "_internals" } ], "events": [] } }, { "name": "w-tab-panel", "description": "Tab panel component that holds content for individual tabs.\n\nEach tab panel should have a name that matches a corresponding tab.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "id", "description": "Required so `<w-tab>` has something to target.", "value": { "type": "string" } } ], "events": [], "js": { "properties": [ { "name": "id", "description": "Required so `<w-tab>` has something to target.", "type": "string" } ], "events": [] } }, { "name": "w-tabs", "description": "Tabs are used to organize content by grouping similar information on the same page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)\n---\n\n\n### **Events:**\n - **change** - Includes `details.panelId` with the now active tab panel's ID", "doc-url": "", "attributes": [ { "name": "active", "description": "The `id` of the panel that should be active.", "value": { "type": "string | undefined", "default": "\"\" (Shows the first tab)" } } ], "events": [ { "name": "change", "type": "WarpTabsChangeEvent", "description": "Includes `details.panelId` with the now active tab panel's ID" } ], "js": { "properties": [ { "name": "active", "description": "The `id` of the panel that should be active.", "type": "string | undefined" } ], "events": [ { "name": "change", "type": "WarpTabsChangeEvent", "description": "Includes `details.panelId` with the now active tab panel's ID" } ] } }, { "name": "w-textarea", "description": "A multi-line text input with built-in form validation, auto-resizing, and styling support.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)\n---\n\n\n### **Events:**\n \n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the textarea passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the validation message if invalid\n- **setCustomValidity(message: _string_): _void_** - Sets a custom validation message. Pass an empty string to clear.", "doc-url": "", "attributes": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "value": { "type": "boolean", "default": "false" } }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "value": { "type": "string | undefined" } }, { "name": "help-text", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "value": { "type": "string | undefined" } }, { "name": "maximum-rows", "description": "Sets the maximum number of text rows before the content starts scrolling.", "value": { "type": "number | undefined" } }, { "name": "minimum-rows", "description": "Sets the minimum number of text rows the textarea should display", "value": { "type": "number | undefined" } }, { "name": "maxlength", "description": "Sets the maximum number of text rows before the content starts scrolling.", "value": { "type": "number | undefined" } }, { "name": "minlength", "description": "Sets the minimum number of characters for the textarea to be valid", "value": { "type": "number | undefined" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Set a text that is shown in the textarea when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "value": { "type": "string | undefined" } }, { "name": "read-only", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether user input is required on the input before form submission", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Lets you set the current value", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Show an icon behind the label indicating the field is optional", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "type": "boolean" }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "type": "boolean" }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "type": "string | undefined" }, { "name": "helpText", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "type": "string | undefined" }, { "name": "maxRows", "description": "Sets the maximum number of text rows before the content starts scrolling.", "type": "number | undefined" }, { "name": "minRows", "description": "Sets the minimum number of text rows the textarea should display", "type": "number | undefined" }, { "name": "maxLength", "description": "Sets the maximum number of text rows before the content starts scrolling.", "type": "number | undefined" }, { "name": "minLength", "description": "Sets the minimum number of characters for the textarea to be valid", "type": "number | undefined" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form", "type": "string | undefined" }, { "name": "placeholder", "description": "Set a text that is shown in the textarea when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "type": "string | undefined" }, { "name": "readOnly", "type": "boolean" }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "type": "boolean" }, { "name": "required", "description": "Whether user input is required on the input before form submission", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "value", "description": "Lets you set the current value", "type": "string | undefined" }, { "name": "optional", "description": "Show an icon behind the label indicating the field is optional", "type": "boolean" }, { "name": "validationMessage", "description": "Returns the validation message if the textarea is invalid, otherwise an empty string", "type": "string" }, { "name": "validity", "description": "Returns the validity state of the textarea", "type": "ValidityState" } ], "events": [] } } ] }, "css": { "properties": [ { "name": "--w-c-modal-backdrop-color" }, { "name": "--w-c-modal-bg" }, { "name": "--w-c-modal-box-shadow" }, { "name": "--w-c-modal-color" }, { "name": "--w-c-modal-height" }, { "name": "--w-c-modal-max-height" }, { "name": "--w-c-modal-min-height" }, { "name": "--w-c-modal-translate-distance" }, { "name": "--w-c-modal-padding-bottom" }, { "name": "--w-c-modal-width" }, { "name": "--w-c-modal-footer-gap", "description": " adjusts the flex gap between actions in the footer." }, { "name": "--w-c-modal-header-font-size" }, { "name": "--w-c-modal-header-line-height" }, { "name": "--w-c-modal-header-margin-bottom" }, { "name": "--w-c-snackbar-item-radius" }, { "name": "--w-c-snackbar-item-max-width" }, { "name": "--w-c-snackbar-item-min-width" }, { "name": "--w-c-snackbar-item-padding" }, { "name": "--w-c-snackbar-item-bg" }, { "name": "--w-c-snackbar-item-action-bg-active" }, { "name": "--w-c-snackbar-item-action-bg-hover" }, { "name": "--w-c-snackbar-item-color" }, { "name": "--w-c-snackbar-item-action-color-active" }, { "name": "--w-c-snackbar-item-action-color-hover" }, { "name": "--w-c-snackbar-item-box-shadow" }, { "name": "--w-c-snackbar-container-gap" }, { "name": "--w-c-snackbar-position-bottom" }, { "name": "--w-c-snackbar-position-left" }, { "name": "--w-c-snackbar-position-right" }, { "name": "--w-c-snackbar-position-top" }, { "name": "--w-c-snackbar-z-index" } ], "pseudo-elements": [ { "name": "part(base)", "description": "the root wrapper element inside the component." }, { "name": "part(chevron)", "description": "the chevron container." }, { "name": "part(dialog)", "description": "the root element inside the component (`<dialog>` element)." }, { "name": "part(wrapper)", "description": "container for all elements, direct child of `<dialog>`." }, { "name": "part(content)", "description": "the container for the `content` slot items (children)." }, { "name": "part(footer)", "description": "the container for slotted items (children)." }, { "name": "part(header)", "description": "the root element inside the component." }, { "name": "part(top)", "description": "the container for the image (`top` slot)." }, { "name": "part(back)", "description": "the back button, if visible." }, { "name": "part(title)", "description": "the title element." }, { "name": "part(close)", "description": "the close button, if visible." }, { "name": "part(item)", "description": "the container wrapping the message, icon and actions." }, { "name": "part(icon)", "description": "the icon for the variant." }, { "name": "part(message)", "description": "the default slot, body of the snackbar item." }, { "name": "part(action)", "description": "close and action button." }, { "name": "part(container)", "description": "the live region that positions messages on the screen." } ] } } }

{ "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json", "name": "@warp-ds/elements", "version": "2.12.1-next.1", "description-markup": "markdown", "contributions": { "html": { "elements": [ { "name": "w-icon", "description": "[Warp component reference](https://warp-ds.github.io/docs/components/icons/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "name", "description": "Icon filename (without .svg)", "value": { "type": "string" } }, { "name": "size", "description": "Size: small, medium, large or pixel value (e.g. \"32px\").", "value": { "type": "\"small\" | \"medium\" | \"large\" | PixelValue | undefined", "default": "\"medium\"" } }, { "name": "locale", "description": "Locale used for `` text.\n\nReads the `lang` attribute from `<html>`, falls back to 'en'.", "value": { "type": "string" } } ], "events": [], "js": { "properties": [ { "name": "name", "description": "Icon filename (without .svg)", "type": "string" }, { "name": "size", "description": "Size: small, medium, large or pixel value (e.g. \"32px\").", "type": "\"small\" | \"medium\" | \"large\" | PixelValue | undefined" }, { "name": "locale", "description": "Locale used for `<title>` text.\n\nReads the `lang` attribute from `<html>`, falls back to 'en'.", "type": "string" } ], "events": [] } }, { "name": "w-tooltip", "description": "A tooltip is a message box that is displayed when a user hovers over or gives focus to a UI element.\n\nTooltips should be used sparingly and contain succinct, supplementary information.\n---\n", "doc-url": "", "attributes": [ { "name": "for", "description": "ID of the element that triggers the tooltip on hover or focus.", "value": { "type": "string", "default": "\"\"" } }, { "name": "no-arrow", "description": "Hide the arrow pointing toward the tooltip target.", "value": { "type": "boolean", "default": "false" } }, { "name": "open", "description": "Indicates whether the tooltip is visible or not.", "value": { "type": "boolean", "default": "false" } }, { "name": "placement", "description": "Sets the placement of the tooltip relative to its target.\n\nThe tooltip will try to position itself at the given placement. If there is no room it will flip to the opposite side automatically.", "value": { "type": "'top' | 'bottom' | 'left' | 'right'", "default": "\"top\"" } }, { "name": "show-delay", "description": "Milliseconds to wait before showing the tooltip on hover.\n\nKeep at a non-zero value to avoid flickering the tooltip on and off when cursors move quickly past the target element.\n\nFocusing the target element shows the tooltip immediately.", "value": { "type": "number", "default": "150" } }, { "name": "hide-delay", "description": "Milliseconds to wait before hiding the tooltip on mouseout.", "value": { "type": "number", "default": "0" } } ], "events": [], "js": { "properties": [ { "name": "for", "description": "ID of the element that triggers the tooltip on hover or focus.", "type": "string" }, { "name": "noArrow", "description": "Hide the arrow pointing toward the tooltip target.", "type": "boolean" }, { "name": "open", "description": "Indicates whether the tooltip is visible or not.", "type": "boolean" }, { "name": "placement", "description": "Sets the placement of the tooltip relative to its target.\n\nThe tooltip will try to position itself at the given placement. If there is no room it will flip to the opposite side automatically.", "type": "'top' | 'bottom' | 'left' | 'right'" }, { "name": "showDelay", "description": "Milliseconds to wait before showing the tooltip on hover.\n\nKeep at a non-zero value to avoid flickering the tooltip on and off when cursors move quickly past the target element.\n\nFocusing the target element shows the tooltip immediately.", "type": "number" }, { "name": "hideDelay", "description": "Milliseconds to wait before hiding the tooltip on mouseout.", "type": "number" } ], "events": [] } }, { "name": "w-textfield", "description": "A single-line input component used for entering and editing textual or numeric data.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)\n---\n\n\n### **Slots:**\n - **suffix** - Use with `<w-affix>` to include a suffix, for example the unit for a number (e. g. km or sek).\n- **prefix** - Use with `<w-affix>` to include a prefix, for example a search icon.", "doc-url": "", "attributes": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Mark the form field as invalid. Make sure to also set a `help-text` to help users fix the validation problem.", "value": { "type": "boolean", "default": "false" } }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "value": { "type": "string | undefined" } }, { "name": "help-text", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "size", "description": "Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs.", "value": { "type": "string | undefined" } }, { "name": "max", "description": "Use with `type=\"number\"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength).", "value": { "type": "number | undefined" } }, { "name": "min", "description": "Use with `type=\"number\"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength).", "value": { "type": "number | undefined" } }, { "name": "min-length", "value": { "type": "number | undefined" } }, { "name": "minlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required.", "value": { "type": "number | undefined" } }, { "name": "max-length", "value": { "type": "number | undefined" } }, { "name": "maxlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed.", "value": { "type": "number | undefined" } }, { "name": "pattern", "description": "Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern)", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Set a text that is shown in the textfield when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "value": { "type": "string | undefined" } }, { "name": "read-only", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether user input is required on the input before form submission.", "value": { "type": "boolean", "default": "false" } }, { "name": "type", "description": "The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Lets you set the current value.", "value": { "type": "string | undefined" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form.", "value": { "type": "string | undefined" } }, { "name": "step", "description": "When used with `number` this attribute forces inputs to be a whole number of `step`.\n\nFor example with a `step=\"5\"` only values that divide evenly on 5 are allowed.\nUsing arrow up and down in the input field increments and decrements by 5.", "value": { "type": "number | undefined" } }, { "name": "autocomplete", "description": "A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill.", "value": { "type": "HTMLInputElement[\"autocomplete\"] | undefined" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } } ], "slots": [ { "name": "suffix", "description": "Use with `<w-affix>` to include a suffix, for example the unit for a number (e. g. km or sek)." }, { "name": "prefix", "description": "Use with `<w-affix>` to include a prefix, for example a search icon." } ], "events": [], "js": { "properties": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "type": "boolean" }, { "name": "invalid", "description": "Mark the form field as invalid. Make sure to also set a `help-text` to help users fix the validation problem.", "type": "boolean" }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "type": "string | undefined" }, { "name": "helpText", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "type": "string | undefined" }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "type": "boolean" }, { "name": "size", "description": "Sets the [size](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#size) (width) of the input field to fit the expected length of inputs.", "type": "string | undefined" }, { "name": "max", "description": "Use with `type=\"number\"` to set the [maximum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength).", "type": "number | undefined" }, { "name": "min", "description": "Use with `type=\"number\"` to set the [minimum allowed value](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength).", "type": "number | undefined" }, { "name": "minLength", "type": "number | undefined" }, { "name": "minlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [minimum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#minlength) required.", "type": "number | undefined" }, { "name": "maxLength", "type": "number | undefined" }, { "name": "maxlength", "description": "For `text`, `search`, `url`, `tel`, `email` and `password` fields, sets the [maximum string length](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#maxlength) allowed.", "type": "number | undefined" }, { "name": "pattern", "description": "Sets a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_expressions) that the input's value must [match to pass validation](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#pattern)", "type": "string | undefined" }, { "name": "placeholder", "description": "Set a text that is shown in the textfield when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "type": "string | undefined" }, { "name": "readOnly", "type": "boolean" }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user.", "type": "boolean" }, { "name": "required", "description": "Whether user input is required on the input before form submission.", "type": "boolean" }, { "name": "type", "description": "The [type of input](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#input_types).", "type": "string | undefined" }, { "name": "value", "description": "Lets you set the current value.", "type": "string | undefined" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form.", "type": "string | undefined" }, { "name": "step", "description": "When used with `number` this attribute forces inputs to be a whole number of `step`.\n\nFor example with a `step=\"5\"` only values that divide evenly on 5 are allowed.\nUsing arrow up and down in the input field increments and decrements by 5.", "type": "number | undefined" }, { "name": "autocomplete", "description": "A space-separated string that hints to browsers [what type of content it can suggest](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Attributes/autocomplete#value) to autofill.", "type": "HTMLInputElement[\"autocomplete\"] | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "formatter", "description": "Function to format value when the input field.\n\nOnly active when the input field does not have focus,\nsimilar to the accessible input [masking example from Filament Group](https://filamentgroup.github.io/politespace/demo/demo.html).", "type": "((value: string) => string) | undefined" } ], "events": [] } }, { "name": "w-affix", "description": "This component is usually used in other components like form elements to show a prefix or suffix. See for example `w-textfield`.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-field/frameworks/elements#prefix-label)\n---\n", "doc-url": "", "attributes": [ { "name": "aria-label", "value": { "type": "string | null", "default": "null" } }, { "name": "clear", "description": "Add this property to render a clickable Warp close icon.\n\nSet an `aria-label` that explains the action when using this.", "value": { "type": "boolean", "default": "false" } }, { "name": "search", "description": "Add this property to render a clickable Warp search icon.", "value": { "type": "boolean", "default": "false" } }, { "name": "label", "value": { "type": "string", "default": "\"\"" } }, { "name": "icon", "value": { "type": "string | null", "default": "null" } } ], "events": [], "js": { "properties": [ { "name": "ariaLabel", "type": "string | null" }, { "name": "clear", "description": "Add this property to render a clickable Warp close icon.\n\nSet an `aria-label` that explains the action when using this.", "type": "boolean" }, { "name": "search", "description": "Add this property to render a clickable Warp search icon.", "type": "boolean" }, { "name": "label", "type": "string" }, { "name": "icon", "type": "string | null" }, { "name": "_icon" } ], "events": [] } }, { "name": "w-alert", "description": "Alert is an inline component used for displaying different types of messages.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/alert/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "variant", "value": { "type": "'negative' | 'positive' | 'warning' | 'info'", "default": "\"info\"" } }, { "name": "show", "value": { "type": "boolean", "default": "false" } }, { "name": "role", "value": { "type": "string", "default": "\"alert\"" } } ], "events": [], "js": { "properties": [ { "name": "variant", "type": "'negative' | 'positive' | 'warning' | 'info'" }, { "name": "show", "type": "boolean" }, { "name": "role", "type": "string" } ], "events": [] } }, { "name": "w-link", "description": "Link component to use when creating links that look like buttons.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/link/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "autofocus", "description": "Focus the link after it is rendered", "value": { "type": "boolean", "default": "false" } }, { "name": "variant", "description": "Visual style for the link/button.", "value": { "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | undefined" } }, { "name": "small", "description": "Render a smaller version", "value": { "type": "boolean", "default": "false" } }, { "name": "href", "description": "The URL the link points to", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Applies disabled styling, but you need to disable clicks on your own.\n\nThe component renders an `<a>` element; `disabled` affects styling, but does not inherently prevent navigation. If you need to fully disable interaction, omit `href` and/or prevent default click behavior.", "value": { "type": "boolean", "default": "false" } }, { "name": "target", "description": "Where to display the linked URL (e.g. `_blank`)", "value": { "type": "string | undefined" } }, { "name": "rel", "description": "Relationship of the linked URL.\n\nIf `target=\"_blank\"` and `rel` is not provided, the component uses `noopener`.", "value": { "type": "string | undefined" } }, { "name": "full-width", "description": "Makes the link take up the full width of its parent", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "autofocus", "description": "Focus the link after it is rendered", "type": "boolean" }, { "name": "variant", "description": "Visual style for the link/button.", "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | undefined" }, { "name": "small", "description": "Render a smaller version", "type": "boolean" }, { "name": "href", "description": "The URL the link points to", "type": "string | undefined" }, { "name": "disabled", "description": "Applies disabled styling, but you need to disable clicks on your own.\n\nThe component renders an `<a>` element; `disabled` affects styling, but does not inherently prevent navigation. If you need to fully disable interaction, omit `href` and/or prevent default click behavior.", "type": "boolean" }, { "name": "target", "description": "Where to display the linked URL (e.g. `_blank`)", "type": "string | undefined" }, { "name": "rel", "description": "Relationship of the linked URL.\n\nIf `target=\"_blank\"` and `rel` is not provided, the component uses `noopener`.", "type": "string | undefined" }, { "name": "fullWidth", "description": "Makes the link take up the full width of its parent", "type": "boolean" } ], "events": [] } }, { "name": "w-button", "description": "Performs an action or renders a link with button styling.\n\nUse button variants to match action priority, risk, and context.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/button/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "type", "description": "Native button type.\nControls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.", "value": { "type": "'button' | 'submit' | 'reset' | undefined" } }, { "name": "autofocus", "description": "Focuses the button when it is first rendered.\nApplies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.", "value": { "type": "boolean", "default": "false" } }, { "name": "variant", "description": "Visual style of the button.\nDefaults to `secondary`. Use the variant that matches the action priority, risk, and placement.", "value": { "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link' | undefined" } }, { "name": "quiet", "description": "Deprecated quiet visual treatment flag\nUse `variant=\"quiet\"` instead.", "value": { "type": "boolean", "default": "false" } }, { "name": "icon-only", "description": "Marks the button as icon-only.\nUse this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.", "value": { "type": "boolean", "default": "false" } }, { "name": "small", "description": "Renders the compact button size.\nUse this in dense layouts where the default button size is too large.", "value": { "type": "boolean", "default": "false" } }, { "name": "loading", "description": "Shows the loading state.\nUse after the user has triggered an action and the action is in progress.", "value": { "type": "boolean", "default": "false" } }, { "name": "href", "description": "URL for rendering the button as a link.\nWhen set, the component renders `w-link` instead of a native `button`.", "value": { "type": "string | undefined" } }, { "name": "target", "description": "Link browsing context.\nPassed to the rendered link when `href` is set.", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Visually disables the button.\nDisabled buttons are discouraged because they can hide the reason an action is unavailable.", "value": { "type": "boolean", "default": "false" } }, { "name": "rel", "description": "Link relationship.\nPassed to the rendered link when `href` is set. If `target=\"_blank\"` is set and `rel` is omitted, `noopener` is used.", "value": { "type": "string | undefined" } }, { "name": "full-width", "description": "Makes the button fill its parent width.\nUseful in narrow layouts where the button should span the available inline space.", "value": { "type": "boolean", "default": "false" } }, { "name": "button-class", "description": "Deprecated class applied to the internal control\nThis class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.", "value": { "type": "string | undefined" } }, { "name": "name", "description": "Form control name.\nUsed when the button participates in form handling.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Form control value.\nUsed with `name` when the button participates in form handling. Resets to its initial value when the form is reset.", "value": { "type": "string | undefined" } }, { "name": "commandfor", "description": "The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "value": { "type": "string | undefined" } }, { "name": "command", "description": "The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "value": { "type": "string | undefined" } } ], "events": [], "js": { "properties": [ { "name": "type", "description": "Native button type.\nControls whether the internal button behaves as a regular button, submits a form, or resets a form. Defaults to `button`.", "type": "'button' | 'submit' | 'reset' | undefined" }, { "name": "autofocus", "description": "Focuses the button when it is first rendered.\nApplies only when the component renders a native button. Link buttons with `href` do not autofocus through this component.", "type": "boolean" }, { "name": "variant", "description": "Visual style of the button.\nDefaults to `secondary`. Use the variant that matches the action priority, risk, and placement.", "type": "'negative' | 'primary' | 'secondary' | 'negativeQuiet' | 'utility' | 'quiet' | 'utilityQuiet' | 'overlay' | 'overlayInverted' | 'overlayQuiet' | 'overlayInvertedQuiet' | 'pill' | 'link' | undefined" }, { "name": "quiet", "description": "Deprecated quiet visual treatment flag\nUse `variant=\"quiet\"` instead.", "type": "boolean" }, { "name": "iconOnly", "description": "Marks the button as icon-only.\nUse this when the button has no visible text. Include accessible text in the slotted content so the internal button has a name.", "type": "boolean" }, { "name": "small", "description": "Renders the compact button size.\nUse this in dense layouts where the default button size is too large.", "type": "boolean" }, { "name": "loading", "description": "Shows the loading state.\nUse after the user has triggered an action and the action is in progress.", "type": "boolean" }, { "name": "href", "description": "URL for rendering the button as a link.\nWhen set, the component renders `w-link` instead of a native `button`.", "type": "string | undefined" }, { "name": "target", "description": "Link browsing context.\nPassed to the rendered link when `href` is set.", "type": "string | undefined" }, { "name": "disabled", "description": "Visually disables the button.\nDisabled buttons are discouraged because they can hide the reason an action is unavailable.", "type": "boolean" }, { "name": "rel", "description": "Link relationship.\nPassed to the rendered link when `href` is set. If `target=\"_blank\"` is set and `rel` is omitted, `noopener` is used.", "type": "string | undefined" }, { "name": "fullWidth", "description": "Makes the button fill its parent width.\nUseful in narrow layouts where the button should span the available inline space.", "type": "boolean" }, { "name": "buttonClass", "description": "Deprecated class applied to the internal control\nThis class is applied inside the shadow DOM and is unlikely to have the desired effect. Use attributes or CSS variables to customize the button appearance.", "type": "string | undefined" }, { "name": "name", "description": "Form control name.\nUsed when the button participates in form handling.", "type": "string | undefined" }, { "name": "value", "description": "Form control value.\nUsed with `name` when the button participates in form handling. Resets to its initial value when the form is reset.", "type": "string | undefined" }, { "name": "commandfor", "description": "The [commandfor HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "type": "string | undefined" }, { "name": "command", "description": "The [command HTML attribute](https://developer.mozilla.org/en-US/docs/Web/API/Invoker_Commands_API#html_attributes) for Invoker Commands.", "type": "string | undefined" } ], "events": [] } }, { "name": "w-attention", "description": "Note: attention will soon be split into multiple components (tooltip, callout, popover, highlight) at which time this component will be deprecated. For now, use the `tooltip`, `callout`, `popover`, and `highlight` boolean properties to achieve the desired style and behavior.\n\nAttention is a versatile component for displaying contextual information and messages. It can be used for a wide range of purposes, such as tooltips, callouts, popovers, and highlights.\n\nThe component is designed to be anchored to a trigger element, providing contextual information related to that element. It supports various placements and styling options to accommodate different use cases and design needs.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tooltip/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "show", "description": "Controls whether the attention panel is visible.\nSet to `true` to show the attention content and `false` to hide it.", "value": { "type": "boolean", "default": "false" } }, { "name": "placement", "description": "Preferred placement relative to the trigger element.\nSets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants.", "value": { "type": "'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end'", "default": "\"bottom\"" } }, { "name": "tooltip", "description": "Renders the component with tooltip styling and behavior.\nUse for compact, non-modal contextual hints anchored to another element.", "value": { "type": "boolean", "default": "false" } }, { "name": "callout", "description": "Renders the component as an inline callout.\nCallout mode is used for always-in-flow informational content instead of floating overlay behavior.", "value": { "type": "boolean", "default": "false" } }, { "name": "popover", "description": "Enables native popover behavior for the attention element.\nWhen enabled, the component uses popover semantics and styling suitable for floating surface UI.", "value": { "type": "boolean", "default": "false" } }, { "name": "highlight", "description": "Renders the component with highlight styling.\nUse highlight mode to visually emphasize important contextual information.", "value": { "type": "boolean", "default": "false" } }, { "name": "can-close", "description": "Shows a close button inside the attention component.\nAdds an internal dismiss action that lets users close the attention panel.", "value": { "type": "boolean", "default": "false" } }, { "name": "no-arrow", "description": "Hides the directional arrow of the attention component.\nDisable the arrow when the visual connection to the trigger should not be shown.", "value": { "type": "boolean", "default": "false" } }, { "name": "distance", "description": "Distance offset between trigger and attention panel.\nDefines the main-axis spacing in pixels from the anchor element.", "value": { "type": "number", "default": "8" } }, { "name": "skidding", "description": "Cross-axis offset for fine-grained positioning.\nMoves the panel along the cross axis in pixels to adjust alignment with the trigger.", "value": { "type": "number", "default": "0" } }, { "name": "flip", "description": "Enables automatic flipping when placement has no space.\nAllows the component to choose an alternative side if the preferred placement would overflow.", "value": { "type": "boolean", "default": "false" } }, { "name": "cross-axis", "description": "Allows overflow checks on the cross axis when flipping.\nUse with `flip` to improve collision handling when space is constrained horizontally or vertically.", "value": { "type": "boolean", "default": "false" } }, { "name": "fallback-placements", "description": "Ordered list of fallback placements.\nProvides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit.", "value": { "type": "Directions[]", "default": "[]" } } ], "events": [], "js": { "properties": [ { "name": "show", "description": "Controls whether the attention panel is visible.\nSet to `true` to show the attention content and `false` to hide it.", "type": "boolean" }, { "name": "placement", "description": "Preferred placement relative to the trigger element.\nSets the initial direction for positioning, for example `top`, `right`, `bottom`, or `left` variants.", "type": "'top' | 'bottom' | 'left' | 'right' | 'top-start' | 'top-end' | 'right-start' | 'right-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end'" }, { "name": "tooltip", "description": "Renders the component with tooltip styling and behavior.\nUse for compact, non-modal contextual hints anchored to another element.", "type": "boolean" }, { "name": "callout", "description": "Renders the component as an inline callout.\nCallout mode is used for always-in-flow informational content instead of floating overlay behavior.", "type": "boolean" }, { "name": "popover", "description": "Enables native popover behavior for the attention element.\nWhen enabled, the component uses popover semantics and styling suitable for floating surface UI.", "type": "boolean" }, { "name": "highlight", "description": "Renders the component with highlight styling.\nUse highlight mode to visually emphasize important contextual information.", "type": "boolean" }, { "name": "canClose", "description": "Shows a close button inside the attention component.\nAdds an internal dismiss action that lets users close the attention panel.", "type": "boolean" }, { "name": "noArrow", "description": "Hides the directional arrow of the attention component.\nDisable the arrow when the visual connection to the trigger should not be shown.", "type": "boolean" }, { "name": "distance", "description": "Distance offset between trigger and attention panel.\nDefines the main-axis spacing in pixels from the anchor element.", "type": "number" }, { "name": "skidding", "description": "Cross-axis offset for fine-grained positioning.\nMoves the panel along the cross axis in pixels to adjust alignment with the trigger.", "type": "number" }, { "name": "flip", "description": "Enables automatic flipping when placement has no space.\nAllows the component to choose an alternative side if the preferred placement would overflow.", "type": "boolean" }, { "name": "crossAxis", "description": "Allows overflow checks on the cross axis when flipping.\nUse with `flip` to improve collision handling when space is constrained horizontally or vertically.", "type": "boolean" }, { "name": "fallbackPlacements", "description": "Ordered list of fallback placements.\nProvides explicit alternative placements to try when `flip` is enabled and the preferred placement does not fit.", "type": "Directions[]" }, { "name": "_initialPlacement" }, { "name": "_actualDirection" } ], "events": [] } }, { "name": "w-badge", "description": "`w-badge` is used for showing a small amount of non-interactive color-categorized metadata, like a status or count.\n---\n\n\n### **Slots:**\n - _default_ - The content of the badge, which is typically a short string like \"New\" or \"4\".", "doc-url": "", "attributes": [ { "name": "variant", "description": "Controls the badge color treatment.\nIf omitted, the badge uses neutral styling without reflecting a `variant` attribute.\nAccepted values are `neutral`, `info`, `positive`, `warning`, `negative`, `disabled`, `price`, and `sponsored`. If omitted, the badge uses neutral styling without reflecting a `variant` attribute.", "value": { "type": "'neutral' | 'info' | 'positive' | 'warning' | 'negative' | 'disabled' | 'price' | 'sponsored' | undefined", "default": "\"neutral\"" } }, { "name": "position", "description": "Positions the badge in a corner of a parent element.\nUse this with a parent element that has `position: relative`. When set, the badge uses absolute positioning and adjusts its corner radii so it sits flush against the selected corner.\nUse this with a parent element that has `position: relative`. Accepted values are `top-left`, `top-right`, `bottom-right`, and `bottom-left`.", "value": { "type": "\"top-left\" | \"top-right\" | \"bottom-right\" | \"bottom-left\" | undefined" } } ], "slots": [ { "name": "", "description": "The content of the badge, which is typically a short string like \"New\" or \"4\"." } ], "events": [], "js": { "properties": [ { "name": "variant", "description": "Controls the badge color treatment.\nIf omitted, the badge uses neutral styling without reflecting a `variant` attribute.\nAccepted values are `neutral`, `info`, `positive`, `warning`, `negative`, `disabled`, `price`, and `sponsored`. If omitted, the badge uses neutral styling without reflecting a `variant` attribute.", "type": "'neutral' | 'info' | 'positive' | 'warning' | 'negative' | 'disabled' | 'price' | 'sponsored' | undefined" }, { "name": "position", "description": "Positions the badge in a corner of a parent element.\nUse this with a parent element that has `position: relative`. When set, the badge uses absolute positioning and adjusts its corner radii so it sits flush against the selected corner.\nUse this with a parent element that has `position: relative`. Accepted values are `top-left`, `top-right`, `bottom-right`, and `bottom-left`.", "type": "\"top-left\" | \"top-right\" | \"bottom-right\" | \"bottom-left\" | undefined" } ], "events": [] } }, { "name": "w-box", "description": "Box is a layout component used for separating content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/box/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "bleed", "description": "Makes the box bleed to the container edge.\nExtends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up.", "value": { "type": "boolean", "default": "false" } }, { "name": "bordered", "description": "Shows the box as a bordered surface.\nUse this when the content needs a clear visual boundary from the surrounding page.", "value": { "type": "boolean", "default": "false" } }, { "name": "info", "description": "Shows the box with information styling.\nUse this for supporting informational content that should be visually separated from the surrounding page.", "value": { "type": "boolean", "default": "false" } }, { "name": "neutral", "description": "Shows the box with neutral styling.\nUse this for quiet grouped content that needs a background without strong emphasis.", "value": { "type": "boolean", "default": "false" } }, { "name": "role", "description": "ARIA role for the box wrapper.\nDefaults to a role of `region`. Set `role=\"none\"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose.", "value": { "type": "string", "default": "\"region\"" } } ], "events": [], "js": { "properties": [ { "name": "bleed", "description": "Makes the box bleed to the container edge.\nExtends the box into the horizontal gutter on narrow screens. Adds negative horizontal margins and square side corners below the small breakpoint, then restores the normal margins and rounded corners from the small breakpoint and up.", "type": "boolean" }, { "name": "bordered", "description": "Shows the box as a bordered surface.\nUse this when the content needs a clear visual boundary from the surrounding page.", "type": "boolean" }, { "name": "info", "description": "Shows the box with information styling.\nUse this for supporting informational content that should be visually separated from the surrounding page.", "type": "boolean" }, { "name": "neutral", "description": "Shows the box with neutral styling.\nUse this for quiet grouped content that needs a background without strong emphasis.", "type": "boolean" }, { "name": "role", "description": "ARIA role for the box wrapper.\nDefaults to a role of `region`. Set `role=\"none\"` to override this behaviour for purely visual grouping, or set a specific role when the box has a clearer semantic purpose.", "type": "string" } ], "events": [] } }, { "name": "w-breadcrumb-item", "description": "Represents one item in a `w-breadcrumbs` trail.\nRenders the slotted label as a link when `href` is set, or as text when it is not, and adds a separator after non-current items.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)\n---\n\n\n### **Slots:**\n - _default_ - The breadcrumb label content.", "doc-url": "", "attributes": [ { "name": "current-page", "description": "Marks this item as the current page.\nUse this on the final breadcrumb item so it exposes `aria-current=\"page\"` and does not render a trailing separator.", "value": { "type": "boolean", "default": "false" } }, { "name": "href", "description": "URL for linked breadcrumb items.\nWhen omitted, the item renders as non-focusable text.", "value": { "type": "string | null", "default": "null" } } ], "slots": [ { "name": "", "description": "The breadcrumb label content." } ], "events": [], "js": { "properties": [ { "name": "currentPage", "description": "Marks this item as the current page.\nUse this on the final breadcrumb item so it exposes `aria-current=\"page\"` and does not render a trailing separator.", "type": "boolean" }, { "name": "href", "description": "URL for linked breadcrumb items.\nWhen omitted, the item renders as non-focusable text.", "type": "string | null" } ], "events": [] } }, { "name": "w-breadcrumbs", "description": "Shows the navigation structure for the current page.\n\nRenders direct child links and non-link elements as a breadcrumb trail, inserts separators between items, and exposes the trail as navigation.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/breadcrumbs/frameworks/elements)\n---\n", "doc-url": "", "attributes": [], "events": [], "js": { "properties": [ { "name": "ariaLabel", "description": "Accessible label for the breadcrumb navigation.\nDefaults to the localized \"You are here\" label. Set `aria-label` when the default label is not specific enough for the page.", "type": "string | null" } ], "events": [] } }, { "name": "w-card", "description": "Card is a layout component used for grouping interactive content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/card/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "selected", "description": "Whether the card is visually selected.\n\nUse this when the card represents a selected item or choice. This only controls the visual selected state; update it from your application state when the selection changes.", "value": { "type": "boolean", "default": "false" } }, { "name": "flat", "description": "Whether the card uses the flat visual treatment.\n\nFlat cards use a bordered surface instead of the default elevated surface. Use this for denser layouts or when the card sits inside another surface.", "value": { "type": "boolean", "default": "false" } }, { "name": "clickable", "description": "Whether the whole card is interactive.\n\nWhen set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "selected", "description": "Whether the card is visually selected.\n\nUse this when the card represents a selected item or choice. This only controls the visual selected state; update it from your application state when the selection changes.", "type": "boolean" }, { "name": "flat", "description": "Whether the card uses the flat visual treatment.\n\nFlat cards use a bordered surface instead of the default elevated surface. Use this for denser layouts or when the card sits inside another surface.", "type": "boolean" }, { "name": "clickable", "description": "Whether the whole card is interactive.\n\nWhen set, the card becomes keyboard focusable and Enter or Space triggers a click on the card. Use this only when the whole card has one action or represents one selectable choice.", "type": "boolean" } ], "events": [] } }, { "name": "w-checkbox", "description": "Checkboxes allow users to select one or more options from a number of choices.\n\nWrap individual checkboxes in a checkbox group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the checkbox passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the browser's validation message if invalid", "doc-url": "", "attributes": [ { "name": "name", "description": "The name of the checkbox.\n\nWhen the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "The value submitted when the checkbox is checked.\n\nIf no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.", "value": { "type": "string | null", "default": "null" } }, { "name": "indeterminate", "description": "Whether the checkbox is visually indeterminate.\n\nUse this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.", "value": { "type": "boolean", "default": "false" } }, { "name": "checked", "description": "Whether the checkbox is checked.\n\nChecked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.", "value": { "type": "boolean", "default": "false" } }, { "name": "disabled", "description": "Whether the checkbox is disabled.\n\nDisabled checkboxes cannot be focused, changed, or submitted with form data.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether the checkbox must be checked before form submission.\n\nA required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Whether the checkbox is visually invalid.\n\nUse this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "input", "type": "HTMLInputElement" }, { "name": "name", "description": "The name of the checkbox.\n\nWhen the checkbox is checked and belongs to a form, this name is submitted with the checkbox value. If the checkbox is inside a `w-checkbox-group` with a name, the group name is used when the checkbox does not have its own name.", "type": "string | undefined" }, { "name": "value", "description": "The value submitted when the checkbox is checked.\n\nIf no value attribute is set, the checkbox defaults to `on`. Unchecked and disabled checkboxes do not submit a value.", "type": "string | null" }, { "name": "indeterminate", "description": "Whether the checkbox is visually indeterminate.\n\nUse this for parent options that represent a mixed set of child selections. Clicking the checkbox clears the indeterminate state and sets the checkbox to checked.", "type": "boolean" }, { "name": "checked", "description": "Whether the checkbox is checked.\n\nChecked checkboxes submit their value with form data. The property is reflected to the `checked` attribute.", "type": "boolean" }, { "name": "disabled", "description": "Whether the checkbox is disabled.\n\nDisabled checkboxes cannot be focused, changed, or submitted with form data.", "type": "boolean" }, { "name": "required", "description": "Whether the checkbox must be checked before form submission.\n\nA required checkbox is invalid until it is checked. For requiring at least one option in a set, use `required` on `w-checkbox-group`.", "type": "boolean" }, { "name": "invalid", "description": "Whether the checkbox is visually invalid.\n\nUse this to show an externally managed validation error. Required validation also sets the invalid state after the user interacts with the checkbox or tries to submit the form.", "type": "boolean" }, { "name": "_computedInvalid", "description": "Computed invalid state: combines own invalid with group invalid", "type": "boolean" }, { "name": "validationMessage", "description": "Returns the validation message if the checkbox is invalid, otherwise an empty string", "type": "string" }, { "name": "validity", "description": "Returns the validity state of the checkbox", "type": "ValidityState" } ], "events": [] } }, { "name": "w-checkbox-group", "description": "Checkboxes allow users to select one or more options from a number of choices.\n\nWrap individual checkboxes in a checkbox group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/checkbox/frameworks/elements)\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the group passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the validation message if invalid\n- **focus(options: _FocusOptions_)** - Sets focus on the checkbox group.", "doc-url": "", "attributes": [ { "name": "label", "description": "The group label displayed above the checkboxes.\n\nUse this to describe the shared question or topic for the checkbox options. The label is connected to the internal group for assistive technologies.", "value": { "type": "string | undefined" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "name", "description": "The name applied to child checkboxes when they do not provide one.\n\nUse this when the grouped checkboxes should submit values under the same form field name. Individual checkboxes can still override the group name with their own `name`.", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that selecting an option from the group is not required.", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "Help text displayed below the checkbox group.\n\nUse this for supporting guidance or validation feedback. When required validation fails, the group replaces this text with the localized required message.", "value": { "type": "string | undefined" } }, { "name": "required", "description": "Whether at least one checkbox in the group must be selected.\n\nRequired validation is managed by the group. The individual checkboxes provide the submitted form values.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Whether the checkbox group is visually invalid.\n\nUse this to show an externally managed validation error for the group. The invalid state is also shared with child checkboxes for consistent styling and accessibility state.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "label", "description": "The group label displayed above the checkboxes.\n\nUse this to describe the shared question or topic for the checkbox options. The label is connected to the internal group for assistive technologies.", "type": "string | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "name", "description": "The name applied to child checkboxes when they do not provide one.\n\nUse this when the grouped checkboxes should submit values under the same form field name. Individual checkboxes can still override the group name with their own `name`.", "type": "string | undefined" }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that selecting an option from the group is not required.", "type": "boolean" }, { "name": "helpText", "description": "Help text displayed below the checkbox group.\n\nUse this for supporting guidance or validation feedback. When required validation fails, the group replaces this text with the localized required message.", "type": "string | undefined" }, { "name": "required", "description": "Whether at least one checkbox in the group must be selected.\n\nRequired validation is managed by the group. The individual checkboxes provide the submitted form values.", "type": "boolean" }, { "name": "invalid", "description": "Whether the checkbox group is visually invalid.\n\nUse this to show an externally managed validation error for the group. The invalid state is also shared with child checkboxes for consistent styling and accessibility state.", "type": "boolean" } ], "events": [] } }, { "name": "w-combobox", "description": "A combobox element for text input with selectable options.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/combo-box/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "options", "description": "The available options to select from.\n\nUse this for framework usage, application state, or remote search results. When `options` contains entries, it is used instead of child `<option>` elements.", "value": { "type": "ComboboxOption[]", "default": "[]" } }, { "name": "label", "description": "The label displayed above the input.\n\nUse this to give the combobox a visible and accessible name.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Placeholder text displayed when the input is empty.\n\nUse this as a short hint for the expected input. Do not use placeholder text as a replacement for a label.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "value", "description": "The selected or typed value.\n\nWhen an option is selected, this is set to the option value. The displayed text may differ when the option has a separate label.", "value": { "type": "string", "default": "\"\"" } }, { "name": "open-on-focus", "description": "Whether the option list opens when the input receives focus.\n\nUse this when users should see available options before they start typing.", "value": { "type": "boolean", "default": "false" } }, { "name": "select-on-blur", "description": "Whether the active option is selected when the input loses focus.\n\nWhen enabled, the combobox selects the keyboard-highlighted option, or an option whose value exactly matches the current input value, on blur.", "value": { "type": "boolean", "default": "true" } }, { "name": "match-text-segments", "description": "Whether matching text segments in options are highlighted.\n\nUse this to visually emphasize the part of each option that matches the current input value.", "value": { "type": "boolean", "default": "false" } }, { "name": "disable-static-filtering", "description": "Whether built-in client-side filtering is disabled.\n\nUse this for remote search or externally filtered results. When disabled, all entries in `options` are rendered as provided.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Whether the combobox is visually invalid.\n\nUse this to show an externally managed validation error. Pair it with `help-text` to explain how to fix the error.", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "Help text displayed below the input.\n\nUse this for supporting guidance or validation feedback.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "disabled", "description": "Whether the combobox is disabled.\n\nDisabled comboboxes cannot be focused, changed, or submitted with form data.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether the combobox is required before form submission.\n\nUse this when the user must provide a value before submitting the form.", "value": { "type": "boolean", "default": "false" } }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that the combobox is not required.", "value": { "type": "boolean", "default": "false" } }, { "name": "name", "description": "The name submitted with the combobox value.\n\nUse this when the combobox belongs to a form and its value should be included in form data.", "value": { "type": "string | undefined", "default": "\"\"" } }, { "name": "autocomplete", "description": "The autocomplete attribute passed to the internal input.\n\nDefaults to `off`. Set this when browser autocomplete should be enabled or scoped to a specific autocomplete token.", "value": { "type": "string | undefined", "default": "\"off\"" } } ], "events": [], "js": { "properties": [ { "name": "options", "description": "The available options to select from.\n\nUse this for framework usage, application state, or remote search results. When `options` contains entries, it is used instead of child `<option>` elements.", "type": "ComboboxOption[]" }, { "name": "label", "description": "The label displayed above the input.\n\nUse this to give the combobox a visible and accessible name.", "type": "string | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "placeholder", "description": "Placeholder text displayed when the input is empty.\n\nUse this as a short hint for the expected input. Do not use placeholder text as a replacement for a label.", "type": "string | undefined" }, { "name": "value", "description": "The selected or typed value.\n\nWhen an option is selected, this is set to the option value. The displayed text may differ when the option has a separate label.", "type": "string" }, { "name": "openOnFocus", "description": "Whether the option list opens when the input receives focus.\n\nUse this when users should see available options before they start typing.", "type": "boolean" }, { "name": "selectOnBlur", "description": "Whether the active option is selected when the input loses focus.\n\nWhen enabled, the combobox selects the keyboard-highlighted option, or an option whose value exactly matches the current input value, on blur.", "type": "boolean" }, { "name": "matchTextSegments", "description": "Whether matching text segments in options are highlighted.\n\nUse this to visually emphasize the part of each option that matches the current input value.", "type": "boolean" }, { "name": "disableStaticFiltering", "description": "Whether built-in client-side filtering is disabled.\n\nUse this for remote search or externally filtered results. When disabled, all entries in `options` are rendered as provided.", "type": "boolean" }, { "name": "invalid", "description": "Whether the combobox is visually invalid.\n\nUse this to show an externally managed validation error. Pair it with `help-text` to explain how to fix the error.", "type": "boolean" }, { "name": "helpText", "description": "Help text displayed below the input.\n\nUse this for supporting guidance or validation feedback.", "type": "string | undefined" }, { "name": "disabled", "description": "Whether the combobox is disabled.\n\nDisabled comboboxes cannot be focused, changed, or submitted with form data.", "type": "boolean" }, { "name": "required", "description": "Whether the combobox is required before form submission.\n\nUse this when the user must provide a value before submitting the form.", "type": "boolean" }, { "name": "optional", "description": "Whether to show optional text next to the label.\n\nUse this to indicate that the combobox is not required.", "type": "boolean" }, { "name": "name", "description": "The name submitted with the combobox value.\n\nUse this when the combobox belongs to a form and its value should be included in form data.", "type": "string | undefined" }, { "name": "autocomplete", "description": "The autocomplete attribute passed to the internal input.\n\nDefaults to `off`. Set this when browser autocomplete should be enabled or scoped to a specific autocomplete token.", "type": "string | undefined" } ], "events": [] } }, { "name": "w-datepicker", "description": "A date picker allows the user to select a specific calendar date.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/date-picker/frameworks/elements)\n---\n\n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the textarea passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the browser's validation message if invalid\n- **setCustomValidity(message: _string_): _void_** - Sets a custom validation message. Pass an empty string to clear.", "doc-url": "", "attributes": [ { "name": "label", "description": "The label displayed above the date input.\n\nUse this to give the datepicker a visible and accessible name.", "value": { "type": "string | undefined" } }, { "name": "required", "description": "Whether user input is required on the input before form submission", "value": { "type": "boolean", "default": "false" } }, { "name": "optional", "description": "Indicate visually that the field is optional", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "lang", "description": "The locale used for calendar labels and date formatting.\n\nThis takes precedence over the `<html>` `lang` attribute. Supported built-in locales are `en`, `nb`, `sv`, `da`, and `fi`.", "value": { "type": "string" } }, { "name": "name", "description": "The name submitted with the date value.\n\nUse this when the datepicker belongs to a form and its value should be included in form data.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "The selected date value.\n\nUse an ISO date string in `YYYY-MM-DD` format. The value is submitted with the form and is reset to its initial value when the form resets.", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "value": { "type": "boolean", "default": "false" } }, { "name": "header-format", "description": "The date format used in the calendar header.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "value": { "type": "string", "default": "\"MMMM yyyy\"" } }, { "name": "weekday-format", "description": "The weekday format shown above the calendar grid.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "value": { "type": "string", "default": "\"EEEEEE\"" } }, { "name": "day-format", "description": "The date format used for calendar day accessible names.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "value": { "type": "string", "default": "\"PPPP\"" } } ], "events": [], "js": { "properties": [ { "name": "label", "description": "The label displayed above the date input.\n\nUse this to give the datepicker a visible and accessible name.", "type": "string | undefined" }, { "name": "required", "description": "Whether user input is required on the input before form submission", "type": "boolean" }, { "name": "optional", "description": "Indicate visually that the field is optional", "type": "boolean" }, { "name": "helpText", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "type": "string | undefined" }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "lang", "description": "The locale used for calendar labels and date formatting.\n\nThis takes precedence over the `<html>` `lang` attribute. Supported built-in locales are `en`, `nb`, `sv`, `da`, and `fi`.", "type": "string" }, { "name": "name", "description": "The name submitted with the date value.\n\nUse this when the datepicker belongs to a form and its value should be included in form data.", "type": "string | undefined" }, { "name": "value", "description": "The selected date value.\n\nUse an ISO date string in `YYYY-MM-DD` format. The value is submitted with the form and is reset to its initial value when the form resets.", "type": "string | undefined" }, { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "type": "boolean" }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "type": "boolean" }, { "name": "headerFormat", "description": "The date format used in the calendar header.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "type": "string" }, { "name": "weekdayFormat", "description": "The weekday format shown above the calendar grid.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "type": "string" }, { "name": "isDayDisabled", "description": "Function used to disable dates in the calendar.\n\nSet this on the element instance in JavaScript, not as an HTML attribute. Disabled dates cannot be selected from the calendar.", "type": "((day: Date) => boolean) | undefined" }, { "name": "dayFormat", "description": "The date format used for calendar day accessible names.\n\nThe syntax is defined by [date-fns/format](https://date-fns.org/v4.1.0/docs/format).", "type": "string" }, { "name": "isCalendarOpen", "type": "boolean" }, { "name": "navigationDate", "type": "Date" }, { "name": "selectedDate", "type": "Date | null" }, { "name": "month" }, { "name": "weeks" }, { "name": "calendar", "type": "HTMLDivElement" }, { "name": "input", "type": "HTMLInputElement" }, { "name": "toggleButton", "type": "HTMLButtonElement" }, { "name": "wrapper", "type": "HTMLDivElement" }, { "name": "previousMonthButton", "description": "This is the first focusable element, needed for the modal focus trap.\n\nDon't cache this and other `@query` fields from inside the calendar modal.\nThey work the first time, but once the calendar is closed and reopened\nthe query will point to an element that doesn't exist anymore.", "type": "HTMLButtonElement" }, { "name": "todayCell", "type": "HTMLTableCellElement" }, { "name": "selectedCell", "type": "HTMLTableCellElement" }, { "name": "validationMessage", "description": "Returns the validation message if the textarea is invalid, otherwise an empty string", "type": "string" }, { "name": "validity", "description": "Returns the validity state of the textarea", "type": "ValidityState" } ], "events": [] } }, { "name": "w-expandable", "description": "Expandable is a layout component used for creating expandable content areas on a page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/expandable/frameworks/elements)\n---\n\n\n### **Slots:**\n - **title** - Alternative to the `title` attribute should you need to provide some additional markup.\n\n### **CSS Parts:**\n - **base** - the root wrapper element inside the component.\n- **chevron** - the chevron container.", "doc-url": "", "attributes": [ { "name": "expanded", "description": "Controls component's expanded state", "value": { "type": "boolean", "default": "false" } }, { "name": "title", "description": "Component title. Used to display the title value which is always present regardless of whether the component is open or closed.", "value": { "type": "string" } }, { "name": "box", "description": "Will make the expandable a Box", "value": { "type": "boolean", "default": "false" } }, { "name": "bleed", "description": "Will make the expandable full-width on the sm breakpoint size", "value": { "type": "boolean", "default": "false" } }, { "name": "button-class", "value": { "type": "string | undefined" } }, { "name": "content-class", "value": { "type": "string | undefined" } }, { "name": "no-chevron", "description": "Controls chevron visibility", "value": { "type": "boolean", "default": "false" } }, { "name": "animated", "description": "Will animate the expansion/collapse", "value": { "type": "boolean", "default": "false" } }, { "name": "heading-level", "description": "Wrap the toggle button in a heading element with the specified level. If headingLevel is not specified, the button will not be wrapped by a heading element.", "value": { "type": "number | undefined" } }, { "name": "_hasTitle", "value": { "type": "boolean", "default": "true" } }, { "name": "_showChevronUp", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "title", "description": "Alternative to the `title` attribute should you need to provide some additional markup." } ], "events": [], "js": { "properties": [ { "name": "expanded", "description": "Controls component's expanded state", "type": "boolean" }, { "name": "title", "description": "Component title. Used to display the title value which is always present regardless of whether the component is open or closed.", "type": "string" }, { "name": "box", "description": "Will make the expandable a Box", "type": "boolean" }, { "name": "bleed", "description": "Will make the expandable full-width on the sm breakpoint size", "type": "boolean" }, { "name": "buttonClass", "type": "string | undefined" }, { "name": "contentClass", "type": "string | undefined" }, { "name": "noChevron", "description": "Controls chevron visibility", "type": "boolean" }, { "name": "animated", "description": "Will animate the expansion/collapse", "type": "boolean" }, { "name": "headingLevel", "description": "Wrap the toggle button in a heading element with the specified level. If headingLevel is not specified, the button will not be wrapped by a heading element.", "type": "number | undefined" } ], "events": [] } }, { "name": "w-modal", "description": "Modals (or dialogs) display important information that users need to acknowledge.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)\n---\n\n\n### **Events:**\n - **shown**\n- **hidden**\n\n### **Slots:**\n - **header** - Typically where you would use the `w-modal-header` component.\n- **content** - The main content of the modal.\n- **footer** - Typically where you would use the `w-modal-footer` component, for things like actions.\n\n### **CSS Properties:**\n - **--w-c-modal-backdrop-color** - undefined _(default: undefined)_\n- **--w-c-modal-bg** - undefined _(default: undefined)_\n- **--w-c-modal-box-shadow** - undefined _(default: undefined)_\n- **--w-c-modal-color** - undefined _(default: undefined)_\n- **--w-c-modal-height** - undefined _(default: undefined)_\n- **--w-c-modal-max-height** - undefined _(default: undefined)_\n- **--w-c-modal-min-height** - undefined _(default: undefined)_\n- **--w-c-modal-translate-distance** - undefined _(default: undefined)_\n- **--w-c-modal-padding-bottom** - undefined _(default: undefined)_\n- **--w-c-modal-width** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **dialog** - the root element inside the component (`<dialog>` element).\n- **wrapper** - container for all elements, direct child of `<dialog>`.\n- **content** - the container for the `content` slot items (children).", "doc-url": "", "attributes": [ { "name": "show", "description": "Controls if the modal should show or hide.\n\nYou can also call the `open()` and `close()` methods.", "value": { "type": "boolean", "default": "false" } }, { "name": "content-id", "value": { "type": "string | undefined" } }, { "name": "ignore-backdrop-clicks", "description": "Ignores clicks to the backdrop when set", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "header", "description": "Typically where you would use the `w-modal-header` component." }, { "name": "content", "description": "The main content of the modal." }, { "name": "footer", "description": "Typically where you would use the `w-modal-footer` component, for things like actions." } ], "events": [ { "name": "shown", "type": "CustomEvent" }, { "name": "hidden", "type": "CustomEvent" } ], "js": { "properties": [ { "name": "show", "description": "Controls if the modal should show or hide.\n\nYou can also call the `open()` and `close()` methods.", "type": "boolean" }, { "name": "contentId", "type": "string | undefined" }, { "name": "ignoreBackdropClicks", "description": "Ignores clicks to the backdrop when set", "type": "boolean" } ], "events": [ { "name": "shown", "type": "CustomEvent" }, { "name": "hidden", "type": "CustomEvent" } ] } }, { "name": "w-modal-footer", "description": "The footer section of a modal, typically where you place actions.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)\n---\n\n\n### **CSS Properties:**\n - **--w-c-modal-footer-gap** - adjusts the flex gap between actions in the footer. _(default: undefined)_\n\n### **CSS Parts:**\n - **footer** - the container for slotted items (children).", "doc-url": "", "attributes": [], "events": [], "js": { "properties": [], "events": [] } }, { "name": "w-modal-header", "description": "The header section of a modal, typically where you place the title and a close button.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/modal/frameworks/elements)\n---\n\n\n### **Events:**\n - **backClicked**\n\n### **Slots:**\n - **top** - Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example.\n\n### **CSS Properties:**\n - **--w-c-modal-header-font-size** - undefined _(default: undefined)_\n- **--w-c-modal-header-line-height** - undefined _(default: undefined)_\n- **--w-c-modal-header-margin-bottom** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **header** - the root element inside the component.\n- **top** - the container for the image (`top` slot).\n- **back** - the back button, if visible.\n- **title** - the title element.\n- **close** - the close button, if visible.", "doc-url": "", "attributes": [ { "name": "title", "description": "A short but descriptive title for the modal", "value": { "type": "string" } }, { "name": "back", "description": "Whether the modal header should have a back button", "value": { "type": "boolean", "default": "false" } }, { "name": "no-close", "description": "Lets you hide the close button in the header", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "top", "description": "Customize the title bar, for example to have a header image that reaches the modal's edges. See the With Image story for an example." } ], "events": [{ "name": "backClicked", "type": "CustomEvent" }], "js": { "properties": [ { "name": "title", "description": "A short but descriptive title for the modal", "type": "string" }, { "name": "back", "description": "Whether the modal header should have a back button", "type": "boolean" }, { "name": "noClose", "description": "Lets you hide the close button in the header", "type": "boolean" } ], "events": [{ "name": "backClicked", "type": "CustomEvent" }] } }, { "name": "w-page-indicator", "description": "A page indicator component that displays a series of dots representing pages.\n\nOne dot is highlighted to indicate the currently selected page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/page-indicator/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "selected-page", "description": "Currently selected page (1-based index)", "value": { "type": "number", "default": "1" } }, { "name": "page-count", "description": "Total number of pages", "value": { "type": "number", "default": "1" } } ], "events": [], "js": { "properties": [ { "name": "selectedPage", "description": "Currently selected page (1-based index)", "type": "number" }, { "name": "pageCount", "description": "Total number of pages", "type": "number" } ], "events": [] } }, { "name": "w-pagination", "description": "Pagination allows users to navigate through multiple pages of content by providing navigation controls with page numbers and directional arrows.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/pagination/frameworks/elements)\n---\n\n\n### **Events:**\n - **page-click** - Triggered when a link in the pagination is clicked. Contains the page number in `string` form.", "doc-url": "", "attributes": [ { "name": "base-url", "description": "The base URL used to construct page links, for example `/search?page=`.\n\nThe page number is appended to this URL.", "value": { "type": "string | undefined" } }, { "name": "pages", "description": "The total number of pages.", "value": { "type": "number", "default": "0" } }, { "name": "current-page", "description": "The currently active page number.", "value": { "type": "number", "default": "1" } }, { "name": "visible-pages", "description": "The maximum number of page numbers visible.", "value": { "type": "number", "default": "7" } } ], "events": [ { "name": "page-click", "type": "CustomEvent", "description": "Triggered when a link in the pagination is clicked. Contains the page number in `string` form." } ], "js": { "properties": [ { "name": "baseUrl", "description": "The base URL used to construct page links, for example `/search?page=`.\n\nThe page number is appended to this URL.", "type": "string | undefined" }, { "name": "pages", "description": "The total number of pages.", "type": "number" }, { "name": "currentPageNumber", "description": "The currently active page number.", "type": "number" }, { "name": "visiblePages", "description": "The maximum number of page numbers visible.", "type": "number" } ], "events": [ { "name": "page-click", "type": "CustomEvent", "description": "Triggered when a link in the pagination is clicked. Contains the page number in `string` form." } ] } }, { "name": "w-pill", "description": "Pill is a type of button that is often used as a filter, but can also be used as a rounded button for overlays, etc.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/pill/frameworks/elements)\n---\n\n\n### **Events:**\n - **w-pill-click** - Fires when the pill itself is clicked.\n- **w-pill-close** - Fires when the pill's close button is clicked.", "doc-url": "", "attributes": [ { "name": "can-close", "description": "Whether the pill should be removable via a close button.", "value": { "type": "boolean", "default": "false" } }, { "name": "suggestion", "description": "Whether the pill should be rendered as a suggestion.", "value": { "type": "boolean", "default": "false" } }, { "name": "open-sr-label", "value": { "type": "string | undefined" } }, { "name": "open-aria-label", "description": "Label read by screen readers when targeting the pill.", "value": { "type": "string | undefined" } }, { "name": "close-sr-label", "value": { "type": "string | undefined" } }, { "name": "close-aria-label", "description": "Label read by screen readers when targeting the close button.", "value": { "type": "string | undefined" } } ], "events": [ { "name": "w-pill-click", "type": "CustomEvent", "description": "Fires when the pill itself is clicked." }, { "name": "w-pill-close", "type": "CustomEvent", "description": "Fires when the pill's close button is clicked." } ], "js": { "properties": [ { "name": "canClose", "description": "Whether the pill should be removable via a close button.", "type": "boolean" }, { "name": "suggestion", "description": "Whether the pill should be rendered as a suggestion.", "type": "boolean" }, { "name": "openSrLabel", "type": "string | undefined" }, { "name": "openAriaLabel", "description": "Label read by screen readers when targeting the pill.", "type": "string | undefined" }, { "name": "closeSrLabel", "type": "string | undefined" }, { "name": "closeAriaLabel", "description": "Label read by screen readers when targeting the close button.", "type": "string | undefined" } ], "events": [ { "name": "w-pill-click", "type": "CustomEvent", "description": "Fires when the pill itself is clicked." }, { "name": "w-pill-close", "type": "CustomEvent", "description": "Fires when the pill's close button is clicked." } ] } }, { "name": "w-radio", "description": "Radios allow users to select a single option from a list of choices.\n\nWrap individual radio components in a radio group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "name", "description": "The name of the radio, submitted as a name/value pair with form data.", "value": { "type": "string" } }, { "name": "value", "description": "The radio's value. When selected, the radio group will receive this value.", "value": { "type": "string | null", "default": "null" } }, { "name": "checked", "description": "Draws the radio in a checked state (reflected to attribute).", "value": { "type": "boolean", "default": "false" } }, { "name": "disabled", "description": "Disables the radio.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Makes the radio a required field.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Draws the radio in an invalid state.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "name", "description": "The name of the radio, submitted as a name/value pair with form data.", "type": "string" }, { "name": "value", "description": "The radio's value. When selected, the radio group will receive this value.", "type": "string | null" }, { "name": "checked", "description": "Draws the radio in a checked state (reflected to attribute).", "type": "boolean" }, { "name": "disabled", "description": "Disables the radio.", "type": "boolean" }, { "name": "required", "description": "Makes the radio a required field.", "type": "boolean" }, { "name": "invalid", "description": "Draws the radio in an invalid state.", "type": "boolean" } ], "events": [] } }, { "name": "w-radio-group", "description": "Radios allow users to select a single option from a list of choices.\n\nWrap individual radio components in a radio group.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/radio/frameworks/elements)\n---\n\n\n### **Slots:**\n - **label** - Alternative to the `label` attribute should you need custom HTML.\n- **help-text** - Alternative to the `help-text` attribute should you need custom HTML.", "doc-url": "", "attributes": [ { "name": "label", "description": "Label for the radio group.", "value": { "type": "string", "default": "\"\"" } }, { "name": "help-text", "description": "Help text for the radio group.\n\nIf you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.", "value": { "type": "string", "default": "\"\"" } }, { "name": "optional", "description": "Whether to show optional text next to the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Marks the radio group as invalid.", "value": { "type": "boolean", "default": "false" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "value": { "type": "string | null", "default": "null" } }, { "name": "disabled", "description": "Disables the radio group and all child radios.", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Makes selecting a radio in the the group required.", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "label", "description": "Alternative to the `label` attribute should you need custom HTML." }, { "name": "help-text", "description": "Alternative to the `help-text` attribute should you need custom HTML." } ], "events": [], "js": { "properties": [ { "name": "label", "description": "Label for the radio group.", "type": "string" }, { "name": "helpText", "description": "Help text for the radio group.\n\nIf you set `required` and `invalid` the group gets a default error message, but you can override it with this attribute.", "type": "string" }, { "name": "optional", "description": "Whether to show optional text next to the label.", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "invalid", "description": "Marks the radio group as invalid.", "type": "boolean" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "type": "string | null" }, { "name": "disabled", "description": "Disables the radio group and all child radios.", "type": "boolean" }, { "name": "required", "description": "Makes selecting a radio in the the group required.", "type": "boolean" } ], "events": [] } }, { "name": "w-select", "description": "A dropdown component for selecting a single value.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/select/frameworks/elements)\n---\n\n\n### **Events:**\n - **change**", "doc-url": "", "attributes": [ { "name": "auto-focus", "description": "Whether the element should receive focus on render.", "value": { "type": "boolean", "default": "false" } }, { "name": "autofocus", "description": "Whether the element should receive focus on render", "value": { "type": "boolean", "default": "false" } }, { "name": "help-text", "description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.", "value": { "type": "boolean", "default": "false" } }, { "name": "always", "description": "Whether to always show a hint.", "value": { "type": "boolean", "default": "false" } }, { "name": "hint", "description": "The content displayed as the help text.", "value": { "type": "string | undefined" } }, { "name": "label", "description": "The content to display as the label.", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "disabled", "description": "Renders the field in a disabled state.", "value": { "type": "boolean", "default": "false" } }, { "name": "read-only", "description": "Renders the field in a readonly state.", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Renders the field in a readonly state.", "value": { "type": "boolean", "default": "false" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Lets you set the current value.", "value": { "type": "string | undefined" } } ], "events": [{ "name": "change", "type": "CustomEvent" }], "js": { "properties": [ { "name": "autoFocus", "description": "Whether the element should receive focus on render.", "type": "boolean" }, { "name": "autofocus", "description": "Whether the element should receive focus on render", "type": "boolean" }, { "name": "helpText", "description": "The content displayed as the help text.\n\nPaired with `invalid` to show the text as a validation error.", "type": "string | undefined" }, { "name": "invalid", "description": "Renders the field in an invalid state.\n\nPaired with `help-text` to provide feedback about the error.", "type": "boolean" }, { "name": "always", "description": "Whether to always show a hint.", "type": "boolean" }, { "name": "hint", "description": "The content displayed as the help text.", "type": "string | undefined" }, { "name": "label", "description": "The content to display as the label.", "type": "string | undefined" }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "disabled", "description": "Renders the field in a disabled state.", "type": "boolean" }, { "name": "readOnly", "description": "Renders the field in a readonly state.", "type": "boolean" }, { "name": "readonly", "description": "Renders the field in a readonly state.", "type": "boolean" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the select when submitting the form.", "type": "string | undefined" }, { "name": "value", "description": "Lets you set the current value.", "type": "string | undefined" } ], "events": [{ "name": "change", "type": "CustomEvent" }] } }, { "name": "w-slider-thumb", "description": "Component to place inside a `<w-slider>`.\n---\n\n\n### **Events:**\n - **thumbreset** - Internal event used by (and stopped by) `w-slider`.\n- **slidervalidity** - Internal event used by (and stopped by) `w-slider`.", "doc-url": "", "attributes": [ { "name": "aria-label", "description": "Label for the range input.", "value": { "type": "string | null", "default": "null" } }, { "name": "aria-description", "description": "Contextual information for assistive technology, should it be needed", "value": { "type": "string | null", "default": "null" } }, { "name": "name", "description": "The name of this input field in the form. The canonical source of the value is the text field.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "The initial value, if any", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Placeholder in empty text fields", "value": { "type": "string | undefined" } } ], "events": [ { "name": "thumbreset", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." }, { "name": "slidervalidity", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." } ], "js": { "properties": [ { "name": "ariaLabel", "description": "Label for the range input.", "type": "string | null" }, { "name": "ariaDescription", "description": "Contextual information for assistive technology, should it be needed", "type": "string | null" }, { "name": "name", "description": "The name of this input field in the form. The canonical source of the value is the text field.", "type": "string | undefined" }, { "name": "value", "description": "The initial value, if any", "type": "string | undefined" }, { "name": "placeholder", "description": "Placeholder in empty text fields", "type": "string | undefined" } ], "events": [ { "name": "thumbreset", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." }, { "name": "slidervalidity", "type": "CustomEvent", "description": "Internal event used by (and stopped by) `w-slider`." } ] } }, { "name": "w-slider", "description": "Parent component for sliders (both single and range sliders). Used in combination with a `<w-slider-thumb>`.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/slider/frameworks/elements)\n---\n\n\n### **Slots:**\n - _default_ - For single sliders place a `<w-slider-thumb>` in the default slot.\n- **label** - Label for the slider or range slider as a whole.\n- **description** - Optional description between the label and slider.\n- **from** - Range sliders need to place a `<w-slider-thumb>` in the from and to slots.\n- **to** - Range sliders need to place a `<w-slider-thumb>` in the from and to slots.", "doc-url": "", "attributes": [ { "name": "label", "description": "The slider fieldset label. Required for proper accessibility.\n\nIf you need to display HTML, use the `label` slot instead (f. ex. `<legend class=\"sr-only\" slot=\"label\">Production year</legend>`)", "value": { "type": "string | undefined" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.", "value": { "type": "string | undefined" } }, { "name": "disabled", "value": { "type": "boolean", "default": "false" } }, { "name": "open-ended", "description": "Whether or not to allow values outside the range such as \"Before 1950\" and \"2025+\".", "value": { "type": "boolean", "default": "false" } }, { "name": "error", "description": "Validation error text, if any", "value": { "type": "string | undefined" } }, { "name": "help-text", "description": "Additional description to show below the fieldset", "value": { "type": "string | undefined" } }, { "name": "invalid", "description": "Sets the form fields and fieldset in an invalid state", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Ensures a child slider thumb has a value before allowing the containing form to submit", "value": { "type": "boolean", "default": "false" } }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "value": { "type": "boolean", "default": "false" } }, { "name": "min", "description": "The minimum allowed value in the range inputs", "value": { "type": "string | undefined", "default": "0" } }, { "name": "max", "description": "The maximum allowed value in the range inputs", "value": { "type": "string | undefined", "default": "100" } }, { "name": "markers", "description": "Pass a value similar to step to create visual markers at that interval", "value": { "type": "number | undefined" } }, { "name": "step", "description": "ets step on the range input to jump between values when dragging", "value": { "type": "number | undefined" } }, { "name": "suffix", "description": "Suffix used in text input fields and for the min and max values of the slider", "value": { "type": "string | undefined" } }, { "name": "hidden-textfield", "description": "Should only be used in special cases", "value": { "type": "boolean", "default": "false" } } ], "slots": [ { "name": "", "description": "For single sliders place a `<w-slider-thumb>` in the default slot." }, { "name": "label", "description": "Label for the slider or range slider as a whole." }, { "name": "description", "description": "Optional description between the label and slider." }, { "name": "from", "description": "Range sliders need to place a `<w-slider-thumb>` in the from and to slots." }, { "name": "to", "description": "Range sliders need to place a `<w-slider-thumb>` in the from and to slots." } ], "events": [], "js": { "properties": [ { "name": "label", "description": "The slider fieldset label. Required for proper accessibility.\n\nIf you need to display HTML, use the `label` slot instead (f. ex. `<legend class=\"sr-only\" slot=\"label\">Production year</legend>`)", "type": "string | undefined" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.", "type": "string | undefined" }, { "name": "disabled", "type": "boolean" }, { "name": "openEnded", "description": "Whether or not to allow values outside the range such as \"Before 1950\" and \"2025+\".", "type": "boolean" }, { "name": "error", "description": "Validation error text, if any", "type": "string | undefined" }, { "name": "helpText", "description": "Additional description to show below the fieldset", "type": "string | undefined" }, { "name": "invalid", "description": "Sets the form fields and fieldset in an invalid state", "type": "boolean" }, { "name": "required", "description": "Ensures a child slider thumb has a value before allowing the containing form to submit", "type": "boolean" }, { "name": "optional", "description": "Whether to show the optional indicator after the label.", "type": "boolean" }, { "name": "min", "description": "The minimum allowed value in the range inputs", "type": "string | undefined" }, { "name": "max", "description": "The maximum allowed value in the range inputs", "type": "string | undefined" }, { "name": "markers", "description": "Pass a value similar to step to create visual markers at that interval", "type": "number | undefined" }, { "name": "step", "description": "ets step on the range input to jump between values when dragging", "type": "number | undefined" }, { "name": "suffix", "description": "Suffix used in text input fields and for the min and max values of the slider", "type": "string | undefined" }, { "name": "hiddenTextfield", "description": "Should only be used in special cases", "type": "boolean" }, { "name": "valueFormatter", "description": "Formatter for the tooltip and input mask values", "type": "((value: string, slot: SliderSlot) => string) | undefined" }, { "name": "tooltipFormatter", "description": "Overrides valueFormatter for the tooltip.\n\nUse in open-ended sliders to show for example \"300+ hk\" instead of \"Max\" in the tooltip.", "type": "((value: string, slot: SliderSlot) => string) | undefined" }, { "name": "labelFormatter", "description": "Formatter for the min and max labels below the range.", "type": "((slot: SliderSlot) => string) | undefined" }, { "name": "_label" } ], "events": [] } }, { "name": "w-snackbar-item", "description": "An item to show in a `w-snackbar`.\n\nSee the `create` function on `w-snackbar` for a convenience API which helps you make snackbar items.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)\n---\n\n\n### **Methods:**\n - **close(): _void_** - Remove the snackbar item from the document.\n\nMoves focus to the last focused element outside of the snackbar item, if available.\n\n### **Slots:**\n - **default** - the snackbar message.\n- **icon** - icon preceeding the message.\n- **action** - action following the message.\n\n### **CSS Properties:**\n - **--w-c-snackbar-item-radius** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-max-width** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-min-width** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-padding** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-bg** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-bg-active** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-bg-hover** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-color** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-color-active** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-action-color-hover** - undefined _(default: undefined)_\n- **--w-c-snackbar-item-box-shadow** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **item** - the container wrapping the message, icon and actions.\n- **icon** - the icon for the variant.\n- **message** - the default slot, body of the snackbar item.\n- **action** - close and action button.", "doc-url": "", "attributes": [ { "name": "action-placement", "description": "The placement of the action and close buttons.", "value": { "type": "'inline' | 'block'", "default": "\"inline\"" } }, { "name": "duration", "description": "How long the message should stay in the document before removing itself.", "value": { "type": "number" } } ], "slots": [ { "name": "default", "description": "the snackbar message." }, { "name": "icon", "description": "icon preceeding the message." }, { "name": "action", "description": "action following the message." } ], "events": [], "js": { "properties": [ { "name": "actionPlacement", "description": "The placement of the action and close buttons.", "type": "'inline' | 'block'" }, { "name": "duration", "description": "How long the message should stay in the document before removing itself.", "type": "number" } ], "events": [] } }, { "name": "w-snackbar", "description": "A Snackbar shows brief user feedback messages that overlay content, with an optional action such as Undo.\n\nInclude one `<w-snackbar></w-snackbar>` in the document `<body>`. Use the `create` function to create messages.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/snackbar/frameworks/elements)\n---\n\n\n### **Methods:**\n - **create(message: _string_, options: _CreateSnackbarOptions_): __** - Creates a snackbar item and immediately adds it to the snackbar.\n\nBy default the snackbar item automatically closes after 4 seconds (`SnackbarDuration.Short`).\n\nIf you include an `action` in the options the default `duration` is\nset to 10 seconds (`SnackbarDuration.Long`) and can not be made shorter.\n\nA `duration` of 10 seconds or longer forces the close button to be visible.\n\nThe default `variant` is `neutral` which does not have an icon.\n\nSet `duration` to `SnackbarDuration.Infinite` if you want a persistent message.\n\n### **Slots:**\n - **default** - `w-snackbar-item` gets placed inside the default slot by the `create` function.\n\n### **CSS Properties:**\n - **--w-c-snackbar-container-gap** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-bottom** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-left** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-right** - undefined _(default: undefined)_\n- **--w-c-snackbar-position-top** - undefined _(default: undefined)_\n- **--w-c-snackbar-z-index** - undefined _(default: undefined)_\n\n### **CSS Parts:**\n - **container** - the live region that positions messages on the screen.", "doc-url": "", "attributes": [], "slots": [ { "name": "default", "description": "`w-snackbar-item` gets placed inside the default slot by the `create` function." } ], "events": [], "js": { "properties": [], "events": [] } }, { "name": "w-step", "description": "Individual step component that shows a single step in a process.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "active", "description": "Whether this step is active.\n\nThe active step displays a filled indicator.", "value": { "type": "boolean", "default": "false" } }, { "name": "completed", "description": "Whether this step is completed.\n\nCompleted steps display a checkmark icon and a filled indicator.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "active", "description": "Whether this step is active.\n\nThe active step displays a filled indicator.", "type": "boolean" }, { "name": "completed", "description": "Whether this step is completed.\n\nCompleted steps display a checkmark icon and a filled indicator.", "type": "boolean" } ], "events": [] } }, { "name": "w-step-indicator", "description": "Steps are used to show progress through a process or to guide users through a multi-step task.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/steps/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "horizontal", "description": "Display steps horizontally instead of vertically", "value": { "type": "boolean", "default": "false" } }, { "name": "right", "description": "Align steps to the right (vertical layout only)", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "horizontal", "description": "Display steps horizontally instead of vertically", "type": "boolean" }, { "name": "right", "description": "Align steps to the right (vertical layout only)", "type": "boolean" } ], "events": [] } }, { "name": "w-switch", "description": "The Switch component allows users to toggle between two states.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/switch/frameworks/elements)\n---\n\n\n### **Events:**\n - **change** - Dispatched when the switch toggles. Includes boolean `checked` and string/null `value` on `details`.", "doc-url": "", "attributes": [ { "name": "name", "description": "Name used when submitting an HTML form.", "value": { "type": "string" } }, { "name": "value", "description": "Value submitted when the switch is checked.\n\nThe component reports `null` as the value in the `change` event when `value` is an empty string.", "value": { "type": "string" } }, { "name": "checked", "description": "Whether the switch is on (checked).", "value": { "type": "boolean", "default": "false" } }, { "name": "disabled", "description": "Whether the switch is disabled.", "value": { "type": "boolean", "default": "false" } } ], "events": [ { "name": "change", "type": "WarpSwitchChangeEvent", "description": "Dispatched when the switch toggles. Includes boolean `checked` and string/null `value` on `details`." } ], "js": { "properties": [ { "name": "name", "description": "Name used when submitting an HTML form.", "type": "string" }, { "name": "value", "description": "Value submitted when the switch is checked.\n\nThe component reports `null` as the value in the `change` event when `value` is an empty string.", "type": "string" }, { "name": "checked", "description": "Whether the switch is on (checked).", "type": "boolean" }, { "name": "disabled", "description": "Whether the switch is disabled.", "type": "boolean" } ], "events": [ { "name": "change", "type": "WarpSwitchChangeEvent", "description": "Dispatched when the switch toggles. Includes boolean `checked` and string/null `value` on `details`." } ] } }, { "name": "w-tab", "description": "Individual tab component used within w-tabs container.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "tabindex", "description": "The host element (`<w-tab>`), the one with `role=tab`, must be the focusable element for assistive technology.", "value": { "type": "number", "default": "0" } }, { "name": "for", "description": "The `id` of the `<w-tab-panel>` this tab controls.", "value": { "type": "string | undefined" } }, { "name": "over", "description": "Whether to show the `icon` slot over the tab title instead of inline.", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "tabindex", "description": "The host element (`<w-tab>`), the one with `role=tab`, must be the focusable element for assistive technology.", "type": "number" }, { "name": "for", "description": "The `id` of the `<w-tab-panel>` this tab controls.", "type": "string | undefined" }, { "name": "over", "description": "Whether to show the `icon` slot over the tab title instead of inline.", "type": "boolean" }, { "name": "_internals" } ], "events": [] } }, { "name": "w-tab-panel", "description": "Tab panel component that holds content for individual tabs.\n\nEach tab panel should have a name that matches a corresponding tab.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)\n---\n", "doc-url": "", "attributes": [ { "name": "id", "description": "Required so `<w-tab>` has something to target.", "value": { "type": "string" } } ], "events": [], "js": { "properties": [ { "name": "id", "description": "Required so `<w-tab>` has something to target.", "type": "string" } ], "events": [] } }, { "name": "w-tabs", "description": "Tabs are used to organize content by grouping similar information on the same page.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/tabs/frameworks/elements)\n---\n\n\n### **Events:**\n - **change** - Includes `details.panelId` with the now active tab panel's ID", "doc-url": "", "attributes": [ { "name": "active", "description": "The `id` of the panel that should be active.", "value": { "type": "string | undefined", "default": "\"\" (Shows the first tab)" } } ], "events": [ { "name": "change", "type": "WarpTabsChangeEvent", "description": "Includes `details.panelId` with the now active tab panel's ID" } ], "js": { "properties": [ { "name": "active", "description": "The `id` of the panel that should be active.", "type": "string | undefined" } ], "events": [ { "name": "change", "type": "WarpTabsChangeEvent", "description": "Includes `details.panelId` with the now active tab panel's ID" } ] } }, { "name": "w-textarea", "description": "A multi-line text input with built-in form validation, auto-resizing, and styling support.\n\n[Warp component reference](https://warp-ds.github.io/docs/components/text-area/frameworks/elements)\n---\n\n\n### **Events:**\n \n\n### **Methods:**\n - **checkValidity(): _boolean_** - Checks whether the textarea passes constraint validation\n- **reportValidity(): _boolean_** - Checks validity and shows the validation message if invalid\n- **setCustomValidity(message: _string_): _void_** - Sets a custom validation message. Pass an empty string to clear.", "doc-url": "", "attributes": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "value": { "type": "boolean", "default": "false" } }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "value": { "type": "boolean", "default": "false" } }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "value": { "type": "string | undefined" } }, { "name": "help-text", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "value": { "type": "string | undefined" } }, { "name": "maximum-rows", "description": "Sets the maximum number of text rows before the content starts scrolling.", "value": { "type": "number | undefined" } }, { "name": "minimum-rows", "description": "Sets the minimum number of text rows the textarea should display", "value": { "type": "number | undefined" } }, { "name": "maxlength", "description": "Sets the maximum number of text rows before the content starts scrolling.", "value": { "type": "number | undefined" } }, { "name": "minlength", "description": "Sets the minimum number of characters for the textarea to be valid", "value": { "type": "number | undefined" } }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form", "value": { "type": "string | undefined" } }, { "name": "placeholder", "description": "Set a text that is shown in the textarea when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "value": { "type": "string | undefined" } }, { "name": "read-only", "value": { "type": "boolean", "default": "false" } }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "value": { "type": "boolean", "default": "false" } }, { "name": "required", "description": "Whether user input is required on the input before form submission", "value": { "type": "boolean", "default": "false" } }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "value": { "type": "string | undefined" } }, { "name": "value", "description": "Lets you set the current value", "value": { "type": "string | undefined" } }, { "name": "optional", "description": "Show an icon behind the label indicating the field is optional", "value": { "type": "boolean", "default": "false" } } ], "events": [], "js": { "properties": [ { "name": "disabled", "description": "Keep in mind that using disabled in its current form is an anti-pattern.\n\nThere will always be users who don't understand why an element is disabled, or users who can't even see that it is disabled because of poor lighting conditions or other reasons.\n\nPlease consider more informative alternatives before choosing to use disabled on an element.", "type": "boolean" }, { "name": "invalid", "description": "Mark the form field as invalid.\n\nMake sure to also set a `help-text` to help users fix the validation problem.", "type": "boolean" }, { "name": "label", "description": "Either a `label` or an `aria-label` must be provided.", "type": "string | undefined" }, { "name": "helpText", "description": "Use in combination with `invalid` to show as a validation error message,\nor on its own to show a help text.", "type": "string | undefined" }, { "name": "maxRows", "description": "Sets the maximum number of text rows before the content starts scrolling.", "type": "number | undefined" }, { "name": "minRows", "description": "Sets the minimum number of text rows the textarea should display", "type": "number | undefined" }, { "name": "maxLength", "description": "Sets the maximum number of text rows before the content starts scrolling.", "type": "number | undefined" }, { "name": "minLength", "description": "Sets the minimum number of characters for the textarea to be valid", "type": "number | undefined" }, { "name": "name", "description": "The [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/input#name) of the input field when submitting the form", "type": "string | undefined" }, { "name": "placeholder", "description": "Set a text that is shown in the textarea when it doesn't have a value.\n\nPlaceholder text should not be used as a substitute for labeling the element with a visible label.", "type": "string | undefined" }, { "name": "readOnly", "type": "boolean" }, { "name": "readonly", "description": "Whether the input can be selected but not changed by the user", "type": "boolean" }, { "name": "required", "description": "Whether user input is required on the input before form submission", "type": "boolean" }, { "name": "tooltip", "description": "Supplementary information that should show in a tooltip behind an information icon after the label.\n\nYou must provide a label to be able to show an info icon with a tooltip.", "type": "string | undefined" }, { "name": "value", "description": "Lets you set the current value", "type": "string | undefined" }, { "name": "optional", "description": "Show an icon behind the label indicating the field is optional", "type": "boolean" }, { "name": "validationMessage", "description": "Returns the validation message if the textarea is invalid, otherwise an empty string", "type": "string" }, { "name": "validity", "description": "Returns the validity state of the textarea", "type": "ValidityState" } ], "events": [] } } ] }, "css": { "properties": [ { "name": "--w-c-modal-backdrop-color" }, { "name": "--w-c-modal-bg" }, { "name": "--w-c-modal-box-shadow" }, { "name": "--w-c-modal-color" }, { "name": "--w-c-modal-height" }, { "name": "--w-c-modal-max-height" }, { "name": "--w-c-modal-min-height" }, { "name": "--w-c-modal-translate-distance" }, { "name": "--w-c-modal-padding-bottom" }, { "name": "--w-c-modal-width" }, { "name": "--w-c-modal-footer-gap", "description": " adjusts the flex gap between actions in the footer." }, { "name": "--w-c-modal-header-font-size" }, { "name": "--w-c-modal-header-line-height" }, { "name": "--w-c-modal-header-margin-bottom" }, { "name": "--w-c-snackbar-item-radius" }, { "name": "--w-c-snackbar-item-max-width" }, { "name": "--w-c-snackbar-item-min-width" }, { "name": "--w-c-snackbar-item-padding" }, { "name": "--w-c-snackbar-item-bg" }, { "name": "--w-c-snackbar-item-action-bg-active" }, { "name": "--w-c-snackbar-item-action-bg-hover" }, { "name": "--w-c-snackbar-item-color" }, { "name": "--w-c-snackbar-item-action-color-active" }, { "name": "--w-c-snackbar-item-action-color-hover" }, { "name": "--w-c-snackbar-item-box-shadow" }, { "name": "--w-c-snackbar-container-gap" }, { "name": "--w-c-snackbar-position-bottom" }, { "name": "--w-c-snackbar-position-left" }, { "name": "--w-c-snackbar-position-right" }, { "name": "--w-c-snackbar-position-top" }, { "name": "--w-c-snackbar-z-index" } ], "pseudo-elements": [ { "name": "part(base)", "description": "the root wrapper element inside the component." }, { "name": "part(chevron)", "description": "the chevron container." }, { "name": "part(dialog)", "description": "the root element inside the component (`<dialog>` element)." }, { "name": "part(wrapper)", "description": "container for all elements, direct child of `<dialog>`." }, { "name": "part(content)", "description": "the container for the `content` slot items (children)." }, { "name": "part(footer)", "description": "the container for slotted items (children)." }, { "name": "part(header)", "description": "the root element inside the component." }, { "name": "part(top)", "description": "the container for the image (`top` slot)." }, { "name": "part(back)", "description": "the back button, if visible." }, { "name": "part(title)", "description": "the title element." }, { "name": "part(close)", "description": "the close button, if visible." }, { "name": "part(item)", "description": "the container wrapping the message, icon and actions." }, { "name": "part(icon)", "description": "the icon for the variant." }, { "name": "part(message)", "description": "the default slot, body of the snackbar item." }, { "name": "part(action)", "description": "close and action button." }, { "name": "part(container)", "description": "the live region that positions messages on the screen." } ] } } }