@db-ui/web-components

@db-ui/web-components

A web-component library containing all components of DB UX Design System (technical components).

Install

npm i @db-ui/web-components

Note: This will install @db-ui/foundations and @db-ui/components as well which contains the css/scss files

Styling Dependencies

Import the styles in scss or css. Based on your technology the file names could be different.

• Default (relative): points to ../assets
• Rollup (rollup): points to @db-ui/foundations/assets
• Webpack (webpack): points to ~@db-ui/foundations/assets

SCSS

// index.scss
@forward "@db-ui/components/build/styles/rollup";

CSS

// main.js
import "@db-ui/components/build/styles/rollup.css";

Note: The @db-ui/components/build/styles/relative file contains optional and all components styles. If you consider performance issues see @db-ui/components for more information.

Usage

// main.js
import { defineCustomElements } from "@db-ui/web-components";
defineCustomElements();

...
<db-button icon="x_placeholder">Test</db-button>
...

VSCode autocomplete

If you don't have it already, add a VS Code settings folder and file at the root of your project - .vscode/settings.json. Then add or append the following code:

{
	"html.customData": [
		"./node_modules/@db-ui/web-components/dist/vscode.html-custom-data.json"
	]
}

Deutsche Bahn brand

As we'd like to perfectly support our users and customers on their digital journey, the usage of Deutsche Bahn brand and trademarks are bound of clear guidelines and restrictions even when being used with the code that we're provide with this product; Deutsche Bahn fully reserves all rights regarding the Deutsche Bahn brand, even though that we're providing the code of DB UI products free to use and release it under the Apache 2.0 license. Please have a look at our brand portal at https://marketingportal.extranet.deutschebahn.com/ for any further questions and whom to contact on any brand issues.

You must remove or replace any Deutsche Bahn brand and design assets as well as protected characteristics and trademarks. We're even also planning to provide a neutral theme that would make it much easier for you to use our product without the trademarks by Deutsche Bahn.

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 Apache-2.0.