{
"$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
"name": "dap-design-system",
"version": "0.9.153",
"description-markup": "markdown",
"contributions": {
"html": {
"elements": [
{
"name": "dap-ds-accordion",
"description": "An accordion is a vertically stacked list of interactive items that can be expanded or collapsed to reveal or hide content.\n---\n\n\n### **Events:**\n - **dds-opened** - Event fired when the accordion is opened.\n- **dds-closed** - Event fired when the accordion is closed.\n\n### **Slots:**\n - **default** - The content of the accordion.\n- **heading** - The heading of the accordion.\n- **icon-opened** - The icon when the accordion is opened.\n- **icon-closed** - The icon when the accordion is closed.\n\n### **CSS Properties:**\n - **--dds-accordion-border-width** - The width of the accordion border (default: var(--dds-border-width-base)) _(default: undefined)_\n- **--dds-accordion-border-style** - The style of the accordion border (default: solid) _(default: undefined)_\n- **--dds-accordion-border-radius** - The border radius of the accordion (default: var(--dds-radius-base)) _(default: undefined)_\n- **--dds-accordion-border-color** - The color of the accordion border (default: var(--dds-border-neutral-divider)) _(default: undefined)_\n- **--dds-accordion-background-color** - The background color of the accordion (default: var(--dds-background-neutral-subtle)) _(default: undefined)_\n- **--dds-accordion-text-color** - The text color of the accordion (default: var(--dds-text-neutral-strong)) _(default: undefined)_\n- **--dds-accordion-hover-background** - The background color when hovering over the accordion (default: var(--dds-background-neutral-base)) _(default: undefined)_\n- **--dds-accordion-active-background** - The background color when the accordion is active (default: var(--dds-background-neutral-medium)) _(default: undefined)_\n- **--dds-accordion-icon-background** - The background color of the accordion icon (default: var(--dds-transparent-black-subtle)) _(default: undefined)_\n- **--dds-accordion-icon-color** - The color of the accordion icon (default: var(--dds-icon-neutral-base)) _(default: undefined)_\n- **--dds-accordion-icon-hover-background** - The background color of the accordion icon when hovered (default: var(--dds-transparent-black-base)) _(default: undefined)_\n- **--dds-accordion-icon-active-background** - The background color of the accordion icon when active (default: var(--dds-transparent-black-strong)) _(default: undefined)_\n- **--dds-accordion-icon-hover-color** - The color of the accordion icon when hovered (default: var(--dds-icon-neutral-strong)) _(default: undefined)_\n- **--dds-accordion-icon-active-color** - The color of the accordion icon when active (default: var(--dds-icon-neutral-strong)) _(default: undefined)_\n- **--dds-accordion-content-color** - The color of the accordion content (default: var(--dds-text-text-neutral)) _(default: undefined)_\n- **--dds-accordion-transition-duration** - The duration of the accordion transitions (default: var(--dds-transition-fast)) _(default: undefined)_\n- **--dds-accordion-transition-timing** - The timing function of the accordion transitions (default: var(--dds-easing-ease-in-out)) _(default: undefined)_\n- **--dds-accordion-divider-color** - The color of the divider between accordion items (default: var(--dds-border-neutral-divider)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main accordion container.\n- **heading** - The heading of the accordion.\n- **button** - The button of the accordion.\n- **content** - The content of the accordion.\n- **content-container** - The container of the accordion content.\n- **icon-wrapper** - The icon wrapper of the accordion.\n- **open-icon** - The icon when the accordion is opened.\n- **open-icon-base** - The base of the icon when the accordion is opened.\n- **close-icon** - The icon when the accordion is closed.\n- **close-icon-base** - The base of the icon when the accordion is closed.",
"doc-url": "",
"attributes": [],
"slots": [
{
"name": "default",
"description": "The content of the accordion."
},
{
"name": "heading",
"description": "The heading of the accordion."
},
{
"name": "icon-opened",
"description": "The icon when the accordion is opened."
},
{
"name": "icon-closed",
"description": "The icon when the accordion is closed."
}
],
"events": [
{
"name": "dds-opened",
"type": "{ open: boolean, item: AccordionBaseElement }",
"description": "Event fired when the accordion is opened."
},
{
"name": "dds-closed",
"type": "{ open: boolean, item: AccordionBaseElement }",
"description": "Event fired when the accordion is closed."
}
],
"js": {
"properties": [
{
"name": "size",
"description": "The size of the accordion. Default is `sm`.",
"type": "'sm' | 'lg'"
},
{
"name": "headingLevel",
"description": "The heading level of the accordion. Default is `4`.",
"type": "1 | 2 | 3 | 4 | 5 | 6"
},
{
"name": "opened",
"description": "Whether the accordion is opened. Default is `false`.",
"type": "boolean"
},
{
"name": "iconLocation",
"description": "The location of the icon. Default is `right`.",
"type": "'left' | 'right'"
},
{
"name": "variant",
"description": "The variant of the accordion.",
"type": "'default' | 'collapsed' | 'clean' | 'clean-collapsed'"
},
{
"name": "lastItem",
"description": "Whether the accordion is the last item.",
"type": "boolean"
},
{
"name": "disabled",
"description": "Whether the accordion is disabled.",
"type": "boolean"
},
{
"name": "loading",
"description": "Whether the accordion is in loading state.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-opened",
"type": "{ open: boolean, item: AccordionBaseElement }",
"description": "Event fired when the accordion is opened."
},
{
"name": "dds-closed",
"type": "{ open: boolean, item: AccordionBaseElement }",
"description": "Event fired when the accordion is closed."
}
]
}
},
{
"name": "dap-ds-accordion-group",
"description": "An accordion group is a collection of accordion components.\n---\n\n\n### **Slots:**\n - _default_ - The content of the accordion group.\n\n### **CSS Properties:**\n - **--dds-accordion-group-spacing** - Controls the gap between accordion items (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-accordion-group-border-color** - Controls the border color (default: var(--dds-border-neutral-subtle)) _(default: undefined)_\n- **--dds-accordion-group-border-width** - Controls the border width (default: var(--dds-border-width-base)) _(default: undefined)_\n- **--dds-accordion-group-border-radius** - Controls the border radius (default: var(--dds-radius-base)) _(default: undefined)_\n- **--dds-accordion-group-background** - Controls the background color (default: transparent) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main accordion group container.",
"doc-url": "",
"attributes": [
{
"name": "autoClose",
"description": "Whether to close other accordions when one is opened.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "variant",
"description": "The variant of the accordion",
"value": {
"type": "'default' | 'collapsed' | 'clean' | 'clean-collapsed'",
"default": "'default'"
}
}
],
"slots": [
{ "name": "", "description": "The content of the accordion group." }
],
"events": [],
"js": {
"properties": [
{
"name": "autoClose",
"description": "Whether to close other accordions when one is opened.",
"type": "string"
},
{
"name": "variant",
"description": "The variant of the accordion",
"type": "'default' | 'collapsed' | 'clean' | 'clean-collapsed'"
}
],
"events": []
}
},
{
"name": "dap-ds-avatar-group",
"description": "Avatar group component displays multiple avatars in an organized layout with overflow management.\n---\n\n\n### **Events:**\n - **dds-overflow-click** - Fired when the overflow indicator is clicked.\n\n### **Slots:**\n - _default_ - The avatars to display in the group.\n\n### **CSS Properties:**\n - **--dds-avatar-group-gap** - Gap between avatars in grid layout. Default is 0. _(default: undefined)_\n- **--dds-avatar-group-overlap** - Overlap amount for stacked layout. Default is -8px. _(default: undefined)_\n- **--dds-avatar-group-border-width** - Border width for avatars. Default is 2px. _(default: undefined)_\n- **--dds-avatar-group-border-color** - Border color for avatars. Default is white. _(default: undefined)_\n- **--dds-avatar-group-overflow-bg** - Background color for overflow indicator. _(default: undefined)_\n- **--dds-avatar-group-overflow-color** - Text color for overflow indicator. _(default: undefined)_\n- **--dds-avatar-group-overflow-border** - Border for overflow indicator. _(default: undefined)_\n- **--dds-avatar-group-size-lg** - Size for large avatars. Default is 80px. _(default: undefined)_\n- **--dds-avatar-group-size-md** - Size for medium avatars. Default is 64px. _(default: undefined)_\n- **--dds-avatar-group-size-sm** - Size for small avatars. Default is 48px. _(default: undefined)_\n- **--dds-avatar-group-size-xs** - Size for extra small avatars. Default is 32px. _(default: undefined)_\n- **--dds-avatar-group-size-xxs** - Size for extra extra small avatars. Default is 24px. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main container of the avatar group.\n- **avatars** - The container for the visible avatars.\n- **overflow** - The overflow indicator element.",
"doc-url": "",
"attributes": [
{
"name": "size",
"description": "The size of avatars in the group",
"value": {
"type": "'xxs' | 'xs' | 'sm' | 'md' | 'lg'",
"default": "'md'"
}
},
{
"name": "layout",
"description": "Layout type for the avatar group",
"value": { "type": "'stack' | 'grid'", "default": "'stack'" }
},
{
"name": "max",
"description": "Maximum number of avatars to show before showing overflow",
"value": { "type": "number", "default": "3" }
},
{
"name": "show-total",
"description": "Whether to show the total count in overflow indicator",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "interactive-overflow",
"description": "Interactive overflow indicator",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "label",
"description": "Accessible label for the avatar group",
"value": { "type": "string" }
},
{
"name": "overflow-label",
"description": "Accessible label for the overflow indicator",
"value": { "type": "string" }
}
],
"slots": [
{
"name": "",
"description": "The avatars to display in the group."
}
],
"events": [
{
"name": "dds-overflow-click",
"description": "Fired when the overflow indicator is clicked."
}
],
"js": {
"properties": [
{
"name": "size",
"description": "The size of avatars in the group",
"type": "'xxs' | 'xs' | 'sm' | 'md' | 'lg'"
},
{
"name": "layout",
"description": "Layout type for the avatar group",
"type": "'stack' | 'grid'"
},
{
"name": "max",
"description": "Maximum number of avatars to show before showing overflow",
"type": "number"
},
{
"name": "showTotal",
"description": "Whether to show the total count in overflow indicator",
"type": "boolean"
},
{
"name": "interactiveOverflow",
"description": "Interactive overflow indicator",
"type": "boolean"
},
{
"name": "label",
"description": "Accessible label for the avatar group",
"type": "string"
},
{
"name": "overflowLabel",
"description": "Accessible label for the overflow indicator",
"type": "string"
}
],
"events": [
{
"name": "dds-overflow-click",
"description": "Fired when the overflow indicator is clicked."
}
]
}
},
{
"name": "dap-ds-badge",
"description": "A badge is a small status descriptor for UI elements.\n---\n\n\n### **Slots:**\n - _default_ - The content of the badge.\n- **icon** - The icon of the badge.\n\n### **CSS Properties:**\n - **--dds-badge-border-width** - The width of the badge's border. Default is the design system's base border width. _(default: undefined)_\n- **--dds-badge-border-style** - The style of the badge's border. Default is solid. _(default: undefined)_\n- **--dds-badge-border-radius** - The border radius of the badge. Default is the design system's base radius. _(default: undefined)_\n- **--dds-badge-font-weight** - The font weight of the badge text. Default is bold. _(default: undefined)_\n- **--dds-badge-line-height** - The line height of the badge text. Default is 1.2. _(default: undefined)_\n- **--dds-badge-transition** - The transition property for the badge. Default is 'all 0.2s ease-in-out'. _(default: undefined)_\n- **--dds-badge-padding-sm** - The padding of the small badge. Default is the design system's spacing-100 and spacing-200. _(default: undefined)_\n- **--dds-badge-padding-lg** - The padding of the large badge. Default is the design system's spacing-100 and spacing-300. _(default: undefined)_\n- **--dds-badge-font-size-sm** - The font size of the small badge. Default is the design system's font-xs. _(default: undefined)_\n- **--dds-badge-font-size-lg** - The font size of the large badge. Default is the design system's font-sm. _(default: undefined)_\n- **--dds-badge-neutral-border-color** - The border color of the neutral badge. Default is the design system's border-neutral-base. _(default: undefined)_\n- **--dds-badge-neutral-background** - The background color of the neutral badge. Default is the design system's background-neutral-medium. _(default: undefined)_\n- **--dds-badge-neutral-color** - The text color of the neutral badge. Default is the design system's text-neutral-subtle. _(default: undefined)_\n- **--dds-badge-brand-border-color** - The border color of the brand badge. Default is the design system's border-brand-base. _(default: undefined)_\n- **--dds-badge-brand-background** - The background color of the brand badge. Default is the design system's background-brand-medium. _(default: undefined)_\n- **--dds-badge-brand-color** - The text color of the brand badge. Default is the design system's text-brand-subtle. _(default: undefined)_\n- **--dds-badge-info-border-color** - The border color of the info badge. Default is the design system's border-informative-base. _(default: undefined)_\n- **--dds-badge-info-background** - The background color of the info badge. Default is the design system's background-informative-medium. _(default: undefined)_\n- **--dds-badge-info-color** - The text color of the info badge. Default is the design system's text-informative-subtle. _(default: undefined)_\n- **--dds-badge-positive-border-color** - The border color of the positive badge. Default is the design system's border-positive-base. _(default: undefined)_\n- **--dds-badge-positive-background** - The background color of the positive badge. Default is the design system's background-positive-medium. _(default: undefined)_\n- **--dds-badge-positive-color** - The text color of the positive badge. Default is the design system's text-positive-subtle. _(default: undefined)_\n- **--dds-badge-warning-border-color** - The border color of the warning badge. Default is the design system's border-warning-subtle. _(default: undefined)_\n- **--dds-badge-warning-background** - The background color of the warning badge. Default is the design system's background-warning-medium. _(default: undefined)_\n- **--dds-badge-warning-color** - The text color of the warning badge. Default is the design system's text-warning-subtle. _(default: undefined)_\n- **--dds-badge-negative-border-color** - The border color of the negative badge. Default is the design system's border-negative-base. _(default: undefined)_\n- **--dds-badge-negative-background** - The background color of the negative badge. Default is the design system's background-negative-medium. _(default: undefined)_\n- **--dds-badge-negative-color** - The text color of the negative badge. Default is the design system's text-negative-subtle. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main container of the badge.\n- **icon** - The icon of the badge.\n- **content** - The content of the badge.\n- **icon-base** - The base of the icon.",
"doc-url": "",
"attributes": [
{
"name": "type",
"description": "The type of the badge",
"value": {
"type": "'neutral' | 'brand' | 'info' | 'positive' | 'warning' | 'negative'",
"default": "'neutral'"
}
},
{
"name": "size",
"description": "The size of the badge",
"value": { "type": "'sm' | 'lg'", "default": "'sm'" }
},
{
"name": "icon",
"description": "The icon of the badge, this is a name of a built in icon",
"value": { "type": "string | undefined" }
},
{
"name": "live",
"description": "Whether the badge represents dynamic content that should announce changes",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{ "name": "", "description": "The content of the badge." },
{ "name": "icon", "description": "The icon of the badge." }
],
"events": [],
"js": {
"properties": [
{
"name": "type",
"description": "The type of the badge",
"type": "'neutral' | 'brand' | 'info' | 'positive' | 'warning' | 'negative'"
},
{
"name": "size",
"description": "The size of the badge",
"type": "'sm' | 'lg'"
},
{
"name": "icon",
"description": "The icon of the badge, this is a name of a built in icon",
"type": "string | undefined"
},
{
"name": "live",
"description": "Whether the badge represents dynamic content that should announce changes",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-anchor-heading",
"description": "Anchor heading is a heading with an anchor link.\n---\n\n\n### **CSS Properties:**\n - **--dds-anchor-link-color** - The color of the anchor link. Default is the primary color. _(default: undefined)_\n- **--dds-anchor-link-opacity** - The opacity of the anchor link when not hovered. Default is 0. _(default: undefined)_\n- **--dds-anchor-link-hover-opacity** - The opacity of the anchor link when hovered. Default is 1. _(default: undefined)_\n- **--dds-anchor-link-transition** - The transition property for the anchor link opacity. Default is 'opacity 0.2s ease-in-out'. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main anchor heading container.\n- **link** - The link of the anchor heading. dap-ds-link element.\n- **link-base** - The base of the link part.\n- **text** - The text of the anchor heading.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the heading. Default is `h2`. Can be `h1`, `h2`, `h3`, `h4`, `h5`, or `h6`.",
"value": { "type": "HeadingVariant" }
},
{
"name": "label",
"description": "The label of the heading.",
"value": { "type": "string" }
}
],
"events": [],
"js": {
"properties": [
{ "name": "variant", "type": "HeadingVariant" },
{ "name": "label", "type": "string" },
{ "name": "elementId" },
{ "name": "anchorTitle" }
],
"events": []
}
},
{
"name": "dap-ds-avatar",
"description": "Avatar component can be used to display user profile images, initials, or icons.\n---\n\n\n### **Events:**\n - **dds-click** - Fired when the avatar is clicked (only when interactive).\n- **dds-load** - Fired when the image loads successfully.\n- **dds-error** - Fired when the image fails to load.\n\n### **Slots:**\n - **icon** - The icon to display when variant is 'icon'.\n- **fallback** - Custom fallback content when image fails to load.\n\n### **CSS Properties:**\n - **--dds-avatar-border-radius** - The border radius of the avatar. Default varies by shape. _(default: undefined)_\n- **--dds-avatar-background-color** - The background color of the avatar. Default is neutral. _(default: undefined)_\n- **--dds-avatar-border-width** - The width of the avatar's border. Default is 0. _(default: undefined)_\n- **--dds-avatar-border-color** - The color of the avatar's border. Default is transparent. _(default: undefined)_\n- **--dds-avatar-border-style** - The style of the avatar's border. Default is solid. _(default: undefined)_\n- **--dds-avatar-transition** - The transition property for the avatar. Default is 'all 0.2s ease-in-out'. _(default: undefined)_\n- **--dds-avatar-text-color** - The color of initials text. Default is neutral strong. _(default: undefined)_\n- **--dds-avatar-font-size** - The font size for initials. Calculated based on size. _(default: undefined)_\n- **--dds-avatar-font-weight** - The font weight for initials. Default is semibold. _(default: undefined)_\n- **--dds-avatar-size-lg** - The size of the large avatar. Default is 80px. _(default: undefined)_\n- **--dds-avatar-size-md** - The size of the medium avatar. Default is 64px. _(default: undefined)_\n- **--dds-avatar-size-sm** - The size of the small avatar. Default is 48px. _(default: undefined)_\n- **--dds-avatar-size-xs** - The size of the extra small avatar. Default is 32px. _(default: undefined)_\n- **--dds-avatar-size-xxs** - The size of the extra extra small avatar. Default is 24px. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main avatar container.\n- **img** - The avatar image.\n- **initials** - The initials container.\n- **icon** - The icon container.\n- **fallback** - The fallback content container.\n- **loading** - The loading indicator.",
"doc-url": "",
"attributes": [
{
"name": "size",
"description": "The size of the avatar",
"value": {
"type": "'xxs' | 'xs' | 'sm' | 'md' | 'lg'",
"default": "'md'"
}
},
{
"name": "shape",
"description": "The shape of the avatar",
"value": {
"type": "'circle' | 'rounded' | 'square'",
"default": "'circle'"
}
},
{
"name": "variant",
"description": "The variant type of the avatar",
"value": {
"type": "'image' | 'initials' | 'icon'",
"default": "'image'"
}
},
{
"name": "src",
"description": "The source of the avatar image",
"value": { "type": "string" }
},
{
"name": "alt",
"description": "The alt text of the avatar",
"value": { "type": "string" }
},
{
"name": "initials",
"description": "The initials to display when variant is 'initials'",
"value": { "type": "string" }
},
{
"name": "label",
"description": "Accessible label for the avatar",
"value": { "type": "string" }
},
{
"name": "loading",
"description": "Loading state indicator",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "interactive",
"description": "Whether the avatar is interactive (clickable)",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "width",
"description": "The width of the avatar. This will override the size",
"value": { "type": "number" }
},
{
"name": "height",
"description": "The height of the avatar. This will override the size",
"value": { "type": "number" }
}
],
"slots": [
{
"name": "icon",
"description": "The icon to display when variant is 'icon'."
},
{
"name": "fallback",
"description": "Custom fallback content when image fails to load."
}
],
"events": [
{
"name": "dds-click",
"description": "Fired when the avatar is clicked (only when interactive)."
},
{
"name": "dds-load",
"description": "Fired when the image loads successfully."
},
{
"name": "dds-error",
"description": "Fired when the image fails to load."
}
],
"js": {
"properties": [
{
"name": "size",
"description": "The size of the avatar",
"type": "'xxs' | 'xs' | 'sm' | 'md' | 'lg'"
},
{
"name": "shape",
"description": "The shape of the avatar",
"type": "'circle' | 'rounded' | 'square'"
},
{
"name": "variant",
"description": "The variant type of the avatar",
"type": "'image' | 'initials' | 'icon'"
},
{
"name": "src",
"description": "The source of the avatar image",
"type": "string"
},
{
"name": "alt",
"description": "The alt text of the avatar",
"type": "string"
},
{
"name": "initials",
"description": "The initials to display when variant is 'initials'",
"type": "string"
},
{
"name": "label",
"description": "Accessible label for the avatar",
"type": "string"
},
{
"name": "loading",
"description": "Loading state indicator",
"type": "boolean"
},
{
"name": "interactive",
"description": "Whether the avatar is interactive (clickable)",
"type": "boolean"
},
{
"name": "width",
"description": "The width of the avatar. This will override the size",
"type": "number"
},
{
"name": "height",
"description": "The height of the avatar. This will override the size",
"type": "number"
}
],
"events": [
{
"name": "dds-click",
"description": "Fired when the avatar is clicked (only when interactive)."
},
{
"name": "dds-load",
"description": "Fired when the image loads successfully."
},
{
"name": "dds-error",
"description": "Fired when the image fails to load."
}
]
}
},
{
"name": "dap-ds-banner",
"description": "A banner is a message displayed at the top of the page to provide important information to the user.\n---\n\n\n### **Events:**\n - **dds-close** - Event fired when the banner is closed.\n\n### **Slots:**\n - _default_ - The content of the banner.\n- **actions** - Actions of banner\n- **icon** - The icon of the banner.\n\n### **CSS Properties:**\n - **--dds-banner-gap** - The gap between banner elements. Default is the design system's spacing-200. _(default: undefined)_\n- **--dds-banner-line-height** - The line height of the banner text. Default is the design system's font-line-height-xlarge. _(default: undefined)_\n- **--dds-banner-transition** - The transition property for the banner. Default is 'all 0.2s ease-in-out'. _(default: undefined)_\n- **--dds-banner-brand-background** - The background color of the brand banner. Default is the design system's banner-background-brand. _(default: undefined)_\n- **--dds-banner-brand-icon-color** - The color of the brand banner icon. Default is the design system's banner-icon-brand. _(default: undefined)_\n- **--dds-banner-brand-text-color** - The text color of the brand banner. Default is the design system's banner-text-brand. _(default: undefined)_\n- **--dds-banner-brand-action-color** - The color of the brand banner actions. Default is the design system's banner-action-enabled. _(default: undefined)_\n- **--dds-banner-info-background** - The background color of the info banner. Default is the design system's banner-background-informative. _(default: undefined)_\n- **--dds-banner-info-icon-color** - The color of the info banner icon. Default is the design system's banner-icon-informative. _(default: undefined)_\n- **--dds-banner-info-text-color** - The text color of the info banner. Default is the design system's banner-text-informative. _(default: undefined)_\n- **--dds-banner-info-action-color** - The color of the info banner actions. Default is the design system's banner-action-enabled. _(default: undefined)_\n- **--dds-banner-positive-background** - The background color of the positive banner. Default is the design system's banner-background-positive. _(default: undefined)_\n- **--dds-banner-positive-icon-color** - The color of the positive banner icon. Default is the design system's banner-icon-positive. _(default: undefined)_\n- **--dds-banner-positive-text-color** - The text color of the positive banner. Default is the design system's banner-text-positive. _(default: undefined)_\n- **--dds-banner-positive-action-color** - The color of the positive banner actions. Default is the design system's banner-action-enabled. _(default: undefined)_\n- **--dds-banner-warning-background** - The background color of the warning banner. Default is the design system's banner-background-warning. _(default: undefined)_\n- **--dds-banner-warning-icon-color** - The color of the warning banner icon. Default is the design system's banner-icon-warning. _(default: undefined)_\n- **--dds-banner-warning-text-color** - The text color of the warning banner. Default is the design system's banner-text-warning. _(default: undefined)_\n- **--dds-banner-warning-action-color** - The color of the warning banner actions. Default is the design system's banner-action-inverted-enabled. _(default: undefined)_\n- **--dds-banner-negative-background** - The background color of the negative banner. Default is the design system's banner-background-negative. _(default: undefined)_\n- **--dds-banner-negative-icon-color** - The color of the negative banner icon. Default is the design system's banner-icon-negative. _(default: undefined)_\n- **--dds-banner-negative-text-color** - The text color of the negative banner. Default is the design system's banner-text-negative. _(default: undefined)_\n- **--dds-banner-negative-action-color** - The color of the negative banner actions. Default is the design system's banner-action-inverted-enabled. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main banner container.\n- **card-base** - The wrapper card container.\n- **icon** - The icon of the banner.\n- **icon-element** - The icon element of the banner.\n- **icon-base** - The base of the icon.\n- **closebutton** - The close button of the banner.\n- **close-icon-element** - The icon element of the close button.\n- **close-icon-base** - The base of the close button icon.\n- **actions** - The actions of the banner.\n- **title** - The title of the banner.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the banner",
"value": {
"type": "'brand' | 'positive' | 'info' | 'warning' | 'negative'",
"default": "'brand'"
}
},
{
"name": "closeable",
"description": "Whether the banner is closeable",
"value": { "type": "boolean" }
},
{
"name": "opened",
"description": "State of the banner. If false banner is hidden",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "closeButtonLabel",
"description": "The aria-label for the close button",
"value": { "type": "string", "default": "'close'" }
},
{
"name": "icon",
"description": "The icon of the banner, this is a name of a built icon icon",
"value": { "type": "string" }
}
],
"slots": [
{ "name": "", "description": "The content of the banner." },
{ "name": "actions", "description": "Actions of banner" },
{ "name": "icon", "description": "The icon of the banner." }
],
"events": [
{
"name": "dds-close",
"type": "{ void }",
"description": "Event fired when the banner is closed."
}
],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the banner",
"type": "'brand' | 'positive' | 'info' | 'warning' | 'negative'"
},
{
"name": "closeable",
"description": "Whether the banner is closeable",
"type": "boolean"
},
{
"name": "opened",
"description": "State of the banner. If false banner is hidden",
"type": "string"
},
{
"name": "closeButtonLabel",
"description": "The aria-label for the close button",
"type": "string"
},
{
"name": "icon",
"description": "The icon of the banner, this is a name of a built icon icon",
"type": "string"
}
],
"events": [
{
"name": "dds-close",
"type": "{ void }",
"description": "Event fired when the banner is closed."
}
]
}
},
{
"name": "dap-ds-breadcrumb",
"description": "A breadcrumb is a secondary navigation scheme that reveals the user's location in a website or Web application.\n---\n\n\n### **Slots:**\n - _default_ - The content of the breadcrumb.\n- **separator** - The separator between breadcrumb items. Default is '/'.\n\n### **CSS Properties:**\n - **--dds-breadcrumb-width** - The width of the breadcrumb container. Default is 100%. _(default: undefined)_\n- **--dds-breadcrumb-overflow-x** - The horizontal overflow behavior of the breadcrumb. Default is auto. _(default: undefined)_\n- **--dds-breadcrumb-transition** - The transition property for the breadcrumb. Default is 'all 0.2s ease-in-out'. _(default: undefined)_\n- **--dds-breadcrumb-list-display** - The display property of the breadcrumb list. Default is flex. _(default: undefined)_\n- **--dds-breadcrumb-list-flex-wrap** - The flex-wrap property of the breadcrumb list. Default is nowrap. _(default: undefined)_\n- **--dds-breadcrumb-list-align-items** - The align-items property of the breadcrumb list. Default is center. _(default: undefined)_\n- **--dds-breadcrumb-list-min-width** - The minimum width of the breadcrumb list. Default is max-content. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main breadcrumb container.\n- **separator** - The separator of the breadcrumb.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"value": { "type": "string", "default": "'normal'" }
},
{
"name": "mobile",
"description": "Mobile version of the breadcrumb",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "aria-labelledby",
"description": "The aria-labelledby of the breadcrumb",
"value": { "type": "string | undefined" }
}
],
"slots": [
{ "name": "", "description": "The content of the breadcrumb." },
{
"name": "separator",
"description": "The separator between breadcrumb items. Default is '/'."
}
],
"events": [],
"js": {
"properties": [
{ "name": "variant", "type": "string" },
{
"name": "mobile",
"description": "Mobile version of the breadcrumb",
"type": "boolean"
},
{
"name": "ariaLabelledBy",
"description": "The aria-labelledby of the breadcrumb",
"type": "string | undefined"
}
],
"events": []
}
},
{
"name": "dap-ds-breadcrumb-item",
"description": "A breadcrumb item is a secondary navigation scheme that reveals the user's location in a website or Web application.\n---\n\n\n### **Slots:**\n - _default_ - The content of the breadcrumb item.\n- **separator** - The separator between breadcrumb items. Default is an arrow-right-s-line icon.\n\n### **CSS Properties:**\n - **--dds-breadcrumb-item-display** - The display property of the breadcrumb item. Default is inline-flex. _(default: undefined)_\n- **--dds-breadcrumb-item-flex-wrap** - The flex-wrap property of the breadcrumb item. Default is nowrap. _(default: undefined)_\n- **--dds-breadcrumb-item-align-items** - The align-items property of the breadcrumb item. Default is center. _(default: undefined)_\n- **--dds-breadcrumb-item-color** - The text color of the breadcrumb item. Default is the design system's text-neutral-base. _(default: undefined)_\n- **--dds-breadcrumb-item-transition** - The transition property for the breadcrumb item. Default is 'all 0.2s ease-in-out'. _(default: undefined)_\n- **--dds-breadcrumb-item-gap** - The gap between the breadcrumb item and the separator. Default is the design system's spacing-200. _(default: undefined)_\n- **--dds-breadcrumb-item-padding** - The padding of the breadcrumb item. Default is the design system's spacing-200. _(default: undefined)_\n- **--dds-breadcrumb-item-font-size** - The font size of the breadcrumb item. Default is the design system's font-sm. _(default: undefined)_\n- **--dds-breadcrumb-item-font-weight** - The font weight of the breadcrumb item. Default is the design system's font-weight-medium. _(default: undefined)_\n- **--dds-breadcrumb-item-font-weight-bold** - The bold font weight of the breadcrumb item. Default is the design system's font-weight-bold. _(default: undefined)_\n- **--dds-breadcrumb-item-separator-color** - The color of the separator. Default is the design system's text-neutral-disabled. _(default: undefined)_\n- **--dds-breadcrumb-item-link-color** - The color of the link. Default is the design system's link-neutral-enabled. _(default: undefined)_\n- **--dds-breadcrumb-item-inverted-color** - The text color when inverted. Default is the design system's text-neutral-inverted. _(default: undefined)_\n- **--dds-breadcrumb-item-inverted-link-color** - The link color when inverted. Default is the design system's text-neutral-inverted. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main breadcrumb item container. The li element.\n- **link** - The link of the breadcrumb item. The dds-link component.\n- **link-base** - The base part of the link part. The dds-link components base part.\n- **item-nolink** - The item of the breadcrumb item without a link. The span element.\n- **separator** - The separator of the breadcrumb item.",
"doc-url": "",
"attributes": [
{
"name": "href",
"description": "The URL of the breadcrumb item.",
"value": { "type": "string | undefined" }
},
{
"name": "target",
"description": "The target of the breadcrumb item.",
"value": { "type": "'_blank' | '_self' | '_parent' | '_top'" }
},
{
"name": "rel",
"description": "The rel of the breadcrumb item link.",
"value": { "type": "string", "default": "'noreferrer noopener'" }
},
{
"name": "disabled",
"description": "Whether the breadcrumb item is disabled.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "variant",
"description": "The variant of the breadcrumb item.",
"value": {
"type": "'normal' | 'inverted'",
"default": "'normal'"
}
}
],
"slots": [
{
"name": "",
"description": "The content of the breadcrumb item."
},
{
"name": "separator",
"description": "The separator between breadcrumb items. Default is an arrow-right-s-line icon."
}
],
"events": [],
"js": {
"properties": [
{
"name": "href",
"description": "The URL of the breadcrumb item.",
"type": "string | undefined"
},
{
"name": "target",
"description": "The target of the breadcrumb item.",
"type": "'_blank' | '_self' | '_parent' | '_top'"
},
{
"name": "rel",
"description": "The rel of the breadcrumb item link.",
"type": "string"
},
{
"name": "disabled",
"description": "Whether the breadcrumb item is disabled.",
"type": "boolean"
},
{
"name": "variant",
"description": "The variant of the breadcrumb item.",
"type": "'normal' | 'inverted'"
}
],
"events": []
}
},
{
"name": "dap-ds-button",
"description": "A button is a clickable element that can be used to trigger an action, submit forms, or navigate to other pages.\n---\n\n\n### **Events:**\n - **dds-loading-timeout** - Emitted when the loading timeout is reached\n\n### **Slots:**\n - _default_ - The content of the button. Can contain text, icons, or other elements.\n\n### **CSS Properties:**\n - **--dds-button-padding-x** - Horizontal padding of the button (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-button-padding-y** - Vertical padding of the button (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-button-border-radius** - Border radius of the button (default: var(--dds-radius-rounded)) _(default: undefined)_\n- **--dds-button-font-weight** - Font weight of the button (default: 700) _(default: undefined)_\n- **--dds-button-line-height** - Line height of the button (default: var(--dds-font-line-height-large)) _(default: undefined)_\n- **--dds-button-transition** - Transition property of the button (default: all 0.2s ease-in-out) _(default: undefined)_\n- **--dds-button-disabled-opacity** - Opacity of disabled button (default: 0.5) _(default: undefined)_\n- **--dds-button-size-lg** - Size of large button (default: var(--dds-spacing-1200)) _(default: undefined)_\n- **--dds-button-size-md** - Size of medium button (default: var(--dds-spacing-1000)) _(default: undefined)_\n- **--dds-button-size-sm** - Size of small button (default: var(--dds-spacing-800)) _(default: undefined)_\n- **--dds-button-size-xs** - Size of extra small button (default: var(--dds-spacing-600)) _(default: undefined)_\n- **--dds-button-circle-lg** - Size of large circle button (default: var(--dds-spacing-1200)) _(default: undefined)_\n- **--dds-button-circle-md** - Size of medium circle button (default: var(--dds-spacing-1000)) _(default: undefined)_\n- **--dds-button-circle-sm** - Size of small circle button (default: var(--dds-spacing-800)) _(default: undefined)_\n- **--dds-button-circle-xs** - Size of extra small circle button (default: var(--dds-spacing-600)) Primary button properties: _(default: undefined)_\n- **--dds-button-primary-color-bg** - Background color of primary button (default: var(--dds-button-primary-background-enabled)) _(default: undefined)_\n- **--dds-button-primary-color-bg-hover** - Background color of primary button on hover (default: var(--dds-button-primary-background-hover)) _(default: undefined)_\n- **--dds-button-primary-color-bg-active** - Background color of primary button when active (default: var(--dds-button-primary-background-pressed)) _(default: undefined)_\n- **--dds-button-primary-color-bg-disabled** - Background color of disabled primary button (default: var(--dds-button-primary-background-disabled)) _(default: undefined)_\n- **--dds-button-primary-color-text** - Text color of primary button (default: var(--dds-button-primary-text-enabled)) _(default: undefined)_\n- **--dds-button-primary-color-text-disabled** - Text color of disabled primary button (default: var(--dds-button-primary-text-disabled)) Primary inverted button properties: _(default: undefined)_\n- **--dds-button-primary-inverted-color-bg** - Background color of primary inverted button (default: var(--dds-button-primary-background-inverted-enabled)) _(default: undefined)_\n- **--dds-button-primary-inverted-color-bg-hover** - Background color of primary inverted button on hover (default: var(--dds-button-primary-background-inverted-hover)) _(default: undefined)_\n- **--dds-button-primary-inverted-color-bg-active** - Background color of primary inverted button when active (default: var(--dds-button-primary-background-inverted-pressed)) _(default: undefined)_\n- **--dds-button-primary-inverted-color-bg-disabled** - Background color of disabled primary inverted button (default: var(--dds-button-primary-background-inverted-disabled)) _(default: undefined)_\n- **--dds-button-primary-inverted-color-text** - Text color of primary inverted button (default: var(--dds-button-primary-text-inverted)) _(default: undefined)_\n- **--dds-button-primary-inverted-color-text-disabled** - Text color of disabled primary inverted button (default: var(--dds-button-primary-text-inverted-disabled)) Outline button properties: _(default: undefined)_\n- **--dds-button-outline-color-border** - Border color of outline button (default: var(--dds-button-outline-border-enabled)) _(default: undefined)_\n- **--dds-button-outline-color-border-hover** - Border color of outline button on hover (default: var(--dds-button-outline-border-hover)) _(default: undefined)_\n- **--dds-button-outline-color-border-active** - Border color of outline button when active (default: var(--dds-button-outline-border-pressed)) _(default: undefined)_\n- **--dds-button-outline-color-border-disabled** - Border color of disabled outline button (default: var(--dds-button-outline-border-disabled)) _(default: undefined)_\n- **--dds-button-outline-color-text** - Text color of outline button (default: var(--dds-button-outline-text-enabled)) _(default: undefined)_\n- **--dds-button-outline-color-text-hover** - Text color of outline button on hover (default: var(--dds-button-outline-text-hover)) _(default: undefined)_\n- **--dds-button-outline-color-text-active** - Text color of outline button when active (default: var(--dds-button-outline-text-pressed)) _(default: undefined)_\n- **--dds-button-outline-color-text-disabled** - Text color of disabled outline button (default: var(--dds-button-outline-text-disabled)) Outline inverted button properties: _(default: undefined)_\n- **--dds-button-outline-inverted-color-border** - Border color of outline inverted button (default: var(--dds-button-outline-border-inverted-enabled)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-border-hover** - Border color of outline inverted button on hover (default: var(--dds-button-outline-border-inverted-hover)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-border-active** - Border color of outline inverted button when active (default: var(--dds-button-outline-border-inverted-pressed)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-border-disabled** - Border color of disabled outline inverted button (default: var(--dds-button-outline-border-inverted-disabled)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-text** - Text color of outline inverted button (default: var(--dds-button-outline-text-inverted-enabled)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-text-hover** - Text color of outline inverted button on hover (default: var(--dds-button-outline-text-inverted-hover)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-text-active** - Text color of outline inverted button when active (default: var(--dds-button-outline-text-inverted-pressed)) _(default: undefined)_\n- **--dds-button-outline-inverted-color-text-disabled** - Text color of disabled outline inverted button (default: var(--dds-button-outline-text-inverted-disabled)) Subtle button properties: _(default: undefined)_\n- **--dds-button-subtle-color-bg** - Background color of subtle button (default: var(--dds-button-subtle-background-enabled)) _(default: undefined)_\n- **--dds-button-subtle-color-bg-hover** - Background color of subtle button on hover (default: var(--dds-button-subtle-background-hover)) _(default: undefined)_\n- **--dds-button-subtle-color-bg-active** - Background color of subtle button when active (default: var(--dds-button-subtle-background-pressed)) _(default: undefined)_\n- **--dds-button-subtle-color-bg-disabled** - Background color of disabled subtle button (default: var(--dds-button-subtle-background-disabled)) _(default: undefined)_\n- **--dds-button-subtle-color-border** - Border color of subtle button (default: var(--dds-button-subtle-border-enabled)) _(default: undefined)_\n- **--dds-button-subtle-color-border-hover** - Border color of subtle button on hover (default: var(--dds-button-subtle-border-hover)) _(default: undefined)_\n- **--dds-button-subtle-color-border-active** - Border color of subtle button when active (default: var(--dds-button-subtle-border-pressed)) _(default: undefined)_\n- **--dds-button-subtle-color-border-disabled** - Border color of disabled subtle button (default: var(--dds-button-subtle-border-disabled)) _(default: undefined)_\n- **--dds-button-subtle-color-text** - Text color of subtle button (default: var(--dds-button-subtle-text-enabled)) _(default: undefined)_\n- **--dds-button-subtle-color-text-hover** - Text color of subtle button on hover (default: var(--dds-button-subtle-text-hover)) _(default: undefined)_\n- **--dds-button-subtle-color-text-active** - Text color of subtle button when active (default: var(--dds-button-subtle-text-pressed)) _(default: undefined)_\n- **--dds-button-subtle-color-text-disabled** - Text color of disabled subtle button (default: var(--dds-button-subtle-text-disabled)) Clean button properties: _(default: undefined)_\n- **--dds-button-clean-color-text** - Text color of clean button (default: var(--dds-text-link-base)) _(default: undefined)_\n- **--dds-button-clean-color-text-hover** - Text color of clean button on hover (default: var(--dds-text-link-hover)) _(default: undefined)_\n- **--dds-button-clean-color-text-active** - Text color of clean button when active (default: var(--dds-text-link-pressed)) _(default: undefined)_\n- **--dds-button-clean-color-text-disabled** - Text color of disabled clean button (default: var(--dds-text-neutral-disabled)) Clean inverted button properties: _(default: undefined)_\n- **--dds-button-clean-inverted-color-text** - Text color of clean inverted button (default: var(--dds-button-primary-text-inverted)) _(default: undefined)_\n- **--dds-button-clean-inverted-color-text-hover** - Text color of clean inverted button on hover (default: var(--dds-button-primary-text-inverted)) _(default: undefined)_\n- **--dds-button-clean-inverted-color-text-active** - Text color of clean inverted button when active (default: var(--dds-button-primary-text-inverted)) _(default: undefined)_\n- **--dds-button-clean-inverted-color-text-disabled** - Text color of disabled clean inverted button (default: var(--dds-text-neutral-disabled)) Danger button properties: _(default: undefined)_\n- **--dds-button-danger-color-bg** - Background color of danger button (default: var(--dds-button-primary-background-destructive-enabled)) _(default: undefined)_\n- **--dds-button-danger-color-bg-hover** - Background color of danger button on hover (default: var(--dds-button-primary-background-destructive-hover)) _(default: undefined)_\n- **--dds-button-danger-color-bg-active** - Background color of danger button when active (default: var(--dds-button-primary-background-destructive-pressed)) _(default: undefined)_\n- **--dds-button-danger-color-text** - Text color of danger button (default: var(--dds-button-primary-text-enabled)) _(default: undefined)_\n- **--dds-button-danger-outline-color-border** - Border color of danger outline button (default: var(--dds-button-outline-border-destructive-enabled)) _(default: undefined)_\n- **--dds-button-danger-outline-color-border-hover** - Border color of danger outline button on hover (default: var(--dds-button-outline-border-destructive-hover)) _(default: undefined)_\n- **--dds-button-danger-outline-color-border-active** - Border color of danger outline button when active (default: var(--dds-button-outline-border-destructive-pressed)) _(default: undefined)_\n- **--dds-button-danger-outline-color-text** - Text color of danger outline button (default: var(--dds-button-outline-text-destructive-enabled)) _(default: undefined)_\n- **--dds-button-danger-outline-color-text-hover** - Text color of danger outline button on hover (default: var(--dds-button-outline-text-destructive-hover)) _(default: undefined)_\n- **--dds-button-danger-outline-color-text-active** - Text color of danger outline button when active (default: var(--dds-button-outline-text-destructive-pressed)) _(default: undefined)_\n- **--dds-button-danger-subtle-color-bg** - Background color of danger subtle button (default: var(--dds-button-subtle-background-destructive-enabled)) _(default: undefined)_\n- **--dds-button-danger-subtle-color-bg-hover** - Background color of danger subtle button on hover (default: var(--dds-button-subtle-background-destructive-hover)) _(default: undefined)_\n- **--dds-button-danger-subtle-color-bg-active** - Background color of danger subtle button when active (default: var(--dds-button-subtle-background-destructive-pressed)) _(default: undefined)_\n- **--dds-button-danger-subtle-color-text** - Text color of danger subtle button (default: var(--dds-button-subtle-text-destructive-enabled)) _(default: undefined)_\n- **--dds-button-danger-subtle-color-text-hover** - Text color of danger subtle button on hover (default: var(--dds-button-subtle-text-destructive-hover)) _(default: undefined)_\n- **--dds-button-danger-subtle-color-text-active** - Text color of danger subtle button when active (default: var(--dds-button-subtle-text-destructive-pressed)) _(default: undefined)_\n- **--dds-button-danger-clean-color-text** - Text color of danger clean button (default: var(--dds-text-negative-subtle)) _(default: undefined)_\n- **--dds-button-danger-clean-color-text-hover** - Text color of danger clean button on hover (default: var(--dds-text-negative-base)) _(default: undefined)_\n- **--dds-button-danger-clean-color-text-active** - Text color of danger clean button when active (default: var(--dds-text-negative-strong)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main button container.\n- **high-contrast** - The high contrast part of the button.\n- **content** - The content wrapper inside the button.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The visual style variant of the button",
"value": {
"type": "'primary' | 'outline' | 'subtle' | 'subtle-neutral' | 'subtle-quiet' | 'subtle-quiet-inverted' | 'clean' | 'primary-inverted' | 'outline-inverted' | 'subtle-inverted' | 'clean-inverted' | 'subtle-menu' | 'subtle-menu-item'",
"default": "'primary'"
}
},
{
"name": "size",
"description": "The size of the button affecting padding and font size",
"value": {
"type": "'lg' | 'md' | 'sm' | 'xs'",
"default": "'md'"
}
},
{
"name": "loading",
"description": "Whether the button is in loading state, showing a spinner and disabling interaction",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "danger",
"description": "Whether the button represents a destructive action (applies danger styling)",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "shape",
"description": "The shape of the button - use 'circle' for icon-only buttons",
"value": { "type": "'button' | 'circle'", "default": "'button'" }
},
{
"name": "htmlType",
"description": "The HTML type attribute for form interaction",
"value": {
"type": "'button' | 'submit' | 'reset'",
"default": "'button'"
}
},
{
"name": "href",
"description": "The URL to navigate to. When present, the button renders as an anchor element",
"value": { "type": "string | undefined" }
},
{
"name": "target",
"description": "The target attribute for link navigation",
"value": {
"type": "'_blank' | '_self' | '_parent' | '_top'",
"default": "'_self'"
}
},
{
"name": "rel",
"description": "The rel attribute for link security and behavior",
"value": {
"type": "string | undefined",
"default": "'noreferrer noopener'"
}
},
{
"name": "aria-controls",
"description": "The ID of the element controlled by this button",
"value": { "type": "string | undefined" }
},
{
"name": "aria-describedby",
"description": "The ID of the element that describes the button",
"value": { "type": "string | undefined" }
},
{
"name": "loadingTimeout",
"description": "Controls loading timeout in milliseconds",
"value": { "type": "number", "default": "0" }
},
{
"name": "active",
"description": "Whether the button is active",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "",
"description": "The content of the button. Can contain text, icons, or other elements."
}
],
"events": [
{
"name": "dds-loading-timeout",
"description": "Emitted when the loading timeout is reached"
}
],
"js": {
"properties": [
{
"name": "variant",
"description": "The visual style variant of the button",
"type": "'primary' | 'outline' | 'subtle' | 'subtle-neutral' | 'subtle-quiet' | 'subtle-quiet-inverted' | 'clean' | 'primary-inverted' | 'outline-inverted' | 'subtle-inverted' | 'clean-inverted' | 'subtle-menu' | 'subtle-menu-item'"
},
{
"name": "size",
"description": "The size of the button affecting padding and font size",
"type": "'lg' | 'md' | 'sm' | 'xs'"
},
{
"name": "loading",
"description": "Whether the button is in loading state, showing a spinner and disabling interaction",
"type": "boolean"
},
{
"name": "danger",
"description": "Whether the button represents a destructive action (applies danger styling)",
"type": "boolean"
},
{
"name": "shape",
"description": "The shape of the button - use 'circle' for icon-only buttons",
"type": "'button' | 'circle'"
},
{
"name": "htmlType",
"description": "The HTML type attribute for form interaction",
"type": "'button' | 'submit' | 'reset'"
},
{
"name": "href",
"description": "The URL to navigate to. When present, the button renders as an anchor element",
"type": "string | undefined"
},
{
"name": "target",
"description": "The target attribute for link navigation",
"type": "'_blank' | '_self' | '_parent' | '_top'"
},
{
"name": "rel",
"description": "The rel attribute for link security and behavior",
"type": "string | undefined"
},
{
"name": "ariaControls",
"description": "The ID of the element controlled by this button",
"type": "string | undefined"
},
{
"name": "ariaDescribedBy",
"description": "The ID of the element that describes the button",
"type": "string | undefined"
},
{
"name": "loadingTimeout",
"description": "Controls loading timeout in milliseconds",
"type": "number"
},
{
"name": "active",
"description": "Whether the button is active",
"type": "boolean"
}
],
"events": [
{
"name": "dds-loading-timeout",
"description": "Emitted when the loading timeout is reached"
}
]
}
},
{
"name": "dap-ds-calendar-cell",
"description": "Calendar cell represents a single cell in the calendar.\n---\n\n\n### **Slots:**\n - _default_ - The content of the calendar cell.\n\n### **CSS Parts:**\n - **base** - The main calendar cell container.\n- **today-mark** - The today mark of the calendar cell.",
"doc-url": "",
"attributes": [
{
"name": "selected",
"description": "Whether the calendar cell is selected.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "disabledDay",
"description": "Whether the calendar cell is disabled.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "today",
"description": "Whether the calendar cell is today.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "outOfRange",
"description": "Whether the calendar cell is out of range.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "header",
"description": "Whether the calendar cell is a date header.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "focused",
"description": "Whether the calendar cell is focused.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{ "name": "", "description": "The content of the calendar cell." }
],
"events": [],
"js": {
"properties": [
{
"name": "value",
"description": "The value of the calendar cell.",
"type": "Dayjs"
},
{
"name": "selected",
"description": "Whether the calendar cell is selected.",
"type": "boolean"
},
{
"name": "disabledDay",
"description": "Whether the calendar cell is disabled.",
"type": "boolean"
},
{
"name": "today",
"description": "Whether the calendar cell is today.",
"type": "boolean"
},
{
"name": "outOfRange",
"description": "Whether the calendar cell is out of range.",
"type": "boolean"
},
{
"name": "header",
"description": "Whether the calendar cell is a date header.",
"type": "boolean"
},
{
"name": "focused",
"description": "Whether the calendar cell is focused.",
"type": "boolean"
},
{ "name": "label", "type": "string" },
{ "name": "focusElement", "type": "HTMLElement" }
],
"events": []
}
},
{
"name": "dap-ds-calendar",
"description": "A calendar is a visual representation of dates. It allows users to select a date.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the calendar value changes.\n\n### **Slots:**\n - _default_ - The content of the calendar.\n\n### **CSS Properties:**\n - **--dds-calendar-display** - The display property of the calendar container. Default is flex. _(default: undefined)_\n- **--dds-calendar-isolation** - The isolation property of the calendar. Default is isolate. _(default: undefined)_\n- **--dds-calendar-block-display** - The display property of the calendar block. Default is block. _(default: undefined)_\n- **--dds-calendar-transition** - The transition property for the calendar. Default is 'all 0.2s ease-in-out'. _(default: undefined)_\n- **--dds-calendar-header-display** - The display property of the calendar header. Default is grid. _(default: undefined)_\n- **--dds-calendar-header-grid-flow** - The grid-auto-flow property of the calendar header. Default is column. _(default: undefined)_\n- **--dds-calendar-header-width** - The width of the calendar header. Default is 100%. _(default: undefined)_\n- **--dds-calendar-header-gap** - The gap between header items. Default is the design system's spacing-100. _(default: undefined)_\n- **--dds-calendar-select-min-height** - The minimum height of the select trigger. Default is auto. _(default: undefined)_\n- **--dds-calendar-select-max-height** - The maximum height of the select trigger. Default is 32px. _(default: undefined)_\n- **--dds-calendar-select-padding** - The padding of the select trigger. Default is the design system's spacing-200. _(default: undefined)_\n- **--dds-calendar-select-border-radius** - The border radius of the select trigger. Default is the design system's radius-rounded. _(default: undefined)_\n- **--dds-calendar-select-border-color** - The border color of the select trigger. Default is the design system's border-neutral-transparent-interactive. _(default: undefined)_\n- **--dds-calendar-select-background** - The background color of the select trigger. Default is the design system's button-subtle-background-enabled. _(default: undefined)_\n- **--dds-calendar-select-color** - The text color of the select trigger. Default is the design system's button-subtle-text-enabled. _(default: undefined)_\n- **--dds-calendar-select-font-size** - The font size of the select trigger. Default is the design system's font-sm. _(default: undefined)_\n- **--dds-calendar-select-font-style** - The font style of the select trigger. Default is normal. _(default: undefined)_\n- **--dds-calendar-select-font-weight** - The font weight of the select trigger. Default is the design system's font-weight-bold. _(default: undefined)_\n- **--dds-calendar-nav-button-margin** - The margin of the navigation buttons. Default is the design system's spacing-200. _(default: undefined)_\n- **--dds-calendar-nav-button-color** - The color of the navigation button icons. Default is the design system's button-subtle-icon-enabled. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main calendar container.\n- **header** - The header of the calendar.\n- **body** - The body of the calendar.",
"doc-url": "",
"attributes": [
{
"name": "locale",
"description": "The locale of the calendar.",
"value": { "type": "string", "default": "dayjs.locale()" }
}
],
"slots": [
{ "name": "", "description": "The content of the calendar." }
],
"events": [
{
"name": "dds-change",
"type": "{ value: Dayjs }",
"description": "Fired when the calendar value changes."
}
],
"js": {
"properties": [
{
"name": "value",
"description": "The value of the calendar.",
"type": "Dayjs"
},
{
"name": "currentDate",
"description": "The current visible date of the calendar. Only the month and year are considered.",
"type": "Dayjs"
},
{
"name": "minDate",
"description": "The minimum date of the calendar. Only the month and year are considered.",
"type": "Dayjs"
},
{
"name": "maxDate",
"description": "The maximum date of the calendar. Only the month and year are considered.",
"type": "Dayjs"
},
{
"name": "disabledDate",
"description": "The function to determine if the date is disabled.",
"type": "Function"
},
{
"name": "locale",
"description": "The locale of the calendar.",
"type": "string"
},
{ "name": "startDate" },
{ "name": "endDate" }
],
"events": [
{
"name": "dds-change",
"type": "{ value: Dayjs }",
"description": "Fired when the calendar value changes."
}
]
}
},
{
"name": "dap-ds-callout",
"description": "`dap-ds-callout` is a custom callout component.\n---\n\n\n### **Events:**\n - **dds-close** - Fired when the close button is clicked.\n\n### **Slots:**\n - _default_ - The content of the callout.\n- **title** - The title of the callout.\n- **icon** - The icon of the callout.\n- **actions** - The actions of the callout.\n- **close** - The close button of the callout.\n\n### **CSS Properties:**\n - **--dds-callout-padding** - Padding of the callout content. Default: var(--dds-spacing-300) _(default: undefined)_\n- **--dds-callout-gap** - Gap between elements in horizontal layout. Default: var(--dds-spacing-300) _(default: undefined)_\n- **--dds-callout-icon-size** - Size of the icon. Default: var(--dds-spacing-600) _(default: undefined)_\n- **--dds-callout-title-color** - Color of the title text. Default: var(--dds-text-neutral-strong) _(default: undefined)_\n- **--dds-callout-description-color** - Color of the description text. Default: var(--dds-text-neutral-base) _(default: undefined)_\n- **--dds-callout-title-font-size** - Font size of the title. Default: var(--dds-font-base) _(default: undefined)_\n- **--dds-callout-description-font-size** - Font size of the description. Default: var(--dds-font-base) _(default: undefined)_\n- **--dds-callout-title-font-weight** - Font weight of the title. Default: var(--dds-font-weight-bold) _(default: undefined)_\n- **--dds-callout-description-font-weight** - Font weight of the description. Default: var(--dds-font-weight-medium) _(default: undefined)_\n- **--dds-callout-actions-font-weight** - Font weight of the actions. Default: var(--dds-font-weight-bold) _(default: undefined)_\n- **--dds-callout-actions-gap** - Gap between action items. Default: var(--dds-spacing-400) _(default: undefined)_\n- **--dds-callout-content-gap** - Gap between content elements. Default: var(--dds-spacing-100) _(default: undefined)_\n- **--dds-callout-border-radius** - Border radius of the callout. Default: var(--dds-radius-base) _(default: undefined)_\n- **--dds-callout-brand-background** - Brand variant background color. Default: var(--dds-background-brand-base) _(default: undefined)_\n- **--dds-callout-brand-background-subtle** - Brand variant subtle background color. Default: var(--dds-background-brand-subtle) _(default: undefined)_\n- **--dds-callout-brand-background-medium** - Brand variant medium background color. Default: var(--dds-background-brand-medium) _(default: undefined)_\n- **--dds-callout-brand-background-strong** - Brand variant strong background color. Default: var(--dds-background-brand-strong) _(default: undefined)_\n- **--dds-callout-brand-icon** - Brand variant icon color. Default: var(--dds-icon-brand-subtle) _(default: undefined)_\n- **--dds-callout-brand-border** - Brand variant border color. Default: var(--dds-border-brand-subtle) _(default: undefined)_\n- **--dds-callout-info-background** - Info variant background color. Default: var(--dds-background-informative-base) _(default: undefined)_\n- **--dds-callout-info-background-subtle** - Info variant subtle background color. Default: var(--dds-background-informative-subtle) _(default: undefined)_\n- **--dds-callout-info-background-medium** - Info variant medium background color. Default: var(--dds-background-informative-medium) _(default: undefined)_\n- **--dds-callout-info-background-strong** - Info variant strong background color. Default: var(--dds-background-informative-strong) _(default: undefined)_\n- **--dds-callout-info-icon** - Info variant icon color. Default: var(--dds-icon-informative-subtle) _(default: undefined)_\n- **--dds-callout-info-border** - Info variant border color. Default: var(--dds-border-informative-subtle) _(default: undefined)_\n- **--dds-callout-positive-background** - Positive variant background color. Default: var(--dds-background-positive-base) _(default: undefined)_\n- **--dds-callout-positive-background-subtle** - Positive variant subtle background color. Default: var(--dds-background-positive-subtle) _(default: undefined)_\n- **--dds-callout-positive-background-medium** - Positive variant medium background color. Default: var(--dds-background-positive-medium) _(default: undefined)_\n- **--dds-callout-positive-background-strong** - Positive variant strong background color. Default: var(--dds-background-positive-strong) _(default: undefined)_\n- **--dds-callout-positive-icon** - Positive variant icon color. Default: var(--dds-icon-positive-subtle) _(default: undefined)_\n- **--dds-callout-positive-border** - Positive variant border color. Default: var(--dds-border-positive-subtle) _(default: undefined)_\n- **--dds-callout-warning-background** - Warning variant background color. Default: var(--dds-background-warning-base) _(default: undefined)_\n- **--dds-callout-warning-background-subtle** - Warning variant subtle background color. Default: var(--dds-background-warning-subtle) _(default: undefined)_\n- **--dds-callout-warning-background-medium** - Warning variant medium background color. Default: var(--dds-background-warning-medium) _(default: undefined)_\n- **--dds-callout-warning-background-strong** - Warning variant strong background color. Default: var(--dds-background-warning-strong) _(default: undefined)_\n- **--dds-callout-warning-icon** - Warning variant icon color. Default: var(--dds-icon-neutral-strong) _(default: undefined)_\n- **--dds-callout-warning-border** - Warning variant border color. Default: var(--dds-border-warning-subtle) _(default: undefined)_\n- **--dds-callout-negative-background** - Negative variant background color. Default: var(--dds-background-negative-base) _(default: undefined)_\n- **--dds-callout-negative-background-subtle** - Negative variant subtle background color. Default: var(--dds-background-negative-subtle) _(default: undefined)_\n- **--dds-callout-negative-background-medium** - Negative variant medium background color. Default: var(--dds-background-negative-medium) _(default: undefined)_\n- **--dds-callout-negative-background-strong** - Negative variant strong background color. Default: var(--dds-background-negative-strong) _(default: undefined)_\n- **--dds-callout-negative-icon** - Negative variant icon color. Default: var(--dds-icon-negative-subtle) _(default: undefined)_\n- **--dds-callout-negative-border** - Negative variant border color. Default: var(--dds-border-negative-subtle) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main callout container.\n- **icon** - The icon of the callout.\n- **title** - The title of the callout.\n- **description** - The description of the callout.\n- **actions** - The actions of the callout.\n- **close** - The close button of the callout.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the callout",
"value": {
"type": "'brand' | 'positive' | 'info' | 'warning' | 'negative'",
"default": "'brand'"
}
},
{
"name": "alignment",
"description": "The alignment of the callout. Can be `vertical` or `horizontal`.",
"value": {
"type": "'vertical' | 'horizontal'",
"default": "'horizontal'"
}
},
{
"name": "shade",
"description": "The strongness of the callout. Can be `subtle`, `base`, `medium`, or `strong`.",
"value": {
"type": "'subtle' | 'base' | 'medium' | 'strong'",
"default": "'base'"
}
},
{
"name": "noBorder",
"description": "The border of the callout",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "closeable",
"description": "If the callout has a close button",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "title",
"description": "The header of the callout",
"value": { "type": "string" }
},
{
"name": "closeButtonLabel",
"description": "The label of the close button",
"value": { "type": "string" }
},
{
"name": "opened",
"description": "If the callout is opened",
"value": { "type": "string", "default": "'true'" }
}
],
"slots": [
{ "name": "", "description": "The content of the callout." },
{ "name": "title", "description": "The title of the callout." },
{ "name": "icon", "description": "The icon of the callout." },
{ "name": "actions", "description": "The actions of the callout." },
{
"name": "close",
"description": "The close button of the callout."
}
],
"events": [
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the close button is clicked."
}
],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the callout",
"type": "'brand' | 'positive' | 'info' | 'warning' | 'negative'"
},
{
"name": "alignment",
"description": "The alignment of the callout. Can be `vertical` or `horizontal`.",
"type": "'vertical' | 'horizontal'"
},
{
"name": "shade",
"description": "The strongness of the callout. Can be `subtle`, `base`, `medium`, or `strong`.",
"type": "'subtle' | 'base' | 'medium' | 'strong'"
},
{
"name": "noBorder",
"description": "The border of the callout",
"type": "string"
},
{
"name": "closeable",
"description": "If the callout has a close button",
"type": "boolean"
},
{
"name": "title",
"description": "The header of the callout",
"type": "string"
},
{
"name": "closeButtonLabel",
"description": "The label of the close button",
"type": "string"
},
{
"name": "opened",
"description": "If the callout is opened",
"type": "string"
}
],
"events": [
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the close button is clicked."
}
]
}
},
{
"name": "dap-ds-checkbox",
"description": "A checkbox is a form element that allows the user to select one or more options from a set.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the checkbox is checked or unchecked.\n- **dds-blur** - Emitted when the checkbox loses focus.\n- **dds-focus** - Emitted when the checkbox gains focus.\n- **dds-input** - Emitted when the checkbox receives input.\n\n### **Methods:**\n - **focus(): _void_** - Programmatically focuses the checkbox input element.\n- **blur(): _void_** - Programmatically blurs the checkbox input element.\n\n### **CSS Properties:**\n - **--dds-checkbox-size** - The size of the checkbox. Default is `var(--dds-spacing-500)`. _(default: undefined)_\n- **--dds-checkbox-border-width** - The border width of the checkbox. Default is `var(--dds-border-width-large)`. _(default: undefined)_\n- **--dds-checkbox-border-radius** - The border radius of the checkbox. Default is `var(--dds-radius-small)`. _(default: undefined)_\n- **--dds-checkbox-border-color** - The border color of the checkbox. Default is `var(--dds-border-neutral-base)`. _(default: undefined)_\n- **--dds-checkbox-background-color** - The background color of the checkbox. Default is `transparent`. _(default: undefined)_\n- **--dds-checkbox-icon-color** - The color of the checkbox icon. Default is `var(--dds-button-primary-icon-enabled)`. _(default: undefined)_\n- **--dds-checkbox-hover-border-color** - The border color when hovering over the checkbox. Default is `var(--dds-border-neutral-medium)`. _(default: undefined)_\n- **--dds-checkbox-hover-background-color** - The background color when hovering over the checkbox. Default is `var(--dds-background-neutral-medium)`. _(default: undefined)_\n- **--dds-checkbox-active-border-color** - The border color when the checkbox is active. Default is `var(--dds-border-neutral-strong)`. _(default: undefined)_\n- **--dds-checkbox-active-background-color** - The background color when the checkbox is active. Default is `var(--dds-background-neutral-strong)`. _(default: undefined)_\n- **--dds-checkbox-checked-border-color** - The border color when the checkbox is checked. Default is `var(--dds-background-brand-base-inverted)`. _(default: undefined)_\n- **--dds-checkbox-checked-background-color** - The background color when the checkbox is checked. Default is `var(--dds-background-brand-base-inverted)`. _(default: undefined)_\n- **--dds-checkbox-checked-hover-border-color** - The border color when hovering over a checked checkbox. Default is `var(--dds-background-brand-medium-inverted)`. _(default: undefined)_\n- **--dds-checkbox-checked-hover-background-color** - The background color when hovering over a checked checkbox. Default is `var(--dds-background-brand-medium-inverted)`. _(default: undefined)_\n- **--dds-checkbox-checked-active-border-color** - The border color when a checked checkbox is active. Default is `var(--dds-background-brand-strong-inverted)`. _(default: undefined)_\n- **--dds-checkbox-checked-active-background-color** - The background color when a checked checkbox is active. Default is `var(--dds-background-brand-strong-inverted)`. _(default: undefined)_\n- **--dds-checkbox-invalid-border-color** - The border color when the checkbox is invalid. Default is `var(--dds-border-negative-base)`. _(default: undefined)_\n- **--dds-checkbox-invalid-background-color** - The background color when the checkbox is invalid. Default is `var(--dds-background-negative-base)`. _(default: undefined)_\n- **--dds-checkbox-invalid-hover-border-color** - The border color when hovering over an invalid checkbox. Default is `var(--dds-border-negative-medium)`. _(default: undefined)_\n- **--dds-checkbox-invalid-hover-background-color** - The background color when hovering over an invalid checkbox. Default is `var(--dds-background-negative-medium)`. _(default: undefined)_\n- **--dds-checkbox-invalid-active-border-color** - The border color when an invalid checkbox is active. Default is `var(--dds-border-negative-strong)`. _(default: undefined)_\n- **--dds-checkbox-invalid-active-background-color** - The background color when an invalid checkbox is active. Default is `var(--dds-background-negative-strong)`. _(default: undefined)_\n- **--dds-checkbox-disabled-border-color** - The border color when the checkbox is disabled. Default is `var(--dds-button-primary-background-disabled)`. _(default: undefined)_\n- **--dds-checkbox-disabled-background-color** - The background color when the checkbox is disabled. Default is `var(--dds-button-primary-background-disabled)`. _(default: undefined)_\n- **--dds-checkbox-disabled-icon-color** - The color of the checkbox icon when disabled. Default is `var(--dds-button-primary-icon-disabled)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main checkbox container.\n- **label** - The label of the checkbox.\n- **input** - The input of the checkbox.\n- **control** - The control of the checkbox.\n- **icon** - The icon of the checkbox.\n- **label-container** - The label container of the checkbox.\n- **description** - The description of the checkbox.",
"doc-url": "",
"attributes": [
{
"name": "indeterminate",
"description": "Whether the checkbox is indeterminate",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "preventDefault",
"description": "Whether the checkbox should prevent the default action",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "border",
"description": "This sets up border around the checkbox, when true.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "type",
"description": "The type of the checkbox",
"value": {
"type": "'normal' | 'background'",
"default": "'normal'"
}
}
],
"events": [
{
"name": "dds-change",
"type": "{ checked: boolean, indeterminate: boolean, value: string, disabled: boolean, type: 'checkbox' }",
"description": "Fired when the checkbox is checked or unchecked."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the checkbox loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the checkbox gains focus."
},
{
"name": "dds-input",
"type": "{ checked: boolean, indeterminate: boolean, value: string, disabled: boolean }",
"description": "Emitted when the checkbox receives input."
}
],
"js": {
"properties": [
{
"name": "indeterminate",
"description": "Whether the checkbox is indeterminate",
"type": "boolean"
},
{
"name": "preventDefault",
"description": "Whether the checkbox should prevent the default action",
"type": "boolean"
},
{
"name": "border",
"description": "This sets up border around the checkbox, when true.",
"type": "boolean"
},
{
"name": "type",
"description": "The type of the checkbox",
"type": "'normal' | 'background'"
},
{ "name": "focusElement", "type": "HTMLInputElement" },
{
"name": "name",
"description": "The name of the checkbox.",
"type": "string"
},
{
"name": "value",
"description": "The value of the checkbox.",
"type": "string"
},
{
"name": "checked",
"description": "Whether the checkbox is checked.",
"type": "boolean"
},
{
"name": "label",
"description": "The label of the checkbox.",
"type": "string"
},
{
"name": "description",
"description": "The description of the checkbox.",
"type": "string"
},
{
"name": "disabled",
"description": "Whether the checkbox is disabled.",
"type": "boolean"
},
{
"name": "required",
"description": "Whether the checkbox is required.",
"type": "boolean"
},
{
"name": "size",
"description": "The size of the checkbox.",
"type": "'xs' | 'sm' | 'md' | 'lg'"
},
{
"name": "labelPlacement",
"description": "The placement of the label.",
"type": "'left' | 'right'"
},
{
"name": "descriptionPlacement",
"description": "The placement of the description.",
"type": "'top' | 'bottom'"
},
{
"name": "subtle",
"description": "The weight of the label.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback of the checkbox.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the checkbox.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "invalid",
"description": "The invalid state of the checkbox.",
"type": "boolean"
},
{
"name": "optional",
"description": "The optional state of the checkbox.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the checkbox.",
"type": "string"
}
],
"events": [
{
"name": "dds-change",
"type": "{ checked: boolean, indeterminate: boolean, value: string, disabled: boolean, type: 'checkbox' }",
"description": "Fired when the checkbox is checked or unchecked."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the checkbox loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the checkbox gains focus."
},
{
"name": "dds-input",
"type": "{ checked: boolean, indeterminate: boolean, value: string, disabled: boolean }",
"description": "Emitted when the checkbox receives input."
}
]
}
},
{
"name": "dap-ds-card-actions",
"description": "A card actions is a container for actions in a card.\n---\n\n\n### **Slots:**\n - _default_ - The content of the card actions.\n\n### **CSS Properties:**\n - **--dds-card-actions-gap** - The gap between items in the card actions. Default is `var(--dds-spacing-200)`. _(default: undefined)_\n- **--dds-card-actions-padding-lg** - The padding for large size card actions. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-actions-padding-md** - The padding for medium size card actions. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-actions-padding-sm** - The padding for small size card actions. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-actions-margin-lg** - The margin for large size card actions spacing. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-actions-margin-md** - The margin for medium size card actions spacing. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-actions-margin-sm** - The margin for small size card actions spacing. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main card actions container.",
"doc-url": "",
"attributes": [
{
"name": "parentSized",
"description": "Whether the card actions should be sized from the parent.",
"value": { "type": "string", "default": "'true'" }
}
],
"slots": [
{ "name": "", "description": "The content of the card actions." }
],
"events": [],
"js": {
"properties": [
{
"name": "parentSized",
"description": "Whether the card actions should be sized from the parent.",
"type": "string"
},
{
"name": "spacing",
"description": "The spacing of the card actions. This adds a margin to the card actions. Default is `bottom`.",
"type": "'top' | 'bottom' | 'both' | 'none'"
},
{
"name": "size",
"description": "The size of the card actions. Default is `sm`.",
"type": "'sm' | 'md' | 'lg'"
}
],
"events": []
}
},
{
"name": "dap-ds-card-content",
"description": "A card content is a container for content in a card.\n---\n\n\n### **Slots:**\n - _default_ - The content of the card-content.\n\n### **CSS Properties:**\n - **--dds-card-content-padding** - The padding of the card content. Default is `0`. _(default: undefined)_\n- **--dds-card-content-margin** - The margin of the card content. Default is `0`. _(default: undefined)_\n- **--dds-card-content-font-size** - The font size of the card content. Default is `var(--dds-font-base)`. _(default: undefined)_\n- **--dds-card-content-line-height** - The line height of the card content. Default is `var(--dds-font-line-height-xlarge)`. _(default: undefined)_\n- **--dds-card-content-spacing-lg** - The large spacing value. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-content-spacing-md** - The medium spacing value. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-content-spacing-sm** - The small spacing value. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-content-spacing-top** - The top spacing value. Default is `0`. _(default: undefined)_\n- **--dds-card-content-spacing-bottom** - The bottom spacing value. Default is `0`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main card content container.",
"doc-url": "",
"attributes": [
{
"name": "renderAs",
"description": "The base rendered root tag of the card content.",
"value": { "type": "string", "default": "'div'" }
},
{
"name": "parentSized",
"description": "Whether the card content should be sized from the parent.",
"value": { "type": "string", "default": "'true'" }
}
],
"slots": [
{ "name": "", "description": "The content of the card-content." }
],
"events": [],
"js": {
"properties": [
{
"name": "renderAs",
"description": "The base rendered root tag of the card content.",
"type": "string"
},
{
"name": "parentSized",
"description": "Whether the card content should be sized from the parent.",
"type": "string"
},
{
"name": "spacing",
"description": "The spacing of the card content. This adds a margin to the card subtitle. Default is `bottom`.",
"type": "'top' | 'bottom' | 'both' | 'none'"
},
{
"name": "size",
"description": "The size of the card subtitle. Default is `sm`.",
"type": "'sm' | 'md' | 'lg'"
}
],
"events": []
}
},
{
"name": "dap-ds-card-image",
"description": "A card image is a container for images in a card.\n---\n\n\n### **Slots:**\n - _default_ - The default slot for the image. The slot can accept any element, for example a video. If nothing is added to the slot, the image will be rendered.\n\n### **CSS Properties:**\n - **--dds-card-image-width** - The width of the image. Default is `100%`. _(default: undefined)_\n- **--dds-card-image-height** - The height of the image. Default is `auto`. _(default: undefined)_\n- **--dds-card-image-object-fit** - How the image fits within its container. Default is `cover`. _(default: undefined)_\n- **--dds-card-image-background-position** - The background position of the image. Default is `center`. _(default: undefined)_\n- **--dds-card-image-background-size** - How the background image is sized. Default is `cover`. _(default: undefined)_\n- **--dds-card-image-background-repeat** - How the background image repeats. Default is `no-repeat`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main card image container.",
"doc-url": "",
"attributes": [
{
"name": "src",
"description": "The source of the image.",
"value": { "type": "string" }
},
{
"name": "alt",
"description": "The alt text of the image.",
"value": { "type": "string" }
},
{
"name": "width",
"description": "The width of the image.",
"value": { "type": "number" }
},
{
"name": "height",
"description": "The height of the image.",
"value": { "type": "number" }
}
],
"slots": [
{
"name": "",
"description": "The default slot for the image. The slot can accept any element, for example a video. If nothing is added to the slot, the image will be rendered."
}
],
"events": [],
"js": {
"properties": [
{
"name": "src",
"description": "The source of the image.",
"type": "string"
},
{
"name": "alt",
"description": "The alt text of the image.",
"type": "string"
},
{
"name": "width",
"description": "The width of the image.",
"type": "number"
},
{
"name": "height",
"description": "The height of the image.",
"type": "number"
}
],
"events": []
}
},
{
"name": "dap-ds-card-subtitle",
"description": "Subtitle of the card\n---\n\n\n### **Slots:**\n - _default_ - The content of the subtitle.\n\n### **CSS Properties:**\n - **--dds-card-subtitle-color** - The color of the subtitle text. Default is `var(--dds-text-neutral-subtle)`. _(default: undefined)_\n- **--dds-card-subtitle-font-size** - The font size of the subtitle. Default is `var(--dds-font-xs)`. _(default: undefined)_\n- **--dds-card-subtitle-font-weight** - The font weight of the subtitle. Default is `var(--dds-font-weight-bold)`. _(default: undefined)_\n- **--dds-card-subtitle-line-height** - The line height of the subtitle. Default is `var(--dds-font-line-height-large)`. _(default: undefined)_\n- **--dds-card-subtitle-padding-sm** - The padding for small size. Default is `0 var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-padding-md** - The padding for medium size. Default is `0 var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-padding-lg** - The padding for large size. Default is `0 var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-subtitle-margin-sm** - The base margin for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-margin-md** - The base margin for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-margin-lg** - The base margin for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-top-sm** - The top spacing for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-top-md** - The top spacing for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-top-lg** - The top spacing for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-bottom-sm** - The bottom spacing for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-bottom-md** - The bottom spacing for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-bottom-lg** - The bottom spacing for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-both-sm** - The both (top and bottom) spacing for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-both-md** - The both (top and bottom) spacing for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-subtitle-spacing-both-lg** - The both (top and bottom) spacing for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The subtitle container.",
"doc-url": "",
"attributes": [
{
"name": "renderAs",
"description": "The base rendered root tag of the card subtitle.",
"value": { "type": "string", "default": "'span'" }
},
{
"name": "parentSized",
"description": "Whether the card subtitle should be sized from the parent.",
"value": { "type": "string", "default": "'true'" }
}
],
"slots": [
{ "name": "", "description": "The content of the subtitle." }
],
"events": [],
"js": {
"properties": [
{
"name": "renderAs",
"description": "The base rendered root tag of the card subtitle.",
"type": "string"
},
{
"name": "parentSized",
"description": "Whether the card subtitle should be sized from the parent.",
"type": "string"
},
{
"name": "spacing",
"description": "The spacing of the card subtitle. This adds a margin to the card subtitle. Default is `top`.",
"type": "'top' | 'bottom' | 'both' | 'none'"
},
{
"name": "size",
"description": "The size of the card subtitle. Default is `sm`.",
"type": "'sm' | 'lg'"
}
],
"events": []
}
},
{
"name": "dap-ds-card-title",
"description": "Title of the card\n---\n\n\n### **Slots:**\n - _default_ - The content of the title.\n\n### **CSS Properties:**\n - **--dds-card-title-color** - The text color of the card title. Default is `var(--dds-color-text-primary)`. _(default: undefined)_\n- **--dds-card-title-font-family** - The font family of the card title. Default is `var(--dds-font-family-base)`. _(default: undefined)_\n- **--dds-card-title-font-weight** - The font weight of the card title. Default is `var(--dds-font-weight-bold)`. _(default: undefined)_\n- **--dds-card-title-line-height** - The line height of the card title. Default is `var(--dds-font-line-height-large)`. _(default: undefined)_\n- **--dds-card-title-margin-bottom** - The bottom margin of the card title. Default is `var(--dds-spacing-100)`. _(default: undefined)_\n- **--dds-card-title-sm-padding-x** - The horizontal padding for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-title-sm-padding-bottom** - The bottom padding for small size. Default is `var(--dds-spacing-100)`. _(default: undefined)_\n- **--dds-card-title-sm-spacing-top** - The top spacing for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-title-sm-spacing-bottom** - The bottom spacing for small size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-title-md-padding-x** - The horizontal padding for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-title-md-padding-bottom** - The bottom padding for medium size. Default is `var(--dds-spacing-100)`. _(default: undefined)_\n- **--dds-card-title-md-spacing-top** - The top spacing for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-title-md-spacing-bottom** - The bottom spacing for medium size. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-title-lg-padding-x** - The horizontal padding for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-title-lg-padding-bottom** - The bottom padding for large size. Default is `var(--dds-spacing-100)`. _(default: undefined)_\n- **--dds-card-title-lg-spacing-top** - The top spacing for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n- **--dds-card-title-lg-spacing-bottom** - The bottom spacing for large size. Default is `var(--dds-spacing-600)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main card title container.",
"doc-url": "",
"attributes": [
{
"name": "renderAs",
"description": "The base rendered root tag of the card title.",
"value": { "type": "string", "default": "'span'" }
},
{
"name": "parentSized",
"description": "Whether the card title should be sized from the parent.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "noPadding",
"description": "Whether the card title should have no padding.",
"value": { "type": "boolean" }
}
],
"slots": [{ "name": "", "description": "The content of the title." }],
"events": [],
"js": {
"properties": [
{
"name": "renderAs",
"description": "The base rendered root tag of the card title.",
"type": "string"
},
{
"name": "parentSized",
"description": "Whether the card title should be sized from the parent.",
"type": "string"
},
{
"name": "noPadding",
"description": "Whether the card title should have no padding.",
"type": "boolean"
},
{
"name": "spacing",
"description": "The spacing of the card title. This adds a margin to the card title. Default is `top`.",
"type": "'top' | 'bottom' | 'both' | 'none'"
},
{
"name": "size",
"description": "The size of the card title. Default is `sm`.",
"type": "'sm' |'md' | 'lg'"
}
],
"events": []
}
},
{
"name": "dap-ds-card",
"description": "A card is a container for content, actions, and images in a consistent format.\n---\n\n\n### **Slots:**\n - _default_ - The content of the card.\n\n### **CSS Properties:**\n - **--dds-card-padding** - The padding of the card. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-card-border-radius** - The border radius of the card. Default is `var(--dds-radius-large)`. _(default: undefined)_\n- **--dds-card-border-width** - The border width of the card. Default is `var(--dds-border-width-base)`. _(default: undefined)_\n- **--dds-card-border-color** - The border color of the card. Default is `var(--dds-border-neutral-divider)`. _(default: undefined)_\n- **--dds-card-background** - The background color of the card. Default is `var(--dds-background-neutral-base)`. _(default: undefined)_\n- **--dds-card-hover-border-color** - The border color when hovering over the card. Default is `var(--dds-border-brand-base)`. _(default: undefined)_\n- **--dds-card-active-border-color** - The border color when the card is active. Default is `var(--dds-border-brand-medium)`. _(default: undefined)_\n- **--dds-card-shadow** - The box shadow of the card. Default is `none`. _(default: undefined)_\n- **--dds-card-hover-shadow** - The box shadow when hovering over the card. Default is `none`. _(default: undefined)_\n- **--dds-card-transition-duration** - The duration of the card's transitions. Default is `var(--dds-transition-medium)`. _(default: undefined)_\n- **--dds-card-transition-timing** - The timing function of the card's transitions. Default is `var(--dds-easing-ease-in-out)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main card container.",
"doc-url": "",
"attributes": [
{
"name": "interactive",
"description": "Whether the card is interactive. Default is false. If true, the card will be rendered as an anchor element.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "renderAs",
"description": "The render as type of the card, only applicable when interactive.",
"value": { "type": "'a' | 'button'", "default": "'a'" }
},
{
"name": "disabled",
"description": "Whether the card is disabled.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "noBorder",
"description": "Removes the border around the card",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "noPadding",
"description": "Removes the padding around the card",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "target",
"description": "The link target of the card",
"value": {
"type": "'_blank' | '_self' | '_parent' | '_top'",
"default": "'_self'"
}
},
{
"name": "href",
"description": "The URL of the card.",
"value": { "type": "string" }
},
{
"name": "rel",
"description": "The rel of the card link.",
"value": { "type": "string", "default": "'noreferrer noopener'" }
}
],
"slots": [{ "name": "", "description": "The content of the card." }],
"events": [],
"js": {
"properties": [
{
"name": "interactive",
"description": "Whether the card is interactive. Default is false. If true, the card will be rendered as an anchor element.",
"type": "boolean"
},
{
"name": "renderAs",
"description": "The render as type of the card, only applicable when interactive.",
"type": "'a' | 'button'"
},
{
"name": "disabled",
"description": "Whether the card is disabled.",
"type": "boolean"
},
{
"name": "noBorder",
"description": "Removes the border around the card",
"type": "boolean"
},
{
"name": "noPadding",
"description": "Removes the padding around the card",
"type": "boolean"
},
{
"name": "target",
"description": "The link target of the card",
"type": "'_blank' | '_self' | '_parent' | '_top'"
},
{
"name": "href",
"description": "The URL of the card.",
"type": "string"
},
{
"name": "rel",
"description": "The rel of the card link.",
"type": "string"
},
{
"name": "size",
"description": "The size of the card title. Default is `sm`.",
"type": "'sm' | 'md' | 'lg'"
}
],
"events": []
}
},
{
"name": "dap-ds-combobox",
"description": "A select is a form element that allows the user to select one option from a set.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the select value changes.\n- **dds-blur** - Emitted when the select loses focus.\n- **dds-focus** - Emitted when the select gains focus.\n- **dds-clear** - Emitted when the select is cleared.\n- **dds-search** - Emitted when the manual input value changes.\n- **dds-input** - Emitted when typing happens in the input.\n\n### **Slots:**\n - _default_ - The default slot for the options.\n\n### **CSS Properties:**\n - **--dds-combobox-background** - The background color of the combobox. Defaults to var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-combobox-border-color** - The border color of the combobox. Defaults to var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-combobox-border-width** - The border width of the combobox. Defaults to var(--dds-border-width-base, 1px). _(default: undefined)_\n- **--dds-combobox-border-radius** - The border radius of the combobox. Defaults to var(--dds-radius-base). _(default: undefined)_\n- **--dds-combobox-text-color** - The text color of the combobox. Defaults to var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-combobox-placeholder-color** - The placeholder text color. Defaults to var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-combobox-disabled-background** - The background color when disabled. Defaults to var(--dds-background-neutral-stronger). _(default: undefined)_\n- **--dds-combobox-disabled-text** - The text color when disabled. Defaults to var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-combobox-error-border** - The border color for error state. Defaults to var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-combobox-success-border** - The border color for success state. Defaults to var(--dds-border-positive-base). _(default: undefined)_\n- **--dds-combobox-icon-color** - The color of the icons. Defaults to var(--dds-text-icon-neutral-subtle). _(default: undefined)_\n- **--dds-combobox-clear-icon-color** - The color of the clear icon. Defaults to var(--dds-button-subtle-icon-neutral-enabled). _(default: undefined)_\n- **--dds-combobox-popup-background** - The background color of the popup. Defaults to var(--dds-background-neutral-subtle). _(default: undefined)_\n- **--dds-combobox-popup-shadow** - The box shadow of the popup. Defaults to 0 4px 6px -1px rgb(0 0 0 / 8%), 0 2px 4px -1px rgb(0 0 0 / 6%). _(default: undefined)_\n- **--dds-combobox-padding-xs** - The padding for extra small size. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-padding-sm** - The padding for small size. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-padding-lg** - The padding for large size. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-padding-horizontal** - The horizontal padding. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-padding-vertical** - The vertical padding. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-gap** - The gap between elements. Defaults to var(--dds-spacing-100). _(default: undefined)_\n- **--dds-combobox-icon-gap** - The gap between icons. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-action-gap** - The gap between action elements. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-action-padding** - The padding for action elements. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-clear-icon-width** - The width of the clear icon. Defaults to var(--dds-spacing-800). _(default: undefined)_\n- **--dds-combobox-dropdown-icon-right** - The right position of the dropdown icon. Defaults to var(--dds-spacing-600). _(default: undefined)_\n- **--dds-combobox-min-width** - The minimum width of the combobox. Defaults to 7.5rem. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main select container.\n- **trigger** - The trigger button of the select.\n- **label** - The label of the select.\n- **description** - The description of the select.\n- **feedback** - The feedback of the select.\n- **tooltip** - The tooltip of the select.\n- **option-list** - The option list of the select.",
"doc-url": "",
"attributes": [],
"slots": [
{ "name": "", "description": "The default slot for the options." }
],
"events": [
{
"name": "dds-change",
"type": "{ value }",
"description": "Fired when the select value changes."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the select loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the select gains focus."
},
{
"name": "dds-clear",
"type": "{ void }",
"description": "Emitted when the select is cleared."
},
{
"name": "dds-search",
"type": "{ search: string }",
"description": "Emitted when the manual input value changes."
},
{
"name": "dds-input",
"type": "{ input: string, originalEvent: Event }",
"description": "Emitted when typing happens in the input."
}
],
"js": {
"properties": [
{
"name": "value",
"description": "The value of the select.",
"type": "string"
},
{
"name": "placeholder",
"description": "The placeholder of the select.",
"type": "string"
},
{
"name": "placement",
"description": "The placement of the select dropdown. Default is 'bottom-start'.",
"type": "'top' | 'top-start' | 'top-end' | 'right' | 'right-start'| 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end'"
},
{
"name": "opened",
"description": "Whether the select dropdown is opened.",
"type": "boolean"
},
{
"name": "sync",
"description": "The sync mode of the select dropdown. How the dropdown item size is synced to the trigger element'.",
"type": "boolean"
},
{
"name": "label",
"description": "The label of the select.",
"type": "string"
},
{
"name": "description",
"description": "The description of the select.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the select.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the input.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "size",
"description": "The size of the select. Default is 'md'.",
"type": "'xs' | 'sm' | 'sm'"
},
{
"name": "disabled",
"description": "Whether the select is disabled.",
"type": "boolean"
},
{
"name": "required",
"description": "Whether the select is required.",
"type": "boolean"
},
{
"name": "readonly",
"description": "Whether the select is readonly.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "Whether the select is autofocus.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback content of the select.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the select.",
"type": "'negative' | 'positive' | 'warning' | 'info'"
},
{
"name": "searchMode",
"description": "The search mode of the select.",
"type": "'none' | 'typehead' | 'autocomplete' | 'manual'"
},
{
"name": "openOnEmpty",
"description": "Whether the combobox should open on empty results.",
"type": "boolean"
},
{
"name": "allowManualInput",
"description": "Whether the combobox allows manual input, or free text.",
"type": "boolean"
},
{
"name": "searchForText",
"description": "Whether the combobox should search for the selected item text.",
"type": "boolean"
},
{
"name": "noTextComplete",
"description": "Whether the combobox should not complete the text.",
"type": "boolean"
},
{
"name": "searchButtonAriaLabel",
"description": "The aria label of the search button.",
"type": "string"
},
{
"name": "selectable",
"description": "Show the selected item check mark in the dropdown. 'true' or 'false'",
"type": "string"
},
{
"name": "noAnimation",
"description": "Whether the combobox open indicator should be animated.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value }",
"description": "Fired when the select value changes."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the select loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the select gains focus."
},
{
"name": "dds-clear",
"type": "{ void }",
"description": "Emitted when the select is cleared."
},
{
"name": "dds-search",
"type": "{ search: string }",
"description": "Emitted when the manual input value changes."
},
{
"name": "dds-input",
"type": "{ input: string, originalEvent: Event }",
"description": "Emitted when typing happens in the input."
}
]
}
},
{
"name": "dap-ds-command-group",
"description": "A command group is a group of command items.\n---\n\n\n### **Slots:**\n - _default_ - The default slot for the command group.\n\n### **CSS Properties:**\n - **--dds-command-group-gap** - The gap between command group elements. Defaults to var(--dds-spacing-100) _(default: undefined)_\n- **--dds-command-group-margin-bottom** - The bottom margin of the command group. Defaults to var(--dds-spacing-200) _(default: undefined)_\n- **--dds-command-group-border-radius** - The border radius of the command group. Defaults to var(--dds-radius-small) _(default: undefined)_\n- **--dds-command-group-label-font-weight** - The font weight of the command group label. Defaults to var(--dds-font-weight-bold) _(default: undefined)_\n- **--dds-command-group-items-gap** - The gap between command items. Defaults to var(--dds-spacing-100) _(default: undefined)_",
"doc-url": "",
"attributes": [
{
"name": "label",
"description": "The label of the command group.",
"value": { "type": "string | undefined" }
},
{
"name": "exclusive",
"description": "Whether the command group is exclusive, only one item can be selected at a time.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "",
"description": "The default slot for the command group."
}
],
"events": [],
"js": {
"properties": [
{
"name": "label",
"description": "The label of the command group.",
"type": "string | undefined"
},
{
"name": "exclusive",
"description": "Whether the command group is exclusive, only one item can be selected at a time.",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-command-item",
"description": "A command item is a command item that can be selected.\n---\n\n\n### **Events:**\n - **dds-command-item-click** - Fired when the command item is clicked.\n\n### **Slots:**\n - _default_ - The label of the command item.\n- **check** - The check of the command item.\n\n### **CSS Properties:**\n - **--dds-command-item-padding** - The padding of the command item _(default: undefined)_\n- **--dds-command-item-background** - The background color of the command item _(default: undefined)_\n- **--dds-command-item-color** - The text color of the command item _(default: undefined)_\n- **--dds-command-item-hover-background** - The background color of the command item on hover _(default: undefined)_\n- **--dds-command-item-selected-background** - The background color of the selected command item _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The base part of the command item.\n- **content** - The content part of the command item.\n- **label** - The label part of the command item.",
"doc-url": "",
"attributes": [
{
"name": "value",
"description": "The value of the command item.",
"value": { "type": "string | undefined" }
},
{
"name": "disabled",
"description": "Whether the command item is disabled.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "name",
"description": "The name of the button",
"value": { "type": "string" }
},
{
"name": "href",
"description": "The Href of the button. If this present the button will be rendered as an anchor `` element.",
"value": { "type": "string" }
},
{
"name": "target",
"description": "The target of the button",
"value": {
"type": "'_blank' | '_self' | '_parent' | '_top'",
"default": "'_self'"
}
},
{
"name": "rel",
"description": "The rel of the button link. Default is `noreferrer noopener`.",
"value": { "type": "string", "default": "'noreferrer noopener'" }
},
{
"name": "selectable",
"description": "Whether the command item is selectable.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "selected",
"description": "Whether the command item is selected.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "closeOnSelect",
"description": "Whether the command item should close the command when selected.",
"value": { "type": "string", "default": "'true'" }
}
],
"slots": [
{ "name": "", "description": "The label of the command item." },
{ "name": "check", "description": "The check of the command item." }
],
"events": [
{
"name": "dds-command-item-click",
"type": "{ value: string, closeOnSelect: boolean }",
"description": "Fired when the command item is clicked."
}
],
"js": {
"properties": [
{
"name": "value",
"description": "The value of the command item.",
"type": "string | undefined"
},
{
"name": "disabled",
"description": "Whether the command item is disabled.",
"type": "boolean"
},
{
"name": "name",
"description": "The name of the button",
"type": "string"
},
{
"name": "href",
"description": "The Href of the button. If this present the button will be rendered as an anchor `` element.",
"type": "string"
},
{
"name": "target",
"description": "The target of the button",
"type": "'_blank' | '_self' | '_parent' | '_top'"
},
{
"name": "rel",
"description": "The rel of the button link. Default is `noreferrer noopener`.",
"type": "string"
},
{
"name": "selectable",
"description": "Whether the command item is selectable.",
"type": "boolean"
},
{
"name": "selected",
"description": "Whether the command item is selected.",
"type": "boolean"
},
{
"name": "closeOnSelect",
"description": "Whether the command item should close the command when selected.",
"type": "string"
}
],
"events": [
{
"name": "dds-command-item-click",
"type": "{ value: string, closeOnSelect: boolean }",
"description": "Fired when the command item is clicked."
}
]
}
},
{
"name": "dap-ds-command",
"description": "A command is a component that displays a list of commands.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the command value changes.\n- **dds-opened** - Fired when the popup is opened.\n- **dds-closed** - Fired when the popup is closed.\n- **dds-close** - Fired when the popup should be closed.\n\n### **Slots:**\n - **trigger** - The trigger element for the command dropdown.\n- _default_ - The command items.\n\n### **CSS Properties:**\n - **--dds-popup-z-index** - Z-index of the popup. _(default: undefined)_\n- **--dds-popup-padding** - Default padding of the popup. _(default: undefined)_\n- **--dds-popup-padding-xs** - Padding of the popup when size is xs. _(default: undefined)_\n- **--dds-popup-padding-lg** - Padding of the popup when size is lg. _(default: undefined)_\n- **--dds-popup-border-width** - Border width of the popup. _(default: undefined)_\n- **--dds-popup-border-radius** - Border radius of the popup. _(default: undefined)_\n- **--dds-popup-border-color** - Border color of the popup. _(default: undefined)_\n- **--dds-popup-background** - Background color of the popup. _(default: undefined)_\n- **--dds-popup-color** - Text color of the popup. _(default: undefined)_\n- **--dds-popup-arrow-size** - Size of the popup arrow. _(default: undefined)_\n\n### **CSS Parts:**\n - **popup** - The main popup container.\n- **arrow** - The arrow of the popup.",
"doc-url": "",
"attributes": [
{
"name": "value",
"description": "The value of the command.",
"value": { "type": "string | null", "default": "null" }
},
{
"name": "fullWidth",
"description": "Whether the command popup should take full width of the screen.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "aria-labelledby",
"description": "ID of element that labels the command dropdown.",
"value": { "type": "string | undefined" }
}
],
"slots": [
{
"name": "trigger",
"description": "The trigger element for the command dropdown."
},
{ "name": "", "description": "The command items." }
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the command value changes."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fired when the popup is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fired when the popup is closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the popup should be closed."
}
],
"js": {
"properties": [
{
"name": "value",
"description": "The value of the command.",
"type": "string | null"
},
{
"name": "fullWidth",
"description": "Whether the command popup should take full width of the screen.",
"type": "boolean"
},
{
"name": "ariaLabelledBy",
"description": "ID of element that labels the command dropdown.",
"type": "string | undefined"
},
{
"name": "placement",
"description": "The placement of the popup.",
"type": "'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end'"
},
{
"name": "overflow",
"description": "Whether the popup should overflow.",
"type": "boolean"
},
{
"name": "size",
"description": "The size of the popup.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "disabled",
"description": "The disabled state of the popup.",
"type": "boolean"
},
{
"name": "opened",
"description": "The open state of the popup.",
"type": "boolean"
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the popup.",
"type": "'absolute' | 'fixed'"
},
{
"name": "offset",
"description": "The offset of the popup.",
"type": "number"
},
{
"name": "sync",
"description": "Whether the popup should sync its width with the trigger.",
"type": "boolean"
},
{
"name": "maxHeight",
"description": "The maximum height of the popup.",
"type": "number | 'auto'"
},
{
"name": "maxWidth",
"description": "The maximum width of the popup.",
"type": "number | 'auto'"
},
{
"name": "hasArrow",
"description": "Whether the popup has an arrow.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the command value changes."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fired when the popup is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fired when the popup is closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the popup should be closed."
}
]
}
},
{
"name": "dap-ds-content-switcher-item",
"description": "Segmented control item component for the segmented control.\n---\n\n\n### **Slots:**\n - **iconcontent** - The icon content of the segmented control item.\n\n### **CSS Properties:**\n - **--dds-content-switcher-item-height** - The height of the content switcher item (default: var(--dds-spacing-800, 32px)) _(default: undefined)_\n- **--dds-content-switcher-item-padding** - The padding of the content switcher item (default: var(--dds-spacing-200, 8px) var(--dds-spacing-400, 16px)) _(default: undefined)_\n- **--dds-content-switcher-item-font-size** - The font size of the content switcher item (default: var(--dds-size-sm, 14px)) _(default: undefined)_\n- **--dds-content-switcher-item-font-weight** - The font weight of the content switcher item (default: var(--dds-weight-bold, 700)) _(default: undefined)_\n- **--dds-content-switcher-item-border-radius** - The border radius of the content switcher item (default: var(--dds-radius-large, 16px)) _(default: undefined)_\n- **--dds-content-switcher-item-background** - The background color of the content switcher item (default: transparent) _(default: undefined)_\n- **--dds-content-switcher-item-color** - The text color of the content switcher item (default: var(--dds-text-neutral-base)) _(default: undefined)_\n- **--dds-content-switcher-item-border-color** - The border color of the content switcher item (default: transparent) _(default: undefined)_\n- **--dds-content-switcher-item-checked-background** - The background color of the checked content switcher item (default: var(--dds-button-primary-background-enabled)) _(default: undefined)_\n- **--dds-content-switcher-item-checked-color** - The text color of the checked content switcher item (default: var(--dds-text-neutral-on-inverted)) _(default: undefined)_\n- **--dds-content-switcher-item-checked-border-color** - The border color of the checked content switcher item (default: var(--dds-border-neutral-transparent-interactive)) _(default: undefined)_\n\n### **CSS Parts:**\n - **input** - The input of the segmented control item.",
"doc-url": "",
"attributes": [
{
"name": "value",
"description": "The value of the segmented control item.",
"value": { "type": "string" }
},
{
"name": "checked",
"description": "The checked state of the segmented control item.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "disabled",
"description": "The disabled state of the segmented control item.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "name",
"description": "The name of the segmented control item.",
"value": { "type": "string" }
}
],
"slots": [
{
"name": "iconcontent",
"description": "The icon content of the segmented control item."
}
],
"events": [],
"js": {
"properties": [
{
"name": "value",
"description": "The value of the segmented control item.",
"type": "string"
},
{
"name": "checked",
"description": "The checked state of the segmented control item.",
"type": "boolean"
},
{
"name": "disabled",
"description": "The disabled state of the segmented control item.",
"type": "boolean"
},
{
"name": "name",
"description": "The name of the segmented control item.",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-content-switcher",
"description": "A content switcher is a set of two or more segments, each of which functions as a mutually exclusive button.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the content switcher is changed.\n\n### **Slots:**\n - _default_ - The content switcher items.\n\n### **CSS Properties:**\n - **--dds-content-switcher-min-width** - The minimum width of the content switcher (default: var(--dds-spacing-4000, 160px)) _(default: undefined)_\n- **--dds-content-switcher-padding** - The padding of the content switcher (default: var(--dds-spacing-100, 4px)) _(default: undefined)_\n- **--dds-content-switcher-border-width** - The border width of the content switcher (default: var(--dds-border-width-base)) _(default: undefined)_\n- **--dds-content-switcher-border-color** - The border color of the content switcher (default: var(--dds-border-neutral-transparent)) _(default: undefined)_\n- **--dds-content-switcher-border-radius** - The border radius of the content switcher (default: var(--dds-radius-rounded, 1000px)) _(default: undefined)_\n- **--dds-content-switcher-background** - The background color of the content switcher (default: var(--dds-transparent-black-subtle, rgb(0 0 0 / 5%))) _(default: undefined)_\n- **--dds-content-switcher-gap** - The gap between content switcher items (default: var(--dds-spacing-100, 4px)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main content switcher container.",
"doc-url": "",
"attributes": [
{
"name": "multiSelect",
"description": "Whether the content switcher allows multiple selections.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "value",
"description": "The value of the content switcher. A comma-separated list if `multiSelect` is `true`.",
"value": { "type": "string" }
}
],
"slots": [
{ "name": "", "description": "The content switcher items." }
],
"events": [
{
"name": "dds-change",
"type": "{ value: string, selected: boolean }",
"description": "Fired when the content switcher is changed."
}
],
"js": {
"properties": [
{
"name": "multiSelect",
"description": "Whether the content switcher allows multiple selections.",
"type": "boolean"
},
{
"name": "value",
"description": "The value of the content switcher. A comma-separated list if `multiSelect` is `true`.",
"type": "string"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string, selected: boolean }",
"description": "Fired when the content switcher is changed."
}
]
}
},
{
"name": "dap-ds-copybox-input",
"description": "A copybox input is a field for copying an input value.\n---\n\n\n### **Events:**\n - **dds-copy** - Fired when the user clicks on the copy button.\n- **dds-change** - Fired when the input value changes.\n- **dds-input** - Fired when the input value changes.\n- **dds-keydown** - Fired when a key is pressed down.\n- **dds-blur** - Fired when the input loses focus.\n- **dds-focus** - Emitted when the input gains focus.\n- **dds-not-allowed** - Emitted when the value cannot be copied.\n\n### **CSS Properties:**\n - **--dds-input-height** - The height of the input. Default is var(--dds-spacing-1000). _(default: undefined)_\n- **--dds-input-padding** - The padding of the input. Default is var(--dds-spacing-300). _(default: undefined)_\n- **--dds-input-font-size** - The font size of the input. Default is var(--dds-font-base). _(default: undefined)_\n- **--dds-input-border-color** - The border color of the input. Default is var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-input-background-color** - The background color of the input. Default is var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-input-text-color** - The text color of the input. Default is var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-input-border-radius** - The border radius of the input. Default is var(--dds-radius-base). _(default: undefined)_\n- **--dds-input-border-width** - The border width of the input. Default is var(--dds-border-width-base). _(default: undefined)_\n- **--dds-input-disabled-background** - The background color of the disabled input. Default is var(--dds-fields-background-disabled). _(default: undefined)_\n- **--dds-input-disabled-text** - The text color of the disabled input. Default is var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-input-readonly-background** - The background color of the readonly input. Default is var(--dds-fields-background-read-only). _(default: undefined)_\n- **--dds-input-readonly-text** - The text color of the readonly input. Default is var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-input-success-border** - The border color of the success input. Default is var(--dds-border-positive-base). _(default: undefined)_\n- **--dds-input-error-border** - The border color of the error input. Default is var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-input-addon-background** - The background color of the input addon. Default is var(--dds-background-ui-neutral-enabled). _(default: undefined)_\n- **--dds-input-addon-success-background** - The background color of the success input addon. Default is var(--dds-background-ui-positive-enabled). _(default: undefined)_\n- **--dds-input-addon-error-background** - The background color of the error input addon. Default is var(--dds-background-ui-negative-enabled). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The base container of the component.\n- **postfix** - The inner postfix icon part of the component.\n- **button** - The button of the component.",
"doc-url": "",
"attributes": [
{
"name": "copyButtonAriaLabel",
"description": "The aria label of the copy button.",
"value": { "type": "string" }
}
],
"events": [
{
"name": "dds-copy",
"type": "{ value: string }",
"description": "Fired when the user clicks on the copy button."
},
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
},
{
"name": "dds-not-allowed",
"type": "{ void }",
"description": "Emitted when the value cannot be copied."
}
],
"js": {
"properties": [
{
"name": "copyButtonAriaLabel",
"description": "The aria label of the copy button.",
"type": "string"
},
{ "name": "type", "type": "string" },
{
"name": "label",
"description": "The label of the input.",
"type": "string"
},
{
"name": "placeholder",
"description": "The placeholder of the input.",
"type": "string"
},
{
"name": "description",
"description": "The description of the input.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the input.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The position of the tooltip. Can be `top`, `right`, `bottom`, or `left`.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "status",
"description": "The status of the input. Can be `success` or `error`.",
"type": "'success' | 'error'"
},
{
"name": "size",
"description": "The size of the input. Default is `sm`.",
"type": "'xs' | 'sm' | 'sm'"
},
{
"name": "name",
"description": "The name of the input.",
"type": "string"
},
{
"name": "value",
"description": "The value of the input.",
"type": "string"
},
{
"name": "disabled",
"description": "The disabled state of the input. Default is false.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the input. Default is false.",
"type": "boolean"
},
{
"name": "readonly",
"description": "The readonly state of the input. Default is false.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "The autofocus state of the input. Default is false.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback of the input.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the input. Can be `negative`, `positive`, or `warning`.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "loading",
"description": "The loading state of the input. Default is false.",
"type": "boolean"
},
{
"name": "optional",
"description": "The optional state of the input.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the input.",
"type": "string"
},
{
"name": "subtle",
"description": "The weight of the label. Default is `false`",
"type": "boolean"
}
],
"events": [
{
"name": "dds-copy",
"type": "{ value: string }",
"description": "Fired when the user clicks on the copy button."
},
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
},
{
"name": "dds-not-allowed",
"type": "{ void }",
"description": "Emitted when the value cannot be copied."
}
]
}
},
{
"name": "dap-ds-dap-badge",
"description": "A DÁP badge is a brand element showing the use of this system design library.\n---\n\n\n### **Slots:**\n - _default_ - Description of badge *\n\n### **CSS Properties:**\n - **--dds-badge-padding-sm** - Custom padding for the small badge (default: var(--dds-spacing-200) var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-badge-padding-lg** - Custom padding for the large badge (default: var(--dds-spacing-400)) _(default: undefined)_\n- **--dds-badge-border-width** - Custom border width for the badge (default: var(--dds-border-width-base)) _(default: undefined)_\n- **--dds-badge-border-color** - Custom border color for the badge (default: var(--dds-border-neutral-divider)) _(default: undefined)_\n- **--dds-badge-border-radius** - Custom border radius for the badge (default: var(--dds-radius-base)) _(default: undefined)_\n- **--dds-badge-color** - Custom text color for the badge (default: var(--dds-text-neutral-base)) _(default: undefined)_\n- **--dds-badge-gap** - Custom gap between icon and text (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-badge-font-size-sm** - Custom font size for the small badge (default: var(--dds-font-xs)) _(default: undefined)_\n- **--dds-badge-font-size-lg** - Custom font size for the large badge (default: var(--dds-font-xs)) _(default: undefined)_\n- **--dds-badge-font-weight** - Custom font weight for the badge (default: var(--dds-font-weight-medium)) _(default: undefined)_\n- **--dds-badge-line-height** - Custom line height for the badge (default: var(--dds-font-line-height-large)) _(default: undefined)_\n- **--dds-badge-border-color-normal** - Custom border color for the normal variant (default: var(--dds-transparent-black-medium)) _(default: undefined)_\n- **--dds-badge-background-color-normal** - Custom background color for the normal variant (default: var(--dds-background-brand-subtle)) _(default: undefined)_\n- **--dds-badge-color-normal** - Custom text color for the normal variant (default: var(--dds-text-brand-subtle)) _(default: undefined)_\n- **--dds-badge-border-color-inverted** - Custom border color for the inverted variant (default: var(--dds-transparent-white-medium)) _(default: undefined)_\n- **--dds-badge-background-color-inverted** - Custom background color for the inverted variant (default: var(--dds-background-brand-base-inverted)) _(default: undefined)_\n- **--dds-badge-color-inverted** - Custom text color for the inverted variant (default: var(--dds-text-neutral-inverted)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - Main badge container\n- **icon** - Badge icon\n- **text** - Badge text",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the DÁP badge",
"value": {
"type": "'normal' | 'inverted'",
"default": "'normal'"
}
},
{
"name": "size",
"description": "The size of the DÁP badge",
"value": { "type": "'sm' | 'lg'", "default": "'sm'" }
}
],
"slots": [{ "name": "", "description": "Description of badge *" }],
"events": [],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the DÁP badge",
"type": "'normal' | 'inverted'"
},
{
"name": "size",
"description": "The size of the DÁP badge",
"type": "'sm' | 'lg'"
}
],
"events": []
}
},
{
"name": "dap-ds-datatable",
"description": "A data table is a component that displays data in a tabular format.\n---\n\n\n### **Events:**\n - **dds-sorting-change** - Fired when the sorting of the table changes.\n- **dds-selection-change** - Fired when the selection of the table changes.\n- **dds-pagination-change** - Fired when the pagination of the table changes.\n- **dds-row-click** - Fired when a row is clicked.\n\n### **CSS Properties:**\n - **--dds-datatable-bg-color** - Background color of the table _(default: undefined)_\n- **--dds-datatable-border-color** - Border color of the table cells _(default: undefined)_\n- **--dds-datatable-header-bg-color** - Background color of the table header _(default: undefined)_\n- **--dds-datatable-header-text-color** - Text color of the table header _(default: undefined)_\n- **--dds-datatable-row-hover-bg-color** - Background color of hovered rows _(default: undefined)_\n- **--dds-datatable-row-selected-bg-color** - Background color of selected rows _(default: undefined)_\n- **--dds-datatable-cell-padding** - Padding of table cells _(default: undefined)_\n- **--dds-datatable-header-padding** - Padding of header cells _(default: undefined)_\n- **--dds-datatable-border-width** - Width of table borders _(default: undefined)_\n- **--dds-datatable-font-size** - Font size of the table _(default: undefined)_\n- **--dds-datatable-line-height** - Line height of the table _(default: undefined)_\n- **--dds-datatable-header-font-weight** - Font weight of the header _(default: undefined)_\n- **--dds-datatable-stripe-color** - Background color for striped rows _(default: undefined)_\n- **--dds-datatable-stripe-enabled** - Whether to enable striped rows _(default: undefined)_\n- **--dds-datatable-border-radius** - Border radius of the table _(default: undefined)_\n- **--dds-datatable-shadow** - Box shadow of the table _(default: undefined)_\n- **--dds-datatable-transition-duration** - Duration of hover/selection transitions _(default: undefined)_\n- **--dds-datatable-z-index** - Z-index of the table _(default: undefined)_\n- **--dds-datatable-min-height** - Minimum height of the table _(default: undefined)_\n- **--dds-datatable-max-height** - Maximum height of the table _(default: undefined)_\n- **--dds-datatable-overflow-x** - Horizontal overflow behavior _(default: undefined)_\n- **--dds-datatable-overflow-y** - Vertical overflow behavior _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main table container.\n- **header** - The header of the table.\n- **header-row** - The header row of the table.\n- **header-cell** - All cells of the header.\n- **body** - The body of the table.\n- **row** - All rows of the table.\n- **cell** - All cells of the table.\n- **pager** - The pager of the table.",
"doc-url": "",
"attributes": [
{
"name": "rowKey",
"description": "Row key to use for row selection, this should be a unique key for each row",
"value": { "type": "string", "default": "'id'" }
},
{
"name": "enableRowSelection",
"description": "Enable row selection on the table, can be a boolean or a function that returns a boolean",
"value": {
"type": "boolean | ((row: Row) => boolean)",
"default": "false"
}
},
{
"name": "enableSorting",
"description": "Enable sorting on the table",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "manualSorting",
"description": "Enable manual sorting on the table",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "manualPagination",
"description": "Enables manual pagination. If this option is set to true, the table will not automatically paginate rows and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "autoResetPageIndex",
"description": "If set to true, pagination will be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc. This behavior is automatically disabled when manualPagination is true but it can be overridden by explicitly assigning a boolean value to the autoResetPageIndex table option.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "enableRowClick",
"description": "Enable row click on the table",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "loading",
"description": "Loading state of the table",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "enableStripedRows",
"description": "Whether to enable striped rows",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "rowCount",
"description": "Number of rows in the table",
"value": { "type": "number | undefined" }
},
{
"name": "ariaDescribedBy",
"description": "ID of element describing the table",
"value": { "type": "string | undefined" }
},
{
"name": "caption",
"description": "Caption text for the table",
"value": { "type": "string | undefined" }
},
{
"name": "pager",
"description": "Whether to show the pager component",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "showPageSizeOptions",
"description": "Show the page size options.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showPageIndex",
"description": "Show the page index.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showPageCount",
"description": "Show the page count.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showFirstButton",
"description": "Show the first button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showPreviousButton",
"description": "Show the previous button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showNextButton",
"description": "Show the next button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showLastButton",
"description": "Show the last button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "firstButtonLabel",
"description": "The label of the first button",
"value": { "type": "string" }
},
{
"name": "previousButtonLabel",
"description": "The label of the previous button",
"value": { "type": "string" }
},
{
"name": "nextButtonLabel",
"description": "The label of the next button",
"value": { "type": "string" }
},
{
"name": "lastButtonLabel",
"description": "The label of the last button",
"value": { "type": "string" }
},
{
"name": "pageSizeOptions",
"description": "Available page size options for the pager",
"value": { "type": "number[]", "default": "[10, 25, 50, 100]" }
},
{
"name": "sorting",
"description": "Sorting state of the table",
"value": { "type": "SortingState" }
},
{
"name": "rowSelection",
"description": "Selection state of the table",
"value": { "type": "RowSelectionState" }
},
{
"name": "pagination",
"description": "Pagination state of the table",
"value": { "type": "PaginationState" }
}
],
"events": [
{
"name": "dds-sorting-change",
"type": "{ sorting: SortingState }",
"description": "Fired when the sorting of the table changes."
},
{
"name": "dds-selection-change",
"type": "{ selection: RowSelectionState }",
"description": "Fired when the selection of the table changes."
},
{
"name": "dds-pagination-change",
"type": "{ pagination: PaginationState }",
"description": "Fired when the pagination of the table changes."
},
{
"name": "dds-row-click",
"type": "{ row: Row }",
"description": "Fired when a row is clicked."
}
],
"js": {
"properties": [
{
"name": "data",
"description": "Data to display in the table",
"type": "RowData[]"
},
{
"name": "columns",
"description": "Columns to display in the table",
"type": "ExtendedColumnDef[]"
},
{
"name": "rowKey",
"description": "Row key to use for row selection, this should be a unique key for each row",
"type": "string"
},
{
"name": "enableRowSelection",
"description": "Enable row selection on the table, can be a boolean or a function that returns a boolean",
"type": "boolean | ((row: Row) => boolean)"
},
{
"name": "enableSorting",
"description": "Enable sorting on the table",
"type": "boolean"
},
{
"name": "manualSorting",
"description": "Enable manual sorting on the table",
"type": "boolean"
},
{
"name": "manualPagination",
"description": "Enables manual pagination. If this option is set to true, the table will not automatically paginate rows and instead will expect you to manually paginate the rows before passing them to the table. This is useful if you are doing server-side pagination and aggregation.",
"type": "boolean"
},
{
"name": "autoResetPageIndex",
"description": "If set to true, pagination will be reset to the first page when page-altering state changes eg. data is updated, filters change, grouping changes, etc. This behavior is automatically disabled when manualPagination is true but it can be overridden by explicitly assigning a boolean value to the autoResetPageIndex table option.",
"type": "boolean"
},
{
"name": "enableRowClick",
"description": "Enable row click on the table",
"type": "boolean"
},
{
"name": "loading",
"description": "Loading state of the table",
"type": "boolean"
},
{
"name": "enableStripedRows",
"description": "Whether to enable striped rows",
"type": "boolean"
},
{
"name": "rowCount",
"description": "Number of rows in the table",
"type": "number | undefined"
},
{
"name": "ariaDescribedBy",
"description": "ID of element describing the table",
"type": "string | undefined"
},
{
"name": "caption",
"description": "Caption text for the table",
"type": "string | undefined"
},
{
"name": "pager",
"description": "Whether to show the pager component",
"type": "boolean"
},
{
"name": "showPageSizeOptions",
"description": "Show the page size options.",
"type": "string"
},
{
"name": "showPageIndex",
"description": "Show the page index.",
"type": "string"
},
{
"name": "showPageCount",
"description": "Show the page count.",
"type": "string"
},
{
"name": "showFirstButton",
"description": "Show the first button.",
"type": "string"
},
{
"name": "showPreviousButton",
"description": "Show the previous button.",
"type": "string"
},
{
"name": "showNextButton",
"description": "Show the next button.",
"type": "string"
},
{
"name": "showLastButton",
"description": "Show the last button.",
"type": "string"
},
{
"name": "firstButtonLabel",
"description": "The label of the first button",
"type": "string"
},
{
"name": "previousButtonLabel",
"description": "The label of the previous button",
"type": "string"
},
{
"name": "nextButtonLabel",
"description": "The label of the next button",
"type": "string"
},
{
"name": "lastButtonLabel",
"description": "The label of the last button",
"type": "string"
},
{
"name": "pageStateText",
"description": "The function to determine the pager text",
"type": "(pageIndex: number, pageSize: number, totalRows: number) => string"
},
{
"name": "pageSizeOptions",
"description": "Available page size options for the pager",
"type": "number[]"
},
{
"name": "sorting",
"description": "Sorting state of the table",
"type": "SortingState"
},
{
"name": "rowSelection",
"description": "Selection state of the table",
"type": "RowSelectionState"
},
{
"name": "pagination",
"description": "Pagination state of the table",
"type": "PaginationState"
}
],
"events": [
{
"name": "dds-sorting-change",
"type": "{ sorting: SortingState }",
"description": "Fired when the sorting of the table changes."
},
{
"name": "dds-selection-change",
"type": "{ selection: RowSelectionState }",
"description": "Fired when the selection of the table changes."
},
{
"name": "dds-pagination-change",
"type": "{ pagination: PaginationState }",
"description": "Fired when the pagination of the table changes."
},
{
"name": "dds-row-click",
"type": "{ row: Row }",
"description": "Fired when a row is clicked."
}
]
}
},
{
"name": "dap-ds-datepicker",
"description": "A datepicker is a graphical user interface widget that allows the user to select a date from a calendar and/or time from a time range.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the datepicker value changes.\n- **dds-input** - Fired when the datepicker input value changes.\n- **dds-valid-date** - Fired when the datepicker input value is valid. Happens on manual input typing.\n- **dds-invalid-date** - Fired when the datepicker input value is invalid. Happens on manual input typing.\n- **dds-clear** - Fired when the datepicker is cleared.\n- **dds-focus** - Emitted when the datepicker gains focus.\n- **dds-blur** - Emitted when the datepicker loses focus.\n\n### **CSS Properties:**\n - **--dds-combobox-background** - The background color of the combobox. Defaults to var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-combobox-border-color** - The border color of the combobox. Defaults to var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-combobox-border-width** - The border width of the combobox. Defaults to var(--dds-border-width-base, 1px). _(default: undefined)_\n- **--dds-combobox-border-radius** - The border radius of the combobox. Defaults to var(--dds-radius-base). _(default: undefined)_\n- **--dds-combobox-text-color** - The text color of the combobox. Defaults to var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-combobox-placeholder-color** - The placeholder text color. Defaults to var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-combobox-disabled-background** - The background color when disabled. Defaults to var(--dds-background-neutral-stronger). _(default: undefined)_\n- **--dds-combobox-disabled-text** - The text color when disabled. Defaults to var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-combobox-error-border** - The border color for error state. Defaults to var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-combobox-success-border** - The border color for success state. Defaults to var(--dds-border-positive-base). _(default: undefined)_\n- **--dds-combobox-icon-color** - The color of the icons. Defaults to var(--dds-text-icon-neutral-subtle). _(default: undefined)_\n- **--dds-combobox-clear-icon-color** - The color of the clear icon. Defaults to var(--dds-button-subtle-icon-neutral-enabled). _(default: undefined)_\n- **--dds-combobox-popup-background** - The background color of the popup. Defaults to var(--dds-background-neutral-subtle). _(default: undefined)_\n- **--dds-combobox-popup-shadow** - The box shadow of the popup. Defaults to 0 4px 6px -1px rgb(0 0 0 / 8%), 0 2px 4px -1px rgb(0 0 0 / 6%). _(default: undefined)_\n- **--dds-combobox-padding-xs** - The padding for extra small size. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-padding-sm** - The padding for small size. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-padding-lg** - The padding for large size. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-padding-horizontal** - The horizontal padding. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-padding-vertical** - The vertical padding. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-gap** - The gap between elements. Defaults to var(--dds-spacing-100). _(default: undefined)_\n- **--dds-combobox-icon-gap** - The gap between icons. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-action-gap** - The gap between action elements. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-action-padding** - The padding for action elements. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-clear-icon-width** - The width of the clear icon. Defaults to var(--dds-spacing-800). _(default: undefined)_\n- **--dds-combobox-dropdown-icon-right** - The right position of the dropdown icon. Defaults to var(--dds-spacing-600). _(default: undefined)_\n- **--dds-combobox-min-width** - The minimum width of the combobox. Defaults to 7.5rem. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main datepicker container.\n- **calendar** - The calendar of the datepicker.\n- **trigger** - The trigger button of the datepicker.\n- **label** - The label of the datepicker.\n- **description** - The description of the datepicker.\n- **feedback** - The feedback of the datepicker.\n- **tooltip** - The tooltip of the datepicker.\n- **input** - The input of the datepicker.\n- **clear-button** - The clear button of the datepicker.",
"doc-url": "",
"attributes": [
{
"name": "disabledDate",
"description": "The disabled date of the datepicker. This function will be called for each date to determine if it is disabled.",
"value": {
"type": "(date: Dayjs) => boolean",
"default": "(date: Dayjs) => false"
}
},
{
"name": "placement",
"description": "The placement of the dropdown of the datepicker.",
"value": {
"type": "'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end'",
"default": "'bottom-start'"
}
},
{
"name": "opened",
"description": "The open state of the datepicker.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "openCalendarOnInput",
"description": "Wheter the calendar should open on typing.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "sendEmptyEventOnInput",
"description": "Wheter the calendar should send an empty event on typing.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "placeholder",
"description": "The placeholder of the datepicker.",
"value": { "type": "string | null" }
},
{
"name": "loading",
"description": "The loading state of the datepicker.",
"value": { "type": "boolean | undefined", "default": "false" }
},
{
"name": "format",
"description": "The format of the datepicker. This is a comma separated list of [formats](https://day.js.org/docs/en/display/format).",
"value": { "type": "string | undefined" }
},
{
"name": "formatSeparator",
"description": "The format separator character in the format attribute.",
"value": { "type": "string", "default": "'|'" }
},
{
"name": "clearButton",
"description": "Whether the clear button should be shown.",
"value": { "type": "string | undefined", "default": "'true'" }
},
{
"name": "clearButtonAriaLabel",
"description": "The aria label of the clear button.",
"value": { "type": "string | undefined" }
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the datepicker.",
"value": { "type": "FloatingStrategy", "default": "'fixed'" }
},
{
"name": "locale",
"description": "The locale of the datepicker. By default it uses the global locale from dayjs. It is determined from the browser language.",
"value": { "type": "'hu' | 'en'" }
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the datepicker value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the datepicker input value changes."
},
{
"name": "dds-valid-date",
"type": "{ value: string }",
"description": "Fired when the datepicker input value is valid. Happens on manual input typing."
},
{
"name": "dds-invalid-date",
"type": "{ value: string, type: 'invalid' | 'out-of-range' }",
"description": "Fired when the datepicker input value is invalid. Happens on manual input typing."
},
{
"name": "dds-clear",
"type": "{ void }",
"description": "Fired when the datepicker is cleared."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the datepicker gains focus."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the datepicker loses focus."
}
],
"js": {
"properties": [
{
"name": "currentDate",
"description": "The current visible date of the calendar. Only the month and year are considered.",
"type": "Dayjs"
},
{
"name": "minDate",
"description": "The minimum date of the datepicker. This date will be the minimum selectable date.",
"type": "Dayjs"
},
{
"name": "maxDate",
"description": "The maximum date of the datepicker. This date will be the maximum selectable date.",
"type": "Dayjs"
},
{
"name": "disabledDate",
"description": "The disabled date of the datepicker. This function will be called for each date to determine if it is disabled.",
"type": "(date: Dayjs) => boolean"
},
{
"name": "placement",
"description": "The placement of the dropdown of the datepicker.",
"type": "'top-start' | 'top' | 'top-end' | 'right-start' | 'right' | 'right-end' | 'bottom-start' | 'bottom' | 'bottom-end' | 'left-start' | 'left' | 'left-end'"
},
{
"name": "opened",
"description": "The open state of the datepicker.",
"type": "boolean"
},
{
"name": "openCalendarOnInput",
"description": "Wheter the calendar should open on typing.",
"type": "boolean"
},
{
"name": "sendEmptyEventOnInput",
"description": "Wheter the calendar should send an empty event on typing.",
"type": "boolean"
},
{
"name": "placeholder",
"description": "The placeholder of the datepicker.",
"type": "string | null"
},
{
"name": "loading",
"description": "The loading state of the datepicker.",
"type": "boolean | undefined"
},
{
"name": "format",
"description": "The format of the datepicker. This is a comma separated list of [formats](https://day.js.org/docs/en/display/format).",
"type": "string | undefined"
},
{
"name": "formatSeparator",
"description": "The format separator character in the format attribute.",
"type": "string"
},
{
"name": "clearButton",
"description": "Whether the clear button should be shown.",
"type": "string | undefined"
},
{
"name": "clearButtonAriaLabel",
"description": "The aria label of the clear button.",
"type": "string | undefined"
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the datepicker.",
"type": "FloatingStrategy"
},
{
"name": "locale",
"description": "The locale of the datepicker. By default it uses the global locale from dayjs. It is determined from the browser language.",
"type": "'hu' | 'en'"
},
{ "name": "focusElement" },
{ "name": "validity", "type": "ValidityState" },
{
"name": "value",
"description": "The value of the datepicker.",
"type": "Dayjs"
},
{
"name": "label",
"description": "The label of the datepicker.",
"type": "string"
},
{
"name": "description",
"description": "The description of the datepicker.",
"type": "string"
},
{
"name": "size",
"description": "The size of the datepicker.",
"type": "'xs' | 'sm' | 'sm'"
},
{
"name": "disabled",
"description": "The disabled state of the datepicker.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the datepicker.",
"type": "boolean"
},
{
"name": "readonly",
"description": "The readonly state of the datepicker.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "The autofocus of the datepicker.",
"type": "boolean"
},
{
"name": "tooltip",
"description": "The tooltip of the datepicker.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the datepicker.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "feedback",
"description": "The feedback of the datepicker.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the datepicker.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "optional",
"description": "The optional state of the datepicker.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the datepicker.",
"type": "string"
},
{
"name": "subtle",
"description": "The weight of the label. Default is `false`",
"type": "boolean"
},
{
"name": "autocomplete",
"description": "The autocomplete of the datepicker.",
"type": "string"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the datepicker value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the datepicker input value changes."
},
{
"name": "dds-valid-date",
"type": "{ value: string }",
"description": "Fired when the datepicker input value is valid. Happens on manual input typing."
},
{
"name": "dds-invalid-date",
"type": "{ value: string, type: 'invalid' | 'out-of-range' }",
"description": "Fired when the datepicker input value is invalid. Happens on manual input typing."
},
{
"name": "dds-clear",
"type": "{ void }",
"description": "Fired when the datepicker is cleared."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the datepicker gains focus."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the datepicker loses focus."
}
]
}
},
{
"name": "dap-ds-divider",
"description": "A divider is a visual separator between elements.\n---\n\n\n### **CSS Properties:**\n - **--dds-divider-border-width** - The width of the divider border. Defaults to var(--dds-border-width-base) _(default: undefined)_\n- **--dds-divider-border-style** - The style of the divider border. Defaults to solid _(default: undefined)_\n- **--dds-divider-border-color** - The color of the divider border. Defaults to var(--dds-border-neutral-divider) _(default: undefined)_\n- **--dds-divider-border-color-inverted** - The color of the divider border when inverted. Defaults to var(--dds-border-neutral-divider-inverted) _(default: undefined)_",
"doc-url": "",
"attributes": [
{
"name": "vertical",
"description": "Whether the divider is vertical",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "spacing",
"description": "The spacing of the divider",
"value": {
"type": "0 | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 1000 | 1200 | 1400 | 1600 | 1800 | 2000 | 2400 | 3000 | 4000 | 5000 | 6000",
"default": "0"
}
},
{
"name": "variant",
"description": "The variant of the divider",
"value": {
"type": "'normal' | 'inverted'",
"default": "'normal'"
}
}
],
"events": [],
"js": {
"properties": [
{
"name": "vertical",
"description": "Whether the divider is vertical",
"type": "boolean"
},
{
"name": "spacing",
"description": "The spacing of the divider",
"type": "0 | 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 1000 | 1200 | 1400 | 1600 | 1800 | 2000 | 2400 | 3000 | 4000 | 5000 | 6000"
},
{
"name": "variant",
"description": "The variant of the divider",
"type": "'normal' | 'inverted'"
}
],
"events": []
}
},
{
"name": "dap-ds-feedback",
"description": "A feedback is a container for feedback messages.\n---\n\n\n### **Slots:**\n - **icon** - The custom icon of the feedback.\n- _default_ - The text of the feedback.\n\n### **CSS Properties:**\n - **--dds-feedback-spacing** - The spacing around the feedback component. Default is `var(--dds-spacing-200)`. _(default: undefined)_\n- **--dds-feedback-color** - The text color of the feedback. Default is `var(--dds-text-positive-subtle)`. _(default: undefined)_\n- **--dds-feedback-font-size** - The font size of the feedback. Default is `var(--dds-font-sm)`. _(default: undefined)_\n- **--dds-feedback-font-weight** - The font weight of the feedback. Default is `var(--dds-font-weight-bold)`. _(default: undefined)_\n- **--dds-feedback-icon-fill** - The fill color of the feedback icon. Default is `var(--dds-icon-positive-subtle)`. _(default: undefined)_\n- **--dds-feedback-icon-spacing** - The spacing between the icon and text. Default is `var(--dds-spacing-100)`. _(default: undefined)_\n- **--dds-feedback-color-warning** - The text color for warning feedback. Default is `var(--dds-text-neutral-base)`. _(default: undefined)_\n- **--dds-feedback-color-positive** - The text color for positive feedback. Default is `var(--dds-text-positive-subtle)`. _(default: undefined)_\n- **--dds-feedback-color-negative** - The text color for negative feedback. Default is `var(--dds-text-negative-subtle)`. _(default: undefined)_\n- **--dds-feedback-icon-fill-warning** - The icon fill color for warning feedback. Default is `var(--dds-icon-informative-subtle)`. _(default: undefined)_\n- **--dds-feedback-icon-fill-positive** - The icon fill color for positive feedback. Default is `var(--dds-icon-positive-subtle)`. _(default: undefined)_\n- **--dds-feedback-icon-fill-negative** - The icon fill color for negative feedback. Default is `var(--dds-icon-negative-subtle)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main feedback container.\n- **icon** - The icon of the feedback.\n- **text** - The text of the feedback.",
"doc-url": "",
"attributes": [],
"slots": [
{
"name": "icon",
"description": "The custom icon of the feedback."
},
{ "name": "", "description": "The text of the feedback." }
],
"events": [],
"js": {
"properties": [
{
"name": "feedback",
"description": "The feedback message.",
"type": "string"
},
{
"name": "feedbackSize",
"description": "The type of the feedback.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "feedbackSubtle",
"description": "The weight of the feedback.",
"type": "boolean"
},
{
"name": "feedbackNoMargin",
"description": "Removes the margins around the feedback.",
"type": "boolean"
},
{
"name": "feedbackId",
"description": "The id of the feedback.",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-file-input-list-item",
"description": "A file input list item is a container for file input list items.\n---\n\n\n### **Events:**\n - **dds-file-remove** - Dispatched when a file is removed from the list.\n\n### **CSS Properties:**\n - **--dds-file-list-item-padding** - The padding of the file list item. _(default: undefined)_\n- **--dds-file-list-item-border-width** - The border width of the file list item. _(default: undefined)_\n- **--dds-file-list-item-border-color** - The border color of the file list item. _(default: undefined)_\n- **--dds-file-list-item-border-radius** - The border radius of the file list item. _(default: undefined)_\n- **--dds-file-list-item-bg-color** - The background color of the file list item. _(default: undefined)_\n- **--dds-file-list-item-font-weight** - The font weight of the file list item. _(default: undefined)_\n- **--dds-file-list-item-disabled-bg-color** - The background color of the disabled file list item. _(default: undefined)_\n- **--dds-file-list-item-disabled-color** - The text color of the disabled file list item. _(default: undefined)_\n- **--dds-file-list-item-content-margin** - The margin of the content within the file list item. _(default: undefined)_\n- **--dds-file-list-item-content-gap** - The gap between content elements in the file list item. _(default: undefined)_\n- **--dds-file-list-item-filename-color** - The color of the filename text. _(default: undefined)_\n- **--dds-file-list-item-filesize-color** - The color of the filesize text. _(default: undefined)_\n- **--dds-file-list-item-feedback-padding** - The padding of the feedback section. _(default: undefined)_\n- **--dds-file-list-item-feedback-border-color** - The border color of the feedback section. _(default: undefined)_\n- **--dds-file-list-item-feedback-font-size** - The font size of the feedback text. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main file input list item container.\n- **feedback** - The feedback container.\n- **link** - The link text of the item component.",
"doc-url": "",
"attributes": [
{
"name": "disabled",
"description": "Disables the file input list item.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "inputName",
"description": "The name of the file input.",
"value": { "type": "string" }
},
{
"name": "feedback",
"description": "The feedback message.",
"value": { "type": "string" }
},
{
"name": "feedbackType",
"description": "Feedback type.",
"value": {
"type": "'negative' | 'positive' | 'warning' | 'info'"
}
},
{
"name": "loading",
"description": "Loading state of the file input list item.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "showDeleteButton",
"description": "Show delete button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showSize",
"description": "Show file size.",
"value": { "type": "boolean", "default": "false" }
},
{ "name": "fileData", "value": { "type": "FileListElement" } },
{
"name": "subtle",
"description": "Subtle style.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "progress",
"description": "The progress of the file upload.",
"value": { "type": "string", "default": "'0'" }
},
{
"name": "href",
"description": "The url of the item link. If present, the item title will rendered as a link.",
"value": { "type": "string" }
},
{
"name": "rel",
"description": "The rel of the item link. Only used if href is present.",
"value": { "type": "string" }
},
{
"name": "target",
"description": "The target of the item link. Only used if href is present.",
"value": { "type": "LinkTarget" }
},
{
"name": "download",
"description": "Whether the file should be downloaded when clicked.",
"value": { "type": "string", "default": "'true'" }
}
],
"events": [
{
"name": "dds-file-remove",
"type": "{ file: FileListElement }",
"description": "Dispatched when a file is removed from the list."
}
],
"js": {
"properties": [
{
"name": "disabled",
"description": "Disables the file input list item.",
"type": "boolean"
},
{
"name": "inputName",
"description": "The name of the file input.",
"type": "string"
},
{
"name": "feedback",
"description": "The feedback message.",
"type": "string"
},
{
"name": "feedbackType",
"description": "Feedback type.",
"type": "'negative' | 'positive' | 'warning' | 'info'"
},
{
"name": "loading",
"description": "Loading state of the file input list item.",
"type": "boolean"
},
{
"name": "showDeleteButton",
"description": "Show delete button.",
"type": "string"
},
{
"name": "showSize",
"description": "Show file size.",
"type": "boolean"
},
{ "name": "fileData", "type": "FileListElement" },
{
"name": "subtle",
"description": "Subtle style.",
"type": "boolean"
},
{
"name": "progress",
"description": "The progress of the file upload.",
"type": "string"
},
{
"name": "href",
"description": "The url of the item link. If present, the item title will rendered as a link.",
"type": "string"
},
{
"name": "rel",
"description": "The rel of the item link. Only used if href is present.",
"type": "string"
},
{
"name": "target",
"description": "The target of the item link. Only used if href is present.",
"type": "LinkTarget"
},
{
"name": "download",
"description": "Whether the file should be downloaded when clicked.",
"type": "string"
},
{ "name": "formattedSize" }
],
"events": [
{
"name": "dds-file-remove",
"type": "{ file: FileListElement }",
"description": "Dispatched when a file is removed from the list."
}
]
}
},
{
"name": "dap-ds-file-input-list",
"description": "A file input list is a container for file input items.\n---\n\n\n### **CSS Properties:**\n - **--dds-file-list-display** - Controls the display property (default: flex) _(default: undefined)_\n- **--dds-file-list-flex-direction** - Controls the flex-direction property (default: column) _(default: undefined)_\n- **--dds-file-list-padding** - Controls the padding property (default: 0) _(default: undefined)_\n- **--dds-file-list-list-style** - Controls the list-style-type property (default: none) _(default: undefined)_\n- **--dds-file-list-gap** - Controls the row-gap property (default: var(--dds-spacing-200)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main file input list container.",
"doc-url": "",
"attributes": [
{
"name": "for",
"description": "The id of the file input element to bind to.",
"value": { "type": "string" }
},
{
"name": "disabled",
"description": "Disables the file input list.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "showDeleteButton",
"description": "Whether to show the delete button in the file input list item.",
"value": { "type": "string", "default": "'true'" }
}
],
"events": [],
"js": {
"properties": [
{
"name": "for",
"description": "The id of the file input element to bind to.",
"type": "string"
},
{
"name": "disabled",
"description": "Disables the file input list.",
"type": "boolean"
},
{
"name": "showDeleteButton",
"description": "Whether to show the delete button in the file input list item.",
"type": "string"
},
{ "name": "files" }
],
"events": []
}
},
{
"name": "dap-ds-file-input",
"description": "A file input is a control that allows users to select files to upload.\n---\n\n\n### **Events:**\n - **dds-upload-start** - Fired when a file upload starts.\n- **dds-upload-progress** - Fired during file upload progress.\n- **dds-upload-complete** - Fired when a file upload completes successfully.\n- **dds-upload-error** - Fired when a file upload encounters an error.\n- **dds-all-uploads-complete** - Fired when all file uploads are complete.\n- **dds-file-removed** - Fired when a file is removed from the file input.\n- **dds-file-delete-error** - Fired when a file deletion from server encounters an error.\n- **dds-file-change** - Fired when the file input value changes.\n\n### **Methods:**\n - **abortUpload(fileName: _string_)** - Aborts upload for a specific file\n- **abortAllUploads()** - Aborts all active uploads\n- **startUpload()** - Manually start upload of all selected files\n\n### **Slots:**\n - **dropzone-content** - The content to display in the dropzone.\n\n### **CSS Parts:**\n - **base** - The main file input container.\n- **input** - The file input control.\n- **label** - The file input label.\n- **description** - The file input description.\n- **feedback** - The file input feedback.\n- **tooltip** - The file input tooltip.\n- **upload-progress** - The upload progress container.\n- **browse-button** - The browse button.\n- **upload-button** - The upload button.\n- **dropzone** - The dropzone area.\n- **file-list** - The file list container.\n- **file-list-item** - Individual file list items.",
"doc-url": "",
"attributes": [
{
"name": "uploadButtonLabel",
"description": "The label for the upload button.",
"value": { "type": "string" }
},
{
"name": "browseButtonLabel",
"description": "The label for the browse button.",
"value": { "type": "string" }
},
{
"name": "showDropzone",
"description": "Whether to show a separate dropzone area.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "dropzoneText",
"description": "Text to display in the dropzone.",
"value": { "type": "string" }
},
{
"name": "showFileList",
"description": "Whether to show the built-in file list.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "confirmRemove",
"description": "Whether to show confirmation dialog before removing files.",
"value": { "type": "boolean", "default": "true" }
},
{
"name": "accept",
"description": "The file types that the file input accepts.",
"value": { "type": "string" }
},
{
"name": "multiple",
"description": "Whether the file input accepts multiple files.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "keepValue",
"description": "Whether to keep the value when new files are selected.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "uploadUrl",
"description": "A remote URL to upload files to.",
"value": { "type": "string" }
},
{
"name": "autoupload",
"description": "Whether to automatically upload files after selection.",
"value": { "type": "boolean" }
},
{
"name": "uploadProperty",
"description": "The property to use when uploading files",
"value": { "type": "string", "default": "'file'" }
},
{
"name": "uploadMethod",
"description": "The HTTP method to use when uploading files",
"value": { "type": "string", "default": "'POST'" }
},
{
"name": "deleteUrl",
"description": "A remote URL to delete uploaded files from. Supports placeholders: `{fileName}`, `{id}`, `{key}`, `{location}`.",
"value": { "type": "string" }
},
{
"name": "deleteMethod",
"description": "The HTTP method to use when deleting files",
"value": { "type": "string", "default": "'DELETE'" }
},
{
"name": "withCredentials",
"description": "Whether to send credentials with the file upload request",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "uploadHeaders",
"description": "Custom headers for upload requests (JSON string).",
"value": { "type": "string" }
},
{
"name": "deleteHeaders",
"description": "Custom headers for delete requests (JSON string).",
"value": { "type": "string" }
},
{
"name": "maxFiles",
"description": "The maximum number of files that can be uploaded.",
"value": { "type": "number" }
},
{
"name": "maxFileSize",
"description": "The maximum size of files that can be uploaded (in bytes).",
"value": { "type": "number" }
}
],
"slots": [
{
"name": "dropzone-content",
"description": "The content to display in the dropzone."
}
],
"events": [
{
"name": "dds-upload-start",
"type": "{ file: File }",
"description": "Fired when a file upload starts."
},
{
"name": "dds-upload-progress",
"type": "{ file: File, progress: number }",
"description": "Fired during file upload progress."
},
{
"name": "dds-upload-complete",
"type": "{ file: File, item: DapDSFileInputListItem, result: any }",
"description": "Fired when a file upload completes successfully."
},
{
"name": "dds-upload-error",
"type": "{ file: File, item: DapDSFileInputListItem, error: Error }",
"description": "Fired when a file upload encounters an error."
},
{
"name": "dds-all-uploads-complete",
"type": "{ void }",
"description": "Fired when all file uploads are complete."
},
{
"name": "dds-file-removed",
"type": "{ file: FileListElement }",
"description": "Fired when a file is removed from the file input."
},
{
"name": "dds-file-delete-error",
"type": "{ file: FileListElement, error: Error }",
"description": "Fired when a file deletion from server encounters an error."
},
{
"name": "dds-file-change",
"type": "{ files: File[] }",
"description": "Fired when the file input value changes."
}
],
"js": {
"properties": [
{
"name": "uploadButtonLabel",
"description": "The label for the upload button.",
"type": "string"
},
{
"name": "browseButtonLabel",
"description": "The label for the browse button.",
"type": "string"
},
{
"name": "showDropzone",
"description": "Whether to show a separate dropzone area.",
"type": "boolean"
},
{
"name": "dropzoneText",
"description": "Text to display in the dropzone.",
"type": "string"
},
{
"name": "showFileList",
"description": "Whether to show the built-in file list.",
"type": "boolean"
},
{
"name": "confirmRemove",
"description": "Whether to show confirmation dialog before removing files.",
"type": "boolean"
},
{
"name": "accept",
"description": "The file types that the file input accepts.",
"type": "string"
},
{
"name": "multiple",
"description": "Whether the file input accepts multiple files.",
"type": "boolean"
},
{
"name": "keepValue",
"description": "Whether to keep the value when new files are selected.",
"type": "boolean"
},
{
"name": "uploadUrl",
"description": "A remote URL to upload files to.",
"type": "string"
},
{
"name": "autoupload",
"description": "Whether to automatically upload files after selection.",
"type": "boolean"
},
{
"name": "uploadProperty",
"description": "The property to use when uploading files",
"type": "string"
},
{
"name": "uploadMethod",
"description": "The HTTP method to use when uploading files",
"type": "string"
},
{
"name": "deleteUrl",
"description": "A remote URL to delete uploaded files from. Supports placeholders: `{fileName}`, `{id}`, `{key}`, `{location}`.",
"type": "string"
},
{
"name": "deleteMethod",
"description": "The HTTP method to use when deleting files",
"type": "string"
},
{
"name": "withCredentials",
"description": "Whether to send credentials with the file upload request",
"type": "boolean"
},
{
"name": "uploadHeaders",
"description": "Custom headers for upload requests (JSON string).",
"type": "string"
},
{
"name": "deleteHeaders",
"description": "Custom headers for delete requests (JSON string).",
"type": "string"
},
{
"name": "fileList",
"description": "The file list component to bind to",
"type": "DapDSFileInputList | null"
},
{
"name": "maxFiles",
"description": "The maximum number of files that can be uploaded.",
"type": "number"
},
{
"name": "maxFileSize",
"description": "The maximum size of files that can be uploaded (in bytes).",
"type": "number"
},
{ "name": "files" },
{
"name": "name",
"description": "The name of the file input.",
"type": "string"
},
{
"name": "value",
"description": "The value of the file input.",
"type": "string"
},
{
"name": "status",
"description": "The status of the file input.",
"type": "'success' | 'error'"
},
{
"name": "label",
"description": "The label for the file input.",
"type": "string"
},
{
"name": "description",
"description": "The description for the file input.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip for the file input.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the input.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "disabled",
"description": "Whether the file input is disabled.",
"type": "boolean"
},
{
"name": "size",
"description": "The size of the file input.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "feedback",
"description": "The feedback for the file input.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The type of feedback for the file input.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "required",
"description": "Whether the file input is required.",
"type": "boolean"
},
{
"name": "optional",
"description": "Whether the file input is optional.",
"type": "boolean"
},
{
"name": "subtle",
"description": "Font weight of the feedback label. Default is `false` which is bold.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-upload-start",
"type": "{ file: File }",
"description": "Fired when a file upload starts."
},
{
"name": "dds-upload-progress",
"type": "{ file: File, progress: number }",
"description": "Fired during file upload progress."
},
{
"name": "dds-upload-complete",
"type": "{ file: File, item: DapDSFileInputListItem, result: any }",
"description": "Fired when a file upload completes successfully."
},
{
"name": "dds-upload-error",
"type": "{ file: File, item: DapDSFileInputListItem, error: Error }",
"description": "Fired when a file upload encounters an error."
},
{
"name": "dds-all-uploads-complete",
"type": "{ void }",
"description": "Fired when all file uploads are complete."
},
{
"name": "dds-file-removed",
"type": "{ file: FileListElement }",
"description": "Fired when a file is removed from the file input."
},
{
"name": "dds-file-delete-error",
"type": "{ file: FileListElement, error: Error }",
"description": "Fired when a file deletion from server encounters an error."
},
{
"name": "dds-file-change",
"type": "{ files: File[] }",
"description": "Fired when the file input value changes."
}
]
}
},
{
"name": "dap-ds-icon",
"description": "An icon is a graphical symbol that represents an object or action.\n---\n\n\n### **Slots:**\n - _default_ - The content of the icon for custom svg icons.\n\n### **CSS Properties:**\n - **--dds-icon-size-xs** - The size of extra small icons (default: 12px) _(default: undefined)_\n- **--dds-icon-size-sm** - The size of small icons (default: 16px) _(default: undefined)_\n- **--dds-icon-size-md** - The size of medium icons (default: 20px) _(default: undefined)_\n- **--dds-icon-size-lg** - The size of large icons (default: 24px) _(default: undefined)_\n- **--dds-icon-size-xl** - The size of extra large icons (default: 32px) _(default: undefined)_\n- **--dds-icon-size-xxl** - The size of extra extra large icons (default: 40px) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main icon container.\n- **icon** - The icon of the icon.",
"doc-url": "",
"attributes": [
{
"name": "name",
"description": "The name of the icon",
"value": { "type": "string" }
},
{
"name": "size",
"description": "The size of the icon",
"value": {
"type": "'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs'",
"default": "'md'"
}
},
{
"name": "staticSize",
"description": "The size of the icon in pixels. This overrides the size attribute.",
"value": { "type": "number | undefined" }
},
{
"name": "focusable",
"description": "Whether the icon is focusable. Default is false.",
"value": { "type": "boolean | undefined", "default": "false" }
}
],
"slots": [
{
"name": "",
"description": "The content of the icon for custom svg icons."
}
],
"events": [],
"js": {
"properties": [
{
"name": "name",
"description": "The name of the icon",
"type": "string"
},
{
"name": "size",
"description": "The size of the icon",
"type": "'xxl' | 'xl' | 'lg' | 'md' | 'sm' | 'xs'"
},
{
"name": "staticSize",
"description": "The size of the icon in pixels. This overrides the size attribute.",
"type": "number | undefined"
},
{
"name": "focusable",
"description": "Whether the icon is focusable. Default is false.",
"type": "boolean | undefined"
},
{
"name": "ariaHidden",
"description": "Whether the icon is hidden from the accessibility tree. Default is true.",
"type": "boolean"
},
{
"name": "ariaLabel",
"description": "The aria label of the icon.",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-icon-button",
"description": "An icon button is a button with an icon.\n---\n\n\n### **Slots:**\n - _default_ - The icon of the button.\n\n### **CSS Properties:**\n - **--dds-icon-button-border-width** - The width of the button's border. Defaults to var(--dds-border-width-base). _(default: undefined)_\n- **--dds-icon-button-border-color** - The color of the button's border. Defaults to var(--dds-border-neutral-transparent-interactive). _(default: undefined)_\n- **--dds-icon-button-border-radius** - The border radius of the button. Defaults to var(--dds-radius-rounded). _(default: undefined)_\n- **--dds-icon-button-hover-border-width** - The width of the button's border on hover. Defaults to var(--dds-border-width-large). _(default: undefined)_\n- **--dds-icon-button-active-border-width** - The width of the button's border when active. Defaults to var(--dds-border-width-xlarge). _(default: undefined)_\n- **--dds-icon-button-transition** - The transition property for the button. Defaults to var(--dds-transition-all). _(default: undefined)_\n- **--dds-icon-button-cursor** - The cursor style for the button. Defaults to pointer. _(default: undefined)_\n- **--dds-icon-button-disabled-cursor** - The cursor style for the disabled button. Defaults to not-allowed. _(default: undefined)_\n- **--dds-icon-button-column-gap** - The gap between icon and text. Defaults to var(--dds-spacing-100). _(default: undefined)_\n- **--dds-icon-button-padding-lg** - Padding for large size. Defaults to var(--dds-spacing-0). _(default: undefined)_\n- **--dds-icon-button-padding-md** - Padding for medium size. Defaults to var(--dds-spacing-100). _(default: undefined)_\n- **--dds-icon-button-padding-sm** - Padding for small size. Defaults to var(--dds-spacing-50). _(default: undefined)_\n- **--dds-icon-button-padding-xs** - Padding for extra small size. Defaults to var(--dds-spacing-25). _(default: undefined)_\n- **--dds-icon-button-size-lg** - Size for large button. Defaults to var(--dds-spacing-800). _(default: undefined)_\n- **--dds-icon-button-size-md** - Size for medium button. Defaults to var(--dds-spacing-600). _(default: undefined)_\n- **--dds-icon-button-size-sm** - Size for small button. Defaults to var(--dds-spacing-400). _(default: undefined)_\n- **--dds-icon-button-size-xs** - Size for extra small button. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-icon-button-neutral-bg** - Background color for neutral variant. Defaults to var(--dds-transparent-black-subtle). _(default: undefined)_\n- **--dds-icon-button-neutral-color** - Text color for neutral variant. Defaults to var(--dds-icon-neutral-base). _(default: undefined)_\n- **--dds-icon-button-neutral-hover-bg** - Hover background color for neutral variant. Defaults to var(--dds-transparent-black-base). _(default: undefined)_\n- **--dds-icon-button-neutral-active-bg** - Active background color for neutral variant. Defaults to var(--dds-transparent-black-medium). _(default: undefined)_\n- **--dds-icon-button-brand-bg** - Background color for brand variant. Defaults to var(--dds-button-subtle-background-enabled). _(default: undefined)_\n- **--dds-icon-button-brand-color** - Text color for brand variant. Defaults to var(--dds-button-subtle-icon-enabled). _(default: undefined)_\n- **--dds-icon-button-brand-hover-bg** - Hover background color for brand variant. Defaults to var(--dds-button-subtle-background-hover). _(default: undefined)_\n- **--dds-icon-button-brand-active-bg** - Active background color for brand variant. Defaults to var(--dds-button-subtle-background-pressed). _(default: undefined)_\n- **--dds-icon-button-inverted-bg** - Background color for inverted variant. Defaults to var(--dds-transparent-white-subtle). _(default: undefined)_\n- **--dds-icon-button-inverted-color** - Text color for inverted variant. Defaults to var(--dds-button-primary-icon-enabled). _(default: undefined)_\n- **--dds-icon-button-inverted-hover-bg** - Hover background color for inverted variant. Defaults to var(--dds-transparent-white-base). _(default: undefined)_\n- **--dds-icon-button-inverted-active-bg** - Active background color for inverted variant. Defaults to var(--dds-transparent-white-medium). _(default: undefined)_\n- **--dds-icon-button-inverted-brand-bg** - Background color for inverted brand variant. Defaults to var(--dds-button-primary-background-enabled). _(default: undefined)_\n- **--dds-icon-button-inverted-brand-color** - Text color for inverted brand variant. Defaults to var(--dds-button-primary-icon-enabled). _(default: undefined)_\n- **--dds-icon-button-inverted-brand-hover-bg** - Hover background color for inverted brand variant. Defaults to var(--dds-button-primary-background-enabled). _(default: undefined)_\n- **--dds-icon-button-inverted-brand-active-bg** - Active background color for inverted brand variant. Defaults to var(--dds-button-primary-background-enabled). _(default: undefined)_\n- **--dds-icon-button-disabled-color** - Color for disabled state. Defaults to var(--dds-icon-neutral-disabled). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main button container.\n- **content** - The icon of the button.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The type of the button.",
"value": {
"type": "'neutral' | 'brand' | 'inverted' | 'inverted-brand'",
"default": "'neutral'"
}
},
{
"name": "clean",
"description": "Adds a transparent background to the button",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "size",
"description": "The size of the icon",
"value": {
"type": "'lg' | 'md' | 'sm' | 'xs'",
"default": "'md'"
}
},
{
"name": "iconSize",
"description": "The size of the icon in pixels. By default the icon gets the size of the button. This property overwrites the size of the icon.",
"value": { "type": "number" }
},
{
"name": "disabled",
"description": "The disabled state of the button.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "htmlType",
"description": "The type of the button.",
"value": {
"type": "'button' | 'submit' | 'reset'",
"default": "'button'"
}
},
{
"name": "icon",
"description": "The icon of the button. You can use the icon names from the icon component",
"value": { "type": "string" }
},
{
"name": "name",
"description": "The name of the button",
"value": { "type": "string" }
}
],
"slots": [{ "name": "", "description": "The icon of the button." }],
"events": [],
"js": {
"properties": [
{
"name": "variant",
"description": "The type of the button.",
"type": "'neutral' | 'brand' | 'inverted' | 'inverted-brand'"
},
{
"name": "clean",
"description": "Adds a transparent background to the button",
"type": "boolean"
},
{
"name": "size",
"description": "The size of the icon",
"type": "'lg' | 'md' | 'sm' | 'xs'"
},
{
"name": "iconSize",
"description": "The size of the icon in pixels. By default the icon gets the size of the button. This property overwrites the size of the icon.",
"type": "number"
},
{
"name": "disabled",
"description": "The disabled state of the button.",
"type": "boolean"
},
{
"name": "htmlType",
"description": "The type of the button.",
"type": "'button' | 'submit' | 'reset'"
},
{
"name": "icon",
"description": "The icon of the button. You can use the icon names from the icon component",
"type": "string"
},
{
"name": "name",
"description": "The name of the button",
"type": "string"
},
{
"name": "ariaLabel",
"description": "The aria label of the button.",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-input",
"description": "An input is a field used to collect user input.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the input value changes.\n- **dds-input** - Fired when the input value changes.\n- **dds-keydown** - Fired when a key is pressed down.\n- **dds-blur** - Fired when the input loses focus.\n- **dds-focus** - Emitted when the input gains focus.\n\n### **Slots:**\n - **postfix** - The postfix of the input.\n- **prefix** - The prefix of the input.\n- **addon-before** - The addon before the input.\n- **addon-after** - The addon after the input.\n- **feedback-icon** - The custom icon of the feedback.\n\n### **CSS Properties:**\n - **--dds-input-height** - The height of the input. Default is var(--dds-spacing-1000). _(default: undefined)_\n- **--dds-input-padding** - The padding of the input. Default is var(--dds-spacing-300). _(default: undefined)_\n- **--dds-input-font-size** - The font size of the input. Default is var(--dds-font-base). _(default: undefined)_\n- **--dds-input-border-color** - The border color of the input. Default is var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-input-background-color** - The background color of the input. Default is var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-input-text-color** - The text color of the input. Default is var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-input-border-radius** - The border radius of the input. Default is var(--dds-radius-base). _(default: undefined)_\n- **--dds-input-border-width** - The border width of the input. Default is var(--dds-border-width-base). _(default: undefined)_\n- **--dds-input-disabled-background** - The background color of the disabled input. Default is var(--dds-fields-background-disabled). _(default: undefined)_\n- **--dds-input-disabled-text** - The text color of the disabled input. Default is var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-input-readonly-background** - The background color of the readonly input. Default is var(--dds-fields-background-read-only). _(default: undefined)_\n- **--dds-input-readonly-text** - The text color of the readonly input. Default is var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-input-success-border** - The border color of the success input. Default is var(--dds-border-positive-base). _(default: undefined)_\n- **--dds-input-error-border** - The border color of the error input. Default is var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-input-addon-background** - The background color of the input addon. Default is var(--dds-background-ui-neutral-enabled). _(default: undefined)_\n- **--dds-input-addon-success-background** - The background color of the success input addon. Default is var(--dds-background-ui-positive-enabled). _(default: undefined)_\n- **--dds-input-addon-error-background** - The background color of the error input addon. Default is var(--dds-background-ui-negative-enabled). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main input container.\n- **input** - The input element.\n- **label** - The label of the input.\n- **description** - The description of the input.\n- **feedback** - The feedback of the input.\n- **tooltip** - The tooltip of the input.\n- **addon-before** - The addon before the input.\n- **addon-after** - The addon after the input.\n- **prefix** - The prefix of the input.\n- **postfix** - The postfix of the input.",
"doc-url": "",
"attributes": [],
"slots": [
{ "name": "postfix", "description": "The postfix of the input." },
{ "name": "prefix", "description": "The prefix of the input." },
{
"name": "addon-before",
"description": "The addon before the input."
},
{
"name": "addon-after",
"description": "The addon after the input."
},
{
"name": "feedback-icon",
"description": "The custom icon of the feedback."
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
}
],
"js": {
"properties": [
{
"name": "label",
"description": "The label of the input.",
"type": "string"
},
{
"name": "description",
"description": "The description of the input.",
"type": "string"
},
{
"name": "optionalLabel",
"description": "Text of optional label.",
"type": "string"
},
{
"name": "subtle",
"description": "Text weight of label. If true the label is subtle. Default value is false.",
"type": "boolean"
},
{
"name": "value",
"description": "The value of the input.",
"type": "string"
},
{
"name": "placeholder",
"description": "The placeholder of the input.",
"type": "string"
},
{
"name": "loading",
"description": "The loading state of the input. Default is false.",
"type": "boolean"
},
{
"name": "tooltip",
"description": "The tooltip of the input.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the input.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "tooltipAriaLabel",
"description": "The aria label of the tooltip.",
"type": "string"
},
{
"name": "feedback",
"description": "The feedback of the input.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the input. Can be `negative`, `positive`, or `warning`.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "status",
"description": "The status of the input. Can be `success` or `error`.",
"type": "'succes' | 'error'"
},
{
"name": "size",
"description": "The size of the input. Default is `sm`.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "name",
"description": "The name of the input.",
"type": "string"
},
{
"name": "type",
"description": "The type of the input. Default is 'text'.",
"type": "'text' | 'number' | 'button' | 'color' | 'email' | 'hidden' | 'reset' | 'submit' | 'url' | 'password'| 'file' | 'time'"
},
{
"name": "disabled",
"description": "The disabled state of the input. Default is false.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the input. Default is false.",
"type": "boolean"
},
{
"name": "readonly",
"description": "The readonly state of the input. Default is false.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "The autofocus state of the input. Default is false.",
"type": "boolean"
},
{
"name": "autocapitalize",
"description": "The autocapitalize state of the input. Default is false.",
"type": "boolean"
},
{
"name": "minlength",
"description": "The minimum length of the input.",
"type": "number"
},
{
"name": "maxlength",
"description": "The maximum length of the input.",
"type": "number"
},
{
"name": "min",
"description": "The minimum value of the number input.",
"type": "number"
},
{
"name": "max",
"description": "The maximum value of the number input.",
"type": "number"
},
{
"name": "step",
"description": "The step value of the number input.",
"type": "number"
},
{
"name": "inputmode",
"description": "The inputmode of the input.",
"type": "string"
},
{
"name": "pattern",
"description": "The regex pattern of the input.",
"type": "string"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
}
]
}
},
{
"name": "dap-ds-label",
"description": "A label is a container for labels intended for general use. It contains a label text, description, and tooltip.\n---\n\n\n### **CSS Properties:**\n - **--dds-label-background** - The background color of the label container. Default is `var(--dds-background-neutral-subtle)`. _(default: undefined)_\n- **--dds-label-border-color** - The border color of the label container. Default is `var(--dds-border-neutral-subtle)`. _(default: undefined)_\n- **--dds-label-border-width** - The border width of the label container. Default is `var(--dds-border-width-base)`. _(default: undefined)_\n- **--dds-label-border-radius** - The border radius of the label container. Default is `var(--dds-radius-base)`. _(default: undefined)_\n- **--dds-label-padding** - The padding of the label container. Default is `var(--dds-spacing-400)`. _(default: undefined)_\n- **--dds-label-disabled-background** - The background color of the label container when disabled. Default is `var(--dds-background-neutral-disabled-inverted)`. _(default: undefined)_\n- **--dds-label-checked-border-color** - The border color of the label container when checked. Default is `var(--dds-background-brand-base-inverted)`. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main label container.\n- **label** - Tha main label container. dap-ds-form-label element.\n- **label-base** - The label text.\n- **label-required** - The required indicator of the label.\n- **label-optional** - The optional indicator of the label.\n- **tooltip** - The tooltip of the label. dap-ds-tooltip element.\n- **description** - The description of the label.",
"doc-url": "",
"attributes": [],
"events": [],
"js": {
"properties": [
{
"name": "label",
"description": "The label text",
"type": "string"
},
{
"name": "description",
"description": "The description of the label",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip text",
"type": "string"
},
{
"name": "size",
"description": "The size of the input. Default is `sm`.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the label.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "optional",
"description": "If the label is optional. Default value is `false`.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "Label of optional text",
"type": "string"
},
{
"name": "subtle",
"description": "Text weight of label. If true the label is subtle. Default value is `false`.",
"type": "boolean"
},
{
"name": "disabled",
"description": "The disabled state of the label. Default is `false`.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the label. Default is `false`.",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-link",
"description": "A link is a reference to a web resource.\n---\n\n\n### **Events:**\n - **dds-click** - Emitted when the link is clicked.\n\n### **Slots:**\n - _default_ - The text of the link.\n\n### **CSS Properties:**\n - **--dds-link-color** - The color of the link text _(default: undefined)_\n- **--dds-link-hover-color** - The color of the link text on hover _(default: undefined)_\n- **--dds-link-active-color** - The color of the link text when active _(default: undefined)_\n- **--dds-link-visited-color** - The color of the visited link text _(default: undefined)_\n- **--dds-link-font-size** - The font size of the link text _(default: undefined)_\n- **--dds-link-line-height** - The line height of the link text _(default: undefined)_\n- **--dds-link-font-weight** - The font weight of the link text _(default: undefined)_\n- **--dds-link-text-decoration** - The text decoration of the link _(default: undefined)_\n- **--dds-link-neutral-color** - The color of the neutral variant link _(default: undefined)_\n- **--dds-link-neutral-hover-color** - The hover color of the neutral variant link _(default: undefined)_\n- **--dds-link-neutral-active-color** - The active color of the neutral variant link _(default: undefined)_\n- **--dds-link-neutral-visited-color** - The visited color of the neutral variant link _(default: undefined)_\n- **--dds-link-brand-color** - The color of the brand variant link _(default: undefined)_\n- **--dds-link-brand-hover-color** - The hover color of the brand variant link _(default: undefined)_\n- **--dds-link-brand-active-color** - The active color of the brand variant link _(default: undefined)_\n- **--dds-link-brand-visited-color** - The visited color of the brand variant link _(default: undefined)_\n- **--dds-link-inverted-color** - The color of the inverted variant link _(default: undefined)_\n- **--dds-link-inverted-hover-color** - The hover color of the inverted variant link _(default: undefined)_\n- **--dds-link-inverted-active-color** - The active color of the inverted variant link _(default: undefined)_\n- **--dds-link-inverted-visited-color** - The visited color of the inverted variant link _(default: undefined)_\n- **--dds-link-warning-color** - The color of the warning variant link _(default: undefined)_\n- **--dds-link-warning-hover-color** - The hover color of the warning variant link _(default: undefined)_\n- **--dds-link-warning-active-color** - The active color of the warning variant link _(default: undefined)_\n- **--dds-link-warning-visited-color** - The visited color of the warning variant link _(default: undefined)_\n- **--dds-link-disabled-color** - The color of the disabled link _(default: undefined)_\n- **--dds-link-disabled-hover-color** - The hover color of the disabled link _(default: undefined)_\n- **--dds-link-disabled-active-color** - The active color of the disabled link _(default: undefined)_\n- **--dds-link-disabled-visited-color** - The visited color of the disabled link _(default: undefined)_\n- **--dds-link-lg-font-size** - The font size of the large link _(default: undefined)_\n- **--dds-link-lg-line-height** - The line height of the large link _(default: undefined)_\n- **--dds-link-md-font-size** - The font size of the medium link _(default: undefined)_\n- **--dds-link-md-line-height** - The line height of the medium link _(default: undefined)_\n- **--dds-link-sm-font-size** - The font size of the small link _(default: undefined)_\n- **--dds-link-sm-line-height** - The line height of the small link _(default: undefined)_\n- **--dds-link-xs-font-size** - The font size of the extra small link _(default: undefined)_\n- **--dds-link-xs-line-height** - The line height of the extra small link _(default: undefined)_\n- **--dds-link-normal-font-weight** - The font weight of the normal link _(default: undefined)_\n- **--dds-link-bold-font-weight** - The font weight of the bold link _(default: undefined)_\n- **--dds-link-no-underline-text-decoration** - The text decoration when underline is removed _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main link container.\n- **text** - The text of the link.",
"doc-url": "",
"attributes": [
{
"name": "size",
"description": "The size of the link",
"value": { "type": "'lg' | 'md' | 'sm' | 'xs'" }
},
{
"name": "variant",
"description": "The theme of the link",
"value": {
"type": "'neutral' | 'brand' | 'inverted' | 'warning'",
"default": "'brand'"
}
},
{
"name": "target",
"description": "The target of the link.",
"value": {
"type": "'_blank' | '_self' | '_parent' | '_top'",
"default": "'_self'"
}
},
{
"name": "bold",
"description": "Bold link style",
"value": { "type": "boolean" }
},
{
"name": "noUnderline",
"description": "Removes underline style",
"value": { "type": "boolean" }
},
{
"name": "href",
"description": "The href / URL of the link",
"value": { "type": "string", "default": "'#'" }
},
{
"name": "disabled",
"description": "Disabled state of the link",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "rel",
"description": "The rel of the link",
"value": { "type": "string", "default": "'noreferrer noopener'" }
},
{
"name": "download",
"description": "The download attribute of the link",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [{ "name": "", "description": "The text of the link." }],
"events": [
{
"name": "dds-click",
"type": "{ event: Event }",
"description": "Emitted when the link is clicked."
}
],
"js": {
"properties": [
{
"name": "size",
"description": "The size of the link",
"type": "'lg' | 'md' | 'sm' | 'xs'"
},
{
"name": "variant",
"description": "The theme of the link",
"type": "'neutral' | 'brand' | 'inverted' | 'warning'"
},
{
"name": "target",
"description": "The target of the link.",
"type": "'_blank' | '_self' | '_parent' | '_top'"
},
{
"name": "bold",
"description": "Bold link style",
"type": "boolean"
},
{
"name": "noUnderline",
"description": "Removes underline style",
"type": "boolean"
},
{
"name": "href",
"description": "The href / URL of the link",
"type": "string"
},
{
"name": "disabled",
"description": "Disabled state of the link",
"type": "boolean"
},
{
"name": "rel",
"description": "The rel of the link",
"type": "string"
},
{
"name": "download",
"description": "The download attribute of the link",
"type": "boolean"
}
],
"events": [
{
"name": "dds-click",
"type": "{ event: Event }",
"description": "Emitted when the link is clicked."
}
]
}
},
{
"name": "dap-ds-list-item",
"description": "A list\n---\n\n\n### **Slots:**\n - _default_ - The content of the list item.\n- **icon** - The icon of the list item.\n- **title** - The title of the list item.\n- **actions** - The actions of the list item.\n\n### **CSS Properties:**\n - **--dds-list-item-gap** - Gap between list item elements (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-list-item-content-gap** - Gap between content elements (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-list-item-horizontal-gap** - Gap for horizontal alignment (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-list-item-vertical-gap** - Gap for vertical alignment (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-list-item-icon-size** - Size of the icon (default: var(--dds-spacing-600)) _(default: undefined)_\n- **--dds-list-item-number-size** - Size of the number icon (default: 20px) _(default: undefined)_\n- **--dds-list-item-actions-gap** - Gap between action elements (default: var(--dds-spacing-400)) _(default: undefined)_\n- **--dds-list-item-actions-padding** - Padding for the actions container (default: var(--dds-spacing-100)) _(default: undefined)_\n- **--dds-list-item-background-base** - Background color for base shade (default: var(--dds-background-neutral-base)) _(default: undefined)_\n- **--dds-list-item-background-subtle** - Background color for subtle shade (default: var(--dds-background-neutral-subtle)) _(default: undefined)_\n- **--dds-list-item-background-medium** - Background color for medium shade (default: var(--dds-background-neutral-medium)) _(default: undefined)_\n- **--dds-list-item-background-strong** - Background color for strong shade (default: var(--dds-background-neutral-strong)) _(default: undefined)_\n- **--dds-list-item-icon-brand** - Color for brand icon (default: var(--dds-icon-brand-subtle)) _(default: undefined)_\n- **--dds-list-item-icon-neutral** - Color for neutral icon (default: var(--dds-icon-neutral-base)) _(default: undefined)_\n- **--dds-list-item-icon-positive** - Color for positive icon (default: var(--dds-icon-positive-subtle)) _(default: undefined)_\n- **--dds-list-item-icon-negative** - Color for negative icon (default: var(--dds-icon-negative-subtle)) _(default: undefined)_\n- **--dds-list-item-title-color** - Title text color (default: var(--dds-text-neutral-strong)) _(default: undefined)_\n- **--dds-list-item-description-color** - Description text color (default: var(--dds-text-neutral-base)) _(default: undefined)_\n- **--dds-list-item-number-text-color** - Number text color (default: var(--dds-text-neutral-inverted)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main list item container.\n- **icon** - The icon of the list item.\n- **title** - The title of the list item.\n- **description** - The description of the list item.\n- **container** - The container of the list item.\n- **list-item-base** - The base list item container.\n- **icon-container** - The container of the icon.\n- **title-container** - The container of the title.\n- **description-container** - The container of the description.\n- **actions-container** - The container of the actions.\n- **iteractive-indicator-container** - The container of the interactive indicator.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the list item.",
"value": {
"type": "'info' | 'pass' | 'fail' | 'notapplicable' | 'empty' | 'number'",
"default": "'info'"
}
},
{
"name": "shade",
"description": "The background strongness of the list item.",
"value": {
"type": "'none' | 'subtle' | 'base' | 'medium' | 'strong'",
"default": "'base'"
}
},
{
"name": "status",
"description": "The status of the list item.",
"value": {
"type": "'transparent' | 'brand' | 'neutral' | 'positive' | 'negative'",
"default": "'neutral'"
}
},
{
"name": "alignment",
"description": "The alignment of the list item.",
"value": {
"type": "'horizontal' | 'vertical'",
"default": "'horizontal'"
}
},
{
"name": "title",
"description": "The title of the list item.",
"value": { "type": "string" }
},
{
"name": "icon",
"description": "The icon of the list item. This is an icon name from the built in icons.",
"value": { "type": "string" }
},
{
"name": "number",
"description": "The number of the list item. Only used when variant is 'number'.",
"value": { "type": "number" }
},
{
"name": "interactive",
"description": "Whether the list item is interactive. Generates an anchor tag.",
"value": { "type": "boolean" }
},
{
"name": "target",
"description": "The link target of the list item when interactive.",
"value": {
"type": "'_blank' | '_self' | '_parent' | '_top'",
"default": "'_self'"
}
},
{
"name": "href",
"description": "The href of the list item when interactive",
"value": { "type": "string" }
},
{
"name": "rel",
"description": "The rel of the list item when interactive",
"value": { "type": "string", "default": "'noreferrer noopener'" }
},
{
"name": "noIcon",
"description": "Whether the list item has an icon.",
"value": { "type": "boolean" }
},
{
"name": "noPadding",
"description": "Whether the list item has no padding.",
"value": { "type": "boolean" }
},
{
"name": "renderAs",
"description": "The render as type of the list item, only applicable when interactive.",
"value": { "type": "'a' | 'button'", "default": "'a'" }
}
],
"slots": [
{ "name": "", "description": "The content of the list item." },
{ "name": "icon", "description": "The icon of the list item." },
{ "name": "title", "description": "The title of the list item." },
{
"name": "actions",
"description": "The actions of the list item."
}
],
"events": [],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the list item.",
"type": "'info' | 'pass' | 'fail' | 'notapplicable' | 'empty' | 'number'"
},
{
"name": "shade",
"description": "The background strongness of the list item.",
"type": "'none' | 'subtle' | 'base' | 'medium' | 'strong'"
},
{
"name": "status",
"description": "The status of the list item.",
"type": "'transparent' | 'brand' | 'neutral' | 'positive' | 'negative'"
},
{
"name": "alignment",
"description": "The alignment of the list item.",
"type": "'horizontal' | 'vertical'"
},
{
"name": "title",
"description": "The title of the list item.",
"type": "string"
},
{
"name": "icon",
"description": "The icon of the list item. This is an icon name from the built in icons.",
"type": "string"
},
{
"name": "number",
"description": "The number of the list item. Only used when variant is 'number'.",
"type": "number"
},
{
"name": "interactive",
"description": "Whether the list item is interactive. Generates an anchor tag.",
"type": "boolean"
},
{
"name": "target",
"description": "The link target of the list item when interactive.",
"type": "'_blank' | '_self' | '_parent' | '_top'"
},
{
"name": "href",
"description": "The href of the list item when interactive",
"type": "string"
},
{
"name": "rel",
"description": "The rel of the list item when interactive",
"type": "string"
},
{
"name": "noIcon",
"description": "Whether the list item has an icon.",
"type": "boolean"
},
{
"name": "noPadding",
"description": "Whether the list item has no padding.",
"type": "boolean"
},
{
"name": "renderAs",
"description": "The render as type of the list item, only applicable when interactive.",
"type": "'a' | 'button'"
}
],
"events": []
}
},
{
"name": "dap-ds-modal",
"description": "A modal is a container for modal content.\n---\n\n\n### **Events:**\n - **dds-before-open** - Fires before the modal opens.\n- **dds-opened** - Fires after the modal opens.\n- **dds-before-close** - Fires before the modal closes.\n- **dds-closed** - Fires after the modal closed.\n- **dds-close** - Fires when the modal is closes. You can prevent the modal from closing by calling `event.preventDefault()`.\n- **dds-ok** - Fires when the OK button is clicked. You can prevent the modal from closing by calling `event.preventDefault()`.\n- **dds-cancel** - Fires when the Cancel button is clicked. You can prevent the modal from closing by calling `event.preventDefault()`.\n\n### **Slots:**\n - _default_ - The content of the modal.\n- **title** - The title of the modal.\n- **description** - The description of the modal.\n- **footer** - The footer of the modal.\n\n### **CSS Properties:**\n - **--dds-modal-max-block-size** - Maximum height of the modal. Default: 80vh. _(default: undefined)_\n- **--dds-modal-max-inline-size** - Maximum width of the modal. Default: 600px. _(default: undefined)_\n- **--dds-modal-padding** - Padding inside the modal. Default: var(--dds-spacing-800). _(default: undefined)_\n- **--dds-modal-transform-amount** - Amount to transform for entrance animation. Default: 2rem. _(default: undefined)_\n- **--dds-modal-transition-speed** - Speed of transition animations. Default: var(--dds-transition-fast). _(default: undefined)_\n- **--dds-modal-transition-timing** - Timing function for transitions. Default: var(--dds-easing-ease-in-out). _(default: undefined)_\n- **--dds-modal-border-width** - Border width of the modal. Default: var(--dds-border-width-base). _(default: undefined)_\n- **--dds-modal-border-color** - Border color of the modal. Default: var(--dds-border-neutral-divider). _(default: undefined)_\n- **--dds-modal-border-radius** - Border radius of the modal. Default: var(--dds-radius-large, 16px). _(default: undefined)_\n- **--dds-modal-background** - Background color of the modal. Default: var(--dds-background-neutral-subtle). _(default: undefined)_\n- **--dds-modal-header-margin** - Margin below the header. Default: var(--dds-spacing-800). _(default: undefined)_\n- **--dds-modal-footer-margin** - Margin above the footer. Default: var(--dds-spacing-400). _(default: undefined)_\n- **--dds-modal-footer-gap** - Gap between footer elements. Default: var(--dds-spacing-400). _(default: undefined)_\n- **--dds-modal-close-margin** - Margin for the close button. Default: var(--dds-spacing-300). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main modal container.\n- **panel** - The panel of the modal.\n- **header** - The header of the modal.\n- **title** - The title of the modal.\n- **description** - The description of the modal.\n- **footer** - The footer of the modal.\n- **content** - The body of the modal.\n- **closebutton** - The close button of the modal.",
"doc-url": "",
"attributes": [],
"slots": [
{ "name": "", "description": "The content of the modal." },
{ "name": "title", "description": "The title of the modal." },
{
"name": "description",
"description": "The description of the modal."
},
{ "name": "footer", "description": "The footer of the modal." }
],
"events": [
{
"name": "dds-before-open",
"type": "{ void }",
"description": "Fires before the modal opens."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fires after the modal opens."
},
{
"name": "dds-before-close",
"type": "{ void }",
"description": "Fires before the modal closes."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fires after the modal closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fires when the modal is closes. You can prevent the modal from closing by calling `event.preventDefault()`."
},
{
"name": "dds-ok",
"type": "{ void }",
"description": "Fires when the OK button is clicked. You can prevent the modal from closing by calling `event.preventDefault()`."
},
{
"name": "dds-cancel",
"type": "{ void }",
"description": "Fires when the Cancel button is clicked. You can prevent the modal from closing by calling `event.preventDefault()`."
}
],
"js": {
"properties": [
{
"name": "bottomFooter",
"description": "Pushes the footer to bottom.",
"type": "boolean"
},
{
"name": "open",
"description": "The open state of the modal.",
"type": "boolean"
},
{
"name": "fullScreen",
"description": "The full screen version of the modal.",
"type": "boolean"
},
{
"name": "wideFooter",
"description": "Wide layout mode for footer.",
"type": "boolean"
},
{
"name": "closeOnEsc",
"description": "Whether the modal should close on pressing the escape key. Default is true.",
"type": "boolean"
},
{
"name": "closeOnOverlayClick",
"description": "Whether the modal should close on clicking the overlay. Default is true.",
"type": "boolean"
},
{
"name": "closeButton",
"description": "Whether the modal should have a close button. Default is true.",
"type": "string"
},
{
"name": "title",
"description": "The title of the modal.",
"type": "string"
},
{
"name": "description",
"description": "The description of the modal.",
"type": "string"
},
{
"name": "okButtonLabel",
"description": "The label of the OK button.",
"type": "string"
},
{
"name": "cancelButtonLabel",
"description": "The label of the Cancel button.",
"type": "string"
},
{
"name": "okButtonDisabled",
"description": "Whether the OK button should be disabled.",
"type": "boolean"
},
{
"name": "cancelButtonDisabled",
"description": "Whether the Cancel button should be disabled.",
"type": "boolean"
},
{
"name": "cancelButtonDanger",
"description": "Whether the Cancel button should be a danger button.",
"type": "boolean"
},
{
"name": "okButtonDanger",
"description": "Whether the OK button should be a danger button.",
"type": "boolean"
},
{
"name": "hideOkButton",
"description": "Whether the OK button should be hidden.",
"type": "boolean"
},
{
"name": "hideCancelButton",
"description": "Whether the Cancel button should be hidden.",
"type": "boolean"
},
{
"name": "footer",
"description": "Whether the modal should have a footer. Default is true.",
"type": "string"
},
{
"name": "header",
"description": "Whether the modal should have a header. Default is true.",
"type": "string"
},
{
"name": "useNativeFocus",
"description": "Whether the modal should use native focus. Default is false.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-before-open",
"type": "{ void }",
"description": "Fires before the modal opens."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fires after the modal opens."
},
{
"name": "dds-before-close",
"type": "{ void }",
"description": "Fires before the modal closes."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fires after the modal closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fires when the modal is closes. You can prevent the modal from closing by calling `event.preventDefault()`."
},
{
"name": "dds-ok",
"type": "{ void }",
"description": "Fires when the OK button is clicked. You can prevent the modal from closing by calling `event.preventDefault()`."
},
{
"name": "dds-cancel",
"type": "{ void }",
"description": "Fires when the Cancel button is clicked. You can prevent the modal from closing by calling `event.preventDefault()`."
}
]
}
},
{
"name": "dap-ds-navigation-menu-item",
"description": "A navigation menu item that can contain either a simple link or dropdown content.\n---\n\n\n### **Events:**\n - **dds-navigation-item-click** - Fired when a navigation item is clicked.\n- **dds-navigation-dropdown-open** - Fired when a navigation dropdown is opened.\n- **dds-opened** - Fired when the popup is opened.\n- **dds-closed** - Fired when the popup is closed.\n- **dds-close** - Fired when the popup should be closed.\n\n### **Slots:**\n - **trigger** - The trigger element (link, button, etc.) for this navigation item.\n- **title** - The title of the navigation item.\n- _default_ - The dropdown content (only used if trigger slot is provided).\n\n### **CSS Properties:**\n - **--dds-popup-z-index** - Z-index of the popup. _(default: undefined)_\n- **--dds-popup-padding** - Default padding of the popup. _(default: undefined)_\n- **--dds-popup-padding-xs** - Padding of the popup when size is xs. _(default: undefined)_\n- **--dds-popup-padding-lg** - Padding of the popup when size is lg. _(default: undefined)_\n- **--dds-popup-border-width** - Border width of the popup. _(default: undefined)_\n- **--dds-popup-border-radius** - Border radius of the popup. _(default: undefined)_\n- **--dds-popup-border-color** - Border color of the popup. _(default: undefined)_\n- **--dds-popup-background** - Background color of the popup. _(default: undefined)_\n- **--dds-popup-color** - Text color of the popup. _(default: undefined)_\n- **--dds-popup-arrow-size** - Size of the popup arrow. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The base part of the navigation item.\n- **trigger** - The trigger element part.\n- **content** - The dropdown content part.\n- **popup** - The main popup container.\n- **arrow** - The arrow of the popup.",
"doc-url": "",
"attributes": [
{
"name": "icon",
"description": "The name of the icon to display in the trigger.",
"value": { "type": "string" }
},
{
"name": "aria-labelledby",
"description": "The name of the element that labels the navigation dropdown.",
"value": { "type": "string" }
},
{
"name": "activeHref",
"description": "The href of the navigation item that is active.",
"value": { "type": "string" }
},
{
"name": "baseHref",
"description": "The href of the navigation item. If provided, the navigation item will be active if the href is a substring of the activeHref. It is useful for dropdowns that are not direct children of the navigation menu.",
"value": { "type": "string" }
},
{
"name": "exactHref",
"description": "Whether the navigation item should be active if the href is exactly the same as the activeHref.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "trigger",
"description": "The trigger element (link, button, etc.) for this navigation item."
},
{
"name": "title",
"description": "The title of the navigation item."
},
{
"name": "",
"description": "The dropdown content (only used if trigger slot is provided)."
}
],
"events": [
{
"name": "dds-navigation-item-click",
"type": "{ href: string, event: Event }",
"description": "Fired when a navigation item is clicked."
},
{
"name": "dds-navigation-dropdown-open",
"type": "{ item: DapDSNavigationMenuItem }",
"description": "Fired when a navigation dropdown is opened."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fired when the popup is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fired when the popup is closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the popup should be closed."
}
],
"js": {
"properties": [
{
"name": "icon",
"description": "The name of the icon to display in the trigger.",
"type": "string"
},
{
"name": "ariaLabelledBy",
"description": "The name of the element that labels the navigation dropdown.",
"type": "string"
},
{
"name": "activeHref",
"description": "The href of the navigation item that is active.",
"type": "string"
},
{
"name": "baseHref",
"description": "The href of the navigation item. If provided, the navigation item will be active if the href is a substring of the activeHref. It is useful for dropdowns that are not direct children of the navigation menu.",
"type": "string"
},
{
"name": "exactHref",
"description": "Whether the navigation item should be active if the href is exactly the same as the activeHref.",
"type": "boolean"
},
{
"name": "placement",
"description": "The placement of the popup.",
"type": "'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end'"
},
{
"name": "overflow",
"description": "Whether the popup should overflow.",
"type": "boolean"
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the popup.",
"type": "'absolute' | 'fixed'"
},
{
"name": "size",
"description": "The size of the popup.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "disabled",
"description": "The disabled state of the popup.",
"type": "boolean"
},
{
"name": "opened",
"description": "The open state of the popup.",
"type": "boolean"
},
{
"name": "offset",
"description": "The offset of the popup.",
"type": "number"
},
{
"name": "sync",
"description": "Whether the popup should sync its width with the trigger.",
"type": "boolean"
},
{
"name": "maxHeight",
"description": "The maximum height of the popup.",
"type": "number | 'auto'"
},
{
"name": "maxWidth",
"description": "The maximum width of the popup.",
"type": "number | 'auto'"
},
{
"name": "hasArrow",
"description": "Whether the popup has an arrow.",
"type": "boolean"
},
{
"name": "fullWidth",
"description": "Whether the popup should take full width of the screen.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-navigation-item-click",
"type": "{ href: string, event: Event }",
"description": "Fired when a navigation item is clicked."
},
{
"name": "dds-navigation-dropdown-open",
"type": "{ item: DapDSNavigationMenuItem }",
"description": "Fired when a navigation dropdown is opened."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fired when the popup is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fired when the popup is closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the popup should be closed."
}
]
}
},
{
"name": "dap-ds-navigation-menu",
"description": "A horizontal navigation menu container that can contain multiple navigation items.\n---\n\n\n### **Events:**\n - **dds-navigation-item-click** - Fired when a navigation item is clicked.\n\n### **Slots:**\n - _default_ - The navigation menu list and items.\n\n### **CSS Parts:**\n - **base** - The main navigation menu container.",
"doc-url": "",
"attributes": [
{
"name": "activeHref",
"description": "The currently active href for highlighting active navigation items.",
"value": { "type": "string" }
},
{
"name": "orientation",
"description": "The orientation of the navigation menu.",
"value": {
"type": "'horizontal' | 'vertical'",
"default": "'horizontal'"
}
},
{
"name": "fullWidth",
"description": "Whether the navigation menu should take full width of the screen.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{ "name": "", "description": "The navigation menu list and items." }
],
"events": [
{
"name": "dds-navigation-item-click",
"type": "{ href: string, event: Event }",
"description": "Fired when a navigation item is clicked."
}
],
"js": {
"properties": [
{
"name": "activeHref",
"description": "The currently active href for highlighting active navigation items.",
"type": "string"
},
{
"name": "orientation",
"description": "The orientation of the navigation menu.",
"type": "'horizontal' | 'vertical'"
},
{
"name": "fullWidth",
"description": "Whether the navigation menu should take full width of the screen.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-navigation-item-click",
"type": "{ href: string, event: Event }",
"description": "Fired when a navigation item is clicked."
}
]
}
},
{
"name": "dap-ds-number-input",
"description": "A number input component.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the input value changes.\n- **dds-input** - Fired when the input value changes.\n- **dds-keydown** - Fired when a key is pressed down.\n- **dds-blur** - Fired when the input loses focus.\n- **dds-focus** - Emitted when the input gains focus.\n\n### **Slots:**\n - **feedback-icon** - The custom icon of the feedback.\n\n### **CSS Properties:**\n - **--dds-input-height** - The height of the input. Default is var(--dds-spacing-1000). _(default: undefined)_\n- **--dds-input-padding** - The padding of the input. Default is var(--dds-spacing-300). _(default: undefined)_\n- **--dds-input-font-size** - The font size of the input. Default is var(--dds-font-base). _(default: undefined)_\n- **--dds-input-border-color** - The border color of the input. Default is var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-input-background-color** - The background color of the input. Default is var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-input-text-color** - The text color of the input. Default is var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-input-border-radius** - The border radius of the input. Default is var(--dds-radius-base). _(default: undefined)_\n- **--dds-input-border-width** - The border width of the input. Default is var(--dds-border-width-base). _(default: undefined)_\n- **--dds-input-disabled-background** - The background color of the disabled input. Default is var(--dds-fields-background-disabled). _(default: undefined)_\n- **--dds-input-disabled-text** - The text color of the disabled input. Default is var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-input-readonly-background** - The background color of the readonly input. Default is var(--dds-fields-background-read-only). _(default: undefined)_\n- **--dds-input-readonly-text** - The text color of the readonly input. Default is var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-input-success-border** - The border color of the success input. Default is var(--dds-border-positive-base). _(default: undefined)_\n- **--dds-input-error-border** - The border color of the error input. Default is var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-input-addon-background** - The background color of the input addon. Default is var(--dds-background-ui-neutral-enabled). _(default: undefined)_\n- **--dds-input-addon-success-background** - The background color of the success input addon. Default is var(--dds-background-ui-positive-enabled). _(default: undefined)_\n- **--dds-input-addon-error-background** - The background color of the error input addon. Default is var(--dds-background-ui-negative-enabled). _(default: undefined)_\n\n### **CSS Parts:**\n - **postfix** - The postfix of the input.\n- **decrement** - The decrement button of the input.\n- **increment** - The increment button of the input.",
"doc-url": "",
"attributes": [
{
"name": "thousandSeparator",
"description": "The thousand separator of the input.",
"value": { "type": "string", "default": "''" }
},
{
"name": "decimalSeparator",
"description": "The decimal separator of the input.",
"value": { "type": "string", "default": "','" }
},
{
"name": "decimalScale",
"description": "The decimal scale of the input.",
"value": { "type": "number" }
},
{
"name": "allowNegative",
"description": "The allow negative state of the input.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "allowDecimal",
"description": "The allow decimal state of the input.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "hideControls",
"description": "Hides the increment and decrement buttons.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "feedback-icon",
"description": "The custom icon of the feedback."
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
}
],
"js": {
"properties": [
{
"name": "thousandSeparator",
"description": "The thousand separator of the input.",
"type": "string"
},
{
"name": "decimalSeparator",
"description": "The decimal separator of the input.",
"type": "string"
},
{
"name": "decimalScale",
"description": "The decimal scale of the input.",
"type": "number"
},
{
"name": "allowNegative",
"description": "The allow negative state of the input.",
"type": "string"
},
{
"name": "allowDecimal",
"description": "The allow decimal state of the input.",
"type": "string"
},
{
"name": "hideControls",
"description": "Hides the increment and decrement buttons.",
"type": "boolean"
},
{ "name": "_thousandSeparator" },
{ "name": "manualValueSet", "type": "boolean" },
{
"name": "label",
"description": "The label of the input.",
"type": "string"
},
{
"name": "placeholder",
"description": "The placeholder of the input.",
"type": "string"
},
{
"name": "description",
"description": "The description of the input.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the input.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the input.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "status",
"description": "The status of the input. Can be `success` or `error`.",
"type": "'success' | 'error'"
},
{
"name": "size",
"description": "The size of the input. Default is `sm`. Can be `sm` or `lg`.",
"type": "'xs' | 'sm' | 'sm'"
},
{
"name": "name",
"description": "The name of the input.",
"type": "string"
},
{
"name": "value",
"description": "The value of the input.",
"type": "string"
},
{
"name": "disabled",
"description": "The disabled state of the input. Default is false.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the input. Default is false.",
"type": "boolean"
},
{
"name": "readonly",
"description": "The readonly state of the input. Default is false.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "The autofocus state of the input. Default is false.",
"type": "boolean"
},
{
"name": "min",
"description": "The minimum value of the number input.",
"type": "number"
},
{
"name": "max",
"description": "The maximum value of the number input.",
"type": "number"
},
{
"name": "step",
"description": "The step value of the number input.",
"type": "number"
},
{
"name": "feedback",
"description": "The feedback of the input.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the input. Can be `negative`, `positive`, or `warning`.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "loading",
"description": "The loading state of the input. Default is false.",
"type": "boolean"
},
{
"name": "optional",
"description": "The optional state of the input.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the input.",
"type": "string"
},
{
"name": "subtle",
"description": "The weight of the label. Default is `false`",
"type": "boolean"
},
{
"name": "disableEnter",
"description": "Disables the enter key from being used to submit the form.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
}
]
}
},
{
"name": "dap-ds-official-website-banner",
"description": "An official website banner is a banner that displays that the website is an official website.\n---\n\n\n### **Events:**\n - **dds-opened** - Event fired when the accordion is opened.\n- **dds-closed** - Event fired when the accordion is closed.\n\n### **Slots:**\n - **default** - The content of the accordion.\n- **heading** - The heading of the accordion.\n- **icon-opened** - The icon when the accordion is opened.\n- **icon-closed** - The icon when the accordion is closed.\n\n### **CSS Properties:**\n - **--dds-official-banner-background-color** - The background color of the official website banner. _(default: undefined)_\n- **--dds-official-banner-text-color** - The text color of the official website banner. _(default: undefined)_\n- **--dds-official-banner-heading-hover-color** - The heading hover color of the official website banner. _(default: undefined)_\n- **--dds-official-banner-border-radius** - The border radius of the official website banner. _(default: undefined)_\n- **--dds-official-banner-icon-color** - The icon color of the official website banner. _(default: undefined)_\n- **--dds-official-banner-icon-color-hover** - The icon hover color of the opener icon official website banner. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main accordion container.\n- **heading** - The heading of the accordion.\n- **button** - The button of the accordion.\n- **content** - The content of the accordion.\n- **content-container** - The container of the accordion content.\n- **icon-wrapper** - The icon wrapper of the accordion.\n- **open-icon** - The icon when the accordion is opened.\n- **open-icon-base** - The base of the icon when the accordion is opened.\n- **close-icon** - The icon when the accordion is closed.\n- **close-icon-base** - The base of the icon when the accordion is closed.",
"doc-url": "",
"attributes": [],
"slots": [
{
"name": "default",
"description": "The content of the accordion."
},
{
"name": "heading",
"description": "The heading of the accordion."
},
{
"name": "icon-opened",
"description": "The icon when the accordion is opened."
},
{
"name": "icon-closed",
"description": "The icon when the accordion is closed."
}
],
"events": [
{
"name": "dds-opened",
"type": "{ void }",
"description": "Event fired when the accordion is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Event fired when the accordion is closed."
}
],
"js": {
"properties": [
{
"name": "size",
"description": "The size of the official website banner. Default is `sm`.",
"type": "'sm' | 'lg'"
},
{
"name": "headingLevel",
"description": "The heading level of the accordion. Default is `4`.",
"type": "1 | 2 | 3 | 4 | 5 | 6"
},
{
"name": "opened",
"description": "Whether the accordion is opened. Default is `false`.",
"type": "boolean"
},
{
"name": "iconLocation",
"description": "The location of the icon. Default is `right`.",
"type": "'left' | 'right'"
},
{
"name": "variant",
"description": "The variant of the accordion.",
"type": "'default' | 'collapsed' | 'clean' | 'clean-collapsed'"
},
{
"name": "lastItem",
"description": "Whether the accordion is the last item.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-opened",
"type": "{ void }",
"description": "Event fired when the accordion is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Event fired when the accordion is closed."
}
]
}
},
{
"name": "dap-ds-notification-badge",
"description": "A notification badge component is a user interface element that visually indicates the presence of new information or updates, often displaying a numeric count of unread notifications, messages, or items requiring attention.\n---\n\n\n### **Slots:**\n - _default_ - The content of the notification badge.\n\n### **CSS Properties:**\n - **--dds-notification-badge-size** - Controls the overall size of the notification badge _(default: undefined)_\n- **--dds-notification-badge-min-width** - Minimum width of the notification badge _(default: undefined)_\n- **--dds-notification-badge-height** - Height of the notification badge _(default: undefined)_\n- **--dds-notification-badge-padding** - Padding inside the notification badge _(default: undefined)_\n- **--dds-notification-badge-border-radius** - Border radius of the notification badge _(default: undefined)_\n- **--dds-notification-badge-font-size** - Font size of the notification badge text _(default: undefined)_\n- **--dds-notification-badge-dot-size** - Size of the dot variant _(default: undefined)_\n- **--dds-notification-badge-color** - Text color of the notification badge _(default: undefined)_\n- **--dds-notification-badge-neutral-bg** - Background color for neutral type _(default: undefined)_\n- **--dds-notification-badge-brand-bg** - Background color for brand type _(default: undefined)_\n- **--dds-notification-badge-info-bg** - Background color for info type _(default: undefined)_\n- **--dds-notification-badge-positive-bg** - Background color for positive type _(default: undefined)_\n- **--dds-notification-badge-warning-bg** - Background color for warning type _(default: undefined)_\n- **--dds-notification-badge-negative-bg** - Background color for negative type _(default: undefined)_\n- **--dds-notification-badge-circular-offset-x** - Horizontal offset for circular positioning _(default: undefined)_\n- **--dds-notification-badge-circular-offset-y** - Vertical offset for circular positioning _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main container of the notification badge.\n- **noty** - The notification badge container.",
"doc-url": "",
"attributes": [
{
"name": "badgeContent",
"description": "The content of the badge, it can be a number or a string. Content tried to be parsed as a number, if it's not a number, it will be displayed as a string.",
"value": { "type": "string" }
},
{
"name": "visible",
"description": "This switch decides the visibility of the badge. This property overrides the badge content visibility. Use it for explicit control.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "showZero",
"description": "This switch decides whether to show a zero value or not.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "type",
"description": "The color scheme of the badge",
"value": {
"type": "'neutral' | 'brand' | 'info' | 'positive' | 'warning' | 'negative'",
"default": "'negative'"
}
},
{
"name": "variant",
"description": "The variant of the badge.",
"value": { "type": "'round' | 'dot'", "default": "'round'" }
},
{
"name": "max",
"description": "The cap value of badge content, if the badge content is greater than the max value, it will be displayed as `[number]+`. Zero means no cap.",
"value": { "type": "number", "default": "0" }
},
{
"name": "placement",
"description": "The position of the badge content around the slot content.",
"value": {
"type": "'top-start' | 'top-end' | 'bottom-start' | 'bottom-end'",
"default": "'top-end'"
}
},
{
"name": "circular-auto",
"description": "Whether to automatically detect circular elements and adjust positioning accordingly",
"value": { "type": "boolean", "default": "true" }
},
{
"name": "force-circular",
"description": "Override circular positioning detection - forces circular positioning calculation",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "",
"description": "The content of the notification badge."
}
],
"events": [],
"js": {
"properties": [
{
"name": "badgeContent",
"description": "The content of the badge, it can be a number or a string. Content tried to be parsed as a number, if it's not a number, it will be displayed as a string.",
"type": "string"
},
{
"name": "visible",
"description": "This switch decides the visibility of the badge. This property overrides the badge content visibility. Use it for explicit control.",
"type": "boolean"
},
{
"name": "showZero",
"description": "This switch decides whether to show a zero value or not.",
"type": "boolean"
},
{
"name": "type",
"description": "The color scheme of the badge",
"type": "'neutral' | 'brand' | 'info' | 'positive' | 'warning' | 'negative'"
},
{
"name": "variant",
"description": "The variant of the badge.",
"type": "'round' | 'dot'"
},
{
"name": "max",
"description": "The cap value of badge content, if the badge content is greater than the max value, it will be displayed as `[number]+`. Zero means no cap.",
"type": "number"
},
{
"name": "placement",
"description": "The position of the badge content around the slot content.",
"type": "'top-start' | 'top-end' | 'bottom-start' | 'bottom-end'"
},
{
"name": "circularAuto",
"description": "Whether to automatically detect circular elements and adjust positioning accordingly",
"type": "boolean"
},
{
"name": "forceCircular",
"description": "Override circular positioning detection - forces circular positioning calculation",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-option-item",
"description": "An option item is a selectable item in a list of options.\n---\n\n\n### **Slots:**\n - **prefix** - The prefix of the option item.\n- _default_ - The label of the option item.\n- **suffix** - The suffix of the option item.\n\n### **CSS Properties:**\n - **--dds-option-item-padding-vertical** - The vertical padding of the option item. _(default: undefined)_\n- **--dds-option-item-padding-horizontal** - The horizontal padding of the option item. _(default: undefined)_\n- **--dds-option-item-border-radius** - The border radius of the option item. _(default: undefined)_\n- **--dds-option-item-color** - The text color of the option item. _(default: undefined)_\n- **--dds-option-item-hover-bg** - The background color of the option item when hovered. _(default: undefined)_\n- **--dds-option-item-active-bg** - The background color of the option item when active. _(default: undefined)_\n- **--dds-option-item-disabled-color** - The text color of the option item when disabled. _(default: undefined)_\n- **--dds-option-item-high-contrast-border** - The border color of the option item in high contrast mode. _(default: undefined)_\n- **--dds-option-item-selected-font-weight** - The font weight of the option item when selected. _(default: undefined)_\n- **--dds-option-item-xs-font-size** - The font size of the option item in extra small size. _(default: undefined)_\n- **--dds-option-item-lg-font-size** - The font size of the option item in large size. _(default: undefined)_\n- **--dds-option-item-selected-icon-width** - The width of the selected icon. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main option item container.\n- **prefix** - The prefix of the option item.\n- **label** - The label of the option item.\n- **suffix** - The suffix of the option item.",
"doc-url": "",
"attributes": [
{
"name": "selected",
"description": "The selected state of the option item",
"value": { "type": "boolean | undefined" }
},
{
"name": "selectable",
"description": "Wheteher the item is selectable, whether it shows the selected icon",
"value": { "type": "boolean | undefined" }
},
{
"name": "value",
"description": "The value of the option item",
"value": { "type": "any | undefined" }
},
{
"name": "disabled",
"description": "The disabled state of the option item",
"value": { "type": "boolean | undefined" }
},
{
"name": "focused",
"description": "The focused state of the option item",
"value": { "type": "boolean | undefined" }
},
{
"name": "label",
"description": "The label of the option item, it can be a simplier version of an item",
"value": { "type": "string | undefined" }
}
],
"slots": [
{
"name": "prefix",
"description": "The prefix of the option item."
},
{ "name": "", "description": "The label of the option item." },
{
"name": "suffix",
"description": "The suffix of the option item."
}
],
"events": [],
"js": {
"properties": [
{
"name": "selected",
"description": "The selected state of the option item",
"type": "boolean | undefined"
},
{
"name": "selectable",
"description": "Wheteher the item is selectable, whether it shows the selected icon",
"type": "boolean | undefined"
},
{
"name": "value",
"description": "The value of the option item",
"type": "any | undefined"
},
{
"name": "disabled",
"description": "The disabled state of the option item",
"type": "boolean | undefined"
},
{
"name": "focused",
"description": "The focused state of the option item",
"type": "boolean | undefined"
},
{
"name": "label",
"description": "The label of the option item, it can be a simplier version of an item",
"type": "string | undefined"
},
{ "name": "optionText", "type": "string" }
],
"events": []
}
},
{
"name": "dap-ds-option-list",
"description": "An option list is a list of selectable options.\n---\n\n\n### **Events:**\n - **dds-cancel** - Fired when the escape key is pressed.\n- **dds-option-change** - Fired when the option list value changes.\n- **dds-keydown** - Fired when a key is pressed down.\n- **dds-list-changed** - Fired when the available options list changes.\n\n### **Slots:**\n - _default_ - The default slot for the options.\n\n### **CSS Parts:**\n - **base** - The main option list container.",
"doc-url": "",
"attributes": [
{
"name": "filterText",
"description": "The filter text of the option list",
"value": { "type": "string", "default": "''" }
},
{
"name": "value",
"description": "The value of the option list",
"value": { "type": "string | undefined" }
},
{
"name": "focused",
"description": "The focused state of the option list.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "search",
"description": "Whether the option list is searchable",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "searchMode",
"description": "The search mode of the option list. Default is `none`",
"value": {
"type": "'none' | 'typehead' | 'autocomplete' | 'manual'",
"default": "'none'"
}
},
{
"name": "selectable",
"description": "Whether the option list items are selectable, whether it shows the selected icon",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{ "name": "", "description": "The default slot for the options." }
],
"events": [
{
"name": "dds-cancel",
"type": "{ void }",
"description": "Fired when the escape key is pressed."
},
{
"name": "dds-option-change",
"type": "{ option: DapDSOptionItem, value: string, index: number, text: string }",
"description": "Fired when the option list value changes."
},
{
"name": "dds-keydown",
"type": "{ void }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-list-changed",
"type": "{ elements: DapDSOptionItem[] }",
"description": "Fired when the available options list changes."
}
],
"js": {
"properties": [
{
"name": "filterText",
"description": "The filter text of the option list",
"type": "string"
},
{
"name": "value",
"description": "The value of the option list",
"type": "string | undefined"
},
{
"name": "focused",
"description": "The focused state of the option list.",
"type": "boolean"
},
{
"name": "search",
"description": "Whether the option list is searchable",
"type": "boolean"
},
{
"name": "searchMode",
"description": "The search mode of the option list. Default is `none`",
"type": "'none' | 'typehead' | 'autocomplete' | 'manual'"
},
{
"name": "selectable",
"description": "Whether the option list items are selectable, whether it shows the selected icon",
"type": "boolean"
},
{ "name": "queryTimeout", "type": "number | undefined" },
{ "name": "queryString", "type": "string" },
{ "name": "firstLoad", "type": "boolean" },
{ "name": "selectedIndex", "type": "number" },
{ "name": "isAutoComplete" },
{ "name": "getSearchString" },
{ "name": "buildQueryString" }
],
"events": [
{
"name": "dds-cancel",
"type": "{ void }",
"description": "Fired when the escape key is pressed."
},
{
"name": "dds-option-change",
"type": "{ option: DapDSOptionItem, value: string, index: number, text: string }",
"description": "Fired when the option list value changes."
},
{
"name": "dds-keydown",
"type": "{ void }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-list-changed",
"type": "{ elements: DapDSOptionItem[] }",
"description": "Fired when the available options list changes."
}
]
}
},
{
"name": "dap-ds-overlay",
"description": "An overlay is a container for overlay content.\n---\n\n\n### **CSS Properties:**\n - **--dds-overlay-z-index** - Controls the z-index of the overlay (default: 1) _(default: undefined)_\n- **--dds-overlay-background-color** - Controls the background color of the overlay (default: var(--dds-black-10)) _(default: undefined)_\n- **--dds-overlay-opacity-closed** - Controls the opacity when overlay is closed (default: 0) _(default: undefined)_\n- **--dds-overlay-opacity-open** - Controls the opacity when overlay is open (default: 1) _(default: undefined)_\n\n### **CSS Parts:**\n - **overlay** - The overlay element",
"doc-url": "",
"attributes": [
{
"name": "open",
"description": "The open state of the overlay.",
"value": { "type": "boolean | undefined" }
}
],
"events": [],
"js": {
"properties": [
{
"name": "open",
"description": "The open state of the overlay.",
"type": "boolean | undefined"
}
],
"events": []
}
},
{
"name": "dap-ds-pager",
"description": "A pager is a component that displays pagination controls.\n---\n\n\n### **Events:**\n - **dds-pagination-change** - Event fired when the pagination changes\n\n### **CSS Properties:**\n - **--dds-pager-spacing-vertical** - The vertical spacing of the pager. _(default: undefined)_\n- **--dds-pager-spacing-horizontal** - The horizontal spacing of the pager. _(default: undefined)_\n- **--dds-pager-button-padding** - The padding of the pager buttons. _(default: undefined)_\n- **--dds-pager-button-border-width** - The border width of the pager buttons. _(default: undefined)_\n- **--dds-pager-button-border-color** - The border color of the pager buttons. _(default: undefined)_\n- **--dds-pager-button-border-radius** - The border radius of the pager buttons. _(default: undefined)_\n- **--dds-pager-button-background** - The background color of the pager buttons. _(default: undefined)_\n- **--dds-pager-button-font-size** - The font size of the pager buttons. _(default: undefined)_\n- **--dds-pager-button-font-weight** - The font weight of the pager buttons. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main pager container.\n- **first** - The first page button.\n- **previous** - The previous page button.\n- **next** - The next page button.\n- **last** - The last page button.",
"doc-url": "",
"attributes": [
{
"name": "manualPagination",
"description": "Enable manual pagination. If true, the component will not automatically update the page index.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "pageIndex",
"description": "The current page index.",
"value": { "type": "number", "default": "0" }
},
{
"name": "pageSize",
"description": "The number of items per page.",
"value": { "type": "number", "default": "10" }
},
{
"name": "totalRows",
"description": "The total number of rows.",
"value": { "type": "number", "default": "0" }
},
{
"name": "pageSizeOptions",
"description": "Available page size options",
"value": { "type": "array", "default": "[10, 25, 50, 100]" }
},
{
"name": "showPageSizeOptions",
"description": "Show the page size options.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showPageIndex",
"description": "Show the page index.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showPageCount",
"description": "Show the page count.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showFirstButton",
"description": "Show the first button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showPreviousButton",
"description": "Show the previous button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showNextButton",
"description": "Show the next button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "showLastButton",
"description": "Show the last button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "firstButtonLabel",
"description": "The first button label.",
"value": { "type": "string" }
},
{
"name": "previousButtonLabel",
"description": "The previous button label.",
"value": { "type": "string" }
},
{
"name": "nextButtonLabel",
"description": "The next button label.",
"value": { "type": "string" }
},
{
"name": "lastButtonLabel",
"description": "The last button label.",
"value": { "type": "string" }
}
],
"events": [
{
"name": "dds-pagination-change",
"type": "{ action: string, pagination: { pageIndex: number, pageSize: number } }",
"description": "Event fired when the pagination changes"
}
],
"js": {
"properties": [
{
"name": "manualPagination",
"description": "Enable manual pagination. If true, the component will not automatically update the page index.",
"type": "boolean"
},
{
"name": "pageIndex",
"description": "The current page index.",
"type": "number"
},
{
"name": "pageSize",
"description": "The number of items per page.",
"type": "number"
},
{
"name": "totalRows",
"description": "The total number of rows.",
"type": "number"
},
{
"name": "pageSizeOptions",
"description": "Available page size options",
"type": "array"
},
{
"name": "showPageSizeOptions",
"description": "Show the page size options.",
"type": "string"
},
{
"name": "showPageIndex",
"description": "Show the page index.",
"type": "string"
},
{
"name": "showPageCount",
"description": "Show the page count.",
"type": "string"
},
{
"name": "showFirstButton",
"description": "Show the first button.",
"type": "string"
},
{
"name": "showPreviousButton",
"description": "Show the previous button.",
"type": "string"
},
{
"name": "showNextButton",
"description": "Show the next button.",
"type": "string"
},
{
"name": "showLastButton",
"description": "Show the last button.",
"type": "string"
},
{
"name": "firstButtonLabel",
"description": "The first button label.",
"type": "string"
},
{
"name": "previousButtonLabel",
"description": "The previous button label.",
"type": "string"
},
{
"name": "nextButtonLabel",
"description": "The next button label.",
"type": "string"
},
{
"name": "lastButtonLabel",
"description": "The last button label.",
"type": "string"
},
{
"name": "pageStateText",
"description": "The function to determine the pager text",
"type": "Function"
}
],
"events": [
{
"name": "dds-pagination-change",
"type": "{ action: string, pagination: { pageIndex: number, pageSize: number } }",
"description": "Event fired when the pagination changes"
}
]
}
},
{
"name": "dap-ds-password-input",
"description": "A password input a field for entering a password.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the input value changes.\n- **dds-input** - Fired when the input value changes.\n- **dds-keydown** - Fired when a key is pressed down.\n- **dds-blur** - Fired when the input loses focus.\n- **dds-focus** - Emitted when the input gains focus.\n\n### **CSS Properties:**\n - **--dds-input-height** - The height of the input. Default is var(--dds-spacing-1000). _(default: undefined)_\n- **--dds-input-padding** - The padding of the input. Default is var(--dds-spacing-300). _(default: undefined)_\n- **--dds-input-font-size** - The font size of the input. Default is var(--dds-font-base). _(default: undefined)_\n- **--dds-input-border-color** - The border color of the input. Default is var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-input-background-color** - The background color of the input. Default is var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-input-text-color** - The text color of the input. Default is var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-input-border-radius** - The border radius of the input. Default is var(--dds-radius-base). _(default: undefined)_\n- **--dds-input-border-width** - The border width of the input. Default is var(--dds-border-width-base). _(default: undefined)_\n- **--dds-input-disabled-background** - The background color of the disabled input. Default is var(--dds-fields-background-disabled). _(default: undefined)_\n- **--dds-input-disabled-text** - The text color of the disabled input. Default is var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-input-readonly-background** - The background color of the readonly input. Default is var(--dds-fields-background-read-only). _(default: undefined)_\n- **--dds-input-readonly-text** - The text color of the readonly input. Default is var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-input-success-border** - The border color of the success input. Default is var(--dds-border-positive-base). _(default: undefined)_\n- **--dds-input-error-border** - The border color of the error input. Default is var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-input-addon-background** - The background color of the input addon. Default is var(--dds-background-ui-neutral-enabled). _(default: undefined)_\n- **--dds-input-addon-success-background** - The background color of the success input addon. Default is var(--dds-background-ui-positive-enabled). _(default: undefined)_\n- **--dds-input-addon-error-background** - The background color of the error input addon. Default is var(--dds-background-ui-negative-enabled). _(default: undefined)_\n\n### **CSS Parts:**\n - **postfix** - The postfix of the password input.\n- **password-input** - The password input.\n- **password-input--visible** - The visible password input.\n- **icon** - The icon of the password input.\n- **icon-base** - The base of the icon.",
"doc-url": "",
"attributes": [],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
}
],
"js": {
"properties": [
{ "name": "passwordVisibile", "type": "boolean" },
{ "name": "type", "type": "string" },
{
"name": "label",
"description": "The label of the password input.",
"type": "string"
},
{
"name": "placeholder",
"description": "The placeholder of the password input.",
"type": "string"
},
{
"name": "description",
"description": "The description of the password input.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the password input.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the input.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "status",
"description": "The status of the password input. Can be `success` or `error`.",
"type": "string"
},
{
"name": "size",
"description": "The size of the password input. Default is `sm`.",
"type": "'xs' | 'sm' | 'sm'"
},
{
"name": "name",
"description": "The name of the password input.",
"type": "string"
},
{
"name": "value",
"description": "The value of the password input.",
"type": "string"
},
{
"name": "disabled",
"description": "The disabled state of the password input. Default is false.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the password input. Default is false.",
"type": "boolean"
},
{
"name": "readonly",
"description": "The readonly state of the password input. Default is false.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "The autofocus state of the password input. Default is false.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback of the input.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the input. Can be `negative`, `positive`, or `warning`.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "loading",
"description": "The loading state of the password input. Default is false.",
"type": "boolean"
},
{
"name": "optional",
"description": "The optional state of the password input.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the password input.",
"type": "string"
},
{
"name": "subtle",
"description": "The weight of the label. Default is `false`",
"type": "boolean"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
}
]
}
},
{
"name": "dap-ds-popup",
"description": "A popup is a container for popup content.\n---\n\n\n### **Events:**\n - **dds-opened** - Fired when the popup is opened.\n- **dds-closed** - Fired when the popup is closed.\n- **dds-close** - Fired when the popup should be closed.\n\n### **Slots:**\n - **trigger** - The trigger of the popup.\n- _default_ - The content of the popup.\n\n### **CSS Properties:**\n - **--dds-popup-z-index** - Z-index of the popup. _(default: undefined)_\n- **--dds-popup-padding** - Default padding of the popup. _(default: undefined)_\n- **--dds-popup-padding-xs** - Padding of the popup when size is xs. _(default: undefined)_\n- **--dds-popup-padding-lg** - Padding of the popup when size is lg. _(default: undefined)_\n- **--dds-popup-border-width** - Border width of the popup. _(default: undefined)_\n- **--dds-popup-border-radius** - Border radius of the popup. _(default: undefined)_\n- **--dds-popup-border-color** - Border color of the popup. _(default: undefined)_\n- **--dds-popup-background** - Background color of the popup. _(default: undefined)_\n- **--dds-popup-color** - Text color of the popup. _(default: undefined)_\n- **--dds-popup-arrow-size** - Size of the popup arrow. _(default: undefined)_\n\n### **CSS Parts:**\n - **popup** - The main popup container.\n- **arrow** - The arrow of the popup.",
"doc-url": "",
"attributes": [],
"slots": [
{ "name": "trigger", "description": "The trigger of the popup." },
{ "name": "", "description": "The content of the popup." }
],
"events": [
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fired when the popup is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fired when the popup is closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the popup should be closed."
}
],
"js": {
"properties": [
{
"name": "size",
"description": "The size of the popup.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "disabled",
"description": "The disabled state of the popup.",
"type": "boolean"
},
{
"name": "opened",
"description": "The open state of the popup.",
"type": "boolean"
},
{
"name": "placement",
"description": "The placement of the popup.",
"type": "'top' | 'right' | 'bottom' | 'left' | 'top-start' | 'top-end' | 'bottom-start' | 'bottom-end' | 'left-start' | 'left-end' | 'right-start' | 'right-end'"
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the popup.",
"type": "'absolute' | 'fixed'"
},
{
"name": "offset",
"description": "The offset of the popup.",
"type": "number"
},
{
"name": "sync",
"description": "Whether the popup should sync its width with the trigger.",
"type": "boolean"
},
{
"name": "maxHeight",
"description": "The maximum height of the popup.",
"type": "number | 'auto'"
},
{
"name": "maxWidth",
"description": "The maximum width of the popup.",
"type": "number | 'auto'"
},
{
"name": "hasArrow",
"description": "Whether the popup has an arrow.",
"type": "boolean"
},
{
"name": "overflow",
"description": "Whether the popup should overflow.",
"type": "boolean"
},
{
"name": "fullWidth",
"description": "Whether the popup should take full width of the screen.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fired when the popup is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fired when the popup is closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fired when the popup should be closed."
}
]
}
},
{
"name": "dap-ds-radio-button",
"description": "A radio button is a graphical control element that allows the user to choose only one of a predefined set of mutually exclusive options.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the radio button is checked.\n- **dds-blur** - Emitted when the radio button loses focus.\n- **dds-focus** - Emitted when the radio button gains focus.\n- **dds-input** - Emitted when the radio button receives input.\n\n### **Methods:**\n - **focus(): _void_** - Programmatically focuses the radio button input element.\n- **blur(): _void_** - Programmatically blurs the radio button input element.\n\n### **CSS Properties:**\n - **--dds-radio-size** - Sets the size of the radio button. Default: var(--dds-spacing-600) _(default: undefined)_\n- **--dds-radio-border-width** - Sets the border width of the radio button. Default: var(--dds-border-width-large) _(default: undefined)_\n- **--dds-radio-border-radius** - Sets the border radius of the radio button. Default: var(--dds-radius-rounded) _(default: undefined)_\n- **--dds-radio-border-color** - Sets the border color of the radio button. Default: var(--dds-border-neutral-base) _(default: undefined)_\n- **--dds-radio-background-color** - Sets the background color of the radio button. Default: var(--dds-background-neutral-base) _(default: undefined)_\n- **--dds-radio-hover-border-color** - Sets the border color of the radio button on hover. Default: var(--dds-border-neutral-medium) _(default: undefined)_\n- **--dds-radio-hover-background-color** - Sets the background color of the radio button on hover. Default: var(--dds-background-neutral-medium) _(default: undefined)_\n- **--dds-radio-active-border-color** - Sets the border color of the radio button when active. Default: var(--dds-border-neutral-strong) _(default: undefined)_\n- **--dds-radio-active-background-color** - Sets the background color of the radio button when active. Default: var(--dds-background-neutral-strong) _(default: undefined)_\n- **--dds-radio-checked-background-color** - Sets the background color of the checked radio button. Default: var(--dds-background-brand-base-inverted) _(default: undefined)_\n- **--dds-radio-checked-hover-background-color** - Sets the background color of the checked radio button on hover. Default: var(--dds-background-brand-medium-inverted) _(default: undefined)_\n- **--dds-radio-checked-active-background-color** - Sets the background color of the checked radio button when active. Default: var(--dds-background-brand-strong-inverted) _(default: undefined)_\n- **--dds-radio-disabled-background-color** - Sets the background color of the disabled radio button. Default: var(--dds-background-neutral-disabled) _(default: undefined)_\n- **--dds-radio-icon-background-color** - Sets the background color of the radio button icon. Default: var(--dds-transparent-white-strong-static) _(default: undefined)_\n- **--dds-radio-disabled-icon-background-color** - Sets the background color of the disabled radio button icon. Default: var(--dds-background-neutral-stronger) _(default: undefined)_\n- **--dds-radio-invalid-border-color** - Sets the border color of the invalid radio button. Default: var(--dds-border-negative-base) _(default: undefined)_\n- **--dds-radio-invalid-background-color** - Sets the background color of the invalid radio button. Default: var(--dds-background-negative-base) _(default: undefined)_\n- **--dds-radio-invalid-hover-border-color** - Sets the border color of the invalid radio button on hover. Default: var(--dds-border-negative-medium) _(default: undefined)_\n- **--dds-radio-invalid-hover-background-color** - Sets the background color of the invalid radio button on hover. Default: var(--dds-background-negative-medium) _(default: undefined)_\n- **--dds-radio-invalid-active-border-color** - Sets the border color of the invalid radio button when active. Default: var(--dds-border-negative-strong) _(default: undefined)_\n- **--dds-radio-invalid-active-background-color** - Sets the background color of the invalid radio button when active. Default: var(--dds-background-negative-strong) _(default: undefined)_\n- **--dds-radio-invalid-checked-background-color** - Sets the background color of the invalid checked radio button. Default: var(--dds-background-negative-base-inverted) _(default: undefined)_\n- **--dds-radio-invalid-checked-hover-background-color** - Sets the background color of the invalid checked radio button on hover. Default: var(--dds-background-negative-medium-inverted) _(default: undefined)_\n- **--dds-radio-invalid-checked-active-background-color** - Sets the background color of the invalid checked radio button when active. Default: var(--dds-background-negative-strong-inverted) _(default: undefined)_\n- **--dds-radio-icon-size** - Sets the size of the radio button icon. Default: var(--dds-spacing-300) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main radio button container.\n- **wrapper** - The wrapper of the radio button.\n- **base-label** - The main label container.\n- **label** - The label of the radio button.\n- **input** - The native input of the radio button.\n- **control** - The control of the radio button.\n- **label-container** - The label container of the radio button.\n- **description** - The description of the radio button.",
"doc-url": "",
"attributes": [
{
"name": "focusable",
"description": "Whether the radio button is focusable.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "preventDefault",
"description": "Whether the radio button should prevent the default action.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "border",
"description": "This sets up a border around the radio button, when true.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "type",
"description": "The type of the radio button.",
"value": {
"type": "'normal' | 'background'",
"default": "'normal'"
}
}
],
"events": [
{
"name": "dds-change",
"type": "{ checked: boolean, value: string, disabled: boolean, type: 'radio' }",
"description": "Fired when the radio button is checked."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the radio button loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the radio button gains focus."
},
{
"name": "dds-input",
"type": "{ checked: boolean, value: string, disabled: boolean }",
"description": "Emitted when the radio button receives input."
}
],
"js": {
"properties": [
{
"name": "focusable",
"description": "Whether the radio button is focusable.",
"type": "boolean"
},
{
"name": "preventDefault",
"description": "Whether the radio button should prevent the default action.",
"type": "boolean"
},
{
"name": "border",
"description": "This sets up a border around the radio button, when true.",
"type": "boolean"
},
{
"name": "type",
"description": "The type of the radio button.",
"type": "'normal' | 'background'"
},
{ "name": "focusElement", "type": "HTMLInputElement" },
{
"name": "name",
"description": "The name of the radio button.",
"type": "string"
},
{
"name": "value",
"description": "The value of the radio button.",
"type": "string"
},
{
"name": "checked",
"description": "Whether the radio button is checked.",
"type": "boolean"
},
{
"name": "label",
"description": "The label of the radio button.",
"type": "string"
},
{
"name": "description",
"description": "The description of the radio button.",
"type": "string"
},
{
"name": "disabled",
"description": "Whether the radio button is disabled.",
"type": "boolean"
},
{
"name": "required",
"description": "Whether the radio button is required.",
"type": "boolean"
},
{
"name": "size",
"description": "The size of the radio button.",
"type": "'xs' | 'sm' | 'md' | 'lg'"
},
{
"name": "labelPlacement",
"description": "The placement of the label.",
"type": "'left' | 'right'"
},
{
"name": "descriptionPlacement",
"description": "The placement of the description.",
"type": "'top' | 'bottom'"
},
{
"name": "subtle",
"description": "The weight of the label.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback of the radio button.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the radio button.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "invalid",
"description": "The invalid state of the radio button.",
"type": "boolean"
},
{
"name": "optional",
"description": "The optional state of the radio button.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the radio button.",
"type": "string"
}
],
"events": [
{
"name": "dds-change",
"type": "{ checked: boolean, value: string, disabled: boolean, type: 'radio' }",
"description": "Fired when the radio button is checked."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the radio button loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the radio button gains focus."
},
{
"name": "dds-input",
"type": "{ checked: boolean, value: string, disabled: boolean }",
"description": "Emitted when the radio button receives input."
}
]
}
},
{
"name": "dap-ds-rating",
"description": "Rating is a component that allows users to rate a product or service.\n---\n\n\n### **Events:**\n - **dds-change** - Event fired when the rating value changes.\n\n### **Methods:**\n - **_announceRating()** - Announce the current rating to screen readers\n\n### **CSS Parts:**\n - **base** - The main rating container.\n- **star** - The star element.\n- **stars-container** - The container of the stars.\n- **icon** - The icon of the star.",
"doc-url": "",
"attributes": [
{
"name": "label",
"description": "The label of the rating",
"value": { "type": "string" }
},
{
"name": "max",
"description": "The maximum number of stars",
"value": { "type": "number", "default": "5" }
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: number }",
"description": "Event fired when the rating value changes."
}
],
"js": {
"properties": [
{
"name": "label",
"description": "The label of the rating",
"type": "string"
},
{
"name": "max",
"description": "The maximum number of stars",
"type": "number"
},
{ "name": "_handleContainerFocus" },
{ "name": "_handleContainerBlur" },
{ "name": "_handleContainerKeyDown" },
{
"name": "_handleKeyDown",
"description": "Handle keyboard events for the entire component\nThis is a backup to catch keyboard events if they bubble up"
},
{ "name": "value", "type": "number" }
],
"events": [
{
"name": "dds-change",
"type": "{ value: number }",
"description": "Event fired when the rating value changes."
}
]
}
},
{
"name": "dap-ds-scroll-area",
"description": "A component that provides a customizable scrollable area with a custom scrollbar.\n---\n\n\n### **Slots:**\n - _default_ - The content to be scrolled\n\n### **CSS Properties:**\n - **--dds-scroll-area-radius** - The border radius of the scroll area and its elements (default: var(--dds-radius-base)) _(default: undefined)_\n- **--dds-scroll-area-background** - The background color of the scroll area (default: var(--dds-background-neutral-base)) _(default: undefined)_\n- **--dds-scroll-area-scrollbar-background** - The background color of the scrollbar (default: var(--dds-background-neutral-subtle)) _(default: undefined)_\n- **--dds-scroll-area-thumb-background** - The background color of the scrollbar thumb (default: var(--dds-background-neutral-interactive)) _(default: undefined)_\n- **--dds-scroll-area-thumb-hover-background** - The background color of the scrollbar thumb on hover (default: var(--dds-background-neutral-interactive-hover)) _(default: undefined)_\n- **--dds-scroll-area-thumb-active-background** - The background color of the scrollbar thumb when active (default: var(--dds-background-neutral-interactive-active)) _(default: undefined)_\n- **--dds-scroll-area-transition** - The transition timing for scrollbar interactions (default: var(--dds-transition-fast) var(--dds-easing-ease-out)) _(default: undefined)_\n- **--dds-scroll-area-scrollbar-size** - The width/height of the scrollbar (default: 10px) _(default: undefined)_\n\n### **CSS Parts:**\n - **viewport** - The viewport element that contains the scrollable content\n- **scrollbar** - The scrollbar container\n- **corner** - The corner between vertical and horizontal scrollbars",
"doc-url": "",
"attributes": [
{
"name": "orientation",
"description": "The orientation of the scrollbar.",
"value": {
"type": "'vertical' | 'horizontal' | 'both'",
"default": "'vertical'"
}
}
],
"slots": [
{ "name": "", "description": "The content to be scrolled" }
],
"events": [],
"js": {
"properties": [
{
"name": "orientation",
"description": "The orientation of the scrollbar.",
"type": "'vertical' | 'horizontal' | 'both'"
}
],
"events": []
}
},
{
"name": "dap-ds-search",
"description": "A select is a form element that allows the user to select one option from a set.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the search value changes.\n- **dds-blur** - Emitted when the search loses focus.\n- **dds-focus** - Emitted when the search gains focus.\n- **dds-clear** - Emitted when the search is cleared.\n- **dds-search** - Emitted when the search input value changes.\n- **dds-input** - Emitted when typing happens in the search input.\n\n### **Slots:**\n - _default_ - The default slot for the options.\n\n### **CSS Properties:**\n - **--dds-combobox-padding-xs** - The padding for extra small size. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-padding-sm** - The padding for small size. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-padding-lg** - The padding for large size. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-padding-horizontal** - The horizontal padding. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-padding-vertical** - The vertical padding. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-gap** - The gap between elements. Defaults to var(--dds-spacing-100). _(default: undefined)_\n- **--dds-combobox-icon-gap** - The gap between icons. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-action-gap** - The gap between action elements. Defaults to var(--dds-spacing-200). _(default: undefined)_\n- **--dds-combobox-action-padding** - The padding for action elements. Defaults to var(--dds-spacing-300). _(default: undefined)_\n- **--dds-combobox-clear-icon-width** - The width of the clear icon. Defaults to var(--dds-spacing-800). _(default: undefined)_\n- **--dds-combobox-dropdown-icon-right** - The right position of the dropdown icon. Defaults to var(--dds-spacing-600). _(default: undefined)_\n- **--dds-combobox-min-width** - The minimum width of the combobox. Defaults to 7.5rem. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main search container.\n- **trigger** - The trigger button of the search.\n- **label** - The label of the search.\n- **description** - The description of the search.\n- **feedback** - The feedback of the search.\n- **tooltip** - The tooltip of the search.\n- **option-list** - The option list of the search.",
"doc-url": "",
"attributes": [],
"slots": [
{ "name": "", "description": "The default slot for the options." }
],
"events": [
{
"name": "dds-change",
"description": "Fired when the search value changes."
},
{
"name": "dds-blur",
"description": "Emitted when the search loses focus."
},
{
"name": "dds-focus",
"description": "Emitted when the search gains focus."
},
{
"name": "dds-clear",
"description": "Emitted when the search is cleared."
},
{
"name": "dds-search",
"description": "Emitted when the search input value changes."
},
{
"name": "dds-input",
"description": "Emitted when typing happens in the search input."
}
],
"js": {
"properties": [
{
"name": "selectable",
"description": "Show the selected item check mark in the dropdown. Default is 'false'.",
"type": "string"
},
{ "name": "search", "type": "boolean" },
{
"name": "noAnimation",
"description": "Whether the search open indicator should be animated. Default is true.",
"type": "boolean"
},
{ "name": "searchOnValueSet", "type": "string" },
{
"name": "searchMode",
"description": "The search mode of the select. Default is 'none'.",
"type": "'none' | 'typehead' | 'autocomplete' | 'manual'"
},
{
"name": "textComplete",
"description": "Whether the search should not complete the text.",
"type": "boolean"
},
{
"name": "value",
"description": "The value of the search.",
"type": "string"
},
{
"name": "placeholder",
"description": "The placeholder of the search.",
"type": "string"
},
{
"name": "placement",
"description": "The placement of the select dropdown. Default is 'bottom-start'.",
"type": "'top' | 'top-start' | 'top-end' | 'right' | 'right-start'| 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end'"
},
{
"name": "opened",
"description": "Whether the search dropdown is opened.",
"type": "boolean"
},
{
"name": "sync",
"description": "The sync mode of the search dropdown. How the dropdown item size is synced to the trigger element'.",
"type": "boolean"
},
{
"name": "label",
"description": "The label of the search.",
"type": "string"
},
{
"name": "description",
"description": "The description of the search.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the search.",
"type": "string"
},
{
"name": "size",
"description": "The size of the search.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "disabled",
"description": "Whether the search is disabled.",
"type": "boolean"
},
{
"name": "required",
"description": "Whether the search is required.",
"type": "boolean"
},
{
"name": "readonly",
"description": "Whether the search is readonly.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "Whether the search is autofocus.",
"type": "boolean"
},
{
"name": "clearButton",
"description": "Whether the search is clearable. Default is 'true'.",
"type": "string"
},
{
"name": "feedback",
"description": "The feedback content of the search.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the search.",
"type": "'negative' | 'positive' | 'warning' | 'info'"
},
{
"name": "allowManualInput",
"description": "Whether the search allows manual input, or free text.",
"type": "boolean"
},
{
"name": "searchForText",
"description": "Whether the search should search for the selected item text.",
"type": "boolean"
},
{
"name": "searchButtonAriaLabel",
"description": "The aria label of the search button.",
"type": "string"
},
{
"name": "openOnEmpty",
"description": "Whether the search should open on empty results.",
"type": "boolean"
},
{
"name": "subtle",
"description": "Subtle color version",
"type": "boolean"
}
],
"events": [
{
"name": "dds-change",
"description": "Fired when the search value changes."
},
{
"name": "dds-blur",
"description": "Emitted when the search loses focus."
},
{
"name": "dds-focus",
"description": "Emitted when the search gains focus."
},
{
"name": "dds-clear",
"description": "Emitted when the search is cleared."
},
{
"name": "dds-search",
"description": "Emitted when the search input value changes."
},
{
"name": "dds-input",
"description": "Emitted when typing happens in the search input."
}
]
}
},
{
"name": "dap-ds-select",
"description": "A select is a form element that allows the user to select one option from a set.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the select value changes.\n- **dds-blur** - Emitted when the select loses focus.\n- **dds-focus** - Emitted when the select gains focus.\n- **dds-opened** - Emitted when the select dropdown is opened.\n- **dds-closed** - Emitted when the select dropdown is closed.\n\n### **Slots:**\n - _default_ - The option list of the select.\n- **indicator-icon** - The indicator icon of the select.\n\n### **CSS Properties:**\n - **--dds-select-min-height** - Minimum height of the select component (default: var(--dds-spacing-1000)) _(default: undefined)_\n- **--dds-select-padding** - Padding of the select component (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-select-column-gap** - Column gap of the select component (default: var(--dds-spacing-100)) _(default: undefined)_\n- **--dds-select-border-color** - Border color of the select component (default: var(--dds-border-neutral-base)) _(default: undefined)_\n- **--dds-select-border-radius** - Border radius of the select component (default: var(--dds-radius-base)) _(default: undefined)_\n- **--dds-select-bg-color** - Background color of the select component (default: var(--dds-background-neutral-subtle)) _(default: undefined)_\n- **--dds-select-text-color** - Text color of the select component (default: var(--dds-text-neutral-base)) _(default: undefined)_\n- **--dds-select-icon-right** - Right position of the icon (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-select-icon-color** - Color of the icon (default: var(--dds-icon-neutral-subtle)) _(default: undefined)_\n- **--dds-select-text-margin-right** - Right margin of the text (default: var(--dds-spacing-600)) _(default: undefined)_\n- **--dds-select-disabled-border-color** - Border color when disabled (default: var(--dds-background-neutral-stronger)) _(default: undefined)_\n- **--dds-select-disabled-bg-color** - Background color when disabled (default: var(--dds-background-neutral-stronger)) _(default: undefined)_\n- **--dds-select-disabled-text-color** - Text color when disabled (default: var(--dds-text-neutral-disabled)) _(default: undefined)_\n- **--dds-select-error-border-color** - Border color in error state (default: var(--dds-border-negative-base)) _(default: undefined)_\n- **--dds-select-success-border-color** - Border color in success state (default: var(--dds-border-positive-base)) _(default: undefined)_\n- **--dds-select-xs-min-height** - Minimum height for extra small size (default: var(--dds-spacing-800)) _(default: undefined)_\n- **--dds-select-xs-padding** - Padding for extra small size (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-select-xs-font-size** - Font size for extra small size (default: var(--dds-font-sm)) _(default: undefined)_\n- **--dds-select-lg-min-height** - Minimum height for large size (default: var(--dds-spacing-1200)) _(default: undefined)_\n- **--dds-select-lg-padding** - Padding for large size (default: var(--dds-spacing-400)) _(default: undefined)_\n- **--dds-select-lg-font-size** - Font size for large size (default: var(--dds-font-lg)) _(default: undefined)_\n- **--dds-select-lg-icon-right** - Right position of the icon for large size (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-select-lg-icon-color** - Color of the icon for large size (default: var(--dds-text-icon-neutral-subtle)) _(default: undefined)_\n- **--dds-select-popup-bg-color** - Background color of the popup (default: var(--dds-background-neutral-subtle)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main select container.\n- **trigger** - The trigger button of the select.\n- **label** - The label of the select.\n- **description** - The description of the select.\n- **feedback** - The feedback of the select.\n- **tooltip** - The tooltip of the select.\n- **option-list** - The option list of the select.",
"doc-url": "",
"attributes": [
{
"name": "placement",
"description": "The popup placement of the select",
"value": {
"type": "'top' | 'top-start' | 'top-end' | 'right' | 'right-start'| 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end'",
"default": "'bottom-start'"
}
},
{
"name": "opened",
"description": "Whether the select dropdown is opened.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "placeholder",
"description": "The placeholder of the select.",
"value": { "type": "string | null" }
},
{
"name": "sync",
"description": "The sync size of the select dropdown",
"value": { "type": "boolean | undefined" }
},
{
"name": "isMobile",
"description": "Whether the select is in mobile mode.",
"value": { "type": "boolean | undefined", "default": "false" }
},
{
"name": "loading",
"description": "The loading state of the select.",
"value": { "type": "boolean | undefined", "default": "false" }
},
{
"name": "maxHeight",
"description": "The max heigth of the select dropdown.",
"value": { "type": "number | undefined" }
},
{
"name": "noAnimation",
"description": "Whether the select dropdown indicator is animated or not",
"value": { "type": "boolean | undefined", "default": "false" }
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the select dropdown",
"value": {
"type": "'absolute' | 'fixed'",
"default": "'absolute'"
}
}
],
"slots": [
{ "name": "", "description": "The option list of the select." },
{
"name": "indicator-icon",
"description": "The indicator icon of the select."
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the select value changes."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the select loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the select gains focus."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Emitted when the select dropdown is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Emitted when the select dropdown is closed."
}
],
"js": {
"properties": [
{
"name": "placement",
"description": "The popup placement of the select",
"type": "'top' | 'top-start' | 'top-end' | 'right' | 'right-start'| 'right-end' | 'bottom' | 'bottom-start' | 'bottom-end' | 'left' | 'left-start' | 'left-end'"
},
{
"name": "opened",
"description": "Whether the select dropdown is opened.",
"type": "boolean"
},
{
"name": "placeholder",
"description": "The placeholder of the select.",
"type": "string | null"
},
{
"name": "sync",
"description": "The sync size of the select dropdown",
"type": "boolean | undefined"
},
{
"name": "isMobile",
"description": "Whether the select is in mobile mode.",
"type": "boolean | undefined"
},
{
"name": "loading",
"description": "The loading state of the select.",
"type": "boolean | undefined"
},
{
"name": "maxHeight",
"description": "The max heigth of the select dropdown.",
"type": "number | undefined"
},
{
"name": "noAnimation",
"description": "Whether the select dropdown indicator is animated or not",
"type": "boolean | undefined"
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the select dropdown",
"type": "'absolute' | 'fixed'"
},
{ "name": "focusElement" },
{ "name": "validity", "type": "ValidityState" },
{ "name": "validationMessage", "type": "string" },
{
"name": "value",
"description": "The value of the select.",
"type": "string"
},
{
"name": "label",
"description": "The label of the select.",
"type": "string"
},
{
"name": "description",
"description": "The description of the select.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the select.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the select.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "size",
"description": "The size of the select. Default is `sm`.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "disabled",
"description": "Whether the select is disabled.",
"type": "boolean"
},
{
"name": "required",
"description": "Whether the select is required.",
"type": "boolean"
},
{
"name": "readonly",
"description": "Whether the select is readonly.",
"type": "boolean"
},
{
"name": "autofocus",
"description": "Whether the select is autofocus.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback of the select.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the select. Can be `negative`, `positive`, or `warning`.",
"type": "negative | positive | warning"
},
{
"name": "status",
"description": "The status of the select. Can be `success` or `error`.",
"type": "string"
},
{
"name": "optional",
"description": "The optional state of the select.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the select.",
"type": "string"
},
{
"name": "subtle",
"description": "The weight of the label. Default is `false`",
"type": "boolean"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the select value changes."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the select loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the select gains focus."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Emitted when the select dropdown is opened."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Emitted when the select dropdown is closed."
}
]
}
},
{
"name": "dap-ds-sidenav-group",
"description": "Side navigation group\n---\n\n\n### **Slots:**\n - _default_ - The content of the side navigation group.\n- **submenu** - The submenu of the side navigation group.\n- **suffix** - The suffix of the side navigation group.\n\n### **CSS Properties:**\n - **--dds-sidenav-group-margin-bottom** - Default bottom margin of the sidenav group. _(default: undefined)_\n- **--dds-sidenav-group-border-radius** - Border radius of the sidenav group. _(default: undefined)_\n- **--dds-sidenav-group-spacing-margin** - Margin used for spacing variants. _(default: undefined)_\n- **--dds-sidenav-group-item-min-height** - Minimum height of the sidenav group item. _(default: undefined)_\n- **--dds-sidenav-group-item-padding** - Padding of the sidenav group item. _(default: undefined)_\n- **--dds-sidenav-group-item-color** - Text color of the sidenav group item. _(default: undefined)_\n- **--dds-sidenav-group-item-font-size** - Font size of the sidenav group item. _(default: undefined)_\n- **--dds-sidenav-group-item-font-weight** - Font weight of the sidenav group item. _(default: undefined)_\n- **--dds-sidenav-group-item-bg-active** - Background color when the item is active. _(default: undefined)_\n- **--dds-sidenav-group-item-bg-hover** - Background color on hover and active states. _(default: undefined)_\n- **--dds-sidenav-group-toggle-margin** - Margin for the toggle button. _(default: undefined)_\n- **--dds-sidenav-group-submenu-padding** - Padding for the submenu. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main side navigation group container.\n- **title** - The title of the side navigation group.\n- **link** - The link of the side navigation group.\n- **toggle** - The toggle button of the side navigation group.\n- **submenu** - The submenu of the side navigation group.",
"doc-url": "",
"attributes": [
{
"name": "href",
"description": "The href of the side navigation item",
"value": { "type": "string" }
},
{
"name": "active",
"description": "Whether the side navigation item is active",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "spacing",
"description": "The spacing of the side navigation item",
"value": {
"type": "'top' | 'bottom' | 'both' | 'none'",
"default": "'none'"
}
},
{
"name": "open",
"description": "Whether the side navigation group is open",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "",
"description": "The content of the side navigation group."
},
{
"name": "submenu",
"description": "The submenu of the side navigation group."
},
{
"name": "suffix",
"description": "The suffix of the side navigation group."
}
],
"events": [],
"js": {
"properties": [
{
"name": "href",
"description": "The href of the side navigation item",
"type": "string"
},
{
"name": "active",
"description": "Whether the side navigation item is active",
"type": "boolean"
},
{
"name": "spacing",
"description": "The spacing of the side navigation item",
"type": "'top' | 'bottom' | 'both' | 'none'"
},
{
"name": "open",
"description": "Whether the side navigation group is open",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-sidenav-item",
"description": "Side navigation item\n---\n\n\n### **Slots:**\n - _default_ - The content of the side navigation item.\n- **suffix** - The suffix of the side navigation item.\n\n### **CSS Properties:**\n - **--dds-sidenav-item-min-height** - Minimum height of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-margin-bottom** - Default bottom margin of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-padding** - Padding of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-radius** - Border radius of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-color** - Text color of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-font-size** - Font size of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-font-weight** - Font weight of the sidenav item. _(default: undefined)_\n- **--dds-sidenav-item-spacing-margin** - Margin used for spacing variants. _(default: undefined)_\n- **--dds-sidenav-item-bg-active** - Background color when the item is active. _(default: undefined)_\n- **--dds-sidenav-item-bg-hover** - Background color on hover and active states. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main side navigation item container.\n- **link** - The link of the side navigation item.",
"doc-url": "",
"attributes": [
{
"name": "href",
"description": "The href of the side navigation item",
"value": { "type": "string" }
},
{
"name": "active",
"description": "Whether the side navigation item is active",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "spacing",
"description": "The spacing of the side navigation item",
"value": {
"type": "'top' | 'bottom' | 'both' | 'none'",
"default": "'none'"
}
}
],
"slots": [
{
"name": "",
"description": "The content of the side navigation item."
},
{
"name": "suffix",
"description": "The suffix of the side navigation item."
}
],
"events": [],
"js": {
"properties": [
{
"name": "href",
"description": "The href of the side navigation item",
"type": "string"
},
{
"name": "active",
"description": "Whether the side navigation item is active",
"type": "boolean"
},
{
"name": "spacing",
"description": "The spacing of the side navigation item",
"type": "'top' | 'bottom' | 'both' | 'none'"
}
],
"events": []
}
},
{
"name": "dap-ds-sidenav",
"description": "Side navigation is a list of links that are used to navigate to different sections of a page.\n---\n\n\n### **Events:**\n - **dds-item-click** - Event fired when the side navigation item is clicked.\n\n### **Slots:**\n - _default_ - The content of the side navigation.\n\n### **CSS Parts:**\n - **base** - The main side navigation container.\n- **menu** - The menu of the side navigation.",
"doc-url": "",
"attributes": [
{
"name": "label",
"description": "The label of the side navigation, if aria label is not provided, it will be used as aria label",
"value": { "type": "string" }
},
{
"name": "activeHref",
"description": "The active href of the side navigation, to explicitly set the active item, if not provided, it will be set based on the current location",
"value": { "type": "string" }
}
],
"slots": [
{ "name": "", "description": "The content of the side navigation." }
],
"events": [
{
"name": "dds-item-click",
"type": "{ href: string, event: Event }",
"description": "Event fired when the side navigation item is clicked."
}
],
"js": {
"properties": [
{
"name": "label",
"description": "The label of the side navigation, if aria label is not provided, it will be used as aria label",
"type": "string"
},
{
"name": "activeHref",
"description": "The active href of the side navigation, to explicitly set the active item, if not provided, it will be set based on the current location",
"type": "string"
}
],
"events": [
{
"name": "dds-item-click",
"type": "{ href: string, event: Event }",
"description": "Event fired when the side navigation item is clicked."
}
]
}
},
{
"name": "dap-ds-skeleton",
"description": "A skeleton loader component for displaying placeholder content while loading.\n---\n\n\n### **CSS Properties:**\n - **--dds-skeleton-color** - The base color of the skeleton. _(default: undefined)_\n- **--dds-skeleton-animation-duration** - Duration of the loading animation. _(default: undefined)_\n- **--dds-skeleton-border-radius** - Border radius for rectangular skeletons. _(default: undefined)_\n- **--dds-skeleton-text-spacing** - Spacing between text lines in text variant. _(default: undefined)_\n- **--dds-skeleton-animation-timing-function** - Timing function for the loading animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main skeleton container.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the skeleton.",
"value": {
"type": "\"text\" | \"circular\" | \"rectangular\"",
"default": "'text'"
}
},
{
"name": "width",
"description": "The width of the skeleton. Can be any valid CSS width value.",
"value": { "type": "string | undefined" }
},
{
"name": "height",
"description": "The height of the skeleton. Can be any valid CSS height value.",
"value": { "type": "string | undefined" }
},
{
"name": "animated",
"description": "Whether to animate the skeleton.",
"value": { "type": "boolean", "default": "true" }
},
{
"name": "animation",
"description": "The animation type for the skeleton.",
"value": {
"type": "\"wave\" | \"pulse\" | \"custom\"",
"default": "'wave'"
}
},
{
"name": "custom-keyframes",
"description": "Custom keyframes for the animation when animation=\"custom\".\nShould be a valid CSS keyframes string without the",
"value": { "type": "string | undefined" }
}
],
"events": [],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the skeleton.",
"type": "\"text\" | \"circular\" | \"rectangular\""
},
{
"name": "width",
"description": "The width of the skeleton. Can be any valid CSS width value.",
"type": "string | undefined"
},
{
"name": "height",
"description": "The height of the skeleton. Can be any valid CSS height value.",
"type": "string | undefined"
},
{
"name": "animated",
"description": "Whether to animate the skeleton.",
"type": "boolean"
},
{
"name": "animation",
"description": "The animation type for the skeleton.",
"type": "\"wave\" | \"pulse\" | \"custom\""
},
{
"name": "customKeyframes",
"description": "Custom keyframes for the animation when animation=\"custom\".\nShould be a valid CSS keyframes string without the",
"type": "string | undefined"
}
],
"events": []
}
},
{
"name": "dap-ds-skip-link",
"description": "A skip link is a link that allows keyboard users to skip to the main content of a page.\n---\n\n\n### **Slots:**\n - _default_ - The content of the skip link.\n\n### **CSS Properties:**\n - **--dds-skip-link-border-color** - Border color for the high contrast outline (default: var(--dds-border-neutral-transparent-interactive, #fff500)) _(default: undefined)_\n- **--dds-skip-link-border-width** - Border width for the high contrast outline (default: var(--dds-border-width-large)) _(default: undefined)_\n- **--dds-skip-link-border-width-active** - Border width for the active state (default: var(--dds-border-width-xlarge)) _(default: undefined)_\n- **--dds-skip-link-border-radius** - Border radius of the skip link (default: var(--dds-radius-small)) _(default: undefined)_\n- **--dds-skip-link-padding-sm** - Padding for small size variant (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-skip-link-padding-lg** - Padding for large size variant (default: var(--dds-spacing-400)) _(default: undefined)_\n- **--dds-skip-link-text-underline-offset** - Underline offset for the text (default: 3px) _(default: undefined)_\n- **--dds-skip-link-z-index** - Z-index of the skip link (default: var(--dds-z-index-100)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main skip link container.\n- **text** - The text container of the skip link.\n- **high-contrast** - The high contrast outline container.",
"doc-url": "",
"attributes": [
{
"name": "placement",
"description": "The placement of the skip link.",
"value": { "type": "'left' | 'center'" }
},
{
"name": "href",
"description": "The href of the skip link",
"value": { "type": "string", "default": "'#'" }
},
{
"name": "size",
"description": "The size of the skip link",
"value": { "type": "'sm' | 'lg'", "default": "'sm'" }
},
{
"name": "noUnderline",
"description": "Whether the skip link should have an underline",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{ "name": "", "description": "The content of the skip link." }
],
"events": [],
"js": {
"properties": [
{
"name": "placement",
"description": "The placement of the skip link.",
"type": "'left' | 'center'"
},
{
"name": "href",
"description": "The href of the skip link",
"type": "string"
},
{
"name": "size",
"description": "The size of the skip link",
"type": "'sm' | 'lg'"
},
{
"name": "noUnderline",
"description": "Whether the skip link should have an underline",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-snackbar-message",
"description": "The Snackbar component shows a sliding message to the user.\n---\n\n\n### **Events:**\n - **dds-close** - Fires when the snackbar closes.\n\n### **Slots:**\n - **default** - The content of the snackbar.\n\n### **CSS Properties:**\n - **--dds-snackbar-width** - Width of the snackbar. _(default: undefined)_\n- **--dds-snackbar-gap** - Gap between snackbar elements. _(default: undefined)_\n- **--dds-snackbar-padding** - Padding inside the snackbar. _(default: undefined)_\n- **--dds-snackbar-margin-bottom** - Bottom margin of the snackbar. _(default: undefined)_\n- **--dds-snackbar-transition** - Transition property for the snackbar. _(default: undefined)_\n- **--dds-snackbar-border-width** - Border width of the snackbar. _(default: undefined)_\n- **--dds-snackbar-border-radius** - Border radius of the snackbar. _(default: undefined)_\n- **--dds-snackbar-font-size** - Font size used in the snackbar. _(default: undefined)_\n- **--dds-snackbar-background** - Background color of the snackbar. _(default: undefined)_\n- **--dds-snackbar-border** - Border color of the snackbar. _(default: undefined)_\n- **--dds-snackbar-text** - Text color of the snackbar. _(default: undefined)_\n- **--dds-snackbar-icon** - Icon color of the snackbar. _(default: undefined)_\n- **--dds-snackbar-link** - Link color of the snackbar. _(default: undefined)_\n- **--dds-snackbar-information-background** - Background color for information variant. _(default: undefined)_\n- **--dds-snackbar-information-border** - Border color for information variant. _(default: undefined)_\n- **--dds-snackbar-information-icon** - Icon color for information variant. _(default: undefined)_\n- **--dds-snackbar-success-background** - Background color for success variant. _(default: undefined)_\n- **--dds-snackbar-success-border** - Border color for success variant. _(default: undefined)_\n- **--dds-snackbar-success-icon** - Icon color for success variant. _(default: undefined)_\n- **--dds-snackbar-error-background** - Background color for error variant. _(default: undefined)_\n- **--dds-snackbar-error-border** - Border color for error variant. _(default: undefined)_\n- **--dds-snackbar-error-icon** - Icon color for error variant. _(default: undefined)_\n- **--dds-snackbar-variant-text** - Text color for information, success, and error variants. _(default: undefined)_\n- **--dds-snackbar-variant-icon** - Icon color for information, success, and error variants. _(default: undefined)_\n- **--dds-snackbar-variant-link** - Link color for information, success, and error variants. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - Main snackbar container.\n- **text** - The text part of the snackbar.\n- **closebutton** - The close button part of the component.\n- **icon** - The icon part of the close button.",
"doc-url": "",
"attributes": [
{
"name": "actions",
"description": "The actions of the snackbar item.",
"value": { "type": "ActionType[] | undefined", "default": "[]" }
},
{
"name": "message",
"description": "The message of the snackbar item.",
"value": { "type": "string", "default": "''" }
},
{
"name": "closeButton",
"description": "Whether the snackbar has a close button.",
"value": { "type": "string", "default": "'true'" }
},
{
"name": "alertType",
"description": "The message type of the snackbar item.",
"value": { "type": "AlertType", "default": "'default'" }
},
{
"name": "customStyle",
"description": "The custom style of the snackbar item.",
"value": { "type": "Record | undefined" }
},
{
"name": "position",
"description": "The position of the snackbar container for directional animations.",
"value": {
"type": "SnackbarPosition",
"default": "'bottom-right'"
}
}
],
"slots": [
{ "name": "default", "description": "The content of the snackbar." }
],
"events": [
{
"name": "dds-close",
"type": "{ id: string }",
"description": "Fires when the snackbar closes."
}
],
"js": {
"properties": [
{
"name": "actions",
"description": "The actions of the snackbar item.",
"type": "ActionType[] | undefined"
},
{
"name": "message",
"description": "The message of the snackbar item.",
"type": "string"
},
{
"name": "closeButton",
"description": "Whether the snackbar has a close button.",
"type": "string"
},
{
"name": "alertType",
"description": "The message type of the snackbar item.",
"type": "AlertType"
},
{
"name": "customStyle",
"description": "The custom style of the snackbar item.",
"type": "Record | undefined"
},
{
"name": "position",
"description": "The position of the snackbar container for directional animations.",
"type": "SnackbarPosition"
}
],
"events": [
{
"name": "dds-close",
"type": "{ id: string }",
"description": "Fires when the snackbar closes."
}
]
}
},
{
"name": "dap-ds-snackbar",
"description": "The Snackbar is a container of sliding messages.\n---\n\n\n### **Methods:**\n - **show(message: _string_, options: _MessageOptionsType_): _void_** - Static method to show a snackbar message anywhere in the application\n- **success(message: _string_, options: _Omit_): _void_** - Static method to show a success message\n- **error(message: _string_, options: _Omit_): _void_** - Static method to show an error message\n- **info(message: _string_, options: _Omit_): _void_** - Static method to show an information message\n- **default(message: _string_, options: _Omit_): _void_** - Static method to show a default message\n- **closeAll(): _void_** - Static method to close all snackbar messages globally\n- **closeAll(): _void_** - Close all currently displayed messages\n\n### **CSS Properties:**\n - **--dds-snackbar-spacing** - Spacing used for positioning the snackbar (default: var(--dds-spacing-400)) _(default: undefined)_\n- **--dds-snackbar-z-index** - Z-index of the snackbar container (default: 10000) _(default: undefined)_\n- **--dds-snackbar-pointer-events** - Pointer events behavior for the snackbar (default: auto) _(default: undefined)_\n- **--dds-snackbar-animation-duration** - Duration of entrance animations (default: 0.3s) _(default: undefined)_\n- **--dds-snackbar-animation-timing** - Timing function for animations (default: ease-out) _(default: undefined)_\n\n### **CSS Parts:**\n - **host** - The host element",
"doc-url": "",
"attributes": [
{
"name": "maxItems",
"description": "The maximum number of snackbar messages at a given time.",
"value": { "type": "number", "default": "4" }
},
{
"name": "position",
"description": "The position of the snackbar",
"value": {
"type": "'bottom-left' | 'bottom-right' | 'bottom-center' | 'top-right' | 'top-center'",
"default": "'bottom-right'"
}
},
{
"name": "duration",
"description": "The duration of the snackbar message in milliseconds",
"value": { "type": "number", "default": "6000" }
},
{
"name": "announceMessages",
"description": "Whether the snackbar should announce new messages to screen readers",
"value": { "type": "boolean", "default": "true" }
}
],
"events": [],
"js": {
"properties": [
{
"name": "maxItems",
"description": "The maximum number of snackbar messages at a given time.",
"type": "number"
},
{
"name": "position",
"description": "The position of the snackbar",
"type": "'bottom-left' | 'bottom-right' | 'bottom-center' | 'top-right' | 'top-center'"
},
{
"name": "duration",
"description": "The duration of the snackbar message in milliseconds",
"type": "number"
},
{
"name": "announceMessages",
"description": "Whether the snackbar should announce new messages to screen readers",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-spinner",
"description": "Loading spinner component.\n---\n\n\n### **Slots:**\n - _default_ - The loading text content.\n\n### **CSS Properties:**\n - **--dds-spinner-icon-color-neutral** - Color for neutral spinner icons. _(default: undefined)_\n- **--dds-spinner-icon-color-brand** - Color for brand spinner icons. _(default: undefined)_\n- **--dds-spinner-icon-color-negative** - Color for negative spinner icons. _(default: undefined)_\n- **--dds-spinner-icon-color-positive** - Color for positive spinner icons. _(default: undefined)_\n- **--dds-spinner-icon-color-inverted** - Color for inverted spinner icons. _(default: undefined)_\n- **--dds-spinner-text-spacing** - Spacing between spinner and text. _(default: undefined)_\n- **--dds-spinner-animation-duration** - Duration of the spinner animation. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main spinner container.\n- **icon** - The loading icon element.\n- **icon-base** - The base of the loading icon.\n- **text** - The loading text element.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the spinner.",
"value": {
"type": "\"neutral\" | \"brand\" | \"negative\" | \"positive\" | \"inverted\"",
"default": "'neutral'"
}
},
{
"name": "size",
"description": "The size of the spinner.",
"value": {
"type": "\"xxl\" | \"xl\" | \"lg\" | \"md\" | \"sm\" | \"xs\"",
"default": "'lg'"
}
},
{
"name": "staticSize",
"description": "The size of the spinner in pixels. This overrides the size attribute",
"value": { "type": "number | undefined" }
},
{
"name": "text",
"description": "The loading text.",
"value": { "type": "string" }
},
{
"name": "noColor",
"description": "Removes the text color",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [{ "name": "", "description": "The loading text content." }],
"events": [],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the spinner.",
"type": "\"neutral\" | \"brand\" | \"negative\" | \"positive\" | \"inverted\""
},
{
"name": "size",
"description": "The size of the spinner.",
"type": "\"xxl\" | \"xl\" | \"lg\" | \"md\" | \"sm\" | \"xs\""
},
{
"name": "staticSize",
"description": "The size of the spinner in pixels. This overrides the size attribute",
"type": "number | undefined"
},
{
"name": "text",
"description": "The loading text.",
"type": "string"
},
{
"name": "noColor",
"description": "Removes the text color",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-stack",
"description": "A stack is a container for stacked content.\n---\n\n\n### **Slots:**\n - _default_ - The content of the stack.\n\n### **CSS Parts:**\n - **stack** - The main stack container.",
"doc-url": "",
"attributes": [
{
"name": "direction",
"description": "The direction of the stack.",
"value": {
"type": "'column' | 'column-reverse' | 'row' | 'row-reverse'",
"default": "'column'"
}
},
{
"name": "endMargin",
"description": "Adds margin to the end of the stack.",
"value": { "type": "boolean | undefined", "default": "false" }
},
{
"name": "startMargin",
"description": "Adds margin to the start of the stack.",
"value": { "type": "boolean | undefined", "default": "false" }
},
{
"name": "spacing",
"description": "The spacing of the stack. Uses the system spacing scale (100, 200, 300...etc)",
"value": { "type": "string" }
}
],
"slots": [{ "name": "", "description": "The content of the stack." }],
"events": [],
"js": {
"properties": [
{
"name": "direction",
"description": "The direction of the stack.",
"type": "'column' | 'column-reverse' | 'row' | 'row-reverse'"
},
{
"name": "endMargin",
"description": "Adds margin to the end of the stack.",
"type": "boolean | undefined"
},
{
"name": "startMargin",
"description": "Adds margin to the start of the stack.",
"type": "boolean | undefined"
},
{
"name": "spacing",
"description": "The spacing of the stack. Uses the system spacing scale (100, 200, 300...etc)"
}
],
"events": []
}
},
{
"name": "dap-ds-switch",
"description": "A switch is a graphical control element that allows the user to toggle between two states.\n---\n\n\n### **Events:**\n - **dds-change** - Fired when the input value changes.\n- **dds-blur** - Emitted when the input loses focus.\n- **dds-focus** - Emitted when the input gains focus.\n- **dds-input** - Emitted when the input receives input.\n\n### **Methods:**\n - **focus(): _void_** - Programmatically focuses the switch input element.\n- **blur(): _void_** - Programmatically blurs the switch input element.\n\n### **CSS Parts:**\n - **base** - The main switch container.\n- **baselabel** - The main label container\n- **label** - The label of the switch.\n- **input** - The native input of the switch.\n- **control** - The control of the switch.\n- **description** - The description of the switch.",
"doc-url": "",
"attributes": [
{
"name": "border",
"description": "This sets up border around the switch, when true.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "type",
"description": "The type of the switch",
"value": {
"type": "'normal' | 'background'",
"default": "'normal'"
}
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Emitted when the input receives input."
}
],
"js": {
"properties": [
{
"name": "border",
"description": "This sets up border around the switch, when true.",
"type": "boolean"
},
{
"name": "type",
"description": "The type of the switch",
"type": "'normal' | 'background'"
},
{ "name": "focusElement", "type": "HTMLInputElement" },
{
"name": "name",
"description": "The name of the switch.",
"type": "string"
},
{
"name": "value",
"description": "The value of the switch.",
"type": "string"
},
{
"name": "label",
"description": "The label of the switch.",
"type": "string"
},
{
"name": "description",
"description": "The description of the switch.",
"type": "string"
},
{
"name": "checked",
"description": "The checked state of the switch.",
"type": "boolean"
},
{
"name": "size",
"description": "The size of the switch.",
"type": "'xs' | 'sm' | 'md' | 'lg'"
},
{
"name": "disabled",
"description": "The disabled state of the switch.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the switch.",
"type": "boolean"
},
{
"name": "labelPlacement",
"description": "The placement of the label.",
"type": "'left' | 'right'"
},
{
"name": "descriptionPlacement",
"description": "The placement of the description.",
"type": "'top' | 'bottom'"
},
{
"name": "subtle",
"description": "The weight of the label.",
"type": "boolean"
},
{
"name": "feedback",
"description": "The feedback of the switch.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the switch.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "optional",
"description": "The optional state of the switch.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the switch.",
"type": "string"
}
],
"events": [
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the input value changes."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Emitted when the input loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the input gains focus."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Emitted when the input receives input."
}
]
}
},
{
"name": "dap-ds-tab-group",
"description": "A tab group component. It is used with dap-ds-tab component to create a tab group.\n---\n\n\n### **Events:**\n - **dds-tab-select** - Fired when select a new tab.\n\n### **Slots:**\n - _default_ - The tab items.\n\n### **CSS Properties:**\n - **--dds-tab-group-border-radius** - Border radius of the tab group container _(default: undefined)_\n- **--dds-tab-group-border-width** - Border width of the tab navigation _(default: undefined)_\n- **--dds-tab-group-border-color** - Border color of the tab navigation _(default: undefined)_\n- **--dds-tab-height-sm** - Height of small tabs _(default: undefined)_\n- **--dds-tab-height-lg** - Height of large tabs _(default: undefined)_\n- **--dds-tab-font-size-sm** - Font size of small tabs _(default: undefined)_\n- **--dds-tab-font-size-lg** - Font size of large tabs _(default: undefined)_\n- **--dds-tab-padding** - Padding of the tab buttons _(default: undefined)_\n- **--dds-tab-border-width** - Border width for tabs _(default: undefined)_\n- **--dds-tab-selected-border-color** - Border color for selected tabs _(default: undefined)_\n- **--dds-tab-text-color** - Text color for tabs _(default: undefined)_\n- **--dds-tab-hover-text-color** - Text color for tabs on hover _(default: undefined)_\n- **--dds-tab-disabled-text-color** - Text color for disabled tabs _(default: undefined)_\n- **--dds-tab-hover-background** - Background color for tabs on hover _(default: undefined)_\n- **--dds-tab-active-background** - Background color for active tabs _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main container.\n- **tab-nav** - The tab navigation container.\n- **tab-content** - The tab content container.",
"doc-url": "",
"attributes": [
{
"name": "selectedTabId",
"description": "The selected tab id.",
"value": { "type": "string" }
},
{
"name": "size",
"description": "The size of the tab buttons. Default is `sm`. Can be `sm` or `lg`.",
"value": { "type": "'sm' | 'lg'", "default": "'sm'" }
},
{
"name": "mobile",
"description": "If true, the tab group will be displayed in mobile mode.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [{ "name": "", "description": "The tab items." }],
"events": [
{
"name": "dds-tab-select",
"description": "Fired when select a new tab."
}
],
"js": {
"properties": [
{
"name": "selectedTabId",
"description": "The selected tab id.",
"type": "string"
},
{
"name": "size",
"description": "The size of the tab buttons. Default is `sm`. Can be `sm` or `lg`.",
"type": "'sm' | 'lg'"
},
{
"name": "mobile",
"description": "If true, the tab group will be displayed in mobile mode.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-tab-select",
"description": "Fired when select a new tab."
}
]
}
},
{
"name": "dap-ds-tab",
"description": "A tab item component. It is used in dap-ds-tab-group component slot to create a tab item.\n---\n\n\n### **Slots:**\n - _default_ - The tab title template.\n- **content** - The tab content.\n\n### **CSS Parts:**\n - **base** - The main tab content container.",
"doc-url": "",
"attributes": [
{
"name": "tabId",
"description": "The tab id. Required",
"value": { "type": "string" }
},
{
"name": "disabled",
"description": "The disabled state of the tab.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{ "name": "", "description": "The tab title template." },
{ "name": "content", "description": "The tab content." }
],
"events": [],
"js": {
"properties": [
{
"name": "tabId",
"description": "The tab id. Required",
"type": "string"
},
{
"name": "disabled",
"description": "The disabled state of the tab.",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-table-cell",
"description": "Table cell component.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n\n### **CSS Properties:**\n - **--dds-table-cell-padding-block** - Padding for the top and bottom of the cell. Default: var(--dds-spacing-200) _(default: undefined)_\n- **--dds-table-cell-padding-inline-start** - Padding for the start (left in LTR) of the cell. Default: var(--dds-spacing-500) _(default: undefined)_\n- **--dds-table-cell-padding-inline-end** - Padding for the end (right in LTR) of the cell. Default: var(--dds-spacing-500) _(default: undefined)_\n- **--dds-table-cell-border-width** - Width of the cell's bottom border. Default: var(--dds-border-width-base) _(default: undefined)_\n- **--dds-table-cell-border-color** - Color of the cell's bottom border. Default: var(--dds-border-neutral-subtle) _(default: undefined)_\n- **--dds-table-cell-text-color** - Text color of the cell. Default: var(--dds-text-neutral-base) _(default: undefined)_\n- **--dds-table-cell-line-height** - Line height of the cell text. Default: 1.5 _(default: undefined)_\n- **--dds-table-cell-text-align** - Text alignment in the cell. Default: left _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main cell container.",
"doc-url": "",
"attributes": [
{
"name": "last",
"description": "If the cell is the last one.",
"value": { "type": "boolean" }
},
{
"name": "role",
"description": "The html role of the cell",
"value": { "type": "string", "default": "'cell'" }
}
],
"slots": [{ "name": "", "description": "The default slot." }],
"events": [],
"js": {
"properties": [
{
"name": "last",
"description": "If the cell is the last one.",
"type": "boolean"
},
{
"name": "role",
"description": "The html role of the cell",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-table-header",
"description": "Table header cell component.\n---\n\n\n### **Slots:**\n - _default_ - The default slot.\n\n### **CSS Properties:**\n - **--dds-table-header-padding-block** - Padding for the top and bottom of the header cell. _(default: undefined)_\n- **--dds-table-header-padding-inline-start** - Padding for the start (left in LTR) of the header cell. _(default: undefined)_\n- **--dds-table-header-padding-inline-end** - Padding for the end (right in LTR) of the header cell. _(default: undefined)_\n- **--dds-table-header-border-width** - Width of the header cell's bottom border. _(default: undefined)_\n- **--dds-table-header-border-color** - Color of the header cell's bottom border. _(default: undefined)_\n- **--dds-table-header-text-color** - Text color of the header cell. _(default: undefined)_\n- **--dds-table-header-font-weight** - Font weight of the header cell text. _(default: undefined)_\n- **--dds-table-header-line-height** - Line height of the header cell text. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main header cell container.",
"doc-url": "",
"attributes": [
{
"name": "last",
"description": "If the header cell is the last one.",
"value": { "type": "boolean" }
},
{
"name": "role",
"description": "The html role of the header cell",
"value": { "type": "string", "default": "'columnheader'" }
}
],
"slots": [{ "name": "", "description": "The default slot." }],
"events": [],
"js": {
"properties": [
{
"name": "last",
"description": "If the header cell is the last one.",
"type": "boolean"
},
{
"name": "role",
"description": "The html role of the header cell",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-table-row",
"description": "Table row component.\n---\n\n\n### **Slots:**\n - _default_ - The default slot. Accepts `dap-ds-table-cell` and `dap-ds-table-header` elements.\n\n### **CSS Properties:**\n - **--dds-table-row-padding-right** - Padding right for the last table header, defaults to var(--dds-spacing-500) _(default: undefined)_\n- **--dds-table-row-padding-top** - Padding top for table headers in mobile view, defaults to var(--dds-spacing-400) _(default: undefined)_\n- **--dds-table-row-padding-bottom** - Padding bottom for the last table cell in mobile view, defaults to var(--dds-spacing-400) _(default: undefined)_\n- **--dds-table-row-border-color** - Border color for table cells and headers, defaults to transparent _(default: undefined)_",
"doc-url": "",
"attributes": [
{
"name": "role",
"description": "The html role of the row",
"value": { "type": "string", "default": "'row'" }
},
{
"name": "mobile",
"description": "If the row is mobile design",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "",
"description": "The default slot. Accepts `dap-ds-table-cell` and `dap-ds-table-header` elements."
}
],
"events": [],
"js": {
"properties": [
{
"name": "role",
"description": "The html role of the row",
"type": "string"
},
{
"name": "mobile",
"description": "If the row is mobile design",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-table",
"description": "Data table component.\n---\n\n\n### **Slots:**\n - _default_ - The default slot. Accepts `dap-ds-table-row` elements.\n\n### **CSS Properties:**\n - **--dds-table-border-width** - Width of the table border. Default: var(--dds-border-width-base, 1px) _(default: undefined)_\n- **--dds-table-border-color** - Color of the table border. Default: var(--dds-border-neutral-subtle) _(default: undefined)_\n- **--dds-table-border-radius** - Border radius of the table. Default: var(--dds-radius-small, 4px) _(default: undefined)_\n- **--dds-table-row-divider-color** - Color of the divider between rows in mobile view. Default: var(--dds-border-neutral-subtle) _(default: undefined)_",
"doc-url": "",
"attributes": [
{
"name": "role",
"value": { "type": "string", "default": "'grid'" }
},
{
"name": "mobile",
"description": "If the table has mobile design",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "caption",
"description": "The caption of the table",
"value": { "type": "string", "default": "''" }
}
],
"slots": [
{
"name": "",
"description": "The default slot. Accepts `dap-ds-table-row` elements."
}
],
"events": [],
"js": {
"properties": [
{ "name": "role", "type": "string" },
{
"name": "mobile",
"description": "If the table has mobile design",
"type": "boolean"
},
{
"name": "caption",
"description": "The caption of the table",
"type": "string"
}
],
"events": []
}
},
{
"name": "dap-ds-textarea",
"description": "A textarea is a multi-line text input field.\n---\n\n\n### **Events:**\n - **dds-count-change** - Fires when the count of the textarea changes.\n- **dds-change** - Fired when the textarea value changes.\n- **dds-input** - Fired when the textarea value changes.\n- **dds-keydown** - Fired when a key is pressed down.\n- **dds-blur** - Fired when the textarea loses focus.\n- **dds-focus** - Emitted when the textarea gains focus.\n- **dds-select** - Emitted when select text in textarea.\n\n### **Slots:**\n - **feedback-icon** - The custom icon of the feedback.\n\n### **CSS Properties:**\n - **--dds-textarea-min-rows** - Minimum number of rows in the textarea. Default is 2. _(default: undefined)_\n- **--dds-textarea-spacing** - Gap between elements in the textarea container. Default is var(--dds-spacing-200). _(default: undefined)_\n- **--dds-textarea-gap** - Gap between elements in the textarea container. Default is var(--dds-spacing-200). _(default: undefined)_\n- **--dds-textarea-margin-top** - Top margin of the textarea. Default is var(--dds-spacing-200). _(default: undefined)_\n- **--dds-textarea-padding** - Padding of the textarea control. Default is var(--dds-spacing-200) var(--dds-spacing-300). _(default: undefined)_\n- **--dds-textarea-border-width** - Border width of the textarea. Default is var(--dds-border-width-base). _(default: undefined)_\n- **--dds-textarea-border-color** - Border color of the textarea. Default is var(--dds-border-neutral-base). _(default: undefined)_\n- **--dds-textarea-background** - Background color of the textarea. Default is var(--dds-fields-background-default). _(default: undefined)_\n- **--dds-textarea-color** - Text color of the textarea. Default is var(--dds-text-neutral-base). _(default: undefined)_\n- **--dds-textarea-border-radius** - Border radius of the textarea. Default is var(--dds-radius-base). _(default: undefined)_\n- **--dds-textarea-disabled-bg** - Background color when disabled. Default is var(--dds-fields-background-disabled). _(default: undefined)_\n- **--dds-textarea-disabled-color** - Text color when disabled. Default is var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-textarea-readonly-bg** - Background color when readonly. Default is var(--dds-fields-background-read-only). _(default: undefined)_\n- **--dds-textarea-readonly-color** - Text color when readonly. Default is var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-textarea-error-border** - Border color when in error state. Default is var(--dds-border-negative-base). _(default: undefined)_\n- **--dds-textarea-success-border** - Border color when in success state. Default is var(--dds-border-positive-base). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main textarea container.\n- **input** - The native input of the textarea.\n- **counter** - The counter of the textarea.\n- **counter-base** - The base of the counter.\n- **feedback** - The feedback of the textarea.\n- **feedback-base** - The base of the feedback.\n- **feedback-text** - The text of the feedback.\n- **feedback-icon** - The icon of the feedback.",
"doc-url": "",
"attributes": [
{
"name": "hideCounter",
"description": "Hide character counter.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "minlength",
"description": "The minimum length of the textarea.",
"value": { "type": "number" }
},
{
"name": "maxlength",
"description": "The maximum length of the textarea.",
"value": { "type": "number | undefined" }
},
{
"name": "rows",
"description": "The number of rows in the textarea.",
"value": { "type": "number | undefined", "default": "6" }
},
{
"name": "cols",
"description": "The number of columns in the textarea.",
"value": { "type": "number | undefined" }
},
{
"name": "placeholder",
"description": "The placeholder of the textarea.",
"value": { "type": "string", "default": "''" }
},
{
"name": "wrap",
"description": "Indicates how the control should wrap the value for form submission.",
"value": { "type": "'hard' | 'soft'" }
}
],
"slots": [
{
"name": "feedback-icon",
"description": "The custom icon of the feedback."
}
],
"events": [
{
"name": "dds-count-change",
"type": "{ value: number }",
"description": "Fires when the count of the textarea changes."
},
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the textarea value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the textarea value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the textarea loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the textarea gains focus."
},
{
"name": "dds-select",
"type": "{ value: string }",
"description": "Emitted when select text in textarea."
}
],
"js": {
"properties": [
{
"name": "hideCounter",
"description": "Hide character counter.",
"type": "boolean"
},
{
"name": "minlength",
"description": "The minimum length of the textarea.",
"type": "number"
},
{
"name": "maxlength",
"description": "The maximum length of the textarea.",
"type": "number | undefined"
},
{
"name": "rows",
"description": "The number of rows in the textarea.",
"type": "number | undefined"
},
{
"name": "cols",
"description": "The number of columns in the textarea.",
"type": "number | undefined"
},
{
"name": "placeholder",
"description": "The placeholder of the textarea.",
"type": "string"
},
{
"name": "wrap",
"description": "Indicates how the control should wrap the value for form submission.",
"type": "'hard' | 'soft'"
},
{ "name": "focusElement" },
{
"name": "size",
"description": "The size of the textarea. Default is `md`.",
"type": "'xs' | 'sm' | 'lg'"
},
{
"name": "disabled",
"description": "The disabled state of the textarea.",
"type": "boolean"
},
{
"name": "value",
"description": "The value of the textarea.",
"type": "string"
},
{
"name": "tooltip",
"description": "The tooltip of the textarea.",
"type": "string"
},
{
"name": "tooltipPlacement",
"description": "The tooltip placement of the textarea.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "status",
"description": "The status of the textarea. Can be `success` or `error`.",
"type": "InputStatus"
},
{
"name": "readonly",
"description": "The readonly state of the textarea.",
"type": "boolean"
},
{
"name": "required",
"description": "The required state of the textarea.",
"type": "boolean"
},
{
"name": "label",
"description": "The label of the textarea.",
"type": "string"
},
{
"name": "description",
"description": "The description of the textarea.",
"type": "string"
},
{
"name": "feedback",
"description": "The feedback of the textarea.",
"type": "string"
},
{
"name": "feedbackType",
"description": "The feedback type of the textarea. Can be `negative`, `positive`, or `warning`.",
"type": "'negative' | 'positive' | 'warning'"
},
{
"name": "optional",
"description": "The optional state of the textarea.",
"type": "boolean"
},
{
"name": "optionalLabel",
"description": "The optional label of the textarea.",
"type": "string"
},
{
"name": "subtle",
"description": "The weight of the label. Default is `false`",
"type": "boolean"
},
{
"name": "autofocus",
"description": "The autofocus state of the textarea.",
"type": "boolean"
}
],
"events": [
{
"name": "dds-count-change",
"type": "{ value: number }",
"description": "Fires when the count of the textarea changes."
},
{
"name": "dds-change",
"type": "{ value: string }",
"description": "Fired when the textarea value changes."
},
{
"name": "dds-input",
"type": "{ value: string }",
"description": "Fired when the textarea value changes."
},
{
"name": "dds-keydown",
"type": "{ value: string, originalEvent: Event }",
"description": "Fired when a key is pressed down."
},
{
"name": "dds-blur",
"type": "{ void }",
"description": "Fired when the textarea loses focus."
},
{
"name": "dds-focus",
"type": "{ void }",
"description": "Emitted when the textarea gains focus."
},
{
"name": "dds-select",
"type": "{ value: string }",
"description": "Emitted when select text in textarea."
}
]
}
},
{
"name": "dap-ds-timeline-item",
"description": "A timeline is a graphical representation of a series of events.\n---\n\n\n### **Slots:**\n - _default_ - The default slot for the item content.\n\n### **CSS Properties:**\n - **--dds-timeline-position** - Position of the timeline dot (default: 28px) _(default: undefined)_\n- **--dds-timeline-connector-width** - Width of the timeline connector line (default: 1px) _(default: undefined)_\n- **--dds-timeline-connector-left-position** - Left position of the timeline connector (default: 5.5px) _(default: undefined)_\n- **--dds-timeline-dot-size** - Size of the timeline dot (default: var(--dds-spacing-300)) _(default: undefined)_\n- **--dds-timeline-item-margin-bottom** - Bottom margin of timeline items (default: var(--dds-spacing-200)) _(default: undefined)_\n- **--dds-timeline-item-padding-left** - Left padding of timeline items (default: var(--dds-spacing-400)) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main timeline item container.\n- **connector** - The connector element between two timeline items.\n- **content** - The content of the timeline item.",
"doc-url": "",
"attributes": [],
"slots": [
{
"name": "",
"description": "The default slot for the item content."
}
],
"events": [],
"js": { "properties": [], "events": [] }
},
{
"name": "dap-ds-timeline",
"description": "A timeline is a graphical representation of a series of events.\n---\n\n\n### **Slots:**\n - _default_ - The default slot for the timeline items.\n\n### **CSS Parts:**\n - **base** - The main timeline container.",
"doc-url": "",
"attributes": [],
"slots": [
{
"name": "",
"description": "The default slot for the timeline items."
}
],
"events": [],
"js": { "properties": [], "events": [] }
},
{
"name": "dap-ds-toc",
"description": "A table of contents (TOC) is a list of links that allows users to quickly navigate to sections within a document.\n---\n\n\n### **Events:**\n - **dds-anchor-change** - Event that is triggered when the anchor changes.\n\n### **CSS Properties:**\n - **--dds-toc-border-width** - Width of the TOC border. Default: var(--dds-border-width-base) _(default: undefined)_\n- **--dds-toc-border-color** - Color of the TOC border. Default: var(--dds-border-neutral-divider) _(default: undefined)_\n- **--dds-toc-title-color** - Color of the TOC title. Default: var(--dds-text-neutral-strong) _(default: undefined)_\n- **--dds-toc-title-font-size** - Font size of the TOC title. Default: var(--dds-font-base) _(default: undefined)_\n- **--dds-toc-title-font-weight** - Font weight of the TOC title. Default: var(--dds-font-weight-bold) _(default: undefined)_\n- **--dds-toc-title-line-height** - Line height of the TOC title. Default: 1.25 _(default: undefined)_\n- **--dds-toc-link-color** - Color of the TOC links. Default: var(--dds-button-subtle-text-neutral-enabled) _(default: undefined)_\n- **--dds-toc-link-active-color** - Color of the active TOC link. Default: var(--dds-button-subtle-text-enabled) _(default: undefined)_\n- **--dds-toc-link-border-color** - Border color of the active TOC link. Default: var(--dds-border-brand-base) _(default: undefined)_\n- **--dds-toc-link-line-height** - Line height of the TOC links. Default: 1.2 _(default: undefined)_\n- **--dds-toc-link-padding** - Padding of the TOC links. Default: var(--dds-spacing-200) _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main container of the toc.",
"doc-url": "",
"attributes": [
{
"name": "root",
"description": "The root element to observe [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#root)",
"value": { "type": "string", "default": "''" }
},
{
"name": "rootMargin",
"description": "The margin around the root element to observe [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#rootmargin)",
"value": { "type": "string", "default": "'0px 0px -80% 0px'" }
},
{
"name": "lastAnchorRootMargin",
"description": "The margin around the last anchor to observe [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#rootmargin)",
"value": { "type": "string", "default": "'0px 0px -50% 0px'" }
},
{
"name": "threshold",
"description": "The threshold to trigger [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#threshold)",
"value": { "type": "number", "default": "1" }
},
{
"name": "minHeadingLevel",
"description": "The minimum heading level to include in the TOC. The default value is `2`.",
"value": { "type": "number", "default": "2" }
},
{
"name": "maxHeadingLevel",
"description": "The maximum heading level to include in the TOC. The default value is `3`.",
"value": { "type": "number", "default": "3" }
},
{
"name": "noIndent",
"description": "Whether to indent the TOC items.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "header",
"description": "The header of the TOC.",
"value": { "type": "string" }
}
],
"events": [
{
"name": "dds-anchor-change",
"type": "{ selectedItem: HTMLAnchorElement, anchorElement: IntersectionObserverEntry | HTMLElement }",
"description": "Event that is triggered when the anchor changes."
}
],
"js": {
"properties": [
{
"name": "root",
"description": "The root element to observe [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#root)",
"type": "string"
},
{
"name": "rootMargin",
"description": "The margin around the root element to observe [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#rootmargin)",
"type": "string"
},
{
"name": "lastAnchorRootMargin",
"description": "The margin around the last anchor to observe [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#rootmargin)",
"type": "string"
},
{
"name": "threshold",
"description": "The threshold to trigger [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API#threshold)",
"type": "number"
},
{
"name": "minHeadingLevel",
"description": "The minimum heading level to include in the TOC. The default value is `2`.",
"type": "number"
},
{
"name": "maxHeadingLevel",
"description": "The maximum heading level to include in the TOC. The default value is `3`.",
"type": "number"
},
{
"name": "noIndent",
"description": "Whether to indent the TOC items.",
"type": "boolean"
},
{
"name": "header",
"description": "The header of the TOC.",
"type": "string"
},
{ "name": "activeAnchor" },
{ "name": "anchors" },
{ "name": "items" },
{
"name": "size",
"description": "The size of the toc. Default is `lg`.",
"type": "'sm' | 'lg'"
}
],
"events": [
{
"name": "dds-anchor-change",
"type": "{ selectedItem: HTMLAnchorElement, anchorElement: IntersectionObserverEntry | HTMLElement }",
"description": "Event that is triggered when the anchor changes."
}
]
}
},
{
"name": "dap-ds-toggle-button",
"description": "A toggle button is a button that can be toggled on (active) or off (inactive).\n---\n\n\n### **Slots:**\n - _default_ - The content of the toggle button.\n\n### **CSS Properties:**\n - **--dds-toggle-button-min-width-lg** - Minimum width of the large toggle button _(default: undefined)_\n- **--dds-toggle-button-min-width-md** - Minimum width of the medium toggle button _(default: undefined)_\n- **--dds-toggle-button-min-width-sm** - Minimum width of the small toggle button _(default: undefined)_\n- **--dds-toggle-button-min-width-xs** - Minimum width of the extra small toggle button _(default: undefined)_\n- **--dds-toggle-button-height-lg** - Height of the large toggle button _(default: undefined)_\n- **--dds-toggle-button-height-md** - Height of the medium toggle button _(default: undefined)_\n- **--dds-toggle-button-height-sm** - Height of the small toggle button _(default: undefined)_\n- **--dds-toggle-button-height-xs** - Height of the extra small toggle button _(default: undefined)_\n- **--dds-toggle-button-padding-lg** - Padding of the large toggle button _(default: undefined)_\n- **--dds-toggle-button-padding-md** - Padding of the medium toggle button _(default: undefined)_\n- **--dds-toggle-button-padding-sm** - Padding of the small toggle button _(default: undefined)_\n- **--dds-toggle-button-padding-xs** - Padding of the extra small toggle button _(default: undefined)_\n- **--dds-toggle-button-font-size-lg** - Font size of the large toggle button _(default: undefined)_\n- **--dds-toggle-button-font-size-md** - Font size of the medium toggle button _(default: undefined)_\n- **--dds-toggle-button-font-size-sm** - Font size of the small toggle button _(default: undefined)_\n- **--dds-toggle-button-font-size-xs** - Font size of the extra small toggle button _(default: undefined)_\n- **--dds-toggle-button-border-enabled** - Border color in enabled state _(default: undefined)_\n- **--dds-toggle-button-background-enabled** - Background color in enabled state _(default: undefined)_\n- **--dds-toggle-button-content-enabled** - Content/text color in enabled state _(default: undefined)_\n- **--dds-toggle-button-border-hover** - Border color in hover state _(default: undefined)_\n- **--dds-toggle-button-background-hover** - Background color in hover state _(default: undefined)_\n- **--dds-toggle-button-border-pressed** - Border color in pressed state _(default: undefined)_\n- **--dds-toggle-button-background-pressed** - Background color in pressed state _(default: undefined)_\n- **--dds-toggle-button-background-selected-enabled** - Background color in selected enabled state _(default: undefined)_\n- **--dds-toggle-button-content-selected-enabled** - Content/text color in selected enabled state _(default: undefined)_\n- **--dds-toggle-button-background-selected-hover** - Background color in selected hover state _(default: undefined)_\n- **--dds-toggle-button-background-selected-pressed** - Background color in selected pressed state _(default: undefined)_\n- **--dds-toggle-button-border-disabled** - Border color in disabled state _(default: undefined)_\n- **--dds-toggle-button-background-disabled** - Background color in disabled state _(default: undefined)_\n- **--dds-toggle-button-content-disabled** - Content/text color in disabled state _(default: undefined)_\n- **--dds-toggle-button-highcontrast-border** - High contrast border color _(default: undefined)_\n- **--dds-toggle-button-highcontrast-border-hover** - High contrast border color on hover _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main button container.\n- **high-contrast** - The high contrast part of the button.",
"doc-url": "",
"attributes": [
{
"name": "size",
"description": "The size of the button",
"value": {
"type": "'lg' | 'md' | 'sm' | 'xs'",
"default": "'md'"
}
},
{
"name": "active",
"description": "Whether the button is active.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "shape",
"description": "The shape of the button",
"value": { "type": "'button' | 'circle'", "default": "'button'" }
},
{
"name": "sizeChildren",
"value": { "type": "string", "default": "'true'" }
}
],
"slots": [
{ "name": "", "description": "The content of the toggle button." }
],
"events": [],
"js": {
"properties": [
{
"name": "size",
"description": "The size of the button",
"type": "'lg' | 'md' | 'sm' | 'xs'"
},
{
"name": "active",
"description": "Whether the button is active.",
"type": "boolean"
},
{
"name": "shape",
"description": "The shape of the button",
"type": "'button' | 'circle'"
},
{ "name": "sizeChildren", "type": "string" },
{ "name": "focusElement", "type": "HTMLButtonElement" }
],
"events": []
}
},
{
"name": "dap-ds-tooltip",
"description": "A tooltip is a container for tooltip content.\n---\n\n\n### **Slots:**\n - _default_ - The content of the tooltip.\n- **trigger** - The trigger element of the tooltip.\n\n### **CSS Properties:**\n - **--dds-tooltip-max-width** - The maximum width of the tooltip before its content will wrap. _(default: undefined)_\n- **--dds-tooltip-padding** - The padding inside the tooltip. _(default: undefined)_\n- **--dds-tooltip-border-color** - The border color of the tooltip. _(default: undefined)_\n- **--dds-tooltip-bg-color** - The background color of the tooltip. _(default: undefined)_\n- **--dds-tooltip-text-color** - The text color of the tooltip. _(default: undefined)_\n- **--dds-tooltip-font-size** - The font size of the tooltip text. _(default: undefined)_\n- **--dds-tooltip-box-shadow** - The box shadow of the tooltip. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main tooltip container.\n- **trigger** - The trigger element of the tooltip.\n- **popup** - The popup of the tooltip.\n- **arrow** - The arrow of the tooltip.",
"doc-url": "",
"attributes": [
{
"name": "content",
"description": "The content of the tooltip, supporting text only.",
"value": { "type": "string" }
},
{
"name": "placement",
"description": "The position of the tooltip around the trigger element.",
"value": {
"type": "'top' | 'right' | 'bottom' | 'left'",
"default": "'bottom'"
}
},
{
"name": "opened",
"description": "Sets the tooltip to opened by default (will still be closed on closing events).",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "mode",
"description": "Sets the tooltip to toggle mode.",
"value": {
"type": "'tooltip' | 'toggle'",
"default": "'tooltip'"
}
},
{
"name": "noArrow",
"description": "Hides the arrow of the tooltip.",
"value": { "type": "boolean", "default": "false" }
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the tooltip. Default is `absolute`. Can be `absolute` or `fixed`.",
"value": {
"type": "'absolute' | 'fixed'",
"default": "'absolute'"
}
},
{
"name": "trigger",
"description": "Sets custom trigger event (hover, focus, click). Default is `hover focus`.",
"value": { "type": "string" }
}
],
"slots": [
{ "name": "", "description": "The content of the tooltip." },
{
"name": "trigger",
"description": "The trigger element of the tooltip."
}
],
"events": [],
"js": {
"properties": [
{
"name": "content",
"description": "The content of the tooltip, supporting text only.",
"type": "string"
},
{
"name": "placement",
"description": "The position of the tooltip around the trigger element.",
"type": "'top' | 'right' | 'bottom' | 'left'"
},
{
"name": "opened",
"description": "Sets the tooltip to opened by default (will still be closed on closing events).",
"type": "boolean"
},
{
"name": "mode",
"description": "Sets the tooltip to toggle mode.",
"type": "'tooltip' | 'toggle'"
},
{
"name": "noArrow",
"description": "Hides the arrow of the tooltip.",
"type": "boolean"
},
{
"name": "floatingStrategy",
"description": "The floating strategy of the tooltip. Default is `absolute`. Can be `absolute` or `fixed`.",
"type": "'absolute' | 'fixed'"
},
{
"name": "trigger",
"description": "Sets custom trigger event (hover, focus, click). Default is `hover focus`."
}
],
"events": []
}
},
{
"name": "dap-ds-tray",
"description": "A tray is a container for slide in content.\n---\n\n\n### **Events:**\n - **dds-before-open** - Fires before the tray opens.\n- **dds-opened** - Fires after the tray opens.\n- **dds-before-close** - Fires before the tray closes.\n- **dds-closed** - Fires after the tray closed.\n- **dds-close** - Fires when the tray is closes. You can prevent the tray from closing by calling `event.preventDefault()`.\n\n### **Slots:**\n - _default_ - The content of the tray.\n- **header** - The header of the tray.\n- **footer** - The footer of the tray.\n\n### **CSS Properties:**\n - **--dds-modal-max-block-size** - Maximum height of the modal. Default: 80vh. _(default: undefined)_\n- **--dds-modal-max-inline-size** - Maximum width of the modal. Default: 600px. _(default: undefined)_\n- **--dds-modal-padding** - Padding inside the modal. Default: var(--dds-spacing-800). _(default: undefined)_\n- **--dds-modal-transform-amount** - Amount to transform for entrance animation. Default: 2rem. _(default: undefined)_\n- **--dds-modal-transition-speed** - Speed of transition animations. Default: var(--dds-transition-fast). _(default: undefined)_\n- **--dds-modal-transition-timing** - Timing function for transitions. Default: var(--dds-easing-ease-in-out). _(default: undefined)_\n- **--dds-modal-border-width** - Border width of the modal. Default: var(--dds-border-width-base). _(default: undefined)_\n- **--dds-modal-border-color** - Border color of the modal. Default: var(--dds-border-neutral-divider). _(default: undefined)_\n- **--dds-modal-border-radius** - Border radius of the modal. Default: var(--dds-radius-large, 16px). _(default: undefined)_\n- **--dds-modal-background** - Background color of the modal. Default: var(--dds-background-neutral-subtle). _(default: undefined)_\n- **--dds-modal-header-margin** - Margin below the header. Default: var(--dds-spacing-800). _(default: undefined)_\n- **--dds-modal-footer-margin** - Margin above the footer. Default: var(--dds-spacing-400). _(default: undefined)_\n- **--dds-modal-footer-gap** - Gap between footer elements. Default: var(--dds-spacing-400). _(default: undefined)_\n- **--dds-modal-close-margin** - Margin for the close button. Default: var(--dds-spacing-300). _(default: undefined)_\n- **--dds-tray-width-side** - Width of the side (left/right) trays. Default: 250px. _(default: undefined)_\n- **--dds-tray-min-width-horizontal** - Minimum width of the horizontal (top/bottom) trays. Default: 400px. _(default: undefined)_\n- **--dds-tray-min-height-horizontal** - Minimum height of the horizontal (top/bottom) trays. Default: 300px. _(default: undefined)_\n- **--dds-tray-min-height-vertical** - Minimum height of the vertical (left/right) trays. Default: 100%. _(default: undefined)_\n- **--dds-tray-transform-duration** - Duration of the transform animation. Default: 0.3s. _(default: undefined)_\n- **--dds-tray-transform-timing** - Timing function for the transform animation. Default: ease-in-out. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main tray container.\n- **panel** - The panel of the tray.\n- **header** - The header of the tray.\n- **footer** - The footer of the tray.\n- **body** - The body of the tray.",
"doc-url": "",
"attributes": [
{
"name": "placement",
"description": "The placement of the tray.",
"value": {
"type": "'left' | 'right' | 'top' | 'bottom'",
"default": "'bottom'"
}
}
],
"slots": [
{ "name": "", "description": "The content of the tray." },
{ "name": "header", "description": "The header of the tray." },
{ "name": "footer", "description": "The footer of the tray." }
],
"events": [
{
"name": "dds-before-open",
"type": "{ void }",
"description": "Fires before the tray opens."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fires after the tray opens."
},
{
"name": "dds-before-close",
"type": "{ void }",
"description": "Fires before the tray closes."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fires after the tray closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fires when the tray is closes. You can prevent the tray from closing by calling `event.preventDefault()`."
}
],
"js": {
"properties": [
{
"name": "placement",
"description": "The placement of the tray.",
"type": "'left' | 'right' | 'top' | 'bottom'"
},
{
"name": "footer",
"description": "Whether the tray should have a footer. Default is false.",
"type": "string"
},
{
"name": "header",
"description": "Whether the tray should have a header. Default is false.",
"type": "string"
},
{
"name": "open",
"description": "The open state of the tray.",
"type": "boolean"
},
{
"name": "closeOnEsc",
"description": "Whether the tray should close on pressing the escape key. Default is true.",
"type": "boolean"
},
{
"name": "closeOnOverlayClick",
"description": "Whether the tray should close on clicking the overlay. Default is true.",
"type": "boolean"
},
{
"name": "closeButton",
"description": "Whether the tray should have a close button. Default is true.",
"type": "string"
},
{
"name": "title",
"description": "The title of the tray.",
"type": "string"
},
{
"name": "description",
"description": "The description of the tray.",
"type": "string"
},
{
"name": "okButtonLabel",
"description": "The label of the OK button.",
"type": "string"
},
{
"name": "cancelButtonLabel",
"description": "The label of the Cancel button.",
"type": "string"
}
],
"events": [
{
"name": "dds-before-open",
"type": "{ void }",
"description": "Fires before the tray opens."
},
{
"name": "dds-opened",
"type": "{ void }",
"description": "Fires after the tray opens."
},
{
"name": "dds-before-close",
"type": "{ void }",
"description": "Fires before the tray closes."
},
{
"name": "dds-closed",
"type": "{ void }",
"description": "Fires after the tray closed."
},
{
"name": "dds-close",
"type": "{ void }",
"description": "Fires when the tray is closes. You can prevent the tray from closing by calling `event.preventDefault()`."
}
]
}
},
{
"name": "dap-ds-typography",
"description": "Typography is used to display text in different styles.\n---\n\n\n### **Slots:**\n - **default** - The content of the typography.\n\n### **CSS Properties:**\n - **--dds-text-color** - The color of the typography. _(default: undefined)_\n- **--dds-text-heading-color** - The color of the heading typography. _(default: undefined)_\n- **--dds-text-description-subtle** - The color of the subtle typography. _(default: undefined)_\n- **--dds-text-font-family** - The font family of the typography. _(default: undefined)_\n- **--dds-text-font-weight-medium** - The font weight of the medium typography. _(default: undefined)_\n- **--dds-text-font-weight-bold** - The font weight of the bold typography. _(default: undefined)_\n- **--dds-text-font-size-h1** - The font size of the h1 typography. _(default: undefined)_\n- **--dds-text-font-size-h2** - The font size of the h2 typography. _(default: undefined)_\n- **--dds-text-font-size-h3** - The font size of the h3 typography. _(default: undefined)_\n- **--dds-text-font-size-h4** - The font size of the h4 typography. _(default: undefined)_\n- **--dds-text-font-size-h5** - The font size of the h5 typography. _(default: undefined)_\n- **--dds-text-font-size-h6** - The font size of the h6 typography. _(default: undefined)_\n- **--dds-text-font-size-body** - The font size of the body typography. _(default: undefined)_\n- **--dds-text-font-size-caption** - The font size of the caption typography. _(default: undefined)_\n- **--dds-text-font-size-description** - The font size of the description typography. _(default: undefined)_\n- **--dds-text-font-size-description-lg** - The font size of the description lg typography. _(default: undefined)_\n- **--dds-text-font-size-description-sm** - The font size of the description sm typography. _(default: undefined)_\n- **--dds-text-font-size-lg** - The font size of the lg typography. _(default: undefined)_\n- **--dds-text-font-size-md** - The font size of the md typography. _(default: undefined)_\n- **--dds-text-font-size-sm** - The font size of the sm typography. _(default: undefined)_\n- **--dds-text-font-size-xs** - The font size of the xs typography. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main typography container.",
"doc-url": "",
"attributes": [
{
"name": "variant",
"description": "The variant of the typography.",
"value": {
"type": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'body' | 'caption' | 'description'"
}
},
{
"name": "size",
"description": "The size of the typography.",
"value": { "type": "'sm' | 'md' | 'lg'" }
},
{
"name": "bodyAs",
"description": "The html element of the body typography.",
"value": { "type": "string | undefined", "default": "'p'" }
},
{
"name": "customClass",
"description": "The custom class of the typography.",
"value": { "type": "string | undefined" }
},
{
"name": "anchor",
"description": "Whether the typography is an anchor for the TOC component.",
"value": { "type": "boolean", "default": "false" }
}
],
"slots": [
{
"name": "default",
"description": "The content of the typography."
}
],
"events": [],
"js": {
"properties": [
{
"name": "variant",
"description": "The variant of the typography.",
"type": "'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'body' | 'caption' | 'description'"
},
{
"name": "size",
"description": "The size of the typography.",
"type": "'sm' | 'md' | 'lg'"
},
{
"name": "bodyAs",
"description": "The html element of the body typography.",
"type": "string | undefined"
},
{
"name": "customClass",
"description": "The custom class of the typography.",
"type": "string | undefined"
},
{
"name": "anchor",
"description": "Whether the typography is an anchor for the TOC component.",
"type": "boolean"
}
],
"events": []
}
},
{
"name": "dap-ds-form-label",
"description": "A form label is a container for labels in a form.\n---\n\n\n### **CSS Properties:**\n - **--dds-form-label-font-weight** - Font weight of the label. Defaults to var(--dds-font-weight-bold). _(default: undefined)_\n- **--dds-form-label-line-height** - Line height of the label. Defaults to var(--dds-font-line-height-xlarge). _(default: undefined)_\n- **--dds-form-label-color** - Text color of the label. Defaults to var(--dds-text-neutral-enabled). _(default: undefined)_\n- **--dds-form-label-disabled-color** - Text color when the label is disabled. Defaults to var(--dds-text-neutral-disabled). _(default: undefined)_\n- **--dds-form-label-required-color** - Color of the required indicator. Defaults to var(--dds-text-negative-subtle). _(default: undefined)_\n- **--dds-form-label-optional-color** - Color of the optional indicator. Defaults to var(--dds-text-neutral-subtle). _(default: undefined)_\n- **--dds-form-label-margin-bottom** - Bottom margin of the label. Defaults to var(--dds-spacing-200). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The main form label container.\n- **required** - The required indicator of the form label.\n- **optional** - The optional indicator of the form label.",
"doc-url": "",
"attributes": [
{
"name": "for",
"description": "The id of the form element that the label is associated with.",
"value": { "type": "string | undefined" }
},
{
"name": "renderAs",
"description": "Whether the label should be rendered as text or a