@solid-design-system/components 3.22.18 → 3.23.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/components/es/combobox.js +11 -0
- package/dist/components/es/map-marker.js +1 -1
- package/dist/components/es/optgroup.js +1 -0
- package/dist/components/es/option-renderer.js +1 -0
- package/dist/components/es/select.js +7 -3
- package/dist/components/es/solid-components2.js +7 -7
- package/dist/components/es/utils.js +1 -0
- package/dist/components/umd/solid-components.js +37 -23
- package/dist/custom-elements.json +1 -1
- package/dist/package/components/combobox/combobox.d.ts +129 -0
- package/dist/package/components/combobox/combobox.js +958 -0
- package/dist/package/components/combobox/option-renderer.d.ts +5 -0
- package/dist/package/components/combobox/option-renderer.js +4 -0
- package/dist/package/components/combobox/utils.d.ts +8 -0
- package/dist/package/components/combobox/utils.js +14 -0
- package/dist/package/components/optgroup/optgroup.d.ts +20 -0
- package/dist/package/components/optgroup/optgroup.js +68 -0
- package/dist/package/components/select/select.d.ts +5 -1
- package/dist/package/components/select/select.js +94 -29
- package/dist/package/solid-components.d.ts +2 -0
- package/dist/package/solid-components.js +74 -70
- package/dist/package/styles/tailwind.css.js +1 -1
- package/dist/package/translations/de.js +7 -4
- package/dist/package/translations/en.js +7 -4
- package/dist/package/utilities/localize.d.ts +3 -0
- package/dist/versioned-components/es/accordion-group.js +1 -1
- package/dist/versioned-components/es/accordion.js +1 -1
- package/dist/versioned-components/es/audio.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/combobox.js +11 -0
- 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/expandable.js +1 -1
- package/dist/versioned-components/es/flipcard.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/map-marker.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/optgroup.js +1 -0
- package/dist/versioned-components/es/option-renderer.js +1 -0
- package/dist/versioned-components/es/option.js +1 -1
- package/dist/versioned-components/es/quickfact.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/scrollable.js +1 -1
- package/dist/versioned-components/es/select.js +7 -3
- package/dist/versioned-components/es/solid-components2.js +7 -7
- package/dist/versioned-components/es/spinner.js +1 -1
- package/dist/versioned-components/es/step-group.js +1 -1
- package/dist/versioned-components/es/step.js +1 -1
- package/dist/versioned-components/es/switch.js +1 -1
- package/dist/versioned-components/es/tab-group.js +1 -1
- package/dist/versioned-components/es/tab-panel.js +1 -1
- package/dist/versioned-components/es/tab.js +1 -1
- 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/utils.js +1 -0
- 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/audio/audio.d.ts +1 -1
- package/dist/versioned-package/components/audio/audio.js +6 -6
- 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 +3 -3
- 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/combobox/combobox.d.ts +129 -0
- package/dist/versioned-package/components/combobox/combobox.js +958 -0
- package/dist/versioned-package/components/combobox/option-renderer.d.ts +5 -0
- package/dist/versioned-package/components/combobox/option-renderer.js +4 -0
- package/dist/versioned-package/components/combobox/utils.d.ts +8 -0
- package/dist/versioned-package/components/combobox/utils.js +14 -0
- 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/expandable/expandable.d.ts +1 -1
- package/dist/versioned-package/components/expandable/expandable.js +2 -2
- package/dist/versioned-package/components/flipcard/flipcard.d.ts +1 -1
- package/dist/versioned-package/components/flipcard/flipcard.js +1 -1
- 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 +3 -3
- 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/map-marker/map-marker.d.ts +1 -1
- package/dist/versioned-package/components/map-marker/map-marker.js +1 -1
- package/dist/versioned-package/components/navigation-item/navigation-item.d.ts +1 -1
- package/dist/versioned-package/components/navigation-item/navigation-item.js +5 -5
- 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/optgroup/optgroup.d.ts +20 -0
- package/dist/versioned-package/components/optgroup/optgroup.js +68 -0
- 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/quickfact/quickfact.d.ts +1 -1
- package/dist/versioned-package/components/quickfact/quickfact.js +2 -2
- 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 +13 -13
- package/dist/versioned-package/components/scrollable/scrollable.d.ts +1 -1
- package/dist/versioned-package/components/scrollable/scrollable.js +3 -3
- package/dist/versioned-package/components/select/select.d.ts +9 -5
- package/dist/versioned-package/components/select/select.js +115 -50
- 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/step/step.d.ts +1 -1
- package/dist/versioned-package/components/step/step.js +2 -2
- package/dist/versioned-package/components/step-group/step-group.d.ts +1 -1
- package/dist/versioned-package/components/step-group/step-group.js +2 -2
- package/dist/versioned-package/components/switch/switch.d.ts +1 -1
- package/dist/versioned-package/components/switch/switch.js +1 -1
- package/dist/versioned-package/components/tab/tab.d.ts +1 -1
- package/dist/versioned-package/components/tab/tab.js +2 -2
- package/dist/versioned-package/components/tab-group/tab-group.d.ts +1 -1
- package/dist/versioned-package/components/tab-group/tab-group.js +13 -13
- package/dist/versioned-package/components/tab-panel/tab-panel.d.ts +1 -1
- package/dist/versioned-package/components/tab-panel/tab-panel.js +2 -2
- 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 +2 -2
- 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 +2 -0
- package/dist/versioned-package/solid-components.js +74 -70
- package/dist/versioned-package/styles/headline/headline.css.js +1 -1
- package/dist/versioned-package/styles/tailwind.css.js +1 -1
- package/dist/versioned-package/translations/de.js +7 -4
- package/dist/versioned-package/translations/en.js +7 -4
- package/dist/versioned-package/utilities/autocomplete-config.js +4 -4
- package/dist/versioned-package/utilities/localize.d.ts +3 -0
- package/dist/versioned-styles/solid-styles.css +1 -1
- package/dist/vscode.html-custom-data.json +371 -45
- package/dist/web-types.json +5471 -3959
- package/package.json +3 -3
@@ -475,6 +475,152 @@
|
|
475
475
|
],
|
476
476
|
"references": []
|
477
477
|
},
|
478
|
+
{
|
479
|
+
"name": "sd-combobox",
|
480
|
+
"description": "Comboboxes 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 combobox's menu opens.\n- **sd-after-show** - Emitted after the combobox's menu opens and all animations are complete.\n- **sd-hide** - Emitted when the combobox's menu closes.\n- **sd-after-hide** - Emitted after the combobox'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- **sd-error** - Emitted when the combobox menu fails to open.\n\n### **Methods:**\n - **hide()** - Hides the listbox.\n- **checkValidity()** - Checks for validity but does not show a validation message.\nReturns `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-optgroup>`'s to group items visually.\n- **label** - The combobox's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the combobox. Alternatively, you can use the `help-text` attribute.\n- **left** - Used to prepend a presentational icon or similar element to the combobox.\n- **right** - Used to append a presentational icon or similar element to the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n\n### **CSS Properties:**\n - **--tag-max-width** - Set the maximum width of the tags and to show an ellipsis. Defaults to \"15ch\" _(default: undefined)_\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, combobox, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The combobox's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container that wraps the prefix, combobox, clear icon, and expand button.\n- **left** - The container that wraps the left icon slot.\n- **right** - The container that wraps the right icon slot.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where the options are slotted and the filtered options list exists.\n- **filtered-listbox** - The container that wraps the filtered options.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
481
|
+
"attributes": [
|
482
|
+
{
|
483
|
+
"name": "name",
|
484
|
+
"description": "The name of the combobox, submitted as a name/value pair with form data.",
|
485
|
+
"values": []
|
486
|
+
},
|
487
|
+
{
|
488
|
+
"name": "value",
|
489
|
+
"description": "The current value of the combobox, submitted as a name/value pair with form data.",
|
490
|
+
"values": [
|
491
|
+
{
|
492
|
+
"name": "string[]"
|
493
|
+
}
|
494
|
+
]
|
495
|
+
},
|
496
|
+
{
|
497
|
+
"name": "size",
|
498
|
+
"description": "The combobox's size.",
|
499
|
+
"values": [
|
500
|
+
{
|
501
|
+
"name": "lg"
|
502
|
+
},
|
503
|
+
{
|
504
|
+
"name": "md"
|
505
|
+
},
|
506
|
+
{
|
507
|
+
"name": "sm"
|
508
|
+
}
|
509
|
+
]
|
510
|
+
},
|
511
|
+
{
|
512
|
+
"name": "placeholder",
|
513
|
+
"description": "Placeholder text to show as a hint when the combobox is empty.",
|
514
|
+
"values": []
|
515
|
+
},
|
516
|
+
{
|
517
|
+
"name": "disabled",
|
518
|
+
"description": "Disables the combobox control.",
|
519
|
+
"values": []
|
520
|
+
},
|
521
|
+
{
|
522
|
+
"name": "clearable",
|
523
|
+
"description": "Adds a clear button when the combobox is not empty.",
|
524
|
+
"values": []
|
525
|
+
},
|
526
|
+
{
|
527
|
+
"name": "open",
|
528
|
+
"description": "Indicates whether or not the combobox is open.\nYou can toggle this attribute to show and hide the listbox, or you can use the `show()`\nand `hide()` methods and this attribute will reflect the combobox's open state.",
|
529
|
+
"values": []
|
530
|
+
},
|
531
|
+
{
|
532
|
+
"name": "hoist",
|
533
|
+
"description": "Enable this option to prevent the listbox from being clipped,\nwhen the component is placed inside a container with `overflow: auto|scroll`.\nHoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
|
534
|
+
"values": []
|
535
|
+
},
|
536
|
+
{
|
537
|
+
"name": "label",
|
538
|
+
"description": "The combobox's label. If you need to display HTML, use the `label` slot instead.",
|
539
|
+
"values": []
|
540
|
+
},
|
541
|
+
{
|
542
|
+
"name": "placement",
|
543
|
+
"description": "The preferred placement of the combobox's menu.\nNote that the actual placement may vary as needed to keep the listbox inside of the viewport.",
|
544
|
+
"values": [
|
545
|
+
{
|
546
|
+
"name": "top"
|
547
|
+
},
|
548
|
+
{
|
549
|
+
"name": "bottom"
|
550
|
+
}
|
551
|
+
]
|
552
|
+
},
|
553
|
+
{
|
554
|
+
"name": "help-text",
|
555
|
+
"description": "The combobox's help text. If you need to display HTML, use the `help-text` slot instead.",
|
556
|
+
"values": []
|
557
|
+
},
|
558
|
+
{
|
559
|
+
"name": "form",
|
560
|
+
"description": "By default, form controls are associated with the nearest containing `<form>` element.\nThis attribute allows you to place the form control outside of a form and associate it\nwith the form that has this `id`.\nThe form must be in the same document or shadow root for this to work.",
|
561
|
+
"values": []
|
562
|
+
},
|
563
|
+
{
|
564
|
+
"name": "required",
|
565
|
+
"description": "The combobox's required attribute.",
|
566
|
+
"values": []
|
567
|
+
},
|
568
|
+
{
|
569
|
+
"name": "getOption",
|
570
|
+
"description": "A function that customizes the rendered option. The first argument is the option, the second\nis the query string, which is typed into the combobox.\nThe function should return either a Lit TemplateResult or a string containing trusted HTML\nto render in the shown list of filtered options.\nIf the query string should be highlighted use the `highlightOptionRenderer` function.",
|
571
|
+
"values": [
|
572
|
+
{
|
573
|
+
"name": "OptionRenderer"
|
574
|
+
}
|
575
|
+
]
|
576
|
+
},
|
577
|
+
{
|
578
|
+
"name": "multiple",
|
579
|
+
"description": "Allows more than one option to be selected.",
|
580
|
+
"values": []
|
581
|
+
},
|
582
|
+
{
|
583
|
+
"name": "useTags",
|
584
|
+
"description": "Uses interactive `sd-tag` elements representing individual options in the display input when `multiple` is `true`. It cannot be opted out.",
|
585
|
+
"values": []
|
586
|
+
},
|
587
|
+
{
|
588
|
+
"name": "max-options-visible",
|
589
|
+
"description": "The maximum number of selected options to show when `multiple` and `useTags` are `true`. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
590
|
+
"values": []
|
591
|
+
},
|
592
|
+
{
|
593
|
+
"name": "style-on-valid",
|
594
|
+
"description": "Shows success styles if the validity of the input is valid.",
|
595
|
+
"values": []
|
596
|
+
},
|
597
|
+
{
|
598
|
+
"name": "filter",
|
599
|
+
"description": "A function used to filter options in the combobox component.\nThe default filter method is a case- and diacritic-insensitive string comparison.",
|
600
|
+
"values": [
|
601
|
+
{
|
602
|
+
"name": "(option: SdOption"
|
603
|
+
},
|
604
|
+
{
|
605
|
+
"name": "queryString: string) => boolean"
|
606
|
+
}
|
607
|
+
]
|
608
|
+
},
|
609
|
+
{
|
610
|
+
"name": "getTag",
|
611
|
+
"description": "A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second\nis the current tag's index. The function should return either a Lit TemplateResult or a string containing trusted HTML of the symbol to render at\nthe specified value.",
|
612
|
+
"values": [
|
613
|
+
{
|
614
|
+
"name": "(option: SdOption, index: number) => TemplateResult"
|
615
|
+
},
|
616
|
+
{
|
617
|
+
"name": "HTMLElement"
|
618
|
+
}
|
619
|
+
]
|
620
|
+
}
|
621
|
+
],
|
622
|
+
"references": []
|
623
|
+
},
|
478
624
|
{
|
479
625
|
"name": "sd-dialog",
|
480
626
|
"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.",
|
@@ -1410,6 +1556,23 @@
|
|
1410
1556
|
],
|
1411
1557
|
"references": []
|
1412
1558
|
},
|
1559
|
+
{
|
1560
|
+
"name": "sd-optgroup",
|
1561
|
+
"description": "The <sd-optgroup> element creates a grouping for <sd-option>s within a <sd-combobox>.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The given options. Must be `<sd-option>` elements.\n- **label** - The label for the optgroup\n\n### **CSS Properties:**\n - **--display-divider** - Display property of the divider. Defaults to \"block\" _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label-container** - The container that wraps prefix, label and base\n- **divider** - The divider that is displayed above the content\n- **options** - The container that wraps the <sd-option> elements.",
|
1562
|
+
"attributes": [
|
1563
|
+
{
|
1564
|
+
"name": "disabled",
|
1565
|
+
"description": "Disables all options in the optgroup.",
|
1566
|
+
"values": []
|
1567
|
+
},
|
1568
|
+
{
|
1569
|
+
"name": "label",
|
1570
|
+
"description": "The optgroups label. If you need to display HTML, use the `label` slot instead.",
|
1571
|
+
"values": []
|
1572
|
+
}
|
1573
|
+
],
|
1574
|
+
"references": []
|
1575
|
+
},
|
1413
1576
|
{
|
1414
1577
|
"name": "sd-option",
|
1415
1578
|
"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.",
|
@@ -2651,7 +2814,7 @@
|
|
2651
2814
|
"references": []
|
2652
2815
|
},
|
2653
2816
|
{
|
2654
|
-
"name": "sd-3-
|
2817
|
+
"name": "sd-3-23-0-accordion-group",
|
2655
2818
|
"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.",
|
2656
2819
|
"attributes": [
|
2657
2820
|
{
|
@@ -2663,7 +2826,7 @@
|
|
2663
2826
|
"references": []
|
2664
2827
|
},
|
2665
2828
|
{
|
2666
|
-
"name": "sd-3-
|
2829
|
+
"name": "sd-3-23-0-accordion",
|
2667
2830
|
"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.",
|
2668
2831
|
"attributes": [
|
2669
2832
|
{
|
@@ -2680,7 +2843,7 @@
|
|
2680
2843
|
"references": []
|
2681
2844
|
},
|
2682
2845
|
{
|
2683
|
-
"name": "sd-3-
|
2846
|
+
"name": "sd-3-23-0-audio",
|
2684
2847
|
"description": "Used to play audio files that are part of the page content.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-playback-start** - Emitted when the audio playback starts.\n- **sd-playback-end** - Emitted when the audio playback ends.\n- **sd-playback-pause** - Emitted when the audio playback pauses.\n- **sd-playback-mute** - Emitted when the audio is muted.\n- **sd-playback-unmute** - Emitted when the audio is unmuted.\n- **sd-playback-speed** - Emitted when the playback speed is changed.\n- **sd-transcript-click** - Emitted when the transcript button is clicked.\n\n### **Slots:**\n - _default_ - The default slot.\n- **play-icon** - The play icon.\n- **pause-icon** - The pause icon.\n- **transcript** - The transcript.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **audio-controls** - The audio controls.\n- **playback-speed** - The playback speed.\n- **play-button** - The play button.\n- **volume** - The volume button.\n- **progress-slider** - The audio progress slider.\n- **timestamps** - The audio timestamps.",
|
2685
2848
|
"attributes": [
|
2686
2849
|
{
|
@@ -2712,7 +2875,7 @@
|
|
2712
2875
|
"references": []
|
2713
2876
|
},
|
2714
2877
|
{
|
2715
|
-
"name": "sd-3-
|
2878
|
+
"name": "sd-3-23-0-badge",
|
2716
2879
|
"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.",
|
2717
2880
|
"attributes": [
|
2718
2881
|
{
|
@@ -2754,7 +2917,7 @@
|
|
2754
2917
|
"references": []
|
2755
2918
|
},
|
2756
2919
|
{
|
2757
|
-
"name": "sd-3-
|
2920
|
+
"name": "sd-3-23-0-brandshape",
|
2758
2921
|
"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- **image** - The image slot for the 'image' variant.\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.\n- **stylized-container** - Container for border and image variant.",
|
2759
2922
|
"attributes": [
|
2760
2923
|
{
|
@@ -2803,7 +2966,7 @@
|
|
2803
2966
|
"references": []
|
2804
2967
|
},
|
2805
2968
|
{
|
2806
|
-
"name": "sd-3-
|
2969
|
+
"name": "sd-3-23-0-button",
|
2807
2970
|
"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.",
|
2808
2971
|
"attributes": [
|
2809
2972
|
{
|
@@ -2975,13 +3138,13 @@
|
|
2975
3138
|
"references": []
|
2976
3139
|
},
|
2977
3140
|
{
|
2978
|
-
"name": "sd-3-
|
3141
|
+
"name": "sd-3-23-0-carousel-item",
|
2979
3142
|
"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.",
|
2980
3143
|
"attributes": [],
|
2981
3144
|
"references": []
|
2982
3145
|
},
|
2983
3146
|
{
|
2984
|
-
"name": "sd-3-
|
3147
|
+
"name": "sd-3-23-0-carousel",
|
2985
3148
|
"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 - **pause()** - Pause the autoplay.\n- **resume()** - Resume the autoplay\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.",
|
2986
3149
|
"attributes": [
|
2987
3150
|
{
|
@@ -3025,7 +3188,7 @@
|
|
3025
3188
|
"references": []
|
3026
3189
|
},
|
3027
3190
|
{
|
3028
|
-
"name": "sd-3-
|
3191
|
+
"name": "sd-3-23-0-checkbox-group",
|
3029
3192
|
"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.\n- **tooltip** - An optional tooltip that helps describe the checkbox-group. Use this slot with the `sd-tooltip` component.",
|
3030
3193
|
"attributes": [
|
3031
3194
|
{
|
@@ -3064,7 +3227,7 @@
|
|
3064
3227
|
"references": []
|
3065
3228
|
},
|
3066
3229
|
{
|
3067
|
-
"name": "sd-3-
|
3230
|
+
"name": "sd-3-23-0-checkbox",
|
3068
3231
|
"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.",
|
3069
3232
|
"attributes": [
|
3070
3233
|
{
|
@@ -3125,7 +3288,153 @@
|
|
3125
3288
|
"references": []
|
3126
3289
|
},
|
3127
3290
|
{
|
3128
|
-
"name": "sd-3-
|
3291
|
+
"name": "sd-3-23-0-combobox",
|
3292
|
+
"description": "Comboboxes 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 combobox's menu opens.\n- **sd-after-show** - Emitted after the combobox's menu opens and all animations are complete.\n- **sd-hide** - Emitted when the combobox's menu closes.\n- **sd-after-hide** - Emitted after the combobox'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- **sd-error** - Emitted when the combobox menu fails to open.\n\n### **Methods:**\n - **hide()** - Hides the listbox.\n- **checkValidity()** - Checks for validity but does not show a validation message.\nReturns `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-optgroup>`'s to group items visually.\n- **label** - The combobox's label. Alternatively, you can use the `label` attribute.\n- **help-text** - Text that describes how to use the combobox. Alternatively, you can use the `help-text` attribute.\n- **left** - Used to prepend a presentational icon or similar element to the combobox.\n- **right** - Used to append a presentational icon or similar element to the combobox.\n- **clear-icon** - An icon to use in lieu of the default clear icon.\n- **expand-icon** - The icon to show when the control is expanded and collapsed. Rotates on open and close.\n\n### **CSS Properties:**\n - **--tag-max-width** - Set the maximum width of the tags and to show an ellipsis. Defaults to \"15ch\" _(default: undefined)_\n\n### **CSS Parts:**\n - **form-control** - The form control that wraps the label, combobox, and help text.\n- **form-control-label** - The label's wrapper.\n- **form-control-input** - The combobox's wrapper.\n- **form-control-help-text** - The help text's wrapper.\n- **combobox** - The container that wraps the prefix, combobox, clear icon, and expand button.\n- **left** - The container that wraps the left icon slot.\n- **right** - The container that wraps the right icon slot.\n- **display-input** - The element that displays the selected option's label, an `<input>` element.\n- **listbox** - The listbox container where the options are slotted and the filtered options list exists.\n- **filtered-listbox** - The container that wraps the filtered options.\n- **clear-button** - The clear button.\n- **expand-icon** - The container that wraps the expand icon.",
|
3293
|
+
"attributes": [
|
3294
|
+
{
|
3295
|
+
"name": "name",
|
3296
|
+
"description": "The name of the combobox, submitted as a name/value pair with form data.",
|
3297
|
+
"values": []
|
3298
|
+
},
|
3299
|
+
{
|
3300
|
+
"name": "value",
|
3301
|
+
"description": "The current value of the combobox, submitted as a name/value pair with form data.",
|
3302
|
+
"values": [
|
3303
|
+
{
|
3304
|
+
"name": "string[]"
|
3305
|
+
}
|
3306
|
+
]
|
3307
|
+
},
|
3308
|
+
{
|
3309
|
+
"name": "size",
|
3310
|
+
"description": "The combobox's size.",
|
3311
|
+
"values": [
|
3312
|
+
{
|
3313
|
+
"name": "lg"
|
3314
|
+
},
|
3315
|
+
{
|
3316
|
+
"name": "md"
|
3317
|
+
},
|
3318
|
+
{
|
3319
|
+
"name": "sm"
|
3320
|
+
}
|
3321
|
+
]
|
3322
|
+
},
|
3323
|
+
{
|
3324
|
+
"name": "placeholder",
|
3325
|
+
"description": "Placeholder text to show as a hint when the combobox is empty.",
|
3326
|
+
"values": []
|
3327
|
+
},
|
3328
|
+
{
|
3329
|
+
"name": "disabled",
|
3330
|
+
"description": "Disables the combobox control.",
|
3331
|
+
"values": []
|
3332
|
+
},
|
3333
|
+
{
|
3334
|
+
"name": "clearable",
|
3335
|
+
"description": "Adds a clear button when the combobox is not empty.",
|
3336
|
+
"values": []
|
3337
|
+
},
|
3338
|
+
{
|
3339
|
+
"name": "open",
|
3340
|
+
"description": "Indicates whether or not the combobox is open.\nYou can toggle this attribute to show and hide the listbox, or you can use the `show()`\nand `hide()` methods and this attribute will reflect the combobox's open state.",
|
3341
|
+
"values": []
|
3342
|
+
},
|
3343
|
+
{
|
3344
|
+
"name": "hoist",
|
3345
|
+
"description": "Enable this option to prevent the listbox from being clipped,\nwhen the component is placed inside a container with `overflow: auto|scroll`.\nHoisting uses a fixed positioning strategy that works in many, but not all, scenarios.",
|
3346
|
+
"values": []
|
3347
|
+
},
|
3348
|
+
{
|
3349
|
+
"name": "label",
|
3350
|
+
"description": "The combobox's label. If you need to display HTML, use the `label` slot instead.",
|
3351
|
+
"values": []
|
3352
|
+
},
|
3353
|
+
{
|
3354
|
+
"name": "placement",
|
3355
|
+
"description": "The preferred placement of the combobox's menu.\nNote that the actual placement may vary as needed to keep the listbox inside of the viewport.",
|
3356
|
+
"values": [
|
3357
|
+
{
|
3358
|
+
"name": "top"
|
3359
|
+
},
|
3360
|
+
{
|
3361
|
+
"name": "bottom"
|
3362
|
+
}
|
3363
|
+
]
|
3364
|
+
},
|
3365
|
+
{
|
3366
|
+
"name": "help-text",
|
3367
|
+
"description": "The combobox's help text. If you need to display HTML, use the `help-text` slot instead.",
|
3368
|
+
"values": []
|
3369
|
+
},
|
3370
|
+
{
|
3371
|
+
"name": "form",
|
3372
|
+
"description": "By default, form controls are associated with the nearest containing `<form>` element.\nThis attribute allows you to place the form control outside of a form and associate it\nwith the form that has this `id`.\nThe form must be in the same document or shadow root for this to work.",
|
3373
|
+
"values": []
|
3374
|
+
},
|
3375
|
+
{
|
3376
|
+
"name": "required",
|
3377
|
+
"description": "The combobox's required attribute.",
|
3378
|
+
"values": []
|
3379
|
+
},
|
3380
|
+
{
|
3381
|
+
"name": "getOption",
|
3382
|
+
"description": "A function that customizes the rendered option. The first argument is the option, the second\nis the query string, which is typed into the combobox.\nThe function should return either a Lit TemplateResult or a string containing trusted HTML\nto render in the shown list of filtered options.\nIf the query string should be highlighted use the `highlightOptionRenderer` function.",
|
3383
|
+
"values": [
|
3384
|
+
{
|
3385
|
+
"name": "OptionRenderer"
|
3386
|
+
}
|
3387
|
+
]
|
3388
|
+
},
|
3389
|
+
{
|
3390
|
+
"name": "multiple",
|
3391
|
+
"description": "Allows more than one option to be selected.",
|
3392
|
+
"values": []
|
3393
|
+
},
|
3394
|
+
{
|
3395
|
+
"name": "useTags",
|
3396
|
+
"description": "Uses interactive `sd-tag` elements representing individual options in the display input when `multiple` is `true`. It cannot be opted out.",
|
3397
|
+
"values": []
|
3398
|
+
},
|
3399
|
+
{
|
3400
|
+
"name": "max-options-visible",
|
3401
|
+
"description": "The maximum number of selected options to show when `multiple` and `useTags` are `true`. After the maximum, \"+n\" will be shown to\nindicate the number of additional items that are selected. Set to 0 to remove the limit.",
|
3402
|
+
"values": []
|
3403
|
+
},
|
3404
|
+
{
|
3405
|
+
"name": "style-on-valid",
|
3406
|
+
"description": "Shows success styles if the validity of the input is valid.",
|
3407
|
+
"values": []
|
3408
|
+
},
|
3409
|
+
{
|
3410
|
+
"name": "filter",
|
3411
|
+
"description": "A function used to filter options in the combobox component.\nThe default filter method is a case- and diacritic-insensitive string comparison.",
|
3412
|
+
"values": [
|
3413
|
+
{
|
3414
|
+
"name": "(option: SdOption"
|
3415
|
+
},
|
3416
|
+
{
|
3417
|
+
"name": "queryString: string) => boolean"
|
3418
|
+
}
|
3419
|
+
]
|
3420
|
+
},
|
3421
|
+
{
|
3422
|
+
"name": "getTag",
|
3423
|
+
"description": "A function that customizes the tags to be rendered when multiple=true. The first argument is the option, the second\nis the current tag's index. The function should return either a Lit TemplateResult or a string containing trusted HTML of the symbol to render at\nthe specified value.",
|
3424
|
+
"values": [
|
3425
|
+
{
|
3426
|
+
"name": "(option: SdOption, index: number) => TemplateResult"
|
3427
|
+
},
|
3428
|
+
{
|
3429
|
+
"name": "HTMLElement"
|
3430
|
+
}
|
3431
|
+
]
|
3432
|
+
}
|
3433
|
+
],
|
3434
|
+
"references": []
|
3435
|
+
},
|
3436
|
+
{
|
3437
|
+
"name": "sd-3-23-0-dialog",
|
3129
3438
|
"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.",
|
3130
3439
|
"attributes": [
|
3131
3440
|
{
|
@@ -3147,7 +3456,7 @@
|
|
3147
3456
|
"references": []
|
3148
3457
|
},
|
3149
3458
|
{
|
3150
|
-
"name": "sd-3-
|
3459
|
+
"name": "sd-3-23-0-divider",
|
3151
3460
|
"description": "Dividers are used to visually separate or group elements.\n\n\n---\n\n\n\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.",
|
3152
3461
|
"attributes": [
|
3153
3462
|
{
|
@@ -3171,7 +3480,7 @@
|
|
3171
3480
|
"references": []
|
3172
3481
|
},
|
3173
3482
|
{
|
3174
|
-
"name": "sd-3-
|
3483
|
+
"name": "sd-3-23-0-drawer",
|
3175
3484
|
"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.",
|
3176
3485
|
"attributes": [
|
3177
3486
|
{
|
@@ -3210,7 +3519,7 @@
|
|
3210
3519
|
"references": []
|
3211
3520
|
},
|
3212
3521
|
{
|
3213
|
-
"name": "sd-3-
|
3522
|
+
"name": "sd-3-23-0-dropdown",
|
3214
3523
|
"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.",
|
3215
3524
|
"attributes": [
|
3216
3525
|
{
|
@@ -3307,7 +3616,7 @@
|
|
3307
3616
|
"references": []
|
3308
3617
|
},
|
3309
3618
|
{
|
3310
|
-
"name": "sd-3-
|
3619
|
+
"name": "sd-3-23-0-expandable",
|
3311
3620
|
"description": "Expandable 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 expandable opens.\n- **sd-after-show** - Emitted after the expandable opens and all animations are complete.\n- **sd-hide** - Emitted when the expandable closes.\n- **sd-after-hide** - Emitted after the expandable closes and all animations are complete.\n\n### **Methods:**\n - **show()** - Opens the expandable\n- **hide()** - Closes the expandable\n\n### **Slots:**\n - _default_ - Content of the expandable\n- **toggle-open** - Content of the toggle button when the expandable is open\n- **toggle-closed** - Content of the toggle button when the expandable is closed\n\n### **CSS Properties:**\n - **--gradient-color-start** - Start color of the gradient. Set the opacity to 0 (default: rgba(255, 255, 255, 0)) _(default: undefined)_\n- **--gradient-color-end** - End color of the gradient. Set the opacity to 1 (default: rgba(255, 255, 255, 1)) _(default: undefined)_\n- **--gradient-height** - Height of the gradient (default: 24px) _(default: undefined)_\n- **--component-expandable-max-block-size** - Different value for initial visible block (default: 90px) _(default: undefined)_\n\n### **CSS Parts:**\n - **content** - The content of the expandable.\n- **toggle** - The toggle button of the expandable.\n- **summary** - The summary of the expandable.\n- **details** - The details element of the expandable.",
|
3312
3621
|
"attributes": [
|
3313
3622
|
{
|
@@ -3324,7 +3633,7 @@
|
|
3324
3633
|
"references": []
|
3325
3634
|
},
|
3326
3635
|
{
|
3327
|
-
"name": "sd-3-
|
3636
|
+
"name": "sd-3-23-0-flipcard",
|
3328
3637
|
"description": "Flipcard allows for the addition of content/information on both \"sides\" of the card, through means of a flip animation. Used to add dynamism and interactivity to a page.\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-flip-front** - Emmited when the front face of the flipcard is clicked.\n- **sd-flip-back** - Emmited when the back face of the flipcard is clicked.\n\n### **Slots:**\n - **front** - The front face of the flipcard.\n- **back** - The back face of the flipcard.\n- **media-front** - An optional media slot which can be as a background. Dependent from gradient variant.\n- **media-back** - An optional media slot which can be as a background. Dependent from gradient variant.\n\n### **CSS Properties:**\n - **--name** - Description of the flipcard. _(default: undefined)_\n- **--height** - Use this property to set the height of the flipcard. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **front** - The container that wraps the front-side of the flipcard.\n- **back** - The container that wraps the back-side of the flipcard.\n- **front-slot-container** - The container that wraps the front slot.\n- **back-slot-container** - The container that wraps the back slot.\n- **media-front** - The container that wraps the media-front slot.\n- **media-back** - The container that wraps the media-back slot.\n- **front-secondary-gradient** - The container that wraps the secondary gradient of the front side.\n- **back-secondary-gradient** - The container that wraps the secondary gradient of the back side.",
|
3329
3638
|
"attributes": [
|
3330
3639
|
{
|
@@ -3415,7 +3724,7 @@
|
|
3415
3724
|
"references": []
|
3416
3725
|
},
|
3417
3726
|
{
|
3418
|
-
"name": "sd-3-
|
3727
|
+
"name": "sd-3-23-0-header",
|
3419
3728
|
"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.",
|
3420
3729
|
"attributes": [
|
3421
3730
|
{
|
@@ -3427,7 +3736,7 @@
|
|
3427
3736
|
"references": []
|
3428
3737
|
},
|
3429
3738
|
{
|
3430
|
-
"name": "sd-3-
|
3739
|
+
"name": "sd-3-23-0-icon",
|
3431
3740
|
"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.",
|
3432
3741
|
"attributes": [
|
3433
3742
|
{
|
@@ -3469,7 +3778,7 @@
|
|
3469
3778
|
"references": []
|
3470
3779
|
},
|
3471
3780
|
{
|
3472
|
-
"name": "sd-3-
|
3781
|
+
"name": "sd-3-23-0-include",
|
3473
3782
|
"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.",
|
3474
3783
|
"attributes": [
|
3475
3784
|
{
|
@@ -3501,7 +3810,7 @@
|
|
3501
3810
|
"references": []
|
3502
3811
|
},
|
3503
3812
|
{
|
3504
|
-
"name": "sd-3-
|
3813
|
+
"name": "sd-3-23-0-input",
|
3505
3814
|
"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- **tooltip** - An optional tooltip that helps describe the input. Use this slot with the `sd-tooltip` component.\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.",
|
3506
3815
|
"attributes": [
|
3507
3816
|
{
|
@@ -3779,7 +4088,7 @@
|
|
3779
4088
|
"references": []
|
3780
4089
|
},
|
3781
4090
|
{
|
3782
|
-
"name": "sd-3-
|
4091
|
+
"name": "sd-3-23-0-link",
|
3783
4092
|
"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.",
|
3784
4093
|
"attributes": [
|
3785
4094
|
{
|
@@ -3839,7 +4148,7 @@
|
|
3839
4148
|
"references": []
|
3840
4149
|
},
|
3841
4150
|
{
|
3842
|
-
"name": "sd-3-
|
4151
|
+
"name": "sd-3-23-0-map-marker",
|
3843
4152
|
"description": "A marker identifies a location on google map\n\n\n---\n\n\n\n\n### **Events:**\n - **sd-blur** - Emitted when the map marker loses focus.\n- **sd-focus** - Emitted when the map marker is focused.\n\n### **Slots:**\n - _default_ - The marker's content.\\\n\n### **CSS Properties:**\n - **--map-marker-scaling** - Scale the marker size. _(default: undefined)_",
|
3844
4153
|
"attributes": [
|
3845
4154
|
{
|
@@ -3909,7 +4218,7 @@
|
|
3909
4218
|
"references": []
|
3910
4219
|
},
|
3911
4220
|
{
|
3912
|
-
"name": "sd-3-
|
4221
|
+
"name": "sd-3-23-0-navigation-item",
|
3913
4222
|
"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.",
|
3914
4223
|
"attributes": [
|
3915
4224
|
{
|
@@ -4003,7 +4312,7 @@
|
|
4003
4312
|
"references": []
|
4004
4313
|
},
|
4005
4314
|
{
|
4006
|
-
"name": "sd-3-
|
4315
|
+
"name": "sd-3-23-0-notification",
|
4007
4316
|
"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>`.",
|
4008
4317
|
"attributes": [
|
4009
4318
|
{
|
@@ -4060,7 +4369,24 @@
|
|
4060
4369
|
"references": []
|
4061
4370
|
},
|
4062
4371
|
{
|
4063
|
-
"name": "sd-3-
|
4372
|
+
"name": "sd-3-23-0-optgroup",
|
4373
|
+
"description": "The <sd-optgroup> element creates a grouping for <sd-option>s within a <sd-combobox>.\n\n\n---\n\n\n\n\n### **Slots:**\n - _default_ - The given options. Must be `<sd-option>` elements.\n- **label** - The label for the optgroup\n\n### **CSS Properties:**\n - **--display-divider** - Display property of the divider. Defaults to \"block\" _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **label-container** - The container that wraps prefix, label and base\n- **divider** - The divider that is displayed above the content\n- **options** - The container that wraps the <sd-option> elements.",
|
4374
|
+
"attributes": [
|
4375
|
+
{
|
4376
|
+
"name": "disabled",
|
4377
|
+
"description": "Disables all options in the optgroup.",
|
4378
|
+
"values": []
|
4379
|
+
},
|
4380
|
+
{
|
4381
|
+
"name": "label",
|
4382
|
+
"description": "The optgroups label. If you need to display HTML, use the `label` slot instead.",
|
4383
|
+
"values": []
|
4384
|
+
}
|
4385
|
+
],
|
4386
|
+
"references": []
|
4387
|
+
},
|
4388
|
+
{
|
4389
|
+
"name": "sd-3-23-0-option",
|
4064
4390
|
"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.",
|
4065
4391
|
"attributes": [
|
4066
4392
|
{
|
@@ -4097,7 +4423,7 @@
|
|
4097
4423
|
"references": []
|
4098
4424
|
},
|
4099
4425
|
{
|
4100
|
-
"name": "sd-3-
|
4426
|
+
"name": "sd-3-23-0-popup",
|
4101
4427
|
"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.",
|
4102
4428
|
"attributes": [
|
4103
4429
|
{
|
@@ -4321,7 +4647,7 @@
|
|
4321
4647
|
"references": []
|
4322
4648
|
},
|
4323
4649
|
{
|
4324
|
-
"name": "sd-3-
|
4650
|
+
"name": "sd-3-23-0-quickfact",
|
4325
4651
|
"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 - **icon** - Optional icon to show in the header. Works best with `<sd-icon>`.\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 - **icon** - The container that wraps the icon.\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.",
|
4326
4652
|
"attributes": [
|
4327
4653
|
{
|
@@ -4343,7 +4669,7 @@
|
|
4343
4669
|
"references": []
|
4344
4670
|
},
|
4345
4671
|
{
|
4346
|
-
"name": "sd-3-
|
4672
|
+
"name": "sd-3-23-0-radio-button",
|
4347
4673
|
"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.",
|
4348
4674
|
"attributes": [
|
4349
4675
|
{
|
@@ -4375,7 +4701,7 @@
|
|
4375
4701
|
"references": []
|
4376
4702
|
},
|
4377
4703
|
{
|
4378
|
-
"name": "sd-3-
|
4704
|
+
"name": "sd-3-23-0-radio-group",
|
4379
4705
|
"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- **tooltip** - An optional tooltip that helps describe the radio-group. Use this slot with the `sd-tooltip` component.\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.",
|
4380
4706
|
"attributes": [
|
4381
4707
|
{
|
@@ -4439,7 +4765,7 @@
|
|
4439
4765
|
"references": []
|
4440
4766
|
},
|
4441
4767
|
{
|
4442
|
-
"name": "sd-3-
|
4768
|
+
"name": "sd-3-23-0-radio",
|
4443
4769
|
"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.",
|
4444
4770
|
"attributes": [
|
4445
4771
|
{
|
@@ -4476,7 +4802,7 @@
|
|
4476
4802
|
"references": []
|
4477
4803
|
},
|
4478
4804
|
{
|
4479
|
-
"name": "sd-3-
|
4805
|
+
"name": "sd-3-23-0-scrollable",
|
4480
4806
|
"description": "Scrollable is used to indicate there is hidden content to be scrolled.\n\n\n---\n\n\n\n\n### **Events:**\n - **start** - Emitted when the start of the scrollable is reached.\n- **end** - Emitted when the end of the scrollable is reached.\n- **eventName** - undefined\n- **button-left** - Emitted when the left button is clicked.\n- **button-right** - Emitted when the right button is clicked.\n- **button-up** - Emitted when the top button is clicked.\n- **button-down** - Emitted when the bottom button is clicked.\n\n### **Slots:**\n - _default_ - The scrollable's content.\n- **icon-start** - The scrollable's start icon.\n- **icon-end** - The scrollable's end icon.\n\n### **CSS Properties:**\n - **--gradient-color** - Defines a custom color for the gradient. _(default: undefined)_\n\n### **CSS Parts:**\n - **base** - The scrollable's base wrapper.\n- **scroll-content** - The scrollable's content.\n- **button-start** - The scrollable's start scroll button.\n- **button-end** - The scrollable's end scroll button.\n- **button-left** - The scrollable's left scroll button.\n- **button-right** - The scrollable's right scroll button.\n- **button-top** - The scrollable's top scroll button.\n- **button-bottom** - The scrollable's bottom scroll button.\n- **shadow-left** - The scrollable's left shadow.\n- **shadow-right** - The scrollable's right shadow.\n- **shadow-top** - The scrollable's top shadow.\n- **shadow-bottom** - The scrollable's bottom shadow.",
|
4481
4807
|
"attributes": [
|
4482
4808
|
{
|
@@ -4523,7 +4849,7 @@
|
|
4523
4849
|
"references": []
|
4524
4850
|
},
|
4525
4851
|
{
|
4526
|
-
"name": "sd-3-
|
4852
|
+
"name": "sd-3-23-0-select",
|
4527
4853
|
"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- **tooltip** - An optional tooltip that helps describe the input. Use this slot with the `sd-tooltip` component.\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.",
|
4528
4854
|
"attributes": [
|
4529
4855
|
{
|
@@ -4648,7 +4974,7 @@
|
|
4648
4974
|
"references": []
|
4649
4975
|
},
|
4650
4976
|
{
|
4651
|
-
"name": "sd-3-
|
4977
|
+
"name": "sd-3-23-0-spinner",
|
4652
4978
|
"description": "Spinners are used to show the progress of an indeterminate operation.\n\n\n---\n\n\n",
|
4653
4979
|
"attributes": [
|
4654
4980
|
{
|
@@ -4670,7 +4996,7 @@
|
|
4670
4996
|
"references": []
|
4671
4997
|
},
|
4672
4998
|
{
|
4673
|
-
"name": "sd-3-
|
4999
|
+
"name": "sd-3-23-0-step-group",
|
4674
5000
|
"description": "Used as navigation bar that guides users through the steps of a process or task.\n\n\n---\n\n\n\n\n### **Methods:**\n - **setActiveStep(index: _number_)** - Sets the active step.\n\n### **Slots:**\n - _default_ - Used for grouping steps in the step group. Must be `<sd-step>` elements.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **body** - The container that wraps the steps.",
|
4675
5001
|
"attributes": [
|
4676
5002
|
{
|
@@ -4711,7 +5037,7 @@
|
|
4711
5037
|
"references": []
|
4712
5038
|
},
|
4713
5039
|
{
|
4714
|
-
"name": "sd-3-
|
5040
|
+
"name": "sd-3-23-0-step",
|
4715
5041
|
"description": "Steps are used inside [step groups](/components/step-group) to guide users through the steps of a process or task..\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### **Slots:**\n - _default_ - The step's description.\n- **label** - The step's label.\n- **index** - The step's index.\n- **circle-content** - The content inside a step circle. This could be an icon or a number.\n\n### **CSS Parts:**\n - **base** - The component's base wrapper.\n- **circle-and-tail-container** - The container that wraps the step's circle and tail.\n- **circle** - The circle that marks the step's state.\n- **tail** - The step's tail.\n- **text-container** - The container that wraps the step's label and description.\n- **label** - The step's label.\n- **description** - The step's description.",
|
4716
5042
|
"attributes": [
|
4717
5043
|
{
|
@@ -4782,7 +5108,7 @@
|
|
4782
5108
|
"references": []
|
4783
5109
|
},
|
4784
5110
|
{
|
4785
|
-
"name": "sd-3-
|
5111
|
+
"name": "sd-3-23-0-switch",
|
4786
5112
|
"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.",
|
4787
5113
|
"attributes": [
|
4788
5114
|
{
|
@@ -4824,7 +5150,7 @@
|
|
4824
5150
|
"references": []
|
4825
5151
|
},
|
4826
5152
|
{
|
4827
|
-
"name": "sd-3-
|
5153
|
+
"name": "sd-3-23-0-tab-group",
|
4828
5154
|
"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 - **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 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.",
|
4829
5155
|
"attributes": [
|
4830
5156
|
{
|
@@ -4843,7 +5169,7 @@
|
|
4843
5169
|
"references": []
|
4844
5170
|
},
|
4845
5171
|
{
|
4846
|
-
"name": "sd-3-
|
5172
|
+
"name": "sd-3-23-0-tab-panel",
|
4847
5173
|
"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.",
|
4848
5174
|
"attributes": [
|
4849
5175
|
{
|
@@ -4860,7 +5186,7 @@
|
|
4860
5186
|
"references": []
|
4861
5187
|
},
|
4862
5188
|
{
|
4863
|
-
"name": "sd-3-
|
5189
|
+
"name": "sd-3-23-0-tab",
|
4864
5190
|
"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.\n- **hover-bottom-border** - The bottom border that appears when the tab is hovered.",
|
4865
5191
|
"attributes": [
|
4866
5192
|
{
|
@@ -4894,7 +5220,7 @@
|
|
4894
5220
|
"references": []
|
4895
5221
|
},
|
4896
5222
|
{
|
4897
|
-
"name": "sd-3-
|
5223
|
+
"name": "sd-3-23-0-tag",
|
4898
5224
|
"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.",
|
4899
5225
|
"attributes": [
|
4900
5226
|
{
|
@@ -4961,7 +5287,7 @@
|
|
4961
5287
|
"references": []
|
4962
5288
|
},
|
4963
5289
|
{
|
4964
|
-
"name": "sd-3-
|
5290
|
+
"name": "sd-3-23-0-teaser-media",
|
4965
5291
|
"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.",
|
4966
5292
|
"attributes": [
|
4967
5293
|
{
|
@@ -4991,7 +5317,7 @@
|
|
4991
5317
|
"references": []
|
4992
5318
|
},
|
4993
5319
|
{
|
4994
|
-
"name": "sd-3-
|
5320
|
+
"name": "sd-3-23-0-teaser",
|
4995
5321
|
"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.",
|
4996
5322
|
"attributes": [
|
4997
5323
|
{
|
@@ -5028,7 +5354,7 @@
|
|
5028
5354
|
"references": []
|
5029
5355
|
},
|
5030
5356
|
{
|
5031
|
-
"name": "sd-3-
|
5357
|
+
"name": "sd-3-23-0-textarea",
|
5032
5358
|
"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- **tooltip** - An optional tooltip that helps describe the input. Use this slot with the `sd-tooltip` component.\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.",
|
5033
5359
|
"attributes": [
|
5034
5360
|
{
|
@@ -5210,7 +5536,7 @@
|
|
5210
5536
|
"references": []
|
5211
5537
|
},
|
5212
5538
|
{
|
5213
|
-
"name": "sd-3-
|
5539
|
+
"name": "sd-3-23-0-tooltip",
|
5214
5540
|
"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.",
|
5215
5541
|
"attributes": [
|
5216
5542
|
{
|
@@ -5278,7 +5604,7 @@
|
|
5278
5604
|
"references": []
|
5279
5605
|
},
|
5280
5606
|
{
|
5281
|
-
"name": "sd-3-
|
5607
|
+
"name": "sd-3-23-0-video",
|
5282
5608
|
"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.",
|
5283
5609
|
"attributes": [
|
5284
5610
|
{
|