@workday/canvas-kit-docs 14.0.0-alpha.1206-next.0 → 14.0.0-alpha.1210-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 +2608 -69
- package/dist/es6/lib/stackblitzFiles/packageJSONFile.js +5 -5
- package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts +5 -5
- package/dist/mdx/14.0-UPGRADE-GUIDE.mdx +65 -3
- package/dist/mdx/labs-react/combobox/Combobox.mdx +19 -3
- package/dist/mdx/preview-react/status-indicator/examples/Icon.tsx +1 -1
- package/dist/mdx/preview-react/status-indicator/examples/Variants.tsx +8 -8
- package/dist/mdx/preview-react/text-area/TextArea.mdx +3 -3
- package/dist/mdx/preview-react/text-input/TextInput.mdx +3 -3
- package/dist/mdx/react/radio/Radio.mdx +15 -6
- package/dist/mdx/react/segmented-control/SegmentedControl.mdx +21 -2
- package/package.json +6 -6
|
@@ -18,11 +18,11 @@ export const packageJSONFile = `{
|
|
|
18
18
|
"@emotion/react": "11.11.4",
|
|
19
19
|
"@types/react": "18.2.60",
|
|
20
20
|
"@types/react-dom": "18.2.19",
|
|
21
|
-
"@workday/canvas-kit-labs-react": "13.2.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.2.
|
|
23
|
-
"@workday/canvas-kit-react": "13.2.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.2.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.2.
|
|
21
|
+
"@workday/canvas-kit-labs-react": "13.2.19",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.2.19",
|
|
23
|
+
"@workday/canvas-kit-react": "13.2.19",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.2.19",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.2.19",
|
|
26
26
|
"@workday/canvas-system-icons-web": "3.0.22",
|
|
27
27
|
"@workday/canvas-tokens-web": "2.0.0"
|
|
28
28
|
},
|
|
@@ -18,11 +18,11 @@ export const packageJSONFile = `{
|
|
|
18
18
|
"@emotion/react": "11.11.4",
|
|
19
19
|
"@types/react": "18.2.60",
|
|
20
20
|
"@types/react-dom": "18.2.19",
|
|
21
|
-
"@workday/canvas-kit-labs-react": "13.2.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.2.
|
|
23
|
-
"@workday/canvas-kit-react": "13.2.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.2.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.2.
|
|
21
|
+
"@workday/canvas-kit-labs-react": "13.2.19",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.2.19",
|
|
23
|
+
"@workday/canvas-kit-react": "13.2.19",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.2.19",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.2.19",
|
|
26
26
|
"@workday/canvas-system-icons-web": "3.0.22",
|
|
27
27
|
"@workday/canvas-tokens-web": "2.0.0"
|
|
28
28
|
},
|
|
@@ -18,6 +18,13 @@ any questions.
|
|
|
18
18
|
- [Hyperlink & ExternalHyperlink](#hyperlink-and-externalhyperlink)
|
|
19
19
|
- [Loading Dots](#loading-dots)
|
|
20
20
|
- [SearchForm](#search-form)
|
|
21
|
+
- [Status Indicator (Preview)](#status-indicator-preview)
|
|
22
|
+
- [Deprecations](#deprecations)
|
|
23
|
+
- [Combobox (Labs)](#combobox-labs)
|
|
24
|
+
- [Radio (Main)](#radio-main)
|
|
25
|
+
- [Segmented Control (Main)](#segmented-control-main)
|
|
26
|
+
- [Side Panel (Main)](#side-panel-main)
|
|
27
|
+
- [Tokens](#tokens)
|
|
21
28
|
- [Removals](#removals)
|
|
22
29
|
- [Menu (preview)](#menu-preview)
|
|
23
30
|
- [Troubleshooting](#troubleshooting)
|
|
@@ -98,8 +105,7 @@ yarn remove @workday/canvas-kit-codemod
|
|
|
98
105
|
|
|
99
106
|
### Branding Changes 💅
|
|
100
107
|
|
|
101
|
-
Several components have been refactored to reflect our new brand direction. Most of these changes
|
|
102
|
-
revolve around the use of our new brand colors.
|
|
108
|
+
Several components have been refactored to reflect our new brand direction. Most of these changes revolve around the use of our new brand colors.
|
|
103
109
|
|
|
104
110
|
The following components have been updated:
|
|
105
111
|
|
|
@@ -119,7 +125,7 @@ The following components have been updated:
|
|
|
119
125
|
|
|
120
126
|
#### TertiaryButton
|
|
121
127
|
|
|
122
|
-
The `TertiaryButton` component no longer supports the `isThemable` prop.
|
|
128
|
+
The `TertiaryButton` component no longer supports the `isThemable` prop.
|
|
123
129
|
To customize the appearance of `TertiaryButton`, use the `cs` prop for custom styles or the `colors`
|
|
124
130
|
prop for palette-based color overrides.
|
|
125
131
|
|
|
@@ -333,6 +339,62 @@ const customTheme = {
|
|
|
333
339
|
This **should not** affect the way you use the type unless you're passing a `number` of `0`, `1`
|
|
334
340
|
or `2` to the `searchTheme` prop.
|
|
335
341
|
|
|
342
|
+
### Status Indicator (Preview) 🚨
|
|
343
|
+
|
|
344
|
+
**PR:** [#3287](https://github.com/Workday/canvas-kit/pull/3287)
|
|
345
|
+
|
|
346
|
+
Preview `StatusIndicator` is a rounder and more vibrant base emphasis (`low`). The `emphasis` prop is now deprecated and the `high` emphasis will be removed in a later version.
|
|
347
|
+
|
|
348
|
+
Variant names of the preview `StatusIndicator` have been updated by the following mapping:
|
|
349
|
+
- `blue` -> `primary`
|
|
350
|
+
- `green` -> `success`
|
|
351
|
+
- `orange` -> `caution`
|
|
352
|
+
- `red` -> `critical`
|
|
353
|
+
- `gray` -> `neutral`
|
|
354
|
+
|
|
355
|
+
The `StatusIndicatorVariant` type has been updated to contain the new variant names listed above. If you use the old variant values, update to use the new ones mapped above. It has also been deprecated. Use `StatusIndicatorProps['variant']` instead.
|
|
356
|
+
|
|
357
|
+
## Deprecations
|
|
358
|
+
|
|
359
|
+
We add the [@deprecated](https://jsdoc.app/tags-deprecated.html) JSDoc tag to code we plan to remove
|
|
360
|
+
in a future major release. This signals consumers to migrate to a more stable alternative before the
|
|
361
|
+
deprecated code is removed.
|
|
362
|
+
|
|
363
|
+
### Combobox (Labs)
|
|
364
|
+
|
|
365
|
+
The Combobox component in `@workday/canvas-kit-labs-react/combobox` has been deprecated and will be
|
|
366
|
+
removed in a future major release. Please migrate to the
|
|
367
|
+
[Combobox](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-combobox--docs) in
|
|
368
|
+
`@workday/canvas-kit-react`.
|
|
369
|
+
|
|
370
|
+
### Radio (Main)
|
|
371
|
+
|
|
372
|
+
The Radio component in `@workday/canvas-kit-react/radio` has been deprecated. Please use the new
|
|
373
|
+
[Radio](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-radio--docs) component
|
|
374
|
+
from the same package, which offers improved accessibility and API consistency.
|
|
375
|
+
|
|
376
|
+
### Segmented Control (Main)
|
|
377
|
+
|
|
378
|
+
The Segmented Control component in `@workday/canvas-kit-react/segmented-control` has been
|
|
379
|
+
deprecated. Please migrate to the new
|
|
380
|
+
[Segmented Control](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-segmented-control--docs)
|
|
381
|
+
for improved features and support.
|
|
382
|
+
|
|
383
|
+
### Side Panel (Main)
|
|
384
|
+
|
|
385
|
+
The Side Panel component in `@workday/canvas-kit-react/side-panel` is now deprecated and will be
|
|
386
|
+
removed in a future release. Please use the new
|
|
387
|
+
[Side Panel](https://workday.github.io/canvas-kit/?path=/docs/components-navigation-side-panel--docs)
|
|
388
|
+
for enhanced functionality.
|
|
389
|
+
|
|
390
|
+
### Tokens
|
|
391
|
+
|
|
392
|
+
The legacy tokens from `@workday/canvas-kit-react/tokens` are now deprecated. Please use the new
|
|
393
|
+
[Canvas Tokens Web](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)
|
|
394
|
+
package (`@workday/canvas-tokens-web`) for all token usage. Follow
|
|
395
|
+
[a migration guide](https://workday.github.io/canvas-kit?path=/docs/guides-tokens-migration-overview--docs)
|
|
396
|
+
for smootier upgrade.
|
|
397
|
+
|
|
336
398
|
## Removals
|
|
337
399
|
|
|
338
400
|
Removals are deletions from our codebase and you can no longer consume this component. We've either
|
|
@@ -1,5 +1,10 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
1
|
+
import {
|
|
2
|
+
ExampleCodeBlock,
|
|
3
|
+
StorybookStatusIndicator,
|
|
4
|
+
SymbolDoc,
|
|
5
|
+
Specifications,
|
|
6
|
+
} from '@workday/canvas-kit-docs';
|
|
7
|
+
import {InformationHighlight} from '@workday/canvas-kit-preview-react/information-highlight';
|
|
3
8
|
import Basic from './examples/Basic';
|
|
4
9
|
import DisabledItem from './examples/DisabledItem';
|
|
5
10
|
import GroupOfResult from './examples/GroupOfResult';
|
|
@@ -8,7 +13,18 @@ import NoClearButton from './examples/NoClearButton';
|
|
|
8
13
|
import RTL from './examples/RTL';
|
|
9
14
|
|
|
10
15
|
|
|
11
|
-
# Combobox
|
|
16
|
+
# Combobox <StorybookStatusIndicator type="deprecated" />
|
|
17
|
+
|
|
18
|
+
<InformationHighlight className="sb-unstyled" variant="caution" cs={{p: {marginBlock: 0}}}>
|
|
19
|
+
<InformationHighlight.Icon />
|
|
20
|
+
<InformationHighlight.Body>
|
|
21
|
+
`Combobox` in Preview has been deprecated and will be removed in a future major version. Please
|
|
22
|
+
use `Combobox` in Main instead.
|
|
23
|
+
</InformationHighlight.Body>
|
|
24
|
+
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs">
|
|
25
|
+
Combobox Docs
|
|
26
|
+
</InformationHighlight.Link>
|
|
27
|
+
</InformationHighlight>
|
|
12
28
|
|
|
13
29
|
The term "Combobox" is based on the
|
|
14
30
|
[Combobox Pattern](https://www.w3.org/WAI/ARIA/apg/patterns/combobox/) as defined in the ARIA
|
|
@@ -17,7 +17,7 @@ export default () => {
|
|
|
17
17
|
<StatusIndicator.Icon aria-label="unpublished" icon={uploadCloudIcon} />
|
|
18
18
|
<StatusIndicator.Label>Unpublished</StatusIndicator.Label>
|
|
19
19
|
</StatusIndicator>
|
|
20
|
-
<StatusIndicator variant="
|
|
20
|
+
<StatusIndicator variant="positive">
|
|
21
21
|
<StatusIndicator.Label>published</StatusIndicator.Label>
|
|
22
22
|
<StatusIndicator.Icon aria-label="published" icon={uploadCloudIcon} />
|
|
23
23
|
</StatusIndicator>
|
|
@@ -24,19 +24,19 @@ export default () => {
|
|
|
24
24
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
25
25
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
26
26
|
</StatusIndicator>
|
|
27
|
-
<StatusIndicator variant="
|
|
27
|
+
<StatusIndicator variant="caution">
|
|
28
28
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
29
29
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
30
30
|
</StatusIndicator>
|
|
31
|
-
<StatusIndicator variant="
|
|
31
|
+
<StatusIndicator variant="info">
|
|
32
32
|
<StatusIndicator.Label>Lorem ipsum dolor </StatusIndicator.Label>
|
|
33
33
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
34
34
|
</StatusIndicator>
|
|
35
|
-
<StatusIndicator variant="
|
|
35
|
+
<StatusIndicator variant="positive">
|
|
36
36
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
37
37
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
38
38
|
</StatusIndicator>
|
|
39
|
-
<StatusIndicator variant="
|
|
39
|
+
<StatusIndicator variant="critical">
|
|
40
40
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
41
41
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
42
42
|
</StatusIndicator>
|
|
@@ -50,19 +50,19 @@ export default () => {
|
|
|
50
50
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
51
51
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
52
52
|
</StatusIndicator>
|
|
53
|
-
<StatusIndicator emphasis="high" variant="
|
|
53
|
+
<StatusIndicator emphasis="high" variant="caution">
|
|
54
54
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
55
55
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
56
56
|
</StatusIndicator>
|
|
57
|
-
<StatusIndicator emphasis="high" variant="
|
|
57
|
+
<StatusIndicator emphasis="high" variant="info">
|
|
58
58
|
<StatusIndicator.Label>Lorem ipsum dolor </StatusIndicator.Label>
|
|
59
59
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
60
60
|
</StatusIndicator>
|
|
61
|
-
<StatusIndicator emphasis="high" variant="
|
|
61
|
+
<StatusIndicator emphasis="high" variant="positive">
|
|
62
62
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
63
63
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
64
64
|
</StatusIndicator>
|
|
65
|
-
<StatusIndicator emphasis="high" variant="
|
|
65
|
+
<StatusIndicator emphasis="high" variant="critical">
|
|
66
66
|
<StatusIndicator.Label>Lorem ipsum dolor</StatusIndicator.Label>
|
|
67
67
|
<StatusIndicator.Icon icon={uploadCloudIcon} />
|
|
68
68
|
</StatusIndicator>
|
|
@@ -27,10 +27,10 @@ import {StatusIndicator} from '@workday/canvas-kit-preview-react/status-indicato
|
|
|
27
27
|
<InformationHighlight.Icon />
|
|
28
28
|
<InformationHighlight.Body>
|
|
29
29
|
`TextArea` in Preview has been deprecated and will be removed in a future major version. Please
|
|
30
|
-
use `
|
|
30
|
+
use `TextArea` in Main instead.
|
|
31
31
|
</InformationHighlight.Body>
|
|
32
|
-
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/
|
|
33
|
-
|
|
32
|
+
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textarea--docs">
|
|
33
|
+
Text Area Docs
|
|
34
34
|
</InformationHighlight.Link>
|
|
35
35
|
</InformationHighlight>
|
|
36
36
|
|
|
@@ -31,10 +31,10 @@ import Alert from './examples/Alert';
|
|
|
31
31
|
<InformationHighlight.Icon />
|
|
32
32
|
<InformationHighlight.Body>
|
|
33
33
|
`TextInput` in Preview has been deprecated and will be removed in a future major version. Please
|
|
34
|
-
use `
|
|
34
|
+
use `TextInput` in Main instead.
|
|
35
35
|
</InformationHighlight.Body>
|
|
36
|
-
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/
|
|
37
|
-
|
|
36
|
+
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/docs/components-inputs-text-input--docs">
|
|
37
|
+
Text Input Docs
|
|
38
38
|
</InformationHighlight.Link>
|
|
39
39
|
</InformationHighlight>
|
|
40
40
|
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
import {
|
|
2
2
|
ExampleCodeBlock,
|
|
3
|
-
|
|
3
|
+
StorybookStatusIndicator,
|
|
4
4
|
SymbolDoc,
|
|
5
5
|
Specifications,
|
|
6
6
|
} from '@workday/canvas-kit-docs';
|
|
7
|
-
|
|
7
|
+
|
|
8
|
+
import {InformationHighlight} from '@workday/canvas-kit-preview-react/information-highlight';
|
|
9
|
+
|
|
8
10
|
import Alert from './examples/Alert';
|
|
9
11
|
import Basic from './examples/Basic';
|
|
10
12
|
import Disabled from './examples/Disabled';
|
|
@@ -16,11 +18,18 @@ import RefForwarding from './examples/RefForwarding';
|
|
|
16
18
|
import Required from './examples/Required';
|
|
17
19
|
|
|
18
20
|
|
|
19
|
-
# Canvas Kit Radio
|
|
21
|
+
# Canvas Kit Radio <StorybookStatusIndicator type="deprecated" />
|
|
20
22
|
|
|
21
|
-
<
|
|
22
|
-
<
|
|
23
|
-
|
|
23
|
+
<InformationHighlight className="sb-unstyled" variant="caution" cs={{p: {marginBlock: 0}}}>
|
|
24
|
+
<InformationHighlight.Icon />
|
|
25
|
+
<InformationHighlight.Body>
|
|
26
|
+
`Radio` in Main has been deprecated and will be removed in a future major version. Please use
|
|
27
|
+
`Radio` in Preview instead.
|
|
28
|
+
</InformationHighlight.Body>
|
|
29
|
+
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/docs/preview-inputs-radio--docs">
|
|
30
|
+
Radio Docs
|
|
31
|
+
</InformationHighlight.Link>
|
|
32
|
+
</InformationHighlight>
|
|
24
33
|
|
|
25
34
|
Radio Buttons allow a user to select one value from a predefined list of 7 or fewer options.
|
|
26
35
|
|
|
@@ -1,7 +1,26 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
ExampleCodeBlock,
|
|
3
|
+
StorybookStatusIndicator,
|
|
4
|
+
SymbolDoc,
|
|
5
|
+
Specifications,
|
|
6
|
+
} from '@workday/canvas-kit-docs';
|
|
7
|
+
|
|
8
|
+
import {InformationHighlight} from '@workday/canvas-kit-preview-react/information-highlight';
|
|
9
|
+
|
|
2
10
|
import Basic from './examples/Basic';
|
|
3
11
|
|
|
4
|
-
# Canvas Kit Segmented Control
|
|
12
|
+
# Canvas Kit Segmented Control <StorybookStatusIndicator type="deprecated" />
|
|
13
|
+
|
|
14
|
+
<InformationHighlight className="sb-unstyled" variant="caution" cs={{p: {marginBlock: 0}}}>
|
|
15
|
+
<InformationHighlight.Icon />
|
|
16
|
+
<InformationHighlight.Body>
|
|
17
|
+
`SegmentedControl` in Main has been deprecated and will be removed in a future major version.
|
|
18
|
+
Please use `Segmented Control` in Preview instead.
|
|
19
|
+
</InformationHighlight.Body>
|
|
20
|
+
<InformationHighlight.Link href="https://workday.github.io/canvas-kit/?path=/docs/preview-segmented-control--docs">
|
|
21
|
+
Segmented Control Docs
|
|
22
|
+
</InformationHighlight.Link>
|
|
23
|
+
</InformationHighlight>
|
|
5
24
|
|
|
6
25
|
A linear set of two or more segments, each of which functions as a mutually exclusive button. This
|
|
7
26
|
is a [_controlled_](https://reactjs.org/docs/forms.html#controlled-components) component.
|
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.1210-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.1210-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^14.0.0-alpha.1210-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^14.0.0-alpha.1210-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^14.0.0-alpha.1210-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": "8ef8c7a0b7515a9341550c564b84bed91598e9f7"
|
|
65
65
|
}
|