@workday/canvas-kit-docs 14.0.0-alpha.1229-next.0 → 14.0.0-alpha.1233-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 +266 -1710
- package/dist/mdx/14.0-UPGRADE-GUIDE.mdx +99 -30
- package/dist/mdx/labs-react/combobox/Combobox.mdx +1 -1
- package/dist/mdx/labs-react/search-form/SearchForm.mdx +14 -2
- 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/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/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",
|
|
@@ -69021,41 +69037,72 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69021
69037
|
}
|
|
69022
69038
|
},
|
|
69023
69039
|
{
|
|
69024
|
-
"name": "
|
|
69025
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/
|
|
69040
|
+
"name": "version",
|
|
69041
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts",
|
|
69026
69042
|
"description": "",
|
|
69027
69043
|
"declarations": [
|
|
69028
69044
|
{
|
|
69029
|
-
"name": "
|
|
69030
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/
|
|
69045
|
+
"name": "version",
|
|
69046
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts"
|
|
69031
69047
|
}
|
|
69032
69048
|
],
|
|
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
|
-
},
|
|
69049
|
+
"tags": {},
|
|
69036
69050
|
"type": {
|
|
69037
|
-
"kind": "
|
|
69038
|
-
"
|
|
69051
|
+
"kind": "primitive",
|
|
69052
|
+
"value": "string"
|
|
69039
69053
|
}
|
|
69040
69054
|
},
|
|
69041
69055
|
{
|
|
69042
|
-
"name": "
|
|
69043
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
69056
|
+
"name": "fonts",
|
|
69057
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react-fonts/lib/fonts.ts",
|
|
69044
69058
|
"description": "",
|
|
69045
69059
|
"declarations": [
|
|
69046
69060
|
{
|
|
69047
|
-
"name": "
|
|
69048
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
69061
|
+
"name": "fonts",
|
|
69062
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react-fonts/lib/fonts.ts"
|
|
69049
69063
|
}
|
|
69050
69064
|
],
|
|
69051
|
-
"tags": {
|
|
69052
|
-
|
|
69053
|
-
"
|
|
69054
|
-
|
|
69065
|
+
"tags": {},
|
|
69066
|
+
"type": {
|
|
69067
|
+
"kind": "array",
|
|
69068
|
+
"value": {
|
|
69069
|
+
"kind": "symbol",
|
|
69070
|
+
"name": "CSSObject",
|
|
69071
|
+
"value": "CSSObject"
|
|
69072
|
+
}
|
|
69073
|
+
}
|
|
69074
|
+
},
|
|
69075
|
+
{
|
|
69076
|
+
"name": "ActionBarProps",
|
|
69077
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx",
|
|
69078
|
+
"description": "",
|
|
69079
|
+
"declarations": [
|
|
69080
|
+
{
|
|
69081
|
+
"name": "ActionBarProps",
|
|
69082
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69083
|
+
}
|
|
69084
|
+
],
|
|
69085
|
+
"tags": {},
|
|
69086
|
+
"type": {
|
|
69087
|
+
"kind": "alias",
|
|
69088
|
+
"name": "ActionBar"
|
|
69089
|
+
}
|
|
69090
|
+
},
|
|
69091
|
+
{
|
|
69092
|
+
"name": "ActionBar",
|
|
69093
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx",
|
|
69094
|
+
"description": "`ActionBar` is a container component that is responsible for creating an {@link ActionBarModel }\nand sharing it with its subcomponents using React context. It does not represent a real element.\n\n```tsx\n<ActionBar items={[]}>{Child components}</ActionBar>\n```\n\nAlternatively, you may pass in a model using the hoisted model pattern.\n\n```tsx\nconst model = useActionBarModel({\n items: [],\n});\n\n<ActionBar model={model}>{Child components}</ActionBar>;\n```",
|
|
69095
|
+
"declarations": [
|
|
69096
|
+
{
|
|
69097
|
+
"name": "ActionBar",
|
|
69098
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69099
|
+
}
|
|
69100
|
+
],
|
|
69101
|
+
"tags": {},
|
|
69055
69102
|
"type": {
|
|
69056
69103
|
"kind": "enhancedComponent",
|
|
69057
69104
|
"componentType": "container",
|
|
69058
|
-
"displayName": "
|
|
69105
|
+
"displayName": "ActionBar",
|
|
69059
69106
|
"props": [
|
|
69060
69107
|
{
|
|
69061
69108
|
"kind": "property",
|
|
@@ -69066,83 +69113,231 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69066
69113
|
"name": "ReactNode",
|
|
69067
69114
|
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69068
69115
|
},
|
|
69069
|
-
"description": "
|
|
69116
|
+
"description": "The contents of the ActionBar. Can be `ActionBar` children or any valid elements.",
|
|
69070
69117
|
"declarations": [
|
|
69071
69118
|
{
|
|
69072
69119
|
"name": "children",
|
|
69073
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
69120
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69074
69121
|
}
|
|
69075
69122
|
],
|
|
69076
69123
|
"tags": {}
|
|
69077
69124
|
},
|
|
69078
69125
|
{
|
|
69079
69126
|
"kind": "property",
|
|
69080
|
-
"name": "
|
|
69081
|
-
"
|
|
69127
|
+
"name": "model",
|
|
69128
|
+
"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.",
|
|
69129
|
+
"tags": {},
|
|
69130
|
+
"declarations": [],
|
|
69082
69131
|
"type": {
|
|
69083
|
-
"kind": "
|
|
69084
|
-
"
|
|
69085
|
-
|
|
69086
|
-
|
|
69087
|
-
|
|
69088
|
-
|
|
69132
|
+
"kind": "symbol",
|
|
69133
|
+
"name": "ActionBarModel"
|
|
69134
|
+
}
|
|
69135
|
+
},
|
|
69136
|
+
{
|
|
69137
|
+
"kind": "property",
|
|
69138
|
+
"name": "elemPropsHook",
|
|
69139
|
+
"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.",
|
|
69140
|
+
"tags": {},
|
|
69141
|
+
"declarations": [],
|
|
69142
|
+
"type": {
|
|
69143
|
+
"kind": "function",
|
|
69144
|
+
"parameters": [
|
|
69089
69145
|
{
|
|
69090
|
-
"kind": "
|
|
69091
|
-
"
|
|
69146
|
+
"kind": "parameter",
|
|
69147
|
+
"description": "",
|
|
69148
|
+
"tags": {},
|
|
69149
|
+
"declarations": [],
|
|
69150
|
+
"name": "model",
|
|
69151
|
+
"type": {
|
|
69152
|
+
"kind": "symbol",
|
|
69153
|
+
"name": "ActionBarModel"
|
|
69154
|
+
},
|
|
69155
|
+
"required": true
|
|
69092
69156
|
},
|
|
69093
69157
|
{
|
|
69094
|
-
"kind": "
|
|
69095
|
-
"
|
|
69158
|
+
"kind": "parameter",
|
|
69159
|
+
"description": "",
|
|
69160
|
+
"tags": {},
|
|
69161
|
+
"declarations": [],
|
|
69162
|
+
"name": "elemProps",
|
|
69163
|
+
"type": {
|
|
69164
|
+
"kind": "generic",
|
|
69165
|
+
"name": "TProps"
|
|
69166
|
+
}
|
|
69096
69167
|
}
|
|
69097
|
-
]
|
|
69098
|
-
|
|
69099
|
-
|
|
69168
|
+
],
|
|
69169
|
+
"returnType": {
|
|
69170
|
+
"kind": "external",
|
|
69171
|
+
"name": "HTML Attributes",
|
|
69172
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
69173
|
+
}
|
|
69174
|
+
}
|
|
69175
|
+
}
|
|
69176
|
+
],
|
|
69177
|
+
"model": "ActionBarModel",
|
|
69178
|
+
"subComponents": [
|
|
69179
|
+
{
|
|
69180
|
+
"name": "List",
|
|
69181
|
+
"symbol": "ActionBarList",
|
|
69182
|
+
"description": "`ActionBar.List` is a {@link Flex } element. It is a container for\n{@link ActionBarItemActionBar.Item} subcomponents. To render an overflow button for\nActionBar with overflow behavior `overflowButton` prop with overflow button component as a\nvalue should be passed.\n\n```tsx\n// without overflow\n<ActionBar.List>{ActionBar.Items}</ActionBar.List>\n\n// with overflow\n<ActionBar.List overflowButton={<ActionBar.OverflowButton aria-label=\"More actions\"/>}>\n {ActionBar.Items}\n</ActionBar.List>\n```",
|
|
69100
69183
|
"declarations": [
|
|
69101
69184
|
{
|
|
69102
|
-
"name": "
|
|
69103
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/
|
|
69185
|
+
"name": "List",
|
|
69186
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69187
|
+
},
|
|
69188
|
+
{
|
|
69189
|
+
"name": "ActionBarList",
|
|
69190
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarList.tsx"
|
|
69191
|
+
}
|
|
69192
|
+
],
|
|
69193
|
+
"tags": {}
|
|
69194
|
+
},
|
|
69195
|
+
{
|
|
69196
|
+
"name": "Item",
|
|
69197
|
+
"symbol": "ActionBarItem",
|
|
69198
|
+
"description": "`ActionBar.Item` is a `button` element, by default it's a `SecondaryButton` unless an `as`\nprop is passed.\n\n```tsx\n<ActionBar.Item as={PrimaryButton} onClick={() => console.log('first action')}>\n First Action\n</ActionBar.Item>\n```",
|
|
69199
|
+
"declarations": [
|
|
69200
|
+
{
|
|
69201
|
+
"name": "Item",
|
|
69202
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69203
|
+
},
|
|
69204
|
+
{
|
|
69205
|
+
"name": "ActionBarItem",
|
|
69206
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
69207
|
+
}
|
|
69208
|
+
],
|
|
69209
|
+
"tags": {}
|
|
69210
|
+
},
|
|
69211
|
+
{
|
|
69212
|
+
"name": "OverflowButton",
|
|
69213
|
+
"symbol": "ActionBarOverflowButton",
|
|
69214
|
+
"description": "",
|
|
69215
|
+
"declarations": [
|
|
69216
|
+
{
|
|
69217
|
+
"name": "OverflowButton",
|
|
69218
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69219
|
+
},
|
|
69220
|
+
{
|
|
69221
|
+
"name": "ActionBarOverflowButton",
|
|
69222
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarOverflowButton.tsx"
|
|
69223
|
+
}
|
|
69224
|
+
],
|
|
69225
|
+
"tags": {}
|
|
69226
|
+
},
|
|
69227
|
+
{
|
|
69228
|
+
"name": "Menu",
|
|
69229
|
+
"symbol": "Menu",
|
|
69230
|
+
"description": "The overflow menu of the ActionBar component. If there isn't enough room to render all the action\nitems, the extra actions that don't fit will be overflowed into this menu.",
|
|
69231
|
+
"declarations": [
|
|
69232
|
+
{
|
|
69233
|
+
"name": "Menu",
|
|
69234
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69104
69235
|
}
|
|
69105
69236
|
],
|
|
69106
69237
|
"tags": {
|
|
69107
|
-
"
|
|
69108
|
-
},
|
|
69109
|
-
"defaultValue": {
|
|
69110
|
-
"kind": "symbol",
|
|
69111
|
-
"name": "vertical",
|
|
69112
|
-
"value": "vertical"
|
|
69238
|
+
"example": "<ActionBar.Menu.Popper>\n <ActionBar.Menu.Card>\n <ActionBar.Menu.List>\n {(item: MyActionItem) => <ActionBar.Menu.Item>{item.text}</ActionBar.Menu.Item>}\n </ActionBar.Menu.List>\n </ActionBar.Menu.Card>\n</ActionBar.Menu.Popper>"
|
|
69113
69239
|
}
|
|
69240
|
+
}
|
|
69241
|
+
]
|
|
69242
|
+
}
|
|
69243
|
+
},
|
|
69244
|
+
{
|
|
69245
|
+
"name": "ActionBarItemProps",
|
|
69246
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
69247
|
+
"description": "",
|
|
69248
|
+
"declarations": [
|
|
69249
|
+
{
|
|
69250
|
+
"name": "ActionBarItemProps",
|
|
69251
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
69252
|
+
}
|
|
69253
|
+
],
|
|
69254
|
+
"tags": {},
|
|
69255
|
+
"type": {
|
|
69256
|
+
"kind": "alias",
|
|
69257
|
+
"name": "ActionBarItem"
|
|
69258
|
+
}
|
|
69259
|
+
},
|
|
69260
|
+
{
|
|
69261
|
+
"name": "useActionBarItem",
|
|
69262
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
69263
|
+
"description": "",
|
|
69264
|
+
"declarations": [
|
|
69265
|
+
{
|
|
69266
|
+
"name": "useActionBarItem",
|
|
69267
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
69268
|
+
}
|
|
69269
|
+
],
|
|
69270
|
+
"tags": {},
|
|
69271
|
+
"type": {
|
|
69272
|
+
"kind": "callExpression",
|
|
69273
|
+
"name": {
|
|
69274
|
+
"kind": "symbol",
|
|
69275
|
+
"name": "composeHooks"
|
|
69276
|
+
},
|
|
69277
|
+
"parameters": [
|
|
69278
|
+
{
|
|
69279
|
+
"kind": "symbol",
|
|
69280
|
+
"name": "useOverflowListItemMeasure",
|
|
69281
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
69282
|
+
"value": "useOverflowListItemMeasure"
|
|
69114
69283
|
},
|
|
69284
|
+
{
|
|
69285
|
+
"kind": "symbol",
|
|
69286
|
+
"name": "useListItemRegister",
|
|
69287
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
69288
|
+
"value": "useListItemRegister"
|
|
69289
|
+
}
|
|
69290
|
+
]
|
|
69291
|
+
}
|
|
69292
|
+
},
|
|
69293
|
+
{
|
|
69294
|
+
"name": "ActionBarItem",
|
|
69295
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
69296
|
+
"description": "",
|
|
69297
|
+
"declarations": [
|
|
69298
|
+
{
|
|
69299
|
+
"name": "ActionBarItem",
|
|
69300
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
69301
|
+
}
|
|
69302
|
+
],
|
|
69303
|
+
"tags": {},
|
|
69304
|
+
"type": {
|
|
69305
|
+
"kind": "enhancedComponent",
|
|
69306
|
+
"componentType": "subcomponent",
|
|
69307
|
+
"elemPropsHook": "useActionBarItem",
|
|
69308
|
+
"displayName": "ActionBar.Item",
|
|
69309
|
+
"props": [
|
|
69115
69310
|
{
|
|
69116
69311
|
"kind": "property",
|
|
69117
|
-
"name": "
|
|
69118
|
-
"required":
|
|
69312
|
+
"name": "children",
|
|
69313
|
+
"required": true,
|
|
69119
69314
|
"type": {
|
|
69120
|
-
"kind": "
|
|
69121
|
-
"name": "
|
|
69122
|
-
"
|
|
69315
|
+
"kind": "external",
|
|
69316
|
+
"name": "ReactNode",
|
|
69317
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
69123
69318
|
},
|
|
69124
|
-
"description": "The
|
|
69319
|
+
"description": "The contents of the action item. This will be the accessible name of the action for screen readers.\n\n```tsx\n<ActionBar.Item>First Action</ActionBar.Item>\n```",
|
|
69125
69320
|
"declarations": [
|
|
69126
69321
|
{
|
|
69127
|
-
"name": "
|
|
69128
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
69322
|
+
"name": "children",
|
|
69323
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
69129
69324
|
}
|
|
69130
69325
|
],
|
|
69131
69326
|
"tags": {}
|
|
69132
69327
|
},
|
|
69133
69328
|
{
|
|
69134
69329
|
"kind": "property",
|
|
69135
|
-
"name": "
|
|
69330
|
+
"name": "data-id",
|
|
69136
69331
|
"required": false,
|
|
69137
69332
|
"type": {
|
|
69138
69333
|
"kind": "primitive",
|
|
69139
|
-
"value": "
|
|
69334
|
+
"value": "string"
|
|
69140
69335
|
},
|
|
69141
|
-
"description": "
|
|
69336
|
+
"description": "The identifier of the action. This identifier will be used for correct overflow behavior.\nIf this property is not provided, it will default to a string representation\nof the the zero-based index of the Item when it was initialized.",
|
|
69142
69337
|
"declarations": [
|
|
69143
69338
|
{
|
|
69144
|
-
"name": "
|
|
69145
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/
|
|
69339
|
+
"name": "data-id",
|
|
69340
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
69146
69341
|
}
|
|
69147
69342
|
],
|
|
69148
69343
|
"tags": {}
|
|
@@ -69159,9 +69354,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69159
69354
|
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
69160
69355
|
},
|
|
69161
69356
|
"defaultValue": {
|
|
69162
|
-
"kind": "
|
|
69163
|
-
"name": "
|
|
69164
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69357
|
+
"kind": "symbol",
|
|
69358
|
+
"name": "SecondaryButton"
|
|
69165
69359
|
}
|
|
69166
69360
|
},
|
|
69167
69361
|
{
|
|
@@ -69180,9 +69374,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69180
69374
|
"name": "R",
|
|
69181
69375
|
"required": true,
|
|
69182
69376
|
"defaultValue": {
|
|
69183
|
-
"kind": "
|
|
69184
|
-
"name": "
|
|
69185
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
69377
|
+
"kind": "symbol",
|
|
69378
|
+
"name": "SecondaryButton"
|
|
69186
69379
|
}
|
|
69187
69380
|
}
|
|
69188
69381
|
]
|
|
@@ -69196,7 +69389,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69196
69389
|
"declarations": [],
|
|
69197
69390
|
"type": {
|
|
69198
69391
|
"kind": "symbol",
|
|
69199
|
-
"name": "
|
|
69392
|
+
"name": "ActionBarModel"
|
|
69200
69393
|
}
|
|
69201
69394
|
},
|
|
69202
69395
|
{
|
|
@@ -69216,1086 +69409,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
69216
69409
|
"name": "model",
|
|
69217
69410
|
"type": {
|
|
69218
69411
|
"kind": "symbol",
|
|
69219
|
-
"name": "
|
|
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",
|
|
69634
|
-
"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
|
-
"type": {
|
|
69655
|
-
"kind": "external",
|
|
69656
|
-
"name": "React.ElementType",
|
|
69657
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
69658
|
-
},
|
|
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
|
-
"description": "",
|
|
69756
|
-
"declarations": [
|
|
69757
|
-
{
|
|
69758
|
-
"name": "Field",
|
|
69759
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/text-input/lib/TextInput.tsx"
|
|
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"
|
|
69804
|
-
}
|
|
69805
|
-
],
|
|
69806
|
-
"tags": {}
|
|
69807
|
-
},
|
|
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
|
-
{
|
|
69821
|
-
"kind": "property",
|
|
69822
|
-
"name": "as",
|
|
69823
|
-
"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.",
|
|
69824
|
-
"tags": {},
|
|
69825
|
-
"declarations": [],
|
|
69826
|
-
"type": {
|
|
69827
|
-
"kind": "external",
|
|
69828
|
-
"name": "React.ElementType",
|
|
69829
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
69830
|
-
},
|
|
69831
|
-
"defaultValue": {
|
|
69832
|
-
"kind": "external",
|
|
69833
|
-
"name": "input",
|
|
69834
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
69835
|
-
}
|
|
69836
|
-
},
|
|
69837
|
-
{
|
|
69838
|
-
"kind": "property",
|
|
69839
|
-
"name": "ref",
|
|
69840
|
-
"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`).",
|
|
69841
|
-
"tags": {},
|
|
69842
|
-
"declarations": [],
|
|
69843
|
-
"type": {
|
|
69844
|
-
"kind": "external",
|
|
69845
|
-
"name": "React.Ref",
|
|
69846
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
69847
|
-
"typeParameters": [
|
|
69848
|
-
{
|
|
69849
|
-
"kind": "typeParameter",
|
|
69850
|
-
"name": "R",
|
|
69851
|
-
"required": true,
|
|
69852
|
-
"defaultValue": {
|
|
69853
|
-
"kind": "external",
|
|
69854
|
-
"name": "input",
|
|
69855
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
69856
|
-
}
|
|
69857
|
-
}
|
|
69858
|
-
]
|
|
69859
|
-
}
|
|
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
|
-
}
|
|
69912
|
-
],
|
|
69913
|
-
"baseElement": {
|
|
69914
|
-
"kind": "external",
|
|
69915
|
-
"name": "input",
|
|
69916
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
69917
|
-
},
|
|
69918
|
-
"styleComponent": {
|
|
69919
|
-
"kind": "symbol",
|
|
69920
|
-
"name": "Box"
|
|
69921
|
-
},
|
|
69922
|
-
"model": "TextInputModel"
|
|
69923
|
-
}
|
|
69924
|
-
},
|
|
69925
|
-
{
|
|
69926
|
-
"name": "version",
|
|
69927
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts",
|
|
69928
|
-
"description": "",
|
|
69929
|
-
"declarations": [
|
|
69930
|
-
{
|
|
69931
|
-
"name": "version",
|
|
69932
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/version.ts"
|
|
69933
|
-
}
|
|
69934
|
-
],
|
|
69935
|
-
"tags": {},
|
|
69936
|
-
"type": {
|
|
69937
|
-
"kind": "primitive",
|
|
69938
|
-
"value": "string"
|
|
69939
|
-
}
|
|
69940
|
-
},
|
|
69941
|
-
{
|
|
69942
|
-
"name": "fonts",
|
|
69943
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react-fonts/lib/fonts.ts",
|
|
69944
|
-
"description": "",
|
|
69945
|
-
"declarations": [
|
|
69946
|
-
{
|
|
69947
|
-
"name": "fonts",
|
|
69948
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react-fonts/lib/fonts.ts"
|
|
69949
|
-
}
|
|
69950
|
-
],
|
|
69951
|
-
"tags": {},
|
|
69952
|
-
"type": {
|
|
69953
|
-
"kind": "array",
|
|
69954
|
-
"value": {
|
|
69955
|
-
"kind": "symbol",
|
|
69956
|
-
"name": "CSSObject",
|
|
69957
|
-
"value": "CSSObject"
|
|
69958
|
-
}
|
|
69959
|
-
}
|
|
69960
|
-
},
|
|
69961
|
-
{
|
|
69962
|
-
"name": "ActionBarProps",
|
|
69963
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx",
|
|
69964
|
-
"description": "",
|
|
69965
|
-
"declarations": [
|
|
69966
|
-
{
|
|
69967
|
-
"name": "ActionBarProps",
|
|
69968
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69969
|
-
}
|
|
69970
|
-
],
|
|
69971
|
-
"tags": {},
|
|
69972
|
-
"type": {
|
|
69973
|
-
"kind": "alias",
|
|
69974
|
-
"name": "ActionBar"
|
|
69975
|
-
}
|
|
69976
|
-
},
|
|
69977
|
-
{
|
|
69978
|
-
"name": "ActionBar",
|
|
69979
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx",
|
|
69980
|
-
"description": "`ActionBar` is a container component that is responsible for creating an {@link ActionBarModel }\nand sharing it with its subcomponents using React context. It does not represent a real element.\n\n```tsx\n<ActionBar items={[]}>{Child components}</ActionBar>\n```\n\nAlternatively, you may pass in a model using the hoisted model pattern.\n\n```tsx\nconst model = useActionBarModel({\n items: [],\n});\n\n<ActionBar model={model}>{Child components}</ActionBar>;\n```",
|
|
69981
|
-
"declarations": [
|
|
69982
|
-
{
|
|
69983
|
-
"name": "ActionBar",
|
|
69984
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
69985
|
-
}
|
|
69986
|
-
],
|
|
69987
|
-
"tags": {},
|
|
69988
|
-
"type": {
|
|
69989
|
-
"kind": "enhancedComponent",
|
|
69990
|
-
"componentType": "container",
|
|
69991
|
-
"displayName": "ActionBar",
|
|
69992
|
-
"props": [
|
|
69993
|
-
{
|
|
69994
|
-
"kind": "property",
|
|
69995
|
-
"name": "children",
|
|
69996
|
-
"required": true,
|
|
69997
|
-
"type": {
|
|
69998
|
-
"kind": "external",
|
|
69999
|
-
"name": "ReactNode",
|
|
70000
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
70001
|
-
},
|
|
70002
|
-
"description": "The contents of the ActionBar. Can be `ActionBar` children or any valid elements.",
|
|
70003
|
-
"declarations": [
|
|
70004
|
-
{
|
|
70005
|
-
"name": "children",
|
|
70006
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
70007
|
-
}
|
|
70008
|
-
],
|
|
70009
|
-
"tags": {}
|
|
70010
|
-
},
|
|
70011
|
-
{
|
|
70012
|
-
"kind": "property",
|
|
70013
|
-
"name": "model",
|
|
70014
|
-
"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.",
|
|
70015
|
-
"tags": {},
|
|
70016
|
-
"declarations": [],
|
|
70017
|
-
"type": {
|
|
70018
|
-
"kind": "symbol",
|
|
70019
|
-
"name": "ActionBarModel"
|
|
70020
|
-
}
|
|
70021
|
-
},
|
|
70022
|
-
{
|
|
70023
|
-
"kind": "property",
|
|
70024
|
-
"name": "elemPropsHook",
|
|
70025
|
-
"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.",
|
|
70026
|
-
"tags": {},
|
|
70027
|
-
"declarations": [],
|
|
70028
|
-
"type": {
|
|
70029
|
-
"kind": "function",
|
|
70030
|
-
"parameters": [
|
|
70031
|
-
{
|
|
70032
|
-
"kind": "parameter",
|
|
70033
|
-
"description": "",
|
|
70034
|
-
"tags": {},
|
|
70035
|
-
"declarations": [],
|
|
70036
|
-
"name": "model",
|
|
70037
|
-
"type": {
|
|
70038
|
-
"kind": "symbol",
|
|
70039
|
-
"name": "ActionBarModel"
|
|
70040
|
-
},
|
|
70041
|
-
"required": true
|
|
70042
|
-
},
|
|
70043
|
-
{
|
|
70044
|
-
"kind": "parameter",
|
|
70045
|
-
"description": "",
|
|
70046
|
-
"tags": {},
|
|
70047
|
-
"declarations": [],
|
|
70048
|
-
"name": "elemProps",
|
|
70049
|
-
"type": {
|
|
70050
|
-
"kind": "generic",
|
|
70051
|
-
"name": "TProps"
|
|
70052
|
-
}
|
|
70053
|
-
}
|
|
70054
|
-
],
|
|
70055
|
-
"returnType": {
|
|
70056
|
-
"kind": "external",
|
|
70057
|
-
"name": "HTML Attributes",
|
|
70058
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
|
|
70059
|
-
}
|
|
70060
|
-
}
|
|
70061
|
-
}
|
|
70062
|
-
],
|
|
70063
|
-
"model": "ActionBarModel",
|
|
70064
|
-
"subComponents": [
|
|
70065
|
-
{
|
|
70066
|
-
"name": "List",
|
|
70067
|
-
"symbol": "ActionBarList",
|
|
70068
|
-
"description": "`ActionBar.List` is a {@link Flex } element. It is a container for\n{@link ActionBarItemActionBar.Item} subcomponents. To render an overflow button for\nActionBar with overflow behavior `overflowButton` prop with overflow button component as a\nvalue should be passed.\n\n```tsx\n// without overflow\n<ActionBar.List>{ActionBar.Items}</ActionBar.List>\n\n// with overflow\n<ActionBar.List overflowButton={<ActionBar.OverflowButton aria-label=\"More actions\"/>}>\n {ActionBar.Items}\n</ActionBar.List>\n```",
|
|
70069
|
-
"declarations": [
|
|
70070
|
-
{
|
|
70071
|
-
"name": "List",
|
|
70072
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
70073
|
-
},
|
|
70074
|
-
{
|
|
70075
|
-
"name": "ActionBarList",
|
|
70076
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarList.tsx"
|
|
70077
|
-
}
|
|
70078
|
-
],
|
|
70079
|
-
"tags": {}
|
|
70080
|
-
},
|
|
70081
|
-
{
|
|
70082
|
-
"name": "Item",
|
|
70083
|
-
"symbol": "ActionBarItem",
|
|
70084
|
-
"description": "`ActionBar.Item` is a `button` element, by default it's a `SecondaryButton` unless an `as`\nprop is passed.\n\n```tsx\n<ActionBar.Item as={PrimaryButton} onClick={() => console.log('first action')}>\n First Action\n</ActionBar.Item>\n```",
|
|
70085
|
-
"declarations": [
|
|
70086
|
-
{
|
|
70087
|
-
"name": "Item",
|
|
70088
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
70089
|
-
},
|
|
70090
|
-
{
|
|
70091
|
-
"name": "ActionBarItem",
|
|
70092
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
70093
|
-
}
|
|
70094
|
-
],
|
|
70095
|
-
"tags": {}
|
|
70096
|
-
},
|
|
70097
|
-
{
|
|
70098
|
-
"name": "OverflowButton",
|
|
70099
|
-
"symbol": "ActionBarOverflowButton",
|
|
70100
|
-
"description": "",
|
|
70101
|
-
"declarations": [
|
|
70102
|
-
{
|
|
70103
|
-
"name": "OverflowButton",
|
|
70104
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
70105
|
-
},
|
|
70106
|
-
{
|
|
70107
|
-
"name": "ActionBarOverflowButton",
|
|
70108
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarOverflowButton.tsx"
|
|
70109
|
-
}
|
|
70110
|
-
],
|
|
70111
|
-
"tags": {}
|
|
70112
|
-
},
|
|
70113
|
-
{
|
|
70114
|
-
"name": "Menu",
|
|
70115
|
-
"symbol": "Menu",
|
|
70116
|
-
"description": "The overflow menu of the ActionBar component. If there isn't enough room to render all the action\nitems, the extra actions that don't fit will be overflowed into this menu.",
|
|
70117
|
-
"declarations": [
|
|
70118
|
-
{
|
|
70119
|
-
"name": "Menu",
|
|
70120
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBar.tsx"
|
|
70121
|
-
}
|
|
70122
|
-
],
|
|
70123
|
-
"tags": {
|
|
70124
|
-
"example": "<ActionBar.Menu.Popper>\n <ActionBar.Menu.Card>\n <ActionBar.Menu.List>\n {(item: MyActionItem) => <ActionBar.Menu.Item>{item.text}</ActionBar.Menu.Item>}\n </ActionBar.Menu.List>\n </ActionBar.Menu.Card>\n</ActionBar.Menu.Popper>"
|
|
70125
|
-
}
|
|
70126
|
-
}
|
|
70127
|
-
]
|
|
70128
|
-
}
|
|
70129
|
-
},
|
|
70130
|
-
{
|
|
70131
|
-
"name": "ActionBarItemProps",
|
|
70132
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
70133
|
-
"description": "",
|
|
70134
|
-
"declarations": [
|
|
70135
|
-
{
|
|
70136
|
-
"name": "ActionBarItemProps",
|
|
70137
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
70138
|
-
}
|
|
70139
|
-
],
|
|
70140
|
-
"tags": {},
|
|
70141
|
-
"type": {
|
|
70142
|
-
"kind": "alias",
|
|
70143
|
-
"name": "ActionBarItem"
|
|
70144
|
-
}
|
|
70145
|
-
},
|
|
70146
|
-
{
|
|
70147
|
-
"name": "useActionBarItem",
|
|
70148
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
70149
|
-
"description": "",
|
|
70150
|
-
"declarations": [
|
|
70151
|
-
{
|
|
70152
|
-
"name": "useActionBarItem",
|
|
70153
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
70154
|
-
}
|
|
70155
|
-
],
|
|
70156
|
-
"tags": {},
|
|
70157
|
-
"type": {
|
|
70158
|
-
"kind": "callExpression",
|
|
70159
|
-
"name": {
|
|
70160
|
-
"kind": "symbol",
|
|
70161
|
-
"name": "composeHooks"
|
|
70162
|
-
},
|
|
70163
|
-
"parameters": [
|
|
70164
|
-
{
|
|
70165
|
-
"kind": "symbol",
|
|
70166
|
-
"name": "useOverflowListItemMeasure",
|
|
70167
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
70168
|
-
"value": "useOverflowListItemMeasure"
|
|
70169
|
-
},
|
|
70170
|
-
{
|
|
70171
|
-
"kind": "symbol",
|
|
70172
|
-
"name": "useListItemRegister",
|
|
70173
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
70174
|
-
"value": "useListItemRegister"
|
|
70175
|
-
}
|
|
70176
|
-
]
|
|
70177
|
-
}
|
|
70178
|
-
},
|
|
70179
|
-
{
|
|
70180
|
-
"name": "ActionBarItem",
|
|
70181
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx",
|
|
70182
|
-
"description": "",
|
|
70183
|
-
"declarations": [
|
|
70184
|
-
{
|
|
70185
|
-
"name": "ActionBarItem",
|
|
70186
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
70187
|
-
}
|
|
70188
|
-
],
|
|
70189
|
-
"tags": {},
|
|
70190
|
-
"type": {
|
|
70191
|
-
"kind": "enhancedComponent",
|
|
70192
|
-
"componentType": "subcomponent",
|
|
70193
|
-
"elemPropsHook": "useActionBarItem",
|
|
70194
|
-
"displayName": "ActionBar.Item",
|
|
70195
|
-
"props": [
|
|
70196
|
-
{
|
|
70197
|
-
"kind": "property",
|
|
70198
|
-
"name": "children",
|
|
70199
|
-
"required": true,
|
|
70200
|
-
"type": {
|
|
70201
|
-
"kind": "external",
|
|
70202
|
-
"name": "ReactNode",
|
|
70203
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
70204
|
-
},
|
|
70205
|
-
"description": "The contents of the action item. This will be the accessible name of the action for screen readers.\n\n```tsx\n<ActionBar.Item>First Action</ActionBar.Item>\n```",
|
|
70206
|
-
"declarations": [
|
|
70207
|
-
{
|
|
70208
|
-
"name": "children",
|
|
70209
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
70210
|
-
}
|
|
70211
|
-
],
|
|
70212
|
-
"tags": {}
|
|
70213
|
-
},
|
|
70214
|
-
{
|
|
70215
|
-
"kind": "property",
|
|
70216
|
-
"name": "data-id",
|
|
70217
|
-
"required": false,
|
|
70218
|
-
"type": {
|
|
70219
|
-
"kind": "primitive",
|
|
70220
|
-
"value": "string"
|
|
70221
|
-
},
|
|
70222
|
-
"description": "The identifier of the action. This identifier will be used for correct overflow behavior.\nIf this property is not provided, it will default to a string representation\nof the the zero-based index of the Item when it was initialized.",
|
|
70223
|
-
"declarations": [
|
|
70224
|
-
{
|
|
70225
|
-
"name": "data-id",
|
|
70226
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/action-bar/lib/ActionBarItem.tsx"
|
|
70227
|
-
}
|
|
70228
|
-
],
|
|
70229
|
-
"tags": {}
|
|
70230
|
-
},
|
|
70231
|
-
{
|
|
70232
|
-
"kind": "property",
|
|
70233
|
-
"name": "as",
|
|
70234
|
-
"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.",
|
|
70235
|
-
"tags": {},
|
|
70236
|
-
"declarations": [],
|
|
70237
|
-
"type": {
|
|
70238
|
-
"kind": "external",
|
|
70239
|
-
"name": "React.ElementType",
|
|
70240
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
70241
|
-
},
|
|
70242
|
-
"defaultValue": {
|
|
70243
|
-
"kind": "symbol",
|
|
70244
|
-
"name": "SecondaryButton"
|
|
70245
|
-
}
|
|
70246
|
-
},
|
|
70247
|
-
{
|
|
70248
|
-
"kind": "property",
|
|
70249
|
-
"name": "ref",
|
|
70250
|
-
"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`).",
|
|
70251
|
-
"tags": {},
|
|
70252
|
-
"declarations": [],
|
|
70253
|
-
"type": {
|
|
70254
|
-
"kind": "external",
|
|
70255
|
-
"name": "React.Ref",
|
|
70256
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
70257
|
-
"typeParameters": [
|
|
70258
|
-
{
|
|
70259
|
-
"kind": "typeParameter",
|
|
70260
|
-
"name": "R",
|
|
70261
|
-
"required": true,
|
|
70262
|
-
"defaultValue": {
|
|
70263
|
-
"kind": "symbol",
|
|
70264
|
-
"name": "SecondaryButton"
|
|
70265
|
-
}
|
|
70266
|
-
}
|
|
70267
|
-
]
|
|
70268
|
-
}
|
|
70269
|
-
},
|
|
70270
|
-
{
|
|
70271
|
-
"kind": "property",
|
|
70272
|
-
"name": "model",
|
|
70273
|
-
"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.",
|
|
70274
|
-
"tags": {},
|
|
70275
|
-
"declarations": [],
|
|
70276
|
-
"type": {
|
|
70277
|
-
"kind": "symbol",
|
|
70278
|
-
"name": "ActionBarModel"
|
|
70279
|
-
}
|
|
70280
|
-
},
|
|
70281
|
-
{
|
|
70282
|
-
"kind": "property",
|
|
70283
|
-
"name": "elemPropsHook",
|
|
70284
|
-
"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.",
|
|
70285
|
-
"tags": {},
|
|
70286
|
-
"declarations": [],
|
|
70287
|
-
"type": {
|
|
70288
|
-
"kind": "function",
|
|
70289
|
-
"parameters": [
|
|
70290
|
-
{
|
|
70291
|
-
"kind": "parameter",
|
|
70292
|
-
"description": "",
|
|
70293
|
-
"tags": {},
|
|
70294
|
-
"declarations": [],
|
|
70295
|
-
"name": "model",
|
|
70296
|
-
"type": {
|
|
70297
|
-
"kind": "symbol",
|
|
70298
|
-
"name": "ActionBarModel"
|
|
69412
|
+
"name": "ActionBarModel"
|
|
70299
69413
|
},
|
|
70300
69414
|
"required": true
|
|
70301
69415
|
},
|
|
@@ -193951,564 +193065,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
193951
193065
|
]
|
|
193952
193066
|
}
|
|
193953
193067
|
},
|
|
193954
|
-
{
|
|
193955
|
-
"name": "InputProviderProps",
|
|
193956
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
|
|
193957
|
-
"description": "",
|
|
193958
|
-
"declarations": [
|
|
193959
|
-
{
|
|
193960
|
-
"name": "InputProviderProps",
|
|
193961
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
193962
|
-
}
|
|
193963
|
-
],
|
|
193964
|
-
"tags": {},
|
|
193965
|
-
"type": {
|
|
193966
|
-
"kind": "alias",
|
|
193967
|
-
"name": "InputProvider"
|
|
193968
|
-
}
|
|
193969
|
-
},
|
|
193970
|
-
{
|
|
193971
|
-
"name": "InputType",
|
|
193972
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
|
|
193973
|
-
"description": "",
|
|
193974
|
-
"declarations": [
|
|
193975
|
-
{
|
|
193976
|
-
"name": "InputType",
|
|
193977
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
193978
|
-
}
|
|
193979
|
-
],
|
|
193980
|
-
"tags": {},
|
|
193981
|
-
"type": {
|
|
193982
|
-
"kind": "object",
|
|
193983
|
-
"typeParameters": [],
|
|
193984
|
-
"properties": [
|
|
193985
|
-
{
|
|
193986
|
-
"kind": "property",
|
|
193987
|
-
"name": "Initial",
|
|
193988
|
-
"type": {
|
|
193989
|
-
"kind": "string",
|
|
193990
|
-
"value": "initial"
|
|
193991
|
-
}
|
|
193992
|
-
},
|
|
193993
|
-
{
|
|
193994
|
-
"kind": "property",
|
|
193995
|
-
"name": "Keyboard",
|
|
193996
|
-
"type": {
|
|
193997
|
-
"kind": "string",
|
|
193998
|
-
"value": "keyboard"
|
|
193999
|
-
}
|
|
194000
|
-
},
|
|
194001
|
-
{
|
|
194002
|
-
"kind": "property",
|
|
194003
|
-
"name": "Mouse",
|
|
194004
|
-
"type": {
|
|
194005
|
-
"kind": "string",
|
|
194006
|
-
"value": "mouse"
|
|
194007
|
-
}
|
|
194008
|
-
},
|
|
194009
|
-
{
|
|
194010
|
-
"kind": "property",
|
|
194011
|
-
"name": "Pointer",
|
|
194012
|
-
"type": {
|
|
194013
|
-
"kind": "string",
|
|
194014
|
-
"value": "pointer"
|
|
194015
|
-
}
|
|
194016
|
-
},
|
|
194017
|
-
{
|
|
194018
|
-
"kind": "property",
|
|
194019
|
-
"name": "Touch",
|
|
194020
|
-
"type": {
|
|
194021
|
-
"kind": "string",
|
|
194022
|
-
"value": "touch"
|
|
194023
|
-
}
|
|
194024
|
-
}
|
|
194025
|
-
],
|
|
194026
|
-
"callSignatures": []
|
|
194027
|
-
}
|
|
194028
|
-
},
|
|
194029
|
-
{
|
|
194030
|
-
"name": "InputEventType",
|
|
194031
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
|
|
194032
|
-
"description": "",
|
|
194033
|
-
"declarations": [
|
|
194034
|
-
{
|
|
194035
|
-
"name": "InputEventType",
|
|
194036
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194037
|
-
}
|
|
194038
|
-
],
|
|
194039
|
-
"tags": {},
|
|
194040
|
-
"type": {
|
|
194041
|
-
"kind": "object",
|
|
194042
|
-
"typeParameters": [],
|
|
194043
|
-
"properties": [
|
|
194044
|
-
{
|
|
194045
|
-
"kind": "property",
|
|
194046
|
-
"name": "KeyDown",
|
|
194047
|
-
"type": {
|
|
194048
|
-
"kind": "string",
|
|
194049
|
-
"value": "keydown"
|
|
194050
|
-
}
|
|
194051
|
-
},
|
|
194052
|
-
{
|
|
194053
|
-
"kind": "property",
|
|
194054
|
-
"name": "KeyUp",
|
|
194055
|
-
"type": {
|
|
194056
|
-
"kind": "string",
|
|
194057
|
-
"value": "keyup"
|
|
194058
|
-
}
|
|
194059
|
-
},
|
|
194060
|
-
{
|
|
194061
|
-
"kind": "property",
|
|
194062
|
-
"name": "MouseDown",
|
|
194063
|
-
"type": {
|
|
194064
|
-
"kind": "string",
|
|
194065
|
-
"value": "mousedown"
|
|
194066
|
-
}
|
|
194067
|
-
},
|
|
194068
|
-
{
|
|
194069
|
-
"kind": "property",
|
|
194070
|
-
"name": "MouseMove",
|
|
194071
|
-
"type": {
|
|
194072
|
-
"kind": "string",
|
|
194073
|
-
"value": "mousemove"
|
|
194074
|
-
}
|
|
194075
|
-
},
|
|
194076
|
-
{
|
|
194077
|
-
"kind": "property",
|
|
194078
|
-
"name": "Wheel",
|
|
194079
|
-
"type": {
|
|
194080
|
-
"kind": "string",
|
|
194081
|
-
"value": "wheel"
|
|
194082
|
-
}
|
|
194083
|
-
},
|
|
194084
|
-
{
|
|
194085
|
-
"kind": "property",
|
|
194086
|
-
"name": "MouseWheel",
|
|
194087
|
-
"type": {
|
|
194088
|
-
"kind": "string",
|
|
194089
|
-
"value": "mousewheel"
|
|
194090
|
-
}
|
|
194091
|
-
},
|
|
194092
|
-
{
|
|
194093
|
-
"kind": "property",
|
|
194094
|
-
"name": "PointerDown",
|
|
194095
|
-
"type": {
|
|
194096
|
-
"kind": "string",
|
|
194097
|
-
"value": "pointerdown"
|
|
194098
|
-
}
|
|
194099
|
-
},
|
|
194100
|
-
{
|
|
194101
|
-
"kind": "property",
|
|
194102
|
-
"name": "PointerMove",
|
|
194103
|
-
"type": {
|
|
194104
|
-
"kind": "string",
|
|
194105
|
-
"value": "pointermove"
|
|
194106
|
-
}
|
|
194107
|
-
},
|
|
194108
|
-
{
|
|
194109
|
-
"kind": "property",
|
|
194110
|
-
"name": "TouchStart",
|
|
194111
|
-
"type": {
|
|
194112
|
-
"kind": "string",
|
|
194113
|
-
"value": "touchstart"
|
|
194114
|
-
}
|
|
194115
|
-
}
|
|
194116
|
-
],
|
|
194117
|
-
"callSignatures": []
|
|
194118
|
-
}
|
|
194119
|
-
},
|
|
194120
|
-
{
|
|
194121
|
-
"name": "inputEventMap",
|
|
194122
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
|
|
194123
|
-
"description": "",
|
|
194124
|
-
"declarations": [
|
|
194125
|
-
{
|
|
194126
|
-
"name": "inputEventMap",
|
|
194127
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194128
|
-
}
|
|
194129
|
-
],
|
|
194130
|
-
"tags": {},
|
|
194131
|
-
"type": {
|
|
194132
|
-
"kind": "object",
|
|
194133
|
-
"properties": [
|
|
194134
|
-
{
|
|
194135
|
-
"kind": "property",
|
|
194136
|
-
"name": "__computed",
|
|
194137
|
-
"defaultValue": {
|
|
194138
|
-
"kind": "property",
|
|
194139
|
-
"name": "Keyboard",
|
|
194140
|
-
"type": {
|
|
194141
|
-
"kind": "qualifiedName",
|
|
194142
|
-
"left": {
|
|
194143
|
-
"kind": "symbol",
|
|
194144
|
-
"name": "InputType",
|
|
194145
|
-
"value": "any"
|
|
194146
|
-
},
|
|
194147
|
-
"right": {
|
|
194148
|
-
"kind": "string",
|
|
194149
|
-
"value": "Keyboard"
|
|
194150
|
-
}
|
|
194151
|
-
}
|
|
194152
|
-
},
|
|
194153
|
-
"type": {
|
|
194154
|
-
"kind": "symbol",
|
|
194155
|
-
"name": "InputType",
|
|
194156
|
-
"value": "InputType"
|
|
194157
|
-
},
|
|
194158
|
-
"required": true,
|
|
194159
|
-
"description": "",
|
|
194160
|
-
"declarations": [
|
|
194161
|
-
{
|
|
194162
|
-
"name": "__computed",
|
|
194163
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194164
|
-
}
|
|
194165
|
-
],
|
|
194166
|
-
"tags": {}
|
|
194167
|
-
},
|
|
194168
|
-
{
|
|
194169
|
-
"kind": "property",
|
|
194170
|
-
"name": "__computed",
|
|
194171
|
-
"defaultValue": {
|
|
194172
|
-
"kind": "property",
|
|
194173
|
-
"name": "Keyboard",
|
|
194174
|
-
"type": {
|
|
194175
|
-
"kind": "qualifiedName",
|
|
194176
|
-
"left": {
|
|
194177
|
-
"kind": "symbol",
|
|
194178
|
-
"name": "InputType",
|
|
194179
|
-
"value": "any"
|
|
194180
|
-
},
|
|
194181
|
-
"right": {
|
|
194182
|
-
"kind": "string",
|
|
194183
|
-
"value": "Keyboard"
|
|
194184
|
-
}
|
|
194185
|
-
}
|
|
194186
|
-
},
|
|
194187
|
-
"type": {
|
|
194188
|
-
"kind": "symbol",
|
|
194189
|
-
"name": "InputType",
|
|
194190
|
-
"value": "InputType"
|
|
194191
|
-
},
|
|
194192
|
-
"required": true,
|
|
194193
|
-
"description": "",
|
|
194194
|
-
"declarations": [
|
|
194195
|
-
{
|
|
194196
|
-
"name": "__computed",
|
|
194197
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194198
|
-
}
|
|
194199
|
-
],
|
|
194200
|
-
"tags": {}
|
|
194201
|
-
},
|
|
194202
|
-
{
|
|
194203
|
-
"kind": "property",
|
|
194204
|
-
"name": "__computed",
|
|
194205
|
-
"defaultValue": {
|
|
194206
|
-
"kind": "property",
|
|
194207
|
-
"name": "Mouse",
|
|
194208
|
-
"type": {
|
|
194209
|
-
"kind": "qualifiedName",
|
|
194210
|
-
"left": {
|
|
194211
|
-
"kind": "symbol",
|
|
194212
|
-
"name": "InputType",
|
|
194213
|
-
"value": "any"
|
|
194214
|
-
},
|
|
194215
|
-
"right": {
|
|
194216
|
-
"kind": "string",
|
|
194217
|
-
"value": "Mouse"
|
|
194218
|
-
}
|
|
194219
|
-
}
|
|
194220
|
-
},
|
|
194221
|
-
"type": {
|
|
194222
|
-
"kind": "symbol",
|
|
194223
|
-
"name": "InputType",
|
|
194224
|
-
"value": "InputType"
|
|
194225
|
-
},
|
|
194226
|
-
"required": true,
|
|
194227
|
-
"description": "",
|
|
194228
|
-
"declarations": [
|
|
194229
|
-
{
|
|
194230
|
-
"name": "__computed",
|
|
194231
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194232
|
-
}
|
|
194233
|
-
],
|
|
194234
|
-
"tags": {}
|
|
194235
|
-
},
|
|
194236
|
-
{
|
|
194237
|
-
"kind": "property",
|
|
194238
|
-
"name": "__computed",
|
|
194239
|
-
"defaultValue": {
|
|
194240
|
-
"kind": "property",
|
|
194241
|
-
"name": "Mouse",
|
|
194242
|
-
"type": {
|
|
194243
|
-
"kind": "qualifiedName",
|
|
194244
|
-
"left": {
|
|
194245
|
-
"kind": "symbol",
|
|
194246
|
-
"name": "InputType",
|
|
194247
|
-
"value": "any"
|
|
194248
|
-
},
|
|
194249
|
-
"right": {
|
|
194250
|
-
"kind": "string",
|
|
194251
|
-
"value": "Mouse"
|
|
194252
|
-
}
|
|
194253
|
-
}
|
|
194254
|
-
},
|
|
194255
|
-
"type": {
|
|
194256
|
-
"kind": "symbol",
|
|
194257
|
-
"name": "InputType",
|
|
194258
|
-
"value": "InputType"
|
|
194259
|
-
},
|
|
194260
|
-
"required": true,
|
|
194261
|
-
"description": "",
|
|
194262
|
-
"declarations": [
|
|
194263
|
-
{
|
|
194264
|
-
"name": "__computed",
|
|
194265
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194266
|
-
}
|
|
194267
|
-
],
|
|
194268
|
-
"tags": {}
|
|
194269
|
-
},
|
|
194270
|
-
{
|
|
194271
|
-
"kind": "property",
|
|
194272
|
-
"name": "__computed",
|
|
194273
|
-
"defaultValue": {
|
|
194274
|
-
"kind": "property",
|
|
194275
|
-
"name": "Mouse",
|
|
194276
|
-
"type": {
|
|
194277
|
-
"kind": "qualifiedName",
|
|
194278
|
-
"left": {
|
|
194279
|
-
"kind": "symbol",
|
|
194280
|
-
"name": "InputType",
|
|
194281
|
-
"value": "any"
|
|
194282
|
-
},
|
|
194283
|
-
"right": {
|
|
194284
|
-
"kind": "string",
|
|
194285
|
-
"value": "Mouse"
|
|
194286
|
-
}
|
|
194287
|
-
}
|
|
194288
|
-
},
|
|
194289
|
-
"type": {
|
|
194290
|
-
"kind": "symbol",
|
|
194291
|
-
"name": "InputType",
|
|
194292
|
-
"value": "InputType"
|
|
194293
|
-
},
|
|
194294
|
-
"required": true,
|
|
194295
|
-
"description": "",
|
|
194296
|
-
"declarations": [
|
|
194297
|
-
{
|
|
194298
|
-
"name": "__computed",
|
|
194299
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194300
|
-
}
|
|
194301
|
-
],
|
|
194302
|
-
"tags": {}
|
|
194303
|
-
},
|
|
194304
|
-
{
|
|
194305
|
-
"kind": "property",
|
|
194306
|
-
"name": "__computed",
|
|
194307
|
-
"defaultValue": {
|
|
194308
|
-
"kind": "property",
|
|
194309
|
-
"name": "Mouse",
|
|
194310
|
-
"type": {
|
|
194311
|
-
"kind": "qualifiedName",
|
|
194312
|
-
"left": {
|
|
194313
|
-
"kind": "symbol",
|
|
194314
|
-
"name": "InputType",
|
|
194315
|
-
"value": "any"
|
|
194316
|
-
},
|
|
194317
|
-
"right": {
|
|
194318
|
-
"kind": "string",
|
|
194319
|
-
"value": "Mouse"
|
|
194320
|
-
}
|
|
194321
|
-
}
|
|
194322
|
-
},
|
|
194323
|
-
"type": {
|
|
194324
|
-
"kind": "symbol",
|
|
194325
|
-
"name": "InputType",
|
|
194326
|
-
"value": "InputType"
|
|
194327
|
-
},
|
|
194328
|
-
"required": true,
|
|
194329
|
-
"description": "",
|
|
194330
|
-
"declarations": [
|
|
194331
|
-
{
|
|
194332
|
-
"name": "__computed",
|
|
194333
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194334
|
-
}
|
|
194335
|
-
],
|
|
194336
|
-
"tags": {}
|
|
194337
|
-
},
|
|
194338
|
-
{
|
|
194339
|
-
"kind": "property",
|
|
194340
|
-
"name": "__computed",
|
|
194341
|
-
"defaultValue": {
|
|
194342
|
-
"kind": "property",
|
|
194343
|
-
"name": "Pointer",
|
|
194344
|
-
"type": {
|
|
194345
|
-
"kind": "qualifiedName",
|
|
194346
|
-
"left": {
|
|
194347
|
-
"kind": "symbol",
|
|
194348
|
-
"name": "InputType",
|
|
194349
|
-
"value": "any"
|
|
194350
|
-
},
|
|
194351
|
-
"right": {
|
|
194352
|
-
"kind": "string",
|
|
194353
|
-
"value": "Pointer"
|
|
194354
|
-
}
|
|
194355
|
-
}
|
|
194356
|
-
},
|
|
194357
|
-
"type": {
|
|
194358
|
-
"kind": "symbol",
|
|
194359
|
-
"name": "InputType",
|
|
194360
|
-
"value": "InputType"
|
|
194361
|
-
},
|
|
194362
|
-
"required": true,
|
|
194363
|
-
"description": "",
|
|
194364
|
-
"declarations": [
|
|
194365
|
-
{
|
|
194366
|
-
"name": "__computed",
|
|
194367
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194368
|
-
}
|
|
194369
|
-
],
|
|
194370
|
-
"tags": {}
|
|
194371
|
-
},
|
|
194372
|
-
{
|
|
194373
|
-
"kind": "property",
|
|
194374
|
-
"name": "__computed",
|
|
194375
|
-
"defaultValue": {
|
|
194376
|
-
"kind": "property",
|
|
194377
|
-
"name": "Pointer",
|
|
194378
|
-
"type": {
|
|
194379
|
-
"kind": "qualifiedName",
|
|
194380
|
-
"left": {
|
|
194381
|
-
"kind": "symbol",
|
|
194382
|
-
"name": "InputType",
|
|
194383
|
-
"value": "any"
|
|
194384
|
-
},
|
|
194385
|
-
"right": {
|
|
194386
|
-
"kind": "string",
|
|
194387
|
-
"value": "Pointer"
|
|
194388
|
-
}
|
|
194389
|
-
}
|
|
194390
|
-
},
|
|
194391
|
-
"type": {
|
|
194392
|
-
"kind": "symbol",
|
|
194393
|
-
"name": "InputType",
|
|
194394
|
-
"value": "InputType"
|
|
194395
|
-
},
|
|
194396
|
-
"required": true,
|
|
194397
|
-
"description": "",
|
|
194398
|
-
"declarations": [
|
|
194399
|
-
{
|
|
194400
|
-
"name": "__computed",
|
|
194401
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194402
|
-
}
|
|
194403
|
-
],
|
|
194404
|
-
"tags": {}
|
|
194405
|
-
},
|
|
194406
|
-
{
|
|
194407
|
-
"kind": "property",
|
|
194408
|
-
"name": "__computed",
|
|
194409
|
-
"defaultValue": {
|
|
194410
|
-
"kind": "property",
|
|
194411
|
-
"name": "Touch",
|
|
194412
|
-
"type": {
|
|
194413
|
-
"kind": "qualifiedName",
|
|
194414
|
-
"left": {
|
|
194415
|
-
"kind": "symbol",
|
|
194416
|
-
"name": "InputType",
|
|
194417
|
-
"value": "any"
|
|
194418
|
-
},
|
|
194419
|
-
"right": {
|
|
194420
|
-
"kind": "string",
|
|
194421
|
-
"value": "Touch"
|
|
194422
|
-
}
|
|
194423
|
-
}
|
|
194424
|
-
},
|
|
194425
|
-
"type": {
|
|
194426
|
-
"kind": "symbol",
|
|
194427
|
-
"name": "InputType",
|
|
194428
|
-
"value": "InputType"
|
|
194429
|
-
},
|
|
194430
|
-
"required": true,
|
|
194431
|
-
"description": "",
|
|
194432
|
-
"declarations": [
|
|
194433
|
-
{
|
|
194434
|
-
"name": "__computed",
|
|
194435
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194436
|
-
}
|
|
194437
|
-
],
|
|
194438
|
-
"tags": {}
|
|
194439
|
-
}
|
|
194440
|
-
]
|
|
194441
|
-
}
|
|
194442
|
-
},
|
|
194443
|
-
{
|
|
194444
|
-
"name": "InputProvider",
|
|
194445
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx",
|
|
194446
|
-
"description": "This component takes heavy inspiration from what-input (https://github.com/ten1seven/what-input)",
|
|
194447
|
-
"declarations": [
|
|
194448
|
-
{
|
|
194449
|
-
"name": "InputProvider",
|
|
194450
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194451
|
-
}
|
|
194452
|
-
],
|
|
194453
|
-
"tags": {},
|
|
194454
|
-
"type": {
|
|
194455
|
-
"kind": "component",
|
|
194456
|
-
"props": [
|
|
194457
|
-
{
|
|
194458
|
-
"kind": "property",
|
|
194459
|
-
"name": "provideIntent",
|
|
194460
|
-
"required": false,
|
|
194461
|
-
"type": {
|
|
194462
|
-
"kind": "primitive",
|
|
194463
|
-
"value": "boolean"
|
|
194464
|
-
},
|
|
194465
|
-
"description": "",
|
|
194466
|
-
"declarations": [
|
|
194467
|
-
{
|
|
194468
|
-
"name": "provideIntent",
|
|
194469
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194470
|
-
}
|
|
194471
|
-
],
|
|
194472
|
-
"tags": {}
|
|
194473
|
-
},
|
|
194474
|
-
{
|
|
194475
|
-
"kind": "property",
|
|
194476
|
-
"name": "container",
|
|
194477
|
-
"required": false,
|
|
194478
|
-
"type": {
|
|
194479
|
-
"kind": "union",
|
|
194480
|
-
"value": [
|
|
194481
|
-
{
|
|
194482
|
-
"kind": "symbol",
|
|
194483
|
-
"name": "HTMLElement",
|
|
194484
|
-
"value": "HTMLElement"
|
|
194485
|
-
},
|
|
194486
|
-
{
|
|
194487
|
-
"kind": "symbol",
|
|
194488
|
-
"name": "React.RefObject",
|
|
194489
|
-
"typeParameters": [
|
|
194490
|
-
{
|
|
194491
|
-
"kind": "symbol",
|
|
194492
|
-
"name": "HTMLElement",
|
|
194493
|
-
"value": "HTMLElement"
|
|
194494
|
-
}
|
|
194495
|
-
],
|
|
194496
|
-
"value": "RefObject<T>"
|
|
194497
|
-
}
|
|
194498
|
-
]
|
|
194499
|
-
},
|
|
194500
|
-
"description": "",
|
|
194501
|
-
"declarations": [
|
|
194502
|
-
{
|
|
194503
|
-
"name": "container",
|
|
194504
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/InputProvider.tsx"
|
|
194505
|
-
}
|
|
194506
|
-
],
|
|
194507
|
-
"tags": {}
|
|
194508
|
-
}
|
|
194509
|
-
]
|
|
194510
|
-
}
|
|
194511
|
-
},
|
|
194512
193068
|
{
|
|
194513
193069
|
"name": "dubLogoPrimary",
|
|
194514
193070
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/parts/_brand-assets.ts",
|
|
@@ -197141,7 +195697,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
197141
195697
|
{
|
|
197142
195698
|
"name": "useThemedRing",
|
|
197143
195699
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/useThemedRing.ts",
|
|
197144
|
-
"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```",
|
|
197145
195701
|
"declarations": [
|
|
197146
195702
|
{
|
|
197147
195703
|
"name": "useThemedRing",
|