@workday/canvas-kit-docs 14.0.0-alpha.1251-next.0 → 14.0.0-alpha.1253-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 +198 -21
- package/dist/es6/mdx/welcomePage.d.ts.map +1 -1
- package/dist/es6/mdx/welcomePage.js +10 -5
- package/dist/mdx/14.0-UPGRADE-GUIDE.mdx +169 -100
- package/dist/mdx/14.0-VISUAL-CHANGES.mdx +44 -0
- package/dist/mdx/react/common/mdx/Theming.mdx +417 -0
- package/dist/mdx/react/common/mdx/examples/RTL.tsx +54 -0
- package/dist/mdx/react/common/mdx/examples/Theming.tsx +34 -0
- package/dist/mdx/welcome.mdx +2 -13
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -193551,9 +193551,204 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
193551
193551
|
],
|
|
193552
193552
|
"members": [],
|
|
193553
193553
|
"returnType": {
|
|
193554
|
-
"kind": "
|
|
193555
|
-
"
|
|
193556
|
-
|
|
193554
|
+
"kind": "union",
|
|
193555
|
+
"value": [
|
|
193556
|
+
{
|
|
193557
|
+
"kind": "object",
|
|
193558
|
+
"properties": [
|
|
193559
|
+
{
|
|
193560
|
+
"kind": "property",
|
|
193561
|
+
"name": "borderColor",
|
|
193562
|
+
"required": false,
|
|
193563
|
+
"type": {
|
|
193564
|
+
"kind": "primitive",
|
|
193565
|
+
"value": "undefined"
|
|
193566
|
+
},
|
|
193567
|
+
"description": "",
|
|
193568
|
+
"tags": {},
|
|
193569
|
+
"declarations": []
|
|
193570
|
+
},
|
|
193571
|
+
{
|
|
193572
|
+
"kind": "property",
|
|
193573
|
+
"name": "transition",
|
|
193574
|
+
"required": false,
|
|
193575
|
+
"type": {
|
|
193576
|
+
"kind": "primitive",
|
|
193577
|
+
"value": "undefined"
|
|
193578
|
+
},
|
|
193579
|
+
"description": "",
|
|
193580
|
+
"tags": {},
|
|
193581
|
+
"declarations": []
|
|
193582
|
+
},
|
|
193583
|
+
{
|
|
193584
|
+
"kind": "property",
|
|
193585
|
+
"name": "boxShadow",
|
|
193586
|
+
"required": false,
|
|
193587
|
+
"type": {
|
|
193588
|
+
"kind": "primitive",
|
|
193589
|
+
"value": "undefined"
|
|
193590
|
+
},
|
|
193591
|
+
"description": "",
|
|
193592
|
+
"tags": {},
|
|
193593
|
+
"declarations": []
|
|
193594
|
+
},
|
|
193595
|
+
{
|
|
193596
|
+
"kind": "property",
|
|
193597
|
+
"name": "&:hover, &:disabled, &.hover, &.disabled",
|
|
193598
|
+
"required": false,
|
|
193599
|
+
"type": {
|
|
193600
|
+
"kind": "primitive",
|
|
193601
|
+
"value": "undefined"
|
|
193602
|
+
},
|
|
193603
|
+
"description": "",
|
|
193604
|
+
"tags": {},
|
|
193605
|
+
"declarations": []
|
|
193606
|
+
},
|
|
193607
|
+
{
|
|
193608
|
+
"kind": "property",
|
|
193609
|
+
"name": "&:focus-visible:not([disabled]), &.focus:not([disabled])",
|
|
193610
|
+
"required": false,
|
|
193611
|
+
"type": {
|
|
193612
|
+
"kind": "primitive",
|
|
193613
|
+
"value": "undefined"
|
|
193614
|
+
},
|
|
193615
|
+
"description": "",
|
|
193616
|
+
"tags": {},
|
|
193617
|
+
"declarations": []
|
|
193618
|
+
}
|
|
193619
|
+
]
|
|
193620
|
+
},
|
|
193621
|
+
{
|
|
193622
|
+
"kind": "object",
|
|
193623
|
+
"properties": [
|
|
193624
|
+
{
|
|
193625
|
+
"kind": "property",
|
|
193626
|
+
"name": "borderColor",
|
|
193627
|
+
"required": true,
|
|
193628
|
+
"type": {
|
|
193629
|
+
"kind": "union",
|
|
193630
|
+
"value": [
|
|
193631
|
+
{
|
|
193632
|
+
"kind": "primitive",
|
|
193633
|
+
"value": "string"
|
|
193634
|
+
},
|
|
193635
|
+
{
|
|
193636
|
+
"kind": "primitive",
|
|
193637
|
+
"value": "undefined"
|
|
193638
|
+
}
|
|
193639
|
+
]
|
|
193640
|
+
},
|
|
193641
|
+
"description": "",
|
|
193642
|
+
"tags": {},
|
|
193643
|
+
"declarations": []
|
|
193644
|
+
},
|
|
193645
|
+
{
|
|
193646
|
+
"kind": "property",
|
|
193647
|
+
"name": "transition",
|
|
193648
|
+
"required": true,
|
|
193649
|
+
"type": {
|
|
193650
|
+
"kind": "primitive",
|
|
193651
|
+
"value": "string"
|
|
193652
|
+
},
|
|
193653
|
+
"description": "",
|
|
193654
|
+
"tags": {},
|
|
193655
|
+
"declarations": []
|
|
193656
|
+
},
|
|
193657
|
+
{
|
|
193658
|
+
"kind": "property",
|
|
193659
|
+
"name": "boxShadow",
|
|
193660
|
+
"required": true,
|
|
193661
|
+
"type": {
|
|
193662
|
+
"kind": "primitive",
|
|
193663
|
+
"value": "string"
|
|
193664
|
+
},
|
|
193665
|
+
"description": "",
|
|
193666
|
+
"tags": {},
|
|
193667
|
+
"declarations": []
|
|
193668
|
+
},
|
|
193669
|
+
{
|
|
193670
|
+
"kind": "property",
|
|
193671
|
+
"name": "&:hover, &:disabled, &.hover, &.disabled",
|
|
193672
|
+
"required": true,
|
|
193673
|
+
"type": {
|
|
193674
|
+
"kind": "object",
|
|
193675
|
+
"properties": [
|
|
193676
|
+
{
|
|
193677
|
+
"kind": "property",
|
|
193678
|
+
"name": "borderColor",
|
|
193679
|
+
"required": true,
|
|
193680
|
+
"type": {
|
|
193681
|
+
"kind": "union",
|
|
193682
|
+
"value": [
|
|
193683
|
+
{
|
|
193684
|
+
"kind": "primitive",
|
|
193685
|
+
"value": "string"
|
|
193686
|
+
},
|
|
193687
|
+
{
|
|
193688
|
+
"kind": "primitive",
|
|
193689
|
+
"value": "undefined"
|
|
193690
|
+
}
|
|
193691
|
+
]
|
|
193692
|
+
},
|
|
193693
|
+
"description": "",
|
|
193694
|
+
"tags": {},
|
|
193695
|
+
"declarations": []
|
|
193696
|
+
}
|
|
193697
|
+
]
|
|
193698
|
+
},
|
|
193699
|
+
"description": "",
|
|
193700
|
+
"tags": {},
|
|
193701
|
+
"declarations": []
|
|
193702
|
+
},
|
|
193703
|
+
{
|
|
193704
|
+
"kind": "property",
|
|
193705
|
+
"name": "&:focus-visible:not([disabled]), &.focus:not([disabled])",
|
|
193706
|
+
"required": true,
|
|
193707
|
+
"type": {
|
|
193708
|
+
"kind": "object",
|
|
193709
|
+
"properties": [
|
|
193710
|
+
{
|
|
193711
|
+
"kind": "property",
|
|
193712
|
+
"name": "borderColor",
|
|
193713
|
+
"required": true,
|
|
193714
|
+
"type": {
|
|
193715
|
+
"kind": "union",
|
|
193716
|
+
"value": [
|
|
193717
|
+
{
|
|
193718
|
+
"kind": "primitive",
|
|
193719
|
+
"value": "string"
|
|
193720
|
+
},
|
|
193721
|
+
{
|
|
193722
|
+
"kind": "primitive",
|
|
193723
|
+
"value": "undefined"
|
|
193724
|
+
}
|
|
193725
|
+
]
|
|
193726
|
+
},
|
|
193727
|
+
"description": "",
|
|
193728
|
+
"tags": {},
|
|
193729
|
+
"declarations": []
|
|
193730
|
+
},
|
|
193731
|
+
{
|
|
193732
|
+
"kind": "property",
|
|
193733
|
+
"name": "boxShadow",
|
|
193734
|
+
"required": true,
|
|
193735
|
+
"type": {
|
|
193736
|
+
"kind": "primitive",
|
|
193737
|
+
"value": "string"
|
|
193738
|
+
},
|
|
193739
|
+
"description": "",
|
|
193740
|
+
"tags": {},
|
|
193741
|
+
"declarations": []
|
|
193742
|
+
}
|
|
193743
|
+
]
|
|
193744
|
+
},
|
|
193745
|
+
"description": "",
|
|
193746
|
+
"tags": {},
|
|
193747
|
+
"declarations": []
|
|
193748
|
+
}
|
|
193749
|
+
]
|
|
193750
|
+
}
|
|
193751
|
+
]
|
|
193557
193752
|
}
|
|
193558
193753
|
}
|
|
193559
193754
|
},
|
|
@@ -193706,24 +193901,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
193706
193901
|
}
|
|
193707
193902
|
],
|
|
193708
193903
|
"tags": {}
|
|
193709
|
-
},
|
|
193710
|
-
{
|
|
193711
|
-
"kind": "parameter",
|
|
193712
|
-
"name": "theme",
|
|
193713
|
-
"type": {
|
|
193714
|
-
"kind": "primitive",
|
|
193715
|
-
"value": "any"
|
|
193716
|
-
},
|
|
193717
|
-
"required": false,
|
|
193718
|
-
"rest": false,
|
|
193719
|
-
"description": "",
|
|
193720
|
-
"declarations": [
|
|
193721
|
-
{
|
|
193722
|
-
"name": "theme",
|
|
193723
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/styles/focusRing.ts"
|
|
193724
|
-
}
|
|
193725
|
-
],
|
|
193726
|
-
"tags": {}
|
|
193727
193904
|
}
|
|
193728
193905
|
],
|
|
193729
193906
|
"members": [],
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"welcomePage.d.ts","sourceRoot":"","sources":["../../../mdx/welcomePage.tsx"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"welcomePage.d.ts","sourceRoot":"","sources":["../../../mdx/welcomePage.tsx"],"names":[],"mappings":"AAqDA,eAAO,MAAM,WAAW,+CAmGvB,CAAC"}
|
|
@@ -1,15 +1,20 @@
|
|
|
1
1
|
import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
|
|
2
2
|
// @ts-ignore: Cannot find module error
|
|
3
3
|
import headerImage from './ck-banner.jpg';
|
|
4
|
+
// @ts-ignore: Cannot find module error
|
|
5
|
+
import componentsImage from './Components.png';
|
|
6
|
+
// @ts-ignore: Cannot find module error
|
|
7
|
+
import tokensImage from './Tokens.png';
|
|
8
|
+
// @ts-ignore: Cannot find module error
|
|
9
|
+
import stylingImage from './Styling.png';
|
|
4
10
|
import { Flex, Grid, Box } from '@workday/canvas-kit-react/layout';
|
|
5
11
|
import { InstallBlock } from './installBlock';
|
|
6
12
|
import { Text, Heading } from '@workday/canvas-kit-react/text';
|
|
7
13
|
import { Card } from '@workday/canvas-kit-react/card';
|
|
8
14
|
import { ExternalHyperlink, Hyperlink } from '@workday/canvas-kit-react/button';
|
|
9
|
-
import {
|
|
10
|
-
import { SystemIcon } from '@workday/canvas-kit-react/icon';
|
|
11
|
-
import { system, base } from '@workday/canvas-tokens-web';
|
|
15
|
+
import { system } from '@workday/canvas-tokens-web';
|
|
12
16
|
import { createStyles } from '@workday/canvas-kit-styling';
|
|
17
|
+
import { Graphic } from '@workday/canvas-kit-react/icon';
|
|
13
18
|
// @ts-ignore: Cannot find module error
|
|
14
19
|
import { version } from '../../../lerna.json';
|
|
15
20
|
const parentFlexStyles = createStyles({
|
|
@@ -32,7 +37,7 @@ const imageStyles = createStyles({
|
|
|
32
37
|
height: 'auto',
|
|
33
38
|
});
|
|
34
39
|
const gridStyles = createStyles({
|
|
35
|
-
maxHeight:
|
|
40
|
+
maxHeight: 400,
|
|
36
41
|
gridTemplateRows: '1fr 1fr 2fr 1fr',
|
|
37
42
|
display: 'grid',
|
|
38
43
|
});
|
|
@@ -41,5 +46,5 @@ const linkStyles = createStyles({
|
|
|
41
46
|
marginTop: system.space.x3,
|
|
42
47
|
});
|
|
43
48
|
export const WelcomePage = () => {
|
|
44
|
-
return (_jsx("div", { className: "sb-unstyled", children: _jsxs("div", { className: parentFlexStyles, children: [_jsxs(Box, { cs: { overflow: 'hidden', position: 'relative' }, children: [_jsx("img", { src: headerImage, alt: "banner with canvas kit logo and version", className: imageStyles }), _jsx(Flex, { cs: { flexDirection: 'row', position: 'absolute', top: '45%', right: '5%' }, children: _jsxs(Text, { typeLevel: "title.medium", cs: [bannerTextStyles, versionStyles], children: ["v", version] }) })] }), _jsxs(Text, { typeLevel: "body.medium", children: ["This project provides a set of components for the Workday Canvas Design System that can be used to implement user experiences consistent with", _jsx(ExternalHyperlink, { href: "https://canvas.workdaydesign.com/", iconLabel: "Open docs in new window", cs: { marginInlineStart: system.space.x1 }, children: "Workday Design Principles." })] }), _jsx(Heading, { size: "medium", children: "Quick Links" }), _jsxs(Grid, { gridAutoColumns: "auto", gridTemplateColumns: "repeat(auto-fill, minmax(250px, 1fr))", gridGap: "s", children: [_jsxs(Grid, { as: Card, className: gridStyles, children: [_jsx(
|
|
49
|
+
return (_jsx("div", { className: "sb-unstyled", children: _jsxs("div", { className: parentFlexStyles, children: [_jsxs(Box, { cs: { overflow: 'hidden', position: 'relative' }, children: [_jsx("img", { src: headerImage, alt: "banner with canvas kit logo and version", className: imageStyles }), _jsx(Flex, { cs: { flexDirection: 'row', position: 'absolute', top: '45%', right: '5%' }, children: _jsxs(Text, { typeLevel: "title.medium", cs: [bannerTextStyles, versionStyles], children: ["v", version] }) })] }), _jsxs(Text, { typeLevel: "body.medium", children: ["This project provides a set of components for the Workday Canvas Design System that can be used to implement user experiences consistent with", _jsx(ExternalHyperlink, { href: "https://canvas.workdaydesign.com/", iconLabel: "Open docs in new window", cs: { marginInlineStart: system.space.x1 }, children: "Workday Design Principles." })] }), _jsx(Heading, { size: "medium", children: "Quick Links" }), _jsxs(Grid, { gridAutoColumns: "auto", gridTemplateColumns: "repeat(auto-fill, minmax(250px, 1fr))", gridGap: "s", children: [_jsxs(Grid, { as: Card, className: gridStyles, children: [_jsx(Graphic, { src: { url: componentsImage } }), _jsx(Card.Heading, { children: "Getting Started" }), _jsx(Card.Body, { children: _jsx(Text, { children: "For all things getting started including helpful guides and docs." }) }), _jsx(Grid.Item, { as: Hyperlink, className: linkStyles, href: "https://workday.github.io/canvas-kit/?path=/docs/guides-getting-started--docs", children: "Getting Started Guide" })] }), _jsxs(Grid, { as: Card, className: gridStyles, children: [_jsx(Graphic, { src: { url: tokensImage } }), _jsx(Card.Heading, { children: "Tokens" }), _jsx(Card.Body, { children: _jsx(Text, { children: "Tokens are the smallest pieces of our Design System with the primary function of storing UI information." }) }), _jsx(Grid.Item, { as: ExternalHyperlink, className: linkStyles, href: "https://workday.github.io/canvas-tokens/?path=/docs/docs-getting-started--docs", children: "View Our Tokens" })] }), _jsxs(Grid, { as: Card, className: gridStyles, children: [_jsx(Graphic, { src: { url: stylingImage } }), _jsx(Card.Heading, { children: "Styling" }), _jsx(Card.Body, { children: _jsx(Text, { children: "Learn how to style Canvas components using tokens, theming, and custom CSS approaches." }) }), _jsx(Grid.Item, { as: Hyperlink, className: linkStyles, href: "https://workday.github.io/canvas-kit/?path=/docs/styling-getting-started-overview--docs", children: "Get Started" })] })] }), _jsx(Heading, { size: "medium", children: "Installation" }), _jsx(Text, { children: "To get started using Canvas Kit React first add or install the module to your existing React project" }), _jsx(InstallBlock, { command: "yarn add", packageName: "@workday/canvas-kit-react @workday/canvas-tokens-web" }), "or", _jsx(InstallBlock, { command: "npm install", packageName: "@workday/canvas-kit-react @workday/canvas-tokens-web" })] }) }));
|
|
45
50
|
};
|