@workday/canvas-kit-docs 14.0.0-alpha.1151-next.0 → 14.0.0-alpha.1156-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
CHANGED
|
@@ -357272,6 +357272,186 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
357272
357272
|
]
|
|
357273
357273
|
}
|
|
357274
357274
|
},
|
|
357275
|
+
{
|
|
357276
|
+
"name": "useTabOverflowScroll",
|
|
357277
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
357278
|
+
"description": "",
|
|
357279
|
+
"declarations": [
|
|
357280
|
+
{
|
|
357281
|
+
"name": "useTabOverflowScroll",
|
|
357282
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
357283
|
+
}
|
|
357284
|
+
],
|
|
357285
|
+
"tags": {},
|
|
357286
|
+
"type": {
|
|
357287
|
+
"kind": "function",
|
|
357288
|
+
"name": {
|
|
357289
|
+
"kind": "symbol",
|
|
357290
|
+
"name": "createElemPropsHook"
|
|
357291
|
+
},
|
|
357292
|
+
"parameters": [
|
|
357293
|
+
{
|
|
357294
|
+
"kind": "parameter",
|
|
357295
|
+
"name": "model",
|
|
357296
|
+
"description": "",
|
|
357297
|
+
"tags": {},
|
|
357298
|
+
"declarations": [],
|
|
357299
|
+
"type": {
|
|
357300
|
+
"kind": "symbol",
|
|
357301
|
+
"name": "TabsModel"
|
|
357302
|
+
},
|
|
357303
|
+
"required": true
|
|
357304
|
+
},
|
|
357305
|
+
{
|
|
357306
|
+
"kind": "parameter",
|
|
357307
|
+
"name": "elemProps",
|
|
357308
|
+
"description": "",
|
|
357309
|
+
"tags": {},
|
|
357310
|
+
"declarations": [],
|
|
357311
|
+
"type": {
|
|
357312
|
+
"kind": "object",
|
|
357313
|
+
"properties": [
|
|
357314
|
+
{
|
|
357315
|
+
"kind": "property",
|
|
357316
|
+
"name": "aria-orientation",
|
|
357317
|
+
"required": false,
|
|
357318
|
+
"type": {
|
|
357319
|
+
"kind": "union",
|
|
357320
|
+
"value": [
|
|
357321
|
+
{
|
|
357322
|
+
"kind": "string",
|
|
357323
|
+
"value": "vertical"
|
|
357324
|
+
},
|
|
357325
|
+
{
|
|
357326
|
+
"kind": "string",
|
|
357327
|
+
"value": "horizontal"
|
|
357328
|
+
}
|
|
357329
|
+
]
|
|
357330
|
+
},
|
|
357331
|
+
"description": "",
|
|
357332
|
+
"declarations": [
|
|
357333
|
+
{
|
|
357334
|
+
"name": "aria-orientation",
|
|
357335
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
357336
|
+
}
|
|
357337
|
+
],
|
|
357338
|
+
"tags": {}
|
|
357339
|
+
}
|
|
357340
|
+
]
|
|
357341
|
+
},
|
|
357342
|
+
"required": false
|
|
357343
|
+
},
|
|
357344
|
+
{
|
|
357345
|
+
"kind": "parameter",
|
|
357346
|
+
"name": "ref",
|
|
357347
|
+
"description": "",
|
|
357348
|
+
"tags": {},
|
|
357349
|
+
"declarations": [],
|
|
357350
|
+
"type": {
|
|
357351
|
+
"kind": "external",
|
|
357352
|
+
"name": "React.Ref",
|
|
357353
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html"
|
|
357354
|
+
},
|
|
357355
|
+
"required": false
|
|
357356
|
+
}
|
|
357357
|
+
],
|
|
357358
|
+
"returnType": {
|
|
357359
|
+
"kind": "object",
|
|
357360
|
+
"properties": [
|
|
357361
|
+
{
|
|
357362
|
+
"kind": "property",
|
|
357363
|
+
"name": "ref",
|
|
357364
|
+
"required": true,
|
|
357365
|
+
"type": {
|
|
357366
|
+
"kind": "function",
|
|
357367
|
+
"parameters": [
|
|
357368
|
+
{
|
|
357369
|
+
"kind": "parameter",
|
|
357370
|
+
"name": "instance",
|
|
357371
|
+
"type": {
|
|
357372
|
+
"kind": "union",
|
|
357373
|
+
"value": [
|
|
357374
|
+
{
|
|
357375
|
+
"kind": "symbol",
|
|
357376
|
+
"name": "T",
|
|
357377
|
+
"value": "T"
|
|
357378
|
+
},
|
|
357379
|
+
{
|
|
357380
|
+
"kind": "primitive",
|
|
357381
|
+
"value": "null"
|
|
357382
|
+
}
|
|
357383
|
+
]
|
|
357384
|
+
},
|
|
357385
|
+
"required": true,
|
|
357386
|
+
"rest": false,
|
|
357387
|
+
"description": "",
|
|
357388
|
+
"declarations": [
|
|
357389
|
+
{
|
|
357390
|
+
"name": "instance",
|
|
357391
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/node_modules/@types/react/ts5.0/index.d.ts"
|
|
357392
|
+
}
|
|
357393
|
+
],
|
|
357394
|
+
"tags": {}
|
|
357395
|
+
}
|
|
357396
|
+
],
|
|
357397
|
+
"members": [],
|
|
357398
|
+
"returnType": {
|
|
357399
|
+
"kind": "primitive",
|
|
357400
|
+
"value": "void"
|
|
357401
|
+
}
|
|
357402
|
+
},
|
|
357403
|
+
"description": "",
|
|
357404
|
+
"tags": {},
|
|
357405
|
+
"declarations": []
|
|
357406
|
+
},
|
|
357407
|
+
{
|
|
357408
|
+
"kind": "property",
|
|
357409
|
+
"name": "onScroll",
|
|
357410
|
+
"required": true,
|
|
357411
|
+
"type": {
|
|
357412
|
+
"kind": "function",
|
|
357413
|
+
"parameters": [
|
|
357414
|
+
{
|
|
357415
|
+
"kind": "parameter",
|
|
357416
|
+
"name": "event",
|
|
357417
|
+
"type": {
|
|
357418
|
+
"kind": "symbol",
|
|
357419
|
+
"name": "React.UIEvent",
|
|
357420
|
+
"typeParameters": [
|
|
357421
|
+
{
|
|
357422
|
+
"kind": "symbol",
|
|
357423
|
+
"name": "HTMLDivElement",
|
|
357424
|
+
"value": "HTMLDivElement"
|
|
357425
|
+
}
|
|
357426
|
+
],
|
|
357427
|
+
"value": "UIEvent<T, E>"
|
|
357428
|
+
},
|
|
357429
|
+
"required": true,
|
|
357430
|
+
"rest": false,
|
|
357431
|
+
"description": "",
|
|
357432
|
+
"declarations": [
|
|
357433
|
+
{
|
|
357434
|
+
"name": "event",
|
|
357435
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
357436
|
+
}
|
|
357437
|
+
],
|
|
357438
|
+
"tags": {}
|
|
357439
|
+
}
|
|
357440
|
+
],
|
|
357441
|
+
"members": [],
|
|
357442
|
+
"returnType": {
|
|
357443
|
+
"kind": "primitive",
|
|
357444
|
+
"value": "void"
|
|
357445
|
+
}
|
|
357446
|
+
},
|
|
357447
|
+
"description": "",
|
|
357448
|
+
"tags": {},
|
|
357449
|
+
"declarations": []
|
|
357450
|
+
}
|
|
357451
|
+
]
|
|
357452
|
+
}
|
|
357453
|
+
}
|
|
357454
|
+
},
|
|
357275
357455
|
{
|
|
357276
357456
|
"name": "useTabsList",
|
|
357277
357457
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
@@ -357290,6 +357470,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
357290
357470
|
"name": "composeHooks"
|
|
357291
357471
|
},
|
|
357292
357472
|
"parameters": [
|
|
357473
|
+
{
|
|
357474
|
+
"kind": "symbol",
|
|
357475
|
+
"name": "useTabOverflowScroll",
|
|
357476
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
357477
|
+
"value": "useTabOverflowScroll"
|
|
357478
|
+
},
|
|
357293
357479
|
{
|
|
357294
357480
|
"kind": "function",
|
|
357295
357481
|
"name": {
|
|
@@ -357352,20 +357538,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
357352
357538
|
},
|
|
357353
357539
|
{
|
|
357354
357540
|
"kind": "property",
|
|
357355
|
-
"name": "
|
|
357541
|
+
"name": "aria-orientation",
|
|
357356
357542
|
"required": true,
|
|
357357
357543
|
"type": {
|
|
357358
|
-
"kind": "
|
|
357359
|
-
"
|
|
357360
|
-
|
|
357361
|
-
"kind": "string",
|
|
357362
|
-
"value": "auto"
|
|
357363
|
-
},
|
|
357364
|
-
{
|
|
357365
|
-
"kind": "primitive",
|
|
357366
|
-
"value": "undefined"
|
|
357367
|
-
}
|
|
357368
|
-
]
|
|
357544
|
+
"kind": "symbol",
|
|
357545
|
+
"name": "Orientation",
|
|
357546
|
+
"value": "any"
|
|
357369
357547
|
},
|
|
357370
357548
|
"description": "",
|
|
357371
357549
|
"tags": {},
|
|
@@ -358310,85 +358488,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
358310
358488
|
"model": "TabsModel"
|
|
358311
358489
|
}
|
|
358312
358490
|
},
|
|
358313
|
-
{
|
|
358314
|
-
"name": "useTouchDirection",
|
|
358315
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
358316
|
-
"description": "",
|
|
358317
|
-
"declarations": [
|
|
358318
|
-
{
|
|
358319
|
-
"name": "useTouchDirection",
|
|
358320
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
358321
|
-
}
|
|
358322
|
-
],
|
|
358323
|
-
"tags": {},
|
|
358324
|
-
"type": {
|
|
358325
|
-
"kind": "function",
|
|
358326
|
-
"parameters": [],
|
|
358327
|
-
"members": [],
|
|
358328
|
-
"returnType": {
|
|
358329
|
-
"kind": "object",
|
|
358330
|
-
"properties": [
|
|
358331
|
-
{
|
|
358332
|
-
"kind": "property",
|
|
358333
|
-
"name": "direction",
|
|
358334
|
-
"defaultValue": {
|
|
358335
|
-
"kind": "unknown",
|
|
358336
|
-
"value": "unknown",
|
|
358337
|
-
"text": "touchDir"
|
|
358338
|
-
},
|
|
358339
|
-
"type": {
|
|
358340
|
-
"kind": "union",
|
|
358341
|
-
"value": [
|
|
358342
|
-
{
|
|
358343
|
-
"kind": "string",
|
|
358344
|
-
"value": "left"
|
|
358345
|
-
},
|
|
358346
|
-
{
|
|
358347
|
-
"kind": "string",
|
|
358348
|
-
"value": "right"
|
|
358349
|
-
},
|
|
358350
|
-
{
|
|
358351
|
-
"kind": "primitive",
|
|
358352
|
-
"value": "undefined"
|
|
358353
|
-
}
|
|
358354
|
-
]
|
|
358355
|
-
},
|
|
358356
|
-
"required": false,
|
|
358357
|
-
"description": "",
|
|
358358
|
-
"declarations": [
|
|
358359
|
-
{
|
|
358360
|
-
"name": "direction",
|
|
358361
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
358362
|
-
}
|
|
358363
|
-
],
|
|
358364
|
-
"tags": {}
|
|
358365
|
-
},
|
|
358366
|
-
{
|
|
358367
|
-
"kind": "property",
|
|
358368
|
-
"name": "isDragging",
|
|
358369
|
-
"defaultValue": {
|
|
358370
|
-
"kind": "unknown",
|
|
358371
|
-
"value": "unknown",
|
|
358372
|
-
"text": "isDragging"
|
|
358373
|
-
},
|
|
358374
|
-
"type": {
|
|
358375
|
-
"kind": "primitive",
|
|
358376
|
-
"value": "boolean"
|
|
358377
|
-
},
|
|
358378
|
-
"required": true,
|
|
358379
|
-
"description": "",
|
|
358380
|
-
"declarations": [
|
|
358381
|
-
{
|
|
358382
|
-
"name": "isDragging",
|
|
358383
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
358384
|
-
}
|
|
358385
|
-
],
|
|
358386
|
-
"tags": {}
|
|
358387
|
-
}
|
|
358388
|
-
]
|
|
358389
|
-
}
|
|
358390
|
-
}
|
|
358391
|
-
},
|
|
358392
358491
|
{
|
|
358393
358492
|
"name": "MenuPopperProps",
|
|
358394
358493
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsMenuPopper.tsx",
|
|
@@ -395717,7 +395816,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
395717
395816
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
395718
395817
|
}
|
|
395719
395818
|
],
|
|
395720
|
-
"tags": {
|
|
395819
|
+
"tags": {
|
|
395820
|
+
"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)."
|
|
395821
|
+
}
|
|
395721
395822
|
},
|
|
395722
395823
|
{
|
|
395723
395824
|
"kind": "property",
|
|
@@ -395802,7 +395903,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
395802
395903
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
395803
395904
|
}
|
|
395804
395905
|
],
|
|
395805
|
-
"tags": {
|
|
395906
|
+
"tags": {
|
|
395907
|
+
"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)."
|
|
395908
|
+
}
|
|
395806
395909
|
},
|
|
395807
395910
|
{
|
|
395808
395911
|
"kind": "property",
|
|
@@ -397281,7 +397384,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
397281
397384
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
397282
397385
|
}
|
|
397283
397386
|
],
|
|
397284
|
-
"tags": {
|
|
397387
|
+
"tags": {
|
|
397388
|
+
"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)."
|
|
397389
|
+
}
|
|
397285
397390
|
},
|
|
397286
397391
|
{
|
|
397287
397392
|
"kind": "property",
|
|
@@ -400052,7 +400157,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400052
400157
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400053
400158
|
}
|
|
400054
400159
|
],
|
|
400055
|
-
"tags": {
|
|
400160
|
+
"tags": {
|
|
400161
|
+
"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)."
|
|
400162
|
+
}
|
|
400056
400163
|
},
|
|
400057
400164
|
{
|
|
400058
400165
|
"kind": "property",
|
|
@@ -400171,7 +400278,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400171
400278
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400172
400279
|
}
|
|
400173
400280
|
],
|
|
400174
|
-
"tags": {
|
|
400281
|
+
"tags": {
|
|
400282
|
+
"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).",
|
|
400283
|
+
"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` |"
|
|
400284
|
+
}
|
|
400175
400285
|
},
|
|
400176
400286
|
{
|
|
400177
400287
|
"kind": "property",
|
|
@@ -400188,7 +400298,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400188
400298
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400189
400299
|
}
|
|
400190
400300
|
],
|
|
400191
|
-
"tags": {
|
|
400301
|
+
"tags": {
|
|
400302
|
+
"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).",
|
|
400303
|
+
"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]}` |"
|
|
400304
|
+
}
|
|
400192
400305
|
},
|
|
400193
400306
|
{
|
|
400194
400307
|
"kind": "property",
|
|
@@ -400204,7 +400317,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400204
400317
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400205
400318
|
}
|
|
400206
400319
|
],
|
|
400207
|
-
"tags": {
|
|
400320
|
+
"tags": {
|
|
400321
|
+
"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)."
|
|
400322
|
+
}
|
|
400208
400323
|
},
|
|
400209
400324
|
{
|
|
400210
400325
|
"kind": "property",
|
|
@@ -400629,7 +400744,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400629
400744
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400630
400745
|
}
|
|
400631
400746
|
],
|
|
400632
|
-
"tags": {
|
|
400747
|
+
"tags": {
|
|
400748
|
+
"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)."
|
|
400749
|
+
}
|
|
400633
400750
|
},
|
|
400634
400751
|
{
|
|
400635
400752
|
"kind": "property",
|
|
@@ -400731,7 +400848,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
400731
400848
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
400732
400849
|
}
|
|
400733
400850
|
],
|
|
400734
|
-
"tags": {
|
|
400851
|
+
"tags": {
|
|
400852
|
+
"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).",
|
|
400853
|
+
"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` |"
|
|
400854
|
+
}
|
|
400735
400855
|
},
|
|
400736
400856
|
{
|
|
400737
400857
|
"kind": "property",
|
|
@@ -401125,7 +401245,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401125
401245
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401126
401246
|
}
|
|
401127
401247
|
],
|
|
401128
|
-
"tags": {
|
|
401248
|
+
"tags": {
|
|
401249
|
+
"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).",
|
|
401250
|
+
"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` |"
|
|
401251
|
+
}
|
|
401129
401252
|
},
|
|
401130
401253
|
{
|
|
401131
401254
|
"kind": "property",
|
|
@@ -401141,7 +401264,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401141
401264
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401142
401265
|
}
|
|
401143
401266
|
],
|
|
401144
|
-
"tags": {
|
|
401267
|
+
"tags": {
|
|
401268
|
+
"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)."
|
|
401269
|
+
}
|
|
401145
401270
|
},
|
|
401146
401271
|
{
|
|
401147
401272
|
"kind": "property",
|
|
@@ -401158,7 +401283,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401158
401283
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401159
401284
|
}
|
|
401160
401285
|
],
|
|
401161
|
-
"tags": {
|
|
401286
|
+
"tags": {
|
|
401287
|
+
"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).",
|
|
401288
|
+
"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```"
|
|
401289
|
+
}
|
|
401162
401290
|
},
|
|
401163
401291
|
{
|
|
401164
401292
|
"kind": "property",
|
|
@@ -401243,7 +401371,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401243
401371
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401244
401372
|
}
|
|
401245
401373
|
],
|
|
401246
|
-
"tags": {
|
|
401374
|
+
"tags": {
|
|
401375
|
+
"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).",
|
|
401376
|
+
"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`|"
|
|
401377
|
+
}
|
|
401247
401378
|
},
|
|
401248
401379
|
{
|
|
401249
401380
|
"kind": "property",
|
|
@@ -401260,7 +401391,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401260
401391
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401261
401392
|
}
|
|
401262
401393
|
],
|
|
401263
|
-
"tags": {
|
|
401394
|
+
"tags": {
|
|
401395
|
+
"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).",
|
|
401396
|
+
"see": "{@link \n}\n for values mapping table",
|
|
401397
|
+
"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```"
|
|
401398
|
+
}
|
|
401264
401399
|
},
|
|
401265
401400
|
{
|
|
401266
401401
|
"kind": "property",
|
|
@@ -401413,7 +401548,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
401413
401548
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
401414
401549
|
}
|
|
401415
401550
|
],
|
|
401416
|
-
"tags": {
|
|
401551
|
+
"tags": {
|
|
401552
|
+
"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).",
|
|
401553
|
+
"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` |"
|
|
401554
|
+
}
|
|
401417
401555
|
}
|
|
401418
401556
|
]
|
|
401419
401557
|
}
|
|
@@ -403229,7 +403367,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
403229
403367
|
{
|
|
403230
403368
|
"name": "space",
|
|
403231
403369
|
"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 |",
|
|
403370
|
+
"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
403371
|
"declarations": [
|
|
403234
403372
|
{
|
|
403235
403373
|
"name": "space",
|
|
@@ -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.1.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.1.
|
|
23
|
-
"@workday/canvas-kit-react": "13.1.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.1.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.1.
|
|
21
|
+
"@workday/canvas-kit-labs-react": "13.1.6",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.1.6",
|
|
23
|
+
"@workday/canvas-kit-react": "13.1.6",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.1.6",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.1.6",
|
|
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.1.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.1.
|
|
23
|
-
"@workday/canvas-kit-react": "13.1.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.1.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.1.
|
|
21
|
+
"@workday/canvas-kit-labs-react": "13.1.6",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.1.6",
|
|
23
|
+
"@workday/canvas-kit-react": "13.1.6",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.1.6",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.1.6",
|
|
26
26
|
"@workday/canvas-system-icons-web": "3.0.22",
|
|
27
27
|
"@workday/canvas-tokens-web": "2.0.0"
|
|
28
28
|
},
|
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.1156-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.1156-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^14.0.0-alpha.1156-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^14.0.0-alpha.1156-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^14.0.0-alpha.1156-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": "e5711be8fa7794a67a880925c1b582a1abbcfbf6"
|
|
65
65
|
}
|