@workday/canvas-kit-docs 14.0.0-alpha.1233-next.0 → 14.0.0-alpha.1237-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/ExampleCodeBlock.js +2 -2
- package/dist/es6/lib/docs.js +117 -57
- package/dist/es6/lib/stackblitzFiles/packageJSONFile.js +5 -5
- package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts +5 -5
- package/dist/es6/mdx/installBlock.d.ts.map +1 -1
- package/dist/es6/mdx/installBlock.js +4 -1
- package/dist/es6/mdx/welcomePage.d.ts.map +1 -1
- package/dist/es6/mdx/welcomePage.js +1 -1
- package/dist/mdx/14.0-UPGRADE-GUIDE.mdx +9 -7
- package/dist/mdx/MAINTAINING.mdx +4 -4
- package/dist/mdx/PACKAGES.mdx +9 -10
- package/dist/mdx/labs-react/search-form/SearchForm.mdx +8 -3
- package/dist/mdx/preview-react/divider/Divider.mdx +15 -5
- package/dist/mdx/preview-react/pill/Pill.mdx +4 -4
- package/dist/mdx/preview-react/radio/Radio.mdx +2 -2
- package/dist/mdx/preview-react/select/Select.mdx +1 -1
- package/dist/mdx/preview-react/status-indicator/StatusIndicator.mdx +2 -2
- package/dist/mdx/react/_examples/mdx/Layouts.mdx +1 -1
- package/dist/mdx/react/avatar/avatar/Avatar.mdx +10 -4
- package/dist/mdx/react/button/button/Button.mdx +21 -16
- package/dist/mdx/react/card/card.mdx +1 -1
- package/dist/mdx/react/checkbox/Checkbox.mdx +5 -5
- package/dist/mdx/react/combobox/Combobox.mdx +2 -2
- package/dist/mdx/react/form-field/FormField.mdx +2 -2
- package/dist/mdx/react/select/Select.mdx +6 -6
- package/dist/mdx/react/status-indicator/StatusIndicator.mdx +1 -1
- package/dist/mdx/react/switch/Switch.mdx +5 -5
- package/dist/mdx/react/table/Table.mdx +26 -13
- package/dist/mdx/react/text/BodyText.mdx +2 -2
- package/dist/mdx/react/text/Heading.mdx +2 -2
- package/dist/mdx/react/text/Subtext.mdx +2 -2
- package/dist/mdx/react/text/Text.mdx +2 -2
- package/dist/mdx/react/text/Title.mdx +2 -2
- package/dist/mdx/style-props/STYLE_PROPS.mdx +1 -1
- package/dist/mdx/styling/mdx/CustomizingStyles.mdx +8 -8
- package/dist/mdx/styling/mdx/Overview.mdx +7 -3
- package/dist/mdx/tokens/TokenMigrationFinal.mdx +1 -1
- package/lib/ExampleCodeBlock.tsx +3 -3
- package/package.json +6 -6
|
@@ -18,7 +18,7 @@ import eslintrc from '!!raw-loader!./stackblitzFiles/.eslintrc.cjs.txt';
|
|
|
18
18
|
import tsconfigNodeFile from '!!raw-loader!./stackblitzFiles/tsconfig.node.json';
|
|
19
19
|
import appFile from '!!raw-loader!./stackblitzFiles/App.tsx';
|
|
20
20
|
import viteEnvFile from '!!raw-loader!./stackblitzFiles/vite-env.d.ts';
|
|
21
|
-
import { CanvasProvider,
|
|
21
|
+
import { CanvasProvider, defaultBranding } from '@workday/canvas-kit-react/common';
|
|
22
22
|
const cardStencil = createStencil({
|
|
23
23
|
base: {
|
|
24
24
|
'[data-part="example-block"]': {
|
|
@@ -110,7 +110,7 @@ export const ExampleCodeBlock = ({ code }) => {
|
|
|
110
110
|
openFile: 'src/Demo.tsx',
|
|
111
111
|
});
|
|
112
112
|
};
|
|
113
|
-
return (_jsxs("div", { ...cardStencil({ opened: isCodeDisplayed }), children: [_jsx(Card, { "data-part": "example-block", className: "sb-unstyled", children: _jsx(Card.Body, { children: _jsxs(CanvasProvider, {
|
|
113
|
+
return (_jsxs("div", { ...cardStencil({ opened: isCodeDisplayed }), children: [_jsx(Card, { "data-part": "example-block", className: "sb-unstyled", children: _jsx(Card.Body, { children: _jsxs(CanvasProvider, { className: defaultBranding, children: [React.createElement(code), code && (_jsxs("div", { "data-part": "code-toggle-stackblitz-btn-container", children: [_jsx(TertiaryButton, { size: "extraSmall", onClick: () => openProjectInStackblitz(), children: "\u26A1\uFE0F Edit in Stackblitz" }), _jsx(TertiaryButton, { size: "extraSmall", onClick: () => setCodeDisplayed(!isCodeDisplayed), children: !isCodeDisplayed ? 'Show Code' : 'Hide Code' })] }))] }) }) }), _jsx(Card, { "data-part": "code-block", padding: 0, children: _jsx(Card.Body, { cs: { position: 'relative' }, children: _jsxs(CanvasProvider, { className: defaultBranding, children: [code && (_jsx("div", { ref: textInput, children: _jsx(SyntaxHighlighter, { className: "sb-unstyled", language: "jsx", style: vscDarkPlus, customStyle: {
|
|
114
114
|
fontSize: cssVar(system.fontSize.subtext.large),
|
|
115
115
|
lineHeight: cssVar(system.lineHeight.subtext.large),
|
|
116
116
|
margin: '0',
|
package/dist/es6/lib/docs.js
CHANGED
|
@@ -10965,7 +10965,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
10965
10965
|
{
|
|
10966
10966
|
"name": "Divider",
|
|
10967
10967
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
|
|
10968
|
-
"description": "# Divider\nA divider to segment and visually organize content. By default, it renders a semantic `[<hr>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr)` element.\n\n[View Docs](https://workday.github.io/canvas-kit/?path=/docs/preview-divider
|
|
10968
|
+
"description": "# Divider\nA divider to segment and visually organize content. By default, it renders a semantic `[<hr>](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/hr)` element.\n\n[View Docs](https://workday.github.io/canvas-kit/?path=/docs/preview-divider--docs)\n\nThe `space` prop will equally apply top and bottom margin styles.\nIn the example below, `x2` (0.5rem), adds `0.25rem` margin to the top and `0.25rem` to the bottom",
|
|
10969
10969
|
"declarations": [
|
|
10970
10970
|
{
|
|
10971
10971
|
"name": "Divider",
|
|
@@ -63248,7 +63248,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63248
63248
|
}
|
|
63249
63249
|
],
|
|
63250
63250
|
"tags": {
|
|
63251
|
-
"deprecated": "⚠️ `scrollIntoViewIfNeeded` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63251
|
+
"deprecated": "⚠️ `scrollIntoViewIfNeeded` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63252
63252
|
},
|
|
63253
63253
|
"type": {
|
|
63254
63254
|
"kind": "function",
|
|
@@ -63313,7 +63313,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63313
63313
|
}
|
|
63314
63314
|
],
|
|
63315
63315
|
"tags": {
|
|
63316
|
-
"deprecated": "⚠️ `SelectProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63316
|
+
"deprecated": "⚠️ `SelectProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63317
63317
|
},
|
|
63318
63318
|
"type": {
|
|
63319
63319
|
"kind": "alias",
|
|
@@ -63331,7 +63331,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63331
63331
|
}
|
|
63332
63332
|
],
|
|
63333
63333
|
"tags": {
|
|
63334
|
-
"deprecated": "⚠️ `Select` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63334
|
+
"deprecated": "⚠️ `Select` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63335
63335
|
},
|
|
63336
63336
|
"type": {
|
|
63337
63337
|
"kind": "enhancedComponent",
|
|
@@ -63577,7 +63577,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63577
63577
|
}
|
|
63578
63578
|
],
|
|
63579
63579
|
"tags": {
|
|
63580
|
-
"deprecated": "⚠️ `Option` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63580
|
+
"deprecated": "⚠️ `Option` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63581
63581
|
},
|
|
63582
63582
|
"type": {
|
|
63583
63583
|
"kind": "object",
|
|
@@ -63693,7 +63693,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63693
63693
|
}
|
|
63694
63694
|
],
|
|
63695
63695
|
"tags": {
|
|
63696
|
-
"deprecated": "⚠️ `NormalizedOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63696
|
+
"deprecated": "⚠️ `NormalizedOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63697
63697
|
},
|
|
63698
63698
|
"type": {
|
|
63699
63699
|
"kind": "object",
|
|
@@ -63809,7 +63809,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63809
63809
|
}
|
|
63810
63810
|
],
|
|
63811
63811
|
"tags": {
|
|
63812
|
-
"deprecated": "⚠️ `RenderSelectedFunction` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63812
|
+
"deprecated": "⚠️ `RenderSelectedFunction` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63813
63813
|
},
|
|
63814
63814
|
"type": {
|
|
63815
63815
|
"kind": "unknown",
|
|
@@ -63828,7 +63828,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63828
63828
|
}
|
|
63829
63829
|
],
|
|
63830
63830
|
"tags": {
|
|
63831
|
-
"deprecated": "⚠️ `RenderableOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63831
|
+
"deprecated": "⚠️ `RenderableOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63832
63832
|
},
|
|
63833
63833
|
"type": {
|
|
63834
63834
|
"kind": "object",
|
|
@@ -63978,7 +63978,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63978
63978
|
}
|
|
63979
63979
|
],
|
|
63980
63980
|
"tags": {
|
|
63981
|
-
"deprecated": "⚠️ `RenderOptionFunction` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
63981
|
+
"deprecated": "⚠️ `RenderOptionFunction` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
63982
63982
|
},
|
|
63983
63983
|
"type": {
|
|
63984
63984
|
"kind": "unknown",
|
|
@@ -63997,7 +63997,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63997
63997
|
}
|
|
63998
63998
|
],
|
|
63999
63999
|
"tags": {
|
|
64000
|
-
"deprecated": "⚠️ `CoreSelectBaseProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
64000
|
+
"deprecated": "⚠️ `CoreSelectBaseProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
64001
64001
|
},
|
|
64002
64002
|
"type": {
|
|
64003
64003
|
"kind": "object",
|
|
@@ -64126,7 +64126,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64126
64126
|
}
|
|
64127
64127
|
],
|
|
64128
64128
|
"tags": {
|
|
64129
|
-
"deprecated": "⚠️ `SelectBaseProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
64129
|
+
"deprecated": "⚠️ `SelectBaseProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
64130
64130
|
},
|
|
64131
64131
|
"type": {
|
|
64132
64132
|
"kind": "alias",
|
|
@@ -64160,7 +64160,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64160
64160
|
}
|
|
64161
64161
|
],
|
|
64162
64162
|
"tags": {
|
|
64163
|
-
"deprecated": "⚠️ `SelectBase` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
64163
|
+
"deprecated": "⚠️ `SelectBase` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
64164
64164
|
},
|
|
64165
64165
|
"type": {
|
|
64166
64166
|
"kind": "component",
|
|
@@ -64683,7 +64683,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64683
64683
|
}
|
|
64684
64684
|
],
|
|
64685
64685
|
"tags": {
|
|
64686
|
-
"deprecated": "⚠️ `SelectMenu` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
64686
|
+
"deprecated": "⚠️ `SelectMenu` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
64687
64687
|
},
|
|
64688
64688
|
"type": {
|
|
64689
64689
|
"kind": "component",
|
|
@@ -64904,7 +64904,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64904
64904
|
}
|
|
64905
64905
|
],
|
|
64906
64906
|
"tags": {
|
|
64907
|
-
"deprecated": "⚠️ `SelectOptionProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
64907
|
+
"deprecated": "⚠️ `SelectOptionProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
64908
64908
|
},
|
|
64909
64909
|
"type": {
|
|
64910
64910
|
"kind": "alias",
|
|
@@ -64922,7 +64922,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64922
64922
|
}
|
|
64923
64923
|
],
|
|
64924
64924
|
"tags": {
|
|
64925
|
-
"deprecated": "⚠️ `SelectOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
64925
|
+
"deprecated": "⚠️ `SelectOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
64926
64926
|
},
|
|
64927
64927
|
"type": {
|
|
64928
64928
|
"kind": "component",
|
|
@@ -65082,7 +65082,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
65082
65082
|
}
|
|
65083
65083
|
],
|
|
65084
65084
|
"tags": {
|
|
65085
|
-
"deprecated": "⚠️ `MenuPlacement` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
65085
|
+
"deprecated": "⚠️ `MenuPlacement` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
65086
65086
|
},
|
|
65087
65087
|
"type": {
|
|
65088
65088
|
"kind": "type",
|
|
@@ -65113,7 +65113,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
65113
65113
|
}
|
|
65114
65114
|
],
|
|
65115
65115
|
"tags": {
|
|
65116
|
-
"deprecated": "⚠️ `MenuVisibility` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
65116
|
+
"deprecated": "⚠️ `MenuVisibility` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
65117
65117
|
},
|
|
65118
65118
|
"type": {
|
|
65119
65119
|
"kind": "type",
|
|
@@ -65233,7 +65233,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
65233
65233
|
}
|
|
65234
65234
|
],
|
|
65235
65235
|
"tags": {
|
|
65236
|
-
"deprecated": "⚠️ `getCorrectedIndexByValue` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--
|
|
65236
|
+
"deprecated": "⚠️ `getCorrectedIndexByValue` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--docs) instead."
|
|
65237
65237
|
},
|
|
65238
65238
|
"type": {
|
|
65239
65239
|
"kind": "function",
|
|
@@ -192704,6 +192704,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
192704
192704
|
"name": "CanvasProvider"
|
|
192705
192705
|
}
|
|
192706
192706
|
},
|
|
192707
|
+
{
|
|
192708
|
+
"name": "defaultBranding",
|
|
192709
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx",
|
|
192710
|
+
"description": "If you wish to reset the theme to the default, apply this class on the CanvasProvider.",
|
|
192711
|
+
"declarations": [
|
|
192712
|
+
{
|
|
192713
|
+
"name": "defaultBranding",
|
|
192714
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx"
|
|
192715
|
+
}
|
|
192716
|
+
],
|
|
192717
|
+
"tags": {},
|
|
192718
|
+
"type": {
|
|
192719
|
+
"kind": "primitive",
|
|
192720
|
+
"value": "string"
|
|
192721
|
+
}
|
|
192722
|
+
},
|
|
192707
192723
|
{
|
|
192708
192724
|
"name": "useCanvasThemeToCssVars",
|
|
192709
192725
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/CanvasProvider.tsx",
|
|
@@ -343365,7 +343381,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343365
343381
|
}
|
|
343366
343382
|
],
|
|
343367
343383
|
"tags": {
|
|
343368
|
-
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--
|
|
343384
|
+
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--docs) in Preview instead."
|
|
343369
343385
|
},
|
|
343370
343386
|
"type": {
|
|
343371
343387
|
"kind": "object",
|
|
@@ -343434,7 +343450,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343434
343450
|
}
|
|
343435
343451
|
],
|
|
343436
343452
|
"tags": {
|
|
343437
|
-
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--
|
|
343453
|
+
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--docs) in Preview instead."
|
|
343438
343454
|
},
|
|
343439
343455
|
"type": {
|
|
343440
343456
|
"kind": "object",
|
|
@@ -343471,7 +343487,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343471
343487
|
}
|
|
343472
343488
|
],
|
|
343473
343489
|
"tags": {
|
|
343474
|
-
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--
|
|
343490
|
+
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--docs) in Preview instead."
|
|
343475
343491
|
},
|
|
343476
343492
|
"type": {
|
|
343477
343493
|
"kind": "object",
|
|
@@ -343567,7 +343583,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343567
343583
|
}
|
|
343568
343584
|
],
|
|
343569
343585
|
"tags": {
|
|
343570
|
-
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--
|
|
343586
|
+
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--docs) in Preview instead."
|
|
343571
343587
|
},
|
|
343572
343588
|
"type": {
|
|
343573
343589
|
"kind": "symbol",
|
|
@@ -343586,7 +343602,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343586
343602
|
}
|
|
343587
343603
|
],
|
|
343588
343604
|
"tags": {
|
|
343589
|
-
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--
|
|
343605
|
+
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--docs) in Preview instead."
|
|
343590
343606
|
},
|
|
343591
343607
|
"type": {
|
|
343592
343608
|
"kind": "alias",
|
|
@@ -343604,7 +343620,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343604
343620
|
}
|
|
343605
343621
|
],
|
|
343606
343622
|
"tags": {
|
|
343607
|
-
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--
|
|
343623
|
+
"deprecated": "⚠️ Status Indicator has been deprecated and will be removed in a future major version. Please use [`Status Indicator`](https://workday.github.io/canvas-kit/?path=/docs/preview-status-indicator--docs) in Preview instead."
|
|
343608
343624
|
},
|
|
343609
343625
|
"type": {
|
|
343610
343626
|
"kind": "component",
|
|
@@ -387213,7 +387229,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
387213
387229
|
}
|
|
387214
387230
|
],
|
|
387215
387231
|
"tags": {
|
|
387216
|
-
"deprecated": "⚠️ `LabelText` has been deprecated and will be removed in a future major version. Please use [FormField.Label](https://workday.github.io/canvas-kit/?path=/docs/
|
|
387232
|
+
"deprecated": "⚠️ `LabelText` has been deprecated and will be removed in a future major version. Please use [FormField.Label](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-form-field--docs) from Main instead."
|
|
387217
387233
|
},
|
|
387218
387234
|
"type": {
|
|
387219
387235
|
"kind": "enhancedComponent",
|
|
@@ -405013,7 +405029,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405013
405029
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/colors.types.ts"
|
|
405014
405030
|
}
|
|
405015
405031
|
],
|
|
405016
|
-
"tags": {
|
|
405032
|
+
"tags": {
|
|
405033
|
+
"deprecated": "⚠️ `BrandingColor` has been deprecated in a future major version. Please use our css var based [`brand colors`](https://workday.github.io/canvas-tokens/?path=/docs/docs-brand-tokens--docs) tokens."
|
|
405034
|
+
},
|
|
405017
405035
|
"type": {
|
|
405018
405036
|
"kind": "object",
|
|
405019
405037
|
"typeParameters": [],
|
|
@@ -405224,7 +405242,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405224
405242
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/colors.types.ts"
|
|
405225
405243
|
}
|
|
405226
405244
|
],
|
|
405227
|
-
"tags": {
|
|
405245
|
+
"tags": {
|
|
405246
|
+
"deprecated": "⚠️ `CanvasColor` has been deprecated in a future major version. Please use our css var based [`color tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-base-tokens--docs) tokens."
|
|
405247
|
+
},
|
|
405228
405248
|
"type": {
|
|
405229
405249
|
"kind": "type",
|
|
405230
405250
|
"typeParameters": [],
|
|
@@ -405893,7 +405913,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405893
405913
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/depth.ts"
|
|
405894
405914
|
}
|
|
405895
405915
|
],
|
|
405896
|
-
"tags": {
|
|
405916
|
+
"tags": {
|
|
405917
|
+
"deprecated": "⚠️ `CanvasDepth` has been deprecated in a future major version. Please use our css var based [`depth tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-depth--docs) tokens."
|
|
405918
|
+
},
|
|
405897
405919
|
"type": {
|
|
405898
405920
|
"kind": "object",
|
|
405899
405921
|
"properties": [
|
|
@@ -406169,7 +406191,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406169
406191
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/depth.ts"
|
|
406170
406192
|
}
|
|
406171
406193
|
],
|
|
406172
|
-
"tags": {
|
|
406194
|
+
"tags": {
|
|
406195
|
+
"deprecated": "⚠️ `CanvasDepthValues` has been deprecated in a future major version. Please use our css var based [`depth tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-depth--docs) tokens."
|
|
406196
|
+
},
|
|
406173
406197
|
"type": {
|
|
406174
406198
|
"kind": "type",
|
|
406175
406199
|
"typeParameters": [],
|
|
@@ -406345,7 +406369,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406345
406369
|
}
|
|
406346
406370
|
],
|
|
406347
406371
|
"tags": {
|
|
406348
|
-
"example": "```tsx\nimport { depth } from '@workday/canvas-kit-react/tokens';\n\nconst CustomCard = () => {\n return (\n <div css={depth[2]}>\n A standard-depth card\n </div>\n );\n}\n```"
|
|
406372
|
+
"example": "```tsx\nimport { depth } from '@workday/canvas-kit-react/tokens';\n\nconst CustomCard = () => {\n return (\n <div css={depth[2]}>\n A standard-depth card\n </div>\n );\n}\n```",
|
|
406373
|
+
"deprecated": "⚠️ `depth` has been deprecated in a future major version. Please use our css var based [`depth tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-depth--docs) tokens."
|
|
406349
406374
|
},
|
|
406350
406375
|
"type": {
|
|
406351
406376
|
"kind": "symbol",
|
|
@@ -406363,7 +406388,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406363
406388
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406364
406389
|
}
|
|
406365
406390
|
],
|
|
406366
|
-
"tags": {
|
|
406391
|
+
"tags": {
|
|
406392
|
+
"deprecated": "⚠️ `CanvasBorderRadius` has been deprecated in a future major version. Please use our css var based [`borderRadius tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-shape--docs) tokens."
|
|
406393
|
+
},
|
|
406367
406394
|
"type": {
|
|
406368
406395
|
"kind": "object",
|
|
406369
406396
|
"properties": [
|
|
@@ -406465,7 +406492,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406465
406492
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406466
406493
|
}
|
|
406467
406494
|
],
|
|
406468
|
-
"tags": {
|
|
406495
|
+
"tags": {
|
|
406496
|
+
"deprecated": "⚠️ `CanvasBorderRadiusKeys` has been deprecated in a future major version. Please use our css var based [`borderRadius tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-shape--docs) tokens."
|
|
406497
|
+
},
|
|
406469
406498
|
"type": {
|
|
406470
406499
|
"kind": "type",
|
|
406471
406500
|
"typeParameters": [],
|
|
@@ -406490,7 +406519,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406490
406519
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406491
406520
|
}
|
|
406492
406521
|
],
|
|
406493
|
-
"tags": {
|
|
406522
|
+
"tags": {
|
|
406523
|
+
"deprecated": "⚠️ `CanvasBorderRadiusValues` has been deprecated in a future major version. Please use our css var based [`borderRadius tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-shape--docs) tokens."
|
|
406524
|
+
},
|
|
406494
406525
|
"type": {
|
|
406495
406526
|
"kind": "type",
|
|
406496
406527
|
"typeParameters": [],
|
|
@@ -406531,7 +406562,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406531
406562
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406532
406563
|
}
|
|
406533
406564
|
],
|
|
406534
|
-
"tags": {
|
|
406565
|
+
"tags": {
|
|
406566
|
+
"deprecated": "⚠️ `borderRadius` has been deprecated in a future major version. Please use our css var based [`borderRadius tokens`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-shape--docs) tokens."
|
|
406567
|
+
},
|
|
406535
406568
|
"type": {
|
|
406536
406569
|
"kind": "symbol",
|
|
406537
406570
|
"name": "CanvasBorderRadius",
|
|
@@ -406839,7 +406872,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406839
406872
|
}
|
|
406840
406873
|
],
|
|
406841
406874
|
"tags": {
|
|
406842
|
-
"deprecated": "⚠️ `spaceNumbers` has been deprecated in a future major version. Please use our
|
|
406875
|
+
"deprecated": "⚠️ `spaceNumbers` has been deprecated in a future major version. Please use our css var based [`space`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-space--docs) tokens. In the case where you need to calculate a value, use [calc() function](https://workday.github.io/canvas-kit/?path=/docs/styling-utilities--docs#calc-functions)."
|
|
406843
406876
|
},
|
|
406844
406877
|
"type": {
|
|
406845
406878
|
"kind": "object",
|
|
@@ -407028,7 +407061,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407028
407061
|
}
|
|
407029
407062
|
],
|
|
407030
407063
|
"tags": {
|
|
407031
|
-
"deprecated": "⚠️ `CanvasSpaceNumberValues` has been deprecated in a future major version. Please use our
|
|
407064
|
+
"deprecated": "⚠️ `CanvasSpaceNumberValues` has been deprecated in a future major version. Please use our css var based [`space`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-space--docs) tokens. In the case where you need to calculate a value, use [calc() function](https://workday.github.io/canvas-kit/?path=/docs/styling-utilities--docs#calc-functions)."
|
|
407032
407065
|
},
|
|
407033
407066
|
"type": {
|
|
407034
407067
|
"kind": "type",
|
|
@@ -407091,7 +407124,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407091
407124
|
}
|
|
407092
407125
|
],
|
|
407093
407126
|
"tags": {
|
|
407094
|
-
"deprecated": "⚠️ `spaceNumbers` has been deprecated in a future major version. Please use our
|
|
407127
|
+
"deprecated": "⚠️ `spaceNumbers` has been deprecated in a future major version. Please use our css var based [`space`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-space--docs) tokens. In the case where you need to calculate a value, use [calc() function](https://workday.github.io/canvas-kit/?path=/docs/styling-utilities--docs#calc-functions)."
|
|
407095
407128
|
},
|
|
407096
407129
|
"type": {
|
|
407097
407130
|
"kind": "symbol",
|
|
@@ -407109,7 +407142,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407109
407142
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407110
407143
|
}
|
|
407111
407144
|
],
|
|
407112
|
-
"tags": {
|
|
407145
|
+
"tags": {
|
|
407146
|
+
"deprecated": "⚠️ `fontFamily` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407147
|
+
},
|
|
407113
407148
|
"type": {
|
|
407114
407149
|
"kind": "union",
|
|
407115
407150
|
"value": [
|
|
@@ -407134,7 +407169,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407134
407169
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407135
407170
|
}
|
|
407136
407171
|
],
|
|
407137
|
-
"tags": {
|
|
407172
|
+
"tags": {
|
|
407173
|
+
"deprecated": "⚠️ `monoFontFamily` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407174
|
+
},
|
|
407138
407175
|
"type": {
|
|
407139
407176
|
"kind": "primitive",
|
|
407140
407177
|
"value": "string"
|
|
@@ -407143,7 +407180,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407143
407180
|
{
|
|
407144
407181
|
"name": "fontFamilies",
|
|
407145
407182
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts",
|
|
407146
|
-
"description": "### Font Family Tokens\n
|
|
407183
|
+
"description": "### Font Family Tokens\n---\nThere are two font family tokens:\n\n- `default`: \"Roboto\" - what you'll almost always want to choose\n- `monospace`: \"Roboto Mono\" - what you'll want for monospace type\n\nYou can find more detailed information by inspecting individual families.",
|
|
407147
407184
|
"declarations": [
|
|
407148
407185
|
{
|
|
407149
407186
|
"name": "fontFamilies",
|
|
@@ -407151,7 +407188,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407151
407188
|
}
|
|
407152
407189
|
],
|
|
407153
407190
|
"tags": {
|
|
407154
|
-
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst MonospaceText = () => (\n <p css={{fontFamily: type.properties.fonts.monospace}}>\n monospace_text\n </p>\n);\n```"
|
|
407191
|
+
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst MonospaceText = () => (\n <p css={{fontFamily: type.properties.fonts.monospace}}>\n monospace_text\n </p>\n);\n```",
|
|
407192
|
+
"deprecated": "⚠️ `fontFamilies` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407155
407193
|
},
|
|
407156
407194
|
"type": {
|
|
407157
407195
|
"kind": "symbol",
|
|
@@ -407169,7 +407207,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407169
407207
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407170
407208
|
}
|
|
407171
407209
|
],
|
|
407172
|
-
"tags": {
|
|
407210
|
+
"tags": {
|
|
407211
|
+
"deprecated": "⚠️ `CanvasFontFamilies` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407212
|
+
},
|
|
407173
407213
|
"type": {
|
|
407174
407214
|
"kind": "object",
|
|
407175
407215
|
"properties": [
|
|
@@ -407223,7 +407263,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407223
407263
|
}
|
|
407224
407264
|
],
|
|
407225
407265
|
"tags": {
|
|
407226
|
-
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst LargeText = () => (\n <p css={{fontSize: type.properties.fontSizes[20]}}>\n Bold Text\n </p>\n);\n```"
|
|
407266
|
+
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst LargeText = () => (\n <p css={{fontSize: type.properties.fontSizes[20]}}>\n Bold Text\n </p>\n);\n```",
|
|
407267
|
+
"deprecated": "⚠️ `fontSizes` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407227
407268
|
},
|
|
407228
407269
|
"type": {
|
|
407229
407270
|
"kind": "symbol",
|
|
@@ -407241,7 +407282,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407241
407282
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontSizes.ts"
|
|
407242
407283
|
}
|
|
407243
407284
|
],
|
|
407244
|
-
"tags": {
|
|
407285
|
+
"tags": {
|
|
407286
|
+
"deprecated": "⚠️ `CanvasFontSizes` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407287
|
+
},
|
|
407245
407288
|
"type": {
|
|
407246
407289
|
"kind": "object",
|
|
407247
407290
|
"properties": [
|
|
@@ -407462,7 +407505,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407462
407505
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontSizes.ts"
|
|
407463
407506
|
}
|
|
407464
407507
|
],
|
|
407465
|
-
"tags": {
|
|
407508
|
+
"tags": {
|
|
407509
|
+
"deprecated": "⚠️ `CanvasFontSizeValues` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407510
|
+
},
|
|
407466
407511
|
"type": {
|
|
407467
407512
|
"kind": "type",
|
|
407468
407513
|
"typeParameters": [],
|
|
@@ -407532,7 +407577,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407532
407577
|
}
|
|
407533
407578
|
],
|
|
407534
407579
|
"tags": {
|
|
407535
|
-
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst BoldText = () => (\n <p css={{fontWeight: type.properties.fontWeights.bold}>\n Bold Text\n </p>\n);\n```"
|
|
407580
|
+
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst BoldText = () => (\n <p css={{fontWeight: type.properties.fontWeights.bold}>\n Bold Text\n </p>\n);\n```",
|
|
407581
|
+
"deprecated": "⚠️ `fontWeights` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407536
407582
|
},
|
|
407537
407583
|
"type": {
|
|
407538
407584
|
"kind": "symbol",
|
|
@@ -407550,7 +407596,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407550
407596
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontWeights.ts"
|
|
407551
407597
|
}
|
|
407552
407598
|
],
|
|
407553
|
-
"tags": {
|
|
407599
|
+
"tags": {
|
|
407600
|
+
"deprecated": "⚠️ `CanvasFontWeights` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407601
|
+
},
|
|
407554
407602
|
"type": {
|
|
407555
407603
|
"kind": "object",
|
|
407556
407604
|
"properties": [
|
|
@@ -407618,7 +407666,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407618
407666
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontWeights.ts"
|
|
407619
407667
|
}
|
|
407620
407668
|
],
|
|
407621
|
-
"tags": {
|
|
407669
|
+
"tags": {
|
|
407670
|
+
"deprecated": "⚠️ `CanvasFontWeightValues` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407671
|
+
},
|
|
407622
407672
|
"type": {
|
|
407623
407673
|
"kind": "type",
|
|
407624
407674
|
"typeParameters": [],
|
|
@@ -407644,14 +407694,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407644
407694
|
{
|
|
407645
407695
|
"name": "type",
|
|
407646
407696
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts",
|
|
407647
|
-
"description": "### Canvas Type Tokens\n[View Storybook Docs](https://workday.github.io/canvas-
|
|
407697
|
+
"description": "### Canvas Type Tokens\n[View Storybook Docs](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs)\n\n---\nType tokens are separated into three sections:\n\n- `levels` - provide higher-level styles for the Canvas type hierarchy: title, heading, body, and subtext\n- `properties` - provide low-level type properties (font families, sizes, and weights)\n- `variants` - provide modifiers for text styles (error, hint, and inverse)",
|
|
407648
407698
|
"declarations": [
|
|
407649
407699
|
{
|
|
407650
407700
|
"name": "type",
|
|
407651
407701
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts"
|
|
407652
407702
|
}
|
|
407653
407703
|
],
|
|
407654
|
-
"tags": {
|
|
407704
|
+
"tags": {
|
|
407705
|
+
"deprecated": "⚠️ `type` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407706
|
+
},
|
|
407655
407707
|
"type": {
|
|
407656
407708
|
"kind": "symbol",
|
|
407657
407709
|
"name": "CanvasType",
|
|
@@ -407668,7 +407720,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407668
407720
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts"
|
|
407669
407721
|
}
|
|
407670
407722
|
],
|
|
407671
|
-
"tags": {
|
|
407723
|
+
"tags": {
|
|
407724
|
+
"deprecated": "⚠️ `CanvasType` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407725
|
+
},
|
|
407672
407726
|
"type": {
|
|
407673
407727
|
"kind": "object",
|
|
407674
407728
|
"properties": [
|
|
@@ -407796,7 +407850,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407796
407850
|
{
|
|
407797
407851
|
"name": "levels",
|
|
407798
407852
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/levels.ts",
|
|
407799
|
-
"description": "### Canvas Type Hierarchy\n[View Storybook Docs](https://workday.github.io/canvas-
|
|
407853
|
+
"description": "### Canvas Type Hierarchy\n[View Storybook Docs](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs)\n\n---\nThe hierarchy is organized into four levels, which correspond to levels defined in Figma.\n\n- `title`: Intended to be used for large page titles.\n- `heading`: Intended to be used for headings and large text.\n- `body`: Intended to be used for standard body text.\n- `subtext`: Intended to be used for small subtext content or in tight spaces.\n\nEach level has three sizes: `large`, `medium`, and `small`.\n\nThe type hierarchy tokens are recommended for most type usage.\nThese objects handle font sizes, weights, line heights, letter spacing, and color for you,\nmaking it really simple to implement consistent type without much effort\n\nYou can find more detailed information by inspecting individual levels and sizes.",
|
|
407800
407854
|
"declarations": [
|
|
407801
407855
|
{
|
|
407802
407856
|
"name": "levels",
|
|
@@ -407804,7 +407858,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407804
407858
|
}
|
|
407805
407859
|
],
|
|
407806
407860
|
"tags": {
|
|
407807
|
-
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst Heading = () => (\n <h3 css={type.levels.heading.medium}>\n Heading Text\n </h3>\n);\n```"
|
|
407861
|
+
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst Heading = () => (\n <h3 css={type.levels.heading.medium}>\n Heading Text\n </h3>\n);\n```",
|
|
407862
|
+
"deprecated": "⚠️ `levels` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407808
407863
|
},
|
|
407809
407864
|
"type": {
|
|
407810
407865
|
"kind": "symbol",
|
|
@@ -407822,7 +407877,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407822
407877
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/levels.ts"
|
|
407823
407878
|
}
|
|
407824
407879
|
],
|
|
407825
|
-
"tags": {
|
|
407880
|
+
"tags": {
|
|
407881
|
+
"deprecated": "⚠️ `CanvasTypeHierarchy` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
407882
|
+
},
|
|
407826
407883
|
"type": {
|
|
407827
407884
|
"kind": "object",
|
|
407828
407885
|
"properties": [
|
|
@@ -409336,7 +409393,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
409336
409393
|
{
|
|
409337
409394
|
"name": "variants",
|
|
409338
409395
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/variants.ts",
|
|
409339
|
-
"description": "### Canvas Type Variants\n[View Storybook Docs](https://workday.github.io/canvas-
|
|
409396
|
+
"description": "### Canvas Type Variants\n[View Storybook Docs](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs)\n\n---\nThere are three type variants:\n\n- `error` Used for making errors more visible\n- `hint` Used for help text and secondary content\n- `inverse` Used for any text on a dark or colored background\n\nType variants provide modifiers for text styles.\nThey are typically used in conjunction with other type styles\nsuch as the type hierarchy and type properties tokens.\nYou can find more detailed information by inspecting individual variants.",
|
|
409340
409397
|
"declarations": [
|
|
409341
409398
|
{
|
|
409342
409399
|
"name": "variants",
|
|
@@ -409344,7 +409401,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
409344
409401
|
}
|
|
409345
409402
|
],
|
|
409346
409403
|
"tags": {
|
|
409347
|
-
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst ErrorText = () => (\n <span css={{ ...type.levels.subtext.small, ...type.variants.error}}>\n Error Text\n </span>\n);\n```"
|
|
409404
|
+
"example": "```tsx\nimport { type } from '@workday/canvas-kit-react/tokens';\n\nconst ErrorText = () => (\n <span css={{ ...type.levels.subtext.small, ...type.variants.error}}>\n Error Text\n </span>\n);\n```",
|
|
409405
|
+
"deprecated": "⚠️ `variants` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
409348
409406
|
},
|
|
409349
409407
|
"type": {
|
|
409350
409408
|
"kind": "symbol",
|
|
@@ -409362,7 +409420,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
409362
409420
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/variants.ts"
|
|
409363
409421
|
}
|
|
409364
409422
|
],
|
|
409365
|
-
"tags": {
|
|
409423
|
+
"tags": {
|
|
409424
|
+
"deprecated": "⚠️ `CanvasTypeVariants` has been deprecated in a future major version. Please use our css var based [`fontFamily`](https://workday.github.io/canvas-tokens/?path=/docs/docs-system-tokens-type--docs) tokens."
|
|
409425
|
+
},
|
|
409366
409426
|
"type": {
|
|
409367
409427
|
"kind": "object",
|
|
409368
409428
|
"properties": [
|
|
@@ -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.2.
|
|
22
|
-
"@workday/canvas-kit-preview-react": "13.2.
|
|
23
|
-
"@workday/canvas-kit-react": "13.2.
|
|
24
|
-
"@workday/canvas-kit-react-fonts": "^13.2.
|
|
25
|
-
"@workday/canvas-kit-styling": "13.2.
|
|
21
|
+
"@workday/canvas-kit-labs-react": "13.2.25",
|
|
22
|
+
"@workday/canvas-kit-preview-react": "13.2.25",
|
|
23
|
+
"@workday/canvas-kit-react": "13.2.25",
|
|
24
|
+
"@workday/canvas-kit-react-fonts": "^13.2.25",
|
|
25
|
+
"@workday/canvas-kit-styling": "13.2.25",
|
|
26
26
|
"@workday/canvas-system-icons-web": "3.0.22",
|
|
27
27
|
"@workday/canvas-tokens-web": "2.0.0"
|
|
28
28
|
},
|