@workday/canvas-kit-docs 14.0.0-alpha.1151-next.0 → 14.0.0-alpha.1153-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
|
@@ -395717,7 +395717,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
395717
395717
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
395718
395718
|
}
|
|
395719
395719
|
],
|
|
395720
|
-
"tags": {
|
|
395720
|
+
"tags": {
|
|
395721
|
+
"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)."
|
|
395722
|
+
}
|
|
395721
395723
|
},
|
|
395722
395724
|
{
|
|
395723
395725
|
"kind": "property",
|
|
@@ -395802,7 +395804,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
395802
395804
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
395803
395805
|
}
|
|
395804
395806
|
],
|
|
395805
|
-
"tags": {
|
|
395807
|
+
"tags": {
|
|
395808
|
+
"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)."
|
|
395809
|
+
}
|
|
395806
395810
|
},
|
|
395807
395811
|
{
|
|
395808
395812
|
"kind": "property",
|
|
@@ -397281,7 +397285,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
397281
397285
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
397282
397286
|
}
|
|
397283
397287
|
],
|
|
397284
|
-
"tags": {
|
|
397288
|
+
"tags": {
|
|
397289
|
+
"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)."
|
|
397290
|
+
}
|
|
397285
397291
|
},
|
|
397286
397292
|
{
|
|
397287
397293
|
"kind": "property",
|
|
@@ -400052,7 +400058,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400052
400058
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400053
400059
|
}
|
|
400054
400060
|
],
|
|
400055
|
-
"tags": {
|
|
400061
|
+
"tags": {
|
|
400062
|
+
"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)."
|
|
400063
|
+
}
|
|
400056
400064
|
},
|
|
400057
400065
|
{
|
|
400058
400066
|
"kind": "property",
|
|
@@ -400171,7 +400179,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400171
400179
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400172
400180
|
}
|
|
400173
400181
|
],
|
|
400174
|
-
"tags": {
|
|
400182
|
+
"tags": {
|
|
400183
|
+
"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).",
|
|
400184
|
+
"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` |"
|
|
400185
|
+
}
|
|
400175
400186
|
},
|
|
400176
400187
|
{
|
|
400177
400188
|
"kind": "property",
|
|
@@ -400188,7 +400199,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400188
400199
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400189
400200
|
}
|
|
400190
400201
|
],
|
|
400191
|
-
"tags": {
|
|
400202
|
+
"tags": {
|
|
400203
|
+
"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).",
|
|
400204
|
+
"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]}` |"
|
|
400205
|
+
}
|
|
400192
400206
|
},
|
|
400193
400207
|
{
|
|
400194
400208
|
"kind": "property",
|
|
@@ -400204,7 +400218,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400204
400218
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400205
400219
|
}
|
|
400206
400220
|
],
|
|
400207
|
-
"tags": {
|
|
400221
|
+
"tags": {
|
|
400222
|
+
"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)."
|
|
400223
|
+
}
|
|
400208
400224
|
},
|
|
400209
400225
|
{
|
|
400210
400226
|
"kind": "property",
|
|
@@ -400629,7 +400645,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400629
400645
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400630
400646
|
}
|
|
400631
400647
|
],
|
|
400632
|
-
"tags": {
|
|
400648
|
+
"tags": {
|
|
400649
|
+
"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)."
|
|
400650
|
+
}
|
|
400633
400651
|
},
|
|
400634
400652
|
{
|
|
400635
400653
|
"kind": "property",
|
|
@@ -400731,7 +400749,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400731
400749
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400732
400750
|
}
|
|
400733
400751
|
],
|
|
400734
|
-
"tags": {
|
|
400752
|
+
"tags": {
|
|
400753
|
+
"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).",
|
|
400754
|
+
"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` |"
|
|
400755
|
+
}
|
|
400735
400756
|
},
|
|
400736
400757
|
{
|
|
400737
400758
|
"kind": "property",
|
|
@@ -401125,7 +401146,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401125
401146
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401126
401147
|
}
|
|
401127
401148
|
],
|
|
401128
|
-
"tags": {
|
|
401149
|
+
"tags": {
|
|
401150
|
+
"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).",
|
|
401151
|
+
"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` |"
|
|
401152
|
+
}
|
|
401129
401153
|
},
|
|
401130
401154
|
{
|
|
401131
401155
|
"kind": "property",
|
|
@@ -401141,7 +401165,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401141
401165
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401142
401166
|
}
|
|
401143
401167
|
],
|
|
401144
|
-
"tags": {
|
|
401168
|
+
"tags": {
|
|
401169
|
+
"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)."
|
|
401170
|
+
}
|
|
401145
401171
|
},
|
|
401146
401172
|
{
|
|
401147
401173
|
"kind": "property",
|
|
@@ -401158,7 +401184,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401158
401184
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401159
401185
|
}
|
|
401160
401186
|
],
|
|
401161
|
-
"tags": {
|
|
401187
|
+
"tags": {
|
|
401188
|
+
"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).",
|
|
401189
|
+
"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```"
|
|
401190
|
+
}
|
|
401162
401191
|
},
|
|
401163
401192
|
{
|
|
401164
401193
|
"kind": "property",
|
|
@@ -401243,7 +401272,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401243
401272
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401244
401273
|
}
|
|
401245
401274
|
],
|
|
401246
|
-
"tags": {
|
|
401275
|
+
"tags": {
|
|
401276
|
+
"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).",
|
|
401277
|
+
"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`|"
|
|
401278
|
+
}
|
|
401247
401279
|
},
|
|
401248
401280
|
{
|
|
401249
401281
|
"kind": "property",
|
|
@@ -401260,7 +401292,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401260
401292
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401261
401293
|
}
|
|
401262
401294
|
],
|
|
401263
|
-
"tags": {
|
|
401295
|
+
"tags": {
|
|
401296
|
+
"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).",
|
|
401297
|
+
"see": "{@link \n}\n for values mapping table",
|
|
401298
|
+
"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```"
|
|
401299
|
+
}
|
|
401264
401300
|
},
|
|
401265
401301
|
{
|
|
401266
401302
|
"kind": "property",
|
|
@@ -401413,7 +401449,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401413
401449
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401414
401450
|
}
|
|
401415
401451
|
],
|
|
401416
|
-
"tags": {
|
|
401452
|
+
"tags": {
|
|
401453
|
+
"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).",
|
|
401454
|
+
"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` |"
|
|
401455
|
+
}
|
|
401417
401456
|
}
|
|
401418
401457
|
]
|
|
401419
401458
|
}
|
|
@@ -403229,7 +403268,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
403229
403268
|
{
|
|
403230
403269
|
"name": "space",
|
|
403231
403270
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/space.ts",
|
|
403232
|
-
"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 |",
|
|
403271
|
+
"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` |",
|
|
403233
403272
|
"declarations": [
|
|
403234
403273
|
{
|
|
403235
403274
|
"name": "space",
|
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.1153-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.1153-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^14.0.0-alpha.1153-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^14.0.0-alpha.1153-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^14.0.0-alpha.1153-next.0",
|
|
52
52
|
"@workday/canvas-system-icons-web": "^3.0.0",
|
|
53
53
|
"@workday/canvas-tokens-web": "3.0.0-alpha.5",
|
|
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": "99af78970bf60236bf766f829a651499297a0b64"
|
|
65
65
|
}
|