Porsche Design System Search Navigate to GitHub repository of Porsche Design System Open sidebar Introduction
Table of Contents
Start Coding#
Porsche Design System provides developers with versioned packages of Web components , Angular components , React
components and Vue components to build clean and high-quality frontends that innately come with the latest design
definitions.
To enable a smooth start with the Porsche Design System we have created sample projects in all common frameworks.
These projects show how to install and the usage of the Porsche Design System. Furthermore, the example projects contain
examples and solutions for testing.
Requirements#
Node.js & NPM
Get required npm-packages
All releases of the Porsche Design System are available as versioned npm packages. Please read more about them on the
corresponding docs.
Web components : @porsche-design-system/components-js
Angular components : @porsche-design-system/components-angular
React components : @porsche-design-system/components-react
Next.js components : @porsche-design-system/components-react/ssr
Remix components : @porsche-design-system/components-react/ssr
Vue components : @porsche-design-system/components-vue
Those packages can be consumed by the following public npm registry:
npm registry (https://npmjs.com )
yarn registry (https://yarnpkg.com )
Global settingsTheme
ThemeMore information Changes 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. // TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
Light// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
Dark// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
Auto (sync with operating system)DirectionMore information Changes the direction of HTML elements, mostly used on<html>
tag to support languages which are read from right to left like e.g. Arabic. // TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
LTR (left-to-right)// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
RTL (right-to-left)// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
AutoText ZoomMore information Changes the text size and values with unit rem
or em
relatively. This setting can be defined in browser settings for any website or by an application itself on<html>
tag. To achieve WCAG 2.2 AA compliance it's obligatory to support text zoom up to at least 200%. // TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
100%// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
130%// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
150%// TODO: get rid of ARIA sprouting and use `elementInternals` API when AXE-CORE supports it: https://github.com/dequelabs/axe-core/issues/4259
200%