@workday/canvas-kit-docs 12.0.0-alpha.822-next.0 → 12.0.0-alpha.841-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.
@@ -25818,2064 +25818,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
25818
25818
  "model": "SegmentedControlModel"
25819
25819
  }
25820
25820
  },
25821
- {
25822
- "name": "scrollIntoViewIfNeeded",
25823
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/scrolling.ts",
25824
- "description": "",
25825
- "declarations": [
25826
- {
25827
- "name": "scrollIntoViewIfNeeded",
25828
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/scrolling.ts"
25829
- }
25830
- ],
25831
- "tags": {
25832
- "deprecated": "⚠️ `scrollIntoViewIfNeeded` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
25833
- },
25834
- "type": {
25835
- "kind": "function",
25836
- "parameters": [
25837
- {
25838
- "kind": "parameter",
25839
- "name": "elem",
25840
- "type": {
25841
- "kind": "symbol",
25842
- "name": "HTMLElement",
25843
- "value": "HTMLElement"
25844
- },
25845
- "required": true,
25846
- "rest": false,
25847
- "description": "",
25848
- "declarations": [
25849
- {
25850
- "name": "elem",
25851
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/scrolling.ts"
25852
- }
25853
- ],
25854
- "tags": {}
25855
- },
25856
- {
25857
- "kind": "parameter",
25858
- "name": "centerIfNeeded",
25859
- "defaultValue": {
25860
- "kind": "boolean",
25861
- "value": true
25862
- },
25863
- "type": {
25864
- "kind": "primitive",
25865
- "value": "boolean"
25866
- },
25867
- "required": false,
25868
- "rest": false,
25869
- "description": "",
25870
- "declarations": [
25871
- {
25872
- "name": "centerIfNeeded",
25873
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/scrolling.ts"
25874
- }
25875
- ],
25876
- "tags": {}
25877
- }
25878
- ],
25879
- "members": [],
25880
- "returnType": {
25881
- "kind": "primitive",
25882
- "value": "void"
25883
- }
25884
- }
25885
- },
25886
- {
25887
- "name": "SelectProps",
25888
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/Select.tsx",
25889
- "description": "",
25890
- "declarations": [
25891
- {
25892
- "name": "SelectProps",
25893
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/Select.tsx"
25894
- }
25895
- ],
25896
- "tags": {
25897
- "deprecated": "⚠️ `SelectProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
25898
- },
25899
- "type": {
25900
- "kind": "alias",
25901
- "name": "Select"
25902
- }
25903
- },
25904
- {
25905
- "name": "Select",
25906
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/Select.tsx",
25907
- "description": "",
25908
- "declarations": [
25909
- {
25910
- "name": "Select",
25911
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/Select.tsx"
25912
- }
25913
- ],
25914
- "tags": {
25915
- "deprecated": "⚠️ `Select` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
25916
- },
25917
- "type": {
25918
- "kind": "enhancedComponent",
25919
- "componentType": "regular",
25920
- "displayName": "Select",
25921
- "props": [
25922
- {
25923
- "kind": "property",
25924
- "name": "options",
25925
- "required": true,
25926
- "type": {
25927
- "kind": "array",
25928
- "value": {
25929
- "kind": "parenthesis",
25930
- "value": {
25931
- "kind": "union",
25932
- "value": [
25933
- {
25934
- "kind": "symbol",
25935
- "name": "Option",
25936
- "value": "Option"
25937
- },
25938
- {
25939
- "kind": "primitive",
25940
- "value": "string"
25941
- }
25942
- ]
25943
- }
25944
- }
25945
- },
25946
- "description": "The options of the Select. `options` may be an array of objects, an array of strings,\nor an array that contains both objects and strings.\n\nIf `options` includes objects, each included object must adhere to the `Option` interface:\n\n* `data: object` (optional)\n* `disabled: boolean` (optional)\n* `id: string` (optional, a random `id` will be assigned to the object if one isn't provided)\n* `label: string` (optional, analogous to the text content of an `<option>`)\n* `value: string` (required, analogous to the `value` attribute of an `<option>`)\n\nIf `label` is omitted, the `value` will be used to render the option.\n\nThe `data` object is carried over to the `option` passed into the `renderOption` function where it may then be used to customize how each option is rendered.",
25947
- "declarations": [
25948
- {
25949
- "name": "options",
25950
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/Select.tsx"
25951
- }
25952
- ],
25953
- "tags": {}
25954
- },
25955
- {
25956
- "kind": "property",
25957
- "name": "error",
25958
- "required": false,
25959
- "type": {
25960
- "kind": "symbol",
25961
- "name": "ErrorType",
25962
- "value": "ErrorType"
25963
- },
25964
- "description": "The type of error associated with the Select (if applicable).",
25965
- "declarations": [
25966
- {
25967
- "name": "error",
25968
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
25969
- }
25970
- ],
25971
- "tags": {}
25972
- },
25973
- {
25974
- "kind": "property",
25975
- "name": "renderOption",
25976
- "required": false,
25977
- "type": {
25978
- "kind": "symbol",
25979
- "name": "RenderOptionFunction",
25980
- "value": "RenderOptionFunction"
25981
- },
25982
- "description": "The function called to render the content of each option.\n\nThe `option` argument passed to the function is an object which contains the following:\n\n* `data: object` (data object carried over from the corresponding option originally passed into the component)\n* `disabled: boolean`\n* `focused: boolean` (set to `true` if the option has keyboard focus)\n* `id: string`\n* `label: string`\n* `selected: boolean` (set to `true` if the option is selected)\n* `value: string`\n\nIf you omit the `renderOption` prop, each option will be rendered using a `defaultRenderOption` function provided by the component.",
25983
- "declarations": [
25984
- {
25985
- "name": "renderOption",
25986
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
25987
- }
25988
- ],
25989
- "tags": {
25990
- "default": "defaultRenderOption"
25991
- },
25992
- "defaultValue": {
25993
- "kind": "symbol",
25994
- "name": "defaultRenderOption",
25995
- "value": "defaultRenderOption"
25996
- }
25997
- },
25998
- {
25999
- "kind": "property",
26000
- "name": "renderSelected",
26001
- "required": false,
26002
- "type": {
26003
- "kind": "symbol",
26004
- "name": "RenderSelectedFunction",
26005
- "value": "RenderSelectedFunction"
26006
- },
26007
- "description": "The function called to render the selected option.\n\nThe `option` argument passed to the function is an object which contains the following:\n\n* `data: object` (data object carried over from the corresponding option originally passed into the component)\n* `disabled: boolean`\n* `id: string`\n* `label: string`\n* `value: string`\n\nIf you omit the `renderSelected` prop, each option will be rendered using a `defaultRenderSelected` function provided by the component.",
26008
- "declarations": [
26009
- {
26010
- "name": "renderSelected",
26011
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26012
- }
26013
- ],
26014
- "tags": {
26015
- "default": "defaultRenderSelected"
26016
- },
26017
- "defaultValue": {
26018
- "kind": "symbol",
26019
- "name": "defaultRenderSelected",
26020
- "value": "defaultRenderSelected"
26021
- }
26022
- },
26023
- {
26024
- "kind": "property",
26025
- "name": "value",
26026
- "required": false,
26027
- "type": {
26028
- "kind": "primitive",
26029
- "value": "string"
26030
- },
26031
- "description": "The value of the Select.",
26032
- "declarations": [
26033
- {
26034
- "name": "value",
26035
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26036
- }
26037
- ],
26038
- "tags": {}
26039
- },
26040
- {
26041
- "kind": "property",
26042
- "name": "theme",
26043
- "required": false,
26044
- "type": {
26045
- "kind": "symbol",
26046
- "name": "EmotionCanvasTheme",
26047
- "value": "EmotionCanvasTheme"
26048
- },
26049
- "description": "",
26050
- "declarations": [
26051
- {
26052
- "name": "theme",
26053
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
26054
- }
26055
- ],
26056
- "tags": {}
26057
- },
26058
- {
26059
- "kind": "property",
26060
- "name": "grow",
26061
- "required": false,
26062
- "type": {
26063
- "kind": "primitive",
26064
- "value": "boolean"
26065
- },
26066
- "description": "True if the component should grow to its container's width. False otherwise.",
26067
- "declarations": [
26068
- {
26069
- "name": "grow",
26070
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
26071
- }
26072
- ],
26073
- "tags": {}
26074
- },
26075
- {
26076
- "kind": "property",
26077
- "name": "children",
26078
- "description": "",
26079
- "tags": {},
26080
- "declarations": [],
26081
- "type": {
26082
- "kind": "external",
26083
- "name": "React.ReactNode",
26084
- "url": "https://reactjs.org/docs/rendering-elements.html"
26085
- }
26086
- },
26087
- {
26088
- "kind": "property",
26089
- "name": "as",
26090
- "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.",
26091
- "tags": {},
26092
- "declarations": [],
26093
- "type": {
26094
- "kind": "external",
26095
- "name": "React.ElementType",
26096
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
26097
- },
26098
- "defaultValue": {
26099
- "kind": "external",
26100
- "name": "button",
26101
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
26102
- }
26103
- },
26104
- {
26105
- "kind": "property",
26106
- "name": "ref",
26107
- "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`).",
26108
- "tags": {},
26109
- "declarations": [],
26110
- "type": {
26111
- "kind": "external",
26112
- "name": "React.Ref",
26113
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
26114
- "typeParameters": [
26115
- {
26116
- "kind": "typeParameter",
26117
- "name": "R",
26118
- "required": true,
26119
- "defaultValue": {
26120
- "kind": "external",
26121
- "name": "button",
26122
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
26123
- }
26124
- }
26125
- ]
26126
- }
26127
- }
26128
- ],
26129
- "baseElement": {
26130
- "kind": "external",
26131
- "name": "button",
26132
- "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
26133
- },
26134
- "subComponents": [
26135
- {
26136
- "name": "ErrorType",
26137
- "symbol": "ErrorType",
26138
- "description": "",
26139
- "declarations": [
26140
- {
26141
- "name": "ErrorType",
26142
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/Select.tsx"
26143
- }
26144
- ],
26145
- "tags": {}
26146
- }
26147
- ]
26148
- }
26149
- },
26150
- {
26151
- "name": "Option",
26152
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26153
- "description": "",
26154
- "declarations": [
26155
- {
26156
- "name": "Option",
26157
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26158
- }
26159
- ],
26160
- "tags": {
26161
- "deprecated": "⚠️ `Option` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26162
- },
26163
- "type": {
26164
- "kind": "object",
26165
- "properties": [
26166
- {
26167
- "kind": "property",
26168
- "name": "data",
26169
- "required": false,
26170
- "type": {
26171
- "kind": "object",
26172
- "properties": [],
26173
- "indexSignature": {
26174
- "kind": "indexSignature",
26175
- "name": "key",
26176
- "type": {
26177
- "kind": "primitive",
26178
- "value": "string"
26179
- },
26180
- "value": {
26181
- "kind": "primitive",
26182
- "value": "any"
26183
- }
26184
- }
26185
- },
26186
- "description": "",
26187
- "declarations": [
26188
- {
26189
- "name": "data",
26190
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26191
- }
26192
- ],
26193
- "tags": {}
26194
- },
26195
- {
26196
- "kind": "property",
26197
- "name": "disabled",
26198
- "required": false,
26199
- "type": {
26200
- "kind": "primitive",
26201
- "value": "boolean"
26202
- },
26203
- "description": "",
26204
- "declarations": [
26205
- {
26206
- "name": "disabled",
26207
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26208
- }
26209
- ],
26210
- "tags": {}
26211
- },
26212
- {
26213
- "kind": "property",
26214
- "name": "id",
26215
- "required": false,
26216
- "type": {
26217
- "kind": "primitive",
26218
- "value": "string"
26219
- },
26220
- "description": "",
26221
- "declarations": [
26222
- {
26223
- "name": "id",
26224
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26225
- }
26226
- ],
26227
- "tags": {}
26228
- },
26229
- {
26230
- "kind": "property",
26231
- "name": "label",
26232
- "required": false,
26233
- "type": {
26234
- "kind": "primitive",
26235
- "value": "string"
26236
- },
26237
- "description": "",
26238
- "declarations": [
26239
- {
26240
- "name": "label",
26241
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26242
- }
26243
- ],
26244
- "tags": {}
26245
- },
26246
- {
26247
- "kind": "property",
26248
- "name": "value",
26249
- "required": true,
26250
- "type": {
26251
- "kind": "primitive",
26252
- "value": "string"
26253
- },
26254
- "description": "",
26255
- "declarations": [
26256
- {
26257
- "name": "value",
26258
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26259
- }
26260
- ],
26261
- "tags": {}
26262
- }
26263
- ]
26264
- }
26265
- },
26266
- {
26267
- "name": "NormalizedOption",
26268
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26269
- "description": "",
26270
- "declarations": [
26271
- {
26272
- "name": "NormalizedOption",
26273
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26274
- }
26275
- ],
26276
- "tags": {
26277
- "deprecated": "⚠️ `NormalizedOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26278
- },
26279
- "type": {
26280
- "kind": "object",
26281
- "properties": [
26282
- {
26283
- "kind": "property",
26284
- "name": "data",
26285
- "required": true,
26286
- "type": {
26287
- "kind": "object",
26288
- "properties": [],
26289
- "indexSignature": {
26290
- "kind": "indexSignature",
26291
- "name": "key",
26292
- "type": {
26293
- "kind": "primitive",
26294
- "value": "string"
26295
- },
26296
- "value": {
26297
- "kind": "primitive",
26298
- "value": "any"
26299
- }
26300
- }
26301
- },
26302
- "description": "",
26303
- "declarations": [
26304
- {
26305
- "name": "data",
26306
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26307
- }
26308
- ],
26309
- "tags": {}
26310
- },
26311
- {
26312
- "kind": "property",
26313
- "name": "disabled",
26314
- "required": true,
26315
- "type": {
26316
- "kind": "primitive",
26317
- "value": "boolean"
26318
- },
26319
- "description": "",
26320
- "declarations": [
26321
- {
26322
- "name": "disabled",
26323
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26324
- }
26325
- ],
26326
- "tags": {}
26327
- },
26328
- {
26329
- "kind": "property",
26330
- "name": "id",
26331
- "required": true,
26332
- "type": {
26333
- "kind": "primitive",
26334
- "value": "string"
26335
- },
26336
- "description": "",
26337
- "declarations": [
26338
- {
26339
- "name": "id",
26340
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26341
- }
26342
- ],
26343
- "tags": {}
26344
- },
26345
- {
26346
- "kind": "property",
26347
- "name": "label",
26348
- "required": true,
26349
- "type": {
26350
- "kind": "primitive",
26351
- "value": "string"
26352
- },
26353
- "description": "",
26354
- "declarations": [
26355
- {
26356
- "name": "label",
26357
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26358
- }
26359
- ],
26360
- "tags": {}
26361
- },
26362
- {
26363
- "kind": "property",
26364
- "name": "value",
26365
- "required": true,
26366
- "type": {
26367
- "kind": "primitive",
26368
- "value": "string"
26369
- },
26370
- "description": "",
26371
- "declarations": [
26372
- {
26373
- "name": "value",
26374
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26375
- }
26376
- ],
26377
- "tags": {}
26378
- }
26379
- ]
26380
- }
26381
- },
26382
- {
26383
- "name": "RenderSelectedFunction",
26384
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26385
- "description": "",
26386
- "declarations": [
26387
- {
26388
- "name": "RenderSelectedFunction",
26389
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26390
- }
26391
- ],
26392
- "tags": {
26393
- "deprecated": "⚠️ `RenderSelectedFunction` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26394
- },
26395
- "type": {
26396
- "kind": "unknown",
26397
- "value": "unknown",
26398
- "text": "export interface RenderSelectedFunction {\n (option: NormalizedOption): React.ReactNode;\n}"
26399
- }
26400
- },
26401
- {
26402
- "name": "RenderableOption",
26403
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26404
- "description": "",
26405
- "declarations": [
26406
- {
26407
- "name": "RenderableOption",
26408
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26409
- }
26410
- ],
26411
- "tags": {
26412
- "deprecated": "⚠️ `RenderableOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26413
- },
26414
- "type": {
26415
- "kind": "object",
26416
- "properties": [
26417
- {
26418
- "kind": "property",
26419
- "name": "focused",
26420
- "required": true,
26421
- "type": {
26422
- "kind": "primitive",
26423
- "value": "boolean"
26424
- },
26425
- "description": "",
26426
- "declarations": [
26427
- {
26428
- "name": "focused",
26429
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26430
- }
26431
- ],
26432
- "tags": {}
26433
- },
26434
- {
26435
- "kind": "property",
26436
- "name": "selected",
26437
- "required": true,
26438
- "type": {
26439
- "kind": "primitive",
26440
- "value": "boolean"
26441
- },
26442
- "description": "",
26443
- "declarations": [
26444
- {
26445
- "name": "selected",
26446
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26447
- }
26448
- ],
26449
- "tags": {}
26450
- },
26451
- {
26452
- "kind": "property",
26453
- "name": "data",
26454
- "required": true,
26455
- "type": {
26456
- "kind": "object",
26457
- "properties": [],
26458
- "indexSignature": {
26459
- "kind": "indexSignature",
26460
- "name": "key",
26461
- "type": {
26462
- "kind": "primitive",
26463
- "value": "string"
26464
- },
26465
- "value": {
26466
- "kind": "primitive",
26467
- "value": "any"
26468
- }
26469
- }
26470
- },
26471
- "description": "",
26472
- "declarations": [
26473
- {
26474
- "name": "data",
26475
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26476
- }
26477
- ],
26478
- "tags": {}
26479
- },
26480
- {
26481
- "kind": "property",
26482
- "name": "disabled",
26483
- "required": true,
26484
- "type": {
26485
- "kind": "primitive",
26486
- "value": "boolean"
26487
- },
26488
- "description": "",
26489
- "declarations": [
26490
- {
26491
- "name": "disabled",
26492
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26493
- }
26494
- ],
26495
- "tags": {}
26496
- },
26497
- {
26498
- "kind": "property",
26499
- "name": "id",
26500
- "required": true,
26501
- "type": {
26502
- "kind": "primitive",
26503
- "value": "string"
26504
- },
26505
- "description": "",
26506
- "declarations": [
26507
- {
26508
- "name": "id",
26509
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26510
- }
26511
- ],
26512
- "tags": {}
26513
- },
26514
- {
26515
- "kind": "property",
26516
- "name": "label",
26517
- "required": true,
26518
- "type": {
26519
- "kind": "primitive",
26520
- "value": "string"
26521
- },
26522
- "description": "",
26523
- "declarations": [
26524
- {
26525
- "name": "label",
26526
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26527
- }
26528
- ],
26529
- "tags": {}
26530
- },
26531
- {
26532
- "kind": "property",
26533
- "name": "value",
26534
- "required": true,
26535
- "type": {
26536
- "kind": "primitive",
26537
- "value": "string"
26538
- },
26539
- "description": "",
26540
- "declarations": [
26541
- {
26542
- "name": "value",
26543
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26544
- }
26545
- ],
26546
- "tags": {}
26547
- }
26548
- ]
26549
- }
26550
- },
26551
- {
26552
- "name": "RenderOptionFunction",
26553
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26554
- "description": "",
26555
- "declarations": [
26556
- {
26557
- "name": "RenderOptionFunction",
26558
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26559
- }
26560
- ],
26561
- "tags": {
26562
- "deprecated": "⚠️ `RenderOptionFunction` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26563
- },
26564
- "type": {
26565
- "kind": "unknown",
26566
- "value": "unknown",
26567
- "text": "export interface RenderOptionFunction {\n (option: RenderableOption): React.ReactNode;\n}"
26568
- }
26569
- },
26570
- {
26571
- "name": "CoreSelectBaseProps",
26572
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26573
- "description": "",
26574
- "declarations": [
26575
- {
26576
- "name": "CoreSelectBaseProps",
26577
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26578
- }
26579
- ],
26580
- "tags": {
26581
- "deprecated": "⚠️ `CoreSelectBaseProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26582
- },
26583
- "type": {
26584
- "kind": "object",
26585
- "properties": [
26586
- {
26587
- "kind": "property",
26588
- "name": "error",
26589
- "required": false,
26590
- "type": {
26591
- "kind": "symbol",
26592
- "name": "ErrorType",
26593
- "value": "ErrorType"
26594
- },
26595
- "description": "The type of error associated with the Select (if applicable).",
26596
- "declarations": [
26597
- {
26598
- "name": "error",
26599
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26600
- }
26601
- ],
26602
- "tags": {}
26603
- },
26604
- {
26605
- "kind": "property",
26606
- "name": "renderOption",
26607
- "required": false,
26608
- "type": {
26609
- "kind": "symbol",
26610
- "name": "RenderOptionFunction",
26611
- "value": "RenderOptionFunction"
26612
- },
26613
- "description": "The function called to render the content of each option.\n\nThe `option` argument passed to the function is an object which contains the following:\n\n* `data: object` (data object carried over from the corresponding option originally passed into the component)\n* `disabled: boolean`\n* `focused: boolean` (set to `true` if the option has keyboard focus)\n* `id: string`\n* `label: string`\n* `selected: boolean` (set to `true` if the option is selected)\n* `value: string`\n\nIf you omit the `renderOption` prop, each option will be rendered using a `defaultRenderOption` function provided by the component.",
26614
- "declarations": [
26615
- {
26616
- "name": "renderOption",
26617
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26618
- }
26619
- ],
26620
- "tags": {
26621
- "default": "defaultRenderOption"
26622
- }
26623
- },
26624
- {
26625
- "kind": "property",
26626
- "name": "renderSelected",
26627
- "required": false,
26628
- "type": {
26629
- "kind": "symbol",
26630
- "name": "RenderSelectedFunction",
26631
- "value": "RenderSelectedFunction"
26632
- },
26633
- "description": "The function called to render the selected option.\n\nThe `option` argument passed to the function is an object which contains the following:\n\n* `data: object` (data object carried over from the corresponding option originally passed into the component)\n* `disabled: boolean`\n* `id: string`\n* `label: string`\n* `value: string`\n\nIf you omit the `renderSelected` prop, each option will be rendered using a `defaultRenderSelected` function provided by the component.",
26634
- "declarations": [
26635
- {
26636
- "name": "renderSelected",
26637
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26638
- }
26639
- ],
26640
- "tags": {
26641
- "default": "defaultRenderSelected"
26642
- }
26643
- },
26644
- {
26645
- "kind": "property",
26646
- "name": "value",
26647
- "required": false,
26648
- "type": {
26649
- "kind": "primitive",
26650
- "value": "string"
26651
- },
26652
- "description": "The value of the Select.",
26653
- "declarations": [
26654
- {
26655
- "name": "value",
26656
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26657
- }
26658
- ],
26659
- "tags": {}
26660
- },
26661
- {
26662
- "kind": "property",
26663
- "name": "theme",
26664
- "required": false,
26665
- "type": {
26666
- "kind": "symbol",
26667
- "name": "EmotionCanvasTheme",
26668
- "value": "EmotionCanvasTheme"
26669
- },
26670
- "description": "",
26671
- "declarations": [
26672
- {
26673
- "name": "theme",
26674
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
26675
- }
26676
- ],
26677
- "tags": {}
26678
- },
26679
- {
26680
- "kind": "property",
26681
- "name": "grow",
26682
- "required": false,
26683
- "type": {
26684
- "kind": "primitive",
26685
- "value": "boolean"
26686
- },
26687
- "description": "True if the component should grow to its container's width. False otherwise.",
26688
- "declarations": [
26689
- {
26690
- "name": "grow",
26691
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
26692
- }
26693
- ],
26694
- "tags": {}
26695
- }
26696
- ]
26697
- }
26698
- },
26699
- {
26700
- "name": "SelectBaseProps",
26701
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26702
- "description": "",
26703
- "declarations": [
26704
- {
26705
- "name": "SelectBaseProps",
26706
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26707
- }
26708
- ],
26709
- "tags": {
26710
- "deprecated": "⚠️ `SelectBaseProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26711
- },
26712
- "type": {
26713
- "kind": "alias",
26714
- "name": "SelectBase"
26715
- }
26716
- },
26717
- {
26718
- "name": "buttonBorderWidth",
26719
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26720
- "description": "",
26721
- "declarations": [
26722
- {
26723
- "name": "buttonBorderWidth",
26724
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26725
- }
26726
- ],
26727
- "tags": {},
26728
- "type": {
26729
- "kind": "number",
26730
- "value": 1
26731
- }
26732
- },
26733
- {
26734
- "name": "SelectBase",
26735
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx",
26736
- "description": "",
26737
- "declarations": [
26738
- {
26739
- "name": "SelectBase",
26740
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26741
- }
26742
- ],
26743
- "tags": {
26744
- "deprecated": "⚠️ `SelectBase` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
26745
- },
26746
- "type": {
26747
- "kind": "component",
26748
- "props": [
26749
- {
26750
- "kind": "property",
26751
- "name": "forwardedButtonRef",
26752
- "required": false,
26753
- "type": {
26754
- "kind": "external",
26755
- "name": "Ref",
26756
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
26757
- "typeParameters": [
26758
- {
26759
- "kind": "symbol",
26760
- "name": "HTMLButtonElement",
26761
- "value": "HTMLButtonElement"
26762
- }
26763
- ]
26764
- },
26765
- "description": "The ref to be forwarded to the underlying button element. Use this to imperatively manipulate the button.",
26766
- "declarations": [
26767
- {
26768
- "name": "forwardedButtonRef",
26769
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26770
- }
26771
- ],
26772
- "tags": {}
26773
- },
26774
- {
26775
- "kind": "property",
26776
- "name": "localButtonRef",
26777
- "required": false,
26778
- "type": {
26779
- "kind": "symbol",
26780
- "name": "React.RefObject",
26781
- "typeParameters": [
26782
- {
26783
- "kind": "symbol",
26784
- "name": "HTMLButtonElement",
26785
- "value": "HTMLButtonElement"
26786
- }
26787
- ],
26788
- "value": "RefObject<T>"
26789
- },
26790
- "description": "The local ref to the underlying button element. Can be used in situations where RefObject is required (such as the Popper Menu).",
26791
- "declarations": [
26792
- {
26793
- "name": "localButtonRef",
26794
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26795
- }
26796
- ],
26797
- "tags": {}
26798
- },
26799
- {
26800
- "kind": "property",
26801
- "name": "focusedOptionIndex",
26802
- "required": false,
26803
- "type": {
26804
- "kind": "primitive",
26805
- "value": "number"
26806
- },
26807
- "description": "The index of the focused option in the SelectBase.",
26808
- "declarations": [
26809
- {
26810
- "name": "focusedOptionIndex",
26811
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26812
- }
26813
- ],
26814
- "tags": {
26815
- "default": "0"
26816
- },
26817
- "defaultValue": {
26818
- "kind": "number",
26819
- "value": 0
26820
- }
26821
- },
26822
- {
26823
- "kind": "property",
26824
- "name": "inputRef",
26825
- "required": false,
26826
- "type": {
26827
- "kind": "external",
26828
- "name": "Ref",
26829
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
26830
- "typeParameters": [
26831
- {
26832
- "kind": "symbol",
26833
- "name": "HTMLInputElement",
26834
- "value": "HTMLInputElement"
26835
- }
26836
- ]
26837
- },
26838
- "description": "The ref to the underlying (hidden) text input element. Use this to imperatively manipulate the input.",
26839
- "declarations": [
26840
- {
26841
- "name": "inputRef",
26842
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26843
- }
26844
- ],
26845
- "tags": {}
26846
- },
26847
- {
26848
- "kind": "property",
26849
- "name": "menuPlacement",
26850
- "required": false,
26851
- "type": {
26852
- "kind": "symbol",
26853
- "name": "MenuPlacement",
26854
- "value": "MenuPlacement"
26855
- },
26856
- "description": "The placement of the SelectBase menu relative to its corresponding SelectButton.",
26857
- "declarations": [
26858
- {
26859
- "name": "menuPlacement",
26860
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26861
- }
26862
- ],
26863
- "tags": {
26864
- "default": "'bottom'"
26865
- },
26866
- "defaultValue": {
26867
- "kind": "string",
26868
- "value": "bottom"
26869
- }
26870
- },
26871
- {
26872
- "kind": "property",
26873
- "name": "menuRef",
26874
- "required": false,
26875
- "type": {
26876
- "kind": "symbol",
26877
- "name": "React.RefObject",
26878
- "typeParameters": [
26879
- {
26880
- "kind": "symbol",
26881
- "name": "HTMLUListElement",
26882
- "value": "HTMLUListElement"
26883
- }
26884
- ],
26885
- "value": "RefObject<T>"
26886
- },
26887
- "description": "The ref to the underlying menu element. Use this to imperatively manipulate the menu.",
26888
- "declarations": [
26889
- {
26890
- "name": "menuRef",
26891
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26892
- }
26893
- ],
26894
- "tags": {}
26895
- },
26896
- {
26897
- "kind": "property",
26898
- "name": "menuVisibility",
26899
- "required": false,
26900
- "type": {
26901
- "kind": "symbol",
26902
- "name": "MenuVisibility",
26903
- "value": "MenuVisibility"
26904
- },
26905
- "description": "The visibility state of the SelectBase menu.",
26906
- "declarations": [
26907
- {
26908
- "name": "menuVisibility",
26909
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26910
- }
26911
- ],
26912
- "tags": {
26913
- "default": "'closed'"
26914
- },
26915
- "defaultValue": {
26916
- "kind": "string",
26917
- "value": "closed"
26918
- }
26919
- },
26920
- {
26921
- "kind": "property",
26922
- "name": "onKeyDown",
26923
- "required": false,
26924
- "type": {
26925
- "kind": "function",
26926
- "parameters": [
26927
- {
26928
- "kind": "parameter",
26929
- "name": "event",
26930
- "type": {
26931
- "kind": "symbol",
26932
- "name": "React.KeyboardEvent",
26933
- "typeParameters": [
26934
- {
26935
- "kind": "symbol",
26936
- "name": "HTMLElement",
26937
- "value": "HTMLElement"
26938
- }
26939
- ],
26940
- "value": "KeyboardEvent<T>"
26941
- },
26942
- "required": true,
26943
- "rest": false,
26944
- "description": "",
26945
- "declarations": [
26946
- {
26947
- "name": "event",
26948
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26949
- }
26950
- ],
26951
- "tags": {}
26952
- }
26953
- ],
26954
- "members": [],
26955
- "returnType": {
26956
- "kind": "primitive",
26957
- "value": "void"
26958
- }
26959
- },
26960
- "description": "The function called when a key is pressed down while the SelectBase button or menu has focus.",
26961
- "declarations": [
26962
- {
26963
- "name": "onKeyDown",
26964
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26965
- }
26966
- ],
26967
- "tags": {}
26968
- },
26969
- {
26970
- "kind": "property",
26971
- "name": "onClose",
26972
- "required": false,
26973
- "type": {
26974
- "kind": "function",
26975
- "parameters": [],
26976
- "members": [],
26977
- "returnType": {
26978
- "kind": "primitive",
26979
- "value": "void"
26980
- }
26981
- },
26982
- "description": "The function called when the menu is closed.",
26983
- "declarations": [
26984
- {
26985
- "name": "onClose",
26986
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
26987
- }
26988
- ],
26989
- "tags": {}
26990
- },
26991
- {
26992
- "kind": "property",
26993
- "name": "onOptionSelection",
26994
- "required": false,
26995
- "type": {
26996
- "kind": "function",
26997
- "parameters": [
26998
- {
26999
- "kind": "parameter",
27000
- "name": "index",
27001
- "type": {
27002
- "kind": "primitive",
27003
- "value": "number"
27004
- },
27005
- "required": true,
27006
- "rest": false,
27007
- "description": "",
27008
- "declarations": [
27009
- {
27010
- "name": "index",
27011
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27012
- }
27013
- ],
27014
- "tags": {}
27015
- }
27016
- ],
27017
- "members": [],
27018
- "returnType": {
27019
- "kind": "primitive",
27020
- "value": "void"
27021
- }
27022
- },
27023
- "description": "The function called when an option in the SelectBase is selected via a click or a keyboard shortcut. The `index` passed to the callback function represents the index of the option which was selected.",
27024
- "declarations": [
27025
- {
27026
- "name": "onOptionSelection",
27027
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27028
- }
27029
- ],
27030
- "tags": {}
27031
- },
27032
- {
27033
- "kind": "property",
27034
- "name": "options",
27035
- "required": true,
27036
- "type": {
27037
- "kind": "array",
27038
- "value": {
27039
- "kind": "symbol",
27040
- "name": "NormalizedOption",
27041
- "value": "NormalizedOption"
27042
- }
27043
- },
27044
- "description": "The options of the SelectBase. `options` is an array of objects, each object adhering to the `NormalizedOption` interface:\n\n* `value: string` (required, analagous to the `value` attribute of an `<option>`)\n* `disabled: boolean` (required)\n* `id: string` (required)\n* `label: string` (required, analagous to the text content of an `<option>`)",
27045
- "declarations": [
27046
- {
27047
- "name": "options",
27048
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27049
- }
27050
- ],
27051
- "tags": {}
27052
- },
27053
- {
27054
- "kind": "property",
27055
- "name": "shouldMenuAutoFlip",
27056
- "required": false,
27057
- "type": {
27058
- "kind": "primitive",
27059
- "value": "boolean"
27060
- },
27061
- "description": "If true, automatically flip the SelectBase menu to keep it visible if necessary (e.g., if the the menu would otherwise display below the visible area of the viewport).",
27062
- "declarations": [
27063
- {
27064
- "name": "shouldMenuAutoFlip",
27065
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27066
- }
27067
- ],
27068
- "tags": {
27069
- "default": "true"
27070
- },
27071
- "defaultValue": {
27072
- "kind": "boolean",
27073
- "value": true
27074
- }
27075
- },
27076
- {
27077
- "kind": "property",
27078
- "name": "shouldMenuAutoFocus",
27079
- "required": false,
27080
- "type": {
27081
- "kind": "primitive",
27082
- "value": "boolean"
27083
- },
27084
- "description": "If true, focus the SelectBase menu when it's shown. Set to false if you don't want to focus the menu automatically (for visual testing purposes, for example).",
27085
- "declarations": [
27086
- {
27087
- "name": "shouldMenuAutoFocus",
27088
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27089
- }
27090
- ],
27091
- "tags": {
27092
- "default": "true"
27093
- },
27094
- "defaultValue": {
27095
- "kind": "boolean",
27096
- "value": true
27097
- }
27098
- },
27099
- {
27100
- "kind": "property",
27101
- "name": "error",
27102
- "required": false,
27103
- "type": {
27104
- "kind": "symbol",
27105
- "name": "ErrorType",
27106
- "value": "ErrorType"
27107
- },
27108
- "description": "The type of error associated with the Select (if applicable).",
27109
- "declarations": [
27110
- {
27111
- "name": "error",
27112
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27113
- }
27114
- ],
27115
- "tags": {}
27116
- },
27117
- {
27118
- "kind": "property",
27119
- "name": "renderOption",
27120
- "required": false,
27121
- "type": {
27122
- "kind": "symbol",
27123
- "name": "RenderOptionFunction",
27124
- "value": "RenderOptionFunction"
27125
- },
27126
- "description": "The function called to render the content of each option.\n\nThe `option` argument passed to the function is an object which contains the following:\n\n* `data: object` (data object carried over from the corresponding option originally passed into the component)\n* `disabled: boolean`\n* `focused: boolean` (set to `true` if the option has keyboard focus)\n* `id: string`\n* `label: string`\n* `selected: boolean` (set to `true` if the option is selected)\n* `value: string`\n\nIf you omit the `renderOption` prop, each option will be rendered using a `defaultRenderOption` function provided by the component.",
27127
- "declarations": [
27128
- {
27129
- "name": "renderOption",
27130
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27131
- }
27132
- ],
27133
- "tags": {
27134
- "default": "defaultRenderOption"
27135
- },
27136
- "defaultValue": {
27137
- "kind": "symbol",
27138
- "name": "defaultRenderOption",
27139
- "value": "defaultRenderOption"
27140
- }
27141
- },
27142
- {
27143
- "kind": "property",
27144
- "name": "renderSelected",
27145
- "required": false,
27146
- "type": {
27147
- "kind": "symbol",
27148
- "name": "RenderSelectedFunction",
27149
- "value": "RenderSelectedFunction"
27150
- },
27151
- "description": "The function called to render the selected option.\n\nThe `option` argument passed to the function is an object which contains the following:\n\n* `data: object` (data object carried over from the corresponding option originally passed into the component)\n* `disabled: boolean`\n* `id: string`\n* `label: string`\n* `value: string`\n\nIf you omit the `renderSelected` prop, each option will be rendered using a `defaultRenderSelected` function provided by the component.",
27152
- "declarations": [
27153
- {
27154
- "name": "renderSelected",
27155
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27156
- }
27157
- ],
27158
- "tags": {
27159
- "default": "defaultRenderSelected"
27160
- },
27161
- "defaultValue": {
27162
- "kind": "symbol",
27163
- "name": "defaultRenderSelected",
27164
- "value": "defaultRenderSelected"
27165
- }
27166
- },
27167
- {
27168
- "kind": "property",
27169
- "name": "value",
27170
- "required": false,
27171
- "type": {
27172
- "kind": "primitive",
27173
- "value": "string"
27174
- },
27175
- "description": "The value of the Select.",
27176
- "declarations": [
27177
- {
27178
- "name": "value",
27179
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27180
- }
27181
- ],
27182
- "tags": {}
27183
- },
27184
- {
27185
- "kind": "property",
27186
- "name": "theme",
27187
- "required": false,
27188
- "type": {
27189
- "kind": "symbol",
27190
- "name": "EmotionCanvasTheme",
27191
- "value": "EmotionCanvasTheme"
27192
- },
27193
- "description": "",
27194
- "declarations": [
27195
- {
27196
- "name": "theme",
27197
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
27198
- }
27199
- ],
27200
- "tags": {}
27201
- },
27202
- {
27203
- "kind": "property",
27204
- "name": "grow",
27205
- "required": false,
27206
- "type": {
27207
- "kind": "primitive",
27208
- "value": "boolean"
27209
- },
27210
- "description": "True if the component should grow to its container's width. False otherwise.",
27211
- "declarations": [
27212
- {
27213
- "name": "grow",
27214
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
27215
- }
27216
- ],
27217
- "tags": {}
27218
- },
27219
- {
27220
- "kind": "property",
27221
- "name": "as",
27222
- "required": false,
27223
- "type": {
27224
- "kind": "symbol",
27225
- "name": "React.ElementType",
27226
- "value": "ElementType<P>"
27227
- },
27228
- "description": "",
27229
- "declarations": [
27230
- {
27231
- "name": "as",
27232
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/utils/components.ts"
27233
- }
27234
- ],
27235
- "tags": {}
27236
- }
27237
- ]
27238
- }
27239
- },
27240
- {
27241
- "name": "menuAnimationDuration",
27242
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx",
27243
- "description": "",
27244
- "declarations": [
27245
- {
27246
- "name": "menuAnimationDuration",
27247
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27248
- }
27249
- ],
27250
- "tags": {},
27251
- "type": {
27252
- "kind": "number",
27253
- "value": 200
27254
- }
27255
- },
27256
- {
27257
- "name": "SelectMenu",
27258
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx",
27259
- "description": "",
27260
- "declarations": [
27261
- {
27262
- "name": "SelectMenu",
27263
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27264
- }
27265
- ],
27266
- "tags": {
27267
- "deprecated": "⚠️ `SelectMenu` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27268
- },
27269
- "type": {
27270
- "kind": "component",
27271
- "props": [
27272
- {
27273
- "kind": "property",
27274
- "name": "buttonRef",
27275
- "required": false,
27276
- "type": {
27277
- "kind": "symbol",
27278
- "name": "React.RefObject",
27279
- "typeParameters": [
27280
- {
27281
- "kind": "symbol",
27282
- "name": "HTMLButtonElement",
27283
- "value": "HTMLButtonElement"
27284
- }
27285
- ],
27286
- "value": "RefObject<T>"
27287
- },
27288
- "description": "The ref to the anchor button element. Required to anchor the menu.",
27289
- "declarations": [
27290
- {
27291
- "name": "buttonRef",
27292
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27293
- }
27294
- ],
27295
- "tags": {}
27296
- },
27297
- {
27298
- "kind": "property",
27299
- "name": "menuRef",
27300
- "required": false,
27301
- "type": {
27302
- "kind": "symbol",
27303
- "name": "React.RefObject",
27304
- "typeParameters": [
27305
- {
27306
- "kind": "symbol",
27307
- "name": "HTMLUListElement",
27308
- "value": "HTMLUListElement"
27309
- }
27310
- ],
27311
- "value": "RefObject<T>"
27312
- },
27313
- "description": "The ref to the underlying menu/listbox element. Use this to imperatively manipulate the menu.",
27314
- "declarations": [
27315
- {
27316
- "name": "menuRef",
27317
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27318
- }
27319
- ],
27320
- "tags": {}
27321
- },
27322
- {
27323
- "kind": "property",
27324
- "name": "onClose",
27325
- "required": false,
27326
- "type": {
27327
- "kind": "function",
27328
- "parameters": [],
27329
- "members": [],
27330
- "returnType": {
27331
- "kind": "primitive",
27332
- "value": "void"
27333
- }
27334
- },
27335
- "description": "The function called when the menu is closed.",
27336
- "declarations": [
27337
- {
27338
- "name": "onClose",
27339
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27340
- }
27341
- ],
27342
- "tags": {}
27343
- },
27344
- {
27345
- "kind": "property",
27346
- "name": "placement",
27347
- "required": false,
27348
- "type": {
27349
- "kind": "symbol",
27350
- "name": "MenuPlacement",
27351
- "value": "MenuPlacement"
27352
- },
27353
- "description": "The placement of the SelectMenu relative to its corresponding button.",
27354
- "declarations": [
27355
- {
27356
- "name": "placement",
27357
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27358
- }
27359
- ],
27360
- "tags": {
27361
- "default": "'bottom'"
27362
- },
27363
- "defaultValue": {
27364
- "kind": "string",
27365
- "value": "bottom"
27366
- }
27367
- },
27368
- {
27369
- "kind": "property",
27370
- "name": "shouldAutoFlip",
27371
- "required": false,
27372
- "type": {
27373
- "kind": "primitive",
27374
- "value": "boolean"
27375
- },
27376
- "description": "If true, automatically flip the SelectMenu to keep it visible if necessary (e.g., if the the SelectMenu would otherwise display below the visible area of the viewport).",
27377
- "declarations": [
27378
- {
27379
- "name": "shouldAutoFlip",
27380
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27381
- }
27382
- ],
27383
- "tags": {
27384
- "default": "true"
27385
- },
27386
- "defaultValue": {
27387
- "kind": "boolean",
27388
- "value": true
27389
- }
27390
- },
27391
- {
27392
- "kind": "property",
27393
- "name": "shouldAutoFocus",
27394
- "required": false,
27395
- "type": {
27396
- "kind": "primitive",
27397
- "value": "boolean"
27398
- },
27399
- "description": "If true, focus the SelectMenu when it's shown. Set to false if you don't want to focus the SelectMenu automatically (for visual testing purposes, for example).",
27400
- "declarations": [
27401
- {
27402
- "name": "shouldAutoFocus",
27403
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27404
- }
27405
- ],
27406
- "tags": {
27407
- "default": "true"
27408
- },
27409
- "defaultValue": {
27410
- "kind": "boolean",
27411
- "value": true
27412
- }
27413
- },
27414
- {
27415
- "kind": "property",
27416
- "name": "visibility",
27417
- "required": false,
27418
- "type": {
27419
- "kind": "symbol",
27420
- "name": "MenuVisibility",
27421
- "value": "MenuVisibility"
27422
- },
27423
- "description": "The visibility state of the SelectMenu.",
27424
- "declarations": [
27425
- {
27426
- "name": "visibility",
27427
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectMenu.tsx"
27428
- }
27429
- ],
27430
- "tags": {
27431
- "default": "'closed'"
27432
- },
27433
- "defaultValue": {
27434
- "kind": "string",
27435
- "value": "closed"
27436
- }
27437
- },
27438
- {
27439
- "kind": "property",
27440
- "name": "theme",
27441
- "required": false,
27442
- "type": {
27443
- "kind": "symbol",
27444
- "name": "EmotionCanvasTheme",
27445
- "value": "EmotionCanvasTheme"
27446
- },
27447
- "description": "",
27448
- "declarations": [
27449
- {
27450
- "name": "theme",
27451
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
27452
- }
27453
- ],
27454
- "tags": {}
27455
- },
27456
- {
27457
- "kind": "property",
27458
- "name": "error",
27459
- "required": false,
27460
- "type": {
27461
- "kind": "symbol",
27462
- "name": "ErrorType",
27463
- "value": "ErrorType"
27464
- },
27465
- "description": "The type of error associated with the Select (if applicable).",
27466
- "declarations": [
27467
- {
27468
- "name": "error",
27469
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectBase.tsx"
27470
- }
27471
- ],
27472
- "tags": {}
27473
- }
27474
- ]
27475
- }
27476
- },
27477
- {
27478
- "name": "SelectOptionProps",
27479
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx",
27480
- "description": "",
27481
- "declarations": [
27482
- {
27483
- "name": "SelectOptionProps",
27484
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27485
- }
27486
- ],
27487
- "tags": {
27488
- "deprecated": "⚠️ `SelectOptionProps` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27489
- },
27490
- "type": {
27491
- "kind": "alias",
27492
- "name": "SelectOption"
27493
- }
27494
- },
27495
- {
27496
- "name": "SelectOption",
27497
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx",
27498
- "description": "",
27499
- "declarations": [
27500
- {
27501
- "name": "SelectOption",
27502
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27503
- }
27504
- ],
27505
- "tags": {
27506
- "deprecated": "⚠️ `SelectOption` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27507
- },
27508
- "type": {
27509
- "kind": "component",
27510
- "props": [
27511
- {
27512
- "kind": "property",
27513
- "name": "error",
27514
- "required": false,
27515
- "type": {
27516
- "kind": "symbol",
27517
- "name": "ErrorType",
27518
- "value": "ErrorType"
27519
- },
27520
- "description": "The type of error associated with the SelectOption (if applicable).",
27521
- "declarations": [
27522
- {
27523
- "name": "error",
27524
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27525
- }
27526
- ],
27527
- "tags": {}
27528
- },
27529
- {
27530
- "kind": "property",
27531
- "name": "focused",
27532
- "required": false,
27533
- "type": {
27534
- "kind": "primitive",
27535
- "value": "boolean"
27536
- },
27537
- "description": "If true, set the SelectOption to the focused state.",
27538
- "declarations": [
27539
- {
27540
- "name": "focused",
27541
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27542
- }
27543
- ],
27544
- "tags": {
27545
- "default": "false"
27546
- },
27547
- "defaultValue": {
27548
- "kind": "boolean",
27549
- "value": false
27550
- }
27551
- },
27552
- {
27553
- "kind": "property",
27554
- "name": "id",
27555
- "required": false,
27556
- "type": {
27557
- "kind": "primitive",
27558
- "value": "string"
27559
- },
27560
- "description": "The HTML `id` of the SelectOption.",
27561
- "declarations": [
27562
- {
27563
- "name": "id",
27564
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27565
- }
27566
- ],
27567
- "tags": {}
27568
- },
27569
- {
27570
- "kind": "property",
27571
- "name": "interactive",
27572
- "required": false,
27573
- "type": {
27574
- "kind": "primitive",
27575
- "value": "boolean"
27576
- },
27577
- "description": "If true, set the SelectOption to the interactive state. Non-interactive SelectOptions should not give any visual cues that they are interactive (e.g., remove hover styling).",
27578
- "declarations": [
27579
- {
27580
- "name": "interactive",
27581
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27582
- }
27583
- ],
27584
- "tags": {
27585
- "default": "true"
27586
- },
27587
- "defaultValue": {
27588
- "kind": "boolean",
27589
- "value": true
27590
- }
27591
- },
27592
- {
27593
- "kind": "property",
27594
- "name": "optionRef",
27595
- "required": false,
27596
- "type": {
27597
- "kind": "external",
27598
- "name": "Ref",
27599
- "url": "https://reactjs.org/docs/refs-and-the-dom.html",
27600
- "typeParameters": [
27601
- {
27602
- "kind": "symbol",
27603
- "name": "HTMLLIElement",
27604
- "value": "HTMLLIElement"
27605
- }
27606
- ]
27607
- },
27608
- "description": "The ref to the list item that the styled component renders. Use this to imperatively manipulate the SelectOption (e.g., to scroll to it if it's out of view in the Select menu).",
27609
- "declarations": [
27610
- {
27611
- "name": "optionRef",
27612
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27613
- }
27614
- ],
27615
- "tags": {}
27616
- },
27617
- {
27618
- "kind": "property",
27619
- "name": "value",
27620
- "required": false,
27621
- "type": {
27622
- "kind": "primitive",
27623
- "value": "string"
27624
- },
27625
- "description": "The value of the SelectOption.",
27626
- "declarations": [
27627
- {
27628
- "name": "value",
27629
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/SelectOption.tsx"
27630
- }
27631
- ],
27632
- "tags": {}
27633
- },
27634
- {
27635
- "kind": "property",
27636
- "name": "theme",
27637
- "required": false,
27638
- "type": {
27639
- "kind": "symbol",
27640
- "name": "EmotionCanvasTheme",
27641
- "value": "EmotionCanvasTheme"
27642
- },
27643
- "description": "",
27644
- "declarations": [
27645
- {
27646
- "name": "theme",
27647
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
27648
- }
27649
- ],
27650
- "tags": {}
27651
- }
27652
- ]
27653
- }
27654
- },
27655
- {
27656
- "name": "MenuPlacement",
27657
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/types.ts",
27658
- "description": "The placement of the menu relative to its corresponding button. This type is a\nsubset of the PopperJS.Placement type limited to the `bottom` and `top` values.\n\nWe need to use `top` and `bottom` instead of `top-start` and `bottom-start` for\nplacements because PopperJS incorrectly rounds the `start` and `end` modifiers:\nhttps://github.com/popperjs/popper-core/blob/38914aae7a2e91715c6eb2b563517082a40cfa64/src/utils/computeOffsets.js#L68-L81\nThis rounding causes problems with browsers that allow subpixel values for elements\nlike Firefox and Edge.",
27659
- "declarations": [
27660
- {
27661
- "name": "MenuPlacement",
27662
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/types.ts"
27663
- }
27664
- ],
27665
- "tags": {
27666
- "deprecated": "⚠️ `MenuPlacement` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27667
- },
27668
- "type": {
27669
- "kind": "type",
27670
- "typeParameters": [],
27671
- "value": {
27672
- "kind": "union",
27673
- "value": [
27674
- {
27675
- "kind": "string",
27676
- "value": "bottom"
27677
- },
27678
- {
27679
- "kind": "string",
27680
- "value": "top"
27681
- }
27682
- ]
27683
- }
27684
- }
27685
- },
27686
- {
27687
- "name": "MenuVisibility",
27688
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/types.ts",
27689
- "description": "The visibility state of the menu.\n\n`closed`: The menu is completely closed (not present in the DOM).\n`open`: The menu was previously `closed` and has just been instructed to open.\n The menu has been added to the DOM, but it's not yet visible. This state is\n necessary in order to apply an opacity of 0 to the menu before transitioning it\n to an opacity of 1.0 in the opening state.\n`opening`: The menu is in the process of opening.\n`opened`: The menu is completely open.\n`close`: The menu was previously `open` and has just been instructed to close.\n`closing`: The menu is in the process of closing.\n\nTypically, a menu will transition through states in the following order:\n`closed` > `open` > `opening` > `opened` > `close` > `closing` > `closed`\n\nHowever, it's possible for a user to open a menu while it's in the process of\nclosing in which case the menu can transition from `closing` > `opening` (and\nvice-versa).",
27690
- "declarations": [
27691
- {
27692
- "name": "MenuVisibility",
27693
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/types.ts"
27694
- }
27695
- ],
27696
- "tags": {
27697
- "deprecated": "⚠️ `MenuVisibility` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27698
- },
27699
- "type": {
27700
- "kind": "type",
27701
- "typeParameters": [],
27702
- "value": {
27703
- "kind": "union",
27704
- "value": [
27705
- {
27706
- "kind": "string",
27707
- "value": "closed"
27708
- },
27709
- {
27710
- "kind": "string",
27711
- "value": "open"
27712
- },
27713
- {
27714
- "kind": "string",
27715
- "value": "opening"
27716
- },
27717
- {
27718
- "kind": "string",
27719
- "value": "opened"
27720
- },
27721
- {
27722
- "kind": "string",
27723
- "value": "close"
27724
- },
27725
- {
27726
- "kind": "string",
27727
- "value": "closing"
27728
- }
27729
- ]
27730
- }
27731
- }
27732
- },
27733
- {
27734
- "name": "getIndexByValue",
27735
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts",
27736
- "description": "",
27737
- "declarations": [
27738
- {
27739
- "name": "getIndexByValue",
27740
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts"
27741
- }
27742
- ],
27743
- "tags": {
27744
- "deprecated": "⚠️ `getIndexByValue` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27745
- },
27746
- "type": {
27747
- "kind": "function",
27748
- "parameters": [
27749
- {
27750
- "kind": "parameter",
27751
- "name": "options",
27752
- "type": {
27753
- "kind": "array",
27754
- "value": {
27755
- "kind": "symbol",
27756
- "name": "NormalizedOption",
27757
- "value": "NormalizedOption"
27758
- }
27759
- },
27760
- "required": true,
27761
- "rest": false,
27762
- "description": "",
27763
- "declarations": [
27764
- {
27765
- "name": "options",
27766
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts"
27767
- }
27768
- ],
27769
- "tags": {}
27770
- },
27771
- {
27772
- "kind": "parameter",
27773
- "name": "value",
27774
- "type": {
27775
- "kind": "union",
27776
- "value": [
27777
- {
27778
- "kind": "primitive",
27779
- "value": "string"
27780
- },
27781
- {
27782
- "kind": "primitive",
27783
- "value": "undefined"
27784
- }
27785
- ]
27786
- },
27787
- "required": false,
27788
- "rest": false,
27789
- "description": "",
27790
- "declarations": [
27791
- {
27792
- "name": "value",
27793
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts"
27794
- }
27795
- ],
27796
- "tags": {}
27797
- }
27798
- ],
27799
- "members": [],
27800
- "returnType": {
27801
- "kind": "primitive",
27802
- "value": "number"
27803
- }
27804
- }
27805
- },
27806
- {
27807
- "name": "getCorrectedIndexByValue",
27808
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts",
27809
- "description": "",
27810
- "declarations": [
27811
- {
27812
- "name": "getCorrectedIndexByValue",
27813
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts"
27814
- }
27815
- ],
27816
- "tags": {
27817
- "deprecated": "⚠️ `getCorrectedIndexByValue` in Preview has been deprecated and will be removed in a future major version. Please use [`Select` in Main](https://workday.github.io/canvas-kit/?path=/docs/components-inputs-select--basic) instead."
27818
- },
27819
- "type": {
27820
- "kind": "function",
27821
- "parameters": [
27822
- {
27823
- "kind": "parameter",
27824
- "name": "options",
27825
- "type": {
27826
- "kind": "array",
27827
- "value": {
27828
- "kind": "symbol",
27829
- "name": "NormalizedOption",
27830
- "value": "NormalizedOption"
27831
- }
27832
- },
27833
- "required": true,
27834
- "rest": false,
27835
- "description": "",
27836
- "declarations": [
27837
- {
27838
- "name": "options",
27839
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts"
27840
- }
27841
- ],
27842
- "tags": {}
27843
- },
27844
- {
27845
- "kind": "parameter",
27846
- "name": "value",
27847
- "type": {
27848
- "kind": "union",
27849
- "value": [
27850
- {
27851
- "kind": "primitive",
27852
- "value": "string"
27853
- },
27854
- {
27855
- "kind": "primitive",
27856
- "value": "undefined"
27857
- }
27858
- ]
27859
- },
27860
- "required": false,
27861
- "rest": false,
27862
- "description": "",
27863
- "declarations": [
27864
- {
27865
- "name": "value",
27866
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/select/lib/utils.ts"
27867
- }
27868
- ],
27869
- "tags": {}
27870
- }
27871
- ],
27872
- "members": [],
27873
- "returnType": {
27874
- "kind": "primitive",
27875
- "value": "number"
27876
- }
27877
- }
27878
- },
27879
25821
  {
27880
25822
  "name": "SidePanelContext",
27881
25823
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/side-panel/lib/hooks.ts",
@@ -114006,6 +111948,73 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
114006
111948
  }
