DB UX Design System v3 🚂💖

DB UX Design System v3 provides robust HTML UI components, reusable visual styles, and powerful tooling to help developers, designers, and content authors build, maintain, and scale best-of-class digital experiences.

We’re not designing pages anymore. We’re designing systems of components. Stephen Hay. Cited in a talk by Brad Frost at beyond tellerrand conference.

Packages

Package	Content	Version
foundations	CSS/SCSS/Tailwind styles and assets
components	CSS/SCSS styles for components
ngx-core-components	Native Angular components
react-core-components	Native React components
v-core-components	Native Vue 3 components
wc-core-components	Web Components

How to use

Install your preferred package via npm or yarn e.g. npm i @db-ux/react-core-components.

Afterwards, you need to include the specific CSS or SCSS files to apply the styles of DB UX Design System (Version 3), as described in the "Styling Dependencies" section of each package's README. We even provide some examples of integrations.

DB Theme

In case that you're building a website or application for Deutsche Bahn, you'll additionally have to install the DB Theme via the @db-ux/db-theme node package (even also available as an inner source node package, as described within that packages README).

Components

We maintain a status overview for all components.

Core principles

Consistent & Compliant

DB UX Design System Core Web is part of DB UX Design System, that are the guidelines for any Personenverkehr Customer and Deutsche Bahn Enterprise website and web applications.

Accessible

DB UX Design System leverages semantic HTML, ARIA roles, states and properties to apply our styles wherever possible, thus enforcing correct, accessible markup. And we're quality checking this in partnership with the Team Digital Accessibility.

Declarative

DB UX Design System uses declarative selectors instead of visual helpers to ensure our HTML class names and structure are human read- and understandable, lean, performant and so much easier to update.

Evergreen

As DB UX Design System evolves, so does DB UX Design System version 3, meaning apps only need to keep their DB UX Design System Core Web package updated to ensure the latest look and feel.

Migration

From DB UI Core or DB UI Elements to DB UX Design System Core

We're providing a detailed migration for each component next to the documentation of each component, like e.g. https://design-system.deutschebahn.com/core-web/review/main/components/action/button/migration

In between DB UX Design System Core versions

Check our migration docs for breaking changes:

1. Alpha ➡ Beta (0.0.x➡0.x.x)
2. v0.2 ➡ v0.3
3. v0.3 ➡ v0.4
4. v0.4 ➡ v0.5: no migration needed, no breaking changes
5. v0.5 ➡ v0.6
6. v0.6 ➡ v0.7
7. v0.7 ➡ v1.0
8. v1.x ➡ v2.0

FAQ

Unexpected "new" colors

We've updated to the stable version of DB UX Design System (v3) version >= 1.x, and now the colors that were supposed to be red, are colored in blue (514ec7).

Please have a look at the migration guide from version 0.6.x to version 0.7.x, you need to install and reference the DB Theme, if you're building a website or web application for Deutsche Bahn.

Things to keep in mind

Developed for and driven by the community

This is mainly a platform providing the space and technology for a common basis of curated components; their development is mainly driven by the community and adapted out of the work done in projects and through the huge amount of feedback that we're gaining out of the community. So please support us in any way possible, this is greatly appreciated!

How to start developing / contributing

If you're working as a developer on the DB UX Design System or would like to contribute (many kudos for that !), please have a look at the relevant development documentation. We even also tag issues that might be a good starter for code contributions by the tag "good first issue".

Give us your feedback!

This is only the first version of our framework and we really want your feedback - either within the DB UX Design System Channel by Web Dev Community in Microsoft Teams (only available DB internally), or directly at db-ux-designsystem@deutschebahn.com. We're particularly keen to add as many examples to the behaviours as possible, to further clarify them.

Deutsche Bahn brand

To perfectly support our users and customers on their digital journey, the use of the Deutsche Bahn brand and trademarks is subject to clear guidelines and restrictions even when used with the code provided by this product. Deutsche Bahn fully reserves all rights and ownership regarding the Deutsche Bahn brand, even though we provide the code for DB UX Design System products free of charge under the Apache 2.0 license. Please refer to our brand portal at https://marketingportal.extranet.deutschebahn.com/ for further questions contact details regarding brand issues. As these assets and visual guidelines are retrieved from our Deutsche Bahn Marketingportal, you'll agree with the "Allgemeine Nutzungsbedingungen für das DB-Marketingportal" (german) in case of using them.

For any usage outside of Deutsche Bahn websites and applications you aren't allowed to use any Deutsche Bahn brand and design assets as well as protected characteristics and trademarks, that for not including the DB Theme.

Contributions

Contributions are very welcome, please refer to the contribution guide.

Code of conduct

We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone – have a look at our Contributor Covenant Code of Conduct.

License

This project is licensed under the Apache-2.0 license. © 2024 DB Systel GmbH.