@workday/canvas-kit-docs 11.0.0-alpha.669-next.0 → 11.0.0-alpha.671-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 +9 -24
- package/dist/mdx/11.0-UPGRADE-GUIDE.mdx +37 -36
- package/package.json +5 -5
package/dist/es6/lib/docs.js
CHANGED
|
@@ -11478,8 +11478,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11478
11478
|
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
11479
11479
|
},
|
|
11480
11480
|
"defaultValue": {
|
|
11481
|
-
"kind": "
|
|
11482
|
-
"name": "
|
|
11481
|
+
"kind": "external",
|
|
11482
|
+
"name": "div",
|
|
11483
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
11483
11484
|
}
|
|
11484
11485
|
},
|
|
11485
11486
|
{
|
|
@@ -11498,8 +11499,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11498
11499
|
"name": "R",
|
|
11499
11500
|
"required": true,
|
|
11500
11501
|
"defaultValue": {
|
|
11501
|
-
"kind": "
|
|
11502
|
-
"name": "
|
|
11502
|
+
"kind": "external",
|
|
11503
|
+
"name": "div",
|
|
11504
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
11503
11505
|
}
|
|
11504
11506
|
}
|
|
11505
11507
|
]
|
|
@@ -11558,8 +11560,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11558
11560
|
}
|
|
11559
11561
|
],
|
|
11560
11562
|
"baseElement": {
|
|
11561
|
-
"kind": "
|
|
11562
|
-
"name": "
|
|
11563
|
+
"kind": "external",
|
|
11564
|
+
"name": "div",
|
|
11565
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
11563
11566
|
},
|
|
11564
11567
|
"model": "RadioModel",
|
|
11565
11568
|
"styleComponent": {
|
|
@@ -12354,24 +12357,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
12354
12357
|
],
|
|
12355
12358
|
"tags": {}
|
|
12356
12359
|
},
|
|
12357
|
-
{
|
|
12358
|
-
"kind": "property",
|
|
12359
|
-
"name": "theme",
|
|
12360
|
-
"required": false,
|
|
12361
|
-
"type": {
|
|
12362
|
-
"kind": "symbol",
|
|
12363
|
-
"name": "EmotionCanvasTheme",
|
|
12364
|
-
"value": "EmotionCanvasTheme"
|
|
12365
|
-
},
|
|
12366
|
-
"description": "",
|
|
12367
|
-
"declarations": [
|
|
12368
|
-
{
|
|
12369
|
-
"name": "theme",
|
|
12370
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
|
|
12371
|
-
}
|
|
12372
|
-
],
|
|
12373
|
-
"tags": {}
|
|
12374
|
-
},
|
|
12375
12360
|
{
|
|
12376
12361
|
"kind": "property",
|
|
12377
12362
|
"name": "children",
|
|
@@ -11,16 +11,17 @@ any questions.
|
|
|
11
11
|
|
|
12
12
|
- [Codemod](#codemod)
|
|
13
13
|
- [Deprecations](#deprecations)
|
|
14
|
-
- [Form Field Main](#form-field-main)
|
|
15
|
-
- [Text Input Preview](#text-input-preview)
|
|
16
|
-
- [Text Area Preview](#text-input-preview)
|
|
14
|
+
- [Form Field (Main)](#form-field-main)
|
|
17
15
|
- [Label Text](#label-text)
|
|
16
|
+
- [Text Area (Preview)](#text-area-preview)
|
|
17
|
+
- [Text Input (Preview)](#text-input-preview)
|
|
18
18
|
- [Component Updates](#component-updates)
|
|
19
19
|
- [Component Style Updates](#component-style-updates)
|
|
20
20
|
- [Card](#card)
|
|
21
21
|
- [Count Badge](#count-badge)
|
|
22
|
-
- [Text](#text)
|
|
23
22
|
- [Form Field Preview](#form-field-preview)
|
|
23
|
+
- [Radio (Preview)](#radio-preview)
|
|
24
|
+
- [Text](#text)
|
|
24
25
|
|
|
25
26
|
## Codemod
|
|
26
27
|
|
|
@@ -100,13 +101,16 @@ instead.
|
|
|
100
101
|
|
|
101
102
|
---
|
|
102
103
|
|
|
103
|
-
### Text
|
|
104
|
+
### Label Text
|
|
104
105
|
|
|
105
|
-
**PR:** [#
|
|
106
|
+
**PR:** [#2455](https://github.com/Workday/canvas-kit/pull/2455)
|
|
106
107
|
|
|
107
|
-
We've deprecated `
|
|
108
|
+
We've deprecated `LabelText` from [Main](#main) in favor of our compound component `FormField.Label`
|
|
108
109
|
in [Preview](#preview). Please use
|
|
109
|
-
[`FormField`](https://workday.github.io/canvas-kit/?path=//docs/preview-inputs-form-field--basic)
|
|
110
|
+
[`FormField.Label`](https://workday.github.io/canvas-kit/?path=//docs/preview-inputs-form-field--basic)
|
|
111
|
+
instead.
|
|
112
|
+
|
|
113
|
+
If you still want to use a `label` element outside of the context of a form, you can use `Text`
|
|
110
114
|
instead.
|
|
111
115
|
|
|
112
116
|
---
|
|
@@ -122,16 +126,13 @@ instead.
|
|
|
122
126
|
|
|
123
127
|
---
|
|
124
128
|
|
|
125
|
-
###
|
|
129
|
+
### Text Input Preview
|
|
126
130
|
|
|
127
|
-
**PR:** [#
|
|
131
|
+
**PR:** [#2472](https://github.com/Workday/canvas-kit/pull/2472)
|
|
128
132
|
|
|
129
|
-
We've deprecated `
|
|
133
|
+
We've deprecated `TextInput` from [Preview](#preview) in favor of our compound component `FormField`
|
|
130
134
|
in [Preview](#preview). Please use
|
|
131
|
-
[`FormField
|
|
132
|
-
instead.
|
|
133
|
-
|
|
134
|
-
If you still want to use a `label` element outside of the context of a form, you can use `Text`
|
|
135
|
+
[`FormField`](https://workday.github.io/canvas-kit/?path=//docs/preview-inputs-form-field--basic)
|
|
135
136
|
instead.
|
|
136
137
|
|
|
137
138
|
---
|
|
@@ -355,26 +356,7 @@ our new
|
|
|
355
356
|
The component API has not been changed, and it should behave identically as it did in previous
|
|
356
357
|
versions.
|
|
357
358
|
|
|
358
|
-
### Form Field
|
|
359
|
-
|
|
360
|
-
**PR:** [#2541](https://github.com/Workday/canvas-kit/pull/2541)
|
|
361
|
-
|
|
362
|
-
`FormField` in [Preview](#preview) and its subcomponents have been refactored to use our
|
|
363
|
-
[new styling utilities](https://workday.github.io/canvas-kit/?path=/docs/styling-basics--create-modifiers#createstyles-api)
|
|
364
|
-
and [tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).
|
|
365
|
-
|
|
366
|
-
### Text
|
|
367
|
-
|
|
368
|
-
**PR:** [#2455](https://github.com/Workday/canvas-kit/pull/2455)
|
|
369
|
-
|
|
370
|
-
`Text` has been refactored to use our
|
|
371
|
-
[new styling utilities](https://workday.github.io/canvas-kit/?path=/docs/styling-basics--create-modifiers#createstyles-api)
|
|
372
|
-
and [tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs). It no
|
|
373
|
-
longer extends the `Box` component, however, it still supports Emotion `styled` and style props.
|
|
374
|
-
Type level components: `Title`, `Heading`, `BodyText` and `Subtext`, have not been changed since
|
|
375
|
-
they extend the `Text` component. These changes do not affect the components API.
|
|
376
|
-
|
|
377
|
-
### Form Field Preview
|
|
359
|
+
### Form Field (Preview)
|
|
378
360
|
|
|
379
361
|
**PR:** [#2472](https://github.com/Workday/canvas-kit/pull/2472)
|
|
380
362
|
|
|
@@ -419,4 +401,23 @@ import {TextInput} from '@workday/canvas-kit-react/text-input';
|
|
|
419
401
|
</FormField>;
|
|
420
402
|
```
|
|
421
403
|
|
|
422
|
-
🤖 The codemod will handle the change of `hasError` to `error` for you automatically.
|
|
404
|
+
🤖 The codemod will handle the change of `hasError` to `error` for you automatically.
|
|
405
|
+
|
|
406
|
+
### Radio (Preview)
|
|
407
|
+
|
|
408
|
+
**PR:** [#2546](https://github.com/Workday/canvas-kit/pull/2546)
|
|
409
|
+
|
|
410
|
+
`Radio` and `RadioGroup` now use [Canvas Tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs) and our [new styling utilities](https://workday.github.io/canvas-kit/?path=/docs/styling-basics--create-modifiers#createstyles-api). The
|
|
411
|
+
component now supports the `cs` prop, but otherwise the API has not changed. It should behave
|
|
412
|
+
identically as it did in previous versions.
|
|
413
|
+
|
|
414
|
+
### Text
|
|
415
|
+
|
|
416
|
+
**PR:** [#2455](https://github.com/Workday/canvas-kit/pull/2455)
|
|
417
|
+
|
|
418
|
+
`Text` has been refactored to use our
|
|
419
|
+
[new styling utilities](https://workday.github.io/canvas-kit/?path=/docs/styling-basics--create-modifiers#createstyles-api)
|
|
420
|
+
and [tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs). It no
|
|
421
|
+
longer extends the `Box` component, however, it still supports Emotion `styled` and style props.
|
|
422
|
+
Type level components: `Title`, `Heading`, `BodyText` and `Subtext`, have not been changed since
|
|
423
|
+
they extend the `Text` component. These changes do not affect the components API.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "11.0.0-alpha.
|
|
3
|
+
"version": "11.0.0-alpha.671-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",
|
|
@@ -44,9 +44,9 @@
|
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@emotion/styled": "^11.6.0",
|
|
46
46
|
"@storybook/csf": "0.0.1",
|
|
47
|
-
"@workday/canvas-kit-labs-react": "^11.0.0-alpha.
|
|
48
|
-
"@workday/canvas-kit-preview-react": "^11.0.0-alpha.
|
|
49
|
-
"@workday/canvas-kit-react": "^11.0.0-alpha.
|
|
47
|
+
"@workday/canvas-kit-labs-react": "^11.0.0-alpha.671-next.0",
|
|
48
|
+
"@workday/canvas-kit-preview-react": "^11.0.0-alpha.671-next.0",
|
|
49
|
+
"@workday/canvas-kit-react": "^11.0.0-alpha.671-next.0",
|
|
50
50
|
"@workday/canvas-kit-styling": "^10.3.1",
|
|
51
51
|
"@workday/canvas-system-icons-web": "^3.0.0",
|
|
52
52
|
"@workday/canvas-tokens-web": "^1.0.2",
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
"mkdirp": "^1.0.3",
|
|
60
60
|
"typescript": "4.2"
|
|
61
61
|
},
|
|
62
|
-
"gitHead": "
|
|
62
|
+
"gitHead": "a38c87c96e3c54cb7eb20ea92d615d297c861112"
|
|
63
63
|
}
|