@amsterdam/design-system-tokens 0.11.0 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +40 -14
- package/README.md +197 -1
- package/dist/compact.css +16 -16
- package/dist/compact.scss +16 -16
- package/dist/compact.theme.css +16 -16
- package/dist/index.css +827 -778
- package/dist/index.d.ts +145 -48
- package/dist/index.json +159 -62
- package/dist/index.mjs +96 -47
- package/dist/index.scss +827 -778
- package/dist/index.theme.css +827 -778
- package/package.json +10 -5
- package/src/common/ams/link-appearance.tokens.json +18 -6
- package/src/components/ams/action-group.tokens.json +7 -0
- package/src/components/ams/avatar.tokens.json +3 -0
- package/src/components/ams/breakout.tokens.json +11 -0
- package/src/components/ams/button.tokens.json +4 -0
- package/src/components/ams/description-list.tokens.json +6 -6
- package/src/components/ams/dialog.tokens.json +4 -9
- package/src/components/ams/hint.tokens.json +7 -0
- package/src/components/ams/icon-button.tokens.json +2 -2
- package/src/components/ams/image-slider.tokens.json +26 -0
- package/src/components/ams/link-list.tokens.json +6 -6
- package/src/components/ams/link.tokens.json +8 -8
- package/src/components/ams/ordered-list.tokens.json +4 -1
- package/src/components/ams/password-input.tokens.json +33 -0
- package/src/components/ams/radio.tokens.json +36 -35
- package/src/components/ams/search-field.tokens.json +1 -3
- package/src/components/ams/unordered-list.tokens.json +4 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,8 +3,47 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
-
## [0.
|
|
6
|
+
## [0.13.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.12.0...design-system-tokens-v0.13.0) (2024-10-28)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### ⚠ BREAKING CHANGES
|
|
10
|
+
|
|
11
|
+
* Rename Description List ‘details’ to ’description’ ([#1703](https://github.com/Amsterdam/design-system/issues/1703))
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* Rename Description List ‘details’ to ’description’ ([#1703](https://github.com/Amsterdam/design-system/issues/1703)) ([139d8cb](https://github.com/Amsterdam/design-system/commit/139d8cb5c8fc4ffc93a2283abeabda6b8364b7cc))
|
|
7
16
|
|
|
17
|
+
## [0.12.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.11.0...design-system-tokens-v0.12.0) (2024-10-25)
|
|
18
|
+
|
|
19
|
+
### ⚠ BREAKING CHANGES
|
|
20
|
+
|
|
21
|
+
* Support various column widths for Description List ([#1697](https://github.com/Amsterdam/design-system/issues/1697))
|
|
22
|
+
* Make terms bold instead of descriptions in Description List ([#1693](https://github.com/Amsterdam/design-system/issues/1693))
|
|
23
|
+
* Add Action Group component, e.g. to wrap Dialog buttons in ([#1592](https://github.com/Amsterdam/design-system/issues/1592))
|
|
24
|
+
* Use inline SVG icon for Radio button ([#1460](https://github.com/Amsterdam/design-system/issues/1460))
|
|
25
|
+
* Remove unnecessary Dialog wrapper ([#1591](https://github.com/Amsterdam/design-system/issues/1591))
|
|
26
|
+
* Remove form from Dialog ([#1582](https://github.com/Amsterdam/design-system/issues/1582))
|
|
27
|
+
* Replace ‘on background’ props with ‘inverseColor’ and ‘contrastColor’ for Link, Link List Link, and Icon Button ([#1448](https://github.com/Amsterdam/design-system/issues/1448))
|
|
28
|
+
|
|
29
|
+
### Features
|
|
30
|
+
|
|
31
|
+
* Add Action Group component, e.g. to wrap Dialog buttons in ([#1592](https://github.com/Amsterdam/design-system/issues/1592)) ([d0ea054](https://github.com/Amsterdam/design-system/commit/d0ea054b98a7f2ee41bd9a8434b76a85e9b8c9f2))
|
|
32
|
+
* Add border to Avatar in forced colors mode ([#1578](https://github.com/Amsterdam/design-system/issues/1578)) ([1f29f35](https://github.com/Amsterdam/design-system/commit/1f29f358ab7b831c502e8fa2cbd284d1853ff6af))
|
|
33
|
+
* Add Breakout component that lets a figure stick out of a Spotlight ([#1397](https://github.com/Amsterdam/design-system/issues/1397)) ([715f4d6](https://github.com/Amsterdam/design-system/commit/715f4d6241353b9b9f1f68dad7b7773b9c618492))
|
|
34
|
+
* Add Hint as component and Label and FieldSet props ([#1499](https://github.com/Amsterdam/design-system/issues/1499)) ([3d86882](https://github.com/Amsterdam/design-system/commit/3d86882f22e4629a17a98cbbf96f03ad56620be9))
|
|
35
|
+
* Add initial Password Input component ([#1449](https://github.com/Amsterdam/design-system/issues/1449)) ([3cc863e](https://github.com/Amsterdam/design-system/commit/3cc863ec8f1f2b50f79a426fd41676ab05838768))
|
|
36
|
+
* Allow Button to display an icon without a label ([#1654](https://github.com/Amsterdam/design-system/issues/1654), [#1700](https://github.com/Amsterdam/design-system/issues/1700)) ([2d347b6](https://github.com/Amsterdam/design-system/commit/2d347b654b701cd6cce9182d5b6837960f41b551), [33c4c0e](https://github.com/Amsterdam/design-system/commit/33c4c0edefdf9c785bb828b0c61f0a120d697b02))
|
|
37
|
+
* Image slider ([#1595](https://github.com/Amsterdam/design-system/issues/1595)) ([58e7766](https://github.com/Amsterdam/design-system/commit/58e77661ad99acb5d3f6e10cbfca981345dc8704))
|
|
38
|
+
* Make terms bold instead of descriptions in Description List ([#1693](https://github.com/Amsterdam/design-system/issues/1693)) ([cc8f40e](https://github.com/Amsterdam/design-system/commit/cc8f40e631669a2f3423b7f55b8b129c025efcf9))
|
|
39
|
+
* Remove form from Dialog ([#1582](https://github.com/Amsterdam/design-system/issues/1582)) ([4fb6e53](https://github.com/Amsterdam/design-system/commit/4fb6e53441f3bae914eb483da2f0537a65273fd2))
|
|
40
|
+
* Remove unnecessary Dialog wrapper ([#1591](https://github.com/Amsterdam/design-system/issues/1591)) ([450b0c3](https://github.com/Amsterdam/design-system/commit/450b0c3e9adf5bdd9fb868400e17aaaea4b2c545))
|
|
41
|
+
* Replace ‘on background’ props with ‘inverseColor’ and ‘contrastColor’ for Link, Link List Link, and Icon Button ([#1448](https://github.com/Amsterdam/design-system/issues/1448)) ([f5176b1](https://github.com/Amsterdam/design-system/commit/f5176b1e2c85c166fa2b6cb67d11ce0b1f9727a3))
|
|
42
|
+
* Support various column widths for Description List ([#1697](https://github.com/Amsterdam/design-system/issues/1697)) ([5a98c07](https://github.com/Amsterdam/design-system/commit/5a98c07cad19eea38a2ff299378dc4dc5b80018c))
|
|
43
|
+
* Update spacing in Ordered and Unordered List ([#1632](https://github.com/Amsterdam/design-system/issues/1632)) ([986e023](https://github.com/Amsterdam/design-system/commit/986e023b83007560911724e819f54fb18c97f1dc))
|
|
44
|
+
* Use inline SVG icon for Radio button ([#1460](https://github.com/Amsterdam/design-system/issues/1460)) ([c19055b](https://github.com/Amsterdam/design-system/commit/c19055bd6453ce40ca43b31d599f14ec65d6037a))
|
|
45
|
+
|
|
46
|
+
## [0.11.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.10.0...design-system-tokens-v0.11.0) (2024-07-25)
|
|
8
47
|
|
|
9
48
|
### ⚠ BREAKING CHANGES
|
|
10
49
|
|
|
@@ -26,7 +65,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
26
65
|
|
|
27
66
|
## [0.10.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.9.0...design-system-tokens-v0.10.0) (2024-06-28)
|
|
28
67
|
|
|
29
|
-
|
|
30
68
|
### ⚠ BREAKING CHANGES
|
|
31
69
|
|
|
32
70
|
* Allow additional background colours for Avatar and remove dark blue option ([#1257](https://github.com/Amsterdam/design-system/issues/1257))
|
|
@@ -39,7 +77,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
39
77
|
|
|
40
78
|
## [0.9.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.8.0...design-system-tokens-v0.9.0) (2024-06-05)
|
|
41
79
|
|
|
42
|
-
|
|
43
80
|
### ⚠ BREAKING CHANGES
|
|
44
81
|
|
|
45
82
|
* Disallow directional style rules ([#1245](https://github.com/Amsterdam/design-system/issues/1245))
|
|
@@ -63,7 +100,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
63
100
|
* Use invalid prop for most inputs ([#1240](https://github.com/Amsterdam/design-system/issues/1240)) ([9477186](https://github.com/Amsterdam/design-system/commit/9477186b8432d6d20991e93d92c64a4357d6f391))
|
|
64
101
|
* Use logical properties for Search Field, Select, Text Area and Text Input ([#1226](https://github.com/Amsterdam/design-system/issues/1226)) ([4471c7a](https://github.com/Amsterdam/design-system/commit/4471c7a154e9f1f31dd92298f932f4bbc134dbf9))
|
|
65
102
|
|
|
66
|
-
|
|
67
103
|
### Bug Fixes
|
|
68
104
|
|
|
69
105
|
* Disallow directional style rules ([#1245](https://github.com/Amsterdam/design-system/issues/1245)) ([8ab6f81](https://github.com/Amsterdam/design-system/commit/8ab6f81d4cbcdb75b7acb986a145d49ccd1895c8))
|
|
@@ -71,7 +107,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
71
107
|
|
|
72
108
|
## [0.8.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.7.1...design-system-tokens-v0.8.0) (2024-04-22)
|
|
73
109
|
|
|
74
|
-
|
|
75
110
|
### ⚠ BREAKING CHANGES
|
|
76
111
|
|
|
77
112
|
* Rename Form Label to Label ([#1201](https://github.com/Amsterdam/design-system/issues/1201))
|
|
@@ -91,27 +126,23 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
91
126
|
* Time input component ([#1202](https://github.com/Amsterdam/design-system/issues/1202)) ([ccec68e](https://github.com/Amsterdam/design-system/commit/ccec68efafa02d5f9ac9bd4abea6c5e7cb72d556))
|
|
92
127
|
* Use fluid gaps in Page Menu ([#1146](https://github.com/Amsterdam/design-system/issues/1146)) ([848223b](https://github.com/Amsterdam/design-system/commit/848223bed7c0ad95de9ce1911c7313104a938f5b))
|
|
93
128
|
|
|
94
|
-
|
|
95
129
|
### Bug Fixes
|
|
96
130
|
|
|
97
131
|
* Use correct text size in Text Input, Search Field, and Text Area ([#1150](https://github.com/Amsterdam/design-system/issues/1150)) ([d5462e4](https://github.com/Amsterdam/design-system/commit/d5462e4537cfb39d62d0cd31564cfff086238330))
|
|
98
132
|
|
|
99
133
|
## [0.7.1](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.7.0...design-system-tokens-v0.7.1) (2024-03-22)
|
|
100
134
|
|
|
101
|
-
|
|
102
135
|
### Features
|
|
103
136
|
|
|
104
137
|
* Add Avatar component ([#1134](https://github.com/Amsterdam/design-system/issues/1134)) ([8dec2cf](https://github.com/Amsterdam/design-system/commit/8dec2cff8f7885ccb163774c0dc979fb2c781256))
|
|
105
138
|
* Add Form Field Character Counter ([#1114](https://github.com/Amsterdam/design-system/issues/1114)) ([779ae8c](https://github.com/Amsterdam/design-system/commit/779ae8c9764b23508ffbfb38c6dc2f7a7c1cbd28))
|
|
106
139
|
|
|
107
|
-
|
|
108
140
|
### Bug Fixes
|
|
109
141
|
|
|
110
142
|
* Use semantic Heading for the title of a Dialog ([#1123](https://github.com/Amsterdam/design-system/issues/1123)) ([0493fd8](https://github.com/Amsterdam/design-system/commit/0493fd87587d36a83bb7aa9cbb69b8debf5d66f0))
|
|
111
143
|
|
|
112
144
|
## [0.7.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.6.1...design-system-tokens-v0.7.0) (2024-03-12)
|
|
113
145
|
|
|
114
|
-
|
|
115
146
|
### ⚠ BREAKING CHANGES
|
|
116
147
|
|
|
117
148
|
* Shorten namespaces in theme and tokens ([#1125](https://github.com/Amsterdam/design-system/issues/1125))
|
|
@@ -122,7 +153,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
122
153
|
|
|
123
154
|
## [0.6.1](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.6.0...design-system-tokens-v0.6.1) (2024-03-11)
|
|
124
155
|
|
|
125
|
-
|
|
126
156
|
### Bug Fixes
|
|
127
157
|
|
|
128
158
|
* Button fixes ([#1122](https://github.com/Amsterdam/design-system/issues/1122)) ([b5a9504](https://github.com/Amsterdam/design-system/commit/b5a950491f46710d92526ce6012f7d76992a569f))
|
|
@@ -130,7 +160,6 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
130
160
|
|
|
131
161
|
## [0.6.0](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.5.1...design-system-tokens-v0.6.0) (2024-03-08)
|
|
132
162
|
|
|
133
|
-
|
|
134
163
|
### ⚠ BREAKING CHANGES
|
|
135
164
|
|
|
136
165
|
* Rename ‘header logo’ to ‘header logo link’ and add missing token for outline offset ([#1108](https://github.com/Amsterdam/design-system/issues/1108))
|
|
@@ -156,21 +185,18 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
|
|
|
156
185
|
* Rename ‘header logo’ to ‘header logo link’ and add missing token for outline offset ([#1108](https://github.com/Amsterdam/design-system/issues/1108)) ([f87e834](https://github.com/Amsterdam/design-system/commit/f87e8345ec900ab08941d5d7ab40f8abd16a569a))
|
|
157
186
|
* Use spacing tokens in Grid component ([#1089](https://github.com/Amsterdam/design-system/issues/1089)) ([b55f0a3](https://github.com/Amsterdam/design-system/commit/b55f0a3b64dcfb660a878ade75033a1dd835ac2d))
|
|
158
187
|
|
|
159
|
-
|
|
160
188
|
### Bug Fixes
|
|
161
189
|
|
|
162
190
|
* Remove whitespace at the right end of dialog content ([#1091](https://github.com/Amsterdam/design-system/issues/1091)) ([23e1253](https://github.com/Amsterdam/design-system/commit/23e1253e38bba8ac85ebbd696af37742d1c1a02d))
|
|
163
191
|
|
|
164
192
|
## [0.5.1](https://github.com/Amsterdam/design-system/compare/design-system-tokens-v0.5.0...design-system-tokens-v0.5.1) (2024-02-13)
|
|
165
193
|
|
|
166
|
-
|
|
167
194
|
### Features
|
|
168
195
|
|
|
169
196
|
* Create unique token classes ([#1071](https://github.com/Amsterdam/design-system/issues/1071)) ([d53d0a9](https://github.com/Amsterdam/design-system/commit/d53d0a93f18238759d85bd897a7b6ee537cc78b0))
|
|
170
197
|
|
|
171
198
|
## [0.5.0](https://github.com/Amsterdam/design-system/compare/@amsterdam/design-system-tokens@0.4.0...design-system-tokens-v0.5.0) (2024-02-09)
|
|
172
199
|
|
|
173
|
-
|
|
174
200
|
### ⚠ BREAKING CHANGES
|
|
175
201
|
|
|
176
202
|
* Add theme setup and compact theme ([#1067](https://github.com/Amsterdam/design-system/issues/1067))
|
package/README.md
CHANGED
|
@@ -1,3 +1,199 @@
|
|
|
1
1
|
<!-- @license CC0-1.0 -->
|
|
2
2
|
|
|
3
|
-
#
|
|
3
|
+
# Amsterdam Design System: Tokens
|
|
4
|
+
|
|
5
|
+
This package provides all design tokens from the [Amsterdam Design System](https://designsystem.amsterdam).
|
|
6
|
+
Use it to apply its visual design to your website or application.
|
|
7
|
+
The tokens are exported in multiple formats, including CSS custom properties and JSON, making them compatible with most, if not all, technology stacks.
|
|
8
|
+
|
|
9
|
+
## Introduction
|
|
10
|
+
|
|
11
|
+
Every design token is a variable representing a single visual design choice.
|
|
12
|
+
Tokens exist for colours, various aspects of text, spacing lengths, border widths, the configuration of animations, and more.
|
|
13
|
+
The value of every token is valid in CSS.
|
|
14
|
+
All tokens together form a theme that encodes the entire branding of the City of Amsterdam.
|
|
15
|
+
|
|
16
|
+
## Installation
|
|
17
|
+
|
|
18
|
+
Install this package by itself if you want or need to reference tokens directly in your stylesheets.
|
|
19
|
+
|
|
20
|
+
Note that our [CSS components](https://www.npmjs.com/package/@amsterdam/design-system-css) and [React components](https://www.npmjs.com/package/@amsterdam/design-system-react) provide more functionality and apply the tokens automatically.
|
|
21
|
+
You should use those packages if your application uses React or if it allows you to apply our HTML classes.
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
npm install @amsterdam/design-system-tokens
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Usage in CSS
|
|
28
|
+
|
|
29
|
+
Tokens are typically used as custom properties in CSS.
|
|
30
|
+
Their name starts with a prefix of `--ams-`; that of a component token (see below) with the property that uses it, e.g. `-font-size`.
|
|
31
|
+
|
|
32
|
+
### Main stylesheet
|
|
33
|
+
|
|
34
|
+
This package offers a main stylesheet containing all tokens.
|
|
35
|
+
They are declared as global CSS variables through the `:root` selector.
|
|
36
|
+
|
|
37
|
+
<!-- prettier-ignore -->
|
|
38
|
+
```ts
|
|
39
|
+
import "@amsterdam/design-system-tokens/dist/index.css"
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
If that doesn’t work for your project, use `index.theme.css` instead, which uses an `.ams-theme` selector.
|
|
43
|
+
Add that class to a root element of your application.
|
|
44
|
+
|
|
45
|
+
<!-- prettier-ignore -->
|
|
46
|
+
```ts
|
|
47
|
+
import "@amsterdam/design-system-tokens/dist/index.theme.css"
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
```html
|
|
51
|
+
<body class="ams-theme">
|
|
52
|
+
…
|
|
53
|
+
</body>
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Compact mode
|
|
57
|
+
|
|
58
|
+
Our branding is rather spacious for websites.
|
|
59
|
+
The main stylesheet implements this ‘spacious mode’ as the default.
|
|
60
|
+
A compact stylesheet is available for applications that require less white space and smaller text.
|
|
61
|
+
|
|
62
|
+
Note that the compact stylesheet is not independent – it only contains overrides.
|
|
63
|
+
Import it after the main stylesheet for the correct result.
|
|
64
|
+
|
|
65
|
+
<!-- prettier-ignore -->
|
|
66
|
+
```ts
|
|
67
|
+
import "@amsterdam/design-system-tokens/dist/index.css"
|
|
68
|
+
import "@amsterdam/design-system-tokens/dist/compact.css"
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Three layers
|
|
72
|
+
|
|
73
|
+
The tokens are organised in three layers: brand, common and component.
|
|
74
|
+
|
|
75
|
+
#### Brand tokens
|
|
76
|
+
|
|
77
|
+
These express the corporate identity of the City of Amsterdam.
|
|
78
|
+
They are our fundamental selection from all possible colours, text characteristics, spacing lengths, border widths, etc.
|
|
79
|
+
Examples:
|
|
80
|
+
|
|
81
|
+
```css
|
|
82
|
+
:root {
|
|
83
|
+
--ams-color-primary-red: #ec0000;
|
|
84
|
+
--ams-space-md: 1rem;
|
|
85
|
+
--ams-proportion-wide: 4/3;
|
|
86
|
+
--ams-border-width-lg: 0.1875rem;
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Find the [list of brand tokens](https://github.com/Amsterdam/design-system/tree/main/proprietary/tokens/src/brand/ams) on GitHub.
|
|
91
|
+
|
|
92
|
+
#### Common tokens
|
|
93
|
+
|
|
94
|
+
Related components share visual design characteristics.
|
|
95
|
+
For example, all links have the same colour, and the borders of various form inputs are equally thick.
|
|
96
|
+
Common tokens express these relations and streamline future changes.
|
|
97
|
+
|
|
98
|
+
Design system components use common tokens where possible.
|
|
99
|
+
The same goes for custom components that you may create in your application.
|
|
100
|
+
|
|
101
|
+
```html
|
|
102
|
+
<a class="my-link" href="#">…</a>
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
```css
|
|
106
|
+
.my-input {
|
|
107
|
+
color: var(--ams-link-appearance-color);
|
|
108
|
+
text-underline-offset: var(--ams-link-appearance-text-underline-offset);
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
Find the [list of common tokens](https://github.com/Amsterdam/design-system/tree/main/proprietary/tokens/src/common/ams) on GitHub.
|
|
113
|
+
|
|
114
|
+
#### Component tokens
|
|
115
|
+
|
|
116
|
+
Every design system component defines a token for every property that expresses branding and uses it in its stylesheet.
|
|
117
|
+
|
|
118
|
+
Use these tokens when recreating an existing component to receive the correct values for them – now and in the future.
|
|
119
|
+
Do not apply these tokens to other components – components must be independent.
|
|
120
|
+
|
|
121
|
+
```html
|
|
122
|
+
<button class="my-button" type="button">Button label</button>
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
```css
|
|
126
|
+
.my-button {
|
|
127
|
+
font-family: var(--ams-button-font-family);
|
|
128
|
+
background-color: var(--ams-button-primary-background-color);
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
Find the [list of component tokens](https://github.com/Amsterdam/design-system/tree/main/proprietary/tokens/src/component/ams) on GitHub.
|
|
133
|
+
|
|
134
|
+
### Overriding tokens
|
|
135
|
+
|
|
136
|
+
This package allows the creation of a theme to reuse our components for a different brand.
|
|
137
|
+
This is a key feature of [NL Design System](https://nldesignsystem.nl/) of which we are part.
|
|
138
|
+
|
|
139
|
+
However, websites and applications for the City of Amsterdam must follow the design system as closely as possible.
|
|
140
|
+
We repeat: websites and applications for the City of Amsterdam must follow the design system as closely as possible.
|
|
141
|
+
|
|
142
|
+
At the same time, we are aware that adopting a design system can pose challenges in practice.
|
|
143
|
+
If there is a good reason to (temporarily) adapt a component, do so by overriding the values of its appropriate tokens in a separate stylesheet.
|
|
144
|
+
Note that redefining the value of a token is a much better approach than redeclaring styles, adding class names or even inline styles.
|
|
145
|
+
|
|
146
|
+
## Usage in Sass
|
|
147
|
+
|
|
148
|
+
The tokens can be imported as Sass variables as well.
|
|
149
|
+
|
|
150
|
+
```sass
|
|
151
|
+
@import "@amsterdam/design-system-tokens/dist/index.scss"
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Import the compact tokens if you need them.
|
|
155
|
+
Sass will override spacious values automatically.
|
|
156
|
+
|
|
157
|
+
```sass
|
|
158
|
+
@import "@amsterdam/design-system-tokens/dist/compact.scss"
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
## Usage in JavaScript
|
|
162
|
+
|
|
163
|
+
Import the JSON file to use the tokens in TypeScript or JavaScript.
|
|
164
|
+
Here, tokens start their name with a prefix of `ams.`.
|
|
165
|
+
Use ‘dot notation’ or square brackets to access the tokens.
|
|
166
|
+
|
|
167
|
+
<!-- prettier-ignore -->
|
|
168
|
+
```ts
|
|
169
|
+
import tokens from "@amsterdam/design-system-tokens/dist/index.json"
|
|
170
|
+
|
|
171
|
+
const buttonBackgroundColor = tokens.ams.color["primary-blue"]
|
|
172
|
+
const rowGap = tokens.ams.space.md
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
Import and merge the compact tokens if you need them.
|
|
176
|
+
Then you can use the tokens in scripting or css-in-js libraries.
|
|
177
|
+
|
|
178
|
+
<!-- prettier-ignore -->
|
|
179
|
+
```ts
|
|
180
|
+
import spaciousTokens from "@amsterdam/design-system-tokens/dist/index.json"
|
|
181
|
+
import compactTokens from "@amsterdam/design-system-tokens/dist/compact.json"
|
|
182
|
+
|
|
183
|
+
const tokens = { ...spaciousTokens, ...compactTokens }
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
## Usage in Figma
|
|
187
|
+
|
|
188
|
+
The tokens are used in our [Figma Library](https://www.figma.com/file/9IGm6IdPUYizBNGsUnueBd/Amsterdam-Design-System?type=design&node-id=741-19633&mode=design&t=N8P3h3W67O0KNdga-0) as well.
|
|
189
|
+
|
|
190
|
+
## Updating
|
|
191
|
+
|
|
192
|
+
We follow semantic versioning and publish a [change log](https://github.com/Amsterdam/design-system/blob/main/proprietary/tokens/CHANGELOG.md) to guide you through updates.
|
|
193
|
+
The tokens are a public API of the design system.
|
|
194
|
+
Note that detecting changed or deleted tokens is still a manual process.
|
|
195
|
+
|
|
196
|
+
## Support
|
|
197
|
+
|
|
198
|
+
Contact us if you have a question, find an issue, or want to contribute.
|
|
199
|
+
Find ways to reach us on [designsystem.amsterdam](https://designsystem.amsterdam/?path=/docs/docs-introduction--docs#send-a-message).
|
package/dist/compact.css
CHANGED
|
@@ -3,22 +3,22 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
:root {
|
|
6
|
-
--ams-text-level-6-font-size: clamp(0.8889rem, calc(0.9141rem + -0.0253vw), 0.9091rem);
|
|
7
|
-
--ams-text-level-5-font-size: 1rem;
|
|
8
|
-
--ams-text-level-4-font-size: clamp(1.1rem, calc(1.0938rem + 0.0313vw), 1.125rem);
|
|
9
|
-
--ams-text-level-3-font-size: clamp(1.21rem, calc(1.1961rem + 0.0695vw), 1.2656rem);
|
|
10
|
-
--ams-text-level-2-font-size: clamp(1.331rem, calc(1.3078rem + 0.116vw), 1.4238rem);
|
|
11
|
-
--ams-text-level-1-font-size: clamp(1.4641rem, calc(1.4297rem + 0.1721vw), 1.6018rem);
|
|
12
|
-
--ams-text-level-0-font-size: clamp(1.6105rem, calc(1.5626rem + 0.2394vw), 1.802rem);
|
|
13
|
-
--ams-space-grid-xl: clamp(2rem, calc(3.125vw - 0.125rem), 5rem);
|
|
14
|
-
--ams-space-grid-lg: clamp(1.5rem, calc(2.34375vw - 0.09375rem), 3.75rem);
|
|
15
|
-
--ams-space-grid-md: clamp(1rem, calc(1.5625vw - 0.0625rem), 2.5rem); /* Grows from 16px at 1088px wide to 40px at 2624px wide. */
|
|
16
|
-
--ams-space-grid-sm: clamp(0.5rem, calc(0.78125vw - 0.03125rem), 1.25rem);
|
|
17
|
-
--ams-space-grid-xs: clamp(0.25rem, calc(0.390625vw - 0.015625rem), 0.625rem);
|
|
18
|
-
--ams-space-xl: 2rem;
|
|
19
|
-
--ams-space-lg: 1.5rem;
|
|
20
|
-
--ams-space-md: 1rem;
|
|
21
|
-
--ams-space-sm: 0.5rem;
|
|
22
6
|
--ams-space-xs: 0.25rem;
|
|
7
|
+
--ams-space-sm: 0.5rem;
|
|
8
|
+
--ams-space-md: 1rem;
|
|
9
|
+
--ams-space-lg: 1.5rem;
|
|
10
|
+
--ams-space-xl: 2rem;
|
|
11
|
+
--ams-space-grid-xs: clamp(0.25rem, calc(0.390625vw - 0.015625rem), 0.625rem);
|
|
12
|
+
--ams-space-grid-sm: clamp(0.5rem, calc(0.78125vw - 0.03125rem), 1.25rem);
|
|
13
|
+
--ams-space-grid-md: clamp(1rem, calc(1.5625vw - 0.0625rem), 2.5rem); /* Grows from 16px at 1088px wide to 40px at 2624px wide. */
|
|
14
|
+
--ams-space-grid-lg: clamp(1.5rem, calc(2.34375vw - 0.09375rem), 3.75rem);
|
|
15
|
+
--ams-space-grid-xl: clamp(2rem, calc(3.125vw - 0.125rem), 5rem);
|
|
16
|
+
--ams-text-level-0-font-size: clamp(1.6105rem, calc(1.5626rem + 0.2394vw), 1.802rem);
|
|
17
|
+
--ams-text-level-1-font-size: clamp(1.4641rem, calc(1.4297rem + 0.1721vw), 1.6018rem);
|
|
18
|
+
--ams-text-level-2-font-size: clamp(1.331rem, calc(1.3078rem + 0.116vw), 1.4238rem);
|
|
19
|
+
--ams-text-level-3-font-size: clamp(1.21rem, calc(1.1961rem + 0.0695vw), 1.2656rem);
|
|
20
|
+
--ams-text-level-4-font-size: clamp(1.1rem, calc(1.0938rem + 0.0313vw), 1.125rem);
|
|
21
|
+
--ams-text-level-5-font-size: 1rem;
|
|
22
|
+
--ams-text-level-6-font-size: clamp(0.8889rem, calc(0.9141rem + -0.0253vw), 0.9091rem);
|
|
23
23
|
--ams-grid-padding-inline: var(--ams-space-grid-md);
|
|
24
24
|
}
|
package/dist/compact.scss
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
|
|
2
2
|
// Do not edit directly, this file was auto-generated.
|
|
3
3
|
|
|
4
|
-
$ams-text-level-6-font-size: clamp(0.8889rem, calc(0.9141rem + -0.0253vw), 0.9091rem);
|
|
5
|
-
$ams-text-level-5-font-size: 1rem;
|
|
6
|
-
$ams-text-level-4-font-size: clamp(1.1rem, calc(1.0938rem + 0.0313vw), 1.125rem);
|
|
7
|
-
$ams-text-level-3-font-size: clamp(1.21rem, calc(1.1961rem + 0.0695vw), 1.2656rem);
|
|
8
|
-
$ams-text-level-2-font-size: clamp(1.331rem, calc(1.3078rem + 0.116vw), 1.4238rem);
|
|
9
|
-
$ams-text-level-1-font-size: clamp(1.4641rem, calc(1.4297rem + 0.1721vw), 1.6018rem);
|
|
10
|
-
$ams-text-level-0-font-size: clamp(1.6105rem, calc(1.5626rem + 0.2394vw), 1.802rem);
|
|
11
|
-
$ams-space-grid-xl: clamp(2rem, calc(3.125vw - 0.125rem), 5rem);
|
|
12
|
-
$ams-space-grid-lg: clamp(1.5rem, calc(2.34375vw - 0.09375rem), 3.75rem);
|
|
13
|
-
$ams-space-grid-md: clamp(1rem, calc(1.5625vw - 0.0625rem), 2.5rem); // Grows from 16px at 1088px wide to 40px at 2624px wide.
|
|
14
|
-
$ams-space-grid-sm: clamp(0.5rem, calc(0.78125vw - 0.03125rem), 1.25rem);
|
|
15
|
-
$ams-space-grid-xs: clamp(0.25rem, calc(0.390625vw - 0.015625rem), 0.625rem);
|
|
16
|
-
$ams-space-xl: 2rem;
|
|
17
|
-
$ams-space-lg: 1.5rem;
|
|
18
|
-
$ams-space-md: 1rem;
|
|
19
|
-
$ams-space-sm: 0.5rem;
|
|
20
4
|
$ams-space-xs: 0.25rem;
|
|
5
|
+
$ams-space-sm: 0.5rem;
|
|
6
|
+
$ams-space-md: 1rem;
|
|
7
|
+
$ams-space-lg: 1.5rem;
|
|
8
|
+
$ams-space-xl: 2rem;
|
|
9
|
+
$ams-space-grid-xs: clamp(0.25rem, calc(0.390625vw - 0.015625rem), 0.625rem);
|
|
10
|
+
$ams-space-grid-sm: clamp(0.5rem, calc(0.78125vw - 0.03125rem), 1.25rem);
|
|
11
|
+
$ams-space-grid-md: clamp(1rem, calc(1.5625vw - 0.0625rem), 2.5rem); // Grows from 16px at 1088px wide to 40px at 2624px wide.
|
|
12
|
+
$ams-space-grid-lg: clamp(1.5rem, calc(2.34375vw - 0.09375rem), 3.75rem);
|
|
13
|
+
$ams-space-grid-xl: clamp(2rem, calc(3.125vw - 0.125rem), 5rem);
|
|
14
|
+
$ams-text-level-0-font-size: clamp(1.6105rem, calc(1.5626rem + 0.2394vw), 1.802rem);
|
|
15
|
+
$ams-text-level-1-font-size: clamp(1.4641rem, calc(1.4297rem + 0.1721vw), 1.6018rem);
|
|
16
|
+
$ams-text-level-2-font-size: clamp(1.331rem, calc(1.3078rem + 0.116vw), 1.4238rem);
|
|
17
|
+
$ams-text-level-3-font-size: clamp(1.21rem, calc(1.1961rem + 0.0695vw), 1.2656rem);
|
|
18
|
+
$ams-text-level-4-font-size: clamp(1.1rem, calc(1.0938rem + 0.0313vw), 1.125rem);
|
|
19
|
+
$ams-text-level-5-font-size: 1rem;
|
|
20
|
+
$ams-text-level-6-font-size: clamp(0.8889rem, calc(0.9141rem + -0.0253vw), 0.9091rem);
|
|
21
21
|
$ams-grid-padding-inline: $ams-space-grid-md;
|
package/dist/compact.theme.css
CHANGED
|
@@ -3,22 +3,22 @@
|
|
|
3
3
|
*/
|
|
4
4
|
|
|
5
5
|
.ams-theme--compact {
|
|
6
|
-
--ams-text-level-6-font-size: clamp(0.8889rem, calc(0.9141rem + -0.0253vw), 0.9091rem);
|
|
7
|
-
--ams-text-level-5-font-size: 1rem;
|
|
8
|
-
--ams-text-level-4-font-size: clamp(1.1rem, calc(1.0938rem + 0.0313vw), 1.125rem);
|
|
9
|
-
--ams-text-level-3-font-size: clamp(1.21rem, calc(1.1961rem + 0.0695vw), 1.2656rem);
|
|
10
|
-
--ams-text-level-2-font-size: clamp(1.331rem, calc(1.3078rem + 0.116vw), 1.4238rem);
|
|
11
|
-
--ams-text-level-1-font-size: clamp(1.4641rem, calc(1.4297rem + 0.1721vw), 1.6018rem);
|
|
12
|
-
--ams-text-level-0-font-size: clamp(1.6105rem, calc(1.5626rem + 0.2394vw), 1.802rem);
|
|
13
|
-
--ams-space-grid-xl: clamp(2rem, calc(3.125vw - 0.125rem), 5rem);
|
|
14
|
-
--ams-space-grid-lg: clamp(1.5rem, calc(2.34375vw - 0.09375rem), 3.75rem);
|
|
15
|
-
--ams-space-grid-md: clamp(1rem, calc(1.5625vw - 0.0625rem), 2.5rem); /* Grows from 16px at 1088px wide to 40px at 2624px wide. */
|
|
16
|
-
--ams-space-grid-sm: clamp(0.5rem, calc(0.78125vw - 0.03125rem), 1.25rem);
|
|
17
|
-
--ams-space-grid-xs: clamp(0.25rem, calc(0.390625vw - 0.015625rem), 0.625rem);
|
|
18
|
-
--ams-space-xl: 2rem;
|
|
19
|
-
--ams-space-lg: 1.5rem;
|
|
20
|
-
--ams-space-md: 1rem;
|
|
21
|
-
--ams-space-sm: 0.5rem;
|
|
22
6
|
--ams-space-xs: 0.25rem;
|
|
7
|
+
--ams-space-sm: 0.5rem;
|
|
8
|
+
--ams-space-md: 1rem;
|
|
9
|
+
--ams-space-lg: 1.5rem;
|
|
10
|
+
--ams-space-xl: 2rem;
|
|
11
|
+
--ams-space-grid-xs: clamp(0.25rem, calc(0.390625vw - 0.015625rem), 0.625rem);
|
|
12
|
+
--ams-space-grid-sm: clamp(0.5rem, calc(0.78125vw - 0.03125rem), 1.25rem);
|
|
13
|
+
--ams-space-grid-md: clamp(1rem, calc(1.5625vw - 0.0625rem), 2.5rem); /* Grows from 16px at 1088px wide to 40px at 2624px wide. */
|
|
14
|
+
--ams-space-grid-lg: clamp(1.5rem, calc(2.34375vw - 0.09375rem), 3.75rem);
|
|
15
|
+
--ams-space-grid-xl: clamp(2rem, calc(3.125vw - 0.125rem), 5rem);
|
|
16
|
+
--ams-text-level-0-font-size: clamp(1.6105rem, calc(1.5626rem + 0.2394vw), 1.802rem);
|
|
17
|
+
--ams-text-level-1-font-size: clamp(1.4641rem, calc(1.4297rem + 0.1721vw), 1.6018rem);
|
|
18
|
+
--ams-text-level-2-font-size: clamp(1.331rem, calc(1.3078rem + 0.116vw), 1.4238rem);
|
|
19
|
+
--ams-text-level-3-font-size: clamp(1.21rem, calc(1.1961rem + 0.0695vw), 1.2656rem);
|
|
20
|
+
--ams-text-level-4-font-size: clamp(1.1rem, calc(1.0938rem + 0.0313vw), 1.125rem);
|
|
21
|
+
--ams-text-level-5-font-size: 1rem;
|
|
22
|
+
--ams-text-level-6-font-size: clamp(0.8889rem, calc(0.9141rem + -0.0253vw), 0.9091rem);
|
|
23
23
|
--ams-grid-padding-inline: var(--ams-space-grid-md);
|
|
24
24
|
}
|