@workday/canvas-kit-docs 14.0.0-alpha.1230-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 +138 -980
- 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 +84 -36
- package/dist/mdx/MAINTAINING.mdx +4 -4
- package/dist/mdx/PACKAGES.mdx +9 -10
- package/dist/mdx/labs-react/combobox/Combobox.mdx +1 -1
- package/dist/mdx/labs-react/search-form/SearchForm.mdx +21 -4
- package/dist/mdx/preview-react/_examples/mdx/examples/TextInputWithFormik.tsx +35 -28
- package/dist/mdx/preview-react/_examples/mdx/examples/TextInputWithReactHookForm.tsx +27 -21
- 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/_examples/mdx/examples/common/FilterListWithLiveStatus.tsx +8 -5
- package/dist/mdx/react/_examples/mdx/examples/common/HiddenLiveRegion.tsx +8 -5
- package/dist/mdx/react/_examples/mdx/examples/common/TextInputWithLiveError.tsx +11 -8
- package/dist/mdx/react/_examples/mdx/examples/common/VisibleLiveRegion.tsx +9 -5
- 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/mdx/preview-react/text-area/TextArea.mdx +0 -136
- package/dist/mdx/preview-react/text-area/examples/Alert.tsx +0 -35
- package/dist/mdx/preview-react/text-area/examples/Basic.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/Disabled.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/Error.tsx +0 -40
- package/dist/mdx/preview-react/text-area/examples/Grow.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/HiddenLabel.tsx +0 -22
- package/dist/mdx/preview-react/text-area/examples/LabelPositionHorizontal.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/LabelPositionVertical.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/Placeholder.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/RefForwarding.tsx +0 -28
- package/dist/mdx/preview-react/text-area/examples/Required.tsx +0 -17
- package/dist/mdx/preview-react/text-area/examples/ResizeConstraints.tsx +0 -22
- package/dist/mdx/preview-react/text-input/TextInput.mdx +0 -170
- package/dist/mdx/preview-react/text-input/examples/Alert.tsx +0 -33
- package/dist/mdx/preview-react/text-input/examples/Basic.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/Disabled.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/Error.tsx +0 -40
- package/dist/mdx/preview-react/text-input/examples/Grow.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/Hidden.tsx +0 -11
- package/dist/mdx/preview-react/text-input/examples/HiddenLabel.tsx +0 -22
- package/dist/mdx/preview-react/text-input/examples/LabelPositionHorizontal.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/LabelPositionVertical.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/Password.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/Placeholder.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/ReadOnly.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/RefForwarding.tsx +0 -28
- package/dist/mdx/preview-react/text-input/examples/Required.tsx +0 -17
- package/dist/mdx/preview-react/text-input/examples/ThemedAlert.tsx +0 -51
- package/dist/mdx/preview-react/text-input/examples/ThemedError.tsx +0 -40
- package/dist/mdx/react/_examples/mdx/SearchForm.mdx +0 -19
- package/dist/mdx/react/_examples/mdx/examples/SearchFormBasic.tsx +0 -35
package/dist/es6/lib/docs.js
CHANGED
|
@@ -2245,7 +2245,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
2245
2245
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
|
|
2246
2246
|
}
|
|
2247
2247
|
],
|
|
2248
|
-
"tags": {
|
|
2248
|
+
"tags": {
|
|
2249
|
+
"deprecated": "⚠️ `SearchFormProps` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
|
|
2250
|
+
},
|
|
2249
2251
|
"type": {
|
|
2250
2252
|
"kind": "alias",
|
|
2251
2253
|
"name": "SearchForm"
|
|
@@ -2261,7 +2263,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
2261
2263
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
|
|
2262
2264
|
}
|
|
2263
2265
|
],
|
|
2264
|
-
"tags": {
|
|
2266
|
+
"tags": {
|
|
2267
|
+
"deprecated": "⚠️ `SearchFormState` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
|
|
2268
|
+
},
|
|
2265
2269
|
"type": {
|
|
2266
2270
|
"kind": "object",
|
|
2267
2271
|
"properties": [
|
|
@@ -2329,7 +2333,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
2329
2333
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
|
|
2330
2334
|
}
|
|
2331
2335
|
],
|
|
2332
|
-
"tags": {
|
|
2336
|
+
"tags": {
|
|
2337
|
+
"deprecated": "⚠️ `searchFormStencil` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
|
|
2338
|
+
},
|
|
2333
2339
|
"type": {
|
|
2334
2340
|
"kind": "function",
|
|
2335
2341
|
"parameters": [
|
|
@@ -3033,7 +3039,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3033
3039
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
|
|
3034
3040
|
}
|
|
3035
3041
|
],
|
|
3036
|
-
"tags": {
|
|
3042
|
+
"tags": {
|
|
3043
|
+
"deprecated": "⚠️ `SearchForm` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
|
|
3044
|
+
},
|
|
3037
3045
|
"type": {
|
|
3038
3046
|
"kind": "component",
|
|
3039
3047
|
"props": [
|
|
@@ -3490,7 +3498,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3490
3498
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
|
|
3491
3499
|
}
|
|
3492
3500
|
],
|
|
3493
|
-
"tags": {
|
|
3501
|
+
"tags": {
|
|
3502
|
+
"deprecated": "⚠️ `SearchTheme` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
|
|
3503
|
+
},
|
|
3494
3504
|
"type": {
|
|
3495
3505
|
"kind": "object",
|
|
3496
3506
|
"typeParameters": [],
|
|
@@ -3533,7 +3543,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3533
3543
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
|
|
3534
3544
|
}
|
|
3535
3545
|
],
|
|
3536
|
-
"tags": {
|
|
3546
|
+
"tags": {
|
|
3547
|
+
"deprecated": "⚠️ `SearchThemeAttributes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
|
|
3548
|
+
},
|
|
3537
3549
|
"type": {
|
|
3538
3550
|
"kind": "object",
|
|
3539
3551
|
"properties": [
|
|
@@ -3703,7 +3715,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3703
3715
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
|
|
3704
3716
|
}
|
|
3705
3717
|
],
|
|
3706
|
-
"tags": {
|
|
3718
|
+
"tags": {
|
|
3719
|
+
"deprecated": "⚠️ `SearchThemes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
|
|
3720
|
+
},
|
|
3707
3721
|
"type": {
|
|
3708
3722
|
"kind": "object",
|
|
3709
3723
|
"properties": [],
|
|
@@ -3732,7 +3746,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
3732
3746
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
|
|
3733
3747
|
}
|
|
3734
3748
|
],
|
|
3735
|
-
"tags": {
|
|
3749
|
+
"tags": {
|
|
3750
|
+
"deprecated": "⚠️ `searchThemes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
|
|
3751
|
+
},
|
|
3736
3752
|
"type": {
|
|
3737
3753
|
"kind": "symbol",
|
|
3738
3754
|
"name": "SearchThemes",
|
|
@@ -10949,7 +10965,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
10949
10965
|
{
|
|
10950
10966
|
"name": "Divider",
|
|
10951
10967
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/divider/lib/Divider.tsx",
|
|
10952
|
-
"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",
|
|
10953
10969
|
"declarations": [
|
|
10954
10970
|
{
|
|
10955
10971
|
"name": "Divider",
|
|
@@ -63232,7 +63248,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63232
63248
|
}
|
|
63233
63249
|
],
|
|
63234
63250
|
"tags": {
|
|
63235
|
-
"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."
|
|
63236
63252
|
},
|
|
63237
63253
|
"type": {
|
|
63238
63254
|
"kind": "function",
|
|
@@ -63297,7 +63313,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63297
63313
|
}
|
|
63298
63314
|
],
|
|
63299
63315
|
"tags": {
|
|
63300
|
-
"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."
|
|
63301
63317
|
},
|
|
63302
63318
|
"type": {
|
|
63303
63319
|
"kind": "alias",
|
|
@@ -63315,7 +63331,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63315
63331
|
}
|
|
63316
63332
|
],
|
|
63317
63333
|
"tags": {
|
|
63318
|
-
"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."
|
|
63319
63335
|
},
|
|
63320
63336
|
"type": {
|
|
63321
63337
|
"kind": "enhancedComponent",
|
|
@@ -63561,7 +63577,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63561
63577
|
}
|
|
63562
63578
|
],
|
|
63563
63579
|
"tags": {
|
|
63564
|
-
"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."
|
|
63565
63581
|
},
|
|
63566
63582
|
"type": {
|
|
63567
63583
|
"kind": "object",
|
|
@@ -63677,7 +63693,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63677
63693
|
}
|
|
63678
63694
|
],
|
|
63679
63695
|
"tags": {
|
|
63680
|
-
"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."
|
|
63681
63697
|
},
|
|
63682
63698
|
"type": {
|
|
63683
63699
|
"kind": "object",
|
|
@@ -63793,7 +63809,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63793
63809
|
}
|
|
63794
63810
|
],
|
|
63795
63811
|
"tags": {
|
|
63796
|
-
"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."
|
|
63797
63813
|
},
|
|
63798
63814
|
"type": {
|
|
63799
63815
|
"kind": "unknown",
|
|
@@ -63812,7 +63828,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63812
63828
|
}
|
|
63813
63829
|
],
|
|
63814
63830
|
"tags": {
|
|
63815
|
-
"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."
|
|
63816
63832
|
},
|
|
63817
63833
|
"type": {
|
|
63818
63834
|
"kind": "object",
|
|
@@ -63962,7 +63978,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63962
63978
|
}
|
|
63963
63979
|
],
|
|
63964
63980
|
"tags": {
|
|
63965
|
-
"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."
|
|
63966
63982
|
},
|
|
63967
63983
|
"type": {
|
|
63968
63984
|
"kind": "unknown",
|
|
@@ -63981,7 +63997,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63981
63997
|
}
|
|
63982
63998
|
],
|
|
63983
63999
|
"tags": {
|
|
63984
|
-
"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."
|
|
63985
64001
|
},
|
|
63986
64002
|
"type": {
|
|
63987
64003
|
"kind": "object",
|
|
@@ -64110,7 +64126,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64110
64126
|
}
|
|
64111
64127
|
],
|
|
64112
64128
|
"tags": {
|
|
64113
|
-
"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."
|
|
64114
64130
|
},
|
|
64115
64131
|
"type": {
|
|
64116
64132
|
"kind": "alias",
|
|
@@ -64144,7 +64160,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64144
64160
|
}
|
|
64145
64161
|
],
|
|
64146
64162
|
"tags": {
|
|
64147
|
-
"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."
|
|
64148
64164
|
},
|
|
64149
64165
|
"type": {
|
|
64150
64166
|
"kind": "component",
|
|
@@ -64667,7 +64683,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64667
64683
|
}
|
|
64668
64684
|
],
|
|
64669
64685
|
"tags": {
|
|
64670
|
-
"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."
|
|
64671
64687
|
},
|
|
64672
64688
|
"type": {
|
|
64673
64689
|
"kind": "component",
|
|
@@ -64888,7 +64904,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64888
64904
|
}
|
|
64889
64905
|
],
|
|
64890
64906
|
"tags": {
|
|
64891
|
-
"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."
|
|
64892
64908
|
},
|
|
64893
64909
|
"type": {
|
|
64894
64910
|
"kind": "alias",
|
|
@@ -64906,7 +64922,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64906
64922
|
}
|
|
64907
64923
|
],
|
|
64908
64924
|
"tags": {
|
|
64909
|
-
"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."
|
|
64910
64926
|
},
|
|
64911
64927
|
"type": {
|
|
64912
64928
|
"kind": "component",
|
|
@@ -65066,7 +65082,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
65066
65082
|
}
|
|
65067
65083
|
],
|
|
65068
65084
|
"tags": {
|
|
65069
|
-
"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."
|
|
65070
65086
|
},
|
|
65071
65087
|
"type": {
|
|
65072
65088
|
"kind": "type",
|
|
@@ -65097,7 +65113,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
65097
65113
|
}
|
|
65098
65114
|
],
|
|
65099
65115
|
"tags": {
|
|
65100
|
-
"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."
|
|
65101
65117
|
},
|
|
65102
65118
|
"type": {
|
|
65103
65119
|
"kind": "type",
|
|
@@ -65217,7 +65233,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
65217
65233
|
}
|
|
65218
65234
|
],
|
|
65219
65235
|
"tags": {
|
|
65220
|
-
"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."
|
|
65221
65237
|
},
|
|
65222
65238
|
"type": {
|
|
65223
65239
|
"kind": "function",
|
|
@@ -68951,872 +68967,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
68951
68967
|
},
|
|
68952
68968
|
{
|
|
68953
68969
|
"kind": "property",
|
|
68954
|
-
"name": "children",
|
|
68955
|
-
"required": false,
|
|
68956
|
-
"type": {
|
|
68957
|
-
"kind": "external",
|
|
68958
|
-
"name": "ReactNode",
|
|
68959
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
68960
|
-
},
|
|
68961
|
-
"description": "",
|
|
68962
|
-
"declarations": [
|
|
68963
|
-
{
|
|
68964
|
-
"name": "children",
|
|
68965
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
68966
|
-
}
|
|
68967
|
-
],
|
|
68968
|
-
"tags": {}
|
|
68969
|
-
},
|
|
68970
|
-
{
|
|
68971
|
-
"kind": "property",
|
|
68972
|
-
"name": "as",
|
|
68973
|
-
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
|
|
68974
|
-
"tags": {},
|
|
68975
|
-
"declarations": [],
|
|
68976
|
-
"type": {
|
|
68977
|
-
"kind": "external",
|
|
68978
|
-
"name": "React.ElementType",
|
|
68979
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
68980
|
-
},
|
|
68981
|
-
"defaultValue": {
|
|
68982
|
-
"kind": "external",
|
|
68983
|
-
"name": "span",
|
|
68984
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
68985
|
-
}
|
|
68986
|
-
},
|
|
68987
|
-
{
|
|
68988
|
-
"kind": "property",
|
|
68989
|
-
"name": "ref",
|
|
68990
|
-
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
|
|
68991
|
-
"tags": {},
|
|
68992
|
-
"declarations": [],
|
|
68993
|
-
"type": {
|
|
68994
|
-
"kind": "external",
|
|
68995
|
-
"name": "React.Ref",
|
|
68996
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
68997
|
-
"typeParameters": [
|
|
68998
|
-
{
|
|
68999
|
-
"kind": "typeParameter",
|
|
69000
|
-
"name": "R",
|
|
69001
|
-
"required": true,
|
|
69002
|
-
"defaultValue": {
|
|
69003
|
-
"kind": "external",
|
|
69004
|
-
"name": "span",
|
|
69005
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
69006
|
-
}
|
|
69007
|
-
}
|
|
69008
|
-
]
|
|
69009
|
-
}
|
|
69010
|
-
}
|
|
69011
|
-
],
|
|
69012
|
-
"baseElement": {
|
|
69013
|
-
"kind": "external",
|
|
69014
|
-
"name": "span",
|
|
69015
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
69016
|
-
},
|
|
69017
|
-
"styleComponent": {
|
|
69018
|
-
"kind": "symbol",
|
|
69019
|
-
"name": "Box"
|
|
69020
|
-
}
|
|
69021
|
-
}
|
|
69022
|
-
},
|
|
69023
|
-
{
|
|
69024
|
-
"name": "TextAreaProps",
|
|
69025
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx",
|
|
69026
|
-
"description": "",
|
|
69027
|
-
"declarations": [
|
|
69028
|
-
{
|
|
69029
|
-
"name": "TextAreaProps",
|
|
69030
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
|
|
69031
|
-
}
|
|
69032
|
-
],
|
|
69033
|
-
"tags": {
|
|
69034
|
-
"deprecated": "⚠️ `TextAreaProps` in Preview has been deprecated and will be removed in a future major version. Please use [`TextArea` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textarea--docs) instead."
|
|
69035
|
-
},
|
|
69036
|
-
"type": {
|
|
69037
|
-
"kind": "alias",
|
|
69038
|
-
"name": "TextArea"
|
|
69039
|
-
}
|
|
69040
|
-
},
|
|
69041
|
-
{
|
|
69042
|
-
"name": "TextArea",
|
|
69043
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx",
|
|
69044
|
-
"description": "",
|
|
69045
|
-
"declarations": [
|
|
69046
|
-
{
|
|
69047
|
-
"name": "TextArea",
|
|
69048
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
|
|
69049
|
-
}
|
|
69050
|
-
],
|
|
69051
|
-
"tags": {
|
|
69052
|
-
"stencil": "formFieldStencil",
|
|
69053
|
-
"deprecated": "⚠️ `TextArea` in Preview has been deprecated and will be removed in a future major version. Please use [`TextArea` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textarea--docs) instead."
|
|
69054
|
-
},
|
|
69055
|
-
"type": {
|
|
69056
|
-
"kind": "enhancedComponent",
|
|
69057
|
-
"componentType": "container",
|
|
69058
|
-
"displayName": "TextArea",
|
|
69059
|
-
"props": [
|
|
69060
|
-
{
|
|
69061
|
-
"kind": "property",
|
|
69062
|
-
"name": "children",
|
|
69063
|
-
"required": true,
|
|
69064
|
-
"type": {
|
|
69065
|
-
"kind": "external",
|
|
69066
|
-
"name": "ReactNode",
|
|
69067
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69068
|
-
},
|
|
69069
|
-
"description": "Children of the Text Input. Should contain a `<TextArea.Field>`, a `<TextArea.Label>` and an optional `<TextArea.Hint>`",
|
|
69070
|
-
"declarations": [
|
|
69071
|
-
{
|
|
69072
|
-
"name": "children",
|
|
69073
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
|
|
69074
|
-
}
|
|
69075
|
-
],
|
|
69076
|
-
"tags": {}
|
|
69077
|
-
},
|
|
69078
|
-
{
|
|
69079
|
-
"kind": "property",
|
|
69080
|
-
"name": "orientation",
|
|
69081
|
-
"required": false,
|
|
69082
|
-
"type": {
|
|
69083
|
-
"kind": "union",
|
|
69084
|
-
"value": [
|
|
69085
|
-
{
|
|
69086
|
-
"kind": "string",
|
|
69087
|
-
"value": "vertical"
|
|
69088
|
-
},
|
|
69089
|
-
{
|
|
69090
|
-
"kind": "string",
|
|
69091
|
-
"value": "horizontalStart"
|
|
69092
|
-
},
|
|
69093
|
-
{
|
|
69094
|
-
"kind": "string",
|
|
69095
|
-
"value": "horizontalEnd"
|
|
69096
|
-
}
|
|
69097
|
-
]
|
|
69098
|
-
},
|
|
69099
|
-
"description": "The direction the child elements should stack. In v13, `horizontal` will be removed. Please use `horizontalStart` or `horizontalEnd` for horizontal alignment.",
|
|
69100
|
-
"declarations": [
|
|
69101
|
-
{
|
|
69102
|
-
"name": "orientation",
|
|
69103
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/form-field/lib/FormField.tsx"
|
|
69104
|
-
}
|
|
69105
|
-
],
|
|
69106
|
-
"tags": {
|
|
69107
|
-
"default": "vertical"
|
|
69108
|
-
},
|
|
69109
|
-
"defaultValue": {
|
|
69110
|
-
"kind": "symbol",
|
|
69111
|
-
"name": "vertical",
|
|
69112
|
-
"value": "vertical"
|
|
69113
|
-
}
|
|
69114
|
-
},
|
|
69115
|
-
{
|
|
69116
|
-
"kind": "property",
|
|
69117
|
-
"name": "cs",
|
|
69118
|
-
"required": false,
|
|
69119
|
-
"type": {
|
|
69120
|
-
"kind": "symbol",
|
|
69121
|
-
"name": "CSToPropsInput",
|
|
69122
|
-
"value": "CSToPropsInput"
|
|
69123
|
-
},
|
|
69124
|
-
"description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
|
|
69125
|
-
"declarations": [
|
|
69126
|
-
{
|
|
69127
|
-
"name": "cs",
|
|
69128
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
69129
|
-
}
|
|
69130
|
-
],
|
|
69131
|
-
"tags": {}
|
|
69132
|
-
},
|
|
69133
|
-
{
|
|
69134
|
-
"kind": "property",
|
|
69135
|
-
"name": "grow",
|
|
69136
|
-
"required": false,
|
|
69137
|
-
"type": {
|
|
69138
|
-
"kind": "primitive",
|
|
69139
|
-
"value": "boolean"
|
|
69140
|
-
},
|
|
69141
|
-
"description": "True if the component should grow to its container's width. False otherwise.",
|
|
69142
|
-
"declarations": [
|
|
69143
|
-
{
|
|
69144
|
-
"name": "grow",
|
|
69145
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
|
|
69146
|
-
}
|
|
69147
|
-
],
|
|
69148
|
-
"tags": {}
|
|
69149
|
-
},
|
|
69150
|
-
{
|
|
69151
|
-
"kind": "property",
|
|
69152
|
-
"name": "as",
|
|
69153
|
-
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
|
|
69154
|
-
"tags": {},
|
|
69155
|
-
"declarations": [],
|
|
69156
|
-
"type": {
|
|
69157
|
-
"kind": "external",
|
|
69158
|
-
"name": "React.ElementType",
|
|
69159
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
69160
|
-
},
|
|
69161
|
-
"defaultValue": {
|
|
69162
|
-
"kind": "external",
|
|
69163
|
-
"name": "div",
|
|
69164
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69165
|
-
}
|
|
69166
|
-
},
|
|
69167
|
-
{
|
|
69168
|
-
"kind": "property",
|
|
69169
|
-
"name": "ref",
|
|
69170
|
-
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
|
|
69171
|
-
"tags": {},
|
|
69172
|
-
"declarations": [],
|
|
69173
|
-
"type": {
|
|
69174
|
-
"kind": "external",
|
|
69175
|
-
"name": "React.Ref",
|
|
69176
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
69177
|
-
"typeParameters": [
|
|
69178
|
-
{
|
|
69179
|
-
"kind": "typeParameter",
|
|
69180
|
-
"name": "R",
|
|
69181
|
-
"required": true,
|
|
69182
|
-
"defaultValue": {
|
|
69183
|
-
"kind": "external",
|
|
69184
|
-
"name": "div",
|
|
69185
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69186
|
-
}
|
|
69187
|
-
}
|
|
69188
|
-
]
|
|
69189
|
-
}
|
|
69190
|
-
},
|
|
69191
|
-
{
|
|
69192
|
-
"kind": "property",
|
|
69193
|
-
"name": "model",
|
|
69194
|
-
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
69195
|
-
"tags": {},
|
|
69196
|
-
"declarations": [],
|
|
69197
|
-
"type": {
|
|
69198
|
-
"kind": "symbol",
|
|
69199
|
-
"name": "TextInputModel"
|
|
69200
|
-
}
|
|
69201
|
-
},
|
|
69202
|
-
{
|
|
69203
|
-
"kind": "property",
|
|
69204
|
-
"name": "elemPropsHook",
|
|
69205
|
-
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
69206
|
-
"tags": {},
|
|
69207
|
-
"declarations": [],
|
|
69208
|
-
"type": {
|
|
69209
|
-
"kind": "function",
|
|
69210
|
-
"parameters": [
|
|
69211
|
-
{
|
|
69212
|
-
"kind": "parameter",
|
|
69213
|
-
"description": "",
|
|
69214
|
-
"tags": {},
|
|
69215
|
-
"declarations": [],
|
|
69216
|
-
"name": "model",
|
|
69217
|
-
"type": {
|
|
69218
|
-
"kind": "symbol",
|
|
69219
|
-
"name": "TextInputModel"
|
|
69220
|
-
},
|
|
69221
|
-
"required": true
|
|
69222
|
-
},
|
|
69223
|
-
{
|
|
69224
|
-
"kind": "parameter",
|
|
69225
|
-
"description": "",
|
|
69226
|
-
"tags": {},
|
|
69227
|
-
"declarations": [],
|
|
69228
|
-
"name": "elemProps",
|
|
69229
|
-
"type": {
|
|
69230
|
-
"kind": "generic",
|
|
69231
|
-
"name": "TProps"
|
|
69232
|
-
}
|
|
69233
|
-
}
|
|
69234
|
-
],
|
|
69235
|
-
"returnType": {
|
|
69236
|
-
"kind": "external",
|
|
69237
|
-
"name": "HTML Attributes",
|
|
69238
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
69239
|
-
}
|
|
69240
|
-
}
|
|
69241
|
-
}
|
|
69242
|
-
],
|
|
69243
|
-
"baseElement": {
|
|
69244
|
-
"kind": "external",
|
|
69245
|
-
"name": "div",
|
|
69246
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69247
|
-
},
|
|
69248
|
-
"model": "TextInputModel",
|
|
69249
|
-
"styleComponent": {
|
|
69250
|
-
"kind": "symbol",
|
|
69251
|
-
"name": "Flex"
|
|
69252
|
-
},
|
|
69253
|
-
"subComponents": [
|
|
69254
|
-
{
|
|
69255
|
-
"name": "Field",
|
|
69256
|
-
"symbol": "TextAreaField",
|
|
69257
|
-
"description": "",
|
|
69258
|
-
"declarations": [
|
|
69259
|
-
{
|
|
69260
|
-
"name": "Field",
|
|
69261
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextArea.tsx"
|
|
69262
|
-
},
|
|
69263
|
-
{
|
|
69264
|
-
"name": "TextAreaField",
|
|
69265
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
|
|
69266
|
-
}
|
|
69267
|
-
],
|
|
69268
|
-
"tags": {}
|
|
69269
|
-
}
|
|
69270
|
-
]
|
|
69271
|
-
}
|
|
69272
|
-
},
|
|
69273
|
-
{
|
|
69274
|
-
"name": "TextAreaField",
|
|
69275
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx",
|
|
69276
|
-
"description": "",
|
|
69277
|
-
"declarations": [
|
|
69278
|
-
{
|
|
69279
|
-
"name": "TextAreaField",
|
|
69280
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-area/lib/TextAreaField.tsx"
|
|
69281
|
-
}
|
|
69282
|
-
],
|
|
69283
|
-
"tags": {
|
|
69284
|
-
"deprecated": "⚠️ `TextAreaField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField`](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-form-field--docs) in Preview instead."
|
|
69285
|
-
},
|
|
69286
|
-
"type": {
|
|
69287
|
-
"kind": "enhancedComponent",
|
|
69288
|
-
"componentType": "subcomponent",
|
|
69289
|
-
"displayName": "TextArea.Field",
|
|
69290
|
-
"props": [
|
|
69291
|
-
{
|
|
69292
|
-
"kind": "property",
|
|
69293
|
-
"name": "cs",
|
|
69294
|
-
"required": false,
|
|
69295
|
-
"type": {
|
|
69296
|
-
"kind": "symbol",
|
|
69297
|
-
"name": "CSToPropsInput",
|
|
69298
|
-
"value": "CSToPropsInput"
|
|
69299
|
-
},
|
|
69300
|
-
"description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
|
|
69301
|
-
"declarations": [
|
|
69302
|
-
{
|
|
69303
|
-
"name": "cs",
|
|
69304
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
69305
|
-
}
|
|
69306
|
-
],
|
|
69307
|
-
"tags": {}
|
|
69308
|
-
},
|
|
69309
|
-
{
|
|
69310
|
-
"kind": "property",
|
|
69311
|
-
"name": "children",
|
|
69312
|
-
"description": "",
|
|
69313
|
-
"tags": {},
|
|
69314
|
-
"declarations": [],
|
|
69315
|
-
"type": {
|
|
69316
|
-
"kind": "external",
|
|
69317
|
-
"name": "React.ReactNode",
|
|
69318
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69319
|
-
}
|
|
69320
|
-
},
|
|
69321
|
-
{
|
|
69322
|
-
"kind": "property",
|
|
69323
|
-
"name": "as",
|
|
69324
|
-
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
|
|
69325
|
-
"tags": {},
|
|
69326
|
-
"declarations": [],
|
|
69327
|
-
"type": {
|
|
69328
|
-
"kind": "external",
|
|
69329
|
-
"name": "React.ElementType",
|
|
69330
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
69331
|
-
},
|
|
69332
|
-
"defaultValue": {
|
|
69333
|
-
"kind": "external",
|
|
69334
|
-
"name": "textarea",
|
|
69335
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
|
|
69336
|
-
}
|
|
69337
|
-
},
|
|
69338
|
-
{
|
|
69339
|
-
"kind": "property",
|
|
69340
|
-
"name": "ref",
|
|
69341
|
-
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
|
|
69342
|
-
"tags": {},
|
|
69343
|
-
"declarations": [],
|
|
69344
|
-
"type": {
|
|
69345
|
-
"kind": "external",
|
|
69346
|
-
"name": "React.Ref",
|
|
69347
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
69348
|
-
"typeParameters": [
|
|
69349
|
-
{
|
|
69350
|
-
"kind": "typeParameter",
|
|
69351
|
-
"name": "R",
|
|
69352
|
-
"required": true,
|
|
69353
|
-
"defaultValue": {
|
|
69354
|
-
"kind": "external",
|
|
69355
|
-
"name": "textarea",
|
|
69356
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
|
|
69357
|
-
}
|
|
69358
|
-
}
|
|
69359
|
-
]
|
|
69360
|
-
}
|
|
69361
|
-
},
|
|
69362
|
-
{
|
|
69363
|
-
"kind": "property",
|
|
69364
|
-
"name": "model",
|
|
69365
|
-
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
69366
|
-
"tags": {},
|
|
69367
|
-
"declarations": [],
|
|
69368
|
-
"type": {
|
|
69369
|
-
"kind": "symbol",
|
|
69370
|
-
"name": "TextInputModel"
|
|
69371
|
-
}
|
|
69372
|
-
},
|
|
69373
|
-
{
|
|
69374
|
-
"kind": "property",
|
|
69375
|
-
"name": "elemPropsHook",
|
|
69376
|
-
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
69377
|
-
"tags": {},
|
|
69378
|
-
"declarations": [],
|
|
69379
|
-
"type": {
|
|
69380
|
-
"kind": "function",
|
|
69381
|
-
"parameters": [
|
|
69382
|
-
{
|
|
69383
|
-
"kind": "parameter",
|
|
69384
|
-
"description": "",
|
|
69385
|
-
"tags": {},
|
|
69386
|
-
"declarations": [],
|
|
69387
|
-
"name": "model",
|
|
69388
|
-
"type": {
|
|
69389
|
-
"kind": "symbol",
|
|
69390
|
-
"name": "TextInputModel"
|
|
69391
|
-
},
|
|
69392
|
-
"required": true
|
|
69393
|
-
},
|
|
69394
|
-
{
|
|
69395
|
-
"kind": "parameter",
|
|
69396
|
-
"description": "",
|
|
69397
|
-
"tags": {},
|
|
69398
|
-
"declarations": [],
|
|
69399
|
-
"name": "elemProps",
|
|
69400
|
-
"type": {
|
|
69401
|
-
"kind": "generic",
|
|
69402
|
-
"name": "TProps"
|
|
69403
|
-
}
|
|
69404
|
-
}
|
|
69405
|
-
],
|
|
69406
|
-
"returnType": {
|
|
69407
|
-
"kind": "external",
|
|
69408
|
-
"name": "HTML Attributes",
|
|
69409
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
69410
|
-
}
|
|
69411
|
-
}
|
|
69412
|
-
}
|
|
69413
|
-
],
|
|
69414
|
-
"baseElement": {
|
|
69415
|
-
"kind": "external",
|
|
69416
|
-
"name": "textarea",
|
|
69417
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea"
|
|
69418
|
-
},
|
|
69419
|
-
"styleComponent": {
|
|
69420
|
-
"kind": "symbol",
|
|
69421
|
-
"name": "Box"
|
|
69422
|
-
},
|
|
69423
|
-
"model": "TextInputModel"
|
|
69424
|
-
}
|
|
69425
|
-
},
|
|
69426
|
-
{
|
|
69427
|
-
"name": "useTextInputField",
|
|
69428
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputField.tsx",
|
|
69429
|
-
"description": "Adds the necessary props to a `Field` component. Used by the TextInput.Field subcomponent.",
|
|
69430
|
-
"declarations": [
|
|
69431
|
-
{
|
|
69432
|
-
"name": "useTextInputField",
|
|
69433
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputField.tsx"
|
|
69434
|
-
}
|
|
69435
|
-
],
|
|
69436
|
-
"tags": {
|
|
69437
|
-
"deprecated": "⚠️ `useTextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
|
|
69438
|
-
},
|
|
69439
|
-
"type": {
|
|
69440
|
-
"kind": "function",
|
|
69441
|
-
"name": {
|
|
69442
|
-
"kind": "symbol",
|
|
69443
|
-
"name": "createElemPropsHook"
|
|
69444
|
-
},
|
|
69445
|
-
"parameters": [
|
|
69446
|
-
{
|
|
69447
|
-
"kind": "parameter",
|
|
69448
|
-
"name": "model",
|
|
69449
|
-
"description": "",
|
|
69450
|
-
"tags": {},
|
|
69451
|
-
"declarations": [],
|
|
69452
|
-
"type": {
|
|
69453
|
-
"kind": "symbol",
|
|
69454
|
-
"name": "TextInputModel"
|
|
69455
|
-
},
|
|
69456
|
-
"required": true
|
|
69457
|
-
},
|
|
69458
|
-
{
|
|
69459
|
-
"kind": "parameter",
|
|
69460
|
-
"name": "elemProps",
|
|
69461
|
-
"description": "",
|
|
69462
|
-
"tags": {},
|
|
69463
|
-
"declarations": [],
|
|
69464
|
-
"type": {
|
|
69465
|
-
"kind": "object",
|
|
69466
|
-
"properties": []
|
|
69467
|
-
},
|
|
69468
|
-
"required": false
|
|
69469
|
-
},
|
|
69470
|
-
{
|
|
69471
|
-
"kind": "parameter",
|
|
69472
|
-
"name": "ref",
|
|
69473
|
-
"description": "",
|
|
69474
|
-
"tags": {},
|
|
69475
|
-
"declarations": [],
|
|
69476
|
-
"type": {
|
|
69477
|
-
"kind": "external",
|
|
69478
|
-
"name": "React.Ref",
|
|
69479
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html"
|
|
69480
|
-
},
|
|
69481
|
-
"required": false
|
|
69482
|
-
}
|
|
69483
|
-
],
|
|
69484
|
-
"returnType": {
|
|
69485
|
-
"kind": "object",
|
|
69486
|
-
"properties": [
|
|
69487
|
-
{
|
|
69488
|
-
"kind": "property",
|
|
69489
|
-
"name": "type",
|
|
69490
|
-
"required": true,
|
|
69491
|
-
"type": {
|
|
69492
|
-
"kind": "string",
|
|
69493
|
-
"value": "text"
|
|
69494
|
-
},
|
|
69495
|
-
"description": "",
|
|
69496
|
-
"tags": {},
|
|
69497
|
-
"declarations": []
|
|
69498
|
-
}
|
|
69499
|
-
]
|
|
69500
|
-
}
|
|
69501
|
-
}
|
|
69502
|
-
},
|
|
69503
|
-
{
|
|
69504
|
-
"name": "useTextInputModel",
|
|
69505
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputModel.ts",
|
|
69506
|
-
"description": "",
|
|
69507
|
-
"declarations": [
|
|
69508
|
-
{
|
|
69509
|
-
"name": "useTextInputModel",
|
|
69510
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/hooks/useTextInputModel.ts"
|
|
69511
|
-
}
|
|
69512
|
-
],
|
|
69513
|
-
"tags": {
|
|
69514
|
-
"deprecated": "⚠️ `useTextInputModel` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-inputs-form-field--basic) instead."
|
|
69515
|
-
},
|
|
69516
|
-
"type": {
|
|
69517
|
-
"kind": "symbol",
|
|
69518
|
-
"name": "useFormFieldModel"
|
|
69519
|
-
}
|
|
69520
|
-
},
|
|
69521
|
-
{
|
|
69522
|
-
"name": "TextInputProps",
|
|
69523
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx",
|
|
69524
|
-
"description": "",
|
|
69525
|
-
"declarations": [
|
|
69526
|
-
{
|
|
69527
|
-
"name": "TextInputProps",
|
|
69528
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx"
|
|
69529
|
-
}
|
|
69530
|
-
],
|
|
69531
|
-
"tags": {
|
|
69532
|
-
"deprecated": "⚠️ `TextInputProps` in Preview has been deprecated and will be removed in a future major version. Please use [`TextInput` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-text-input--docs) instead."
|
|
69533
|
-
},
|
|
69534
|
-
"type": {
|
|
69535
|
-
"kind": "alias",
|
|
69536
|
-
"name": "TextInput"
|
|
69537
|
-
}
|
|
69538
|
-
},
|
|
69539
|
-
{
|
|
69540
|
-
"name": "TextInput",
|
|
69541
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx",
|
|
69542
|
-
"description": "",
|
|
69543
|
-
"declarations": [
|
|
69544
|
-
{
|
|
69545
|
-
"name": "TextInput",
|
|
69546
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx"
|
|
69547
|
-
}
|
|
69548
|
-
],
|
|
69549
|
-
"tags": {
|
|
69550
|
-
"stencil": "formFieldStencil",
|
|
69551
|
-
"deprecated": "⚠️ `TextInput` in Preview has been deprecated and will be removed in a future major version. Please use [`TextInput` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-textinput--docs) instead."
|
|
69552
|
-
},
|
|
69553
|
-
"type": {
|
|
69554
|
-
"kind": "enhancedComponent",
|
|
69555
|
-
"componentType": "container",
|
|
69556
|
-
"displayName": "TextInput",
|
|
69557
|
-
"props": [
|
|
69558
|
-
{
|
|
69559
|
-
"kind": "property",
|
|
69560
|
-
"name": "orientation",
|
|
69561
|
-
"required": false,
|
|
69562
|
-
"type": {
|
|
69563
|
-
"kind": "union",
|
|
69564
|
-
"value": [
|
|
69565
|
-
{
|
|
69566
|
-
"kind": "string",
|
|
69567
|
-
"value": "vertical"
|
|
69568
|
-
},
|
|
69569
|
-
{
|
|
69570
|
-
"kind": "string",
|
|
69571
|
-
"value": "horizontalStart"
|
|
69572
|
-
},
|
|
69573
|
-
{
|
|
69574
|
-
"kind": "string",
|
|
69575
|
-
"value": "horizontalEnd"
|
|
69576
|
-
}
|
|
69577
|
-
]
|
|
69578
|
-
},
|
|
69579
|
-
"description": "The direction the child elements should stack. In v13, `horizontal` will be removed. Please use `horizontalStart` or `horizontalEnd` for horizontal alignment.",
|
|
69580
|
-
"declarations": [
|
|
69581
|
-
{
|
|
69582
|
-
"name": "orientation",
|
|
69583
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/form-field/lib/FormField.tsx"
|
|
69584
|
-
}
|
|
69585
|
-
],
|
|
69586
|
-
"tags": {
|
|
69587
|
-
"default": "vertical"
|
|
69588
|
-
},
|
|
69589
|
-
"defaultValue": {
|
|
69590
|
-
"kind": "symbol",
|
|
69591
|
-
"name": "vertical",
|
|
69592
|
-
"value": "vertical"
|
|
69593
|
-
}
|
|
69594
|
-
},
|
|
69595
|
-
{
|
|
69596
|
-
"kind": "property",
|
|
69597
|
-
"name": "children",
|
|
69598
|
-
"required": true,
|
|
69599
|
-
"type": {
|
|
69600
|
-
"kind": "external",
|
|
69601
|
-
"name": "ReactNode",
|
|
69602
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69603
|
-
},
|
|
69604
|
-
"description": "",
|
|
69605
|
-
"declarations": [
|
|
69606
|
-
{
|
|
69607
|
-
"name": "children",
|
|
69608
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/form-field/lib/FormField.tsx"
|
|
69609
|
-
}
|
|
69610
|
-
],
|
|
69611
|
-
"tags": {}
|
|
69612
|
-
},
|
|
69613
|
-
{
|
|
69614
|
-
"kind": "property",
|
|
69615
|
-
"name": "cs",
|
|
69616
|
-
"required": false,
|
|
69617
|
-
"type": {
|
|
69618
|
-
"kind": "symbol",
|
|
69619
|
-
"name": "CSToPropsInput",
|
|
69620
|
-
"value": "CSToPropsInput"
|
|
69621
|
-
},
|
|
69622
|
-
"description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
|
|
69623
|
-
"declarations": [
|
|
69624
|
-
{
|
|
69625
|
-
"name": "cs",
|
|
69626
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
69627
|
-
}
|
|
69628
|
-
],
|
|
69629
|
-
"tags": {}
|
|
69630
|
-
},
|
|
69631
|
-
{
|
|
69632
|
-
"kind": "property",
|
|
69633
|
-
"name": "grow",
|
|
68970
|
+
"name": "children",
|
|
69634
68971
|
"required": false,
|
|
69635
|
-
"type": {
|
|
69636
|
-
"kind": "primitive",
|
|
69637
|
-
"value": "boolean"
|
|
69638
|
-
},
|
|
69639
|
-
"description": "True if the component should grow to its container's width. False otherwise.",
|
|
69640
|
-
"declarations": [
|
|
69641
|
-
{
|
|
69642
|
-
"name": "grow",
|
|
69643
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
|
|
69644
|
-
}
|
|
69645
|
-
],
|
|
69646
|
-
"tags": {}
|
|
69647
|
-
},
|
|
69648
|
-
{
|
|
69649
|
-
"kind": "property",
|
|
69650
|
-
"name": "as",
|
|
69651
|
-
"description": "Optional override of the default element used by the component. Any valid tag or Component. If you provided a Component, this component should forward the ref using `React.forwardRef`and spread extra props to a root element.\n\n**Note:** Not all elements make sense and some elements may cause accessibility issues. Change this value with care.",
|
|
69652
|
-
"tags": {},
|
|
69653
|
-
"declarations": [],
|
|
69654
68972
|
"type": {
|
|
69655
68973
|
"kind": "external",
|
|
69656
|
-
"name": "
|
|
69657
|
-
"url": "https://
|
|
68974
|
+
"name": "ReactNode",
|
|
68975
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69658
68976
|
},
|
|
69659
|
-
"defaultValue": {
|
|
69660
|
-
"kind": "external",
|
|
69661
|
-
"name": "div",
|
|
69662
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69663
|
-
}
|
|
69664
|
-
},
|
|
69665
|
-
{
|
|
69666
|
-
"kind": "property",
|
|
69667
|
-
"name": "ref",
|
|
69668
|
-
"description": "Optional ref. If the component represents an element, this ref will be a reference to the real DOM element of the component. If `as` is set to an element, it will be that element. If `as` is a component, the reference will be to that component (or element if the component uses `React.forwardRef`).",
|
|
69669
|
-
"tags": {},
|
|
69670
|
-
"declarations": [],
|
|
69671
|
-
"type": {
|
|
69672
|
-
"kind": "external",
|
|
69673
|
-
"name": "React.Ref",
|
|
69674
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
69675
|
-
"typeParameters": [
|
|
69676
|
-
{
|
|
69677
|
-
"kind": "typeParameter",
|
|
69678
|
-
"name": "R",
|
|
69679
|
-
"required": true,
|
|
69680
|
-
"defaultValue": {
|
|
69681
|
-
"kind": "external",
|
|
69682
|
-
"name": "div",
|
|
69683
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69684
|
-
}
|
|
69685
|
-
}
|
|
69686
|
-
]
|
|
69687
|
-
}
|
|
69688
|
-
},
|
|
69689
|
-
{
|
|
69690
|
-
"kind": "property",
|
|
69691
|
-
"name": "model",
|
|
69692
|
-
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
69693
|
-
"tags": {},
|
|
69694
|
-
"declarations": [],
|
|
69695
|
-
"type": {
|
|
69696
|
-
"kind": "symbol",
|
|
69697
|
-
"name": "FormFieldModel"
|
|
69698
|
-
}
|
|
69699
|
-
},
|
|
69700
|
-
{
|
|
69701
|
-
"kind": "property",
|
|
69702
|
-
"name": "elemPropsHook",
|
|
69703
|
-
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
69704
|
-
"tags": {},
|
|
69705
|
-
"declarations": [],
|
|
69706
|
-
"type": {
|
|
69707
|
-
"kind": "function",
|
|
69708
|
-
"parameters": [
|
|
69709
|
-
{
|
|
69710
|
-
"kind": "parameter",
|
|
69711
|
-
"description": "",
|
|
69712
|
-
"tags": {},
|
|
69713
|
-
"declarations": [],
|
|
69714
|
-
"name": "model",
|
|
69715
|
-
"type": {
|
|
69716
|
-
"kind": "symbol",
|
|
69717
|
-
"name": "FormFieldModel"
|
|
69718
|
-
},
|
|
69719
|
-
"required": true
|
|
69720
|
-
},
|
|
69721
|
-
{
|
|
69722
|
-
"kind": "parameter",
|
|
69723
|
-
"description": "",
|
|
69724
|
-
"tags": {},
|
|
69725
|
-
"declarations": [],
|
|
69726
|
-
"name": "elemProps",
|
|
69727
|
-
"type": {
|
|
69728
|
-
"kind": "generic",
|
|
69729
|
-
"name": "TProps"
|
|
69730
|
-
}
|
|
69731
|
-
}
|
|
69732
|
-
],
|
|
69733
|
-
"returnType": {
|
|
69734
|
-
"kind": "external",
|
|
69735
|
-
"name": "HTML Attributes",
|
|
69736
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
69737
|
-
}
|
|
69738
|
-
}
|
|
69739
|
-
}
|
|
69740
|
-
],
|
|
69741
|
-
"baseElement": {
|
|
69742
|
-
"kind": "external",
|
|
69743
|
-
"name": "div",
|
|
69744
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69745
|
-
},
|
|
69746
|
-
"model": "FormFieldModel",
|
|
69747
|
-
"styleComponent": {
|
|
69748
|
-
"kind": "symbol",
|
|
69749
|
-
"name": "Flex"
|
|
69750
|
-
},
|
|
69751
|
-
"subComponents": [
|
|
69752
|
-
{
|
|
69753
|
-
"name": "Field",
|
|
69754
|
-
"symbol": "TextInputField",
|
|
69755
68977
|
"description": "",
|
|
69756
68978
|
"declarations": [
|
|
69757
68979
|
{
|
|
69758
|
-
"name": "
|
|
69759
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
69760
|
-
},
|
|
69761
|
-
{
|
|
69762
|
-
"name": "TextInputField",
|
|
69763
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInputField.tsx"
|
|
69764
|
-
}
|
|
69765
|
-
],
|
|
69766
|
-
"tags": {}
|
|
69767
|
-
}
|
|
69768
|
-
]
|
|
69769
|
-
}
|
|
69770
|
-
},
|
|
69771
|
-
{
|
|
69772
|
-
"name": "TextInputField",
|
|
69773
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInputField.tsx",
|
|
69774
|
-
"description": "",
|
|
69775
|
-
"declarations": [
|
|
69776
|
-
{
|
|
69777
|
-
"name": "TextInputField",
|
|
69778
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInputField.tsx"
|
|
69779
|
-
}
|
|
69780
|
-
],
|
|
69781
|
-
"tags": {
|
|
69782
|
-
"deprecated": "⚠️ `TextInputField` in Preview has been deprecated and will be removed in a future major version. Please use [`FormField` in Preview](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-form-field--docs) instead."
|
|
69783
|
-
},
|
|
69784
|
-
"type": {
|
|
69785
|
-
"kind": "enhancedComponent",
|
|
69786
|
-
"componentType": "subcomponent",
|
|
69787
|
-
"elemPropsHook": "useTextInputField",
|
|
69788
|
-
"displayName": "TextInput.Field",
|
|
69789
|
-
"props": [
|
|
69790
|
-
{
|
|
69791
|
-
"kind": "property",
|
|
69792
|
-
"name": "cs",
|
|
69793
|
-
"required": false,
|
|
69794
|
-
"type": {
|
|
69795
|
-
"kind": "symbol",
|
|
69796
|
-
"name": "CSToPropsInput",
|
|
69797
|
-
"value": "CSToPropsInput"
|
|
69798
|
-
},
|
|
69799
|
-
"description": "The `cs` prop takes in a single value or an array of values. You can pass the CSS class name\nreturned by {@link createStyles}, or the result of {@link createVars} and\n{@link createModifiers}. If you're extending a component already using `cs`, you can merge that\nprop in as well. Any style that is passed to the `cs` prop will override style props. If you\nwish to have styles that are overridden by the `css` prop, or styles added via the `styled`\nAPI, use {@link handleCsProp} wherever `elemProps` is used. If your component needs to also\nhandle style props, use {@link mergeStyles } instead.\n\n\n```tsx\nimport {handleCsProp} from '@workday/canvas-kit-styling';\nimport {mergeStyles} from '@workday/canvas-kit-react/layout';\n\n// ...\n\n// `handleCsProp` handles compat mode with Emotion's runtime APIs. `mergeStyles` has the same\n// function signature, but adds support for style props.\n\nreturn (\n <Element\n {...handleCsProp(elemProps, [\n myStyles,\n myModifiers({ size: 'medium' }),\n myVars({ backgroundColor: 'red' })\n ])}\n >\n {children}\n </Element>\n)\n```",
|
|
69800
|
-
"declarations": [
|
|
69801
|
-
{
|
|
69802
|
-
"name": "cs",
|
|
69803
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
68980
|
+
"name": "children",
|
|
68981
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
69804
68982
|
}
|
|
69805
68983
|
],
|
|
69806
68984
|
"tags": {}
|
|
69807
68985
|
},
|
|
69808
|
-
{
|
|
69809
|
-
"kind": "property",
|
|
69810
|
-
"name": "children",
|
|
69811
|
-
"description": "",
|
|
69812
|
-
"tags": {},
|
|
69813
|
-
"declarations": [],
|
|
69814
|
-
"type": {
|
|
69815
|
-
"kind": "external",
|
|
69816
|
-
"name": "React.ReactNode",
|
|
69817
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69818
|
-
}
|
|
69819
|
-
},
|
|
69820
68986
|
{
|
|
69821
68987
|
"kind": "property",
|
|
69822
68988
|
"name": "as",
|
|
@@ -69830,8 +68996,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69830
68996
|
},
|
|
69831
68997
|
"defaultValue": {
|
|
69832
68998
|
"kind": "external",
|
|
69833
|
-
"name": "
|
|
69834
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
68999
|
+
"name": "span",
|
|
69000
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
69835
69001
|
}
|
|
69836
69002
|
},
|
|
69837
69003
|
{
|
|
@@ -69851,75 +69017,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69851
69017
|
"required": true,
|
|
69852
69018
|
"defaultValue": {
|
|
69853
69019
|
"kind": "external",
|
|
69854
|
-
"name": "
|
|
69855
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
69020
|
+
"name": "span",
|
|
69021
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
69856
69022
|
}
|
|
69857
69023
|
}
|
|
69858
69024
|
]
|
|
69859
69025
|
}
|
|
69860
|
-
},
|
|
69861
|
-
{
|
|
69862
|
-
"kind": "property",
|
|
69863
|
-
"name": "model",
|
|
69864
|
-
"description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
|
|
69865
|
-
"tags": {},
|
|
69866
|
-
"declarations": [],
|
|
69867
|
-
"type": {
|
|
69868
|
-
"kind": "symbol",
|
|
69869
|
-
"name": "TextInputModel"
|
|
69870
|
-
}
|
|
69871
|
-
},
|
|
69872
|
-
{
|
|
69873
|
-
"kind": "property",
|
|
69874
|
-
"name": "elemPropsHook",
|
|
69875
|
-
"description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
|
|
69876
|
-
"tags": {},
|
|
69877
|
-
"declarations": [],
|
|
69878
|
-
"type": {
|
|
69879
|
-
"kind": "function",
|
|
69880
|
-
"parameters": [
|
|
69881
|
-
{
|
|
69882
|
-
"kind": "parameter",
|
|
69883
|
-
"description": "",
|
|
69884
|
-
"tags": {},
|
|
69885
|
-
"declarations": [],
|
|
69886
|
-
"name": "model",
|
|
69887
|
-
"type": {
|
|
69888
|
-
"kind": "symbol",
|
|
69889
|
-
"name": "TextInputModel"
|
|
69890
|
-
},
|
|
69891
|
-
"required": true
|
|
69892
|
-
},
|
|
69893
|
-
{
|
|
69894
|
-
"kind": "parameter",
|
|
69895
|
-
"description": "",
|
|
69896
|
-
"tags": {},
|
|
69897
|
-
"declarations": [],
|
|
69898
|
-
"name": "elemProps",
|
|
69899
|
-
"type": {
|
|
69900
|
-
"kind": "generic",
|
|
69901
|
-
"name": "TProps"
|
|
69902
|
-
}
|
|
69903
|
-
}
|
|
69904
|
-
],
|
|
69905
|
-
"returnType": {
|
|
69906
|
-
"kind": "external",
|
|
69907
|
-
"name": "HTML Attributes",
|
|
69908
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
69909
|
-
}
|
|
69910
|
-
}
|
|
69911
69026
|
}
|
|
69912
69027
|
],
|
|
69913
69028
|
"baseElement": {
|
|
69914
69029
|
"kind": "external",
|
|
69915
|
-
"name": "
|
|
69916
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
69030
|
+
"name": "span",
|
|
69031
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
69917
69032
|
},
|
|
69918
69033
|
"styleComponent": {
|
|
69919
69034
|
"kind": "symbol",
|
|
69920
69035
|
"name": "Box"
|
|
69921
|
-
}
|
|
69922
|
-
"model": "TextInputModel"
|
|
69036
|
+
}
|
|
69923
69037
|
}
|
|
69924
69038
|
},
|
|
69925
69039
|
{
|
|
@@ -196583,7 +195697,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
196583
195697
|
{
|
|
196584
195698
|
"name": "useThemedRing",
|
|
196585
195699
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts",
|
|
196586
|
-
"description": "This is a way to automatically add themed colors to your input and is helpful when showing alerts, success or errors to users.\nIt supports `error`, `alert`, and `success` states. It will try and use the corresponding\n`main` colors from your `CanvasThemePalette` unless they do not meet accessibility contrast, in\nwhich case the outer ring will use the `darkest` color. This hook will also show a `focusOutline`\nring when the input is focused. Note: You should not rely on these colors alone to differentiate\nalerts, but use them in combination with icons or hint text.\n```tsx\n// Add here jsx pragma to use css\nimport {jsx} from '@emotion/react';\nimport React from 'react';\nimport {TextInput} from '@workday/canvas-kit-
|
|
195700
|
+
"description": "This is a way to automatically add themed colors to your input and is helpful when showing alerts, success or errors to users.\nIt supports `error`, `alert`, and `success` states. It will try and use the corresponding\n`main` colors from your `CanvasThemePalette` unless they do not meet accessibility contrast, in\nwhich case the outer ring will use the `darkest` color. This hook will also show a `focusOutline`\nring when the input is focused. Note: You should not rely on these colors alone to differentiate\nalerts, but use them in combination with icons or hint text.\n```tsx\n// Add here jsx pragma to use css\nimport {jsx} from '@emotion/react';\nimport React from 'react';\nimport {FormField} from '@workday/canvas-kit-react/form-field';\nimport {TextInput} from '@workday/canvas-kit-react/text-input';\nimport {useThemedRing} from '@workday/canvas-kit-react/common';\n\nexport const MyInput = ({handleChange}) => {\n const [value, setValue] = React.useState('invalid@email');\n const handleChange = (event: React.ChangeEvent<HTMLInputElement>) => {\n setValue(event.target.value);\n };\n\n const alertStyles = useThemedRing('alert');\n\n return (\n <FormField>\n <FormField.Label>Email</FormField.Label>\n <FormField.Field css={alertStyles}>\n <FormField.Input as={TextInput} onChange={handleChange} value={value} />\n <FormField.Hint>Add a valid email</FormField.Hint>\n </FormField.Field>\n </FormField>\n );\n};\n```",
|
|
196587
195701
|
"declarations": [
|
|
196588
195702
|
{
|
|
196589
195703
|
"name": "useThemedRing",
|
|
@@ -344251,7 +343365,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
344251
343365
|
}
|
|
344252
343366
|
],
|
|
344253
343367
|
"tags": {
|
|
344254
|
-
"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."
|
|
344255
343369
|
},
|
|
344256
343370
|
"type": {
|
|
344257
343371
|
"kind": "object",
|
|
@@ -344320,7 +343434,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
344320
343434
|
}
|
|
344321
343435
|
],
|
|
344322
343436
|
"tags": {
|
|
344323
|
-
"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."
|
|
344324
343438
|
},
|
|
344325
343439
|
"type": {
|
|
344326
343440
|
"kind": "object",
|
|
@@ -344357,7 +343471,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
344357
343471
|
}
|
|
344358
343472
|
],
|
|
344359
343473
|
"tags": {
|
|
344360
|
-
"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."
|
|
344361
343475
|
},
|
|
344362
343476
|
"type": {
|
|
344363
343477
|
"kind": "object",
|
|
@@ -344453,7 +343567,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
344453
343567
|
}
|
|
344454
343568
|
],
|
|
344455
343569
|
"tags": {
|
|
344456
|
-
"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."
|
|
344457
343571
|
},
|
|
344458
343572
|
"type": {
|
|
344459
343573
|
"kind": "symbol",
|
|
@@ -344472,7 +343586,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
344472
343586
|
}
|
|
344473
343587
|
],
|
|
344474
343588
|
"tags": {
|
|
344475
|
-
"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."
|
|
344476
343590
|
},
|
|
344477
343591
|
"type": {
|
|
344478
343592
|
"kind": "alias",
|
|
@@ -344490,7 +343604,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
344490
343604
|
}
|
|
344491
343605
|
],
|
|
344492
343606
|
"tags": {
|
|
344493
|
-
"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."
|
|
344494
343608
|
},
|
|
344495
343609
|
"type": {
|
|
344496
343610
|
"kind": "component",
|
|
@@ -388099,7 +387213,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
388099
387213
|
}
|
|
388100
387214
|
],
|
|
388101
387215
|
"tags": {
|
|
388102
|
-
"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."
|
|
388103
387217
|
},
|
|
388104
387218
|
"type": {
|
|
388105
387219
|
"kind": "enhancedComponent",
|
|
@@ -405899,7 +405013,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
405899
405013
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/colors.types.ts"
|
|
405900
405014
|
}
|
|
405901
405015
|
],
|
|
405902
|
-
"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
|
+
},
|
|
405903
405019
|
"type": {
|
|
405904
405020
|
"kind": "object",
|
|
405905
405021
|
"typeParameters": [],
|
|
@@ -406110,7 +405226,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406110
405226
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/colors.types.ts"
|
|
406111
405227
|
}
|
|
406112
405228
|
],
|
|
406113
|
-
"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
|
+
},
|
|
406114
405232
|
"type": {
|
|
406115
405233
|
"kind": "type",
|
|
406116
405234
|
"typeParameters": [],
|
|
@@ -406779,7 +405897,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
406779
405897
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/depth.ts"
|
|
406780
405898
|
}
|
|
406781
405899
|
],
|
|
406782
|
-
"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
|
+
},
|
|
406783
405903
|
"type": {
|
|
406784
405904
|
"kind": "object",
|
|
406785
405905
|
"properties": [
|
|
@@ -407055,7 +406175,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407055
406175
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/depth.ts"
|
|
407056
406176
|
}
|
|
407057
406177
|
],
|
|
407058
|
-
"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
|
+
},
|
|
407059
406181
|
"type": {
|
|
407060
406182
|
"kind": "type",
|
|
407061
406183
|
"typeParameters": [],
|
|
@@ -407231,7 +406353,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407231
406353
|
}
|
|
407232
406354
|
],
|
|
407233
406355
|
"tags": {
|
|
407234
|
-
"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."
|
|
407235
406358
|
},
|
|
407236
406359
|
"type": {
|
|
407237
406360
|
"kind": "symbol",
|
|
@@ -407249,7 +406372,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407249
406372
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
407250
406373
|
}
|
|
407251
406374
|
],
|
|
407252
|
-
"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
|
+
},
|
|
407253
406378
|
"type": {
|
|
407254
406379
|
"kind": "object",
|
|
407255
406380
|
"properties": [
|
|
@@ -407351,7 +406476,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407351
406476
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
407352
406477
|
}
|
|
407353
406478
|
],
|
|
407354
|
-
"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
|
+
},
|
|
407355
406482
|
"type": {
|
|
407356
406483
|
"kind": "type",
|
|
407357
406484
|
"typeParameters": [],
|
|
@@ -407376,7 +406503,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407376
406503
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
407377
406504
|
}
|
|
407378
406505
|
],
|
|
407379
|
-
"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
|
+
},
|
|
407380
406509
|
"type": {
|
|
407381
406510
|
"kind": "type",
|
|
407382
406511
|
"typeParameters": [],
|
|
@@ -407417,7 +406546,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407417
406546
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/radius.ts"
|
|
407418
406547
|
}
|
|
407419
406548
|
],
|
|
407420
|
-
"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
|
+
},
|
|
407421
406552
|
"type": {
|
|
407422
406553
|
"kind": "symbol",
|
|
407423
406554
|
"name": "CanvasBorderRadius",
|
|
@@ -407725,7 +406856,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407725
406856
|
}
|
|
407726
406857
|
],
|
|
407727
406858
|
"tags": {
|
|
407728
|
-
"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)."
|
|
407729
406860
|
},
|
|
407730
406861
|
"type": {
|
|
407731
406862
|
"kind": "object",
|
|
@@ -407914,7 +407045,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407914
407045
|
}
|
|
407915
407046
|
],
|
|
407916
407047
|
"tags": {
|
|
407917
|
-
"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)."
|
|
407918
407049
|
},
|
|
407919
407050
|
"type": {
|
|
407920
407051
|
"kind": "type",
|
|
@@ -407977,7 +407108,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407977
407108
|
}
|
|
407978
407109
|
],
|
|
407979
407110
|
"tags": {
|
|
407980
|
-
"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)."
|
|
407981
407112
|
},
|
|
407982
407113
|
"type": {
|
|
407983
407114
|
"kind": "symbol",
|
|
@@ -407995,7 +407126,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
407995
407126
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
407996
407127
|
}
|
|
407997
407128
|
],
|
|
407998
|
-
"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
|
+
},
|
|
407999
407132
|
"type": {
|
|
408000
407133
|
"kind": "union",
|
|
408001
407134
|
"value": [
|
|
@@ -408020,7 +407153,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408020
407153
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
408021
407154
|
}
|
|
408022
407155
|
],
|
|
408023
|
-
"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
|
+
},
|
|
408024
407159
|
"type": {
|
|
408025
407160
|
"kind": "primitive",
|
|
408026
407161
|
"value": "string"
|
|
@@ -408029,7 +407164,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408029
407164
|
{
|
|
408030
407165
|
"name": "fontFamilies",
|
|
408031
407166
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts",
|
|
408032
|
-
"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.",
|
|
408033
407168
|
"declarations": [
|
|
408034
407169
|
{
|
|
408035
407170
|
"name": "fontFamilies",
|
|
@@ -408037,7 +407172,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408037
407172
|
}
|
|
408038
407173
|
],
|
|
408039
407174
|
"tags": {
|
|
408040
|
-
"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."
|
|
408041
407177
|
},
|
|
408042
407178
|
"type": {
|
|
408043
407179
|
"kind": "symbol",
|
|
@@ -408055,7 +407191,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408055
407191
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontFamilies.ts"
|
|
408056
407192
|
}
|
|
408057
407193
|
],
|
|
408058
|
-
"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
|
+
},
|
|
408059
407197
|
"type": {
|
|
408060
407198
|
"kind": "object",
|
|
408061
407199
|
"properties": [
|
|
@@ -408109,7 +407247,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408109
407247
|
}
|
|
408110
407248
|
],
|
|
408111
407249
|
"tags": {
|
|
408112
|
-
"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."
|
|
408113
407252
|
},
|
|
408114
407253
|
"type": {
|
|
408115
407254
|
"kind": "symbol",
|
|
@@ -408127,7 +407266,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408127
407266
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontSizes.ts"
|
|
408128
407267
|
}
|
|
408129
407268
|
],
|
|
408130
|
-
"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
|
+
},
|
|
408131
407272
|
"type": {
|
|
408132
407273
|
"kind": "object",
|
|
408133
407274
|
"properties": [
|
|
@@ -408348,7 +407489,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408348
407489
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontSizes.ts"
|
|
408349
407490
|
}
|
|
408350
407491
|
],
|
|
408351
|
-
"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
|
+
},
|
|
408352
407495
|
"type": {
|
|
408353
407496
|
"kind": "type",
|
|
408354
407497
|
"typeParameters": [],
|
|
@@ -408418,7 +407561,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408418
407561
|
}
|
|
408419
407562
|
],
|
|
408420
407563
|
"tags": {
|
|
408421
|
-
"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."
|
|
408422
407566
|
},
|
|
408423
407567
|
"type": {
|
|
408424
407568
|
"kind": "symbol",
|
|
@@ -408436,7 +407580,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408436
407580
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontWeights.ts"
|
|
408437
407581
|
}
|
|
408438
407582
|
],
|
|
408439
|
-
"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
|
+
},
|
|
408440
407586
|
"type": {
|
|
408441
407587
|
"kind": "object",
|
|
408442
407588
|
"properties": [
|
|
@@ -408504,7 +407650,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408504
407650
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/fontWeights.ts"
|
|
408505
407651
|
}
|
|
408506
407652
|
],
|
|
408507
|
-
"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
|
+
},
|
|
408508
407656
|
"type": {
|
|
408509
407657
|
"kind": "type",
|
|
408510
407658
|
"typeParameters": [],
|
|
@@ -408530,14 +407678,16 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408530
407678
|
{
|
|
408531
407679
|
"name": "type",
|
|
408532
407680
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts",
|
|
408533
|
-
"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)",
|
|
408534
407682
|
"declarations": [
|
|
408535
407683
|
{
|
|
408536
407684
|
"name": "type",
|
|
408537
407685
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts"
|
|
408538
407686
|
}
|
|
408539
407687
|
],
|
|
408540
|
-
"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
|
+
},
|
|
408541
407691
|
"type": {
|
|
408542
407692
|
"kind": "symbol",
|
|
408543
407693
|
"name": "CanvasType",
|
|
@@ -408554,7 +407704,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408554
407704
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/index.ts"
|
|
408555
407705
|
}
|
|
408556
407706
|
],
|
|
408557
|
-
"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
|
+
},
|
|
408558
407710
|
"type": {
|
|
408559
407711
|
"kind": "object",
|
|
408560
407712
|
"properties": [
|
|
@@ -408682,7 +407834,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408682
407834
|
{
|
|
408683
407835
|
"name": "levels",
|
|
408684
407836
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/levels.ts",
|
|
408685
|
-
"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.",
|
|
408686
407838
|
"declarations": [
|
|
408687
407839
|
{
|
|
408688
407840
|
"name": "levels",
|
|
@@ -408690,7 +407842,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408690
407842
|
}
|
|
408691
407843
|
],
|
|
408692
407844
|
"tags": {
|
|
408693
|
-
"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."
|
|
408694
407847
|
},
|
|
408695
407848
|
"type": {
|
|
408696
407849
|
"kind": "symbol",
|
|
@@ -408708,7 +407861,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
408708
407861
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/levels.ts"
|
|
408709
407862
|
}
|
|
408710
407863
|
],
|
|
408711
|
-
"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
|
+
},
|
|
408712
407867
|
"type": {
|
|
408713
407868
|
"kind": "object",
|
|
408714
407869
|
"properties": [
|
|
@@ -410222,7 +409377,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
410222
409377
|
{
|
|
410223
409378
|
"name": "variants",
|
|
410224
409379
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/variants.ts",
|
|
410225
|
-
"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.",
|
|
410226
409381
|
"declarations": [
|
|
410227
409382
|
{
|
|
410228
409383
|
"name": "variants",
|
|
@@ -410230,7 +409385,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
410230
409385
|
}
|
|
410231
409386
|
],
|
|
410232
409387
|
"tags": {
|
|
410233
|
-
"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."
|
|
410234
409390
|
},
|
|
410235
409391
|
"type": {
|
|
410236
409392
|
"kind": "symbol",
|
|
@@ -410248,7 +409404,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
410248
409404
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tokens/lib/type/variants.ts"
|
|
410249
409405
|
}
|
|
410250
409406
|
],
|
|
410251
|
-
"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
|
+
},
|
|
410252
409410
|
"type": {
|
|
410253
409411
|
"kind": "object",
|
|
410254
409412
|
"properties": [
|