114007
111949
  }
114008
111950
  },
111951
+ {
111952
+ "name": "filterOutProps",
111953
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts",
111954
+ "description": "",
111955
+ "declarations": [
111956
+ {
111957
+ "name": "filterOutProps",
111958
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
111959
+ }
111960
+ ],
111961
+ "tags": {},
111962
+ "type": {
111963
+ "kind": "function",
111964
+ "parameters": [
111965
+ {
111966
+ "kind": "parameter",
111967
+ "name": "omittedProps",
111968
+ "type": {
111969
+ "kind": "array",
111970
+ "value": {
111971
+ "kind": "primitive",
111972
+ "value": "string"
111973
+ }
111974
+ },
111975
+ "required": true,
111976
+ "rest": false,
111977
+ "description": "",
111978
+ "declarations": [
111979
+ {
111980
+ "name": "omittedProps",
111981
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
111982
+ }
111983
+ ],
111984
+ "tags": {}
111985
+ }
111986
+ ],
111987
+ "members": [],
111988
+ "returnType": {
111989
+ "kind": "function",
111990
+ "parameters": [
111991
+ {
111992
+ "kind": "parameter",
111993
+ "name": "prop",
111994
+ "type": {
111995
+ "kind": "primitive",
111996
+ "value": "string"
111997
+ },
111998
+ "required": true,
111999
+ "rest": false,
112000
+ "description": "",
112001
+ "declarations": [
112002
+ {
112003
+ "name": "prop",
112004
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts"
112005
+ }
112006
+ ],
112007
+ "tags": {}
112008
+ }
112009
+ ],
112010
+ "members": [],
112011
+ "returnType": {
112012
+ "kind": "primitive",
112013
+ "value": "boolean"
112014
+ }
112015
+ }
112016
+ }
112017
+ },
114009
112018
  {
114010
112019
  "name": "StyleRewriteFn",
114011
112020
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/styled.ts",