{ "components": { "carousel": { "description": "A Carousel can accept a maximum number of 5 panels where only 1 panel is visible at a time.\n\nYou are able to navigate between panels by interacting with the `slds-carousel__indicator` elements that sit below the panel.\n\nA panel becomes visible by toggling the `slds-hide` class with the `slds-show` class on the `slds-carousel__panel` element.\n\nWhen making the `slds-carousel__panel` active, the indicator should be updated with the `slds-is-active` class. This provides visual feedback showing which carousel panel is active.\n\n### Accessibility\n\nA Carousel is built using a tabbed UI specification and requires the following to meet accessibility requirements:\n\n- The tab list, which should have `role=\"tablist\"`\n- The tabs in that list, which should each be an `` anchor wrapped in a `
  • ` list item\n- The tab panels, which display each tab’s content and should each have `role=\"tabpanel\"`\n\n**Expected markup:**\n\n- Selected tab’s anchor has `aria-selected=\"true\"`, all other tabs’ anchors have `aria-selected=\"false\"`\n- Selected tab’s anchor has `tabindex=\"0\"`, all other tabs have `tabindex=\"-1\"`\n- Each tab’s anchor has an `aria-controls` attribute whose value is the id of the associated `
    `\n- Each tab panel has an `aria-labelledby` attribute whose value is the id of its associated ``\n- When the Carousel is set to auto-play, the HTML for the pause button is required to precede the HTML of the tab set\n\n**Expected keyboard interactions:**\n\n- Arrow keys, when focus is on selected tab, cycle selection to the next or previous tab\n- Tab key, when focus is before the tab list, moves focus to the selected tab panel\n- Tab key, when focus is on selected tabpanel, moves focus into the selected tabpanel's associated tab or to the next focusable element on the page if that panel has no focusable elements\n- Shift+Tab keys, when focus is on first element in a tab panel, move focus focus entirely from tabset", "annotations": { "summary": "A carousel allows multiple pieces of featured content to occupy an allocated amount of space.", "layout": "responsive", "name": "carousel", "support": "dev-ready", "base": true, "lwc": true, "type": "navigation, data-display", "category": "experience", "selector": ".slds-carousel" }, "id": "carousel", "restrictees": [ { "description": "", "annotations": { "summary": "Initiates a carousel component", "name": "base", "selector": ".slds-carousel", "restrict": "div", "support": "dev-ready", "variant": true }, "id": "base", "restrictees": [ { "description": "", "annotations": { "summary": "Main stage for carousel's tab-panels and tab-list inidicators", "selector": ".slds-carousel__stage", "restrict": ".slds-carousel div" }, "id": ".slds-carousel__stage", "restrictees": [ { "description": "", "annotations": { "summary": "Tabpanel region that contains all carousel panels", "selector": ".slds-carousel__panels", "restrict": ".slds-carousel__stage div" }, "id": ".slds-carousel__panels", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Actionable element that contains the carousel's tab-panel content", "selector": ".slds-carousel__panel-action", "restrict": ".slds-carousel__stage a" }, "id": ".slds-carousel__panel-action", "restrictees": [ { "description": "", "annotations": { "summary": "Element that contains the image inside the carousel's tab-panel", "selector": ".slds-carousel__image", "restrict": ".slds-carousel__panel-action div" }, "id": ".slds-carousel__image", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Element that contains the content inside the carousel's tab-panel", "selector": ".slds-carousel__content", "restrict": ".slds-carousel__panel-action div" }, "id": ".slds-carousel__content", "restrictees": [ { "description": "", "annotations": { "summary": "Heading element that contains the title of the carousel's tab-panel", "selector": ".slds-carousel__content-title", "restrict": ".slds-carousel__content h2" }, "id": ".slds-carousel__content-title", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Element that contains the auto-play button icon to toggle on/off", "selector": ".slds-carousel__autoplay", "restrict": ".slds-carousel__stage span" }, "id": ".slds-carousel__autoplay", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "List element that contains the carousel's tab-list inidicators", "selector": ".slds-carousel__indicators", "restrict": ".slds-carousel ul" }, "id": ".slds-carousel__indicators", "restrictees": [ { "description": "", "annotations": { "summary": "Carousel's tab-list inidicator items", "selector": ".slds-carousel__indicator", "restrict": ".slds-carousel__indicators li" }, "id": ".slds-carousel__indicator", "restrictees": [ { "description": "", "annotations": { "summary": "Actionable element inside of each tab-list indicator", "selector": ".slds-carousel__indicator-action", "restrict": ".slds-carousel__indicator a" }, "id": ".slds-carousel__indicator-action", "restrictees": [ { "description": "", "annotations": { "summary": "Active state notifying the tab that its current panel is active", "selector": ".slds-is-active", "restrict": ".slds-carousel__indicator-action" }, "id": ".slds-is-active", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/carousel/base/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default" } ] }, { "title": "states", "items": [ { "id": "tab-1-active", "label": "Tab 1 Active" }, { "id": "tab-2-active", "label": "Tab 2 Active" }, { "id": "tab-3-active", "label": "Tab 3 active" }, { "id": "auto-play-enabled", "label": "Auto-play enabled" }, { "id": "auto-play-stopped", "label": "Auto-play stopped" } ] } ] } ], "docPath": "./ui/components/carousel/docs.mdx", "showcasePath": null, "showcase": [] }, "datetime-picker": { "description": "", "annotations": { "summary": "A datetime picker is used to select a day and a time.", "base": true, "name": "datetime-picker", "selector": ".slds-datetime-picker", "support": "dev-ready", "category": "experience", "type": "data-entry", "role": "grid, combobox" }, "id": "datetime-picker", "restrictees": [ { "description": "", "annotations": { "summary": "Initializes a datetime picker", "name": "base", "selector": ".slds-datetime-picker", "restrict": "div", "support": "dev-ready", "variant": true }, "id": "base", "restrictees": [], "docPath": null, "showcasePath": "./ui/components/datetime-picker/base/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default" } ] }, { "title": "examples", "items": [ { "id": "small-width-container", "label": "Small Width Container", "demoStyles": "height: auto; width: 200px; border: 1px dashed #ddd;", "storybookStyles": true } ] }, { "title": "states", "items": [ { "id": "date-selection", "label": "Date selected" }, { "id": "time-selection", "label": "Time selected", "demoStyles": "height: 20rem;", "storybookStyles": true }, { "id": "required", "label": "Date and Time - required", "demoStyles": "height: 20rem;" }, { "id": "error", "label": "Date and Time - error", "demoStyles": "height: 20rem;" }, { "id": "required-error", "label": "Date and Time - required and has error", "demoStyles": "height: 20rem;" }, { "id": "datetimepicker-with-tooltip-for-datepicker", "label": "Datetime Picker With Tooptip for datepicker", "demoStyles": "height: 20rem;" }, { "id": "datetimepicker-with-tooltip-for-timepicker", "label": "Datetime Picker With Tooptip for timepicker", "demoStyles": "height: 20rem;" }, { "id": "disabled", "label": "Date and Time - disabled", "demoStyles": "height: 10rem;", "storybookStyles": true } ] } ] } ], "docPath": "./ui/components/datetime-picker/docs.mdx", "showcasePath": null, "showcase": [] }, "slider": { "description": "", "annotations": { "summary": "An input range slider lets the user specify a numeric value which must be between two specified values.", "name": "slider", "support": "dev-ready", "base": true, "styling-hooks": true, "lwc": true, "type": "user-input", "category": "base", "selector": ".slds-slider" }, "id": "slider", "restrictees": [ { "description": "", "annotations": { "summary": "Initializes slider component", "name": "base", "selector": ".slds-slider", "restrict": "div", "support": "dev-ready", "variant": true }, "id": "base", "restrictees": [ { "description": "", "annotations": { "summary": "Range track for slider", "selector": ".slds-slider__range", "restrict": ".slds-slider input" }, "id": ".slds-slider__range", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Element that contains value of input range", "selector": ".slds-slider__value", "restrict": ".slds-slider span" }, "id": ".slds-slider__value", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Modifier that makes the slider vertical", "selector": ".slds-slider_vertical", "restrict": ".slds-slider", "modifier": true }, "id": ".slds-slider_vertical", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/slider/base/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default", "label": "Default" } ] }, { "title": "examples", "items": [ { "id": "min-max", "label": "Min/Max Range" }, { "id": "steps", "label": "Min/Max Range with Steps" }, { "id": "width-x-small", "label": "Width: x-small" }, { "id": "width-small", "label": "Width: small" }, { "id": "width-medium", "label": "Width: medium" }, { "id": "width-large", "label": "Width: large" }, { "id": "error", "label": "Error" }, { "id": "vertical", "label": "Vertical" } ] }, { "title": "states", "items": [ { "id": "disabled", "label": "Disabled" }, { "id": "value-0", "label": "Value: 0" }, { "id": "value-25", "label": "Value: 25" }, { "id": "value-50", "label": "Value: 50" }, { "id": "value-75", "label": "Value: 75" }, { "id": "value-100", "label": "Value: 100" } ] } ] } ], "docPath": "./ui/components/slider/docs.mdx", "showcasePath": null, "showcase": [] }, "buttons": { "description": "Create a button with a `button` or `a` element to retain the native click\nfunction.\n\nUse a disabled attribute when a button can’t be clicked.", "annotations": { "summary": "Buttons are used to invoke an event", "layout": "responsive", "name": "buttons", "support": "dev-ready", "base": true, "styling-hooks": true, "role": "button", "lwc": true, "type": "action", "category": "base", "selector": ".slds-button, .slds-button_stateful, .slds-button_dual-stateful, .slds-button_reset" }, "id": "buttons", "restrictees": [ { "description": "", "annotations": { "summary": "This neutralizes all the base styles making it look like a text link", "name": "base", "selector": ".slds-button", "restrict": "button, a, span", "support": "dev-ready", "variant": true }, "id": "base", "restrictees": [ { "description": "", "annotations": { "summary": "Explicitly style the first button in a button group", "selector": ".slds-button_first", "restrict": ".slds-button" }, "id": ".slds-button_first", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Explicitly style buttons in the middle (i.e., not first or last) in a button group", "selector": ".slds-button_middle", "restrict": ".slds-button" }, "id": ".slds-button_middle", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Explicitly style the last button in a button group", "selector": ".slds-button_last", "restrict": ".slds-button" }, "id": ".slds-button_last", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "neutral", "summary": "Creates the gray border with white background default style", "selector": ".slds-button_neutral", "restrict": ".slds-button", "modifier": true, "group": "theme" }, "id": "neutral", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "brand", "summary": "Creates the brand blue Salesforce style", "selector": ".slds-button_brand", "restrict": ".slds-button", "modifier": true, "group": "theme" }, "id": "brand", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "outline-brand", "summary": "Creates the outlined button with the brand color", "selector": ".slds-button_outline-brand", "restrict": ".slds-button", "modifier": true, "group": "theme" }, "id": "outline-brand", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "inverse", "summary": "Creates the inverse style for dark backgrounds", "selector": ".slds-button_inverse", "restrict": ".slds-button", "modifier": true, "group": "theme" }, "id": "inverse", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "destructive", "summary": "Creates a red button style", "selector": ".slds-button_destructive", "restrict": ".slds-button", "group": "theme", "modifier": true }, "id": "destructive", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "text-destructive", "summary": "Creates a neutral button with red text", "selector": ".slds-button_text-destructive", "restrict": ".slds-button", "modifier": true, "group": "theme" }, "id": "text-destructive", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "success", "summary": "Creates a green button style", "selector": ".slds-button_success", "restrict": ".slds-button", "group": "theme", "modifier": true }, "id": "success", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "with-icon", "summary": "Sizing for icon that sits inside button__icon", "selector": ".slds-button__icon", "restrict": ".slds-button svg", "support": "dev-ready", "variant": true }, "id": "with-icon", "restrictees": [ { "description": "", "annotations": { "summary": "Large size for button icon svg", "name": "large", "selector": ".slds-button__icon_large", "restrict": ".slds-button__icon", "support": "dev-ready", "modifier": true, "group": "size" }, "id": "large", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Small size for button icon svg", "name": "small", "selector": ".slds-button__icon_small", "restrict": ".slds-button__icon", "support": "dev-ready", "modifier": true, "group": "size" }, "id": "small", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "X-Small size for button icon svg", "name": "x-small", "selector": ".slds-button__icon_x-small", "restrict": ".slds-button__icon", "support": "dev-ready", "modifier": true, "group": "size" }, "id": "x-small", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "large", "summary": "Large size button icon svg", "selector": ".slds-button__icon_large", "restrict": ".slds-button__icon", "modifier": true, "group": "size" }, "id": "large", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "small", "summary": "Small size button icon svg", "selector": ".slds-button__icon_small", "restrict": ".slds-button__icon", "modifier": true, "group": "size" }, "id": "small", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "name": "x-small", "summary": "X-Small size button icon svg", "selector": ".slds-button__icon_x-small", "restrict": ".slds-button__icon", "modifier": true, "group": "size" }, "id": "x-small", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Position of icon when sitting to the left side of the text when inside a button", "selector": ".slds-button__icon_left", "restrict": ".slds-button__icon, .slds-button__icon_stateful" }, "id": ".slds-button__icon_left", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Position of icon when sitting to the right side of the text when inside a button", "selector": ".slds-button__icon_right", "restrict": ".slds-button__icon, .slds-button__icon_stateful" }, "id": ".slds-button__icon_right", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "selector": ".slds-icon_x-small", "restrict": ".slds-icon, .slds-button__icon", "modifier": true, "group": "size" }, "id": ".slds-icon_x-small", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/buttons/with-icon/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default", "label": "Default" } ] }, { "title": "examples", "items": [ { "id": "with-icon-right", "label": "With right icon" } ] }, { "title": "states", "items": [ { "id": "disabled", "label": "Disabled" } ] } ] }, { "description": "", "annotations": { "summary": "Creates a button style for full width that resets styling", "selector": ".slds-button_full-width", "restrict": ".slds-button", "modifier": true, "group": "size" }, "id": ".slds-button_full-width", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Creates a button style for 100% width with centered text that maintains current styling", "selector": ".slds-button_stretch", "restrict": ".slds-button", "modifier": true, "group": "size" }, "id": ".slds-button_stretch", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Positions decrement button within counter input field", "selector": ".slds-input__button_decrement", "restrict": " .slds-button" }, "id": ".slds-input__button_decrement", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Positions increment button within counter input field", "selector": ".slds-input__button_increment", "restrict": ".slds-button" }, "id": ".slds-input__button_increment", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/buttons/base/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default" } ] }, { "title": "examples", "items": [ { "id": "base-kinetics", "label": "Base (Kinetics)" }, { "id": "neutral", "label": "Neutral" }, { "id": "neutral-kinetics", "label": "Neutral (Kinetics)" }, { "id": "brand", "label": "Brand" }, { "id": "brand-kinetics", "label": "Brand (Kinetics)" }, { "id": "outline-brand", "label": "Outline Brand" }, { "id": "outline-brand-kinetics", "label": "Outline Brand (Kinetics)" }, { "id": "inverse", "label": "Inverse" }, { "id": "inverse-kinetics", "label": "Inverse (Kinetics)" }, { "id": "destructive", "label": "Destructive" }, { "id": "destructive-kinetics", "label": "Destructive (Kinetics)" }, { "id": "text-destructive", "label": "Text Destructive" }, { "id": "success", "label": "Success" }, { "id": "success-kinetics", "label": "Success (Kinetics)" }, { "id": "stretch", "label": "Stretch" }, { "id": "stretch-kinetics", "label": "Stretch (Kinetics)" }, { "id": "full-width", "label": "Full Width" }, { "id": "base-link", "label": "Base as a Link" }, { "id": "neutral-link", "label": "Neutral as a Link" }, { "id": "brand-link", "label": "Brand as a Link" }, { "id": "outline-brand-link", "label": "Outline Brand as a Link" }, { "id": "inverse-link", "label": "Inverse as a Link" }, { "id": "destructive-link", "label": "Destructive as a Link" }, { "id": "text-destructive-link", "label": "Text Destructive as a Link" }, { "id": "success-link", "label": "Success as a Link" }, { "id": "stretch-link", "label": "Stretch as a Link" }, { "id": "base-centering", "label": "Base Centering" }, { "id": "reset", "label": "Reset" } ] }, { "title": "states", "items": [ { "id": "disabled", "label": "Disabled" }, { "id": "base-kinetics-disabled", "label": "Base (Kinetics) - Disabled" }, { "id": "neutral-disabled", "label": "Neutral - Disabled" }, { "id": "neutral-kinetics-disabled", "label": "Neutral (Kinetics) - Disabled" }, { "id": "brand-disabled", "label": "Brand - Disabled" }, { "id": "brand-kinetics-disabled", "label": "Brand (Kinetics) - Disabled" }, { "id": "outline-brand-disabled", "label": "Outline Brand - Disabled" }, { "id": "outline-brand-kinetics-disabled", "label": "Outline Brand (Kinetics) - Disabled" }, { "id": "inverse-disabled", "label": "Inverse - Disabled" }, { "id": "destructive-disabled", "label": "Destructive - Disabled" }, { "id": "text-destructive-disabled", "label": "Text Destructive - Disabled" }, { "id": "success-disabled", "label": "Success - Disabled" } ] } ] }, { "description": "", "annotations": { "summary": "Initiates a dual stateful button", "name": "dual-stateful", "selector": ".slds-button_dual-stateful", "restrict": "button", "support": "dev-ready", "variant": true }, "id": "dual-stateful", "restrictees": [ { "description": "", "annotations": { "summary": "Shown text when button is not pressed - default state", "selector": ".slds-text-not-pressed", "restrict": ".slds-button_dual-stateful span" }, "id": ".slds-text-not-pressed", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Shown text when button is pressed", "selector": ".slds-text-pressed", "restrict": ".slds-button_dual-stateful span" }, "id": ".slds-text-pressed", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "When button is in pressed state", "selector": ".slds-is-pressed", "restrict": ".slds-button_dual-stateful", "notes": "This class should be toggled with JavaScript", "modifier": true, "group": "interaction" }, "id": ".slds-is-pressed", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/buttons/dual-stateful/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default", "label": "Default" } ] }, { "title": "examples", "items": [ { "id": "pressed", "label": "pressed" } ] }, { "title": "states", "items": [ { "id": "disabled", "label": "disabled" } ] } ] }, { "description": "", "annotations": { "summary": "Initiates a stateful button", "name": "stateful", "selector": ".slds-button_stateful", "restrict": "button", "support": "dev-ready", "variant": true, "lwc": true }, "id": "stateful", "restrictees": [ { "description": "Default state of a stateful button", "annotations": { "selector": ".slds-not-selected", "restrict": ".slds-button_stateful", "notes": "This class should be toggled with JavaScript", "modifier": true, "group": "interaction" }, "id": ".slds-not-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Shown text when button is selected", "selector": ".slds-text-selected", "restrict": ".slds-button_stateful span" }, "id": ".slds-text-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Shown text when button is selected and focused", "selector": ".slds-text-selected-focus", "restrict": ".slds-button_stateful span" }, "id": ".slds-text-selected-focus", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Shown text when button is not selected - default state", "selector": ".slds-text-not-selected", "restrict": ".slds-button_stateful span" }, "id": ".slds-text-not-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "When button is selected and still has focus from click", "selector": ".slds-is-selected-clicked", "restrict": ".slds-button_stateful", "notes": "This class should be toggled with JavaScript", "modifier": true, "group": "interaction" }, "id": ".slds-is-selected-clicked", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "When button is pressed and selected", "selector": ".slds-is-selected", "restrict": ".slds-button_stateful", "notes": "This class should be toggled with JavaScript", "modifier": true, "group": "interaction" }, "id": ".slds-is-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/buttons/stateful/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default" } ] }, { "title": "states", "items": [ { "id": "disabled", "label": "disabled" }, { "id": "selected", "label": "Selected" }, { "id": "selected-clicked", "label": "Selected and Clicked" } ] } ] } ], "docPath": "./ui/components/buttons/docs.mdx", "showcasePath": null, "showcase": [] }, "dueling-picklist": { "description": "", "annotations": { "summary": "A dueling-picklist is used to move options between two lists and is often referred to as a multi-select. Sometimes, the list options can then be re-ordered, depending on the use case.", "name": "dueling-picklist", "support": "dev-ready", "base": true, "role": "listbox", "lwc": true, "scroller": true, "type": "data-entry", "category": "experience", "s1": "false", "selector": ".slds-dueling-list" }, "id": "dueling-picklist", "restrictees": [ { "description": "A dueling picklist inherits styles from the listbox component", "annotations": { "summary": "Initializes a dueling picklist", "name": "base", "selector": ".slds-dueling-list", "restrict": "div", "support": "dev-ready", "variant": true }, "id": "base", "restrictees": [ { "description": "", "annotations": { "summary": "Handles the layout of the dueling picklist", "selector": ".slds-dueling-list__column", "restrict": ".slds-dueling-list div" }, "id": ".slds-dueling-list__column", "restrictees": [ { "description": "", "annotations": { "summary": "Changes the layout of the dueling picklist to be responsive", "selector": ".slds-dueling-list__column_responsive", "restrict": ".slds-dueling-list__column" }, "id": ".slds-dueling-list__column_responsive", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Bounding visual container for listbox of options", "selector": ".slds-dueling-list__options", "restrict": ".slds-dueling-list div" }, "id": ".slds-dueling-list__options", "restrictees": [ { "description": "Listbox container", "annotations": { "name": "listbox", "selector": ".slds-listbox", "restrict": ".slds-dropdown ul, .slds-dueling-list__options ul, .slds-pill_container ul, .slds-listbox_selection-group ul, .slds-combobox_container ul, .slds-form-element__control ul, .slds-popover__body ul", "support": "dev-ready", "variant": true }, "id": "listbox", "restrictees": [ { "description": "Inline listbox", "annotations": { "selector": ".slds-listbox_inline", "restrict": ".slds-listbox", "modifier": true }, "id": ".slds-listbox_inline", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Horizontal listbox", "annotations": { "selector": ".slds-listbox_horizontal", "restrict": ".slds-listbox", "modifier": true }, "id": ".slds-listbox_horizontal", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Listbox item", "annotations": { "selector": ".slds-listbox__item", "restrict": ".slds-listbox > li" }, "id": ".slds-listbox__item", "restrictees": [ { "description": "Choosable option within listbox", "annotations": { "selector": ".slds-listbox__option", "restrict": ".slds-listbox__item > div" }, "id": ".slds-listbox__option", "restrictees": [ { "description": "", "annotations": { "summary": "Header for choosable option within listbox", "selector": ".slds-listbox__option-header", "restrict": ".slds-listbox__option h3" }, "id": ".slds-listbox__option-header", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Container for listbox option icon", "selector": ".slds-listbox__option-icon", "restrict": ".slds-listbox__option span" }, "id": ".slds-listbox__option-icon", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Focus state of a vertical listbox option", "annotations": { "selector": ".slds-has-focus", "restrict": ".slds-listbox__option", "modifier": true }, "id": ".slds-has-focus", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Modifies the listbox option if it contains an entity object", "annotations": { "selector": ".slds-listbox__option_entity", "restrict": ".slds-listbox__option" }, "id": ".slds-listbox__option_entity", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Modifies the listbox option if it contains an plain object or string", "annotations": { "selector": ".slds-listbox__option_plain", "restrict": ".slds-listbox__option" }, "id": ".slds-listbox__option_plain", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "If the listbox option has metadata or secondary information that sits below its primary text", "annotations": { "selector": ".slds-listbox__option_has-meta", "restrict": ".slds-listbox__option" }, "id": ".slds-listbox__option_has-meta", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Modifier that makes selected icon visible", "annotations": { "selector": ".slds-is-selected", "restrict": ".slds-listbox__option", "modifier": true }, "id": ".slds-is-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "The main text of an entity listbox", "annotations": { "selector": ".slds-listbox__option-text_entity", "restrict": ".slds-listbox__option span" }, "id": ".slds-listbox__option-text_entity", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "The metadata or secondary text of an entity listbox", "annotations": { "selector": ".slds-listbox__option-meta", "restrict": ".slds-listbox__option span" }, "id": ".slds-listbox__option-meta", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "The icon within a plain listbox that indicates if an option has been selected or not.", "annotations": { "selector": ".slds-listbox__icon-selected", "restrict": ".slds-listbox__item svg" }, "id": ".slds-listbox__icon-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "Creates a vertical listbox", "annotations": { "selector": ".slds-listbox_vertical", "restrict": ".slds-listbox", "modifier": true }, "id": ".slds-listbox_vertical", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Forces overflow scrolling after 5 list items", "selector": ".slds-dropdown_length-5", "restrict": ".slds-dropdown, .slds-dropdown__list, .slds-listbox", "modifier": true, "group": "height" }, "id": ".slds-dropdown_length-5", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Forces overflow scrolling after 7 list items", "selector": ".slds-dropdown_length-7", "restrict": ".slds-dropdown, .slds-dropdown__list, .slds-listbox", "modifier": true, "group": "height" }, "id": ".slds-dropdown_length-7", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Forces overflow scrolling after 10 list items", "selector": ".slds-dropdown_length-10", "restrict": ".slds-dropdown, .slds-dropdown__list, .slds-listbox", "modifier": true, "group": "height" }, "id": ".slds-dropdown_length-10", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Forces overflow scrolling after 5 list items with an icon", "selector": ".slds-dropdown_length-with-icon-5", "restrict": ".slds-dropdown, .slds-dropdown__list, .slds-listbox", "modifier": true, "group": "height" }, "id": ".slds-dropdown_length-with-icon-5", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Forces overflow scrolling after 7 list items with an icon", "selector": ".slds-dropdown_length-with-icon-7", "restrict": ".slds-dropdown, .slds-dropdown__list, .slds-listbox", "modifier": true, "group": "height" }, "id": ".slds-dropdown_length-with-icon-7", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Forces overflow scrolling after 10 list items with an icon", "selector": ".slds-dropdown_length-with-icon-10", "restrict": ".slds-dropdown, .slds-dropdown__list, .slds-listbox", "modifier": true, "group": "height" }, "id": ".slds-dropdown_length-with-icon-10", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Selected/dragging state of a listbox option", "selector": ".slds-is-selected", "restrict": ".slds-dueling-list__options div" }, "id": ".slds-is-selected", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "grabbed state of a listbox option", "selector": ".slds-is-grabbed", "restrict": ".slds-dueling-list__options div" }, "id": ".slds-is-grabbed", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Disabled state of a picklist option", "selector": ".slds-is-disabled", "restrict": ".slds-dueling-list__options" }, "id": ".slds-is-disabled", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/dueling-picklist/base/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default" } ] }, { "title": "states", "items": [ { "id": "locked-item-dueling-picklist", "label": "Locked" }, { "id": "disabled-dueling-picklist", "label": "Disabled" }, { "id": "multi-select-selected-item", "label": "Selected Item" }, { "id": "multi-select-multi-selected-items", "label": "Multiple Selected Items" }, { "id": "multi-select-grabbed", "label": "Grabbed" }, { "id": "multi-select-moved-in", "label": "Moved in list" }, { "id": "multi-select-dropped", "label": "Dropped" }, { "id": "multi-select-moved-to", "label": "Moved to list" }, { "id": "no-reordering-dueling-picklist", "label": "No Reordering" }, { "id": "responsive-no-reordering-dueling-picklist", "label": "Responsive No Reordering" }, { "id": "view-mode-dueling-picklist", "label": "View Mode" }, { "id": "required-dueling-picklist", "label": "Required" }, { "id": "with-tooltip", "label": "With Tooltip" }, { "id": "required-dueling-picklist-with-tooltip", "label": "Required With Tooltip" } ] } ] } ], "docPath": "./ui/components/dueling-picklist/docs.mdx", "showcasePath": null, "showcase": [] }, "cards": { "description": "To initialize a card, apply the `.slds-card` class to a containing `
    `.\nA card is made up of three sections, a header, a body, and a footer.\nThe card header will get the `.slds-card__header` class.\nThe card body will get the `.slds-card__body` class. The card footer will\nget the `.slds-card__footer` class.", "annotations": { "summary": "Cards are used to apply a container around a related grouping of information.", "layout": "responsive", "name": "cards", "support": "dev-ready", "base": true, "styling-hooks": true, "role": "article", "lwc": true, "type": "data-display, layout", "category": "base, structure", "selector": ".slds-card, .slds-card-wrapper" }, "id": "cards", "restrictees": [ { "description": "", "annotations": { "summary": "Initializes card", "name": "base", "selector": ".slds-card", "restrict": "article, div, section", "support": "dev-ready", "variant": true }, "id": "base", "restrictees": [ { "description": "", "annotations": { "summary": "Used to bring back the border on a card when needed", "selector": ".slds-card_boundary", "restrict": ".slds-card" }, "id": ".slds-card_boundary", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Initializes card header", "selector": ".slds-card__header", "restrict": ".slds-card div" }, "id": ".slds-card__header", "restrictees": [ { "description": "", "annotations": { "summary": "Title element within card header", "selector": ".slds-card__header-title", "restrict": ".slds-card__header h2" }, "id": ".slds-card__header-title", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Actionable element within the card header title", "selector": ".slds-card__header-link", "restrict": ".slds-card__header h2 a" }, "id": ".slds-card__header-link", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "variant": true, "summary": "Einstein themed card header", "name": "einstein", "support": "dev-ready", "role": "article", "type": "layout", "restrict": ".slds-card__header", "category": "feature", "selector": ".slds-einstein-header" }, "id": "einstein", "restrictees": [ { "description": "", "annotations": { "summary": "Einstein themed card header figure", "selector": ".slds-einstein-header__figure", "restrict": ".slds-einstein-header, div, header" }, "id": ".slds-einstein-header__figure", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Einstein themed card header actions", "selector": ".slds-einstein-header__actions", "restrict": ".slds-einstein-header" }, "id": ".slds-einstein-header__actions", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/cards/einstein/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default" } ] }, { "title": "states", "items": [ { "id": "einstein-with-icon", "label": "Einstein card - with icon" }, { "id": "einstein-with-icon-and-actions", "label": "Einstein card - with icon and actions" } ] } ] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Initializes card body", "selector": ".slds-card__body", "restrict": ".slds-card div" }, "id": ".slds-card__body", "restrictees": [ { "description": "", "annotations": { "summary": "Apply the same spacing found on the card header to the card body", "selector": ".slds-card__body_inner", "restrict": ".slds-card__body" }, "id": ".slds-card__body_inner", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] }, { "description": "", "annotations": { "summary": "Initializes card footer", "selector": ".slds-card__footer", "restrict": ".slds-card footer" }, "id": ".slds-card__footer", "restrictees": [ { "description": "", "annotations": { "summary": "Actionable element within card footer", "selector": ".slds-card__footer-action", "restrict": ".slds-card__footer a" }, "id": ".slds-card__footer-action", "restrictees": [], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": null, "showcase": [] } ], "docPath": null, "showcasePath": "./ui/components/cards/base/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default", "label": "Default" } ] }, { "title": "examples", "items": [ { "id": "related-list-table", "label": "With data-table" }, { "id": "related-list-tiles", "label": "With tiles" }, { "id": "nested-cards", "label": "Nested cards" }, { "id": "with-no-header", "label": "With no header" }, { "id": "visibly-hidden-card-header", "label": "Visibly hidden card header" }, { "id": "body-has-no-padding", "label": "Body with no padding" }, { "id": "body-has-padding", "label": "Body with padding" }, { "id": "has-no-footer", "label": "No footer" }, { "id": "has-footer", "label": "Has footer" }, { "id": "nested-no-boundary", "label": "Nested with no boundary" }, { "id": "nested-with-boundary", "label": "Nested with boundary" }, { "id": "with-long-truncated-title", "label": "With long truncated title", "demoStyles": "max-width: 360px;", "storybookStyles": true }, { "id": "styling-hooks", "label": "Styling Hooks", "demoStyles": "\n --slds-c-card-color-background: #f3f3f3;\n --slds-c-card-radius-border: 8px;\n --slds-c-card-shadow: rgba(0,0,0,.15) 0 4px 8px, rgba(0,0,0,.05) 0 2px 4px;\n --slds-c-card-spacing-block-start: 1.5rem;\n --slds-c-card-spacing-block-end: 0.5rem;\n --slds-c-card-spacing-inline: 1rem;\n --slds-c-card-title-font-size: 1.5rem;\n --slds-c-card-header-spacing-block-start: 0;\n --slds-c-card-header-spacing-inline-start: 1.5rem;\n --slds-c-card-header-spacing-inline-end: 1.5rem;\n --slds-c-card-body-spacing-inline-start: 1.5rem;\n --slds-c-card-body-spacing-inline-end: 1.5rem;\n --slds-c-card-body-spacing-block-end: 1rem;\n --slds-c-card-footer-spacing-block-start: 0.5rem;\n --slds-c-card-footer-spacing-block-end: 0;\n --slds-c-card-footer-spacing-inline-start: 1.5rem;\n --slds-c-card-footer-spacing-inline-end: 1.5rem;\n --slds-c-card-footer-font-size: 0.75rem;\n --slds-c-card-footer-text-align: right;\n ", "storybookStyles": true } ] }, { "title": "states", "items": [ { "id": "empty", "label": "Empty" }, { "id": "empty-illustration", "label": "Empty with illustration" }, { "id": "loading", "label": "Loading" } ] } ] }, { "description": "", "annotations": { "name": "wrapper", "summary": "Removes the card look from nested cards and pulls them to the boundary of the card wrapper, making the nested cards look like they are inside of one card", "selector": ".slds-card-wrapper", "restrict": "div", "support": "dev-ready", "variant": true }, "id": "wrapper", "restrictees": [], "docPath": null, "showcasePath": "./ui/components/cards/wrapper/example.jsx", "showcase": [ { "title": "default", "items": [ { "id": "default", "label": "Default" } ] }, { "title": "examples", "items": [ { "id": "tabs-wrapper", "label": "Card wrapper for tabs" }, { "id": "styling-hooks", "label": "Styling Hooks", "demoStyles": "\n --slds-c-card-color-background: #f3f3f3;\n --slds-c-card-radius-border: 8px;\n --slds-c-card-shadow: rgba(0,0,0,.15) 0 4px 8px, rgba(0,0,0,.05) 0 2px 4px;\n --slds-c-card-spacing-block-start: 1.5rem;\n --slds-c-card-spacing-block-end: 0.5rem;\n --slds-c-card-title-font-size: 1.5rem;\n --slds-c-card-header-spacing-block-start: 0;\n --slds-c-card-header-spacing-inline-start: 1.5rem;\n --slds-c-card-header-spacing-inline-end: 1.5rem;\n --slds-c-card-body-spacing-inline-start: 1.5rem;\n --slds-c-card-body-spacing-inline-end: 1.5rem;\n --slds-c-card-body-spacing-block-end: 1rem;\n --slds-c-card-footer-spacing-block-start: 0.5rem;\n --slds-c-card-footer-spacing-block-end: 0;\n --slds-c-card-footer-spacing-inline-start: 1.5rem;\n --slds-c-card-footer-spacing-inline-end: 1.5rem;\n --slds-c-card-footer-font-size: 0.75rem;\n --slds-c-card-footer-text-align: right;\n ", "storybookStyles": true } ] } ] } ], "docPath": "./ui/components/cards/docs.mdx", "showcasePath": null, "showcase": [] }, "checkbox": { "description": "The ability to style checkboxes with CSS varies across browsers.\nTo ensure that checkboxes look the same everywhere, we use a custom DOM.\nPay close attention to the markup, because all elements must exist for the\nstyles to work.\n\n#### Accessibility\n\nGroups of checkboxes should be marked up using the fieldset and legend\nelement. This helps someone using assistive technology to understand the\nquestion they're answering with the group of checkboxes. The fieldset is\nplaced around the whole group and the legend contains the question.\n\nCustom checkboxes are created by applying the `.slds-checkbox` class to\na `