@workday/canvas-kit-docs 14.0.0-alpha.1257-next.0 → 14.0.0-alpha.1258-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.
|
@@ -12,14 +12,16 @@ any questions.
|
|
|
12
12
|
v14.0 Introduces Workday's new brand direction which includes a new color palette and with it, some
|
|
13
13
|
styling updates to our components.
|
|
14
14
|
|
|
15
|
-
**Please consult our
|
|
15
|
+
**Please consult our
|
|
16
|
+
[v14 Visual Changes](/help/upgrade-guides/canvas-v14-upgrade-guide/#tab=visual-changes) page for a
|
|
17
|
+
visual reference of what's changed.**
|
|
16
18
|
|
|
17
19
|
> **Note:** While v14 does not require an upgrade to our v3 tokens, we strongly advise to upgrade to
|
|
18
20
|
> the latest to ensure proper branding.
|
|
19
21
|
|
|
20
22
|
## Table of contents
|
|
21
23
|
|
|
22
|
-
- [LLM Assisted Migration](#llm)
|
|
24
|
+
- [LLM Assisted Migration](#llm-assisted-migration)
|
|
23
25
|
- [Codemod](#codemod)
|
|
24
26
|
- [Instructions](#instructions)
|
|
25
27
|
- [Tokens](#tokens)
|
|
@@ -64,10 +66,10 @@ styling updates to our components.
|
|
|
64
66
|
|
|
65
67
|
## LLM Assisted Migration <StorybookStatusIndicator type="ai" />
|
|
66
68
|
|
|
67
|
-
We provide a **LLM migration mapping file** (`llm-canvas-kit-upgrade-guide-v14.txt`) specifically
|
|
68
|
-
use with LLM-based code assistants (such as [Cursor](https://www.cursor.so/) or similar
|
|
69
|
-
file is not intended for direct human reference or team documentation, but rather as
|
|
70
|
-
input for LLMs to automate and assist with your token migration process.
|
|
69
|
+
We provide a **LLM migration mapping file** (`llm-canvas-kit-upgrade-guide-v14.txt`) specifically
|
|
70
|
+
designed for use with LLM-based code assistants (such as [Cursor](https://www.cursor.so/) or similar
|
|
71
|
+
tools). This file is not intended for direct human reference or team documentation, but rather as
|
|
72
|
+
structured input for LLMs to automate and assist with your token migration process.
|
|
71
73
|
|
|
72
74
|
> **Important:** LLMs can make mistakes. Please review changes to be sure they are correct using our
|
|
73
75
|
> docs and upgrade guides.
|
|
@@ -82,8 +84,8 @@ This file contains a compiled LLM consumption version of this v14 Upgrade Guide.
|
|
|
82
84
|
migration
|
|
83
85
|
|
|
84
86
|
<DownloadLLMFile
|
|
85
|
-
|
|
86
|
-
|
|
87
|
+
rawFileLink="https://raw.githubusercontent.com/Workday/canvas-kit/master/modules/docs/llm-txt/llm-canvas-kit-upgrade-guide-v14.txt"
|
|
88
|
+
filename="llm-canvas-kit-upgrade-guide-v14.txt"
|
|
87
89
|
/>
|
|
88
90
|
|
|
89
91
|
## Codemod
|
|
@@ -246,7 +248,8 @@ someFunction(ErrorType.Caution);
|
|
|
246
248
|
|
|
247
249
|
### New Documentation
|
|
248
250
|
|
|
249
|
-
We've **significantly** improved our theming documentation. Please consult our new
|
|
251
|
+
We've **significantly** improved our theming documentation. Please consult our new
|
|
252
|
+
[Canvas Kit Theming Guide](/get-started/for-developers/theming/overview/).
|
|
250
253
|
|
|
251
254
|
### Canvas Provider 🚨
|
|
252
255
|
|
|
@@ -262,7 +265,10 @@ Canvas Provider has been updated to **remove** default branding colors to ensure
|
|
|
262
265
|
our CSS variables. Instead of generating a palette and shifting the brightness and darkness with
|
|
263
266
|
`chroma.js`, we use `oklch` to generate the palette colors.
|
|
264
267
|
|
|
265
|
-
Prior to v14, `CanvasProvider` created a
|
|
268
|
+
Prior to v14, `CanvasProvider` created a
|
|
269
|
+
[cascade barrier](/get-started/for-developers/theming/overview/#what-is-a-cascade-barrier), which
|
|
270
|
+
redefined brand CSS variables under a class and created a higher specificity. This made it difficult
|
|
271
|
+
to override brand tokens in certain scenarios. v14 removes that barrier.
|
|
266
272
|
|
|
267
273
|
**Before in v13** In v13, the `useTheme` hook would call `createCanvasTheme` which generated a
|
|
268
274
|
palette given a `main` color via `chroma.js`.
|
|
@@ -322,7 +328,6 @@ The reason for this change is to ensure that the CSS variables properly cascade
|
|
|
322
328
|
Before in v13, the `CanvasProvider` would add the brand tokens under a class name, creating a higher
|
|
323
329
|
specificity.
|
|
324
330
|
|
|
325
|
-
|
|
326
331
|
### useIsRTL
|
|
327
332
|
|
|
328
333
|
**PR:** [#3480](https://github.com/Workday/canvas-kit/pull/3477)
|
|
@@ -393,9 +398,9 @@ revolve around the use of our new brand colors. For a better guide on what has c
|
|
|
393
398
|
tokens, please view the Tokens v3.0.0
|
|
394
399
|
[Upgrade Guide](https://workday.github.io/canvas-tokens/?path=/docs/guides-upgrade-guides-v3-overview--docs).
|
|
395
400
|
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
401
|
+
The following components have been updated (**see
|
|
402
|
+
[v14 Visual Changes](/help/upgrade-guides/canvas-v14-upgrade-guide/#tab=visual-changes) for a visual
|
|
403
|
+
reference of the updates**):
|
|
399
404
|
|
|
400
405
|
- `Breadcrumbs`
|
|
401
406
|
[#3270](https://github.com/Workday/canvas-kit/pull/3270),[#3447](https://github.com/Workday/canvas-kit/pull/3447)
|
|
@@ -41,8 +41,8 @@ LLM consumption.
|
|
|
41
41
|
migration
|
|
42
42
|
|
|
43
43
|
<DownloadLLMFile
|
|
44
|
-
|
|
45
|
-
|
|
44
|
+
rawFileLink="https://raw.githubusercontent.com/Workday/canvas-kit/master/modules/docs/llm-txt/llm-token-migration-14.txt"
|
|
45
|
+
filename="llm-token-migration-14.0.0.txt"
|
|
46
46
|
/>
|
|
47
47
|
|
|
48
48
|
## Core Principles
|
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.1258-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.1258-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^14.0.0-alpha.1258-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^14.0.0-alpha.1258-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^14.0.0-alpha.1258-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": "a455f82fedaccde04d905face6d63445e9c589e6"
|
|
65
65
|
}
|