Porsche Design System
You are currently viewing an earlier release of the Porsche Design System.Switch to the latest Porsche Design System documentation.
SearchNavigate to GitHub repository of Porsche Design SystemOpen sidebar
ConfiguratorUsageAccessibilityAPI
Canvas 🧪 Table of ContentsPropertiesPropertyAttributeDescriptionTypeDefaultbackground backgroundDefines the background color of the main section and auto adjust it for the sidebartype CanvasBackground =
'canvas'
'surface'
'canvas'
sidebarEndOpen sidebar-end-openOpen the sidebar on the end sidebooleanfalsesidebarStartOpen sidebar-start-openOpen the sidebar on the start sidebooleanfalse
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.CSS VariablesCSS VariableDescriptiondefaultValue--p-canvas-sidebar-start-width Width of the sidebar start.320px--p-canvas-sidebar-end-width Width of the sidebar end.320px
Global settingsColor SchemeAll color tokens use the light-dark() CSS function. Set the theme via the CSS color-scheme property: light for light mode, dark for dark mode, or light dark to follow the user's system preference.LightDarkLight DarkDirectionThe 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%