@workday/canvas-kit-docs 13.1.6 → 13.2.0-1154-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
|
@@ -338465,186 +338465,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
338465
338465
|
]
|
|
338466
338466
|
}
|
|
338467
338467
|
},
|
|
338468
|
-
{
|
|
338469
|
-
"name": "useTabOverflowScroll",
|
|
338470
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
338471
|
-
"description": "",
|
|
338472
|
-
"declarations": [
|
|
338473
|
-
{
|
|
338474
|
-
"name": "useTabOverflowScroll",
|
|
338475
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
338476
|
-
}
|
|
338477
|
-
],
|
|
338478
|
-
"tags": {},
|
|
338479
|
-
"type": {
|
|
338480
|
-
"kind": "function",
|
|
338481
|
-
"name": {
|
|
338482
|
-
"kind": "symbol",
|
|
338483
|
-
"name": "createElemPropsHook"
|
|
338484
|
-
},
|
|
338485
|
-
"parameters": [
|
|
338486
|
-
{
|
|
338487
|
-
"kind": "parameter",
|
|
338488
|
-
"name": "model",
|
|
338489
|
-
"description": "",
|
|
338490
|
-
"tags": {},
|
|
338491
|
-
"declarations": [],
|
|
338492
|
-
"type": {
|
|
338493
|
-
"kind": "symbol",
|
|
338494
|
-
"name": "TabsModel"
|
|
338495
|
-
},
|
|
338496
|
-
"required": true
|
|
338497
|
-
},
|
|
338498
|
-
{
|
|
338499
|
-
"kind": "parameter",
|
|
338500
|
-
"name": "elemProps",
|
|
338501
|
-
"description": "",
|
|
338502
|
-
"tags": {},
|
|
338503
|
-
"declarations": [],
|
|
338504
|
-
"type": {
|
|
338505
|
-
"kind": "object",
|
|
338506
|
-
"properties": [
|
|
338507
|
-
{
|
|
338508
|
-
"kind": "property",
|
|
338509
|
-
"name": "aria-orientation",
|
|
338510
|
-
"required": false,
|
|
338511
|
-
"type": {
|
|
338512
|
-
"kind": "union",
|
|
338513
|
-
"value": [
|
|
338514
|
-
{
|
|
338515
|
-
"kind": "string",
|
|
338516
|
-
"value": "vertical"
|
|
338517
|
-
},
|
|
338518
|
-
{
|
|
338519
|
-
"kind": "string",
|
|
338520
|
-
"value": "horizontal"
|
|
338521
|
-
}
|
|
338522
|
-
]
|
|
338523
|
-
},
|
|
338524
|
-
"description": "",
|
|
338525
|
-
"declarations": [
|
|
338526
|
-
{
|
|
338527
|
-
"name": "aria-orientation",
|
|
338528
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
338529
|
-
}
|
|
338530
|
-
],
|
|
338531
|
-
"tags": {}
|
|
338532
|
-
}
|
|
338533
|
-
]
|
|
338534
|
-
},
|
|
338535
|
-
"required": false
|
|
338536
|
-
},
|
|
338537
|
-
{
|
|
338538
|
-
"kind": "parameter",
|
|
338539
|
-
"name": "ref",
|
|
338540
|
-
"description": "",
|
|
338541
|
-
"tags": {},
|
|
338542
|
-
"declarations": [],
|
|
338543
|
-
"type": {
|
|
338544
|
-
"kind": "external",
|
|
338545
|
-
"name": "React.Ref",
|
|
338546
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html"
|
|
338547
|
-
},
|
|
338548
|
-
"required": false
|
|
338549
|
-
}
|
|
338550
|
-
],
|
|
338551
|
-
"returnType": {
|
|
338552
|
-
"kind": "object",
|
|
338553
|
-
"properties": [
|
|
338554
|
-
{
|
|
338555
|
-
"kind": "property",
|
|
338556
|
-
"name": "ref",
|
|
338557
|
-
"required": true,
|
|
338558
|
-
"type": {
|
|
338559
|
-
"kind": "function",
|
|
338560
|
-
"parameters": [
|
|
338561
|
-
{
|
|
338562
|
-
"kind": "parameter",
|
|
338563
|
-
"name": "instance",
|
|
338564
|
-
"type": {
|
|
338565
|
-
"kind": "union",
|
|
338566
|
-
"value": [
|
|
338567
|
-
{
|
|
338568
|
-
"kind": "symbol",
|
|
338569
|
-
"name": "T",
|
|
338570
|
-
"value": "T"
|
|
338571
|
-
},
|
|
338572
|
-
{
|
|
338573
|
-
"kind": "primitive",
|
|
338574
|
-
"value": "null"
|
|
338575
|
-
}
|
|
338576
|
-
]
|
|
338577
|
-
},
|
|
338578
|
-
"required": true,
|
|
338579
|
-
"rest": false,
|
|
338580
|
-
"description": "",
|
|
338581
|
-
"declarations": [
|
|
338582
|
-
{
|
|
338583
|
-
"name": "instance",
|
|
338584
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/node_modules/@types/react/ts5.0/index.d.ts"
|
|
338585
|
-
}
|
|
338586
|
-
],
|
|
338587
|
-
"tags": {}
|
|
338588
|
-
}
|
|
338589
|
-
],
|
|
338590
|
-
"members": [],
|
|
338591
|
-
"returnType": {
|
|
338592
|
-
"kind": "primitive",
|
|
338593
|
-
"value": "void"
|
|
338594
|
-
}
|
|
338595
|
-
},
|
|
338596
|
-
"description": "",
|
|
338597
|
-
"tags": {},
|
|
338598
|
-
"declarations": []
|
|
338599
|
-
},
|
|
338600
|
-
{
|
|
338601
|
-
"kind": "property",
|
|
338602
|
-
"name": "onScroll",
|
|
338603
|
-
"required": true,
|
|
338604
|
-
"type": {
|
|
338605
|
-
"kind": "function",
|
|
338606
|
-
"parameters": [
|
|
338607
|
-
{
|
|
338608
|
-
"kind": "parameter",
|
|
338609
|
-
"name": "event",
|
|
338610
|
-
"type": {
|
|
338611
|
-
"kind": "symbol",
|
|
338612
|
-
"name": "React.UIEvent",
|
|
338613
|
-
"typeParameters": [
|
|
338614
|
-
{
|
|
338615
|
-
"kind": "symbol",
|
|
338616
|
-
"name": "HTMLDivElement",
|
|
338617
|
-
"value": "HTMLDivElement"
|
|
338618
|
-
}
|
|
338619
|
-
],
|
|
338620
|
-
"value": "UIEvent<T, E>"
|
|
338621
|
-
},
|
|
338622
|
-
"required": true,
|
|
338623
|
-
"rest": false,
|
|
338624
|
-
"description": "",
|
|
338625
|
-
"declarations": [
|
|
338626
|
-
{
|
|
338627
|
-
"name": "event",
|
|
338628
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
338629
|
-
}
|
|
338630
|
-
],
|
|
338631
|
-
"tags": {}
|
|
338632
|
-
}
|
|
338633
|
-
],
|
|
338634
|
-
"members": [],
|
|
338635
|
-
"returnType": {
|
|
338636
|
-
"kind": "primitive",
|
|
338637
|
-
"value": "void"
|
|
338638
|
-
}
|
|
338639
|
-
},
|
|
338640
|
-
"description": "",
|
|
338641
|
-
"tags": {},
|
|
338642
|
-
"declarations": []
|
|
338643
|
-
}
|
|
338644
|
-
]
|
|
338645
|
-
}
|
|
338646
|
-
}
|
|
338647
|
-
},
|
|
338648
338468
|
{
|
|
338649
338469
|
"name": "useTabsList",
|
|
338650
338470
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
@@ -338663,12 +338483,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
338663
338483
|
"name": "composeHooks"
|
|
338664
338484
|
},
|
|
338665
338485
|
"parameters": [
|
|
338666
|
-
{
|
|
338667
|
-
"kind": "symbol",
|
|
338668
|
-
"name": "useTabOverflowScroll",
|
|
338669
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
338670
|
-
"value": "useTabOverflowScroll"
|
|
338671
|
-
},
|
|
338672
338486
|
{
|
|
338673
338487
|
"kind": "function",
|
|
338674
338488
|
"name": {
|
|
@@ -338731,12 +338545,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
338731
338545
|
},
|
|
338732
338546
|
{
|
|
338733
338547
|
"kind": "property",
|
|
338734
|
-
"name": "
|
|
338548
|
+
"name": "overflowX",
|
|
338735
338549
|
"required": true,
|
|
338736
338550
|
"type": {
|
|
338737
|
-
"kind": "
|
|
338738
|
-
"
|
|
338739
|
-
|
|
338551
|
+
"kind": "union",
|
|
338552
|
+
"value": [
|
|
338553
|
+
{
|
|
338554
|
+
"kind": "string",
|
|
338555
|
+
"value": "auto"
|
|
338556
|
+
},
|
|
338557
|
+
{
|
|
338558
|
+
"kind": "primitive",
|
|
338559
|
+
"value": "undefined"
|
|
338560
|
+
}
|
|
338561
|
+
]
|
|
338740
338562
|
},
|
|
338741
338563
|
"description": "",
|
|
338742
338564
|
"tags": {},
|
|
@@ -339681,6 +339503,85 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
339681
339503
|
"model": "TabsModel"
|
|
339682
339504
|
}
|
|
339683
339505
|
},
|
|
339506
|
+
{
|
|
339507
|
+
"name": "useTouchDirection",
|
|
339508
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx",
|
|
339509
|
+
"description": "",
|
|
339510
|
+
"declarations": [
|
|
339511
|
+
{
|
|
339512
|
+
"name": "useTouchDirection",
|
|
339513
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
339514
|
+
}
|
|
339515
|
+
],
|
|
339516
|
+
"tags": {},
|
|
339517
|
+
"type": {
|
|
339518
|
+
"kind": "function",
|
|
339519
|
+
"parameters": [],
|
|
339520
|
+
"members": [],
|
|
339521
|
+
"returnType": {
|
|
339522
|
+
"kind": "object",
|
|
339523
|
+
"properties": [
|
|
339524
|
+
{
|
|
339525
|
+
"kind": "property",
|
|
339526
|
+
"name": "direction",
|
|
339527
|
+
"defaultValue": {
|
|
339528
|
+
"kind": "unknown",
|
|
339529
|
+
"value": "unknown",
|
|
339530
|
+
"text": "touchDir"
|
|
339531
|
+
},
|
|
339532
|
+
"type": {
|
|
339533
|
+
"kind": "union",
|
|
339534
|
+
"value": [
|
|
339535
|
+
{
|
|
339536
|
+
"kind": "string",
|
|
339537
|
+
"value": "left"
|
|
339538
|
+
},
|
|
339539
|
+
{
|
|
339540
|
+
"kind": "string",
|
|
339541
|
+
"value": "right"
|
|
339542
|
+
},
|
|
339543
|
+
{
|
|
339544
|
+
"kind": "primitive",
|
|
339545
|
+
"value": "undefined"
|
|
339546
|
+
}
|
|
339547
|
+
]
|
|
339548
|
+
},
|
|
339549
|
+
"required": false,
|
|
339550
|
+
"description": "",
|
|
339551
|
+
"declarations": [
|
|
339552
|
+
{
|
|
339553
|
+
"name": "direction",
|
|
339554
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
339555
|
+
}
|
|
339556
|
+
],
|
|
339557
|
+
"tags": {}
|
|
339558
|
+
},
|
|
339559
|
+
{
|
|
339560
|
+
"kind": "property",
|
|
339561
|
+
"name": "isDragging",
|
|
339562
|
+
"defaultValue": {
|
|
339563
|
+
"kind": "unknown",
|
|
339564
|
+
"value": "unknown",
|
|
339565
|
+
"text": "isDragging"
|
|
339566
|
+
},
|
|
339567
|
+
"type": {
|
|
339568
|
+
"kind": "primitive",
|
|
339569
|
+
"value": "boolean"
|
|
339570
|
+
},
|
|
339571
|
+
"required": true,
|
|
339572
|
+
"description": "",
|
|
339573
|
+
"declarations": [
|
|
339574
|
+
{
|
|
339575
|
+
"name": "isDragging",
|
|
339576
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsList.tsx"
|
|
339577
|
+
}
|
|
339578
|
+
],
|
|
339579
|
+
"tags": {}
|
|
339580
|
+
}
|
|
339581
|
+
]
|
|
339582
|
+
}
|
|
339583
|
+
}
|
|
339584
|
+
},
|
|
339684
339585
|
{
|
|
339685
339586
|
"name": "MenuPopperProps",
|
|
339686
339587
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tabs/lib/TabsMenuPopper.tsx",
|
|
@@ -376977,7 +376878,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
376977
376878
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
376978
376879
|
}
|
|
376979
376880
|
],
|
|
376980
|
-
"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
|
+
}
|
|
376981
376884
|
},
|
|
376982
376885
|
{
|
|
376983
376886
|
"kind": "property",
|
|
@@ -377062,7 +376965,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
377062
376965
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
377063
376966
|
}
|
|
377064
376967
|
],
|
|
377065
|
-
"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
|
+
}
|
|
377066
376971
|
},
|
|
377067
376972
|
{
|
|
377068
376973
|
"kind": "property",
|
|
@@ -378541,7 +378446,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
378541
378446
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
378542
378447
|
}
|
|
378543
378448
|
],
|
|
378544
|
-
"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
|
+
}
|
|
378545
378452
|
},
|
|
378546
378453
|
{
|
|
378547
378454
|
"kind": "property",
|
|
@@ -381312,7 +381219,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381312
381219
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381313
381220
|
}
|
|
381314
381221
|
],
|
|
381315
|
-
"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
|
+
}
|
|
381316
381225
|
},
|
|
381317
381226
|
{
|
|
381318
381227
|
"kind": "property",
|
|
@@ -381431,7 +381340,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381431
381340
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381432
381341
|
}
|
|
381433
381342
|
],
|
|
381434
|
-
"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
|
+
}
|
|
381435
381347
|
},
|
|
381436
381348
|
{
|
|
381437
381349
|
"kind": "property",
|
|
@@ -381448,7 +381360,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381448
381360
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381449
381361
|
}
|
|
381450
381362
|
],
|
|
381451
|
-
"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
|
+
}
|
|
381452
381367
|
},
|
|
381453
381368
|
{
|
|
381454
381369
|
"kind": "property",
|
|
@@ -381464,7 +381379,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381464
381379
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381465
381380
|
}
|
|
381466
381381
|
],
|
|
381467
|
-
"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
|
+
}
|
|
381468
381385
|
},
|
|
381469
381386
|
{
|
|
381470
381387
|
"kind": "property",
|
|
@@ -381889,7 +381806,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381889
381806
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381890
381807
|
}
|
|
381891
381808
|
],
|
|
381892
|
-
"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
|
+
}
|
|
381893
381812
|
},
|
|
381894
381813
|
{
|
|
381895
381814
|
"kind": "property",
|
|
@@ -381991,7 +381910,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
381991
381910
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
381992
381911
|
}
|
|
381993
381912
|
],
|
|
381994
|
-
"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
|
+
}
|
|
381995
381917
|
},
|
|
381996
381918
|
{
|
|
381997
381919
|
"kind": "property",
|
|
@@ -382385,7 +382307,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382385
382307
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382386
382308
|
}
|
|
382387
382309
|
],
|
|
382388
|
-
"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
|
+
}
|
|
382389
382314
|
},
|
|
382390
382315
|
{
|
|
382391
382316
|
"kind": "property",
|
|
@@ -382401,7 +382326,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382401
382326
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382402
382327
|
}
|
|
382403
382328
|
],
|
|
382404
|
-
"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
|
+
}
|
|
382405
382332
|
},
|
|
382406
382333
|
{
|
|
382407
382334
|
"kind": "property",
|
|
@@ -382418,7 +382345,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382418
382345
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382419
382346
|
}
|
|
382420
382347
|
],
|
|
382421
|
-
"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
|
+
}
|
|
382422
382352
|
},
|
|
382423
382353
|
{
|
|
382424
382354
|
"kind": "property",
|
|
@@ -382503,7 +382433,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382503
382433
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382504
382434
|
}
|
|
382505
382435
|
],
|
|
382506
|
-
"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
|
+
}
|
|
382507
382440
|
},
|
|
382508
382441
|
{
|
|
382509
382442
|
"kind": "property",
|
|
@@ -382520,7 +382453,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382520
382453
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382521
382454
|
}
|
|
382522
382455
|
],
|
|
382523
|
-
"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
|
+
}
|
|
382524
382461
|
},
|
|
382525
382462
|
{
|
|
382526
382463
|
"kind": "property",
|
|
@@ -382673,7 +382610,10 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
382673
382610
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/index.ts"
|
|
382674
382611
|
}
|
|
382675
382612
|
],
|
|
382676
|
-
"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
|
+
}
|
|
382677
382617
|
}
|
|
382678
382618
|
]
|
|
382679
382619
|
}
|
|
@@ -384489,7 +384429,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
384489
384429
|
{
|
|
384490
384430
|
"name": "space",
|
|
384491
384431
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/space.ts",
|
|
384492
|
-
"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` |",
|
|
384493
384433
|
"declarations": [
|
|
384494
384434
|
{
|
|
384495
384435
|
"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.5",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.1.5",
|
|
23
|
+
"@workday/canvas-kit-react": "13.1.5",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.1.5",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.1.5",
|
|
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.5",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.1.5",
|
|
23
|
+
"@workday/canvas-kit-react": "13.1.5",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.1.5",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.1.5",
|
|
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": "13.
|
|
3
|
+
"version": "13.2.0-1154-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-1154-next.0",
|
|
49
|
+
"@workday/canvas-kit-preview-react": "^13.2.0-1154-next.0",
|
|
50
|
+
"@workday/canvas-kit-react": "^13.2.0-1154-next.0",
|
|
51
|
+
"@workday/canvas-kit-styling": "^13.2.0-1154-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": "500ed5283573c48f36ac477a4474c20a279493ab"
|
|
65
65
|
}
|