@workday/canvas-kit-docs 13.0.0-alpha.1074-next.0 → 13.0.0-alpha.1075-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 +72 -152
- package/dist/mdx/13.0-UPGRADE-GUIDE.mdx +51 -3
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -9181,150 +9181,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
9181
9181
|
]
|
|
9182
9182
|
}
|
|
9183
9183
|
},
|
|
9184
|
-
{
|
|
9185
|
-
"name": "dubLogoPrimary",
|
|
9186
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9187
|
-
"description": "",
|
|
9188
|
-
"declarations": [
|
|
9189
|
-
{
|
|
9190
|
-
"name": "dubLogoPrimary",
|
|
9191
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9192
|
-
}
|
|
9193
|
-
],
|
|
9194
|
-
"tags": {},
|
|
9195
|
-
"type": {
|
|
9196
|
-
"kind": "primitive",
|
|
9197
|
-
"value": "string"
|
|
9198
|
-
}
|
|
9199
|
-
},
|
|
9200
|
-
{
|
|
9201
|
-
"name": "dubLogoReversed",
|
|
9202
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9203
|
-
"description": "",
|
|
9204
|
-
"declarations": [
|
|
9205
|
-
{
|
|
9206
|
-
"name": "dubLogoReversed",
|
|
9207
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9208
|
-
}
|
|
9209
|
-
],
|
|
9210
|
-
"tags": {},
|
|
9211
|
-
"type": {
|
|
9212
|
-
"kind": "primitive",
|
|
9213
|
-
"value": "string"
|
|
9214
|
-
}
|
|
9215
|
-
},
|
|
9216
|
-
{
|
|
9217
|
-
"name": "dubLogoMonoBlue",
|
|
9218
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9219
|
-
"description": "",
|
|
9220
|
-
"declarations": [
|
|
9221
|
-
{
|
|
9222
|
-
"name": "dubLogoMonoBlue",
|
|
9223
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9224
|
-
}
|
|
9225
|
-
],
|
|
9226
|
-
"tags": {},
|
|
9227
|
-
"type": {
|
|
9228
|
-
"kind": "primitive",
|
|
9229
|
-
"value": "string"
|
|
9230
|
-
}
|
|
9231
|
-
},
|
|
9232
|
-
{
|
|
9233
|
-
"name": "dubLogoMonoWhite",
|
|
9234
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9235
|
-
"description": "",
|
|
9236
|
-
"declarations": [
|
|
9237
|
-
{
|
|
9238
|
-
"name": "dubLogoMonoWhite",
|
|
9239
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9240
|
-
}
|
|
9241
|
-
],
|
|
9242
|
-
"tags": {},
|
|
9243
|
-
"type": {
|
|
9244
|
-
"kind": "primitive",
|
|
9245
|
-
"value": "string"
|
|
9246
|
-
}
|
|
9247
|
-
},
|
|
9248
|
-
{
|
|
9249
|
-
"name": "wdayLogoPrimary",
|
|
9250
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9251
|
-
"description": "",
|
|
9252
|
-
"declarations": [
|
|
9253
|
-
{
|
|
9254
|
-
"name": "wdayLogoPrimary",
|
|
9255
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9256
|
-
}
|
|
9257
|
-
],
|
|
9258
|
-
"tags": {},
|
|
9259
|
-
"type": {
|
|
9260
|
-
"kind": "primitive",
|
|
9261
|
-
"value": "string"
|
|
9262
|
-
}
|
|
9263
|
-
},
|
|
9264
|
-
{
|
|
9265
|
-
"name": "wdayLogoReversed",
|
|
9266
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9267
|
-
"description": "",
|
|
9268
|
-
"declarations": [
|
|
9269
|
-
{
|
|
9270
|
-
"name": "wdayLogoReversed",
|
|
9271
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9272
|
-
}
|
|
9273
|
-
],
|
|
9274
|
-
"tags": {},
|
|
9275
|
-
"type": {
|
|
9276
|
-
"kind": "primitive",
|
|
9277
|
-
"value": "string"
|
|
9278
|
-
}
|
|
9279
|
-
},
|
|
9280
|
-
{
|
|
9281
|
-
"name": "wdayLogoMonoBlue",
|
|
9282
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9283
|
-
"description": "",
|
|
9284
|
-
"declarations": [
|
|
9285
|
-
{
|
|
9286
|
-
"name": "wdayLogoMonoBlue",
|
|
9287
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9288
|
-
}
|
|
9289
|
-
],
|
|
9290
|
-
"tags": {},
|
|
9291
|
-
"type": {
|
|
9292
|
-
"kind": "primitive",
|
|
9293
|
-
"value": "string"
|
|
9294
|
-
}
|
|
9295
|
-
},
|
|
9296
|
-
{
|
|
9297
|
-
"name": "wdayLogoMonoWhite",
|
|
9298
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9299
|
-
"description": "",
|
|
9300
|
-
"declarations": [
|
|
9301
|
-
{
|
|
9302
|
-
"name": "wdayLogoMonoWhite",
|
|
9303
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9304
|
-
}
|
|
9305
|
-
],
|
|
9306
|
-
"tags": {},
|
|
9307
|
-
"type": {
|
|
9308
|
-
"kind": "primitive",
|
|
9309
|
-
"value": "string"
|
|
9310
|
-
}
|
|
9311
|
-
},
|
|
9312
|
-
{
|
|
9313
|
-
"name": "miniWdayLogoBlue",
|
|
9314
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts",
|
|
9315
|
-
"description": "",
|
|
9316
|
-
"declarations": [
|
|
9317
|
-
{
|
|
9318
|
-
"name": "miniWdayLogoBlue",
|
|
9319
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/common/lib/parts/_brand-assets.ts"
|
|
9320
|
-
}
|
|
9321
|
-
],
|
|
9322
|
-
"tags": {},
|
|
9323
|
-
"type": {
|
|
9324
|
-
"kind": "primitive",
|
|
9325
|
-
"value": "string"
|
|
9326
|
-
}
|
|
9327
|
-
},
|
|
9328
9184
|
{
|
|
9329
9185
|
"name": "dividerStencil",
|
|
9330
9186
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
|
|
@@ -148336,12 +148192,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
148336
148192
|
}
|
|
148337
148193
|
},
|
|
148338
148194
|
{
|
|
148339
|
-
"name": "
|
|
148195
|
+
"name": "dubLogoPrimary",
|
|
148340
148196
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148341
148197
|
"description": "",
|
|
148342
148198
|
"declarations": [
|
|
148343
148199
|
{
|
|
148344
|
-
"name": "
|
|
148200
|
+
"name": "dubLogoPrimary",
|
|
148345
148201
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148346
148202
|
}
|
|
148347
148203
|
],
|
|
@@ -148352,12 +148208,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
148352
148208
|
}
|
|
148353
148209
|
},
|
|
148354
148210
|
{
|
|
148355
|
-
"name": "
|
|
148211
|
+
"name": "dubLogoReversed",
|
|
148356
148212
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148357
148213
|
"description": "",
|
|
148358
148214
|
"declarations": [
|
|
148359
148215
|
{
|
|
148360
|
-
"name": "
|
|
148216
|
+
"name": "dubLogoReversed",
|
|
148361
148217
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148362
148218
|
}
|
|
148363
148219
|
],
|
|
@@ -148368,12 +148224,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
148368
148224
|
}
|
|
148369
148225
|
},
|
|
148370
148226
|
{
|
|
148371
|
-
"name": "
|
|
148227
|
+
"name": "dubLogoMonoBlue",
|
|
148372
148228
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148373
148229
|
"description": "",
|
|
148374
148230
|
"declarations": [
|
|
148375
148231
|
{
|
|
148376
|
-
"name": "
|
|
148232
|
+
"name": "dubLogoMonoBlue",
|
|
148377
148233
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148378
148234
|
}
|
|
148379
148235
|
],
|
|
@@ -148384,12 +148240,76 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
148384
148240
|
}
|
|
148385
148241
|
},
|
|
148386
148242
|
{
|
|
148387
|
-
"name": "
|
|
148243
|
+
"name": "dubLogoMonoWhite",
|
|
148244
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148245
|
+
"description": "",
|
|
148246
|
+
"declarations": [
|
|
148247
|
+
{
|
|
148248
|
+
"name": "dubLogoMonoWhite",
|
|
148249
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148250
|
+
}
|
|
148251
|
+
],
|
|
148252
|
+
"tags": {},
|
|
148253
|
+
"type": {
|
|
148254
|
+
"kind": "primitive",
|
|
148255
|
+
"value": "string"
|
|
148256
|
+
}
|
|
148257
|
+
},
|
|
148258
|
+
{
|
|
148259
|
+
"name": "wdayLogoPrimary",
|
|
148388
148260
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148389
148261
|
"description": "",
|
|
148390
148262
|
"declarations": [
|
|
148391
148263
|
{
|
|
148392
|
-
"name": "
|
|
148264
|
+
"name": "wdayLogoPrimary",
|
|
148265
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148266
|
+
}
|
|
148267
|
+
],
|
|
148268
|
+
"tags": {},
|
|
148269
|
+
"type": {
|
|
148270
|
+
"kind": "primitive",
|
|
148271
|
+
"value": "string"
|
|
148272
|
+
}
|
|
148273
|
+
},
|
|
148274
|
+
{
|
|
148275
|
+
"name": "wdayLogoReversed",
|
|
148276
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148277
|
+
"description": "",
|
|
148278
|
+
"declarations": [
|
|
148279
|
+
{
|
|
148280
|
+
"name": "wdayLogoReversed",
|
|
148281
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148282
|
+
}
|
|
148283
|
+
],
|
|
148284
|
+
"tags": {},
|
|
148285
|
+
"type": {
|
|
148286
|
+
"kind": "primitive",
|
|
148287
|
+
"value": "string"
|
|
148288
|
+
}
|
|
148289
|
+
},
|
|
148290
|
+
{
|
|
148291
|
+
"name": "wdayLogoMonoBlue",
|
|
148292
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148293
|
+
"description": "",
|
|
148294
|
+
"declarations": [
|
|
148295
|
+
{
|
|
148296
|
+
"name": "wdayLogoMonoBlue",
|
|
148297
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148298
|
+
}
|
|
148299
|
+
],
|
|
148300
|
+
"tags": {},
|
|
148301
|
+
"type": {
|
|
148302
|
+
"kind": "primitive",
|
|
148303
|
+
"value": "string"
|
|
148304
|
+
}
|
|
148305
|
+
},
|
|
148306
|
+
{
|
|
148307
|
+
"name": "wdayLogoMonoWhite",
|
|
148308
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
148309
|
+
"description": "",
|
|
148310
|
+
"declarations": [
|
|
148311
|
+
{
|
|
148312
|
+
"name": "wdayLogoMonoWhite",
|
|
148393
148313
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts"
|
|
148394
148314
|
}
|
|
148395
148315
|
],
|
|
@@ -21,6 +21,8 @@ any questions.
|
|
|
21
21
|
- [External Hyperlink](#external-hyperlink)
|
|
22
22
|
- [Pill](#pill)
|
|
23
23
|
- [Tabs](#tabs)
|
|
24
|
+
- [Brand Refresh](#brand-refresh)
|
|
25
|
+
- [Logo Updates](#logo-updates)
|
|
24
26
|
- [Infrastructure](#infrastructure)
|
|
25
27
|
- [Supporting react-jsx](#supoorting-react-jsx)
|
|
26
28
|
- [Troubleshooting](#troubleshooting)
|
|
@@ -118,7 +120,7 @@ The following components are affected:
|
|
|
118
120
|
- `Tabs`
|
|
119
121
|
- `Tooltip`
|
|
120
122
|
|
|
121
|
-
|
|
123
|
+
### External Hyperlink
|
|
122
124
|
|
|
123
125
|
**PR:** [#3101](https://github.com/Workday/canvas-kit/pull/3101)
|
|
124
126
|
|
|
@@ -136,7 +138,7 @@ The following components are affected:
|
|
|
136
138
|
</ExternalHyperlink>
|
|
137
139
|
```
|
|
138
140
|
|
|
139
|
-
|
|
141
|
+
### Pill
|
|
140
142
|
|
|
141
143
|
**PRs:** [#3104](https://github.com/Workday/canvas-kit/pull/3104)
|
|
142
144
|
|
|
@@ -152,7 +154,7 @@ A few changes have been made to `Pill` to ensure proper accessibility and styles
|
|
|
152
154
|
- `<Pill.IconButton/>` no longer has a default `aria-label="remove"`. You *must* provide an `aria-label` for `<Pill.IconButton/>` to ensure proper accessibility. Our examples have been updated to reflect this change.
|
|
153
155
|
- `<Pill.Label/>` is a *required* element when using other sub-components like `<Pill.Icon/>` to ensure that the label truncates correctly.
|
|
154
156
|
|
|
155
|
-
|
|
157
|
+
### Tabs
|
|
156
158
|
|
|
157
159
|
**PR:** [#3119](https://github.com/Workday/canvas-kit/pull/3119)
|
|
158
160
|
|
|
@@ -160,6 +162,52 @@ A few changes have been made to `Pill` to ensure proper accessibility and styles
|
|
|
160
162
|
|
|
161
163
|
**Note:** There should be no developer impact and the visual changes are safe to accept.
|
|
162
164
|
|
|
165
|
+
## Brand Refresh
|
|
166
|
+
|
|
167
|
+
### Logo Updates
|
|
168
|
+
|
|
169
|
+
We've removed the outdated Dub Logos in Main and promoted the new logos that were previously in our Preview package to Main as part of the brand refresh.
|
|
170
|
+
|
|
171
|
+
| Old Logo Name | New Logo Name |
|
|
172
|
+
| --------------- | ----------------- |
|
|
173
|
+
| dubLogoBlue | dubLogoPrimary |
|
|
174
|
+
| dubLogoWhite | dubLogoReversed |
|
|
175
|
+
| wdayLogoBlue | wdayLogoPrimary |
|
|
176
|
+
| wdayLogoWhite | wdayLogoReversed |
|
|
177
|
+
|
|
178
|
+
```tsx
|
|
179
|
+
// In v12
|
|
180
|
+
// Importing from Main common
|
|
181
|
+
import {dubLogoBlue} from "@workday/canvas-kit-react/common"
|
|
182
|
+
|
|
183
|
+
<div dangerouslySetInnerHTML={__html: dubLogoBlue} />
|
|
184
|
+
|
|
185
|
+
// Importing from Preview common
|
|
186
|
+
import {dubLogoPrimary} from "@workday/canvas-kit-preview-react/common"
|
|
187
|
+
|
|
188
|
+
<div dangerouslySetInnerHTML={__html: dubLogoPrimary} />
|
|
189
|
+
|
|
190
|
+
// In v13
|
|
191
|
+
// New logos have been promoted to Main common AND renamed
|
|
192
|
+
import {dubLogoPrimary} from "@workday/canvas-kit-preview-react/common"
|
|
193
|
+
|
|
194
|
+
<div dangerouslySetInnerHTML={__html: dubLogoPrimary} />
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
🤖 The codemod will handle the change of `'dubLogoBlue', 'dubLogoWhite', 'wdayLogoBlue', 'wdayLogoWhite'` to
|
|
198
|
+
`'dubLogoPrimary', 'dubLogoReversed', 'wdayLogoPrimary', 'wdayLogoReversed'` as shown above in the table. It will also handle
|
|
199
|
+
updating your imports.
|
|
200
|
+
|
|
201
|
+
From:
|
|
202
|
+
```tsx
|
|
203
|
+
import {dubLogoBlue} from "@workday/canvas-kit-react/common"
|
|
204
|
+
```
|
|
205
|
+
To:
|
|
206
|
+
```tsx
|
|
207
|
+
import {dubLogoPrimary} from "@workday/canvas-kit-react/common"
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
|
|
163
211
|
## Infrastructure
|
|
164
212
|
|
|
165
213
|
### Supporting `react-jsx`
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "13.0.0-alpha.
|
|
3
|
+
"version": "13.0.0-alpha.1075-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": "^13.0.0-alpha.
|
|
49
|
-
"@workday/canvas-kit-preview-react": "^13.0.0-alpha.
|
|
50
|
-
"@workday/canvas-kit-react": "^13.0.0-alpha.
|
|
51
|
-
"@workday/canvas-kit-styling": "^13.0.0-alpha.
|
|
48
|
+
"@workday/canvas-kit-labs-react": "^13.0.0-alpha.1075-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^13.0.0-alpha.1075-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^13.0.0-alpha.1075-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^13.0.0-alpha.1075-next.0",
|
|
52
52
|
"@workday/canvas-system-icons-web": "^3.0.0",
|
|
53
53
|
"@workday/canvas-tokens-web": "^2.1.1",
|
|
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": "423e097625d8c1cf8e48dcfc794313aae00ded67"
|
|
65
65
|
}
|