@workday/canvas-kit-docs 13.1.5 → 13.2.0-1152-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 +55 -16
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -376878,7 +376878,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
376878
376878
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
376879
376879
|
}
|
|
376880
376880
|
],
|
|
376881
|
-
"tags": {
|
|
376881
|
+
"tags": {
|
|
376882
|
+
"deprecated": "Use brand or system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
376883
|
+
}
|
|
376882
376884
|
},
|
|
376883
376885
|
{
|
|
376884
376886
|
"kind": "property",
|
|
@@ -376963,7 +376965,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
376963
376965
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
376964
376966
|
}
|
|
376965
376967
|
],
|
|
376966
|
-
"tags": {
|
|
376968
|
+
"tags": {
|
|
376969
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
376970
|
+
}
|
|
376967
376971
|
},
|
|
376968
376972
|
{
|
|
376969
376973
|
"kind": "property",
|
|
@@ -378442,7 +378446,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
378442
378446
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
378443
378447
|
}
|
|
378444
378448
|
],
|
|
378445
|
-
"tags": {
|
|
378449
|
+
"tags": {
|
|
378450
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
378451
|
+
}
|
|
378446
378452
|
},
|
|
378447
378453
|
{
|
|
378448
378454
|
"kind": "property",
|
|
@@ -381213,7 +381219,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381213
381219
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381214
381220
|
}
|
|
381215
381221
|
],
|
|
381216
|
-
"tags": {
|
|
381222
|
+
"tags": {
|
|
381223
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
381224
|
+
}
|
|
381217
381225
|
},
|
|
381218
381226
|
{
|
|
381219
381227
|
"kind": "property",
|
|
@@ -381332,7 +381340,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381332
381340
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381333
381341
|
}
|
|
381334
381342
|
],
|
|
381335
|
-
"tags": {
|
|
381343
|
+
"tags": {
|
|
381344
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
381345
|
+
"see": "| Old Token | New Token |\n|----------------|---------------------|\n| `commonColors.background` | `system.color.bg.default` |\n| `commonColors.backgroundAlt` | `system.color.bg.alt.default` |\n| `commonColors.focusOutline` | `system.color.border.primary.default` |\n| `commonColors.focusBackground` | `system.color.bg.primary.default` |\n| `commonColors.hoverBackground` | `system.color.bg.alt.strong` |\n| `commonColors.divider` | `system.color.border.divider` |"
|
|
381346
|
+
}
|
|
381336
381347
|
},
|
|
381337
381348
|
{
|
|
381338
381349
|
"kind": "property",
|
|
@@ -381349,7 +381360,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381349
381360
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381350
381361
|
}
|
|
381351
381362
|
],
|
|
381352
|
-
"tags": {
|
|
381363
|
+
"tags": {
|
|
381364
|
+
"deprecated": "Use system depth tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
381365
|
+
"see": "| Old Token | New Token |\n|----------------|---------------------|\n| `depth[0]` | `{boxShadow: 'none'}` |\n| `depth[1]` | `{boxShadow: system.depth[1]}` |\n| `depth[2]` | `{boxShadow: system.depth[2]}` |\n| `depth[3]` | `{boxShadow: system.depth[3]}` |\n| `depth[4]` | `{boxShadow: system.depth[4]}` |\n| `depth[5]` | `{boxShadow: system.depth[5]}` |\n| `depth[6]` | `{boxShadow: system.depth[6]}` |"
|
|
381366
|
+
}
|
|
381353
381367
|
},
|
|
381354
381368
|
{
|
|
381355
381369
|
"kind": "property",
|
|
@@ -381365,7 +381379,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381365
381379
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381366
381380
|
}
|
|
381367
381381
|
],
|
|
381368
|
-
"tags": {
|
|
381382
|
+
"tags": {
|
|
381383
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
381384
|
+
}
|
|
381369
381385
|
},
|
|
381370
381386
|
{
|
|
381371
381387
|
"kind": "property",
|
|
@@ -381790,7 +381806,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381790
381806
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381791
381807
|
}
|
|
381792
381808
|
],
|
|
381793
|
-
"tags": {
|
|
381809
|
+
"tags": {
|
|
381810
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
381811
|
+
}
|
|
381794
381812
|
},
|
|
381795
381813
|
{
|
|
381796
381814
|
"kind": "property",
|
|
@@ -381892,7 +381910,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381892
381910
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381893
381911
|
}
|
|
381894
381912
|
],
|
|
381895
|
-
"tags": {
|
|
381913
|
+
"tags": {
|
|
381914
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
381915
|
+
"see": "| Old Token | New Token |\n|----------------|---------------------|\n| `iconColors.active` | `system.color.fg.primary.default` |\n| `iconColors.disabled` | `system.color.fg.disabled.default` |\n| `iconColors.hover` | `system.color.fg.muted.stronger` |\n| `iconColors.inverse` | `system.color.fg.inverse` |\n| `iconColors.standard` | `system.color.fg.muted.soft` |"
|
|
381916
|
+
}
|
|
381896
381917
|
},
|
|
381897
381918
|
{
|
|
381898
381919
|
"kind": "property",
|
|
@@ -382286,7 +382307,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382286
382307
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382287
382308
|
}
|
|
382288
382309
|
],
|
|
382289
|
-
"tags": {
|
|
382310
|
+
"tags": {
|
|
382311
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
382312
|
+
"see": "| Old Token | New Token |\n|----------------|---------------------|\n| `inputColors.background` | `system.color.bg.default` |\n| `inputColors.border` | `system.color.border.input.default` |\n| `inputColors.placeholder` | `system.color.fg.muted.default` |\n| `inputColors.text` | `system.color.fg.default` |\n| `inputColors.icon` | `system.color.fg.muted.soft` |\n| `inputColors.iconHover` | `system.color.fg.muted.stronger` |\n| `inputColors.selectionControlFill` | `system.color.bg.primary.default` |\n| `inputColors.hoverBorder` | `system.color.border.input.strong` |\n| `inputColors.focusBorder` | `system.color.border.primary.default` |\n| `inputColors.disabled.background` | `system.color.bg.alt.softer` |\n| `inputColors.disabled.border` | `system.color.border.input.disabled` |\n| `inputColors.disabled.text` | `system.color.fg.disabled` |\n| `inputColors.disabled.icon` | `system.color.fg.disabled` |\n| `inputColors.error.border` | `system.color.border.critical.default` |\n| `inputColors.error.message` | `base.blackPepper100` |\n| `inputColors.error.icon` | `system.color.fg.critical.default` |\n| `inputColors.alert.border` | `system.color.border.caution.default` |\n| `inputColors.alert.message` | `base.blackPepper100` |\n| `inputColors.alert.icon` | `base.cantaloupe500` |"
|
|
382313
|
+
}
|
|
382290
382314
|
},
|
|
382291
382315
|
{
|
|
382292
382316
|
"kind": "property",
|
|
@@ -382302,7 +382326,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382302
382326
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382303
382327
|
}
|
|
382304
382328
|
],
|
|
382305
|
-
"tags": {
|
|
382329
|
+
"tags": {
|
|
382330
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs)."
|
|
382331
|
+
}
|
|
382306
382332
|
},
|
|
382307
382333
|
{
|
|
382308
382334
|
"kind": "property",
|
|
@@ -382319,7 +382345,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382319
382345
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382320
382346
|
}
|
|
382321
382347
|
],
|
|
382322
|
-
"tags": {
|
|
382348
|
+
"tags": {
|
|
382349
|
+
"deprecated": "Use system space tokens from `@workday/canvas-tokens-web` instead. Check new values column for the new tokens. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
382350
|
+
"example": "```ts\n// before\nimport { space } from '@workday/canvas-kit-react/tokens';\nconst space = space.zero;\n\n// now\nimport { system } from '@workday/canvas-tokens-web';\nimport { cssVar } from '@workday/canvas-kit-styling';\nconst space = cssVar(system.space.zero);\n```"
|
|
382351
|
+
}
|
|
382323
382352
|
},
|
|
382324
382353
|
{
|
|
382325
382354
|
"kind": "property",
|
|
@@ -382404,7 +382433,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382404
382433
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382405
382434
|
}
|
|
382406
382435
|
],
|
|
382407
|
-
"tags": {
|
|
382436
|
+
"tags": {
|
|
382437
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
382438
|
+
"see": "| Old Property | Tokens for foreground (text and icons) | Tokens for border |\n|-------------------------|-------------------------------------|---------------------------------------|\n| `statusColors.active` | `system.color.fg.primary.default` | `system.color.border.primary.default` |\n| `statusColors.success` | `system.color.fg.success.default` | none |\n| `statusColors.warning` | `system.color.fg.caution.default` | `system.color.border.caution.default` |\n| `statusColors.error` | `system.color.fg.critical.default` | `system.color.border.critical.default`|"
|
|
382439
|
+
}
|
|
382408
382440
|
},
|
|
382409
382441
|
{
|
|
382410
382442
|
"kind": "property",
|
|
@@ -382421,7 +382453,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382421
382453
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382422
382454
|
}
|
|
382423
382455
|
],
|
|
382424
|
-
"tags": {
|
|
382456
|
+
"tags": {
|
|
382457
|
+
"deprecated": "Use system type tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
382458
|
+
"see": "{@link \n}\n for values mapping table",
|
|
382459
|
+
"example": "```ts\n// before\nimport { type } from '@workday/canvas-kit-react/tokens';\nconst styles = css({\n ...type.levels.body.large,\n fontWeight: type.properties.fontWeights.bold,\n color: type.variants.error,\n})\n\n// now\nimport { system } from '@workday/canvas-tokens-web';\nimport { createStyles } from '@workday/canvas-kit-styling';\nconst styles = createStyles({\n ...system.type.body.large,\n fontWeight: system.fontWeight.bold,\n color: system.color.fg.critical.default,\n})\n```"
|
|
382460
|
+
}
|
|
382425
382461
|
},
|
|
382426
382462
|
{
|
|
382427
382463
|
"kind": "property",
|
|
@@ -382574,7 +382610,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382574
382610
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382575
382611
|
}
|
|
382576
382612
|
],
|
|
382577
|
-
"tags": {
|
|
382613
|
+
"tags": {
|
|
382614
|
+
"deprecated": "Use system color tokens from `@workday/canvas-tokens-web` instead. View Docs [here](https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs).",
|
|
382615
|
+
"see": "| Old Property | Tokens for text |\n|-------------------------------------|-----------------------------------|\n| `typeColors.body` | `system.color.fg.default` |\n| `typeColors.heading` | `system.color.fg.strong` |\n| `typeColors.hint` | `system.color.fg.muted.default` |\n| `typeColors.inverse` | `system.color.fg.inverse` |\n| `typeColors.label` | `system.color.fg.default` |\n| `typeColors.link` | `system.color.fg.primary.default` |\n| `typeColors.selectHighlight` | `system.color.fg.primary.default` |\n| `typeColors.selectHighlightInverse` | `system.color.fg.inverse` |"
|
|
382616
|
+
}
|
|
382578
382617
|
}
|
|
382579
382618
|
]
|
|
382580
382619
|
}
|
|
@@ -384390,7 +384429,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
384390
384429
|
{
|
|
384391
384430
|
"name": "space",
|
|
384392
384431
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/space.ts",
|
|
384393
|
-
"description": "An object of space keys and rem values (strings)\n\nBelow is a table to show the equivalent values from `px` to `rem`.\nThis is based on the default browser font size which is `16px`.\n\n| px Value | rem Value | space token |\n| --------- | --------- | ----------- |\n| 0 | 0 | zero |\n| 4px | 0.25rem | xxxs |\n| 8px | 0.5rem | xxs |\n| 12px | 0.75rem | xs |\n| 16px | 1rem | s |\n| 24px | 1.5rem | m |\n| 32px | 2rem | l |\n| 40px | 2.5rem | xl |\n| 64px | 4rem | xxl |\n| 80px | 5rem | xxxl |",
|
|
384432
|
+
"description": "An object of space keys and rem values (strings)\n\nBelow is a table to show the equivalent values from `px` to `rem`.\nThis is based on the default browser font size which is `16px`.\n\n| px Value | rem Value | space token | new token |\n| --------- | --------- | ----------- | --------- |\n| 0 | 0 | zero | `system.space.zero` |\n| 4px | 0.25rem | xxxs | `system.space.x1` |\n| 8px | 0.5rem | xxs | `system.space.x2` |\n| 12px | 0.75rem | xs | `system.space.x3` |\n| 16px | 1rem | s | `system.space.x4` |\n| 24px | 1.5rem | m | `system.space.x6` |\n| 32px | 2rem | l | `system.space.x8` |\n| 40px | 2.5rem | xl | `system.space.x10` |\n| 64px | 4rem | xxl | `system.space.x16` |\n| 80px | 5rem | xxxl | `system.space.x20` |",
|
|
384394
384433
|
"declarations": [
|
|
384395
384434
|
{
|
|
384396
384435
|
"name": "space",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "13.
|
|
3
|
+
"version": "13.2.0-1152-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.
|
|
49
|
-
"@workday/canvas-kit-preview-react": "^13.
|
|
50
|
-
"@workday/canvas-kit-react": "^13.
|
|
51
|
-
"@workday/canvas-kit-styling": "^13.
|
|
48
|
+
"@workday/canvas-kit-labs-react": "^13.2.0-1152-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^13.2.0-1152-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^13.2.0-1152-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^13.2.0-1152-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": "e915fc5aad2b09dbb6191ccedd4a830c14b6b1bc"
|
|
65
65
|
}
|