@workday/canvas-kit-docs 12.0.0-alpha.852-next.0 → 12.0.0-alpha.855-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.
|
@@ -42,8 +42,8 @@ A note to the reader:
|
|
|
42
42
|
- [InputIconContainer](#inputiconcontainer)
|
|
43
43
|
- [Select (Preview)](#select-preview)
|
|
44
44
|
- [Component Updates](#component-updates)
|
|
45
|
-
- [
|
|
46
|
-
- [
|
|
45
|
+
- [Styling API and CSS Tokens](#styling-api-and-css-tokens)
|
|
46
|
+
- [Text Area](#text-area)
|
|
47
47
|
- [Style Utility Updates](#style-utility-updates)
|
|
48
48
|
- [createStencil](#createstencil)
|
|
49
49
|
- [Troubleshooting](#troubleshooting)
|
|
@@ -57,8 +57,8 @@ A note to the reader:
|
|
|
57
57
|
In v12, all the components listed in this guide have started using our new
|
|
58
58
|
[Canvas Tokens Web](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).
|
|
59
59
|
|
|
60
|
-
In v12 you must add `@workday/canvas-tokens-web` to ensure our components are properly styled and
|
|
61
|
-
variables are defined. For more information on installing and using, please reference our tokens
|
|
60
|
+
In v12 you must add `@workday/canvas-tokens-web` to ensure our components are properly styled and
|
|
61
|
+
the variables are defined. For more information on installing and using, please reference our tokens
|
|
62
62
|
[docs](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).
|
|
63
63
|
|
|
64
64
|
## Deprecations
|
|
@@ -68,19 +68,24 @@ in a future major release. This signals consumers to migrate to a more stable al
|
|
|
68
68
|
deprecated code is removed.
|
|
69
69
|
|
|
70
70
|
## Removals
|
|
71
|
-
|
|
71
|
+
|
|
72
|
+
Removals are deletions from our codebase and you can no longer consume this component. We've either
|
|
73
|
+
promoted or replaced a component or utility.
|
|
72
74
|
|
|
73
75
|
### Select (Preview)
|
|
74
76
|
|
|
75
77
|
**PR:** [#2796](https://github.com/Workday/canvas-kit/pull/2796)
|
|
76
78
|
|
|
77
|
-
We've removed the `Select` component that was in Preview. Please use the compound
|
|
79
|
+
We've removed the `Select` component that was in Preview. Please use the compound
|
|
80
|
+
[Select component from Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic).
|
|
78
81
|
|
|
79
82
|
### InputIconContainer
|
|
80
83
|
|
|
81
84
|
**PR:** [#2838](https://github.com/Workday/canvas-kit/pull/2838)
|
|
82
85
|
|
|
83
|
-
We've removed `InputIconContainer` from Main. Please use
|
|
86
|
+
We've removed `InputIconContainer` from Main. Please use
|
|
87
|
+
[InputGroup](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-text-input--icons)
|
|
88
|
+
from Main instead.
|
|
84
89
|
|
|
85
90
|
---
|
|
86
91
|
|
|
@@ -88,6 +93,9 @@ We've removed `InputIconContainer` from Main. Please use [InputGroup](https://wo
|
|
|
88
93
|
|
|
89
94
|
### Styling API and CSS Tokens
|
|
90
95
|
|
|
96
|
+
**PRs:** [#2825](https://github.com/Workday/canvas-kit/pull/2825),
|
|
97
|
+
[#2795](https://github.com/Workday/canvas-kit/pull/2795)
|
|
98
|
+
|
|
91
99
|
Several components have been refactored to use our new
|
|
92
100
|
[Canvas Tokens](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs) and
|
|
93
101
|
[styling API](https://workday.github.io/canvas-kit/?path=/docs/styling-basics--create-modifiers#createstyles-api).
|
|
@@ -95,24 +103,32 @@ The React interface **has not changed**, but CSS variables are now used for dyna
|
|
|
95
103
|
|
|
96
104
|
The following components are affected:
|
|
97
105
|
|
|
98
|
-
- `Popup`
|
|
99
106
|
- `Dialog`
|
|
100
107
|
- `Modal`
|
|
108
|
+
- `Popup`
|
|
109
|
+
- `TextArea`
|
|
110
|
+
- `TextInput`
|
|
101
111
|
- `Toast`
|
|
102
112
|
|
|
103
113
|
> **Note:** These components also support our new `cs` prop for styling. Learn more about styling
|
|
104
114
|
> with `cs` in our
|
|
105
115
|
> [documentation](https://workday.github.io/canvas-kit/?path=/docs/styling-basics--cs-prop).
|
|
106
116
|
|
|
107
|
-
###
|
|
117
|
+
### Text Area
|
|
108
118
|
|
|
109
|
-
**PR:** [#
|
|
119
|
+
**PR:** [#2825](https://github.com/Workday/canvas-kit/pull/2825)
|
|
110
120
|
|
|
111
|
-
|
|
121
|
+
`TextAreaResizeDirection` is no longer a TypeScript enum, but a JavaScript object. This change does
|
|
122
|
+
not effect runtime at all, but may cause TypeScript errors if you use `TextAreaResizeDirection` as a
|
|
123
|
+
type.
|
|
112
124
|
|
|
113
|
-
|
|
125
|
+
```tsx
|
|
126
|
+
// v11
|
|
127
|
+
interface MyProps { resize?: TextAreaResizeDirection }
|
|
114
128
|
|
|
115
|
-
|
|
129
|
+
// 12 type ValueOf<T> = T[keyof T]; interface MyProps { resize?:
|
|
130
|
+
ValueOf<typeof TextAreaResizeDirection> }
|
|
131
|
+
```
|
|
116
132
|
|
|
117
133
|
## Troubleshooting
|
|
118
134
|
|
|
@@ -160,7 +160,7 @@ the popup's stack context when entering/exiting fullscreen.
|
|
|
160
160
|
|
|
161
161
|
<ExampleCodeBlock code={FullScreen} />
|
|
162
162
|
|
|
163
|
-
### Opening an
|
|
163
|
+
### Opening an External Window
|
|
164
164
|
|
|
165
165
|
A popup can open an external window. This isn't supported directly. The `Popup.Popper` subcomponent
|
|
166
166
|
is replaced with a custom subcomponent that connects to the Popup model and controls the lifecycle
|
|
@@ -16,7 +16,7 @@ import {
|
|
|
16
16
|
import {Tooltip} from '@workday/canvas-kit-react/tooltip';
|
|
17
17
|
import {Popup, usePopupModel} from '@workday/canvas-kit-react/popup';
|
|
18
18
|
import {SecondaryButton} from '@workday/canvas-kit-react/button';
|
|
19
|
-
import {Flex} from '
|
|
19
|
+
import {Flex} from '@workday/canvas-kit-react/layout';
|
|
20
20
|
|
|
21
21
|
const mainContentStyles = createStyles({
|
|
22
22
|
padding: system.space.x4,
|
|
@@ -106,7 +106,6 @@ const ExternalWindowPortal = ({
|
|
|
106
106
|
onWindowClose();
|
|
107
107
|
};
|
|
108
108
|
|
|
109
|
-
|
|
110
109
|
window.addEventListener('unload', closeWindow);
|
|
111
110
|
newWindow?.addEventListener('unload', closeWindow);
|
|
112
111
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "12.0.0-alpha.
|
|
3
|
+
"version": "12.0.0-alpha.855-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,10 +44,10 @@
|
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@emotion/styled": "^11.6.0",
|
|
46
46
|
"@storybook/csf": "0.0.1",
|
|
47
|
-
"@workday/canvas-kit-labs-react": "^12.0.0-alpha.
|
|
48
|
-
"@workday/canvas-kit-preview-react": "^12.0.0-alpha.
|
|
49
|
-
"@workday/canvas-kit-react": "^12.0.0-alpha.
|
|
50
|
-
"@workday/canvas-kit-styling": "^12.0.0-alpha.
|
|
47
|
+
"@workday/canvas-kit-labs-react": "^12.0.0-alpha.855-next.0",
|
|
48
|
+
"@workday/canvas-kit-preview-react": "^12.0.0-alpha.855-next.0",
|
|
49
|
+
"@workday/canvas-kit-react": "^12.0.0-alpha.855-next.0",
|
|
50
|
+
"@workday/canvas-kit-styling": "^12.0.0-alpha.855-next.0",
|
|
51
51
|
"@workday/canvas-system-icons-web": "^3.0.0",
|
|
52
52
|
"@workday/canvas-tokens-web": "^2.0.0",
|
|
53
53
|
"markdown-to-jsx": "^7.2.0",
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
"mkdirp": "^1.0.3",
|
|
60
60
|
"typescript": "4.2"
|
|
61
61
|
},
|
|
62
|
-
"gitHead": "
|
|
62
|
+
"gitHead": "9bf5667e2a94b160d69cb88c2e053d29760a34a9"
|
|
63
63
|
}
|