Porsche Design SystemSearchNavigate to GitHub repository of Porsche Design SystemOpen sidebar
ConfiguratorUsageAccessibilityAPI
Canvas 🧪 Table of ContentsPropertiesPropertyAttributeDescriptionTypeDefaultsidebarEndOpen sidebar-end-openOpen the sidebar on the end sidebooleanfalsesidebarStartOpen sidebar-start-openOpen the sidebar on the start sidebooleanfalsetheme themeAdapts the color depending on the theme.type Theme =
'light'
'dark'
'auto'
'light'
EventsEventDescriptionTypesidebarEndDismiss Emitted when the sidebar end requests to be dismissed.CustomEvent<void>sidebarStartUpdate Emitted when the sidebar start requests to be opened or dismissed.type CanvasSidebarStartUpdateEventDetail = {
  open: boolean;
}
CustomEvent<CanvasSidebarStartUpdateEventDetail>
SlotsSlotDescriptionisRequiredaltPropallowedTagNames<slot name="title"> Renders the application name in the header section of the sidebar start area.<slot name="header-start"> Renders a **sticky** header section above the content area on the **start** side (**left** in **LTR** mode / **right** in **RTL** mode).<slot name="header-end"> Renders a **sticky** header section above the content area on the **end** side (**right** in **LTR** mode / **left** in **RTL** mode).<slot> Default slot for the main content.<slot name="footer"> Renders a **sticky** footer section underneath the main content.<slot name="sidebar-start"> Renders a sidebar area on the **start** side (**left** in **LTR** mode / **right** in **RTL** mode). On mobile view it transforms into a flyout.<slot name="sidebar-end"> Renders a sidebar area on the **end** side (**right** in **LTR** mode / **left** in **RTL** mode). On mobile view it transforms into a flyout.<slot name="sidebar-end-header"> Renders in the header section of the sidebar end area.<slot name="background"> Can be used to pass a sticky media element <img/> or <video/> placed underneath the main content.
Global settingsThemeChanges the theme of the application and any Porsche Design System component. It's possible to choose between forced theme light and dark. It's also possible to use auto, which applies light or dark theme depending on the operating system settings automatically.LightDarkAuto (sync with operating system)DirectionThe dir global attribute in HTML changes the direction of text and other content within an element. It's most often used on the <html> tag to set the entire page's direction, which is crucial for supporting languages that are written from right to left (RTL), such as Arabic and Hebrew. For example, using <html dir="rtl"> makes the entire page display from right to left, adjusting the layout and text flow accordingly.LTR (left-to-right)RTL (right-to-left)Text ZoomTo ensure accessibility and comply with WCAG 2.2 AA standards, it is mandatory for web content to support text resizing up to at least 200% without loss of content or functionality. Using relative units like rem is a best practice for achieving this, as they allow the text to scale uniformly based on the user's browser settings.100%130%150%200%