Skip to content

Commit 7989830

Browse files
feat: doc 4 users (#612)
# Contents Updates aan de documentatie voor gebruikers --------- Co-authored-by: Fionn Mac an Bhaird <33222605+FinnWard@users.noreply.github.com>
1 parent a5659aa commit 7989830

File tree

1 file changed

+28
-23
lines changed
  • proprietary/lux-community-design-tokens

1 file changed

+28
-23
lines changed

proprietary/lux-community-design-tokens/readme.md

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ zodat de github action eigenlijk al niet accepteert zodra er dingen van RHC word
1010
In plaats hiervan wordt geadviseerd om eigen token sets te maken, bijvoorbeeld met naam `overrides/*`, en die dan voor
1111
jouw thema aan te zetten.
1212

13-
## Installeren
13+
## Installatie
1414

1515
### NPM
1616

@@ -24,48 +24,53 @@ jouw thema aan te zetten.
2424

2525
`pnpm add @lux-design-system/lux-community-design-tokens --save-dev`
2626

27-
## Genereren
27+
## Gebruik
2828

29-
Er komt een script waarmee de RHC design tokens (uit een andere package `@lux-design-system/design-tokens` in deze zelfde repository) lokaal worden
30-
samengevoegd met de overwrites uit de projecten. Zo kunnen designers en developers samenwerken met Figma (en Tokens
31-
Studio) en code.
32-
Dan zijn de volgende producten beschikbaar:
29+
In de map `/dist/` staan de CSS-variabelen, die kun je zo importeren en in je project gebruiken. Om de design tokens als CSS-variabelen te gebruiken zijn er verschillende methoden.
30+
31+
### Via Webpack
3332

34-
### JSON
33+
Als je de tokens installeert (en de afhankelijkheid beheert) via een [package manager](#installatie).
34+
Root CSS-variabelen inladen:
3535

36-
Tokens die vanuit Tokens Studio en Figma gegenereerd worden.
37-
Meer informatie over de LUX design tokens en de lagen vind je op de pagina [Design Tokens](https://nl-design-system.github.io/lux/?path=/docs/design-tokens-design-tokens--docs) van onze Storybook.
36+
```javascript
37+
import "@lux-design-system/lux-community-design-tokens/dist/index.css";
38+
```
3839

39-
### CSS
40+
Of thema-specifieke CSS-variabelen inladen:
4041

41-
In de map `/dist/` staan de CSS-variabelen, die kun je zo importeren en in je project gebruiken.
42+
```javascript
43+
import "@lux-design-system/lux-community-design-tokens/dist/bwbapp/index.css";
44+
```
4245

43-
#### Gebruik
46+
Vervang in bovenstaande voorbeelden `.css` door `.scss` als je Sass wilt gebruiken.
4447

45-
Om de design tokens als CSS-variabelen te gebruiken zijn er verschillende methoden. Een aantal voorbeelden.
48+
### Via Unpkg (unsupported & niet aangeraden voor productie)
4649

47-
In de `<head>` sectie van je HTML-pagina, vanaf de Unpkg CDN:
50+
In de `<head>` sectie van je HTML-pagina.
51+
Root CSS-variabelen inladen:
4852

4953
```html
50-
<!-- :root-versie -->
51-
<link rel="stylesheet" href="https://unpkg.com/@lux-design-system/lux-community-design-tokens/dist/logius/index.css" />
54+
<link rel="stylesheet" href="https://unpkg.com/@lux-design-system/lux-community-design-tokens/dist/variables.css" />
5255
```
5356

57+
Thema-specifieke CSS-variabelen inladen:
58+
5459
```html
55-
<!-- theme-versie -->
5660
<link
5761
rel="stylesheet"
58-
href="https://unpkg.com/@lux-design-system/lux-community-design-tokens/dist/logius/index-theme.css"
62+
href="https://unpkg.com/@lux-design-system/lux-community-design-tokens/dist/bwbapp/variables.css"
5963
/>
6064
```
6165

66+
Thema instellen:
67+
6268
```html
63-
<!-- theme -->
6469
<div class="lux-theme--logius-dark">...</div>
6570
```
6671

67-
Via Webpack als je installeert via een [package manager](#installeren):
72+
## Automatisch samenvoeging
6873

69-
```javascript
70-
import "@lux-design-system/lux-community-design-tokens/dist/logius/index.css";
71-
```
74+
Er is een script, `merge-token-sets.mjs` waarmee de RHC design tokens (uit de package `@rijkshuisstijl-community/design-tokens`) worden
75+
samengevoegd met de overwrites uit de projecten. Zo kunnen designers en developers samenwerken met Figma (en Tokens
76+
Studio) en code. Na samenvoeging wordt de transformatie van token file naar exports gerund en zo komen de hierboven genoemde exports (.css en .scss) beschikbaar.

0 commit comments

Comments
 (0)