@db-ui/foundations
Advanced tools
Comparing version 0.0.56 to 0.0.57
@@ -19,2 +19,9 @@ { | ||
}, | ||
"screens": { | ||
"xs": "360px", | ||
"sm": "720px", | ||
"md": "1024px", | ||
"lg": "1440px", | ||
"xl": "1920px" | ||
}, | ||
"spacing": { | ||
@@ -21,0 +28,0 @@ "0": 0, |
{ | ||
"name": "@db-ui/foundations", | ||
"version": "0.0.56", | ||
"version": "0.0.57", | ||
"description": "Provides basic tokens and assets based on DB UX Design System Core.", | ||
@@ -43,4 +43,4 @@ "repository": { | ||
"oslllo-svg-fixer": "^3.0.0", | ||
"sass": "^1.69.4", | ||
"style-dictionary": "3.8.0", | ||
"sass": "^1.69.5", | ||
"style-dictionary": "3.9.0", | ||
"svgtofont": "^4.0.0" | ||
@@ -47,0 +47,0 @@ }, |
@@ -8,3 +8,3 @@ # @db-ui/foundations | ||
A library containing all tokens of [DB UX Design System (technical components)](https://github.com/db-ui/mono). | ||
A library containing all tokens (colors, icons, variables) of [DB UX Design System (technical components)](https://github.com/db-ui/mono). | ||
@@ -26,3 +26,3 @@ We currently support: | ||
- [Tonality](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system-v3/principles/tonalities): `regular` | ||
- [Adaptive Coloring](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system-v3/principles/adaptive-styles): `neutral-0` | ||
- [Adaptive Coloring](https://marketingportal.extranet.deutschebahn.com/marketingportal/Design-Anwendungen/db-ux-design-system-v3/principles/adaptive-styles): `base` | ||
@@ -105,58 +105,2 @@ ### CSS | ||
## Icons | ||
We use icon fonts as `woff2` files for all our icons. | ||
We auto generate these files out of `.svg` files. | ||
### Custom Icons | ||
If you have custom icons and want to use them for foundations and/or in components, you need to generate a `woff2` file. | ||
For this run: | ||
```shell | ||
node node_modules/@db-ui/foundations/scripts/generate-icon-fonts/index.js --src ./my-path-to/icons --fontName my-name | ||
``` | ||
We search for all `**/*.svg` files inside the `src` directory and create a new icon font with the provided name. | ||
> **_NOTE:_** We use 3 different sizes for components (16,20,24) to show more or less details. You can do the same by providing another file with a size postfix for example "icon_file_name_16.svg". | ||
In your app you need to include some of the generated files: | ||
`./my-path-to/icons/fonts/my-name.woff2` | ||
`./my-path-to/icons/fonts/font-face.css` | ||
Now you can use your icons with your `font-family: my-name`, e.g.: | ||
```html | ||
<!--example.html--> | ||
<i class="my-name">icon_file_name</i> | ||
``` | ||
### data-icon | ||
If you like to use a custom icon in one of our components you can do it by overwriting the default font-family like this: | ||
```html | ||
<!--example.html--> | ||
<p class="icon-family-my-name" data-icon="icon_file_name">Test</p> | ||
<!-- or --> | ||
<p data-icon-family="my-name" data-icon="icon_file_name">Test</p> | ||
``` | ||
### Foundation Developer | ||
If you update a `svg` inside `assets/icons/functional/images` you need to recreate the `woff2` file. | ||
For this you just need to run | ||
```shell | ||
npm run generate:icon-fonts | ||
``` | ||
Your new icon should be inside `assets/icons/functional/fonts/info.json` and you should see it inside `assets/icons/functional/fonts/index.html` in the browser. | ||
## Deutsche Bahn brand | ||
@@ -163,0 +107,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
2705008
642
2564
174
7
20
3
122