@workday/canvas-kit-docs 8.3.4 → 8.3.6
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/commonjs/lib/specs.js +42 -42
- package/dist/commonjs/mdx/installBlock.d.ts +6 -0
- package/dist/commonjs/mdx/installBlock.d.ts.map +1 -0
- package/dist/commonjs/mdx/installBlock.js +31 -0
- package/dist/commonjs/mdx/welcomePage.d.ts +2 -0
- package/dist/commonjs/mdx/welcomePage.d.ts.map +1 -0
- package/dist/commonjs/mdx/welcomePage.js +66 -0
- package/dist/es6/lib/specs.js +42 -42
- package/dist/es6/mdx/installBlock.d.ts +6 -0
- package/dist/es6/mdx/installBlock.d.ts.map +1 -0
- package/dist/es6/mdx/installBlock.js +24 -0
- package/dist/es6/mdx/welcomePage.d.ts +2 -0
- package/dist/es6/mdx/welcomePage.d.ts.map +1 -0
- package/dist/es6/mdx/welcomePage.js +59 -0
- package/dist/mdx/4.0-UPGRADE-GUIDE.mdx +10 -0
- package/dist/mdx/5.0-UPGRADE-GUIDE.mdx +10 -0
- package/dist/mdx/6.0-UPGRADE-GUIDE.mdx +12 -2
- package/dist/mdx/7.0-UPGRADE-GUIDE.mdx +13 -3
- package/dist/mdx/8.0-UPGRADE-GUIDE.mdx +16 -10
- package/dist/mdx/API_PATTERN_GUIDELINES.mdx +11 -1
- package/dist/mdx/COMPOUND_COMPONENTS.mdx +10 -0
- package/dist/mdx/CONTRIBUTING.mdx +12 -3
- package/dist/mdx/CREATING_COMPOUND_COMPONENTS.mdx +10 -0
- package/dist/mdx/GETTING_STARTED.mdx +14 -0
- package/dist/mdx/MAINTAINING.mdx +10 -0
- package/dist/mdx/TESTING.mdx +10 -0
- package/dist/mdx/changelog.stories.mdx +9 -0
- package/dist/mdx/preview-react/segmented-control/SegmentedControl.mdx +1 -2
- package/dist/mdx/react/icon/Assets.mdx +28 -0
- package/dist/mdx/react/icon/examples/AccentIconList.tsx +50 -0
- package/dist/mdx/react/icon/examples/AppletIconList.tsx +50 -0
- package/dist/mdx/react/icon/examples/IconList.tsx +49 -0
- package/dist/mdx/react/icon/examples/Overview.tsx +30 -0
- package/dist/mdx/react/layout/Box.mdx +3 -1
- package/dist/mdx/react/layout/Flex.mdx +4 -7
- package/dist/mdx/react/layout/Grid.mdx +7 -4
- package/dist/mdx/react/tabs/Tabs.mdx +2 -3
- package/dist/mdx/react/text/Text.mdx +2 -2
- package/dist/mdx/react/tokens/Tokens.mdx +51 -0
- package/dist/mdx/react/tokens/examples/Overview.tsx +19 -0
- package/dist/mdx/react/tokens/examples/Tokens.tsx +276 -0
- package/dist/mdx/style-props/STYLE_PROPS.mdx +14 -4
- package/dist/mdx/welcome.stories.mdx +31 -1
- package/package.json +4 -3
package/dist/es6/lib/specs.js
CHANGED
|
@@ -51,7 +51,7 @@ module.exports = {specifications: [
|
|
|
51
51
|
"children": [
|
|
52
52
|
{
|
|
53
53
|
"type": "describe",
|
|
54
|
-
"name": "given the [Components/Indicators/Banner
|
|
54
|
+
"name": "given the [Components/Indicators/Banner, Error] story is rendered",
|
|
55
55
|
"children": [
|
|
56
56
|
{
|
|
57
57
|
"type": "it",
|
|
@@ -73,7 +73,7 @@ module.exports = {specifications: [
|
|
|
73
73
|
},
|
|
74
74
|
{
|
|
75
75
|
"type": "describe",
|
|
76
|
-
"name": "given the [Components/Indicators/Banner
|
|
76
|
+
"name": "given the [Components/Indicators/Banner, Sticky] story is rendered",
|
|
77
77
|
"children": [
|
|
78
78
|
{
|
|
79
79
|
"type": "it",
|
|
@@ -107,7 +107,7 @@ module.exports = {specifications: [
|
|
|
107
107
|
"children": [
|
|
108
108
|
{
|
|
109
109
|
"type": "describe",
|
|
110
|
-
"name": "given the [Components/Navigation/Breadcrumbs
|
|
110
|
+
"name": "given the [Components/Navigation/Breadcrumbs, Basic] example is rendered",
|
|
111
111
|
"children": [
|
|
112
112
|
{
|
|
113
113
|
"type": "it",
|
|
@@ -171,7 +171,7 @@ module.exports = {specifications: [
|
|
|
171
171
|
},
|
|
172
172
|
{
|
|
173
173
|
"type": "describe",
|
|
174
|
-
"name": "given the [Components/Navigation/Breadcrumbs
|
|
174
|
+
"name": "given the [Components/Navigation/Breadcrumbs, Overflow Breadcrumbs] example is rendered",
|
|
175
175
|
"children": [
|
|
176
176
|
{
|
|
177
177
|
"type": "it",
|
|
@@ -203,7 +203,7 @@ module.exports = {specifications: [
|
|
|
203
203
|
},
|
|
204
204
|
{
|
|
205
205
|
"type": "describe",
|
|
206
|
-
"name": "given the [Components/Navigation/Breadcrumbs
|
|
206
|
+
"name": "given the [Components/Navigation/Breadcrumbs, Overflow Breadcrumbs] menu is rendered",
|
|
207
207
|
"children": [
|
|
208
208
|
{
|
|
209
209
|
"type": "it",
|
|
@@ -1225,7 +1225,7 @@ module.exports = {specifications: [
|
|
|
1225
1225
|
"children": [
|
|
1226
1226
|
{
|
|
1227
1227
|
"type": "describe",
|
|
1228
|
-
"name": "given the [Labs/Expandable
|
|
1228
|
+
"name": "given the [Labs/Expandable, Long Title] story is rendered",
|
|
1229
1229
|
"children": [
|
|
1230
1230
|
{
|
|
1231
1231
|
"type": "it",
|
|
@@ -1401,7 +1401,7 @@ module.exports = {specifications: [
|
|
|
1401
1401
|
"children": [
|
|
1402
1402
|
{
|
|
1403
1403
|
"type": "describe",
|
|
1404
|
-
"name": "given the [Components/Popups/Menu
|
|
1404
|
+
"name": "given the [Components/Popups/Menu, Basic] story is rendered",
|
|
1405
1405
|
"children": [
|
|
1406
1406
|
{
|
|
1407
1407
|
"type": "it",
|
|
@@ -1546,7 +1546,7 @@ module.exports = {specifications: [
|
|
|
1546
1546
|
"children": [
|
|
1547
1547
|
{
|
|
1548
1548
|
"type": "describe",
|
|
1549
|
-
"name": "given the [Preview/Menu
|
|
1549
|
+
"name": "given the [Preview/Menu, Basic] example is rendered",
|
|
1550
1550
|
"children": [
|
|
1551
1551
|
{
|
|
1552
1552
|
"type": "it",
|
|
@@ -1584,7 +1584,7 @@ module.exports = {specifications: [
|
|
|
1584
1584
|
"children": [
|
|
1585
1585
|
{
|
|
1586
1586
|
"type": "describe",
|
|
1587
|
-
"name": "given the [Components/Popups/Modal
|
|
1587
|
+
"name": "given the [Components/Popups/Modal, Basic] story is rendered",
|
|
1588
1588
|
"children": [
|
|
1589
1589
|
{
|
|
1590
1590
|
"type": "it",
|
|
@@ -1704,7 +1704,7 @@ module.exports = {specifications: [
|
|
|
1704
1704
|
},
|
|
1705
1705
|
{
|
|
1706
1706
|
"type": "describe",
|
|
1707
|
-
"name": "given the [Testing/
|
|
1707
|
+
"name": "given the [Testing/Popups/Modal, With Tooltips] story is rendered",
|
|
1708
1708
|
"children": [
|
|
1709
1709
|
{
|
|
1710
1710
|
"type": "describe",
|
|
@@ -1820,7 +1820,7 @@ module.exports = {specifications: [
|
|
|
1820
1820
|
},
|
|
1821
1821
|
{
|
|
1822
1822
|
"type": "describe",
|
|
1823
|
-
"name": "given the [Testing/
|
|
1823
|
+
"name": "given the [Testing/Popups/Modal, With Radio buttons] story is rendered",
|
|
1824
1824
|
"children": [
|
|
1825
1825
|
{
|
|
1826
1826
|
"type": "it",
|
|
@@ -1840,7 +1840,7 @@ module.exports = {specifications: [
|
|
|
1840
1840
|
},
|
|
1841
1841
|
{
|
|
1842
1842
|
"type": "describe",
|
|
1843
|
-
"name": "given the [Components/Popups/Modal
|
|
1843
|
+
"name": "given the [Components/Popups/Modal, Without close icon] story is rendered",
|
|
1844
1844
|
"children": [
|
|
1845
1845
|
{
|
|
1846
1846
|
"type": "it",
|
|
@@ -1940,7 +1940,7 @@ module.exports = {specifications: [
|
|
|
1940
1940
|
},
|
|
1941
1941
|
{
|
|
1942
1942
|
"type": "describe",
|
|
1943
|
-
"name": "given the [Components/Popups/Modal
|
|
1943
|
+
"name": "given the [Components/Popups/Modal, Custom focus] story is rendered",
|
|
1944
1944
|
"children": [
|
|
1945
1945
|
{
|
|
1946
1946
|
"type": "describe",
|
|
@@ -2020,7 +2020,7 @@ module.exports = {specifications: [
|
|
|
2020
2020
|
},
|
|
2021
2021
|
{
|
|
2022
2022
|
"type": "describe",
|
|
2023
|
-
"name": "given the [Testing/
|
|
2023
|
+
"name": "given the [Testing/Popups/Modal, StackedModals] story is rendered",
|
|
2024
2024
|
"children": [
|
|
2025
2025
|
{
|
|
2026
2026
|
"type": "describe",
|
|
@@ -2064,7 +2064,7 @@ module.exports = {specifications: [
|
|
|
2064
2064
|
},
|
|
2065
2065
|
{
|
|
2066
2066
|
"type": "describe",
|
|
2067
|
-
"name": "given the [Testing/
|
|
2067
|
+
"name": "given the [Testing/Popups/Modal, ModalWithPopup] story is rendered",
|
|
2068
2068
|
"children": [
|
|
2069
2069
|
{
|
|
2070
2070
|
"type": "describe",
|
|
@@ -2094,7 +2094,7 @@ module.exports = {specifications: [
|
|
|
2094
2094
|
},
|
|
2095
2095
|
{
|
|
2096
2096
|
"type": "describe",
|
|
2097
|
-
"name": "given the [Components/Popups/Modal
|
|
2097
|
+
"name": "given the [Components/Popups/Modal, CustomTarget] example is rendered",
|
|
2098
2098
|
"children": [
|
|
2099
2099
|
{
|
|
2100
2100
|
"type": "describe",
|
|
@@ -2416,7 +2416,7 @@ module.exports = {specifications: [
|
|
|
2416
2416
|
"children": [
|
|
2417
2417
|
{
|
|
2418
2418
|
"type": "describe",
|
|
2419
|
-
"name": "given the [Components/Popups/Popup
|
|
2419
|
+
"name": "given the [Components/Popups/Popup, Basic] example is rendered",
|
|
2420
2420
|
"children": [
|
|
2421
2421
|
{
|
|
2422
2422
|
"type": "describe",
|
|
@@ -2484,7 +2484,7 @@ module.exports = {specifications: [
|
|
|
2484
2484
|
},
|
|
2485
2485
|
{
|
|
2486
2486
|
"type": "describe",
|
|
2487
|
-
"name": "given the [Components/Popups/Popup
|
|
2487
|
+
"name": "given the [Components/Popups/Popup, MultiplePopups] example is rendered",
|
|
2488
2488
|
"children": [
|
|
2489
2489
|
{
|
|
2490
2490
|
"type": "describe",
|
|
@@ -2514,7 +2514,7 @@ module.exports = {specifications: [
|
|
|
2514
2514
|
},
|
|
2515
2515
|
{
|
|
2516
2516
|
"type": "describe",
|
|
2517
|
-
"name": "given the [Testing/
|
|
2517
|
+
"name": "given the [Testing/Popups/Popup, PopupWithNonHidablePopup] example is rendered",
|
|
2518
2518
|
"children": [
|
|
2519
2519
|
{
|
|
2520
2520
|
"type": "describe",
|
|
@@ -2554,7 +2554,7 @@ module.exports = {specifications: [
|
|
|
2554
2554
|
},
|
|
2555
2555
|
{
|
|
2556
2556
|
"type": "describe",
|
|
2557
|
-
"name": "given the [Testing/
|
|
2557
|
+
"name": "given the [Testing/Popups/Popup, MixedPopupTypes] story is rendered",
|
|
2558
2558
|
"children": [
|
|
2559
2559
|
{
|
|
2560
2560
|
"type": "it",
|
|
@@ -2710,7 +2710,7 @@ module.exports = {specifications: [
|
|
|
2710
2710
|
},
|
|
2711
2711
|
{
|
|
2712
2712
|
"type": "describe",
|
|
2713
|
-
"name": "given the [Components/Popups/Popup
|
|
2713
|
+
"name": "given the [Components/Popups/Popup, CustomTarget] example is rendered",
|
|
2714
2714
|
"children": [
|
|
2715
2715
|
{
|
|
2716
2716
|
"type": "describe",
|
|
@@ -2740,7 +2740,7 @@ module.exports = {specifications: [
|
|
|
2740
2740
|
},
|
|
2741
2741
|
{
|
|
2742
2742
|
"type": "describe",
|
|
2743
|
-
"name": "given the [Components/Popups/Popup
|
|
2743
|
+
"name": "given the [Components/Popups/Popup, FocusRedirect] example is rendered",
|
|
2744
2744
|
"children": [
|
|
2745
2745
|
{
|
|
2746
2746
|
"type": "describe",
|
|
@@ -2770,7 +2770,7 @@ module.exports = {specifications: [
|
|
|
2770
2770
|
},
|
|
2771
2771
|
{
|
|
2772
2772
|
"type": "describe",
|
|
2773
|
-
"name": "given the [Testing/
|
|
2773
|
+
"name": "given the [Testing/Popups/Popup, ReturnFocusTest] story is rendered",
|
|
2774
2774
|
"children": [
|
|
2775
2775
|
{
|
|
2776
2776
|
"type": "describe",
|
|
@@ -2781,7 +2781,7 @@ module.exports = {specifications: [
|
|
|
2781
2781
|
},
|
|
2782
2782
|
{
|
|
2783
2783
|
"type": "describe",
|
|
2784
|
-
"name": "given the [Testing/
|
|
2784
|
+
"name": "given the [Testing/Popups/Popup, CloseOnTargetHiddenTest] story is rendered",
|
|
2785
2785
|
"children": [
|
|
2786
2786
|
{
|
|
2787
2787
|
"type": "describe",
|
|
@@ -2792,7 +2792,7 @@ module.exports = {specifications: [
|
|
|
2792
2792
|
},
|
|
2793
2793
|
{
|
|
2794
2794
|
"type": "describe",
|
|
2795
|
-
"name": "given the [Testing/
|
|
2795
|
+
"name": "given the [Testing/Popups/Popup, TooltipReturnFocus] example is rendered",
|
|
2796
2796
|
"children": [
|
|
2797
2797
|
{
|
|
2798
2798
|
"type": "describe",
|
|
@@ -2962,7 +2962,7 @@ module.exports = {specifications: [
|
|
|
2962
2962
|
"children": [
|
|
2963
2963
|
{
|
|
2964
2964
|
"type": "describe",
|
|
2965
|
-
"name": "given the [Preview/Segmented Control
|
|
2965
|
+
"name": "given the [Preview/Segmented Control, Basic] story is rendered",
|
|
2966
2966
|
"children": [
|
|
2967
2967
|
{
|
|
2968
2968
|
"type": "it",
|
|
@@ -3074,7 +3074,7 @@ module.exports = {specifications: [
|
|
|
3074
3074
|
},
|
|
3075
3075
|
{
|
|
3076
3076
|
"type": "describe",
|
|
3077
|
-
"name": "given the [Preview/Segmented Control
|
|
3077
|
+
"name": "given the [Preview/Segmented Control, Vertical] story is rendered",
|
|
3078
3078
|
"children": [
|
|
3079
3079
|
{
|
|
3080
3080
|
"type": "it",
|
|
@@ -3186,7 +3186,7 @@ module.exports = {specifications: [
|
|
|
3186
3186
|
},
|
|
3187
3187
|
{
|
|
3188
3188
|
"type": "describe",
|
|
3189
|
-
"name": "given the [Preview/Segmented Control
|
|
3189
|
+
"name": "given the [Preview/Segmented Control, Disabled] story is rendered",
|
|
3190
3190
|
"children": [
|
|
3191
3191
|
{
|
|
3192
3192
|
"type": "describe",
|
|
@@ -3216,7 +3216,7 @@ module.exports = {specifications: [
|
|
|
3216
3216
|
},
|
|
3217
3217
|
{
|
|
3218
3218
|
"type": "describe",
|
|
3219
|
-
"name": "given the [Preview/Segmented Control
|
|
3219
|
+
"name": "given the [Preview/Segmented Control, rtl] story is rendered",
|
|
3220
3220
|
"children": [
|
|
3221
3221
|
{
|
|
3222
3222
|
"type": "describe",
|
|
@@ -5140,7 +5140,7 @@ module.exports = {specifications: [
|
|
|
5140
5140
|
"children": [
|
|
5141
5141
|
{
|
|
5142
5142
|
"type": "it",
|
|
5143
|
-
"name": "should render the
|
|
5143
|
+
"name": "should render the Welcome page"
|
|
5144
5144
|
},
|
|
5145
5145
|
{
|
|
5146
5146
|
"type": "describe",
|
|
@@ -5252,7 +5252,7 @@ module.exports = {specifications: [
|
|
|
5252
5252
|
"children": [
|
|
5253
5253
|
{
|
|
5254
5254
|
"type": "describe",
|
|
5255
|
-
"name": "given the [Components/Containers/Tabs
|
|
5255
|
+
"name": "given the [Components/Containers/Tabs, Basic] story is rendered",
|
|
5256
5256
|
"children": [
|
|
5257
5257
|
{
|
|
5258
5258
|
"type": "it",
|
|
@@ -5442,7 +5442,7 @@ module.exports = {specifications: [
|
|
|
5442
5442
|
},
|
|
5443
5443
|
{
|
|
5444
5444
|
"type": "describe",
|
|
5445
|
-
"name": "given the [Components/Containers/Tabs
|
|
5445
|
+
"name": "given the [Components/Containers/Tabs, Named Tabs] story is rendered",
|
|
5446
5446
|
"children": [
|
|
5447
5447
|
{
|
|
5448
5448
|
"type": "it",
|
|
@@ -5632,7 +5632,7 @@ module.exports = {specifications: [
|
|
|
5632
5632
|
},
|
|
5633
5633
|
{
|
|
5634
5634
|
"type": "describe",
|
|
5635
|
-
"name": "given the [Components/Containers/Tabs
|
|
5635
|
+
"name": "given the [Components/Containers/Tabs, DisabledTab] story is rendered",
|
|
5636
5636
|
"children": [
|
|
5637
5637
|
{
|
|
5638
5638
|
"type": "describe",
|
|
@@ -5682,7 +5682,7 @@ module.exports = {specifications: [
|
|
|
5682
5682
|
},
|
|
5683
5683
|
{
|
|
5684
5684
|
"type": "describe",
|
|
5685
|
-
"name": "given the [Components/Containers/Tabs
|
|
5685
|
+
"name": "given the [Components/Containers/Tabs, DynamicTabs] story is rendered",
|
|
5686
5686
|
"children": [
|
|
5687
5687
|
{
|
|
5688
5688
|
"type": "describe",
|
|
@@ -5800,7 +5800,7 @@ module.exports = {specifications: [
|
|
|
5800
5800
|
},
|
|
5801
5801
|
{
|
|
5802
5802
|
"type": "describe",
|
|
5803
|
-
"name": "given the [Components/Containers/Tabs
|
|
5803
|
+
"name": "given the [Components/Containers/Tabs, LeftToRight] story is rendered",
|
|
5804
5804
|
"children": [
|
|
5805
5805
|
{
|
|
5806
5806
|
"type": "describe",
|
|
@@ -5872,7 +5872,7 @@ module.exports = {specifications: [
|
|
|
5872
5872
|
},
|
|
5873
5873
|
{
|
|
5874
5874
|
"type": "describe",
|
|
5875
|
-
"name": "when [Components/Containers/Tabs
|
|
5875
|
+
"name": "when [Components/Containers/Tabs, OverflowTabs] story is rendered",
|
|
5876
5876
|
"children": [
|
|
5877
5877
|
{
|
|
5878
5878
|
"type": "it",
|
|
@@ -6660,7 +6660,7 @@ module.exports = {specifications: [
|
|
|
6660
6660
|
"children": [
|
|
6661
6661
|
{
|
|
6662
6662
|
"type": "describe",
|
|
6663
|
-
"name": "given the [Components/Popups/Tooltip
|
|
6663
|
+
"name": "given the [Components/Popups/Tooltip, DefaultStory] example is rendered",
|
|
6664
6664
|
"children": [
|
|
6665
6665
|
{
|
|
6666
6666
|
"type": "it",
|
|
@@ -6758,7 +6758,7 @@ module.exports = {specifications: [
|
|
|
6758
6758
|
},
|
|
6759
6759
|
{
|
|
6760
6760
|
"type": "describe",
|
|
6761
|
-
"name": "given the [Components/Popups/Tooltip
|
|
6761
|
+
"name": "given the [Components/Popups/Tooltip, Describe Type] example is rendered",
|
|
6762
6762
|
"children": [
|
|
6763
6763
|
{
|
|
6764
6764
|
"type": "it",
|
|
@@ -6790,7 +6790,7 @@ module.exports = {specifications: [
|
|
|
6790
6790
|
},
|
|
6791
6791
|
{
|
|
6792
6792
|
"type": "describe",
|
|
6793
|
-
"name": "given the [Components/Popups/Tooltip
|
|
6793
|
+
"name": "given the [Components/Popups/Tooltip, Muted] example is rendered",
|
|
6794
6794
|
"children": [
|
|
6795
6795
|
{
|
|
6796
6796
|
"type": "it",
|
|
@@ -6830,7 +6830,7 @@ module.exports = {specifications: [
|
|
|
6830
6830
|
},
|
|
6831
6831
|
{
|
|
6832
6832
|
"type": "describe",
|
|
6833
|
-
"name": "given the [Components/Popups/Tooltip
|
|
6833
|
+
"name": "given the [Components/Popups/Tooltip, Ellipsis] example is rendered",
|
|
6834
6834
|
"children": [
|
|
6835
6835
|
{
|
|
6836
6836
|
"type": "it",
|
|
@@ -6904,7 +6904,7 @@ module.exports = {specifications: [
|
|
|
6904
6904
|
},
|
|
6905
6905
|
{
|
|
6906
6906
|
"type": "describe",
|
|
6907
|
-
"name": "given the [Testing/
|
|
6907
|
+
"name": "given the [Testing/Popups/Tooltip, Non Interactive] example is rendered",
|
|
6908
6908
|
"children": [
|
|
6909
6909
|
{
|
|
6910
6910
|
"type": "describe",
|
|
@@ -6930,7 +6930,7 @@ module.exports = {specifications: [
|
|
|
6930
6930
|
},
|
|
6931
6931
|
{
|
|
6932
6932
|
"type": "describe",
|
|
6933
|
-
"name": "given the [Testing/
|
|
6933
|
+
"name": "given the [Testing/Popups/Tooltip, Overflow] example is rendered",
|
|
6934
6934
|
"children": [
|
|
6935
6935
|
{
|
|
6936
6936
|
"type": "describe",
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"installBlock.d.ts","sourceRoot":"","sources":["../../../mdx/installBlock.tsx"],"names":[],"mappings":"AAKA,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,YAAY,6BAA4B,iBAAiB,gBA8BrE,CAAC"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
import { Flex } from '@workday/canvas-kit-react/layout';
|
|
3
|
+
import { colors } from '@workday/canvas-kit-react/tokens';
|
|
4
|
+
import { PrimaryButton } from '@workday/canvas-kit-react/button';
|
|
5
|
+
export var InstallBlock = function (_a) {
|
|
6
|
+
var command = _a.command, packageName = _a.packageName;
|
|
7
|
+
var commandRef = React.useRef(null);
|
|
8
|
+
var _b = React.useState(false), copied = _b[0], setCopied = _b[1];
|
|
9
|
+
React.useEffect(function () {
|
|
10
|
+
setTimeout(function () { return setCopied(false); }, 600);
|
|
11
|
+
}, [copied]);
|
|
12
|
+
var handleCopy = function () {
|
|
13
|
+
setCopied(true);
|
|
14
|
+
if (commandRef.current) {
|
|
15
|
+
navigator.clipboard.writeText(commandRef.current.innerText);
|
|
16
|
+
}
|
|
17
|
+
};
|
|
18
|
+
return (React.createElement(Flex, { padding: "xs", backgroundColor: colors.licorice500, borderRadius: "m", justifyContent: "space-between", alignItems: "center", flexWrap: 'wrap' },
|
|
19
|
+
React.createElement("pre", { ref: commandRef },
|
|
20
|
+
React.createElement("span", { style: { color: colors.blueberry200 } }, command),
|
|
21
|
+
' ',
|
|
22
|
+
React.createElement("span", { style: { color: colors.frenchVanilla100 } }, packageName)),
|
|
23
|
+
React.createElement(PrimaryButton, { variant: "inverse", onClick: handleCopy, size: "small" }, copied ? 'Copied' : 'Copy')));
|
|
24
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"welcomePage.d.ts","sourceRoot":"","sources":["../../../mdx/welcomePage.tsx"],"names":[],"mappings":"AAcA,eAAO,MAAM,WAAW,mBA6IvB,CAAC"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import React from 'react';
|
|
2
|
+
// @ts-ignore: Cannot find module error
|
|
3
|
+
import headerImage from './storybook-welcome-header.png';
|
|
4
|
+
import { Flex, Grid, Box } from '@workday/canvas-kit-react/layout';
|
|
5
|
+
import { InstallBlock } from './installBlock';
|
|
6
|
+
import { Text, Heading } from '@workday/canvas-kit-react/text';
|
|
7
|
+
import { Card } from '@workday/canvas-kit-react/card';
|
|
8
|
+
import { ExternalHyperlink, Hyperlink } from '@workday/canvas-kit-react/button';
|
|
9
|
+
import { colors } from '@workday/canvas-kit-react/tokens';
|
|
10
|
+
import { rocketIcon, tokensIcon, shapesIcon } from '@workday/canvas-system-icons-web';
|
|
11
|
+
import { SystemIcon } from '@workday/canvas-kit-react/icon';
|
|
12
|
+
// @ts-ignore: Cannot find module error
|
|
13
|
+
import { version } from '../../../lerna.json';
|
|
14
|
+
export var WelcomePage = function () {
|
|
15
|
+
return (React.createElement(Flex, { flexDirection: "column", gap: "s" },
|
|
16
|
+
React.createElement(Box, { borderRadius: "m", overflow: "hidden", position: "relative" },
|
|
17
|
+
React.createElement(Flex, { position: "absolute", flexDirection: "column", top: "30%", left: "10%" },
|
|
18
|
+
React.createElement(Text, { typeLevel: "title.medium", color: colors.frenchVanilla100, fontSize: "6vmin", marginBottom: "s", style: { lineHeight: '3vmin' } }, "Canvas Kit"),
|
|
19
|
+
React.createElement(Text, { typeLevel: "body.large", fontSize: "3vmin", style: { lineHeight: '2vw' }, color: colors.frenchVanilla100 },
|
|
20
|
+
"v",
|
|
21
|
+
version)),
|
|
22
|
+
React.createElement("img", { src: headerImage, alt: "test", style: { width: '100%', height: 'auto' } })),
|
|
23
|
+
React.createElement(Text, { typeLevel: "body.medium" },
|
|
24
|
+
' ',
|
|
25
|
+
"This project provides a set of components for the Workday Canvas Design System that can be used to implement user experiences consistent with",
|
|
26
|
+
' ',
|
|
27
|
+
React.createElement(ExternalHyperlink, { href: "https://canvas.workdaydesign.com/" }, "Workday Design Principles.")),
|
|
28
|
+
React.createElement(Heading, { size: "medium", borderBottom: "1px solid " + colors.blueberry200, paddingBottom: "xxs" }, "Quick Links"),
|
|
29
|
+
React.createElement(Grid, { gridAutoColumns: "auto", gridTemplateColumns: "repeat(auto-fill, minmax(250px, 1fr))", gridGap: "s" },
|
|
30
|
+
React.createElement(Grid, { as: Card, gridTemplateRows: "1fr 1fr 2fr 1fr", depth: "none", display: "grid", maxHeight: 320 },
|
|
31
|
+
React.createElement(SystemIcon, { color: colors.cantaloupe400, colorHover: colors.cantaloupe400, icon: rocketIcon, size: 60 }),
|
|
32
|
+
React.createElement(Card.Heading, null, "Getting Started"),
|
|
33
|
+
React.createElement(Card.Body, null,
|
|
34
|
+
React.createElement(Text, null, "For all things getting started including helpful guides and docs.")),
|
|
35
|
+
React.createElement(Grid.Item, { as: Hyperlink, alignSelf: "end", marginTop: "xs", href: "/?path=/docs/guides-getting-started--page" },
|
|
36
|
+
' ',
|
|
37
|
+
"Getting Started Guide")),
|
|
38
|
+
React.createElement(Grid, { as: Card, gridTemplateRows: "1fr 1fr 2fr 1fr", depth: "none", display: "grid", maxHeight: 320 },
|
|
39
|
+
React.createElement(SystemIcon, { color: colors.blueberry400, icon: tokensIcon, colorHover: colors.blueberry400, size: 60 }),
|
|
40
|
+
React.createElement(Card.Heading, null, "Tokens"),
|
|
41
|
+
React.createElement(Card.Body, null,
|
|
42
|
+
React.createElement(Text, null, "Tokens are the smallest pieces of our Design System with the primary function of storing UI information.")),
|
|
43
|
+
React.createElement(Grid.Item, { alignSelf: "end", as: Hyperlink, marginTop: "xs", href: "/?path=/docs/tokens--overview" },
|
|
44
|
+
' ',
|
|
45
|
+
"View Our Tokens")),
|
|
46
|
+
React.createElement(Grid, { as: Card, gridTemplateRows: "1fr 1fr 2fr 1fr", depth: "none", display: "grid", maxHeight: 320 },
|
|
47
|
+
React.createElement(SystemIcon, { color: colors.greenApple400, icon: shapesIcon, size: 60, colorHover: colors.greenApple400 }),
|
|
48
|
+
React.createElement(Card.Heading, null, "Assets"),
|
|
49
|
+
React.createElement(Card.Body, null,
|
|
50
|
+
React.createElement(Text, null, "Assets are graphics which help communicate meaning or highlight areas of interaction to our users.")),
|
|
51
|
+
React.createElement(Grid.Item, { as: Hyperlink, alignSelf: "end", marginTop: "xs", href: "/?path=/docs/assets-icons--overview" },
|
|
52
|
+
' ',
|
|
53
|
+
"View Assets"))),
|
|
54
|
+
React.createElement(Heading, { size: "medium", borderBottom: "1px solid " + colors.blueberry200, paddingBottom: "xxs" }, "Installation"),
|
|
55
|
+
React.createElement(Text, null, "To get started using Canvas kit React first add or install the module to your existing React project"),
|
|
56
|
+
React.createElement(InstallBlock, { command: "yarn add", packageName: "@workday/canvas-kit-react" }),
|
|
57
|
+
"or",
|
|
58
|
+
React.createElement(InstallBlock, { command: "npm install", packageName: "@workday/canvas-kit-react" })));
|
|
59
|
+
};
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
<Meta
|
|
2
|
+
title="Guides/Upgrade Guides/v4.0"
|
|
3
|
+
parameters={{
|
|
4
|
+
viewMode: 'docs',
|
|
5
|
+
previewTabs: {
|
|
6
|
+
canvas: {hidden: true},
|
|
7
|
+
},
|
|
8
|
+
}}
|
|
9
|
+
/>
|
|
10
|
+
|
|
1
11
|
# Canvas Kit 4.0 Upgrade Guide
|
|
2
12
|
|
|
3
13
|
Below are the breaking changes made in Canvas Kit v4. Please reach out if you have any questions
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
<Meta
|
|
2
|
+
title="Guides/Upgrade Guides/v6.0"
|
|
3
|
+
parameters={{
|
|
4
|
+
viewMode: 'docs',
|
|
5
|
+
previewTabs: {
|
|
6
|
+
canvas: { hidden: true }
|
|
7
|
+
},
|
|
8
|
+
}}
|
|
9
|
+
/>
|
|
10
|
+
|
|
1
11
|
# Canvas Kit 6.0 Upgrade Guide
|
|
2
12
|
|
|
3
13
|
Below are the breaking changes made in Canvas Kit v6. Please
|
|
@@ -80,8 +90,8 @@ warning.
|
|
|
80
90
|
#### Hard Deprecation
|
|
81
91
|
|
|
82
92
|
A hard-deprecated component or package is no longer available. You will need to follow the method
|
|
83
|
-
prescribed in our upgrade guide to update your application. Please reach out to our team directly
|
|
84
|
-
|
|
93
|
+
prescribed in our upgrade guide to update your application. Please reach out to our team directly if
|
|
94
|
+
you need additional help.
|
|
85
95
|
|
|
86
96
|
### Cookie Banner
|
|
87
97
|
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
<Meta
|
|
2
|
+
title="Guides/Upgrade Guides/v7.0"
|
|
3
|
+
parameters={{
|
|
4
|
+
viewMode: 'docs',
|
|
5
|
+
previewTabs: {
|
|
6
|
+
canvas: {hidden: true},
|
|
7
|
+
},
|
|
8
|
+
}}
|
|
9
|
+
/>
|
|
10
|
+
|
|
1
11
|
# Canvas Kit 7.0 Upgrade Guide
|
|
2
12
|
|
|
3
13
|
This guide contains breaking changes in Canvas Kit v7. Please
|
|
@@ -453,9 +463,9 @@ const model = useActionBarModel({
|
|
|
453
463
|
|
|
454
464
|
#### Responsive Container Support
|
|
455
465
|
|
|
456
|
-
The `ActionBar` component can now handle responsive containers, but the support is not automatic.
|
|
457
|
-
must use the dynamic API and provide an overflow menu subcomponent. The dynamic API doesn't know
|
|
458
|
-
shape of your object, so render props must be used to instruct React how to render each item.
|
|
466
|
+
The `ActionBar` component can now handle responsive containers, but the support is not automatic.
|
|
467
|
+
You must use the dynamic API and provide an overflow menu subcomponent. The dynamic API doesn't know
|
|
468
|
+
the shape of your object, so render props must be used to instruct React how to render each item.
|
|
459
469
|
|
|
460
470
|
```tsx
|
|
461
471
|
const [items] = React.useState<MyActionItem[]>([
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
<Meta
|
|
2
|
+
title="Guides/Upgrade Guides/v8.0"
|
|
3
|
+
parameters={{
|
|
4
|
+
viewMode: 'docs',
|
|
5
|
+
previewTabs: {
|
|
6
|
+
canvas: {hidden: true},
|
|
7
|
+
},
|
|
8
|
+
}}
|
|
9
|
+
/>
|
|
10
|
+
|
|
1
11
|
# Canvas Kit 8.0 Upgrade Guide
|
|
2
12
|
|
|
3
13
|
This guide contains an overview of the changes in Canvas Kit v8. Please
|
|
@@ -311,7 +321,8 @@ changes have been made:
|
|
|
311
321
|
|
|
312
322
|
### Utility Deprecations
|
|
313
323
|
|
|
314
|
-
The following utility functions are being deprecated and will be removed in a later version of
|
|
324
|
+
The following utility functions are being deprecated and will be removed in a later version of
|
|
325
|
+
Canvas Kit.
|
|
315
326
|
|
|
316
327
|
- Types:
|
|
317
328
|
- `Model`
|
|
@@ -892,9 +903,8 @@ button, it is still a breaking change. This change effects the following compone
|
|
|
892
903
|
### Loading Animation
|
|
893
904
|
|
|
894
905
|
`LoadingAnimation` is being renamed to `LoadingDots` and is moving from of
|
|
895
|
-
`@workday/canvas-kit-react/loading-animation` to
|
|
896
|
-
|
|
897
|
-
continue to use this component exactly as you did in v7.
|
|
906
|
+
`@workday/canvas-kit-react/loading-animation` to `@workday/canvas-kit-react/loading-dots`. The
|
|
907
|
+
component has not been modified and you may continue to use this component exactly as you did in v7.
|
|
898
908
|
|
|
899
909
|
The CSS package has been similarly updated for consistency, but is still in maintenance mode.
|
|
900
910
|
|
|
@@ -909,9 +919,7 @@ The CSS package has been similarly updated for consistency, but is still in main
|
|
|
909
919
|
|
|
910
920
|
```tsx
|
|
911
921
|
// v7
|
|
912
|
-
import {
|
|
913
|
-
LoadingAnimation
|
|
914
|
-
} from '@workday/canvas-kit-react/loading-animation';
|
|
922
|
+
import {LoadingAnimation} from '@workday/canvas-kit-react/loading-animation';
|
|
915
923
|
|
|
916
924
|
const MyComponent = (props: MyComponentProps) => {
|
|
917
925
|
return <LoadingAnimation />;
|
|
@@ -920,9 +928,7 @@ const MyComponent = (props: MyComponentProps) => {
|
|
|
920
928
|
const StyledLoadingAnimation = styled(LoadingAnimation)({});
|
|
921
929
|
|
|
922
930
|
// v8
|
|
923
|
-
import {
|
|
924
|
-
LoadingDots
|
|
925
|
-
} from '@workday/canvas-kit-react/loading-dots';
|
|
931
|
+
import {LoadingDots} from '@workday/canvas-kit-react/loading-dots';
|
|
926
932
|
|
|
927
933
|
const MyComponent = (props: MyComponentProps) => {
|
|
928
934
|
return <LoadingDots />;
|
|
@@ -1,3 +1,13 @@
|
|
|
1
|
+
<Meta
|
|
2
|
+
title="Guides/API & Pattern Guidelines"
|
|
3
|
+
parameters={{
|
|
4
|
+
viewMode: 'docs',
|
|
5
|
+
previewTabs: {
|
|
6
|
+
canvas: { hidden: true }
|
|
7
|
+
},
|
|
8
|
+
}}
|
|
9
|
+
/>
|
|
10
|
+
|
|
1
11
|
# API & Pattern Guidelines
|
|
2
12
|
|
|
3
13
|
Note: This repo hasn't seen a full audit, so you may find examples that contradict these guidelines.
|
|
@@ -40,7 +50,7 @@ Some of the below rules are inspired by painpoints we've encountered in this pro
|
|
|
40
50
|
- Use the provided types (e.g. `CanvasSpaceValues`, `CanvasSpaceNumbers`, etc.) to restrict prop
|
|
41
51
|
values
|
|
42
52
|
- Check out the
|
|
43
|
-
[`@workday/canvas-kit-react/tokens` README](https://github.com/Workday/canvas-kit/blob/master/modules/tokens/
|
|
53
|
+
[`@workday/canvas-kit-react/tokens` README](https://github.com/Workday/canvas-kit/blob/master/modules/react/tokens/README.md)
|
|
44
54
|
for the latest and greatest Canvas helpers.
|
|
45
55
|
|
|
46
56
|
## Naming
|