@workday/canvas-kit-docs 14.0.0-alpha.1233-next.0 → 14.0.0-alpha.1234-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 +101 -57
- 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/package.json +6 -6
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",
|
|
@@ -343365,7 +343365,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343365
343365
|
}
|
|
343366
343366
|
],
|
|
343367
343367
|
"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--
|
|
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--docs) in Preview instead."
|
|
343369
343369
|
},
|
|
343370
343370
|
"type": {
|
|
343371
343371
|
"kind": "object",
|
|
@@ -343434,7 +343434,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343434
343434
|
}
|
|
343435
343435
|
],
|
|
343436
343436
|
"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--
|
|
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--docs) in Preview instead."
|
|
343438
343438
|
},
|
|
343439
343439
|
"type": {
|
|
343440
343440
|
"kind": "object",
|
|
@@ -343471,7 +343471,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343471
343471
|
}
|
|
343472
343472
|
],
|
|
343473
343473
|
"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--
|
|
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--docs) in Preview instead."
|
|
343475
343475
|
},
|
|
343476
343476
|
"type": {
|
|
343477
343477
|
"kind": "object",
|
|
@@ -343567,7 +343567,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343567
343567
|
}
|
|
343568
343568
|
],
|
|
343569
343569
|
"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--
|
|
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--docs) in Preview instead."
|
|
343571
343571
|
},
|
|
343572
343572
|
"type": {
|
|
343573
343573
|
"kind": "symbol",
|
|
@@ -343586,7 +343586,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343586
343586
|
}
|
|
343587
343587
|
],
|
|
343588
343588
|
"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--
|
|
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--docs) in Preview instead."
|
|
343590
343590
|
},
|
|
343591
343591
|
"type": {
|
|
343592
343592
|
"kind": "alias",
|
|
@@ -343604,7 +343604,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
343604
343604
|
}
|
|
343605
343605
|
],
|
|
343606
343606
|
"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--
|
|
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--docs) in Preview instead."
|
|
343608
343608
|
},
|
|
343609
343609
|
"type": {
|
|
343610
343610
|
"kind": "component",
|
|
@@ -387213,7 +387213,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
387213
387213
|
}
|
|
387214
387214
|
],
|
|
387215
387215
|
"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/
|
|
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/components-inputs-form-field--docs) from Main instead."
|
|
387217
387217
|
},
|
|
387218
387218
|
"type": {
|
|
387219
387219
|
"kind": "enhancedComponent",
|
|
@@ -405013,7 +405013,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405013
405013
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/colors.types.ts"
|
|
405014
405014
|
}
|
|
405015
405015
|
],
|
|
405016
|
-
"tags": {
|
|
405016
|
+
"tags": {
|
|
405017
|
+
"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."
|
|
405018
|
+
},
|
|
405017
405019
|
"type": {
|
|
405018
405020
|
"kind": "object",
|
|
405019
405021
|
"typeParameters": [],
|
|
@@ -405224,7 +405226,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405224
405226
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/colors.types.ts"
|
|
405225
405227
|
}
|
|
405226
405228
|
],
|
|
405227
|
-
"tags": {
|
|
405229
|
+
"tags": {
|
|
405230
|
+
"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."
|
|
405231
|
+
},
|
|
405228
405232
|
"type": {
|
|
405229
405233
|
"kind": "type",
|
|
405230
405234
|
"typeParameters": [],
|
|
@@ -405893,7 +405897,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405893
405897
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/depth.ts"
|
|
405894
405898
|
}
|
|
405895
405899
|
],
|
|
405896
|
-
"tags": {
|
|
405900
|
+
"tags": {
|
|
405901
|
+
"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."
|
|
405902
|
+
},
|
|
405897
405903
|
"type": {
|
|
405898
405904
|
"kind": "object",
|
|
405899
405905
|
"properties": [
|
|
@@ -406169,7 +406175,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406169
406175
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/depth.ts"
|
|
406170
406176
|
}
|
|
406171
406177
|
],
|
|
406172
|
-
"tags": {
|
|
406178
|
+
"tags": {
|
|
406179
|
+
"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."
|
|
406180
|
+
},
|
|
406173
406181
|
"type": {
|
|
406174
406182
|
"kind": "type",
|
|
406175
406183
|
"typeParameters": [],
|
|
@@ -406345,7 +406353,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406345
406353
|
}
|
|
406346
406354
|
],
|
|
406347
406355
|
"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```"
|
|
406356
|
+
"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```",
|
|
406357
|
+
"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
406358
|
},
|
|
406350
406359
|
"type": {
|
|
406351
406360
|
"kind": "symbol",
|
|
@@ -406363,7 +406372,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406363
406372
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406364
406373
|
}
|
|
406365
406374
|
],
|
|
406366
|
-
"tags": {
|
|
406375
|
+
"tags": {
|
|
406376
|
+
"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."
|
|
406377
|
+
},
|
|
406367
406378
|
"type": {
|
|
406368
406379
|
"kind": "object",
|
|
406369
406380
|
"properties": [
|
|
@@ -406465,7 +406476,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406465
406476
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406466
406477
|
}
|
|
406467
406478
|
],
|
|
406468
|
-
"tags": {
|
|
406479
|
+
"tags": {
|
|
406480
|
+
"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."
|
|
406481
|
+
},
|
|
406469
406482
|
"type": {
|
|
406470
406483
|
"kind": "type",
|
|
406471
406484
|
"typeParameters": [],
|
|
@@ -406490,7 +406503,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406490
406503
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406491
406504
|
}
|
|
406492
406505
|
],
|
|
406493
|
-
"tags": {
|
|
406506
|
+
"tags": {
|
|
406507
|
+
"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."
|
|
406508
|
+
},
|
|
406494
406509
|
"type": {
|
|
406495
406510
|
"kind": "type",
|
|
406496
406511
|
"typeParameters": [],
|
|
@@ -406531,7 +406546,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406531
406546
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
406532
406547
|
}
|
|
406533
406548
|
],
|
|
406534
|
-
"tags": {
|
|
406549
|
+
"tags": {
|
|
406550
|
+
"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."
|
|
406551
|
+
},
|
|
406535
406552
|
"type": {
|
|
406536
406553
|
"kind": "symbol",
|
|
406537
406554
|
"name": "CanvasBorderRadius",
|
|
@@ -406839,7 +406856,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406839
406856
|
}
|
|
406840
406857
|
],
|
|
406841
406858
|
"tags": {
|
|
406842
|
-
"deprecated": "⚠️ `spaceNumbers` has been deprecated in a future major version. Please use our
|
|
406859
|
+
"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
406860
|
},
|
|
406844
406861
|
"type": {
|
|
406845
406862
|
"kind": "object",
|
|
@@ -407028,7 +407045,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407028
407045
|
}
|
|
407029
407046
|
],
|
|
407030
407047
|
"tags": {
|
|
407031
|
-
"deprecated": "⚠️ `CanvasSpaceNumberValues` has been deprecated in a future major version. Please use our
|
|
407048
|
+
"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
407049
|
},
|
|
407033
407050
|
"type": {
|
|
407034
407051
|
"kind": "type",
|
|
@@ -407091,7 +407108,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407091
407108
|
}
|
|
407092
407109
|
],
|
|
407093
407110
|
"tags": {
|
|
407094
|
-
"deprecated": "⚠️ `spaceNumbers` has been deprecated in a future major version. Please use our
|
|
407111
|
+
"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
407112
|
},
|
|
407096
407113
|
"type": {
|
|
407097
407114
|
"kind": "symbol",
|
|
@@ -407109,7 +407126,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407109
407126
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407110
407127
|
}
|
|
407111
407128
|
],
|
|
407112
|
-
"tags": {
|
|
407129
|
+
"tags": {
|
|
407130
|
+
"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."
|
|
407131
|
+
},
|
|
407113
407132
|
"type": {
|
|
407114
407133
|
"kind": "union",
|
|
407115
407134
|
"value": [
|
|
@@ -407134,7 +407153,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407134
407153
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407135
407154
|
}
|
|
407136
407155
|
],
|
|
407137
|
-
"tags": {
|
|
407156
|
+
"tags": {
|
|
407157
|
+
"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."
|
|
407158
|
+
},
|
|
407138
407159
|
"type": {
|
|
407139
407160
|
"kind": "primitive",
|
|
407140
407161
|
"value": "string"
|
|
@@ -407143,7 +407164,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407143
407164
|
{
|
|
407144
407165
|
"name": "fontFamilies",
|
|
407145
407166
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts",
|
|
407146
|
-
"description": "### Font Family Tokens\n
|
|
407167
|
+
"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
407168
|
"declarations": [
|
|
407148
407169
|
{
|
|
407149
407170
|
"name": "fontFamilies",
|
|
@@ -407151,7 +407172,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407151
407172
|
}
|
|
407152
407173
|
],
|
|
407153
407174
|
"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```"
|
|
407175
|
+
"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```",
|
|
407176
|
+
"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
407177
|
},
|
|
407156
407178
|
"type": {
|
|
407157
407179
|
"kind": "symbol",
|
|
@@ -407169,7 +407191,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407169
407191
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407170
407192
|
}
|
|
407171
407193
|
],
|
|
407172
|
-
"tags": {
|
|
407194
|
+
"tags": {
|
|
407195
|
+
"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."
|
|
407196
|
+
},
|
|
407173
407197
|
"type": {
|
|
407174
407198
|
"kind": "object",
|
|
407175
407199
|
"properties": [
|
|
@@ -407223,7 +407247,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407223
407247
|
}
|
|
407224
407248
|
],
|
|
407225
407249
|
"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```"
|
|
407250
|
+
"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```",
|
|
407251
|
+
"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
407252
|
},
|
|
407228
407253
|
"type": {
|
|
407229
407254
|
"kind": "symbol",
|
|
@@ -407241,7 +407266,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407241
407266
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontSizes.ts"
|
|
407242
407267
|
}
|
|
407243
407268
|
],
|
|
407244
|
-
"tags": {
|
|
407269
|
+
"tags": {
|
|
407270
|
+
"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."
|
|
407271
|
+
},
|
|
407245
407272
|
"type": {
|
|
407246
407273
|
"kind": "object",
|
|
407247
407274
|
"properties": [
|
|
@@ -407462,7 +407489,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407462
407489
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontSizes.ts"
|
|
407463
407490
|
}
|
|
407464
407491
|
],
|
|
407465
|
-
"tags": {
|
|
407492
|
+
"tags": {
|
|
407493
|
+
"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."
|
|
407494
|
+
},
|
|
407466
407495
|
"type": {
|
|
407467
407496
|
"kind": "type",
|
|
407468
407497
|
"typeParameters": [],
|
|
@@ -407532,7 +407561,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407532
407561
|
}
|
|
407533
407562
|
],
|
|
407534
407563
|
"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```"
|
|
407564
|
+
"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```",
|
|
407565
|
+
"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
407566
|
},
|
|
407537
407567
|
"type": {
|
|
407538
407568
|
"kind": "symbol",
|
|
@@ -407550,7 +407580,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407550
407580
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontWeights.ts"
|
|
407551
407581
|
}
|
|
407552
407582
|
],
|
|
407553
|
-
"tags": {
|
|
407583
|
+
"tags": {
|
|
407584
|
+
"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."
|
|
407585
|
+
},
|
|
407554
407586
|
"type": {
|
|
407555
407587
|
"kind": "object",
|
|
407556
407588
|
"properties": [
|
|
@@ -407618,7 +407650,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407618
407650
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontWeights.ts"
|
|
407619
407651
|
}
|
|
407620
407652
|
],
|
|
407621
|
-
"tags": {
|
|
407653
|
+
"tags": {
|
|
407654
|
+
"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."
|
|
407655
|
+
},
|
|
407622
407656
|
"type": {
|
|
407623
407657
|
"kind": "type",
|
|
407624
407658
|
"typeParameters": [],
|
|
@@ -407644,14 +407678,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407644
407678
|
{
|
|
407645
407679
|
"name": "type",
|
|
407646
407680
|
"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-
|
|
407681
|
+
"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
407682
|
"declarations": [
|
|
407649
407683
|
{
|
|
407650
407684
|
"name": "type",
|
|
407651
407685
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts"
|
|
407652
407686
|
}
|
|
407653
407687
|
],
|
|
407654
|
-
"tags": {
|
|
407688
|
+
"tags": {
|
|
407689
|
+
"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."
|
|
407690
|
+
},
|
|
407655
407691
|
"type": {
|
|
407656
407692
|
"kind": "symbol",
|
|
407657
407693
|
"name": "CanvasType",
|
|
@@ -407668,7 +407704,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407668
407704
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts"
|
|
407669
407705
|
}
|
|
407670
407706
|
],
|
|
407671
|
-
"tags": {
|
|
407707
|
+
"tags": {
|
|
407708
|
+
"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."
|
|
407709
|
+
},
|
|
407672
407710
|
"type": {
|
|
407673
407711
|
"kind": "object",
|
|
407674
407712
|
"properties": [
|
|
@@ -407796,7 +407834,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407796
407834
|
{
|
|
407797
407835
|
"name": "levels",
|
|
407798
407836
|
"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-
|
|
407837
|
+
"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
407838
|
"declarations": [
|
|
407801
407839
|
{
|
|
407802
407840
|
"name": "levels",
|
|
@@ -407804,7 +407842,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407804
407842
|
}
|
|
407805
407843
|
],
|
|
407806
407844
|
"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```"
|
|
407845
|
+
"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```",
|
|
407846
|
+
"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
407847
|
},
|
|
407809
407848
|
"type": {
|
|
407810
407849
|
"kind": "symbol",
|
|
@@ -407822,7 +407861,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407822
407861
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/levels.ts"
|
|
407823
407862
|
}
|
|
407824
407863
|
],
|
|
407825
|
-
"tags": {
|
|
407864
|
+
"tags": {
|
|
407865
|
+
"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."
|
|
407866
|
+
},
|
|
407826
407867
|
"type": {
|
|
407827
407868
|
"kind": "object",
|
|
407828
407869
|
"properties": [
|
|
@@ -409336,7 +409377,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
409336
409377
|
{
|
|
409337
409378
|
"name": "variants",
|
|
409338
409379
|
"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-
|
|
409380
|
+
"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
409381
|
"declarations": [
|
|
409341
409382
|
{
|
|
409342
409383
|
"name": "variants",
|
|
@@ -409344,7 +409385,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
409344
409385
|
}
|
|
409345
409386
|
],
|
|
409346
409387
|
"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```"
|
|
409388
|
+
"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```",
|
|
409389
|
+
"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
409390
|
},
|
|
409349
409391
|
"type": {
|
|
409350
409392
|
"kind": "symbol",
|
|
@@ -409362,7 +409404,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
409362
409404
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/variants.ts"
|
|
409363
409405
|
}
|
|
409364
409406
|
],
|
|
409365
|
-
"tags": {
|
|
409407
|
+
"tags": {
|
|
409408
|
+
"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."
|
|
409409
|
+
},
|
|
409366
409410
|
"type": {
|
|
409367
409411
|
"kind": "object",
|
|
409368
409412
|
"properties": [
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"installBlock.d.ts","sourceRoot":"","sources":["../../../mdx/installBlock.tsx"],"names":[],"mappings":"AAMA,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,YAAY,6BAA4B,iBAAiB,
|
|
1
|
+
{"version":3,"file":"installBlock.d.ts","sourceRoot":"","sources":["../../../mdx/installBlock.tsx"],"names":[],"mappings":"AAMA,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,eAAO,MAAM,YAAY,6BAA4B,iBAAiB,4CAqCrE,CAAC"}
|
|
@@ -16,5 +16,8 @@ export const InstallBlock = ({ command, packageName }) => {
|
|
|
16
16
|
navigator.clipboard.writeText(commandRef.current.innerText);
|
|
17
17
|
}
|
|
18
18
|
};
|
|
19
|
-
return (_jsxs(Flex, { padding: "xs", backgroundColor: system.color.bg.contrast.default, borderRadius: "m", justifyContent: "space-between", alignItems: "center", flexWrap: "wrap", children: [_jsxs("pre", { ref: commandRef, children: [_jsx("span", { style: {
|
|
19
|
+
return (_jsxs(Flex, { padding: "xs", backgroundColor: system.color.bg.contrast.default, borderRadius: "m", justifyContent: "space-between", alignItems: "center", flexWrap: "wrap", children: [_jsxs("pre", { ref: commandRef, children: [_jsx("span", { style: {
|
|
20
|
+
color: cssVar(system.color.fg.primary.soft),
|
|
21
|
+
marginInlineEnd: cssVar(system.space.x2),
|
|
22
|
+
}, children: command }), _jsx("span", { style: { color: cssVar(system.color.fg.inverse) }, children: packageName })] }), _jsx(PrimaryButton, { variant: "inverse", onClick: handleCopy, size: "small", children: copied ? 'Copied' : 'Copy' })] }));
|
|
20
23
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"welcomePage.d.ts","sourceRoot":"","sources":["../../../mdx/welcomePage.tsx"],"names":[],"mappings":"AAgDA,eAAO,MAAM,WAAW,+
|
|
1
|
+
{"version":3,"file":"welcomePage.d.ts","sourceRoot":"","sources":["../../../mdx/welcomePage.tsx"],"names":[],"mappings":"AAgDA,eAAO,MAAM,WAAW,+CAmGvB,CAAC"}
|
|
@@ -41,5 +41,5 @@ const linkStyles = createStyles({
|
|
|
41
41
|
marginTop: system.space.x3,
|
|
42
42
|
});
|
|
43
43
|
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
|
|
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(SystemIcon, { color: base.magenta600, icon: rocketIcon, size: 60 }), _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(SystemIcon, { color: base.red300, icon: tokensIcon, size: 60 }), _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(SystemIcon, { color: base.teal500, icon: shapesIcon, size: 60 }), _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
45
|
};
|