@workday/canvas-kit-docs 16.0.0-alpha.0441-next.0 → 16.0.0-alpha.0445-next.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/dist/es6/lib/docs.js +28 -0
- package/dist/mdx/16.0-UPGRADE-GUIDE.mdx +89 -17
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -451464,6 +451464,34 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
451464
451464
|
"tags": {
|
|
451465
451465
|
"default": "'accent'"
|
|
451466
451466
|
}
|
|
451467
|
+
},
|
|
451468
|
+
{
|
|
451469
|
+
"kind": "property",
|
|
451470
|
+
"name": "surfaceType",
|
|
451471
|
+
"required": false,
|
|
451472
|
+
"type": {
|
|
451473
|
+
"kind": "union",
|
|
451474
|
+
"value": [
|
|
451475
|
+
{
|
|
451476
|
+
"kind": "string",
|
|
451477
|
+
"value": "default"
|
|
451478
|
+
},
|
|
451479
|
+
{
|
|
451480
|
+
"kind": "string",
|
|
451481
|
+
"value": "inverse"
|
|
451482
|
+
}
|
|
451483
|
+
]
|
|
451484
|
+
},
|
|
451485
|
+
"description": "A string that will determine which surface overlay variant to use.",
|
|
451486
|
+
"declarations": [
|
|
451487
|
+
{
|
|
451488
|
+
"name": "surfaceType",
|
|
451489
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/colorSpace.tsx"
|
|
451490
|
+
}
|
|
451491
|
+
],
|
|
451492
|
+
"tags": {
|
|
451493
|
+
"default": "'default'"
|
|
451494
|
+
}
|
|
451467
451495
|
}
|
|
451468
451496
|
]
|
|
451469
451497
|
}
|
|
@@ -16,14 +16,18 @@ Soon to be...
|
|
|
16
16
|
- [KBD](#kbd)
|
|
17
17
|
- [Component Updates](#component-updates)
|
|
18
18
|
- [Avatar](#avatar)
|
|
19
|
-
- [Buttons](#buttons)
|
|
20
|
-
- [Delete Button Outline Variant](#delete-button-outline-variant)
|
|
19
|
+
- [Buttons](#buttons) - [Delete Button Outline Variant](#delete-button-outline-variant)
|
|
21
20
|
- [Card](#card)
|
|
22
|
-
- [
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
21
|
+
- [Inputs](#inputs)
|
|
22
|
+
- [Accessibility: Checked-State Contrast](#accessibility-checked-state-contrast)
|
|
23
|
+
- [Checkbox](#checkbox)
|
|
24
|
+
- [Color Input](#color-input)
|
|
25
|
+
- [Color Picker](#color-picker)
|
|
26
|
+
- [Form Field](#form-field)
|
|
27
|
+
- [Radio](#radio)
|
|
28
|
+
- [Switch](#switch)
|
|
29
|
+
- [Text Area](#text-area)
|
|
30
|
+
- [Text Input](#text-input)
|
|
27
31
|
- [New Utilities](#new-utilities)
|
|
28
32
|
- [cornerShapeStencil](#cornershapestencil)
|
|
29
33
|
- [Deprecations](#deprecations)
|
|
@@ -211,48 +215,116 @@ import {DeleteButton} from '@workday/canvas-kit-react/button';
|
|
|
211
215
|
- Card's border radius is now managed via the new `cornerShapeStencil` (see
|
|
212
216
|
[New Utilities](#new-utilities)).
|
|
213
217
|
|
|
214
|
-
###
|
|
218
|
+
### Inputs
|
|
219
|
+
|
|
220
|
+
#### Accessibility: Checked-State Contrast
|
|
221
|
+
|
|
222
|
+
> **Important:** The checked states of `Checkbox`, `Radio`, and `Switch` now derive their
|
|
223
|
+
> background/fill color from `system.color.brand.accent.positive` (which maps to your theme's
|
|
224
|
+
> `brand.success.base`), while the foreground (the check icon, radio dot, and switch thumb) remains
|
|
225
|
+
> an inverse/white color. This pairing relies on `brand.success.base` being a sufficiently dark
|
|
226
|
+
> color.
|
|
227
|
+
|
|
228
|
+
This change is safe for the default Canvas themes, where `brand.success.base` is dark enough to
|
|
229
|
+
maintain adequate contrast against the white foreground. However, **consumer themes that override
|
|
230
|
+
`brand.success.base` with a light color may produce insufficient contrast** between the checked
|
|
231
|
+
background and the white check icon, radio dot, or switch thumb. This can cause the checked state to
|
|
232
|
+
fail
|
|
233
|
+
[WCAG 1.4.11 Non-text Contrast (3:1)](https://www.w3.org/WAI/WCAG21/Understanding/non-text-contrast.html).
|
|
234
|
+
|
|
235
|
+
If you customize `brand.success.base` in your theme, please verify the following:
|
|
236
|
+
|
|
237
|
+
- **Maintain a minimum 3:1 contrast ratio** between your `brand.success.main` value and the white
|
|
238
|
+
(`#ffffff`) foreground used for the check icon, radio dot, and switch thumb.
|
|
239
|
+
- Prefer a `brand.success.base` value that is dark enough to pair with a light foreground. If your
|
|
240
|
+
brand requires a light success color, you may need to override the component styles so the
|
|
241
|
+
foreground uses a darker, paired contrast color instead of white.
|
|
242
|
+
> **Note:** All visual updates apply to both the Default Canvas theme and new Sana Canvas theme
|
|
243
|
+
> unless specified otherwise.
|
|
244
|
+
|
|
245
|
+
#### Checkbox
|
|
246
|
+
|
|
247
|
+
**PR:** [#3984](https://github.com/Workday/canvas-kit/pull/3984)
|
|
248
|
+
|
|
249
|
+
##### Visual Updates
|
|
250
|
+
|
|
251
|
+
- The default Checkbox size is now **20px** (previously 24px).
|
|
252
|
+
- Checked state uses `system.color.brand.accent.positive` instead of
|
|
253
|
+
`system.color.brand.accent.primary` for the background.
|
|
254
|
+
- Error and alert states no longer display a status background color; only the standard background
|
|
255
|
+
is shown.
|
|
256
|
+
- The hover ring is smaller to better align with the smaller size. The hover ring background color
|
|
257
|
+
uses neutral instead of slate in `sana-canvas` theme.
|
|
258
|
+
|
|
259
|
+
#### Color Input
|
|
215
260
|
|
|
216
261
|
**PR:** [#3992](https://github.com/Workday/canvas-kit/pull/3992)
|
|
217
262
|
|
|
218
|
-
|
|
263
|
+
##### Visual Updates
|
|
219
264
|
|
|
220
265
|
- Shape is now **12px** (previously 8px).
|
|
221
266
|
|
|
222
|
-
|
|
267
|
+
#### Color Picker
|
|
223
268
|
|
|
224
269
|
**PR:** [#3992](https://github.com/Workday/canvas-kit/pull/3992)
|
|
225
270
|
|
|
226
|
-
|
|
271
|
+
##### Visual Updates
|
|
227
272
|
|
|
228
273
|
- **Sana Canvas:** swatch shape is now **6px** (previously **4px**).
|
|
229
274
|
|
|
230
|
-
|
|
275
|
+
#### Form Field
|
|
231
276
|
|
|
232
277
|
**PR:** [#3992](https://github.com/Workday/canvas-kit/pull/3992)
|
|
233
278
|
|
|
234
|
-
|
|
279
|
+
##### Visual Updates
|
|
235
280
|
|
|
236
281
|
- Shape for grouped inputs (Radio groups and Checkbox groups) is now **12px** (previously 8px). As
|
|
237
282
|
in v15, this shape is primarily visible for error and caution states.
|
|
238
283
|
- Error and caution states no longer display a status background color; only the standard background
|
|
239
284
|
is shown.
|
|
240
285
|
|
|
241
|
-
|
|
286
|
+
#### Radio
|
|
287
|
+
|
|
288
|
+
**PR:** [#3984](https://github.com/Workday/canvas-kit/pull/3984)
|
|
289
|
+
|
|
290
|
+
##### Visual Updates
|
|
291
|
+
|
|
292
|
+
- The default Radio size is now **20px** (previously 24px).
|
|
293
|
+
- Checked state uses `system.color.brand.accent.positive` instead of
|
|
294
|
+
`system.color.brand.accent.primary` for the background.
|
|
295
|
+
- Error and alert states no longer display a status background color; only the standard background
|
|
296
|
+
is shown.
|
|
297
|
+
- The hover ring is smaller to better align with the smaller size. The hover ring background color
|
|
298
|
+
uses a neutral color instead of slate in `sana-canvas` theme.
|
|
299
|
+
|
|
300
|
+
#### Switch
|
|
301
|
+
|
|
302
|
+
**PR:** [#3984](https://github.com/Workday/canvas-kit/pull/3984)
|
|
303
|
+
|
|
304
|
+
##### Visual Updates
|
|
305
|
+
|
|
306
|
+
- The Switch thumb is now **16px** (was 14px). The icon-thumb container width remains unchanged.
|
|
307
|
+
- The checked state background now uses `system.color.brand.accent.positive` instead of
|
|
308
|
+
`system.color.brand.accent.primary`.
|
|
309
|
+
- The default (unchecked) background color now uses `system.color.surface.muted.default` instead of
|
|
310
|
+
`system.color.surface.muted.soft`. Background color uses a neutral color instead of slate in
|
|
311
|
+
`sana-canvas` theme.
|
|
312
|
+
|
|
313
|
+
#### Text Area
|
|
242
314
|
|
|
243
315
|
**PR:** [#3992](https://github.com/Workday/canvas-kit/pull/3992)
|
|
244
316
|
|
|
245
|
-
|
|
317
|
+
##### Visual Updates
|
|
246
318
|
|
|
247
319
|
- Shape is now **12px** (previously 8px).
|
|
248
320
|
- Error and caution states no longer display a status background color; only the standard background
|
|
249
321
|
is shown.
|
|
250
322
|
|
|
251
|
-
|
|
323
|
+
#### Text Input
|
|
252
324
|
|
|
253
325
|
**PR:** [#3992](https://github.com/Workday/canvas-kit/pull/3992)
|
|
254
326
|
|
|
255
|
-
|
|
327
|
+
##### Visual Updates
|
|
256
328
|
|
|
257
329
|
- Shape is now **12px** (previously 8px).
|
|
258
330
|
- Error and caution states no longer display a status background color; only the standard background
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "16.0.0-alpha.
|
|
3
|
+
"version": "16.0.0-alpha.0445-next.0",
|
|
4
4
|
"description": "Documentation components of Canvas Kit components",
|
|
5
5
|
"author": "Workday, Inc. (https://www.workday.com)",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -47,10 +47,10 @@
|
|
|
47
47
|
"@stackblitz/sdk": "^1.11.0",
|
|
48
48
|
"@storybook/csf": "0.0.1",
|
|
49
49
|
"@workday/canvas-expressive-icons-web": "1.0.2",
|
|
50
|
-
"@workday/canvas-kit-labs-react": "^16.0.0-alpha.
|
|
51
|
-
"@workday/canvas-kit-preview-react": "^16.0.0-alpha.
|
|
52
|
-
"@workday/canvas-kit-react": "^16.0.0-alpha.
|
|
53
|
-
"@workday/canvas-kit-styling": "^16.0.0-alpha.
|
|
50
|
+
"@workday/canvas-kit-labs-react": "^16.0.0-alpha.0445-next.0",
|
|
51
|
+
"@workday/canvas-kit-preview-react": "^16.0.0-alpha.0445-next.0",
|
|
52
|
+
"@workday/canvas-kit-react": "^16.0.0-alpha.0445-next.0",
|
|
53
|
+
"@workday/canvas-kit-styling": "^16.0.0-alpha.0445-next.0",
|
|
54
54
|
"@workday/canvas-system-icons-web": "4.0.4",
|
|
55
55
|
"@workday/canvas-tokens-web": "4.4.0-beta.3",
|
|
56
56
|
"markdown-to-jsx": "^7.2.0",
|
|
@@ -63,5 +63,5 @@
|
|
|
63
63
|
"mkdirp": "^1.0.3",
|
|
64
64
|
"typescript": "5.0"
|
|
65
65
|
},
|
|
66
|
-
"gitHead": "
|
|
66
|
+
"gitHead": "fc927ea8a9cdb16ad227bbfc5d843dba09009b43"
|
|
67
67
|
}
|