ids-foundation 1.2.0 → 1.2.2

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/README.md CHANGED
@@ -21,22 +21,108 @@ Tokens are categorized by the foundational style that’s applied.
21
21
  |**shadow** |Defines box shadow properties like offsets, blur, and color |`shadow-error`| Future |
22
22
  |**motion** |Defines animations during certain interaction states |`motion-ease`| Future |
23
23
 
24
- ### Using the Tokens
24
+ ### Using the Tokens in Code
25
25
 
26
- #### Code
26
+ We provide the tokens in a few formats. They are: `scss`, `css`, and `map.scss`. We can add other formats as needed. There is also a description json file that contains all tokens with descriptions.
27
27
 
28
- Sass files for the tokens are provided as CSS variables. We may provide other formats as needed.
28
+ To use any of these install the [`npm` package](https://www.npmjs.com/package/ids-foundation). Additionally note that the web component theme css files contain the tokens, so if you are using those you can just start using the token css variables directly without any additional setup.
29
+
30
+ #### Using `Scss`
31
+
32
+ Sass files for the tokens are provided as CSS variables.
29
33
 
30
34
  To use the components:
31
35
 
32
- 1. Take the core and semantic tokens from [/ids-foundation](https://github.com/infor-design/ids-foundation/tree/main/tokens/theme-soho). View [component tokens](https://github.com/infor-design/enterprise-wc/tree/main/src/themes/default) in `@infor-design/enterprise-wc`.
33
- 2. Use the [`npm` package](https://www.npmjs.com/package/ids-foundation).
34
- 3. Or additionally note that the web component theme css files contain the tokens, so if you are using those you can just start using the tokens.
36
+ 1. Take the core and semantic tokens from [/ids-foundation](https://oxford.awsdev.infor.com/infor-design/ids-foundation/-/tree/main/tokens/theme-soho?ref_type=heads).
37
+ 2. Use them similar to the [component tokens](https://oxford.awsdev.infor.com/infor-design/enterprise-wc/-/tree/main/src/themes/default?ref_type=heads) in `@infor-design/enterprise-wc`.
38
+
39
+ Example light theme:
40
+
41
+ ```scss
42
+ @import '../../../node_modules/ids-foundation/theme-soho/scss/core';
43
+ @import '../../../node_modules/ids-foundation/theme-soho/scss/theme-colors';
44
+ @import '../../../node_modules/ids-foundation/theme-soho/scss/semantic-light';
45
+
46
+ .light-theme .my-class {
47
+ color: var(--ids-color-neutral-90);
48
+ }
49
+ ```
50
+
51
+ #### Using `css`
52
+
53
+ 1. Import the files from the `tokens/theme-<name>/css` directory.
54
+ 2. Start using them in your styles.
55
+
56
+ ```html
57
+ <!DOCTYPE html>
58
+ <html lang="en">
59
+ <head>
60
+ <title>Design Tokens Example</title>
61
+ <link rel="stylesheet" href="path/to/ids-foundation/theme-soho/css/ids-theme-tokens-default-light.css">
62
+ </head>
63
+ <body>
64
+ <div class="my-class">
65
+ This text uses the design token for color.
66
+ </div>
67
+ </body>
68
+ </html>
69
+ ```
70
+
71
+ ```scss
72
+ .my-class {
73
+ color: var(--ids-color-neutral-90);
74
+ }
75
+ ```
76
+
77
+ #### Using `.map.scss`
78
+
79
+ To use the sass map files you should review the info about them the [Sass Website](https://sass-lang.com/documentation/at-rules/use#importing-a-map). These can be useful for filtering specific tokens in or out.
80
+
81
+ We made a simple example to test it out. Which you can see here:
82
+ https://stackblitz.com/edit/sass-map-tester?file=src%2Fapp%2Fapp.component.scss,src%2Fapp%2Fapp.component.html
83
+
84
+ Some additional example code:
85
+
86
+ ```scss
87
+ @use 'ids-theme-tokens-default-light.map' as light;
88
+ @use 'ids-theme-tokens-default-dark.map' as dark;
89
+
90
+ .theme-new-light {
91
+ @each $key, $value in light.$css-variables {
92
+ // only add tokens that are not in the color palette
93
+ @if str-index($key, '--ids-color') == null {
94
+ #{$key}: #{$value};
95
+ }
96
+ }
97
+
98
+ .blue {
99
+ color: var(--ids-color-blue-100);
100
+ }
101
+ }
102
+
103
+ .theme-new-dark {
104
+ @each $key, $value in dark.$css-variables {
105
+ // only add tokens that are in the color palette
106
+ @if str-index($key, '--ids-color') {
107
+ #{$key}: #{$value};
108
+ }
109
+ }
110
+
111
+ background-color: var(--ids-color-background-default);
112
+
113
+ .blue {
114
+ color: var(--ids-color-accent-blue-strongest);
115
+ }
116
+ .red {
117
+ color: var(--ids-color-accent-red-strongest);
118
+ }
119
+ }
120
+ ```
35
121
 
36
- #### Design
122
+ ### Design
37
123
 
38
124
  Semantic tokens can be manually applied in Figma by adding the [IDS Design Tokens](https://www.figma.com/design/7xMSXwCpK3eq4uGqkDDDav/IDS-Design-Tokens?m=auto&node-id=16%3A396&t=VDCzgpqVzBEcmjt5-1) library. Tokenized Figma components will available in the future.
39
125
 
40
- ### Using the System Fonts
126
+ ## Using the System Fonts
41
127
 
42
128
  The system fonts are included in the `fonts` directory. They are used in the web components and can be used in your projects as well. See [./fonts](./fonts) for more information and readme. To get around GDPR issues we strongly recommend you serve this with your app.
package/fonts/README.md CHANGED
@@ -1,10 +1,10 @@
1
1
  # Using Source Sans Pro for Infor Design System
2
2
 
3
- To read more about how to use Source Sans in IDS, see our [typography page](https://github.com/infor-design/enterprise/blob/main/src/components/typography/readme.md).
3
+ To read more about how to use Source Sans in IDS, see our [typography page](https://oxford.awsdev.infor.com/infor-design/enterprise/-/blob/main/src/components/typography/readme.md?ref_type=heads).
4
4
 
5
5
  ## Source Sans Pro
6
6
 
7
- [Source Sans Pro](http://adobe-fonts.github.io/source-sans-pro/) is a set of OpenType fonts that have been designed to work well in user interface (UI) environments.
7
+ Source Sans Pro is a set of OpenType fonts that have been designed to work well in user interface (UI) environments. Note that this font is now renamed to Source Sans 3 but there are differences and Source Sans 3 should be used. Use the font in this repo instead.
8
8
 
9
9
  ## Including Source Sans Pro in your Web App
10
10
 
@@ -16,7 +16,7 @@ c) because some countries google links may be banned
16
16
 
17
17
  For this reason we recommend you serve the files with your application. All the needed fonts can be found in this folder
18
18
 
19
- 1. Serve all the `woff2` files in a folder on the server thats available to the app. These fonts can use caching if possible. Note that there are a lot of files because Source Sans is not available in some languages so alternatives are used as noted on [this page](https://github.com/infor-design/enterprise/blob/main/src/components/typography/_typography-new.scss#L6)
19
+ 1. Serve all the `woff2` files in a folder on the server thats available to the app. These fonts can use caching if possible. Note that there are a lot of files because Source Sans is not available in some languages so alternatives are used as noted on [this page](https://oxford.awsdev.infor.com/infor-design/enterprise/-/blob/main/src/components/typography/_typography-new.scss?ref_type=heads#L6)
20
20
 
21
21
  1. The OFL.txt is the license
22
22
  1. The README.md is this file
package/package.json CHANGED
@@ -1,17 +1,17 @@
1
1
  {
2
2
  "name": "ids-foundation",
3
- "version": "1.2.0",
3
+ "version": "1.2.2",
4
4
  "description": "Base tokens, font files and foundational assets for IDS",
5
5
  "main": "index.js",
6
6
  "scripts": {},
7
7
  "repository": {
8
8
  "type": "git",
9
- "url": "git+https://github.com/infor-design/ids-foundation.git"
9
+ "url": "git+https://oxford.awsdev.infor.com/infor-design/ids-foundation.git"
10
10
  },
11
11
  "author": "Infor Design",
12
12
  "license": "Apache-2.0",
13
13
  "bugs": {
14
- "url": "https://github.com/infor-design/ids-foundation/issues"
14
+ "url": "https://inforwiki.atlassian.net/jira/software/c/projects/IDS/issues"
15
15
  },
16
- "homepage": "https://github.com/infor-design/ids-foundation#readme"
17
- }
16
+ "homepage": "https: //oxford.awsdev.infor.com/infor-design/ids-foundation#readme"
17
+ }
@@ -305,11 +305,6 @@
305
305
  --ids-color-info-default: var(--ids-color-blue-80);
306
306
  --ids-color-info-strong: var(--ids-color-blue-90);
307
307
  --ids-color-info-stronger: var(--ids-color-blue-100);
308
- --ids-color-action-weakest: var(--ids-color-blue-10);
309
- --ids-color-action-weaker: var(--ids-color-blue-30);
310
- --ids-color-action-default: var(--ids-color-blue-80);
311
- --ids-color-action-stronger: var(--ids-color-blue-90);
312
- --ids-color-action-strongest: var(--ids-color-blue-100);
313
308
  --ids-color-theme-weakest: var(--ids-color-theme-10);
314
309
  --ids-color-theme-weaker: var(--ids-color-theme-40);
315
310
  --ids-color-theme-strong: var(--ids-color-theme-80);
@@ -305,11 +305,6 @@
305
305
  --ids-color-info-default: var(--ids-color-blue-50);
306
306
  --ids-color-info-strong: var(--ids-color-blue-40);
307
307
  --ids-color-info-stronger: var(--ids-color-blue-10);
308
- --ids-color-action-weakest: var(--ids-color-blue-100);
309
- --ids-color-action-weaker: var(--ids-color-blue-90);
310
- --ids-color-action-default: var(--ids-color-blue-50);
311
- --ids-color-action-stronger: var(--ids-color-blue-40);
312
- --ids-color-action-strongest: var(--ids-color-blue-20);
313
308
  --ids-color-theme-weakest: var(--ids-color-theme-100);
314
309
  --ids-color-theme-weaker: var(--ids-color-theme-90);
315
310
  --ids-color-theme-strong: var(--ids-color-theme-50);
@@ -305,11 +305,6 @@
305
305
  --ids-color-info-default: var(--ids-color-blue-60);
306
306
  --ids-color-info-strong: var(--ids-color-blue-70);
307
307
  --ids-color-info-stronger: var(--ids-color-blue-100);
308
- --ids-color-action-weakest: var(--ids-color-blue-10);
309
- --ids-color-action-weaker: var(--ids-color-blue-20);
310
- --ids-color-action-default: var(--ids-color-blue-60);
311
- --ids-color-action-stronger: var(--ids-color-blue-70);
312
- --ids-color-action-strongest: var(--ids-color-blue-90);
313
308
  --ids-color-theme-weakest: var(--ids-color-theme-10);
314
309
  --ids-color-theme-weaker: var(--ids-color-theme-20);
315
310
  --ids-color-theme-strong: var(--ids-color-theme-60);
@@ -0,0 +1,489 @@
1
+ {
2
+ "tokenDescriptions": [
3
+ {
4
+ "--ids-transparent": {
5
+ "description": "Transparent fill for any element."
6
+ }
7
+ },
8
+ {
9
+ "--ids-color-background-default": {
10
+ "description": "Default background color for containers and surfaces."
11
+ }
12
+ },
13
+ {
14
+ "--ids-color-background-elevated": {
15
+ "description": "Background color for containers and surfaces that sit on elements styled by color-background-default."
16
+ }
17
+ },
18
+ {
19
+ "--ids-color-background-dark": {
20
+ "description": "Default background color for containers and surfaces that remain dark in all modes."
21
+ }
22
+ },
23
+ {
24
+ "--ids-color-foreground-default-default": {
25
+ "description": "Default text and icon color."
26
+ }
27
+ },
28
+ {
29
+ "--ids-color-foreground-default-secondary": {
30
+ "description": "Secondary text and icon color."
31
+ }
32
+ },
33
+ {
34
+ "--ids-color-foreground-default-tertiary": {
35
+ "description": "Tertiary text and icon color."
36
+ }
37
+ },
38
+ {
39
+ "--ids-color-foreground-default-disabled": {
40
+ "description": "Disabled text and icon color."
41
+ }
42
+ },
43
+ {
44
+ "--ids-color-foreground-light-default": {
45
+ "description": "Default text and icon color that remains light in all modes."
46
+ }
47
+ },
48
+ {
49
+ "--ids-color-foreground-light-secondary": {
50
+ "description": "Secondary text and icon color that remains light in all modes."
51
+ }
52
+ },
53
+ {
54
+ "--ids-color-foreground-light-tertiary": {
55
+ "description": "Tertiary text and icon color that remains light in all modes."
56
+ }
57
+ },
58
+ {
59
+ "--ids-color-foreground-light-disabled": {
60
+ "description": "Disabled text and icon color that remains light in all modes."
61
+ }
62
+ },
63
+ {
64
+ "--ids-color-foreground-dark-default": {
65
+ "description": "Default text and icon color that remains dark in all modes."
66
+ }
67
+ },
68
+ {
69
+ "--ids-color-border-default": {
70
+ "description": "Default border color."
71
+ }
72
+ },
73
+ {
74
+ "--ids-color-border-weaker": {
75
+ "description": "Weaker border color."
76
+ }
77
+ },
78
+ {
79
+ "--ids-color-border-weak": {
80
+ "description": "Weak border color."
81
+ }
82
+ },
83
+ {
84
+ "--ids-color-border-strong": {
85
+ "description": "Strong border color."
86
+ }
87
+ },
88
+ {
89
+ "--ids-color-border-light": {
90
+ "description": "Default border color that remains light in all modes."
91
+ }
92
+ },
93
+ {
94
+ "--ids-color-action-weakest": {
95
+ "description": "Weakest interactive status color, used in buttons and links."
96
+ }
97
+ },
98
+ {
99
+ "--ids-color-action-weaker": {
100
+ "description": "Weaker interactive status color, used in buttons and links."
101
+ }
102
+ },
103
+ {
104
+ "--ids-color-action-default": {
105
+ "description": "Default interactive status color, used in buttons and links."
106
+ }
107
+ },
108
+ {
109
+ "--ids-color-action-stronger": {
110
+ "description": "Stronger interactive status color, used in buttons and links."
111
+ }
112
+ },
113
+ {
114
+ "--ids-color-action-strongest": {
115
+ "description": "Strongest interactive status color, used in links."
116
+ }
117
+ },
118
+ {
119
+ "--ids-color-success-weak": {
120
+ "description": "Weak success status color."
121
+ }
122
+ },
123
+ {
124
+ "--ids-color-success-default": {
125
+ "description": "Default success status color."
126
+ }
127
+ },
128
+ {
129
+ "--ids-color-success-strong": {
130
+ "description": "Strong success status color."
131
+ }
132
+ },
133
+ {
134
+ "--ids-color-success-stronger": {
135
+ "description": "Stronger success status color."
136
+ }
137
+ },
138
+ {
139
+ "--ids-color-caution-weak": {
140
+ "description": "Weak caution status color."
141
+ }
142
+ },
143
+ {
144
+ "--ids-color-caution-default": {
145
+ "description": "Default caution status color."
146
+ }
147
+ },
148
+ {
149
+ "--ids-color-caution-strong": {
150
+ "description": "Strong caution status color."
151
+ }
152
+ },
153
+ {
154
+ "--ids-color-caution-stronger": {
155
+ "description": "Stronger caution status color."
156
+ }
157
+ },
158
+ {
159
+ "--ids-color-warning-weak": {
160
+ "description": "Weak warning status color."
161
+ }
162
+ },
163
+ {
164
+ "--ids-color-warning-default": {
165
+ "description": "Default warning status color."
166
+ }
167
+ },
168
+ {
169
+ "--ids-color-warning-strong": {
170
+ "description": "Strong warning status color."
171
+ }
172
+ },
173
+ {
174
+ "--ids-color-warning-stronger": {
175
+ "description": "Stronger warning status color."
176
+ }
177
+ },
178
+ {
179
+ "--ids-color-error-weak": {
180
+ "description": "Weak error status color."
181
+ }
182
+ },
183
+ {
184
+ "--ids-color-error-default": {
185
+ "description": "Default error status color."
186
+ }
187
+ },
188
+ {
189
+ "--ids-color-error-stronger": {
190
+ "description": "Stronger error status color."
191
+ }
192
+ },
193
+ {
194
+ "--ids-color-error-strongest": {
195
+ "description": "Strongest error status color."
196
+ }
197
+ },
198
+ {
199
+ "--ids-color-info-weak": {
200
+ "description": "Weak informational status color."
201
+ }
202
+ },
203
+ {
204
+ "--ids-color-info-default": {
205
+ "description": "Default informational status color."
206
+ }
207
+ },
208
+ {
209
+ "--ids-color-info-strong": {
210
+ "description": "Strong informational status color."
211
+ }
212
+ },
213
+ {
214
+ "--ids-color-info-stronger": {
215
+ "description": "Stronger informational status color."
216
+ }
217
+ },
218
+ {
219
+ "--ids-color-theme-weakest": {
220
+ "description": ""
221
+ }
222
+ },
223
+ {
224
+ "--ids-color-theme-weaker": {
225
+ "description": ""
226
+ }
227
+ },
228
+ {
229
+ "--ids-color-theme-strong": {
230
+ "description": ""
231
+ }
232
+ },
233
+ {
234
+ "--ids-color-theme-stronger": {
235
+ "description": ""
236
+ }
237
+ },
238
+ {
239
+ "--ids-color-theme-strongest": {
240
+ "description": ""
241
+ }
242
+ },
243
+ {
244
+ "--ids-color-accent-neutral-weakest": {
245
+ "description": ""
246
+ }
247
+ },
248
+ {
249
+ "--ids-color-accent-neutral-weaker": {
250
+ "description": ""
251
+ }
252
+ },
253
+ {
254
+ "--ids-color-accent-neutral-weak": {
255
+ "description": ""
256
+ }
257
+ },
258
+ {
259
+ "--ids-color-accent-neutral-default": {
260
+ "description": ""
261
+ }
262
+ },
263
+ {
264
+ "--ids-color-accent-neutral-strong": {
265
+ "description": ""
266
+ }
267
+ },
268
+ {
269
+ "--ids-color-accent-neutral-stronger": {
270
+ "description": ""
271
+ }
272
+ },
273
+ {
274
+ "--ids-color-accent-neutral-strongest": {
275
+ "description": ""
276
+ }
277
+ },
278
+ {
279
+ "--ids-color-accent-blue-weakest": {
280
+ "description": ""
281
+ }
282
+ },
283
+ {
284
+ "--ids-color-accent-blue-weaker": {
285
+ "description": ""
286
+ }
287
+ },
288
+ {
289
+ "--ids-color-accent-blue-weak": {
290
+ "description": ""
291
+ }
292
+ },
293
+ {
294
+ "--ids-color-accent-blue-strong": {
295
+ "description": ""
296
+ }
297
+ },
298
+ {
299
+ "--ids-color-accent-blue-stronger": {
300
+ "description": ""
301
+ }
302
+ },
303
+ {
304
+ "--ids-color-accent-blue-strongest": {
305
+ "description": ""
306
+ }
307
+ },
308
+ {
309
+ "--ids-color-accent-green-weakest": {
310
+ "description": ""
311
+ }
312
+ },
313
+ {
314
+ "--ids-color-accent-green-weaker": {
315
+ "description": ""
316
+ }
317
+ },
318
+ {
319
+ "--ids-color-accent-green-weak": {
320
+ "description": ""
321
+ }
322
+ },
323
+ {
324
+ "--ids-color-accent-green-strong": {
325
+ "description": ""
326
+ }
327
+ },
328
+ {
329
+ "--ids-color-accent-green-stronger": {
330
+ "description": ""
331
+ }
332
+ },
333
+ {
334
+ "--ids-color-accent-green-strongest": {
335
+ "description": ""
336
+ }
337
+ },
338
+ {
339
+ "--ids-color-accent-orange-weakest": {
340
+ "description": ""
341
+ }
342
+ },
343
+ {
344
+ "--ids-color-accent-orange-weaker": {
345
+ "description": ""
346
+ }
347
+ },
348
+ {
349
+ "--ids-color-accent-orange-weak": {
350
+ "description": ""
351
+ }
352
+ },
353
+ {
354
+ "--ids-color-accent-orange-strong": {
355
+ "description": ""
356
+ }
357
+ },
358
+ {
359
+ "--ids-color-accent-orange-stronger": {
360
+ "description": ""
361
+ }
362
+ },
363
+ {
364
+ "--ids-color-accent-orange-strongest": {
365
+ "description": ""
366
+ }
367
+ },
368
+ {
369
+ "--ids-color-accent-purple-weakest": {
370
+ "description": ""
371
+ }
372
+ },
373
+ {
374
+ "--ids-color-accent-purple-weaker": {
375
+ "description": ""
376
+ }
377
+ },
378
+ {
379
+ "--ids-color-accent-purple-weak": {
380
+ "description": ""
381
+ }
382
+ },
383
+ {
384
+ "--ids-color-accent-purple-strong": {
385
+ "description": ""
386
+ }
387
+ },
388
+ {
389
+ "--ids-color-accent-purple-stronger": {
390
+ "description": ""
391
+ }
392
+ },
393
+ {
394
+ "--ids-color-accent-purple-strongest": {
395
+ "description": ""
396
+ }
397
+ },
398
+ {
399
+ "--ids-color-accent-red-weakest": {
400
+ "description": ""
401
+ }
402
+ },
403
+ {
404
+ "--ids-color-accent-red-weaker": {
405
+ "description": ""
406
+ }
407
+ },
408
+ {
409
+ "--ids-color-accent-red-weak": {
410
+ "description": ""
411
+ }
412
+ },
413
+ {
414
+ "--ids-color-accent-red-strong": {
415
+ "description": ""
416
+ }
417
+ },
418
+ {
419
+ "--ids-color-accent-red-stronger": {
420
+ "description": ""
421
+ }
422
+ },
423
+ {
424
+ "--ids-color-accent-red-strongest": {
425
+ "description": ""
426
+ }
427
+ },
428
+ {
429
+ "--ids-color-accent-teal-weakest": {
430
+ "description": ""
431
+ }
432
+ },
433
+ {
434
+ "--ids-color-accent-teal-weaker": {
435
+ "description": ""
436
+ }
437
+ },
438
+ {
439
+ "--ids-color-accent-teal-weak": {
440
+ "description": ""
441
+ }
442
+ },
443
+ {
444
+ "--ids-color-accent-teal-strong": {
445
+ "description": ""
446
+ }
447
+ },
448
+ {
449
+ "--ids-color-accent-teal-stronger": {
450
+ "description": ""
451
+ }
452
+ },
453
+ {
454
+ "--ids-color-accent-teal-strongest": {
455
+ "description": ""
456
+ }
457
+ },
458
+ {
459
+ "--ids-color-accent-yellow-weakest": {
460
+ "description": ""
461
+ }
462
+ },
463
+ {
464
+ "--ids-color-accent-yellow-weaker": {
465
+ "description": ""
466
+ }
467
+ },
468
+ {
469
+ "--ids-color-accent-yellow-weak": {
470
+ "description": ""
471
+ }
472
+ },
473
+ {
474
+ "--ids-color-accent-yellow-strong": {
475
+ "description": ""
476
+ }
477
+ },
478
+ {
479
+ "--ids-color-accent-yellow-stronger": {
480
+ "description": ""
481
+ }
482
+ },
483
+ {
484
+ "--ids-color-accent-yellow-strongest": {
485
+ "description": ""
486
+ }
487
+ }
488
+ ]
489
+ }