@solid-design-system/components 2.5.0 → 2.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/es/solid-components2.js +1 -1
- package/dist/components/es/solid-element.js +5 -5
- package/dist/components/es/tab-group.js +1 -0
- package/dist/components/es/tab-panel.js +1 -0
- package/dist/components/es/tab.js +1 -0
- package/dist/components/umd/solid-components.js +18 -18
- package/dist/custom-elements.json +1 -1
- package/dist/package/components/tab/tab.d.ts +22 -0
- package/dist/package/components/tab/tab.js +94 -0
- package/dist/package/components/tab-group/tab-group.d.ts +40 -0
- package/dist/package/components/tab-group/tab-group.js +249 -0
- package/dist/package/components/tab-panel/tab-panel.d.ts +16 -0
- package/dist/package/components/tab-panel/tab-panel.js +59 -0
- package/dist/package/solid-components.d.ts +3 -0
- package/dist/package/solid-components.js +18 -12
- package/dist/package/styles/tailwind.css.js +1 -1
- package/dist/versioned-components/es/accordion-group.js +1 -1
- package/dist/versioned-components/es/accordion.js +1 -1
- package/dist/versioned-components/es/badge.js +1 -1
- package/dist/versioned-components/es/brandshape.js +1 -1
- package/dist/versioned-components/es/button.js +1 -1
- package/dist/versioned-components/es/carousel-item.js +1 -1
- package/dist/versioned-components/es/carousel.js +3 -3
- package/dist/versioned-components/es/checkbox-group.js +1 -1
- package/dist/versioned-components/es/checkbox.js +1 -1
- package/dist/versioned-components/es/dialog.js +1 -1
- package/dist/versioned-components/es/divider.js +1 -1
- package/dist/versioned-components/es/drawer.js +1 -1
- package/dist/versioned-components/es/dropdown.js +1 -1
- package/dist/versioned-components/es/form.js +1 -1
- package/dist/versioned-components/es/header.js +1 -1
- package/dist/versioned-components/es/icon.js +1 -1
- package/dist/versioned-components/es/include.js +1 -1
- package/dist/versioned-components/es/input.js +1 -1
- package/dist/versioned-components/es/link.js +1 -1
- package/dist/versioned-components/es/navigation-item.js +1 -1
- package/dist/versioned-components/es/notification.js +1 -1
- package/dist/versioned-components/es/option.js +1 -1
- package/dist/versioned-components/es/popup.js +1 -1
- package/dist/versioned-components/es/radio-button.js +1 -1
- package/dist/versioned-components/es/radio-group.js +1 -1
- package/dist/versioned-components/es/radio.js +1 -1
- package/dist/versioned-components/es/select.js +3 -3
- package/dist/versioned-components/es/solid-components2.js +1 -1
- package/dist/versioned-components/es/solid-element.js +5 -5
- package/dist/versioned-components/es/spinner.js +1 -1
- package/dist/versioned-components/es/switch.js +1 -1
- package/dist/versioned-components/es/tab-group.js +1 -0
- package/dist/versioned-components/es/tab-panel.js +1 -0
- package/dist/versioned-components/es/tab.js +1 -0
- package/dist/versioned-components/es/tag.js +1 -1
- package/dist/versioned-components/es/teaser-media.js +1 -1
- package/dist/versioned-components/es/teaser.js +1 -1
- package/dist/versioned-components/es/textarea.js +1 -1
- package/dist/versioned-components/es/tooltip.js +2 -2
- package/dist/versioned-components/es/video.js +1 -1
- package/dist/versioned-package/_components/button-group/button-group.d.ts +1 -1
- package/dist/versioned-package/_components/button-group/button-group.js +11 -11
- package/dist/versioned-package/components/accordion/accordion.d.ts +1 -1
- package/dist/versioned-package/components/accordion/accordion.js +2 -2
- package/dist/versioned-package/components/accordion-group/accordion-group.d.ts +1 -1
- package/dist/versioned-package/components/accordion-group/accordion-group.js +3 -3
- package/dist/versioned-package/components/badge/badge.d.ts +1 -1
- package/dist/versioned-package/components/badge/badge.js +1 -1
- package/dist/versioned-package/components/brandshape/brandshape.d.ts +1 -1
- package/dist/versioned-package/components/brandshape/brandshape.js +1 -1
- package/dist/versioned-package/components/button/button.d.ts +1 -1
- package/dist/versioned-package/components/button/button.js +4 -4
- package/dist/versioned-package/components/carousel/carousel.d.ts +1 -1
- package/dist/versioned-package/components/carousel/carousel.js +6 -6
- package/dist/versioned-package/components/carousel-item/carousel-item.d.ts +1 -1
- package/dist/versioned-package/components/carousel-item/carousel-item.js +1 -1
- package/dist/versioned-package/components/checkbox/checkbox.d.ts +1 -1
- package/dist/versioned-package/components/checkbox/checkbox.js +4 -4
- package/dist/versioned-package/components/checkbox-group/checkbox-group.d.ts +1 -1
- package/dist/versioned-package/components/checkbox-group/checkbox-group.js +5 -5
- package/dist/versioned-package/components/dialog/dialog.d.ts +1 -1
- package/dist/versioned-package/components/dialog/dialog.js +2 -2
- package/dist/versioned-package/components/divider/divider.d.ts +1 -1
- package/dist/versioned-package/components/divider/divider.js +2 -2
- package/dist/versioned-package/components/drawer/drawer.d.ts +1 -1
- package/dist/versioned-package/components/drawer/drawer.js +2 -2
- package/dist/versioned-package/components/dropdown/dropdown.d.ts +1 -1
- package/dist/versioned-package/components/dropdown/dropdown.js +8 -8
- package/dist/versioned-package/components/header/header.d.ts +1 -1
- package/dist/versioned-package/components/header/header.js +4 -4
- package/dist/versioned-package/components/icon/icon.d.ts +1 -1
- package/dist/versioned-package/components/icon/icon.js +1 -1
- package/dist/versioned-package/components/include/include.d.ts +1 -1
- package/dist/versioned-package/components/include/include.js +1 -1
- package/dist/versioned-package/components/input/input.d.ts +1 -1
- package/dist/versioned-package/components/input/input.js +4 -4
- package/dist/versioned-package/components/link/link.d.ts +1 -1
- package/dist/versioned-package/components/link/link.js +2 -2
- package/dist/versioned-package/components/navigation-item/navigation-item.d.ts +1 -1
- package/dist/versioned-package/components/navigation-item/navigation-item.js +3 -3
- package/dist/versioned-package/components/notification/notification.d.ts +1 -1
- package/dist/versioned-package/components/notification/notification.js +5 -5
- package/dist/versioned-package/components/option/option.d.ts +1 -1
- package/dist/versioned-package/components/option/option.js +2 -2
- package/dist/versioned-package/components/popup/popup.d.ts +1 -1
- package/dist/versioned-package/components/popup/popup.js +1 -1
- package/dist/versioned-package/components/radio/radio.d.ts +1 -1
- package/dist/versioned-package/components/radio/radio.js +2 -2
- package/dist/versioned-package/components/radio-button/radio-button.d.ts +1 -1
- package/dist/versioned-package/components/radio-button/radio-button.js +2 -2
- package/dist/versioned-package/components/radio-group/radio-group.d.ts +2 -2
- package/dist/versioned-package/components/radio-group/radio-group.js +15 -15
- package/dist/versioned-package/components/select/select.d.ts +4 -4
- package/dist/versioned-package/components/select/select.js +28 -28
- package/dist/versioned-package/components/spinner/spinner.d.ts +1 -1
- package/dist/versioned-package/components/spinner/spinner.js +1 -1
- package/dist/versioned-package/components/switch/switch.d.ts +1 -1
- package/dist/versioned-package/components/switch/switch.js +2 -2
- package/dist/versioned-package/components/tab/tab.d.ts +22 -0
- package/dist/versioned-package/components/tab/tab.js +94 -0
- package/dist/versioned-package/components/tab-group/tab-group.d.ts +40 -0
- package/dist/versioned-package/components/tab-group/tab-group.js +249 -0
- package/dist/versioned-package/components/tab-panel/tab-panel.d.ts +16 -0
- package/dist/versioned-package/components/tab-panel/tab-panel.js +59 -0
- package/dist/versioned-package/components/tag/tag.d.ts +1 -1
- package/dist/versioned-package/components/tag/tag.js +2 -2
- package/dist/versioned-package/components/teaser/teaser.js +1 -1
- package/dist/versioned-package/components/teaser-media/teaser-media.js +1 -1
- package/dist/versioned-package/components/textarea/textarea.d.ts +1 -1
- package/dist/versioned-package/components/textarea/textarea.js +3 -3
- package/dist/versioned-package/components/tooltip/tooltip.d.ts +1 -1
- package/dist/versioned-package/components/tooltip/tooltip.js +5 -5
- package/dist/versioned-package/components/video/video.d.ts +1 -1
- package/dist/versioned-package/components/video/video.js +2 -2
- package/dist/versioned-package/internal/form.js +3 -3
- package/dist/versioned-package/solid-components.d.ts +3 -0
- package/dist/versioned-package/solid-components.js +18 -12
- package/dist/versioned-package/styles/headline/headline.css.js +1 -1
- package/dist/versioned-package/styles/tailwind.css.js +1 -1
- package/dist/versioned-styles/solid-styles.css +1 -1
- package/dist/vscode.html-custom-data.json +174 -34
- package/dist/web-types.json +573 -35
- package/package.json +3 -3
|
@@ -1755,6 +1755,76 @@
|
|
|
1755
1755
|
],
|
|
1756
1756
|
"references": []
|
|
1757
1757
|
},
|
|
1758
|
+
{
|
|
1759
|
+
"name": "sd-tab-group",
|
|
1760
|
+
"description": "Tab groups organize content into a container that shows one section at a time.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-tab-show** - Emitted when a tab is shown.\n- **sd-tab-hide** - Emitted when a tab is hidden.\n\n### **Methods:**\n - **setActiveTab(tab: _SdTab_, options: _{ emitEvents?: boolean; scrollBehavior?: 'auto' | 'smooth' }_)** - Sets the active tab and panel.\n- **show(panel: _string_)** - Shows the specified tab panel.\n\n### **Slots:**\n - _default_ - Used for grouping tab panels in the tab group. Must be `<sd-tab-panel>` elements.\n- **nav** - Used for grouping tabs in the tab group. Must be `<sd-tab>` elements.\n\n### **CSS Properties:**\n - **--track-color** - The color of the indicator's track (the line that separates tabs from panels). _(default: undefined)_\n- **--track-width** - The width of the indicator's track (the line that separates tabs from panels). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **nav** - The tab group's navigation container where tabs are slotted in.\n- **scroll-container** - The container that wraps the tabs and active-tab-indicator.\n- **tabs** - The container that wraps the tabs.\n- **separation** - The line that separates tabs from panels.\n- **body** - The tab group's body where tab panels are slotted in.\n- **scroll-button--start** - The starting scroll button.\n- **scroll-button--end** - The ending scroll button.\n- **scroll-button__base** - The scroll button's exported `base` part.",
|
|
1761
|
+
"attributes": [
|
|
1762
|
+
{
|
|
1763
|
+
"name": "activation",
|
|
1764
|
+
"description": "When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel. When set to\nmanual, the tab will receive focus but will not show until the user presses spacebar or enter.",
|
|
1765
|
+
"values": [
|
|
1766
|
+
{
|
|
1767
|
+
"name": "auto"
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
"name": "manual"
|
|
1771
|
+
}
|
|
1772
|
+
]
|
|
1773
|
+
}
|
|
1774
|
+
],
|
|
1775
|
+
"references": []
|
|
1776
|
+
},
|
|
1777
|
+
{
|
|
1778
|
+
"name": "sd-tab-panel",
|
|
1779
|
+
"description": "Tab panels are used inside [tab groups](/components/tab-group) to display tabbed content.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The tab panel's content.\n\n### **CSS Properties:**\n - **--padding** - The tab panel's padding. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
1780
|
+
"attributes": [
|
|
1781
|
+
{
|
|
1782
|
+
"name": "name",
|
|
1783
|
+
"description": "The tab panel's name.",
|
|
1784
|
+
"values": []
|
|
1785
|
+
},
|
|
1786
|
+
{
|
|
1787
|
+
"name": "active",
|
|
1788
|
+
"description": "When true, the tab panel will be shown.",
|
|
1789
|
+
"values": []
|
|
1790
|
+
}
|
|
1791
|
+
],
|
|
1792
|
+
"references": []
|
|
1793
|
+
},
|
|
1794
|
+
{
|
|
1795
|
+
"name": "sd-tab",
|
|
1796
|
+
"description": "Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).\n\n\n---\n\n\n\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus to the tab.\n- **blur()** - Removes focus from the tab.\n\n### **Slots:**\n - _default_ - The tab's label.\n- **left** - Optional element (eg. icon) positioned to the left of the label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **active-tab-indicator** - The active tab indicator.",
|
|
1797
|
+
"attributes": [
|
|
1798
|
+
{
|
|
1799
|
+
"name": "panel",
|
|
1800
|
+
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
|
1801
|
+
"values": []
|
|
1802
|
+
},
|
|
1803
|
+
{
|
|
1804
|
+
"name": "variant",
|
|
1805
|
+
"description": "When set to container, a border appears around the current tab and tab-panel.",
|
|
1806
|
+
"values": [
|
|
1807
|
+
{
|
|
1808
|
+
"name": "default"
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
"name": "container"
|
|
1812
|
+
}
|
|
1813
|
+
]
|
|
1814
|
+
},
|
|
1815
|
+
{
|
|
1816
|
+
"name": "active",
|
|
1817
|
+
"description": "Draws the tab in an active state.",
|
|
1818
|
+
"values": []
|
|
1819
|
+
},
|
|
1820
|
+
{
|
|
1821
|
+
"name": "disabled",
|
|
1822
|
+
"description": "Disables the tab and prevents selection.",
|
|
1823
|
+
"values": []
|
|
1824
|
+
}
|
|
1825
|
+
],
|
|
1826
|
+
"references": []
|
|
1827
|
+
},
|
|
1758
1828
|
{
|
|
1759
1829
|
"name": "sd-tag",
|
|
1760
1830
|
"description": "Tags are used as labels to organize things or to indicate a selection.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the tag loses focus.\n- **sd-focus** - Emitted when the tag gains focus.\n- **sd-remove** - Emitted when the remove button is activated.\n\n### **Methods:**\n - **click()** - Simulates a click on the tag.\n- **focus(options: _FocusOptions_)** - Sets focus on the tag.\n- **blur()** - Removes focus from the tag.\n\n### **Slots:**\n - _default_ - The tag's content.\n- **removable-indicator** - The tag's removability indicator.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **content** - The tag's content.\n- **removable-indicator** - The tag's removability indicator.",
|
|
@@ -2157,7 +2227,7 @@
|
|
|
2157
2227
|
"references": []
|
|
2158
2228
|
},
|
|
2159
2229
|
{
|
|
2160
|
-
"name": "sd-2-
|
|
2230
|
+
"name": "sd-2-6-0-accordion-group",
|
|
2161
2231
|
"description": "Short summary of the component's intended use.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The default slot where `<sd-accordion>` elements are placed.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
2162
2232
|
"attributes": [
|
|
2163
2233
|
{
|
|
@@ -2169,7 +2239,7 @@
|
|
|
2169
2239
|
"references": []
|
|
2170
2240
|
},
|
|
2171
2241
|
{
|
|
2172
|
-
"name": "sd-2-
|
|
2242
|
+
"name": "sd-2-6-0-accordion",
|
|
2173
2243
|
"description": "Accordion shows a brief summary and expands to show additional content.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the accordion opens.\n- **sd-after-show** - Emitted after the accordion opens and all animations are complete.\n- **sd-hide** - Emitted when the accordion closes.\n- **sd-after-hide** - Emitted after the accordion closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the accordion.\n- **hide()** - Hides the accordion\n\n### **Slots:**\n - _default_ - The accordion main content.\n- **summary** - The accordion summary. Alternatively, you can use the `summary` attribute.\n- **expand-icon** - Optional expand icon to use instead of the default. Works best with `<sd-icon>`.\n- **collapse-icon** - Optional collapse icon to use instead of the default. Works best with `<sd-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **header** - The header that wraps both the summary and the expand/collapse icon.\n- **summary** - The container that wraps the summary.\n- **summary-icon** - The container that wraps the expand/collapse icons.\n- **summary-border** - The container that wraps the currently active accordions border.\n- **content** - The container that wraps the accordion content slot.\n- **content__slot** - The accordion content slot.",
|
|
2174
2244
|
"attributes": [
|
|
2175
2245
|
{
|
|
@@ -2186,7 +2256,7 @@
|
|
|
2186
2256
|
"references": []
|
|
2187
2257
|
},
|
|
2188
2258
|
{
|
|
2189
|
-
"name": "sd-2-
|
|
2259
|
+
"name": "sd-2-6-0-badge",
|
|
2190
2260
|
"description": "Badges are used to draw attention and display statuses or counts.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The badge's content.\n\n### **CSS Parts:**\n - **base** - The badge's base wrapper.\n- **content** - The badge's main content.",
|
|
2191
2261
|
"attributes": [
|
|
2192
2262
|
{
|
|
@@ -2228,7 +2298,7 @@
|
|
|
2228
2298
|
"references": []
|
|
2229
2299
|
},
|
|
2230
2300
|
{
|
|
2231
|
-
"name": "sd-2-
|
|
2301
|
+
"name": "sd-2-6-0-brandshape",
|
|
2232
2302
|
"description": "The Brandshape highlights a piece of content.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The content inside the brandshape.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **content** - Middle content wrapper.\n- **shape-top** - Top shape.\n- **shape-middle** - Middle shape.\n- **shape-bottom** - Bottom shape.",
|
|
2233
2303
|
"attributes": [
|
|
2234
2304
|
{
|
|
@@ -2265,7 +2335,7 @@
|
|
|
2265
2335
|
"references": []
|
|
2266
2336
|
},
|
|
2267
2337
|
{
|
|
2268
|
-
"name": "sd-2-
|
|
2338
|
+
"name": "sd-2-6-0-button",
|
|
2269
2339
|
"description": "Buttons represent actions that are available to the user.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the button loses focus.\n- **sd-focus** - Emitted when the button gains focus.\n- **sd-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **click()** - Simulates a click on the button.\n- **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n- **checkValidity()** - Checks for validity but does not show the browser's validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The button's label.\n- **icon-left** - A prefix icon or similar element.\n- **icon-right** - A suffix icon or similar element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon-left** - The container that wraps the left icon area.\n- **label** - The button's label.\n- **icon-right** - The container that wraps the right icon area.",
|
|
2270
2340
|
"attributes": [
|
|
2271
2341
|
{
|
|
@@ -2437,13 +2507,13 @@
|
|
|
2437
2507
|
"references": []
|
|
2438
2508
|
},
|
|
2439
2509
|
{
|
|
2440
|
-
"name": "sd-2-
|
|
2510
|
+
"name": "sd-2-6-0-carousel-item",
|
|
2441
2511
|
"description": "A carousel item represent a slide within a [carousel](/components/carousel).\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The carousel item's content.",
|
|
2442
2512
|
"attributes": [],
|
|
2443
2513
|
"references": []
|
|
2444
2514
|
},
|
|
2445
2515
|
{
|
|
2446
|
-
"name": "sd-2-
|
|
2516
|
+
"name": "sd-2-6-0-carousel",
|
|
2447
2517
|
"description": "Carousels display an arbitrary number of content slides along a horizontal axis.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-slide-change** - Emitted when the active slide changes.\n\n### **Methods:**\n - **previous(behavior: _ScrollBehavior_)** - Move the carousel backward by `slides-per-move` slides.\n- **next(behavior: _ScrollBehavior_)** - Move the carousel forward by `slides-per-move` slides.\n- **goToSlide(index: _number_, behavior: _ScrollBehavior_)** - Scrolls the carousel to the slide specified by `index`.\n\n### **Slots:**\n - _default_ - The carousel's main content, one or more `<sd-carousel-item>` elements.\n- **next-icon** - Optional next icon to use instead of the default. Works best with `<sd-icon>`.\n- **previous-icon** - Optional previous icon to use instead of the default. Works best with `<sd-icon>`.\n- **autoplay-start** - Optional start icon to use instead of the default. Works best with `<sd-icon>`.\n- **autoplay-pause** - Optional pause icon to use instead of the default. Works best with `<sd-icon>`.\n\n### **CSS Properties:**\n - **--slide-gap** - The space between each slide. _(default: undefined)_\n- **--scroll-hint** - The amount of padding to apply to the scroll area, allowing adjacent slides to become partially visible as a scroll hint. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The carousel's internal wrapper.\n- **scroll-container** - The scroll container that wraps the slides.\n- **controls** - A wrapper for the navigation and autoplay controller buttons.\n- **pagination-dot** - The pagination indicator in dot format.\n- **pagination-number** - The pagination indicator in number format.\n- **pagination-item** - The pagination indicator.\n- **pagination-item--active** - Applied when the item is active.\n- **navigation** - The navigation wrapper.\n- **navigation-button** - The navigation button.\n- **navigation-button--previous** - Applied to the previous button.\n- **navigation-button--next** - Applied to the next button.\n- **autoplay-controls** - A wrapper for pause/start button.",
|
|
2448
2518
|
"attributes": [
|
|
2449
2519
|
{
|
|
@@ -2487,7 +2557,7 @@
|
|
|
2487
2557
|
"references": []
|
|
2488
2558
|
},
|
|
2489
2559
|
{
|
|
2490
|
-
"name": "sd-2-
|
|
2560
|
+
"name": "sd-2-6-0-checkbox-group",
|
|
2491
2561
|
"description": "Checkbox groups are used to group multiple [checkbox](/components/checkbox). It provides only presentational functionality.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The default slot where `<sd-checkbox>` elements are placed.\n- **label** - The checkbox group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute.",
|
|
2492
2562
|
"attributes": [
|
|
2493
2563
|
{
|
|
@@ -2523,7 +2593,7 @@
|
|
|
2523
2593
|
"references": []
|
|
2524
2594
|
},
|
|
2525
2595
|
{
|
|
2526
|
-
"name": "sd-2-
|
|
2596
|
+
"name": "sd-2-6-0-checkbox",
|
|
2527
2597
|
"description": "Checkboxes allow the user to toggle an option on or off.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the checkbox loses focus.\n- **sd-change** - Emitted when the checked state changes.\n- **sd-focus** - Emitted when the checkbox gains focus.\n- **sd-input** - Emitted when the checkbox receives input.\n\n### **Methods:**\n - **click()** - Simulates a click on the checkbox.\n- **focus(options: _FocusOptions_)** - Sets focus on the checkbox.\n- **blur()** - Removes focus from the checkbox.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns true when valid and false when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows a validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. The value provided will be shown to the user when the form is submitted. To clear\nthe custom validation message, call this method with an empty string.\n\n### **Slots:**\n - _default_ - The checkbox's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The square container that wraps the checkbox's checked state.\n- **control--checked** - Matches the control part when the checkbox is checked.\n- **control--indeterminate** - Matches the control part when the checkbox is indeterminate.\n- **checked-icon** - The checked icon, an `<sd-icon>` element.\n- **indeterminate-icon** - The indeterminate icon, an `<sd-icon>` element.\n- **label** - The container that wraps the checkbox's label.",
|
|
2528
2598
|
"attributes": [
|
|
2529
2599
|
{
|
|
@@ -2581,7 +2651,7 @@
|
|
|
2581
2651
|
"references": []
|
|
2582
2652
|
},
|
|
2583
2653
|
{
|
|
2584
|
-
"name": "sd-2-
|
|
2654
|
+
"name": "sd-2-6-0-dialog",
|
|
2585
2655
|
"description": "Dialogs, sometimes called \"modals\", appear above the page and require the user's immediate attention.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the dialog opens.\n- **sd-after-show** - Emitted after the dialog opens and all animations are complete.\n- **sd-hide** - Emitted when the dialog closes.\n- **sd-after-hide** - Emitted after the dialog closes and all animations are complete.\n- **sd-initial-focus** - Emitted when the dialog opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.\n- **sd-request-close** - Emitted when the user attempts to close the dialog by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the dialog open. Avoid using this unless closing the dialog will result in destructive behavior such as data loss.\n\n### **Methods:**\n - **show()** - Shows the dialog.\n- **hide()** - Hides the dialog\n\n### **Slots:**\n - _default_ - The dialog's main content.\n- **headline** - The dialog's headline. Alternatively, you can use the `headline` attribute.\n- **footer** - The dialog's footer, usually one or more buttons representing various options.\n- **close-button** - The dialog's close button. Works best with `<sd-button>` and `<sd-icon>`.\n\n### **CSS Properties:**\n - **--width** - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **overlay** - The overlay that covers the screen behind the dialog.\n- **panel** - The dialog's panel (where the dialog and its content are rendered).\n- **header** - The dialog's header. This element wraps the title and header actions.\n- **title** - The dialog's title.\n- **close-button** - The close button, an `<sd-button>`.\n- **body** - The dialog's body.\n- **footer** - The dialog's footer.",
|
|
2586
2656
|
"attributes": [
|
|
2587
2657
|
{
|
|
@@ -2603,7 +2673,7 @@
|
|
|
2603
2673
|
"references": []
|
|
2604
2674
|
},
|
|
2605
2675
|
{
|
|
2606
|
-
"name": "sd-2-
|
|
2676
|
+
"name": "sd-2-6-0-divider",
|
|
2607
2677
|
"description": "Dividers are used to visually separate or group elements.\n\n\n---\n\n\n",
|
|
2608
2678
|
"attributes": [
|
|
2609
2679
|
{
|
|
@@ -2627,7 +2697,7 @@
|
|
|
2627
2697
|
"references": []
|
|
2628
2698
|
},
|
|
2629
2699
|
{
|
|
2630
|
-
"name": "sd-2-
|
|
2700
|
+
"name": "sd-2-6-0-drawer",
|
|
2631
2701
|
"description": "Drawers slide in from a container to expose additional options and information.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the drawer opens.\n- **sd-after-show** - Emitted after the drawer opens and all animations are complete.\n- **sd-hide** - Emitted when the drawer closes.\n- **sd-after-hide** - Emitted after the drawer closes and all animations are complete.\n- **sd-initial-focus** - Emitted when the drawer opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.\n- **sd-request-close** - Emitted when the user attempts to close the drawer by clicking the close button, clicking the overlay, or pressing escape. Calling `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in destructive behavior such as data loss.\n\n### **Methods:**\n - **show()** - Shows the drawer.\n- **hide()** - Hides the drawer\n\n### **Slots:**\n - _default_ - The drawer's main content.\n- **header** - The drawer's header, usually a title.\n- **footer** - The drawer's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--width** - The preferred width of the drawer. depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **overlay** - The overlay that covers the screen behind the drawer.\n- **panel** - The drawer's panel (where the drawer and its content are rendered).\n- **header** - The drawer's header. This element wraps the title and the close-button.\n- **title** - The drawer's title.\n- **close-button** - The close button, an `<sd-button>`.\n- **body** - The drawer's body.\n- **footer** - The drawer's footer.",
|
|
2632
2702
|
"attributes": [
|
|
2633
2703
|
{
|
|
@@ -2666,7 +2736,7 @@
|
|
|
2666
2736
|
"references": []
|
|
2667
2737
|
},
|
|
2668
2738
|
{
|
|
2669
|
-
"name": "sd-2-
|
|
2739
|
+
"name": "sd-2-6-0-dropdown",
|
|
2670
2740
|
"description": "Dropdowns expose additional content that \"drops down\" in a panel.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the dropdown opens.\n- **sd-after-show** - Emitted after the dropdown opens and all animations are complete.\n- **sd-hide** - Emitted when the dropdown closes.\n- **sd-after-hide** - Emitted after the dropdown closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the dropdown panel.\n- **hide()** - Hides the dropdown panel\n- **reposition()** - Instructs the dropdown menu to reposition. Useful when the position or size of the trigger changes when the menu\nis activated.\n\n### **Slots:**\n - _default_ - The dropdown's main content.\n- **trigger** - The dropdown's trigger, usually a `<sd-button>` element.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **trigger** - The container that wraps the trigger.\n- **panel** - The panel that gets shown when the dropdown is open.",
|
|
2671
2741
|
"attributes": [
|
|
2672
2742
|
{
|
|
@@ -2763,7 +2833,7 @@
|
|
|
2763
2833
|
"references": []
|
|
2764
2834
|
},
|
|
2765
2835
|
{
|
|
2766
|
-
"name": "sd-2-
|
|
2836
|
+
"name": "sd-2-6-0-header",
|
|
2767
2837
|
"description": "Header\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The header's default content.\n\n### **CSS Properties:**\n - **--sd-header-inner-width** - width of the header content _(default: undefined)_\n- **--sd-header-inner-max-width** - max-width of the header content _(default: undefined)_\n- **--sd-header-padding** - padding-left and padding-right of the header content _(default: undefined)_\n\n### **CSS Parts:**\n - **main** - The container that wraps the header's content.",
|
|
2768
2838
|
"attributes": [
|
|
2769
2839
|
{
|
|
@@ -2775,7 +2845,7 @@
|
|
|
2775
2845
|
"references": []
|
|
2776
2846
|
},
|
|
2777
2847
|
{
|
|
2778
|
-
"name": "sd-2-
|
|
2848
|
+
"name": "sd-2-6-0-icon",
|
|
2779
2849
|
"description": "Icons are symbols that can be used to represent various options within an application.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-load** - Emitted when the icon has loaded.\n- **sd-error** - Emitted when the icon fails to load due to an error.",
|
|
2780
2850
|
"attributes": [
|
|
2781
2851
|
{
|
|
@@ -2817,7 +2887,7 @@
|
|
|
2817
2887
|
"references": []
|
|
2818
2888
|
},
|
|
2819
2889
|
{
|
|
2820
|
-
"name": "sd-2-
|
|
2890
|
+
"name": "sd-2-6-0-include",
|
|
2821
2891
|
"description": "Includes give you the power to embed external HTML files into the page.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-load** - Emitted when the included file is loaded.\n- **sd-error** - Emitted when the included file fails to load due to an error.",
|
|
2822
2892
|
"attributes": [
|
|
2823
2893
|
{
|
|
@@ -2849,7 +2919,7 @@
|
|
|
2849
2919
|
"references": []
|
|
2850
2920
|
},
|
|
2851
2921
|
{
|
|
2852
|
-
"name": "sd-2-
|
|
2922
|
+
"name": "sd-2-6-0-input",
|
|
2853
2923
|
"description": "Inputs collect data from the user.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the control loses focus.\n- **sd-change** - Emitted when an alteration to the control's value is committed by the user.\n- **sd-clear** - Emitted when the clear button is activated.\n- **sd-focus** - Emitted when the control gains focus.\n- **sd-input** - Emitted when the control receives input.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the input.\n- **blur()** - Removes focus from the input.\n- **select()** - Selects all the text in the input.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n- **showPicker()** - Displays the browser picker for an input element (only works if the browser supports it for the input type).\n- **stepUp()** - Increments the value of a numeric input type by the value of the step attribute.\n- **stepDown()** - Decrements the value of a numeric input type by the value of the step attribute.\n- **checkValidity()** - Checks for validity but does not show the browser's validation message.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **left** - Used to prepend a presentational icon or similar element to the input.\n- **right** - Used to append a presentational icon or similar element to the input.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **show-password-icon** - An icon to use in lieu of the default show password icon.\n- **hide-password-icon** - An icon to use in lieu of the default hide password icon.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **border** - The base part's absolutely positioned border. Allows for easy adjustment of border thickness without affecting component dimensions.\n- **input** - The internal `<input>` control.\n- **left** - The container that wraps the left.\n- **clear-button** - The clear button.\n- **password-toggle-button** - The password toggle button.\n- **right** - The container that wraps the right.\n- **invalid-icon** - The invalid icon.\n- **valid-icon** - The valid icon.\n- **invalid-message** - The invalid message.",
|
|
2854
2924
|
"attributes": [
|
|
2855
2925
|
{
|
|
@@ -3127,7 +3197,7 @@
|
|
|
3127
3197
|
"references": []
|
|
3128
3198
|
},
|
|
3129
3199
|
{
|
|
3130
|
-
"name": "sd-2-
|
|
3200
|
+
"name": "sd-2-6-0-link",
|
|
3131
3201
|
"description": "A link component.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the link loses focus.\n- **sd-focus** - Emitted when the link gains focus.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the button.\n- **blur()** - Removes focus from the button.\n\n### **Slots:**\n - _default_ - The default slot.\n- **icon-left** - The icon to display on the left side of the link.\n- **icon-right** - The icon to display on the right side of the link.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon-left** - The container that wraps the left icon area.\n- **label** - The link's label.\n- **icon-right** - The container that wraps the right icon area.",
|
|
3132
3202
|
"attributes": [
|
|
3133
3203
|
{
|
|
@@ -3187,7 +3257,7 @@
|
|
|
3187
3257
|
"references": []
|
|
3188
3258
|
},
|
|
3189
3259
|
{
|
|
3190
|
-
"name": "sd-2-
|
|
3260
|
+
"name": "sd-2-6-0-navigation-item",
|
|
3191
3261
|
"description": "Flexible button / link component that can be used to quickly build navigations. Takes one of 3 forms: link (overrides all other if 'href' is provided), button (default), or accordion (if 'children' slot defined).\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the navigation item has has children, no href, and is clicked while HTML details are hidden.\n- **sd-hide** - Emitted when the navigation item has has children, no href, and is clicked while HTML details are shown.\n\n### **Slots:**\n - _default_ - The navigation item's label.\n- **description** - *Vertical only: Slot used to provide a description for the navigation item.\n- **children** - Slot used to provide nested child navigation elements. If provided, details and summary elements will be used. A chevron will be shown on the right side regardless of the chevron property.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper including children.\n- **content-wrapper** - The component's content wrapper.\n- **content** - The component's content excluding children.\n- **chevron** - The container that wraps the chevron.\n- **description** - The component's description area below its main content.\n- **divider** - The component's optional top divider.",
|
|
3192
3262
|
"attributes": [
|
|
3193
3263
|
{
|
|
@@ -3277,7 +3347,7 @@
|
|
|
3277
3347
|
"references": []
|
|
3278
3348
|
},
|
|
3279
3349
|
{
|
|
3280
|
-
"name": "sd-2-
|
|
3350
|
+
"name": "sd-2-6-0-notification",
|
|
3281
3351
|
"description": "Alerts are used to display important messages inline or as toast notifications.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the notification opens.\n- **sd-after-show** - Emitted after the notification opens and all animations are complete.\n- **sd-hide** - Emitted when the notification closes.\n- **sd-after-hide** - Emitted after the notification closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the notification.\n- **hide()** - Hides the notification\n- **toast()** - Displays the notification as a toast notification. This will move the notification out of its position in the DOM and, when\ndismissed, it will be removed from the DOM completely. By storing a reference to the notification, you can reuse it by\ncalling this method again. The returned promise will resolve after the notification is hidden.\n\n### **Slots:**\n - _default_ - The sd-notification's main content.\n- **icon** - An icon to show in the sd-notification. Works best with `<sd-icon>`.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **icon** - The container that wraps the optional icon.\n- **content** - The container that wraps the notifications's main content and the close button.\n- **message** - The container that wraps the notifications's main content.\n- **duration-indicator__elapsed** - The current duration indicator.\n- **duration-indicator__total** - The total duration indicator.\n- **close-button** - The close button, an `<sd-icon-button>`.",
|
|
3282
3352
|
"attributes": [
|
|
3283
3353
|
{
|
|
@@ -3334,7 +3404,7 @@
|
|
|
3334
3404
|
"references": []
|
|
3335
3405
|
},
|
|
3336
3406
|
{
|
|
3337
|
-
"name": "sd-2-
|
|
3407
|
+
"name": "sd-2-6-0-option",
|
|
3338
3408
|
"description": "Options define the selectable items within various form controls such as [select](/components/select).\n\n\n---\n\n\n\n\n### **Methods:**\n - **getTextLabel()** - Returns a plain text label based on the option's content.\n\n### **Slots:**\n - _default_ - The option's label.\n- **left** - Used to prepend an icon or similar element to the menu item.\n- **right** - Used to append an icon or similar element to the menu item.\n\n### **CSS Parts:**\n - **checked-icon** - The checked icon, an `<sd-icon>` element.\n- **base** - The component's base wrapper.\n- **label** - The option's label.\n- **left** - The container that wraps the left.\n- **right** - The container that wraps the right.",
|
|
3339
3409
|
"attributes": [
|
|
3340
3410
|
{
|
|
@@ -3371,7 +3441,7 @@
|
|
|
3371
3441
|
"references": []
|
|
3372
3442
|
},
|
|
3373
3443
|
{
|
|
3374
|
-
"name": "sd-2-
|
|
3444
|
+
"name": "sd-2-6-0-popup",
|
|
3375
3445
|
"description": "Popup is a utility that lets you declaratively anchor \"popup\" containers to another element.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-reposition** - Emitted when the popup is repositioned. This event can fire a lot, so avoid putting expensive operations in your listener or consider debouncing it.\n- **sd-current-placement** - Emitted when the popup's placement changes automatically based on screen limitations.\n\n### **Methods:**\n - **reposition()** - Forces the popup to recalculate and reposition itself.\n\n### **Slots:**\n - _default_ - The popup's content.\n- **anchor** - The element the popup will be anchored to. If the anchor lives outside of the popup, you can use the `anchor` attribute or property instead.\n\n### **CSS Properties:**\n - **--arrow-size** - The size of the arrow. Note that an arrow won't be shown unless the `arrow` attribute is used. _(default: 6px)_\n- **--arrow-color** - The color of the arrow. _(default: var(--sd-color-neutral-0))_\n- **--auto-size-available-width** - A read-only custom property that determines the amount of width the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n- **--auto-size-available-height** - A read-only custom property that determines the amount of height the popup can be before overflowing. Useful for positioning child elements that need to overflow. This property is only available when using `auto-size`. _(default: undefined)_\n\n### **CSS Parts:**\n - **arrow** - The arrow's container. Avoid setting `top|bottom|left|right` properties, as these values are assigned dynamically as the popup moves. This is most useful for applying a background color to match the popup, and maybe a border or box shadow.\n- **popup** - The popup's container. Useful for setting a background color, box shadow, etc.",
|
|
3376
3446
|
"attributes": [
|
|
3377
3447
|
{
|
|
@@ -3595,7 +3665,7 @@
|
|
|
3595
3665
|
"references": []
|
|
3596
3666
|
},
|
|
3597
3667
|
{
|
|
3598
|
-
"name": "sd-2-
|
|
3668
|
+
"name": "sd-2-6-0-radio-button",
|
|
3599
3669
|
"description": "Radio buttons allow the user to select a single option from a group using a button-like control.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the button loses focus.\n- **sd-focus** - Emitted when the button gains focus.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the radio button.\n- **blur()** - Removes focus from the radio button.\n\n### **Slots:**\n - _default_ - The radio button's label.\n- **icon** - A presentational icon.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **button** - The internal `<button>` element.\n- **button--checked** - The internal button element when the radio button is checked.\n- **icon** - The container that wraps the icon.\n- **label** - The container that wraps the radio button's label.",
|
|
3600
3670
|
"attributes": [
|
|
3601
3671
|
{
|
|
@@ -3627,7 +3697,7 @@
|
|
|
3627
3697
|
"references": []
|
|
3628
3698
|
},
|
|
3629
3699
|
{
|
|
3630
|
-
"name": "sd-2-
|
|
3700
|
+
"name": "sd-2-6-0-radio-group",
|
|
3631
3701
|
"description": "Radio groups are used to group multiple [radios](/components/radio) or [radio buttons](/components/radio-button) so they function as a single form control.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-change** - Emitted when the radio group's selected value changes.\n- **sd-input** - Emitted when the radio group receives user input.\n- **sd-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus()** - Move focus to the checked radio (or the first one if none are checked)\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity(): _boolean_** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - _default_ - The default slot where `<sd-radio>` or `<sd-radio-button>` elements are placed.\n- **label** - The radio group's label. Required for proper accessibility. Alternatively, you can use the `label` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and error text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **button-group** - The button group that wraps radio buttons.\n- **button-group__base** - The button group's `base` part.",
|
|
3632
3702
|
"attributes": [
|
|
3633
3703
|
{
|
|
@@ -3688,7 +3758,7 @@
|
|
|
3688
3758
|
"references": []
|
|
3689
3759
|
},
|
|
3690
3760
|
{
|
|
3691
|
-
"name": "sd-2-
|
|
3761
|
+
"name": "sd-2-6-0-radio",
|
|
3692
3762
|
"description": "A radio allows to select only one value from a set of options. Clicking on an unchecked radio will deselect the other one(s).\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the control loses focus.\n- **sd-focus** - Emitted when the control gains focus.\n\n### **Slots:**\n - _default_ - The radio's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control--unchecked** - The radio control when the radio is unchecked.\n- **control--checked** - The radio control when the radio is checked.\n- **checked** - The dot inside the radio component when the radio is checked.\n- **label** - The container that wraps the radio's label.",
|
|
3693
3763
|
"attributes": [
|
|
3694
3764
|
{
|
|
@@ -3722,7 +3792,7 @@
|
|
|
3722
3792
|
"references": []
|
|
3723
3793
|
},
|
|
3724
3794
|
{
|
|
3725
|
-
"name": "sd-2-
|
|
3795
|
+
"name": "sd-2-6-0-select",
|
|
3726
3796
|
"description": "Selects allow you to choose items from a menu of predefined options.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-change** - Emitted when the control's value changes.\n- **sd-clear** - Emitted when the control's value is cleared.\n- **sd-input** - Emitted when the control receives input.\n- **sd-focus** - Emitted when the control gains focus.\n- **sd-blur** - Emitted when the control loses focus.\n- **sd-show** - Emitted when the select's menu opens.\n- **sd-after-show** - Emitted after the select's menu opens and all animations are complete.\n- **sd-hide** - Emitted when the select's menu closes.\n- **sd-after-hide** - Emitted after the select's menu closes and all animations are complete.\n- **sd-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **show()** - Shows the listbox.\n- **hide()** - Hides the listbox.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n- **focus(options: _FocusOptions_)** - Sets focus on the control.\n- **blur()** - Removes focus from the control.\n\n### **Slots:**\n - _default_ - The listbox options. Must be `<sd-option>` elements. You can use `<sd-divider>` to group items visually.\n- **label** - The input's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The select's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container the wraps the combobox, clear icon, and expand button.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where options are slotted.\n- **tags** - The container that houses option tags when `multiselect` is used.\n- **tag** - The individual tags that represent each multiselect option.\n- **tag__base** - The tag's base part.\n- **tag__content** - The tag's content part.\n- **tag__removable-indicator** - The tag's remove button.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
|
3727
3797
|
"attributes": [
|
|
3728
3798
|
{
|
|
@@ -3847,7 +3917,7 @@
|
|
|
3847
3917
|
"references": []
|
|
3848
3918
|
},
|
|
3849
3919
|
{
|
|
3850
|
-
"name": "sd-2-
|
|
3920
|
+
"name": "sd-2-6-0-spinner",
|
|
3851
3921
|
"description": "Spinners are used to show the progress of an indeterminate operation.\n\n\n---\n\n\n",
|
|
3852
3922
|
"attributes": [
|
|
3853
3923
|
{
|
|
@@ -3869,7 +3939,7 @@
|
|
|
3869
3939
|
"references": []
|
|
3870
3940
|
},
|
|
3871
3941
|
{
|
|
3872
|
-
"name": "sd-2-
|
|
3942
|
+
"name": "sd-2-6-0-switch",
|
|
3873
3943
|
"description": "Switches allow the user to toggle an option on or off.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the switch loses focus.\n- **sd-change** - Emitted when the checked state changes.\n- **sd-focus** - Emitted when the switch gains focus.\n- **sd-input** - Emitted when the switch receives input.\n\n### **Methods:**\n - **click()** - Simulates a click on the switch.\n- **focus(options: _FocusOptions_)** - Sets focus on the switch.\n- **blur()** - Removes focus from the switch.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns true when valid and false when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows a validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. The value provided will be shown to the user when the form is submitted. To clear\nthe custom validation message, call this method with an empty string.\n\n### **Slots:**\n - _default_ - The switch's label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **control** - The square container that wraps the switch's state.\n- **control--checked** - Matches the control part when the switch is on.\n- **control--unchecked** - Matches the control part when the switch is off.\n- **thumb** - The circle that marks the switch's state.\n- **label** - The container that wraps the switch's label.",
|
|
3874
3944
|
"attributes": [
|
|
3875
3945
|
{
|
|
@@ -3911,7 +3981,77 @@
|
|
|
3911
3981
|
"references": []
|
|
3912
3982
|
},
|
|
3913
3983
|
{
|
|
3914
|
-
"name": "sd-2-
|
|
3984
|
+
"name": "sd-2-6-0-tab-group",
|
|
3985
|
+
"description": "Tab groups organize content into a container that shows one section at a time.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-tab-show** - Emitted when a tab is shown.\n- **sd-tab-hide** - Emitted when a tab is hidden.\n\n### **Methods:**\n - **setActiveTab(tab: _SdTab_, options: _{ emitEvents?: boolean; scrollBehavior?: 'auto' | 'smooth' }_)** - Sets the active tab and panel.\n- **show(panel: _string_)** - Shows the specified tab panel.\n\n### **Slots:**\n - _default_ - Used for grouping tab panels in the tab group. Must be `<sd-tab-panel>` elements.\n- **nav** - Used for grouping tabs in the tab group. Must be `<sd-tab>` elements.\n\n### **CSS Properties:**\n - **--track-color** - The color of the indicator's track (the line that separates tabs from panels). _(default: undefined)_\n- **--track-width** - The width of the indicator's track (the line that separates tabs from panels). _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **nav** - The tab group's navigation container where tabs are slotted in.\n- **scroll-container** - The container that wraps the tabs and active-tab-indicator.\n- **tabs** - The container that wraps the tabs.\n- **separation** - The line that separates tabs from panels.\n- **body** - The tab group's body where tab panels are slotted in.\n- **scroll-button--start** - The starting scroll button.\n- **scroll-button--end** - The ending scroll button.\n- **scroll-button__base** - The scroll button's exported `base` part.",
|
|
3986
|
+
"attributes": [
|
|
3987
|
+
{
|
|
3988
|
+
"name": "activation",
|
|
3989
|
+
"description": "When set to auto, navigating tabs with the arrow keys will instantly show the corresponding tab panel. When set to\nmanual, the tab will receive focus but will not show until the user presses spacebar or enter.",
|
|
3990
|
+
"values": [
|
|
3991
|
+
{
|
|
3992
|
+
"name": "auto"
|
|
3993
|
+
},
|
|
3994
|
+
{
|
|
3995
|
+
"name": "manual"
|
|
3996
|
+
}
|
|
3997
|
+
]
|
|
3998
|
+
}
|
|
3999
|
+
],
|
|
4000
|
+
"references": []
|
|
4001
|
+
},
|
|
4002
|
+
{
|
|
4003
|
+
"name": "sd-2-6-0-tab-panel",
|
|
4004
|
+
"description": "Tab panels are used inside [tab groups](/components/tab-group) to display tabbed content.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The tab panel's content.\n\n### **CSS Properties:**\n - **--padding** - The tab panel's padding. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
|
4005
|
+
"attributes": [
|
|
4006
|
+
{
|
|
4007
|
+
"name": "name",
|
|
4008
|
+
"description": "The tab panel's name.",
|
|
4009
|
+
"values": []
|
|
4010
|
+
},
|
|
4011
|
+
{
|
|
4012
|
+
"name": "active",
|
|
4013
|
+
"description": "When true, the tab panel will be shown.",
|
|
4014
|
+
"values": []
|
|
4015
|
+
}
|
|
4016
|
+
],
|
|
4017
|
+
"references": []
|
|
4018
|
+
},
|
|
4019
|
+
{
|
|
4020
|
+
"name": "sd-2-6-0-tab",
|
|
4021
|
+
"description": "Tabs are used inside [tab groups](/components/tab-group) to represent and activate [tab panels](/components/tab-panel).\n\n\n---\n\n\n\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus to the tab.\n- **blur()** - Removes focus from the tab.\n\n### **Slots:**\n - _default_ - The tab's label.\n- **left** - Optional element (eg. icon) positioned to the left of the label.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **active-tab-indicator** - The active tab indicator.",
|
|
4022
|
+
"attributes": [
|
|
4023
|
+
{
|
|
4024
|
+
"name": "panel",
|
|
4025
|
+
"description": "The name of the tab panel this tab is associated with. The panel must be located in the same tab group.",
|
|
4026
|
+
"values": []
|
|
4027
|
+
},
|
|
4028
|
+
{
|
|
4029
|
+
"name": "variant",
|
|
4030
|
+
"description": "When set to container, a border appears around the current tab and tab-panel.",
|
|
4031
|
+
"values": [
|
|
4032
|
+
{
|
|
4033
|
+
"name": "default"
|
|
4034
|
+
},
|
|
4035
|
+
{
|
|
4036
|
+
"name": "container"
|
|
4037
|
+
}
|
|
4038
|
+
]
|
|
4039
|
+
},
|
|
4040
|
+
{
|
|
4041
|
+
"name": "active",
|
|
4042
|
+
"description": "Draws the tab in an active state.",
|
|
4043
|
+
"values": []
|
|
4044
|
+
},
|
|
4045
|
+
{
|
|
4046
|
+
"name": "disabled",
|
|
4047
|
+
"description": "Disables the tab and prevents selection.",
|
|
4048
|
+
"values": []
|
|
4049
|
+
}
|
|
4050
|
+
],
|
|
4051
|
+
"references": []
|
|
4052
|
+
},
|
|
4053
|
+
{
|
|
4054
|
+
"name": "sd-2-6-0-tag",
|
|
3915
4055
|
"description": "Tags are used as labels to organize things or to indicate a selection.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the tag loses focus.\n- **sd-focus** - Emitted when the tag gains focus.\n- **sd-remove** - Emitted when the remove button is activated.\n\n### **Methods:**\n - **click()** - Simulates a click on the tag.\n- **focus(options: _FocusOptions_)** - Sets focus on the tag.\n- **blur()** - Removes focus from the tag.\n\n### **Slots:**\n - _default_ - The tag's content.\n- **removable-indicator** - The tag's removability indicator.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **content** - The tag's content.\n- **removable-indicator** - The tag's removability indicator.",
|
|
3916
4056
|
"attributes": [
|
|
3917
4057
|
{
|
|
@@ -3973,7 +4113,7 @@
|
|
|
3973
4113
|
"references": []
|
|
3974
4114
|
},
|
|
3975
4115
|
{
|
|
3976
|
-
"name": "sd-2-
|
|
4116
|
+
"name": "sd-2-6-0-teaser-media",
|
|
3977
4117
|
"description": "Teasers group information into flexible containers so users can browse a collection of related items and actions.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - An optional main content slot.\n- **media** - An optional media slot.\n- **meta** - An optional meta slot.\n- **expandable** - An optional expandable slot, <strong>not</strong> shown on small devices.\n- **headline** - headline slot.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **media** - The container that wraps the media.\n- **content** - The container that wraps the content.\n- **meta** - The container that wraps the meta.\n- **headline** - The container that wraps the headline.\n- **expandable** - The container that wraps the expandable.\n- **main** - The container that wraps the main content.",
|
|
3978
4118
|
"attributes": [
|
|
3979
4119
|
{
|
|
@@ -4003,7 +4143,7 @@
|
|
|
4003
4143
|
"references": []
|
|
4004
4144
|
},
|
|
4005
4145
|
{
|
|
4006
|
-
"name": "sd-2-
|
|
4146
|
+
"name": "sd-2-6-0-teaser",
|
|
4007
4147
|
"description": "Teasers group information into flexible containers so users can browse a collection of related items and actions.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - An optional main content slot.\n- **media** - An optional media slot.\n- **meta** - An optional meta slot.\n- **headline** - headline slot.\n\n### **CSS Properties:**\n - **--distribution-media** - The distribution ratio of the media. _(default: undefined)_\n- **--distribution-content** - The distribution ratio of the content. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **media** - The container that wraps the media.\n- **content** - The container that wraps the content.\n- **meta** - The container that wraps the meta.\n- **headline** - The container that wraps the headline.\n- **main** - The container that wraps the main content.",
|
|
4008
4148
|
"attributes": [
|
|
4009
4149
|
{
|
|
@@ -4040,7 +4180,7 @@
|
|
|
4040
4180
|
"references": []
|
|
4041
4181
|
},
|
|
4042
4182
|
{
|
|
4043
|
-
"name": "sd-2-
|
|
4183
|
+
"name": "sd-2-6-0-textarea",
|
|
4044
4184
|
"description": "Textareas collect data from the user and allow multiple lines of text.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the control loses focus.\n- **sd-change** - Emitted when an alteration to the control's value is committed by the user.\n- **sd-focus** - Emitted when the control gains focus.\n- **sd-input** - Emitted when the control receives input.\n- **sd-invalid** - Emitted when the form control has been checked for validity and its constraints aren't satisfied.\n\n### **Methods:**\n - **focus(options: _FocusOptions_)** - Sets focus on the textarea.\n- **blur()** - Removes focus from the textarea.\n- **select()** - Selects all the text in the textarea.\n- **scrollPosition(position: _{ top?: number; left?: number }_): _{ top: number; left: number } | undefined_** - Gets or sets the textarea's scroll position.\n- **setSelectionRange(selectionStart: _number_, selectionEnd: _number_, selectionDirection: _'forward' | 'backward' | 'none'_)** - Sets the start and end positions of the text selection (0-based).\n- **setRangeText(replacement: _string_, start: _number_, end: _number_, selectMode: _'select' | 'start' | 'end' | 'preserve'_)** - Replaces a range of text with a new string.\n- **checkValidity()** - Checks for validity but does not show a validation message. Returns `true` when valid and `false` when invalid.\n- **getForm(): _HTMLFormElement | null_** - Gets the associated form, if one exists.\n- **reportValidity()** - Checks for validity and shows the browser's validation message if the control is invalid.\n- **setCustomValidity(message: _string_)** - Sets a custom validation message. Pass an empty string to restore validity.\n\n### **Slots:**\n - **label** - The textarea's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the input. Alternatively, you can use the `help-text` attribute.\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, input, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The input's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **base** - The component's base wrapper.\n- **border** - The base part's absolutely positioned border. Allows for easy adjustment of border thickness without affecting component dimensions.\n- **textarea** - The internal `<textarea>` control.",
|
|
4045
4185
|
"attributes": [
|
|
4046
4186
|
{
|
|
@@ -4222,7 +4362,7 @@
|
|
|
4222
4362
|
"references": []
|
|
4223
4363
|
},
|
|
4224
4364
|
{
|
|
4225
|
-
"name": "sd-2-
|
|
4365
|
+
"name": "sd-2-6-0-tooltip",
|
|
4226
4366
|
"description": "Tooltips display additional information based on a specific action.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-show** - Emitted when the tooltip begins to show.\n- **sd-after-show** - Emitted after the tooltip has shown and all animations are complete.\n- **sd-hide** - Emitted when the tooltip begins to hide.\n- **sd-after-hide** - Emitted after the tooltip has hidden and all animations are complete.\n\n### **Methods:**\n - **show()** - Shows the tooltip.\n- **hide()** - Hides the tooltip\n\n### **Slots:**\n - _default_ - The tooltip's target element. Avoid slotting in more than one element, as subsequent ones will be ignored.\n- **content** - The content to render in the tooltip. Alternatively, you can use the `content` attribute.\n\n### **CSS Properties:**\n - **--max-width** - The maximum width of the tooltip before its content will wrap. _(default: undefined)_\n- **--hide-delay** - The amount of time to wait before hiding the tooltip when hovering. _(default: undefined)_\n- **--show-delay** - The amount of time to wait before showing the tooltip when hovering. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper, an `<sd-popup>` element.\n- **base__popup** - The popup's exported `popup` part. Use this to target the tooltip's popup container.\n- **base__arrow** - The popup's exported `arrow` part. Use this to target the tooltip's arrow.\n- **body** - The tooltip's body where its content is rendered.",
|
|
4227
4367
|
"attributes": [
|
|
4228
4368
|
{
|
|
@@ -4290,7 +4430,7 @@
|
|
|
4290
4430
|
"references": []
|
|
4291
4431
|
},
|
|
4292
4432
|
{
|
|
4293
|
-
"name": "sd-2-
|
|
4433
|
+
"name": "sd-2-6-0-video",
|
|
4294
4434
|
"description": "Used to wrap external video elements (e. g. from Moving Image or bare <video>-Tags) and provide some basic styling for Union Investment.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-play** - Event emitted when clicking the `play-icon`. Listen for this event and use it to play the wrapped video.\n\n### **Slots:**\n - _default_ - The default slot used to pass a video player element.\n- **play-icon** - The video's play icon.\n- **poster** - Specifies an image to be shown before initial play of the wrapped video. Acts like the `poster` attribute on the native video tag.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **play-button** - The `<button>` element wrapper around the play-icon slot (full screen to field all click events).\n- **play-button-bg** - The `<div>` element wrapper around the play-button that defines the circular background.\n- **overlay** - The `<div>` element styled as an absolutely positioned transparent overlay.",
|
|
4295
4435
|
"attributes": [
|
|
4296
4436
|
{
|