@workday/canvas-kit-docs 14.0.0-alpha.1210-next.0 → 14.0.0-alpha.1212-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 +0 -188
- package/dist/mdx/14.0-UPGRADE-GUIDE.mdx +25 -6
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -113105,194 +113105,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
113105
113105
|
}
|
|
113106
113106
|
}
|
|
113107
113107
|
},
|
|
113108
|
-
{
|
|
113109
|
-
"name": "DeprecatedButtonProps",
|
|
113110
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx",
|
|
113111
|
-
"description": "",
|
|
113112
|
-
"declarations": [
|
|
113113
|
-
{
|
|
113114
|
-
"name": "DeprecatedButtonProps",
|
|
113115
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx"
|
|
113116
|
-
}
|
|
113117
|
-
],
|
|
113118
|
-
"tags": {},
|
|
113119
|
-
"type": {
|
|
113120
|
-
"kind": "alias",
|
|
113121
|
-
"name": "DeprecatedButton"
|
|
113122
|
-
}
|
|
113123
|
-
},
|
|
113124
|
-
{
|
|
113125
|
-
"name": "DeprecatedButton",
|
|
113126
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx",
|
|
113127
|
-
"description": "",
|
|
113128
|
-
"declarations": [
|
|
113129
|
-
{
|
|
113130
|
-
"name": "DeprecatedButton",
|
|
113131
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx"
|
|
113132
|
-
}
|
|
113133
|
-
],
|
|
113134
|
-
"tags": {},
|
|
113135
|
-
"type": {
|
|
113136
|
-
"kind": "enhancedComponent",
|
|
113137
|
-
"componentType": "regular",
|
|
113138
|
-
"displayName": "DeprecatedButton",
|
|
113139
|
-
"props": [
|
|
113140
|
-
{
|
|
113141
|
-
"kind": "property",
|
|
113142
|
-
"name": "variant",
|
|
113143
|
-
"required": false,
|
|
113144
|
-
"type": {
|
|
113145
|
-
"kind": "union",
|
|
113146
|
-
"value": [
|
|
113147
|
-
{
|
|
113148
|
-
"kind": "string",
|
|
113149
|
-
"value": "primary"
|
|
113150
|
-
},
|
|
113151
|
-
{
|
|
113152
|
-
"kind": "string",
|
|
113153
|
-
"value": "secondary"
|
|
113154
|
-
},
|
|
113155
|
-
{
|
|
113156
|
-
"kind": "string",
|
|
113157
|
-
"value": "delete"
|
|
113158
|
-
}
|
|
113159
|
-
]
|
|
113160
|
-
},
|
|
113161
|
-
"description": "The variant of the Button.",
|
|
113162
|
-
"declarations": [
|
|
113163
|
-
{
|
|
113164
|
-
"name": "variant",
|
|
113165
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx"
|
|
113166
|
-
}
|
|
113167
|
-
],
|
|
113168
|
-
"tags": {
|
|
113169
|
-
"default": "'secondary'"
|
|
113170
|
-
},
|
|
113171
|
-
"defaultValue": {
|
|
113172
|
-
"kind": "string",
|
|
113173
|
-
"value": "secondary"
|
|
113174
|
-
}
|
|
113175
|
-
},
|
|
113176
|
-
{
|
|
113177
|
-
"kind": "property",
|
|
113178
|
-
"name": "size",
|
|
113179
|
-
"required": false,
|
|
113180
|
-
"type": {
|
|
113181
|
-
"kind": "union",
|
|
113182
|
-
"value": [
|
|
113183
|
-
{
|
|
113184
|
-
"kind": "string",
|
|
113185
|
-
"value": "small"
|
|
113186
|
-
},
|
|
113187
|
-
{
|
|
113188
|
-
"kind": "string",
|
|
113189
|
-
"value": "medium"
|
|
113190
|
-
},
|
|
113191
|
-
{
|
|
113192
|
-
"kind": "string",
|
|
113193
|
-
"value": "large"
|
|
113194
|
-
}
|
|
113195
|
-
]
|
|
113196
|
-
},
|
|
113197
|
-
"description": "The size of the Button.",
|
|
113198
|
-
"declarations": [
|
|
113199
|
-
{
|
|
113200
|
-
"name": "size",
|
|
113201
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx"
|
|
113202
|
-
}
|
|
113203
|
-
],
|
|
113204
|
-
"tags": {
|
|
113205
|
-
"default": "'medium'"
|
|
113206
|
-
},
|
|
113207
|
-
"defaultValue": {
|
|
113208
|
-
"kind": "string",
|
|
113209
|
-
"value": "large"
|
|
113210
|
-
}
|
|
113211
|
-
},
|
|
113212
|
-
{
|
|
113213
|
-
"kind": "property",
|
|
113214
|
-
"name": "children",
|
|
113215
|
-
"required": false,
|
|
113216
|
-
"type": {
|
|
113217
|
-
"kind": "external",
|
|
113218
|
-
"name": "ReactNode",
|
|
113219
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
113220
|
-
},
|
|
113221
|
-
"description": "",
|
|
113222
|
-
"declarations": [
|
|
113223
|
-
{
|
|
113224
|
-
"name": "children",
|
|
113225
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/deprecated_Button.tsx"
|
|
113226
|
-
}
|
|
113227
|
-
],
|
|
113228
|
-
"tags": {}
|
|
113229
|
-
},
|
|
113230
|
-
{
|
|
113231
|
-
"kind": "property",
|
|
113232
|
-
"name": "grow",
|
|
113233
|
-
"required": false,
|
|
113234
|
-
"type": {
|
|
113235
|
-
"kind": "primitive",
|
|
113236
|
-
"value": "boolean"
|
|
113237
|
-
},
|
|
113238
|
-
"description": "True if the component should grow to its container's width. False otherwise.",
|
|
113239
|
-
"declarations": [
|
|
113240
|
-
{
|
|
113241
|
-
"name": "grow",
|
|
113242
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
|
|
113243
|
-
}
|
|
113244
|
-
],
|
|
113245
|
-
"tags": {}
|
|
113246
|
-
},
|
|
113247
|
-
{
|
|
113248
|
-
"kind": "property",
|
|
113249
|
-
"name": "as",
|
|
113250
|
-
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
|
|
113251
|
-
"tags": {},
|
|
113252
|
-
"declarations": [],
|
|
113253
|
-
"type": {
|
|
113254
|
-
"kind": "external",
|
|
113255
|
-
"name": "React.ElementType",
|
|
113256
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
113257
|
-
},
|
|
113258
|
-
"defaultValue": {
|
|
113259
|
-
"kind": "external",
|
|
113260
|
-
"name": "button",
|
|
113261
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
|
|
113262
|
-
}
|
|
113263
|
-
},
|
|
113264
|
-
{
|
|
113265
|
-
"kind": "property",
|
|
113266
|
-
"name": "ref",
|
|
113267
|
-
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
|
|
113268
|
-
"tags": {},
|
|
113269
|
-
"declarations": [],
|
|
113270
|
-
"type": {
|
|
113271
|
-
"kind": "external",
|
|
113272
|
-
"name": "React.Ref",
|
|
113273
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
113274
|
-
"typeParameters": [
|
|
113275
|
-
{
|
|
113276
|
-
"kind": "typeParameter",
|
|
113277
|
-
"name": "R",
|
|
113278
|
-
"required": true,
|
|
113279
|
-
"defaultValue": {
|
|
113280
|
-
"kind": "external",
|
|
113281
|
-
"name": "button",
|
|
113282
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
|
|
113283
|
-
}
|
|
113284
|
-
}
|
|
113285
|
-
]
|
|
113286
|
-
}
|
|
113287
|
-
}
|
|
113288
|
-
],
|
|
113289
|
-
"baseElement": {
|
|
113290
|
-
"kind": "external",
|
|
113291
|
-
"name": "button",
|
|
113292
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
|
|
113293
|
-
}
|
|
113294
|
-
}
|
|
113295
|
-
},
|
|
113296
113108
|
{
|
|
113297
113109
|
"name": "ExternalHyperlinkProps",
|
|
113298
113110
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/button/lib/ExternalHyperlink.tsx",
|
|
@@ -27,6 +27,7 @@ any questions.
|
|
|
27
27
|
- [Tokens](#tokens)
|
|
28
28
|
- [Removals](#removals)
|
|
29
29
|
- [Menu (preview)](#menu-preview)
|
|
30
|
+
- [Deprecated Buttons](#deprecated-buttons)
|
|
30
31
|
- [Troubleshooting](#troubleshooting)
|
|
31
32
|
- [Glossary](#glossary)
|
|
32
33
|
- [Main](#main)
|
|
@@ -105,7 +106,8 @@ yarn remove @workday/canvas-kit-codemod
|
|
|
105
106
|
|
|
106
107
|
### Branding Changes 💅
|
|
107
108
|
|
|
108
|
-
Several components have been refactored to reflect our new brand direction. Most of these changes
|
|
109
|
+
Several components have been refactored to reflect our new brand direction. Most of these changes
|
|
110
|
+
revolve around the use of our new brand colors.
|
|
109
111
|
|
|
110
112
|
The following components have been updated:
|
|
111
113
|
|
|
@@ -113,6 +115,7 @@ The following components have been updated:
|
|
|
113
115
|
- `Buttons` [#3394](https://github.com/Workday/canvas-kit/pull/3394)
|
|
114
116
|
- `ColorPicker` (Main) [#3307](https://github.com/Workday/canvas-kit/pull/3307)
|
|
115
117
|
- `ColorPicker` (preview) [#3307](https://github.com/Workday/canvas-kit/pull/3307)
|
|
118
|
+
- `InformationHighlight` [#3443](https://github.com/Workday/canvas-kit/pull/3443)
|
|
116
119
|
- `LoadingDots` (Main) [#3393](https://github.com/Workday/canvas-kit/pull/3393)
|
|
117
120
|
- `Pagination` (Preview) [#3300](https://github.com/Workday/canvas-kit/pull/3300)
|
|
118
121
|
- `SearchForm` (Labs) [#3303](https://github.com/Workday/canvas-kit/pull/3303)
|
|
@@ -125,9 +128,9 @@ The following components have been updated:
|
|
|
125
128
|
|
|
126
129
|
#### TertiaryButton
|
|
127
130
|
|
|
128
|
-
The `TertiaryButton` component no longer supports the `isThemable` prop.
|
|
129
|
-
|
|
130
|
-
|
|
131
|
+
The `TertiaryButton` component no longer supports the `isThemable` prop. To customize the appearance
|
|
132
|
+
of `TertiaryButton`, use the `cs` prop for custom styles or the `colors` prop for palette-based
|
|
133
|
+
color overrides.
|
|
131
134
|
|
|
132
135
|
The shape of `TertiaryButton` has changed to have rounded corners, aligning with other buttons and
|
|
133
136
|
our new brand direction.
|
|
@@ -343,16 +346,20 @@ const customTheme = {
|
|
|
343
346
|
|
|
344
347
|
**PR:** [#3287](https://github.com/Workday/canvas-kit/pull/3287)
|
|
345
348
|
|
|
346
|
-
Preview `StatusIndicator` is a rounder and more vibrant base emphasis (`low`). The `emphasis` prop
|
|
349
|
+
Preview `StatusIndicator` is a rounder and more vibrant base emphasis (`low`). The `emphasis` prop
|
|
350
|
+
is now deprecated and the `high` emphasis will be removed in a later version.
|
|
347
351
|
|
|
348
352
|
Variant names of the preview `StatusIndicator` have been updated by the following mapping:
|
|
353
|
+
|
|
349
354
|
- `blue` -> `primary`
|
|
350
355
|
- `green` -> `success`
|
|
351
356
|
- `orange` -> `caution`
|
|
352
357
|
- `red` -> `critical`
|
|
353
358
|
- `gray` -> `neutral`
|
|
354
359
|
|
|
355
|
-
The `StatusIndicatorVariant` type has been updated to contain the new variant names listed above. If
|
|
360
|
+
The `StatusIndicatorVariant` type has been updated to contain the new variant names listed above. If
|
|
361
|
+
you use the old variant values, update to use the new ones mapped above. It has also been
|
|
362
|
+
deprecated. Use `StatusIndicatorProps['variant']` instead.
|
|
356
363
|
|
|
357
364
|
## Deprecations
|
|
358
365
|
|
|
@@ -400,6 +407,18 @@ for smootier upgrade.
|
|
|
400
407
|
Removals are deletions from our codebase and you can no longer consume this component. We've either
|
|
401
408
|
promoted or replaced a component or utility.
|
|
402
409
|
|
|
410
|
+
### Deprecated Buttons
|
|
411
|
+
|
|
412
|
+
**PR:** [#3429](https://github.com/Workday/canvas-kit/pull/3439)
|
|
413
|
+
|
|
414
|
+
Long overdue, but a sign of moving forward, we are removing our `DeprecatedButton`. Our design
|
|
415
|
+
system supported this for quite some time, but with the advancement in theming, our components API
|
|
416
|
+
and our flexibility, it is time for us to finally remove this component. This component has served
|
|
417
|
+
as a reminder of how far we've come and it part we're thankful for this change.
|
|
418
|
+
|
|
419
|
+
Al though unlikely, but not impossible, if you were using `DeprecatedButton` please use our flexible
|
|
420
|
+
and themable buttons like `PrimaryButton`, `ScondaryButton` or `TertiaryButton`.
|
|
421
|
+
|
|
403
422
|
### Menu (preview)
|
|
404
423
|
|
|
405
424
|
**PR:** [#3353](https://github.com/Workday/canvas-kit/pull/3353)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "14.0.0-alpha.
|
|
3
|
+
"version": "14.0.0-alpha.1212-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",
|
|
@@ -45,10 +45,10 @@
|
|
|
45
45
|
"@emotion/styled": "^11.6.0",
|
|
46
46
|
"@stackblitz/sdk": "^1.11.0",
|
|
47
47
|
"@storybook/csf": "0.0.1",
|
|
48
|
-
"@workday/canvas-kit-labs-react": "^14.0.0-alpha.
|
|
49
|
-
"@workday/canvas-kit-preview-react": "^14.0.0-alpha.
|
|
50
|
-
"@workday/canvas-kit-react": "^14.0.0-alpha.
|
|
51
|
-
"@workday/canvas-kit-styling": "^14.0.0-alpha.
|
|
48
|
+
"@workday/canvas-kit-labs-react": "^14.0.0-alpha.1212-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^14.0.0-alpha.1212-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^14.0.0-alpha.1212-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^14.0.0-alpha.1212-next.0",
|
|
52
52
|
"@workday/canvas-system-icons-web": "^3.0.35",
|
|
53
53
|
"@workday/canvas-tokens-web": "3.0.0-alpha.12",
|
|
54
54
|
"markdown-to-jsx": "^7.2.0",
|
|
@@ -61,5 +61,5 @@
|
|
|
61
61
|
"mkdirp": "^1.0.3",
|
|
62
62
|
"typescript": "5.0"
|
|
63
63
|
},
|
|
64
|
-
"gitHead": "
|
|
64
|
+
"gitHead": "4061f71f096822b9165e03d503a7f22ee01c1565"
|
|
65
65
|
}
|