@workday/canvas-kit-docs 11.0.0-alpha.669-next.0 → 11.0.0-alpha.682-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 +2301 -286
- package/dist/mdx/11.0-UPGRADE-GUIDE.mdx +49 -36
- package/dist/mdx/preview-react/side-panel/examples/Basic.tsx +17 -15
- package/dist/mdx/preview-react/side-panel/examples/RightOrigin.tsx +14 -12
- package/dist/mdx/preview-react/side-panel/examples/Variant.tsx +14 -12
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -11478,8 +11478,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11478
11478
|
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
11479
11479
|
},
|
|
11480
11480
|
"defaultValue": {
|
|
11481
|
-
"kind": "
|
|
11482
|
-
"name": "
|
|
11481
|
+
"kind": "external",
|
|
11482
|
+
"name": "div",
|
|
11483
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
11483
11484
|
}
|
|
11484
11485
|
},
|
|
11485
11486
|
{
|
|
@@ -11498,8 +11499,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11498
11499
|
"name": "R",
|
|
11499
11500
|
"required": true,
|
|
11500
11501
|
"defaultValue": {
|
|
11501
|
-
"kind": "
|
|
11502
|
-
"name": "
|
|
11502
|
+
"kind": "external",
|
|
11503
|
+
"name": "div",
|
|
11504
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
11503
11505
|
}
|
|
11504
11506
|
}
|
|
11505
11507
|
]
|
|
@@ -11558,8 +11560,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11558
11560
|
}
|
|
11559
11561
|
],
|
|
11560
11562
|
"baseElement": {
|
|
11561
|
-
"kind": "
|
|
11562
|
-
"name": "
|
|
11563
|
+
"kind": "external",
|
|
11564
|
+
"name": "div",
|
|
11565
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
11563
11566
|
},
|
|
11564
11567
|
"model": "RadioModel",
|
|
11565
11568
|
"styleComponent": {
|
|
@@ -12354,24 +12357,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
12354
12357
|
],
|
|
12355
12358
|
"tags": {}
|
|
12356
12359
|
},
|
|
12357
|
-
{
|
|
12358
|
-
"kind": "property",
|
|
12359
|
-
"name": "theme",
|
|
12360
|
-
"required": false,
|
|
12361
|
-
"type": {
|
|
12362
|
-
"kind": "symbol",
|
|
12363
|
-
"name": "EmotionCanvasTheme",
|
|
12364
|
-
"value": "EmotionCanvasTheme"
|
|
12365
|
-
},
|
|
12366
|
-
"description": "",
|
|
12367
|
-
"declarations": [
|
|
12368
|
-
{
|
|
12369
|
-
"name": "theme",
|
|
12370
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/theming/types.ts"
|
|
12371
|
-
}
|
|
12372
|
-
],
|
|
12373
|
-
"tags": {}
|
|
12374
|
-
},
|
|
12375
12360
|
{
|
|
12376
12361
|
"kind": "property",
|
|
12377
12362
|
"name": "children",
|
|
@@ -64019,19 +64004,121 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64019
64004
|
}
|
|
64020
64005
|
},
|
|
64021
64006
|
{
|
|
64022
|
-
"name": "
|
|
64023
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64007
|
+
"name": "backgroundVars",
|
|
64008
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx",
|
|
64024
64009
|
"description": "",
|
|
64025
64010
|
"declarations": [
|
|
64026
64011
|
{
|
|
64027
|
-
"name": "
|
|
64028
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64012
|
+
"name": "backgroundVars",
|
|
64013
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx"
|
|
64029
64014
|
}
|
|
64030
64015
|
],
|
|
64031
64016
|
"tags": {},
|
|
64032
64017
|
"type": {
|
|
64033
|
-
"kind": "
|
|
64034
|
-
"name": "
|
|
64018
|
+
"kind": "symbol",
|
|
64019
|
+
"name": "CsVars",
|
|
64020
|
+
"value": "CsVars<\"inner\" | \"outer\", never>"
|
|
64021
|
+
}
|
|
64022
|
+
},
|
|
64023
|
+
{
|
|
64024
|
+
"name": "CheckBackground",
|
|
64025
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx",
|
|
64026
|
+
"description": "",
|
|
64027
|
+
"declarations": [
|
|
64028
|
+
{
|
|
64029
|
+
"name": "CheckBackground",
|
|
64030
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx"
|
|
64031
|
+
}
|
|
64032
|
+
],
|
|
64033
|
+
"tags": {},
|
|
64034
|
+
"type": {
|
|
64035
|
+
"kind": "enhancedComponent",
|
|
64036
|
+
"componentType": "regular",
|
|
64037
|
+
"displayName": "CheckBackground",
|
|
64038
|
+
"props": [
|
|
64039
|
+
{
|
|
64040
|
+
"kind": "property",
|
|
64041
|
+
"name": "children",
|
|
64042
|
+
"required": true,
|
|
64043
|
+
"type": {
|
|
64044
|
+
"kind": "external",
|
|
64045
|
+
"name": "ReactNode",
|
|
64046
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
64047
|
+
},
|
|
64048
|
+
"description": "",
|
|
64049
|
+
"declarations": [
|
|
64050
|
+
{
|
|
64051
|
+
"name": "children",
|
|
64052
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx"
|
|
64053
|
+
}
|
|
64054
|
+
],
|
|
64055
|
+
"tags": {}
|
|
64056
|
+
},
|
|
64057
|
+
{
|
|
64058
|
+
"kind": "property",
|
|
64059
|
+
"name": "error",
|
|
64060
|
+
"required": false,
|
|
64061
|
+
"type": {
|
|
64062
|
+
"kind": "symbol",
|
|
64063
|
+
"name": "ErrorType",
|
|
64064
|
+
"value": "ErrorType"
|
|
64065
|
+
},
|
|
64066
|
+
"description": "",
|
|
64067
|
+
"declarations": [
|
|
64068
|
+
{
|
|
64069
|
+
"name": "error",
|
|
64070
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx"
|
|
64071
|
+
}
|
|
64072
|
+
],
|
|
64073
|
+
"tags": {}
|
|
64074
|
+
},
|
|
64075
|
+
{
|
|
64076
|
+
"kind": "property",
|
|
64077
|
+
"name": "as",
|
|
64078
|
+
"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.",
|
|
64079
|
+
"tags": {},
|
|
64080
|
+
"declarations": [],
|
|
64081
|
+
"type": {
|
|
64082
|
+
"kind": "external",
|
|
64083
|
+
"name": "React.ElementType",
|
|
64084
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
64085
|
+
},
|
|
64086
|
+
"defaultValue": {
|
|
64087
|
+
"kind": "external",
|
|
64088
|
+
"name": "div",
|
|
64089
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64090
|
+
}
|
|
64091
|
+
},
|
|
64092
|
+
{
|
|
64093
|
+
"kind": "property",
|
|
64094
|
+
"name": "ref",
|
|
64095
|
+
"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`).",
|
|
64096
|
+
"tags": {},
|
|
64097
|
+
"declarations": [],
|
|
64098
|
+
"type": {
|
|
64099
|
+
"kind": "external",
|
|
64100
|
+
"name": "React.Ref",
|
|
64101
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
64102
|
+
"typeParameters": [
|
|
64103
|
+
{
|
|
64104
|
+
"kind": "typeParameter",
|
|
64105
|
+
"name": "R",
|
|
64106
|
+
"required": true,
|
|
64107
|
+
"defaultValue": {
|
|
64108
|
+
"kind": "external",
|
|
64109
|
+
"name": "div",
|
|
64110
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64111
|
+
}
|
|
64112
|
+
}
|
|
64113
|
+
]
|
|
64114
|
+
}
|
|
64115
|
+
}
|
|
64116
|
+
],
|
|
64117
|
+
"baseElement": {
|
|
64118
|
+
"kind": "external",
|
|
64119
|
+
"name": "div",
|
|
64120
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64121
|
+
}
|
|
64035
64122
|
}
|
|
64036
64123
|
},
|
|
64037
64124
|
{
|
|
@@ -64062,7 +64149,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64062
64149
|
"declarations": [
|
|
64063
64150
|
{
|
|
64064
64151
|
"name": "checked",
|
|
64065
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64152
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64066
64153
|
}
|
|
64067
64154
|
],
|
|
64068
64155
|
"tags": {
|
|
@@ -64085,7 +64172,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64085
64172
|
"declarations": [
|
|
64086
64173
|
{
|
|
64087
64174
|
"name": "disabled",
|
|
64088
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64175
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64089
64176
|
}
|
|
64090
64177
|
],
|
|
64091
64178
|
"tags": {
|
|
@@ -64096,6 +64183,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64096
64183
|
"value": false
|
|
64097
64184
|
}
|
|
64098
64185
|
},
|
|
64186
|
+
{
|
|
64187
|
+
"kind": "property",
|
|
64188
|
+
"name": "error",
|
|
64189
|
+
"required": false,
|
|
64190
|
+
"type": {
|
|
64191
|
+
"kind": "symbol",
|
|
64192
|
+
"name": "ErrorType",
|
|
64193
|
+
"value": "ErrorType"
|
|
64194
|
+
},
|
|
64195
|
+
"description": "The type of error associated with the Checkbox (if applicable).",
|
|
64196
|
+
"declarations": [
|
|
64197
|
+
{
|
|
64198
|
+
"name": "error",
|
|
64199
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64200
|
+
}
|
|
64201
|
+
],
|
|
64202
|
+
"tags": {}
|
|
64203
|
+
},
|
|
64099
64204
|
{
|
|
64100
64205
|
"kind": "property",
|
|
64101
64206
|
"name": "id",
|
|
@@ -64108,7 +64213,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64108
64213
|
"declarations": [
|
|
64109
64214
|
{
|
|
64110
64215
|
"name": "id",
|
|
64111
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64216
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64112
64217
|
}
|
|
64113
64218
|
],
|
|
64114
64219
|
"tags": {
|
|
@@ -64120,6 +64225,29 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64120
64225
|
"value": "useUniqueId"
|
|
64121
64226
|
}
|
|
64122
64227
|
},
|
|
64228
|
+
{
|
|
64229
|
+
"kind": "property",
|
|
64230
|
+
"name": "indeterminate",
|
|
64231
|
+
"required": false,
|
|
64232
|
+
"type": {
|
|
64233
|
+
"kind": "primitive",
|
|
64234
|
+
"value": "boolean"
|
|
64235
|
+
},
|
|
64236
|
+
"description": "If true, set the Checkbox to an indeterminate state. Use this on a Checkbox with nested child Checkboxes to denote that some (but not all) child Checkboxes are checked.",
|
|
64237
|
+
"declarations": [
|
|
64238
|
+
{
|
|
64239
|
+
"name": "indeterminate",
|
|
64240
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64241
|
+
}
|
|
64242
|
+
],
|
|
64243
|
+
"tags": {
|
|
64244
|
+
"default": "false"
|
|
64245
|
+
},
|
|
64246
|
+
"defaultValue": {
|
|
64247
|
+
"kind": "boolean",
|
|
64248
|
+
"value": false
|
|
64249
|
+
}
|
|
64250
|
+
},
|
|
64123
64251
|
{
|
|
64124
64252
|
"kind": "property",
|
|
64125
64253
|
"name": "label",
|
|
@@ -64132,7 +64260,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64132
64260
|
"declarations": [
|
|
64133
64261
|
{
|
|
64134
64262
|
"name": "label",
|
|
64135
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64263
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64136
64264
|
}
|
|
64137
64265
|
],
|
|
64138
64266
|
"tags": {
|
|
@@ -64171,7 +64299,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64171
64299
|
"declarations": [
|
|
64172
64300
|
{
|
|
64173
64301
|
"name": "e",
|
|
64174
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64302
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64175
64303
|
}
|
|
64176
64304
|
],
|
|
64177
64305
|
"tags": {}
|
|
@@ -64187,7 +64315,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64187
64315
|
"declarations": [
|
|
64188
64316
|
{
|
|
64189
64317
|
"name": "onChange",
|
|
64190
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64318
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64191
64319
|
}
|
|
64192
64320
|
],
|
|
64193
64321
|
"tags": {}
|
|
@@ -64204,92 +64332,211 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64204
64332
|
"declarations": [
|
|
64205
64333
|
{
|
|
64206
64334
|
"name": "value",
|
|
64207
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64335
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64208
64336
|
}
|
|
64209
64337
|
],
|
|
64210
64338
|
"tags": {}
|
|
64211
64339
|
},
|
|
64212
64340
|
{
|
|
64213
64341
|
"kind": "property",
|
|
64214
|
-
"name": "
|
|
64342
|
+
"name": "variant",
|
|
64215
64343
|
"required": false,
|
|
64216
64344
|
"type": {
|
|
64217
|
-
"kind": "
|
|
64218
|
-
"
|
|
64219
|
-
|
|
64345
|
+
"kind": "union",
|
|
64346
|
+
"value": [
|
|
64347
|
+
{
|
|
64348
|
+
"kind": "string",
|
|
64349
|
+
"value": "inverse"
|
|
64350
|
+
},
|
|
64351
|
+
{
|
|
64352
|
+
"kind": "primitive",
|
|
64353
|
+
"value": "undefined"
|
|
64354
|
+
}
|
|
64355
|
+
]
|
|
64220
64356
|
},
|
|
64221
|
-
"description": "The
|
|
64357
|
+
"description": "The variant for the checkbox",
|
|
64222
64358
|
"declarations": [
|
|
64223
64359
|
{
|
|
64224
|
-
"name": "
|
|
64225
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64360
|
+
"name": "variant",
|
|
64361
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64226
64362
|
}
|
|
64227
64363
|
],
|
|
64228
64364
|
"tags": {}
|
|
64229
64365
|
},
|
|
64230
64366
|
{
|
|
64231
64367
|
"kind": "property",
|
|
64232
|
-
"name": "
|
|
64368
|
+
"name": "cs",
|
|
64233
64369
|
"required": false,
|
|
64234
64370
|
"type": {
|
|
64235
|
-
"kind": "
|
|
64236
|
-
"
|
|
64371
|
+
"kind": "symbol",
|
|
64372
|
+
"name": "CSToPropsInput",
|
|
64373
|
+
"value": "CSToPropsInput"
|
|
64237
64374
|
},
|
|
64238
|
-
"description": "
|
|
64375
|
+
"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```",
|
|
64239
64376
|
"declarations": [
|
|
64240
64377
|
{
|
|
64241
|
-
"name": "
|
|
64242
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
64378
|
+
"name": "cs",
|
|
64379
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64243
64380
|
}
|
|
64244
64381
|
],
|
|
64245
|
-
"tags": {
|
|
64246
|
-
|
|
64382
|
+
"tags": {}
|
|
64383
|
+
},
|
|
64384
|
+
{
|
|
64385
|
+
"kind": "property",
|
|
64386
|
+
"name": "children",
|
|
64387
|
+
"description": "",
|
|
64388
|
+
"tags": {},
|
|
64389
|
+
"declarations": [],
|
|
64390
|
+
"type": {
|
|
64391
|
+
"kind": "external",
|
|
64392
|
+
"name": "React.ReactNode",
|
|
64393
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
64394
|
+
}
|
|
64395
|
+
},
|
|
64396
|
+
{
|
|
64397
|
+
"kind": "property",
|
|
64398
|
+
"name": "as",
|
|
64399
|
+
"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.",
|
|
64400
|
+
"tags": {},
|
|
64401
|
+
"declarations": [],
|
|
64402
|
+
"type": {
|
|
64403
|
+
"kind": "external",
|
|
64404
|
+
"name": "React.ElementType",
|
|
64405
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
64247
64406
|
},
|
|
64248
64407
|
"defaultValue": {
|
|
64249
|
-
"kind": "
|
|
64250
|
-
"
|
|
64408
|
+
"kind": "external",
|
|
64409
|
+
"name": "input",
|
|
64410
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
64251
64411
|
}
|
|
64252
64412
|
},
|
|
64253
64413
|
{
|
|
64254
64414
|
"kind": "property",
|
|
64255
|
-
"name": "
|
|
64256
|
-
"
|
|
64415
|
+
"name": "ref",
|
|
64416
|
+
"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`).",
|
|
64417
|
+
"tags": {},
|
|
64418
|
+
"declarations": [],
|
|
64257
64419
|
"type": {
|
|
64258
|
-
"kind": "
|
|
64259
|
-
"
|
|
64260
|
-
|
|
64261
|
-
|
|
64262
|
-
"value": "inverse"
|
|
64263
|
-
},
|
|
64420
|
+
"kind": "external",
|
|
64421
|
+
"name": "React.Ref",
|
|
64422
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
64423
|
+
"typeParameters": [
|
|
64264
64424
|
{
|
|
64265
|
-
"kind": "
|
|
64266
|
-
"
|
|
64425
|
+
"kind": "typeParameter",
|
|
64426
|
+
"name": "R",
|
|
64427
|
+
"required": true,
|
|
64428
|
+
"defaultValue": {
|
|
64429
|
+
"kind": "external",
|
|
64430
|
+
"name": "input",
|
|
64431
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
64432
|
+
}
|
|
64267
64433
|
}
|
|
64268
64434
|
]
|
|
64269
|
-
}
|
|
64270
|
-
|
|
64435
|
+
}
|
|
64436
|
+
}
|
|
64437
|
+
],
|
|
64438
|
+
"baseElement": {
|
|
64439
|
+
"kind": "external",
|
|
64440
|
+
"name": "input",
|
|
64441
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
64442
|
+
},
|
|
64443
|
+
"subComponents": [
|
|
64444
|
+
{
|
|
64445
|
+
"name": "ErrorType",
|
|
64446
|
+
"symbol": "ErrorType",
|
|
64447
|
+
"description": "",
|
|
64271
64448
|
"declarations": [
|
|
64272
64449
|
{
|
|
64273
|
-
"name": "
|
|
64450
|
+
"name": "ErrorType",
|
|
64274
64451
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/Checkbox.tsx"
|
|
64275
64452
|
}
|
|
64276
64453
|
],
|
|
64277
64454
|
"tags": {}
|
|
64455
|
+
}
|
|
64456
|
+
]
|
|
64457
|
+
}
|
|
64458
|
+
},
|
|
64459
|
+
{
|
|
64460
|
+
"name": "CheckboxCheck",
|
|
64461
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxCheck.tsx",
|
|
64462
|
+
"description": "",
|
|
64463
|
+
"declarations": [
|
|
64464
|
+
{
|
|
64465
|
+
"name": "CheckboxCheck",
|
|
64466
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxCheck.tsx"
|
|
64467
|
+
}
|
|
64468
|
+
],
|
|
64469
|
+
"tags": {},
|
|
64470
|
+
"type": {
|
|
64471
|
+
"kind": "enhancedComponent",
|
|
64472
|
+
"componentType": "regular",
|
|
64473
|
+
"displayName": "CheckboxCheck",
|
|
64474
|
+
"props": [
|
|
64475
|
+
{
|
|
64476
|
+
"kind": "property",
|
|
64477
|
+
"name": "checked",
|
|
64478
|
+
"required": true,
|
|
64479
|
+
"type": {
|
|
64480
|
+
"kind": "primitive",
|
|
64481
|
+
"value": "boolean"
|
|
64482
|
+
},
|
|
64483
|
+
"description": "",
|
|
64484
|
+
"declarations": [
|
|
64485
|
+
{
|
|
64486
|
+
"name": "checked",
|
|
64487
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxCheck.tsx"
|
|
64488
|
+
}
|
|
64489
|
+
],
|
|
64490
|
+
"tags": {}
|
|
64278
64491
|
},
|
|
64279
64492
|
{
|
|
64280
64493
|
"kind": "property",
|
|
64281
|
-
"name": "
|
|
64494
|
+
"name": "error",
|
|
64282
64495
|
"required": false,
|
|
64283
64496
|
"type": {
|
|
64284
64497
|
"kind": "symbol",
|
|
64285
|
-
"name": "
|
|
64286
|
-
"value": "
|
|
64498
|
+
"name": "ErrorType",
|
|
64499
|
+
"value": "ErrorType"
|
|
64287
64500
|
},
|
|
64288
64501
|
"description": "",
|
|
64289
64502
|
"declarations": [
|
|
64290
64503
|
{
|
|
64291
|
-
"name": "
|
|
64292
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/
|
|
64504
|
+
"name": "error",
|
|
64505
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxCheck.tsx"
|
|
64506
|
+
}
|
|
64507
|
+
],
|
|
64508
|
+
"tags": {}
|
|
64509
|
+
},
|
|
64510
|
+
{
|
|
64511
|
+
"kind": "property",
|
|
64512
|
+
"name": "indeterminate",
|
|
64513
|
+
"required": false,
|
|
64514
|
+
"type": {
|
|
64515
|
+
"kind": "primitive",
|
|
64516
|
+
"value": "boolean"
|
|
64517
|
+
},
|
|
64518
|
+
"description": "",
|
|
64519
|
+
"declarations": [
|
|
64520
|
+
{
|
|
64521
|
+
"name": "indeterminate",
|
|
64522
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxCheck.tsx"
|
|
64523
|
+
}
|
|
64524
|
+
],
|
|
64525
|
+
"tags": {}
|
|
64526
|
+
},
|
|
64527
|
+
{
|
|
64528
|
+
"kind": "property",
|
|
64529
|
+
"name": "variant",
|
|
64530
|
+
"required": false,
|
|
64531
|
+
"type": {
|
|
64532
|
+
"kind": "string",
|
|
64533
|
+
"value": "inverse"
|
|
64534
|
+
},
|
|
64535
|
+
"description": "",
|
|
64536
|
+
"declarations": [
|
|
64537
|
+
{
|
|
64538
|
+
"name": "variant",
|
|
64539
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxCheck.tsx"
|
|
64293
64540
|
}
|
|
64294
64541
|
],
|
|
64295
64542
|
"tags": {}
|
|
@@ -64319,8 +64566,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64319
64566
|
},
|
|
64320
64567
|
"defaultValue": {
|
|
64321
64568
|
"kind": "external",
|
|
64322
|
-
"name": "
|
|
64323
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
64569
|
+
"name": "div",
|
|
64570
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64324
64571
|
}
|
|
64325
64572
|
},
|
|
64326
64573
|
{
|
|
@@ -64340,8 +64587,8 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64340
64587
|
"required": true,
|
|
64341
64588
|
"defaultValue": {
|
|
64342
64589
|
"kind": "external",
|
|
64343
|
-
"name": "
|
|
64344
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
64590
|
+
"name": "div",
|
|
64591
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64345
64592
|
}
|
|
64346
64593
|
}
|
|
64347
64594
|
]
|
|
@@ -64350,18 +64597,430 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64350
64597
|
],
|
|
64351
64598
|
"baseElement": {
|
|
64352
64599
|
"kind": "external",
|
|
64353
|
-
"name": "
|
|
64354
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/
|
|
64355
|
-
}
|
|
64356
|
-
|
|
64600
|
+
"name": "div",
|
|
64601
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64602
|
+
}
|
|
64603
|
+
}
|
|
64604
|
+
},
|
|
64605
|
+
{
|
|
64606
|
+
"name": "inputVars",
|
|
64607
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx",
|
|
64608
|
+
"description": "",
|
|
64609
|
+
"declarations": [
|
|
64610
|
+
{
|
|
64611
|
+
"name": "inputVars",
|
|
64612
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64613
|
+
}
|
|
64614
|
+
],
|
|
64615
|
+
"tags": {},
|
|
64616
|
+
"type": {
|
|
64617
|
+
"kind": "symbol",
|
|
64618
|
+
"name": "CsVars",
|
|
64619
|
+
"value": "CsVars<\"errorInner\" | \"errorOuter\" | \"alertInner\" | \"alertOuter\", never>"
|
|
64620
|
+
}
|
|
64621
|
+
},
|
|
64622
|
+
{
|
|
64623
|
+
"name": "CheckboxContainer",
|
|
64624
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx",
|
|
64625
|
+
"description": "",
|
|
64626
|
+
"declarations": [
|
|
64627
|
+
{
|
|
64628
|
+
"name": "CheckboxContainer",
|
|
64629
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64630
|
+
}
|
|
64631
|
+
],
|
|
64632
|
+
"tags": {},
|
|
64633
|
+
"type": {
|
|
64634
|
+
"kind": "enhancedComponent",
|
|
64635
|
+
"componentType": "regular",
|
|
64636
|
+
"displayName": "CheckboxContainer",
|
|
64637
|
+
"props": [
|
|
64357
64638
|
{
|
|
64358
|
-
"
|
|
64359
|
-
"
|
|
64639
|
+
"kind": "property",
|
|
64640
|
+
"name": "children",
|
|
64641
|
+
"required": true,
|
|
64642
|
+
"type": {
|
|
64643
|
+
"kind": "external",
|
|
64644
|
+
"name": "ReactNode",
|
|
64645
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
64646
|
+
},
|
|
64360
64647
|
"description": "",
|
|
64361
64648
|
"declarations": [
|
|
64362
64649
|
{
|
|
64363
|
-
"name": "
|
|
64364
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/
|
|
64650
|
+
"name": "children",
|
|
64651
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64652
|
+
}
|
|
64653
|
+
],
|
|
64654
|
+
"tags": {}
|
|
64655
|
+
},
|
|
64656
|
+
{
|
|
64657
|
+
"kind": "property",
|
|
64658
|
+
"name": "disabled",
|
|
64659
|
+
"required": false,
|
|
64660
|
+
"type": {
|
|
64661
|
+
"kind": "primitive",
|
|
64662
|
+
"value": "boolean"
|
|
64663
|
+
},
|
|
64664
|
+
"description": "",
|
|
64665
|
+
"declarations": [
|
|
64666
|
+
{
|
|
64667
|
+
"name": "disabled",
|
|
64668
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64669
|
+
}
|
|
64670
|
+
],
|
|
64671
|
+
"tags": {}
|
|
64672
|
+
},
|
|
64673
|
+
{
|
|
64674
|
+
"kind": "property",
|
|
64675
|
+
"name": "id",
|
|
64676
|
+
"required": true,
|
|
64677
|
+
"type": {
|
|
64678
|
+
"kind": "primitive",
|
|
64679
|
+
"value": "string"
|
|
64680
|
+
},
|
|
64681
|
+
"description": "",
|
|
64682
|
+
"declarations": [
|
|
64683
|
+
{
|
|
64684
|
+
"name": "id",
|
|
64685
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64686
|
+
}
|
|
64687
|
+
],
|
|
64688
|
+
"tags": {}
|
|
64689
|
+
},
|
|
64690
|
+
{
|
|
64691
|
+
"kind": "property",
|
|
64692
|
+
"name": "label",
|
|
64693
|
+
"required": true,
|
|
64694
|
+
"type": {
|
|
64695
|
+
"kind": "primitive",
|
|
64696
|
+
"value": "string"
|
|
64697
|
+
},
|
|
64698
|
+
"description": "",
|
|
64699
|
+
"declarations": [
|
|
64700
|
+
{
|
|
64701
|
+
"name": "label",
|
|
64702
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64703
|
+
}
|
|
64704
|
+
],
|
|
64705
|
+
"tags": {}
|
|
64706
|
+
},
|
|
64707
|
+
{
|
|
64708
|
+
"kind": "property",
|
|
64709
|
+
"name": "variant",
|
|
64710
|
+
"required": false,
|
|
64711
|
+
"type": {
|
|
64712
|
+
"kind": "string",
|
|
64713
|
+
"value": "inverse"
|
|
64714
|
+
},
|
|
64715
|
+
"description": "",
|
|
64716
|
+
"declarations": [
|
|
64717
|
+
{
|
|
64718
|
+
"name": "variant",
|
|
64719
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64720
|
+
}
|
|
64721
|
+
],
|
|
64722
|
+
"tags": {}
|
|
64723
|
+
},
|
|
64724
|
+
{
|
|
64725
|
+
"kind": "property",
|
|
64726
|
+
"name": "cs",
|
|
64727
|
+
"required": false,
|
|
64728
|
+
"type": {
|
|
64729
|
+
"kind": "symbol",
|
|
64730
|
+
"name": "CSToPropsInput",
|
|
64731
|
+
"value": "CSToPropsInput"
|
|
64732
|
+
},
|
|
64733
|
+
"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```",
|
|
64734
|
+
"declarations": [
|
|
64735
|
+
{
|
|
64736
|
+
"name": "cs",
|
|
64737
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64738
|
+
}
|
|
64739
|
+
],
|
|
64740
|
+
"tags": {}
|
|
64741
|
+
},
|
|
64742
|
+
{
|
|
64743
|
+
"kind": "property",
|
|
64744
|
+
"name": "as",
|
|
64745
|
+
"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.",
|
|
64746
|
+
"tags": {},
|
|
64747
|
+
"declarations": [],
|
|
64748
|
+
"type": {
|
|
64749
|
+
"kind": "external",
|
|
64750
|
+
"name": "React.ElementType",
|
|
64751
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
64752
|
+
},
|
|
64753
|
+
"defaultValue": {
|
|
64754
|
+
"kind": "external",
|
|
64755
|
+
"name": "div",
|
|
64756
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64757
|
+
}
|
|
64758
|
+
},
|
|
64759
|
+
{
|
|
64760
|
+
"kind": "property",
|
|
64761
|
+
"name": "ref",
|
|
64762
|
+
"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`).",
|
|
64763
|
+
"tags": {},
|
|
64764
|
+
"declarations": [],
|
|
64765
|
+
"type": {
|
|
64766
|
+
"kind": "external",
|
|
64767
|
+
"name": "React.Ref",
|
|
64768
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
64769
|
+
"typeParameters": [
|
|
64770
|
+
{
|
|
64771
|
+
"kind": "typeParameter",
|
|
64772
|
+
"name": "R",
|
|
64773
|
+
"required": true,
|
|
64774
|
+
"defaultValue": {
|
|
64775
|
+
"kind": "external",
|
|
64776
|
+
"name": "div",
|
|
64777
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64778
|
+
}
|
|
64779
|
+
}
|
|
64780
|
+
]
|
|
64781
|
+
}
|
|
64782
|
+
}
|
|
64783
|
+
],
|
|
64784
|
+
"baseElement": {
|
|
64785
|
+
"kind": "external",
|
|
64786
|
+
"name": "div",
|
|
64787
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
64788
|
+
}
|
|
64789
|
+
}
|
|
64790
|
+
},
|
|
64791
|
+
{
|
|
64792
|
+
"name": "CheckboxProps",
|
|
64793
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx",
|
|
64794
|
+
"description": "",
|
|
64795
|
+
"declarations": [
|
|
64796
|
+
{
|
|
64797
|
+
"name": "CheckboxProps",
|
|
64798
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64799
|
+
}
|
|
64800
|
+
],
|
|
64801
|
+
"tags": {},
|
|
64802
|
+
"type": {
|
|
64803
|
+
"kind": "object",
|
|
64804
|
+
"properties": [
|
|
64805
|
+
{
|
|
64806
|
+
"kind": "property",
|
|
64807
|
+
"name": "checked",
|
|
64808
|
+
"required": false,
|
|
64809
|
+
"type": {
|
|
64810
|
+
"kind": "primitive",
|
|
64811
|
+
"value": "boolean"
|
|
64812
|
+
},
|
|
64813
|
+
"description": "If true, set the Checkbox to the checked state.",
|
|
64814
|
+
"declarations": [
|
|
64815
|
+
{
|
|
64816
|
+
"name": "checked",
|
|
64817
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64818
|
+
}
|
|
64819
|
+
],
|
|
64820
|
+
"tags": {
|
|
64821
|
+
"default": "false"
|
|
64822
|
+
}
|
|
64823
|
+
},
|
|
64824
|
+
{
|
|
64825
|
+
"kind": "property",
|
|
64826
|
+
"name": "disabled",
|
|
64827
|
+
"required": false,
|
|
64828
|
+
"type": {
|
|
64829
|
+
"kind": "primitive",
|
|
64830
|
+
"value": "boolean"
|
|
64831
|
+
},
|
|
64832
|
+
"description": "If true, set the Checkbox to the disabled state.",
|
|
64833
|
+
"declarations": [
|
|
64834
|
+
{
|
|
64835
|
+
"name": "disabled",
|
|
64836
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64837
|
+
}
|
|
64838
|
+
],
|
|
64839
|
+
"tags": {
|
|
64840
|
+
"default": "false"
|
|
64841
|
+
}
|
|
64842
|
+
},
|
|
64843
|
+
{
|
|
64844
|
+
"kind": "property",
|
|
64845
|
+
"name": "error",
|
|
64846
|
+
"required": false,
|
|
64847
|
+
"type": {
|
|
64848
|
+
"kind": "symbol",
|
|
64849
|
+
"name": "ErrorType",
|
|
64850
|
+
"value": "ErrorType"
|
|
64851
|
+
},
|
|
64852
|
+
"description": "The type of error associated with the Checkbox (if applicable).",
|
|
64853
|
+
"declarations": [
|
|
64854
|
+
{
|
|
64855
|
+
"name": "error",
|
|
64856
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64857
|
+
}
|
|
64858
|
+
],
|
|
64859
|
+
"tags": {}
|
|
64860
|
+
},
|
|
64861
|
+
{
|
|
64862
|
+
"kind": "property",
|
|
64863
|
+
"name": "id",
|
|
64864
|
+
"required": false,
|
|
64865
|
+
"type": {
|
|
64866
|
+
"kind": "primitive",
|
|
64867
|
+
"value": "string"
|
|
64868
|
+
},
|
|
64869
|
+
"description": "The HTML `id` of the underlying checkbox input element. This is required if `label` is defined as a non-empty string.",
|
|
64870
|
+
"declarations": [
|
|
64871
|
+
{
|
|
64872
|
+
"name": "id",
|
|
64873
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64874
|
+
}
|
|
64875
|
+
],
|
|
64876
|
+
"tags": {
|
|
64877
|
+
"default": "{useUniqueId}"
|
|
64878
|
+
}
|
|
64879
|
+
},
|
|
64880
|
+
{
|
|
64881
|
+
"kind": "property",
|
|
64882
|
+
"name": "indeterminate",
|
|
64883
|
+
"required": false,
|
|
64884
|
+
"type": {
|
|
64885
|
+
"kind": "primitive",
|
|
64886
|
+
"value": "boolean"
|
|
64887
|
+
},
|
|
64888
|
+
"description": "If true, set the Checkbox to an indeterminate state. Use this on a Checkbox with nested child Checkboxes to denote that some (but not all) child Checkboxes are checked.",
|
|
64889
|
+
"declarations": [
|
|
64890
|
+
{
|
|
64891
|
+
"name": "indeterminate",
|
|
64892
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64893
|
+
}
|
|
64894
|
+
],
|
|
64895
|
+
"tags": {
|
|
64896
|
+
"default": "false"
|
|
64897
|
+
}
|
|
64898
|
+
},
|
|
64899
|
+
{
|
|
64900
|
+
"kind": "property",
|
|
64901
|
+
"name": "label",
|
|
64902
|
+
"required": false,
|
|
64903
|
+
"type": {
|
|
64904
|
+
"kind": "primitive",
|
|
64905
|
+
"value": "string"
|
|
64906
|
+
},
|
|
64907
|
+
"description": "The text of the Checkbox label.",
|
|
64908
|
+
"declarations": [
|
|
64909
|
+
{
|
|
64910
|
+
"name": "label",
|
|
64911
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64912
|
+
}
|
|
64913
|
+
],
|
|
64914
|
+
"tags": {
|
|
64915
|
+
"default": "''"
|
|
64916
|
+
}
|
|
64917
|
+
},
|
|
64918
|
+
{
|
|
64919
|
+
"kind": "property",
|
|
64920
|
+
"name": "onChange",
|
|
64921
|
+
"required": false,
|
|
64922
|
+
"type": {
|
|
64923
|
+
"kind": "function",
|
|
64924
|
+
"parameters": [
|
|
64925
|
+
{
|
|
64926
|
+
"kind": "parameter",
|
|
64927
|
+
"name": "e",
|
|
64928
|
+
"type": {
|
|
64929
|
+
"kind": "symbol",
|
|
64930
|
+
"name": "React.ChangeEvent",
|
|
64931
|
+
"typeParameters": [
|
|
64932
|
+
{
|
|
64933
|
+
"kind": "symbol",
|
|
64934
|
+
"name": "HTMLInputElement",
|
|
64935
|
+
"value": "HTMLInputElement"
|
|
64936
|
+
}
|
|
64937
|
+
],
|
|
64938
|
+
"value": "ChangeEvent<T>"
|
|
64939
|
+
},
|
|
64940
|
+
"required": true,
|
|
64941
|
+
"rest": false,
|
|
64942
|
+
"description": "",
|
|
64943
|
+
"declarations": [
|
|
64944
|
+
{
|
|
64945
|
+
"name": "e",
|
|
64946
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64947
|
+
}
|
|
64948
|
+
],
|
|
64949
|
+
"tags": {}
|
|
64950
|
+
}
|
|
64951
|
+
],
|
|
64952
|
+
"members": [],
|
|
64953
|
+
"returnType": {
|
|
64954
|
+
"kind": "primitive",
|
|
64955
|
+
"value": "void"
|
|
64956
|
+
}
|
|
64957
|
+
},
|
|
64958
|
+
"description": "The function called when the Checkbox state changes.",
|
|
64959
|
+
"declarations": [
|
|
64960
|
+
{
|
|
64961
|
+
"name": "onChange",
|
|
64962
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64963
|
+
}
|
|
64964
|
+
],
|
|
64965
|
+
"tags": {}
|
|
64966
|
+
},
|
|
64967
|
+
{
|
|
64968
|
+
"kind": "property",
|
|
64969
|
+
"name": "value",
|
|
64970
|
+
"required": false,
|
|
64971
|
+
"type": {
|
|
64972
|
+
"kind": "primitive",
|
|
64973
|
+
"value": "string"
|
|
64974
|
+
},
|
|
64975
|
+
"description": "The value of the Checkbox.",
|
|
64976
|
+
"declarations": [
|
|
64977
|
+
{
|
|
64978
|
+
"name": "value",
|
|
64979
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
64980
|
+
}
|
|
64981
|
+
],
|
|
64982
|
+
"tags": {}
|
|
64983
|
+
},
|
|
64984
|
+
{
|
|
64985
|
+
"kind": "property",
|
|
64986
|
+
"name": "variant",
|
|
64987
|
+
"required": false,
|
|
64988
|
+
"type": {
|
|
64989
|
+
"kind": "union",
|
|
64990
|
+
"value": [
|
|
64991
|
+
{
|
|
64992
|
+
"kind": "string",
|
|
64993
|
+
"value": "inverse"
|
|
64994
|
+
},
|
|
64995
|
+
{
|
|
64996
|
+
"kind": "primitive",
|
|
64997
|
+
"value": "undefined"
|
|
64998
|
+
}
|
|
64999
|
+
]
|
|
65000
|
+
},
|
|
65001
|
+
"description": "The variant for the checkbox",
|
|
65002
|
+
"declarations": [
|
|
65003
|
+
{
|
|
65004
|
+
"name": "variant",
|
|
65005
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65006
|
+
}
|
|
65007
|
+
],
|
|
65008
|
+
"tags": {}
|
|
65009
|
+
},
|
|
65010
|
+
{
|
|
65011
|
+
"kind": "property",
|
|
65012
|
+
"name": "cs",
|
|
65013
|
+
"required": false,
|
|
65014
|
+
"type": {
|
|
65015
|
+
"kind": "symbol",
|
|
65016
|
+
"name": "CSToPropsInput",
|
|
65017
|
+
"value": "CSToPropsInput"
|
|
65018
|
+
},
|
|
65019
|
+
"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```",
|
|
65020
|
+
"declarations": [
|
|
65021
|
+
{
|
|
65022
|
+
"name": "cs",
|
|
65023
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64365
65024
|
}
|
|
64366
65025
|
],
|
|
64367
65026
|
"tags": {}
|
|
@@ -64369,6 +65028,405 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64369
65028
|
]
|
|
64370
65029
|
}
|
|
64371
65030
|
},
|
|
65031
|
+
{
|
|
65032
|
+
"name": "CheckboxInput",
|
|
65033
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx",
|
|
65034
|
+
"description": "",
|
|
65035
|
+
"declarations": [
|
|
65036
|
+
{
|
|
65037
|
+
"name": "CheckboxInput",
|
|
65038
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65039
|
+
}
|
|
65040
|
+
],
|
|
65041
|
+
"tags": {},
|
|
65042
|
+
"type": {
|
|
65043
|
+
"kind": "enhancedComponent",
|
|
65044
|
+
"componentType": "regular",
|
|
65045
|
+
"displayName": "CheckboxInput",
|
|
65046
|
+
"props": [
|
|
65047
|
+
{
|
|
65048
|
+
"kind": "property",
|
|
65049
|
+
"name": "checked",
|
|
65050
|
+
"required": false,
|
|
65051
|
+
"type": {
|
|
65052
|
+
"kind": "primitive",
|
|
65053
|
+
"value": "boolean"
|
|
65054
|
+
},
|
|
65055
|
+
"description": "If true, set the Checkbox to the checked state.",
|
|
65056
|
+
"declarations": [
|
|
65057
|
+
{
|
|
65058
|
+
"name": "checked",
|
|
65059
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65060
|
+
}
|
|
65061
|
+
],
|
|
65062
|
+
"tags": {
|
|
65063
|
+
"default": "false"
|
|
65064
|
+
},
|
|
65065
|
+
"defaultValue": {
|
|
65066
|
+
"kind": "boolean",
|
|
65067
|
+
"value": false
|
|
65068
|
+
}
|
|
65069
|
+
},
|
|
65070
|
+
{
|
|
65071
|
+
"kind": "property",
|
|
65072
|
+
"name": "disabled",
|
|
65073
|
+
"required": false,
|
|
65074
|
+
"type": {
|
|
65075
|
+
"kind": "primitive",
|
|
65076
|
+
"value": "boolean"
|
|
65077
|
+
},
|
|
65078
|
+
"description": "If true, set the Checkbox to the disabled state.",
|
|
65079
|
+
"declarations": [
|
|
65080
|
+
{
|
|
65081
|
+
"name": "disabled",
|
|
65082
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65083
|
+
}
|
|
65084
|
+
],
|
|
65085
|
+
"tags": {
|
|
65086
|
+
"default": "false"
|
|
65087
|
+
},
|
|
65088
|
+
"defaultValue": {
|
|
65089
|
+
"kind": "boolean",
|
|
65090
|
+
"value": false
|
|
65091
|
+
}
|
|
65092
|
+
},
|
|
65093
|
+
{
|
|
65094
|
+
"kind": "property",
|
|
65095
|
+
"name": "error",
|
|
65096
|
+
"required": false,
|
|
65097
|
+
"type": {
|
|
65098
|
+
"kind": "symbol",
|
|
65099
|
+
"name": "ErrorType",
|
|
65100
|
+
"value": "ErrorType"
|
|
65101
|
+
},
|
|
65102
|
+
"description": "The type of error associated with the Checkbox (if applicable).",
|
|
65103
|
+
"declarations": [
|
|
65104
|
+
{
|
|
65105
|
+
"name": "error",
|
|
65106
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65107
|
+
}
|
|
65108
|
+
],
|
|
65109
|
+
"tags": {}
|
|
65110
|
+
},
|
|
65111
|
+
{
|
|
65112
|
+
"kind": "property",
|
|
65113
|
+
"name": "id",
|
|
65114
|
+
"required": false,
|
|
65115
|
+
"type": {
|
|
65116
|
+
"kind": "primitive",
|
|
65117
|
+
"value": "string"
|
|
65118
|
+
},
|
|
65119
|
+
"description": "The HTML `id` of the underlying checkbox input element. This is required if `label` is defined as a non-empty string.",
|
|
65120
|
+
"declarations": [
|
|
65121
|
+
{
|
|
65122
|
+
"name": "id",
|
|
65123
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65124
|
+
}
|
|
65125
|
+
],
|
|
65126
|
+
"tags": {
|
|
65127
|
+
"default": "{useUniqueId}"
|
|
65128
|
+
},
|
|
65129
|
+
"defaultValue": {
|
|
65130
|
+
"kind": "symbol",
|
|
65131
|
+
"name": "useUniqueId",
|
|
65132
|
+
"value": "useUniqueId"
|
|
65133
|
+
}
|
|
65134
|
+
},
|
|
65135
|
+
{
|
|
65136
|
+
"kind": "property",
|
|
65137
|
+
"name": "indeterminate",
|
|
65138
|
+
"required": false,
|
|
65139
|
+
"type": {
|
|
65140
|
+
"kind": "primitive",
|
|
65141
|
+
"value": "boolean"
|
|
65142
|
+
},
|
|
65143
|
+
"description": "If true, set the Checkbox to an indeterminate state. Use this on a Checkbox with nested child Checkboxes to denote that some (but not all) child Checkboxes are checked.",
|
|
65144
|
+
"declarations": [
|
|
65145
|
+
{
|
|
65146
|
+
"name": "indeterminate",
|
|
65147
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65148
|
+
}
|
|
65149
|
+
],
|
|
65150
|
+
"tags": {
|
|
65151
|
+
"default": "false"
|
|
65152
|
+
},
|
|
65153
|
+
"defaultValue": {
|
|
65154
|
+
"kind": "boolean",
|
|
65155
|
+
"value": false
|
|
65156
|
+
}
|
|
65157
|
+
},
|
|
65158
|
+
{
|
|
65159
|
+
"kind": "property",
|
|
65160
|
+
"name": "label",
|
|
65161
|
+
"required": false,
|
|
65162
|
+
"type": {
|
|
65163
|
+
"kind": "primitive",
|
|
65164
|
+
"value": "string"
|
|
65165
|
+
},
|
|
65166
|
+
"description": "The text of the Checkbox label.",
|
|
65167
|
+
"declarations": [
|
|
65168
|
+
{
|
|
65169
|
+
"name": "label",
|
|
65170
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65171
|
+
}
|
|
65172
|
+
],
|
|
65173
|
+
"tags": {
|
|
65174
|
+
"default": "''"
|
|
65175
|
+
},
|
|
65176
|
+
"defaultValue": {
|
|
65177
|
+
"kind": "symbol",
|
|
65178
|
+
"name": "''",
|
|
65179
|
+
"value": "''"
|
|
65180
|
+
}
|
|
65181
|
+
},
|
|
65182
|
+
{
|
|
65183
|
+
"kind": "property",
|
|
65184
|
+
"name": "onChange",
|
|
65185
|
+
"required": false,
|
|
65186
|
+
"type": {
|
|
65187
|
+
"kind": "function",
|
|
65188
|
+
"parameters": [
|
|
65189
|
+
{
|
|
65190
|
+
"kind": "parameter",
|
|
65191
|
+
"name": "e",
|
|
65192
|
+
"type": {
|
|
65193
|
+
"kind": "symbol",
|
|
65194
|
+
"name": "React.ChangeEvent",
|
|
65195
|
+
"typeParameters": [
|
|
65196
|
+
{
|
|
65197
|
+
"kind": "symbol",
|
|
65198
|
+
"name": "HTMLInputElement",
|
|
65199
|
+
"value": "HTMLInputElement"
|
|
65200
|
+
}
|
|
65201
|
+
],
|
|
65202
|
+
"value": "ChangeEvent<T>"
|
|
65203
|
+
},
|
|
65204
|
+
"required": true,
|
|
65205
|
+
"rest": false,
|
|
65206
|
+
"description": "",
|
|
65207
|
+
"declarations": [
|
|
65208
|
+
{
|
|
65209
|
+
"name": "e",
|
|
65210
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65211
|
+
}
|
|
65212
|
+
],
|
|
65213
|
+
"tags": {}
|
|
65214
|
+
}
|
|
65215
|
+
],
|
|
65216
|
+
"members": [],
|
|
65217
|
+
"returnType": {
|
|
65218
|
+
"kind": "primitive",
|
|
65219
|
+
"value": "void"
|
|
65220
|
+
}
|
|
65221
|
+
},
|
|
65222
|
+
"description": "The function called when the Checkbox state changes.",
|
|
65223
|
+
"declarations": [
|
|
65224
|
+
{
|
|
65225
|
+
"name": "onChange",
|
|
65226
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65227
|
+
}
|
|
65228
|
+
],
|
|
65229
|
+
"tags": {}
|
|
65230
|
+
},
|
|
65231
|
+
{
|
|
65232
|
+
"kind": "property",
|
|
65233
|
+
"name": "value",
|
|
65234
|
+
"required": false,
|
|
65235
|
+
"type": {
|
|
65236
|
+
"kind": "primitive",
|
|
65237
|
+
"value": "string"
|
|
65238
|
+
},
|
|
65239
|
+
"description": "The value of the Checkbox.",
|
|
65240
|
+
"declarations": [
|
|
65241
|
+
{
|
|
65242
|
+
"name": "value",
|
|
65243
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65244
|
+
}
|
|
65245
|
+
],
|
|
65246
|
+
"tags": {}
|
|
65247
|
+
},
|
|
65248
|
+
{
|
|
65249
|
+
"kind": "property",
|
|
65250
|
+
"name": "variant",
|
|
65251
|
+
"required": false,
|
|
65252
|
+
"type": {
|
|
65253
|
+
"kind": "union",
|
|
65254
|
+
"value": [
|
|
65255
|
+
{
|
|
65256
|
+
"kind": "string",
|
|
65257
|
+
"value": "inverse"
|
|
65258
|
+
},
|
|
65259
|
+
{
|
|
65260
|
+
"kind": "primitive",
|
|
65261
|
+
"value": "undefined"
|
|
65262
|
+
}
|
|
65263
|
+
]
|
|
65264
|
+
},
|
|
65265
|
+
"description": "The variant for the checkbox",
|
|
65266
|
+
"declarations": [
|
|
65267
|
+
{
|
|
65268
|
+
"name": "variant",
|
|
65269
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxInput.tsx"
|
|
65270
|
+
}
|
|
65271
|
+
],
|
|
65272
|
+
"tags": {}
|
|
65273
|
+
},
|
|
65274
|
+
{
|
|
65275
|
+
"kind": "property",
|
|
65276
|
+
"name": "cs",
|
|
65277
|
+
"required": false,
|
|
65278
|
+
"type": {
|
|
65279
|
+
"kind": "symbol",
|
|
65280
|
+
"name": "CSToPropsInput",
|
|
65281
|
+
"value": "CSToPropsInput"
|
|
65282
|
+
},
|
|
65283
|
+
"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```",
|
|
65284
|
+
"declarations": [
|
|
65285
|
+
{
|
|
65286
|
+
"name": "cs",
|
|
65287
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
65288
|
+
}
|
|
65289
|
+
],
|
|
65290
|
+
"tags": {}
|
|
65291
|
+
},
|
|
65292
|
+
{
|
|
65293
|
+
"kind": "property",
|
|
65294
|
+
"name": "children",
|
|
65295
|
+
"description": "",
|
|
65296
|
+
"tags": {},
|
|
65297
|
+
"declarations": [],
|
|
65298
|
+
"type": {
|
|
65299
|
+
"kind": "external",
|
|
65300
|
+
"name": "React.ReactNode",
|
|
65301
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
65302
|
+
}
|
|
65303
|
+
},
|
|
65304
|
+
{
|
|
65305
|
+
"kind": "property",
|
|
65306
|
+
"name": "as",
|
|
65307
|
+
"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.",
|
|
65308
|
+
"tags": {},
|
|
65309
|
+
"declarations": [],
|
|
65310
|
+
"type": {
|
|
65311
|
+
"kind": "external",
|
|
65312
|
+
"name": "React.ElementType",
|
|
65313
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
65314
|
+
},
|
|
65315
|
+
"defaultValue": {
|
|
65316
|
+
"kind": "external",
|
|
65317
|
+
"name": "input",
|
|
65318
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
65319
|
+
}
|
|
65320
|
+
},
|
|
65321
|
+
{
|
|
65322
|
+
"kind": "property",
|
|
65323
|
+
"name": "ref",
|
|
65324
|
+
"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`).",
|
|
65325
|
+
"tags": {},
|
|
65326
|
+
"declarations": [],
|
|
65327
|
+
"type": {
|
|
65328
|
+
"kind": "external",
|
|
65329
|
+
"name": "React.Ref",
|
|
65330
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
65331
|
+
"typeParameters": [
|
|
65332
|
+
{
|
|
65333
|
+
"kind": "typeParameter",
|
|
65334
|
+
"name": "R",
|
|
65335
|
+
"required": true,
|
|
65336
|
+
"defaultValue": {
|
|
65337
|
+
"kind": "external",
|
|
65338
|
+
"name": "input",
|
|
65339
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
65340
|
+
}
|
|
65341
|
+
}
|
|
65342
|
+
]
|
|
65343
|
+
}
|
|
65344
|
+
}
|
|
65345
|
+
],
|
|
65346
|
+
"baseElement": {
|
|
65347
|
+
"kind": "external",
|
|
65348
|
+
"name": "input",
|
|
65349
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input"
|
|
65350
|
+
}
|
|
65351
|
+
}
|
|
65352
|
+
},
|
|
65353
|
+
{
|
|
65354
|
+
"name": "CheckboxRipple",
|
|
65355
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxRipple.tsx",
|
|
65356
|
+
"description": "",
|
|
65357
|
+
"declarations": [
|
|
65358
|
+
{
|
|
65359
|
+
"name": "CheckboxRipple",
|
|
65360
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxRipple.tsx"
|
|
65361
|
+
}
|
|
65362
|
+
],
|
|
65363
|
+
"tags": {},
|
|
65364
|
+
"type": {
|
|
65365
|
+
"kind": "enhancedComponent",
|
|
65366
|
+
"componentType": "regular",
|
|
65367
|
+
"displayName": "CheckboxRipple",
|
|
65368
|
+
"props": [
|
|
65369
|
+
{
|
|
65370
|
+
"kind": "property",
|
|
65371
|
+
"name": "children",
|
|
65372
|
+
"description": "",
|
|
65373
|
+
"tags": {},
|
|
65374
|
+
"declarations": [],
|
|
65375
|
+
"type": {
|
|
65376
|
+
"kind": "external",
|
|
65377
|
+
"name": "React.ReactNode",
|
|
65378
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
65379
|
+
}
|
|
65380
|
+
},
|
|
65381
|
+
{
|
|
65382
|
+
"kind": "property",
|
|
65383
|
+
"name": "as",
|
|
65384
|
+
"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.",
|
|
65385
|
+
"tags": {},
|
|
65386
|
+
"declarations": [],
|
|
65387
|
+
"type": {
|
|
65388
|
+
"kind": "external",
|
|
65389
|
+
"name": "React.ElementType",
|
|
65390
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
65391
|
+
},
|
|
65392
|
+
"defaultValue": {
|
|
65393
|
+
"kind": "external",
|
|
65394
|
+
"name": "span",
|
|
65395
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
65396
|
+
}
|
|
65397
|
+
},
|
|
65398
|
+
{
|
|
65399
|
+
"kind": "property",
|
|
65400
|
+
"name": "ref",
|
|
65401
|
+
"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`).",
|
|
65402
|
+
"tags": {},
|
|
65403
|
+
"declarations": [],
|
|
65404
|
+
"type": {
|
|
65405
|
+
"kind": "external",
|
|
65406
|
+
"name": "React.Ref",
|
|
65407
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
65408
|
+
"typeParameters": [
|
|
65409
|
+
{
|
|
65410
|
+
"kind": "typeParameter",
|
|
65411
|
+
"name": "R",
|
|
65412
|
+
"required": true,
|
|
65413
|
+
"defaultValue": {
|
|
65414
|
+
"kind": "external",
|
|
65415
|
+
"name": "span",
|
|
65416
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
65417
|
+
}
|
|
65418
|
+
}
|
|
65419
|
+
]
|
|
65420
|
+
}
|
|
65421
|
+
}
|
|
65422
|
+
],
|
|
65423
|
+
"baseElement": {
|
|
65424
|
+
"kind": "external",
|
|
65425
|
+
"name": "span",
|
|
65426
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/span"
|
|
65427
|
+
}
|
|
65428
|
+
}
|
|
65429
|
+
},
|
|
64372
65430
|
{
|
|
64373
65431
|
"name": "orientationKeyMap",
|
|
64374
65432
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/collection/lib/keyUtils.ts",
|
|
@@ -249156,6 +250214,90 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249156
250214
|
}
|
|
249157
250215
|
}
|
|
249158
250216
|
},
|
|
250217
|
+
{
|
|
250218
|
+
"name": "createObjectTransform",
|
|
250219
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/createObjectTransform.ts",
|
|
250220
|
+
"description": "Object transforms take an AST node that represents a style object and turn it into a\n`NestedStyleObject` or return `void`. If an object transform returns an object, transformation\nparsing stops on that node. If `void` is returned, processing continues using\n`parseObjectToStaticValue`. These transforms are useful if you have custom utility functions\nthat are not statically parsable by the static styling transformer.",
|
|
250221
|
+
"declarations": [
|
|
250222
|
+
{
|
|
250223
|
+
"name": "createObjectTransform",
|
|
250224
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/createObjectTransform.ts"
|
|
250225
|
+
}
|
|
250226
|
+
],
|
|
250227
|
+
"tags": {},
|
|
250228
|
+
"type": {
|
|
250229
|
+
"kind": "function",
|
|
250230
|
+
"parameters": [
|
|
250231
|
+
{
|
|
250232
|
+
"kind": "parameter",
|
|
250233
|
+
"name": "transformFn",
|
|
250234
|
+
"type": {
|
|
250235
|
+
"kind": "symbol",
|
|
250236
|
+
"name": "ObjectTransform",
|
|
250237
|
+
"value": "ObjectTransform"
|
|
250238
|
+
},
|
|
250239
|
+
"required": true,
|
|
250240
|
+
"rest": false,
|
|
250241
|
+
"description": "",
|
|
250242
|
+
"declarations": [
|
|
250243
|
+
{
|
|
250244
|
+
"name": "transformFn",
|
|
250245
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/createObjectTransform.ts"
|
|
250246
|
+
}
|
|
250247
|
+
],
|
|
250248
|
+
"tags": {}
|
|
250249
|
+
}
|
|
250250
|
+
],
|
|
250251
|
+
"members": [],
|
|
250252
|
+
"returnType": {
|
|
250253
|
+
"kind": "symbol",
|
|
250254
|
+
"name": "ObjectTransform",
|
|
250255
|
+
"value": "ObjectTransform"
|
|
250256
|
+
}
|
|
250257
|
+
}
|
|
250258
|
+
},
|
|
250259
|
+
{
|
|
250260
|
+
"name": "createPropertyTransform",
|
|
250261
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/createPropertyTransform.ts",
|
|
250262
|
+
"description": "A property transform takes a style property node and will return a string. You can use\n`parseNodeToStaticValue` to help you process properties that might be inputs to a function.",
|
|
250263
|
+
"declarations": [
|
|
250264
|
+
{
|
|
250265
|
+
"name": "createPropertyTransform",
|
|
250266
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/createPropertyTransform.ts"
|
|
250267
|
+
}
|
|
250268
|
+
],
|
|
250269
|
+
"tags": {},
|
|
250270
|
+
"type": {
|
|
250271
|
+
"kind": "function",
|
|
250272
|
+
"parameters": [
|
|
250273
|
+
{
|
|
250274
|
+
"kind": "parameter",
|
|
250275
|
+
"name": "transformFn",
|
|
250276
|
+
"type": {
|
|
250277
|
+
"kind": "symbol",
|
|
250278
|
+
"name": "PropertyTransform",
|
|
250279
|
+
"value": "PropertyTransform"
|
|
250280
|
+
},
|
|
250281
|
+
"required": true,
|
|
250282
|
+
"rest": false,
|
|
250283
|
+
"description": "",
|
|
250284
|
+
"declarations": [
|
|
250285
|
+
{
|
|
250286
|
+
"name": "transformFn",
|
|
250287
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/createPropertyTransform.ts"
|
|
250288
|
+
}
|
|
250289
|
+
],
|
|
250290
|
+
"tags": {}
|
|
250291
|
+
}
|
|
250292
|
+
],
|
|
250293
|
+
"members": [],
|
|
250294
|
+
"returnType": {
|
|
250295
|
+
"kind": "symbol",
|
|
250296
|
+
"name": "PropertyTransform",
|
|
250297
|
+
"value": "PropertyTransform"
|
|
250298
|
+
}
|
|
250299
|
+
}
|
|
250300
|
+
},
|
|
249159
250301
|
{
|
|
249160
250302
|
"name": "NestedStyleObject",
|
|
249161
250303
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
@@ -249208,6 +250350,65 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249208
250350
|
"type": {
|
|
249209
250351
|
"kind": "object",
|
|
249210
250352
|
"properties": [
|
|
250353
|
+
{
|
|
250354
|
+
"kind": "property",
|
|
250355
|
+
"name": "fallbackFiles",
|
|
250356
|
+
"required": false,
|
|
250357
|
+
"type": {
|
|
250358
|
+
"kind": "array",
|
|
250359
|
+
"value": {
|
|
250360
|
+
"kind": "primitive",
|
|
250361
|
+
"value": "string"
|
|
250362
|
+
}
|
|
250363
|
+
},
|
|
250364
|
+
"description": "",
|
|
250365
|
+
"declarations": [
|
|
250366
|
+
{
|
|
250367
|
+
"name": "fallbackFiles",
|
|
250368
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250369
|
+
}
|
|
250370
|
+
],
|
|
250371
|
+
"tags": {}
|
|
250372
|
+
},
|
|
250373
|
+
{
|
|
250374
|
+
"kind": "property",
|
|
250375
|
+
"name": "transformers",
|
|
250376
|
+
"required": false,
|
|
250377
|
+
"type": {
|
|
250378
|
+
"kind": "array",
|
|
250379
|
+
"value": {
|
|
250380
|
+
"kind": "symbol",
|
|
250381
|
+
"name": "NodeTransformer",
|
|
250382
|
+
"value": "NodeTransformer"
|
|
250383
|
+
}
|
|
250384
|
+
},
|
|
250385
|
+
"description": "",
|
|
250386
|
+
"declarations": [
|
|
250387
|
+
{
|
|
250388
|
+
"name": "transformers",
|
|
250389
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250390
|
+
}
|
|
250391
|
+
],
|
|
250392
|
+
"tags": {}
|
|
250393
|
+
},
|
|
250394
|
+
{
|
|
250395
|
+
"kind": "property",
|
|
250396
|
+
"name": "checker",
|
|
250397
|
+
"required": true,
|
|
250398
|
+
"type": {
|
|
250399
|
+
"kind": "symbol",
|
|
250400
|
+
"name": "ts.TypeChecker",
|
|
250401
|
+
"value": "TypeChecker"
|
|
250402
|
+
},
|
|
250403
|
+
"description": "",
|
|
250404
|
+
"declarations": [
|
|
250405
|
+
{
|
|
250406
|
+
"name": "checker",
|
|
250407
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
250408
|
+
}
|
|
250409
|
+
],
|
|
250410
|
+
"tags": {}
|
|
250411
|
+
},
|
|
249211
250412
|
{
|
|
249212
250413
|
"kind": "property",
|
|
249213
250414
|
"name": "prefix",
|
|
@@ -249220,7 +250421,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249220
250421
|
"declarations": [
|
|
249221
250422
|
{
|
|
249222
250423
|
"name": "prefix",
|
|
249223
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250424
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
249224
250425
|
}
|
|
249225
250426
|
],
|
|
249226
250427
|
"tags": {}
|
|
@@ -249232,13 +250433,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249232
250433
|
"type": {
|
|
249233
250434
|
"kind": "external",
|
|
249234
250435
|
"name": "Record",
|
|
249235
|
-
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"
|
|
250436
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
250437
|
+
"typeParameters": [
|
|
250438
|
+
{
|
|
250439
|
+
"kind": "primitive",
|
|
250440
|
+
"value": "string"
|
|
250441
|
+
},
|
|
250442
|
+
{
|
|
250443
|
+
"kind": "primitive",
|
|
250444
|
+
"value": "string"
|
|
250445
|
+
}
|
|
250446
|
+
]
|
|
249236
250447
|
},
|
|
249237
250448
|
"description": "",
|
|
249238
250449
|
"declarations": [
|
|
249239
250450
|
{
|
|
249240
250451
|
"name": "variables",
|
|
249241
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250452
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
249242
250453
|
}
|
|
249243
250454
|
],
|
|
249244
250455
|
"tags": {}
|
|
@@ -249250,24 +250461,73 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249250
250461
|
"type": {
|
|
249251
250462
|
"kind": "external",
|
|
249252
250463
|
"name": "Record",
|
|
249253
|
-
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"
|
|
250464
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
250465
|
+
"typeParameters": [
|
|
250466
|
+
{
|
|
250467
|
+
"kind": "primitive",
|
|
250468
|
+
"value": "string"
|
|
250469
|
+
},
|
|
250470
|
+
{
|
|
250471
|
+
"kind": "primitive",
|
|
250472
|
+
"value": "string"
|
|
250473
|
+
}
|
|
250474
|
+
]
|
|
249254
250475
|
},
|
|
249255
250476
|
"description": "",
|
|
249256
250477
|
"declarations": [
|
|
249257
250478
|
{
|
|
249258
250479
|
"name": "keyframes",
|
|
249259
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250480
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
249260
250481
|
}
|
|
249261
250482
|
],
|
|
249262
250483
|
"tags": {}
|
|
249263
250484
|
},
|
|
249264
250485
|
{
|
|
249265
250486
|
"kind": "property",
|
|
249266
|
-
"name": "
|
|
249267
|
-
"required":
|
|
250487
|
+
"name": "styles",
|
|
250488
|
+
"required": true,
|
|
249268
250489
|
"type": {
|
|
249269
|
-
"kind": "
|
|
249270
|
-
"
|
|
250490
|
+
"kind": "symbol",
|
|
250491
|
+
"name": "StylesOutput",
|
|
250492
|
+
"value": "StylesOutput"
|
|
250493
|
+
},
|
|
250494
|
+
"description": "",
|
|
250495
|
+
"declarations": [
|
|
250496
|
+
{
|
|
250497
|
+
"name": "styles",
|
|
250498
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
250499
|
+
}
|
|
250500
|
+
],
|
|
250501
|
+
"tags": {}
|
|
250502
|
+
},
|
|
250503
|
+
{
|
|
250504
|
+
"kind": "property",
|
|
250505
|
+
"name": "getFileName",
|
|
250506
|
+
"required": true,
|
|
250507
|
+
"type": {
|
|
250508
|
+
"kind": "function",
|
|
250509
|
+
"parameters": [
|
|
250510
|
+
{
|
|
250511
|
+
"kind": "parameter",
|
|
250512
|
+
"name": "path",
|
|
250513
|
+
"type": {
|
|
250514
|
+
"kind": "primitive",
|
|
250515
|
+
"value": "string"
|
|
250516
|
+
},
|
|
250517
|
+
"required": true,
|
|
250518
|
+
"rest": false,
|
|
250519
|
+
"description": "",
|
|
250520
|
+
"declarations": [
|
|
250521
|
+
{
|
|
250522
|
+
"name": "path",
|
|
250523
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
250524
|
+
}
|
|
250525
|
+
],
|
|
250526
|
+
"tags": {}
|
|
250527
|
+
}
|
|
250528
|
+
],
|
|
250529
|
+
"members": [],
|
|
250530
|
+
"returnType": {
|
|
249271
250531
|
"kind": "primitive",
|
|
249272
250532
|
"value": "string"
|
|
249273
250533
|
}
|
|
@@ -249275,29 +250535,67 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249275
250535
|
"description": "",
|
|
249276
250536
|
"declarations": [
|
|
249277
250537
|
{
|
|
249278
|
-
"name": "
|
|
249279
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250538
|
+
"name": "getFileName",
|
|
250539
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
249280
250540
|
}
|
|
249281
250541
|
],
|
|
249282
250542
|
"tags": {}
|
|
249283
250543
|
},
|
|
249284
250544
|
{
|
|
249285
250545
|
"kind": "property",
|
|
249286
|
-
"name": "
|
|
249287
|
-
"required":
|
|
250546
|
+
"name": "objectTransforms",
|
|
250547
|
+
"required": true,
|
|
249288
250548
|
"type": {
|
|
249289
250549
|
"kind": "array",
|
|
249290
250550
|
"value": {
|
|
249291
250551
|
"kind": "symbol",
|
|
249292
|
-
"name": "
|
|
249293
|
-
"value": "
|
|
250552
|
+
"name": "ObjectTransform",
|
|
250553
|
+
"value": "ObjectTransform"
|
|
249294
250554
|
}
|
|
249295
250555
|
},
|
|
249296
250556
|
"description": "",
|
|
249297
250557
|
"declarations": [
|
|
249298
250558
|
{
|
|
249299
|
-
"name": "
|
|
249300
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250559
|
+
"name": "objectTransforms",
|
|
250560
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
250561
|
+
}
|
|
250562
|
+
],
|
|
250563
|
+
"tags": {}
|
|
250564
|
+
},
|
|
250565
|
+
{
|
|
250566
|
+
"kind": "property",
|
|
250567
|
+
"name": "propertyTransforms",
|
|
250568
|
+
"required": true,
|
|
250569
|
+
"type": {
|
|
250570
|
+
"kind": "array",
|
|
250571
|
+
"value": {
|
|
250572
|
+
"kind": "symbol",
|
|
250573
|
+
"name": "PropertyTransform",
|
|
250574
|
+
"value": "PropertyTransform"
|
|
250575
|
+
}
|
|
250576
|
+
},
|
|
250577
|
+
"description": "",
|
|
250578
|
+
"declarations": [
|
|
250579
|
+
{
|
|
250580
|
+
"name": "propertyTransforms",
|
|
250581
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
250582
|
+
}
|
|
250583
|
+
],
|
|
250584
|
+
"tags": {}
|
|
250585
|
+
},
|
|
250586
|
+
{
|
|
250587
|
+
"kind": "property",
|
|
250588
|
+
"name": "fileName",
|
|
250589
|
+
"required": true,
|
|
250590
|
+
"type": {
|
|
250591
|
+
"kind": "primitive",
|
|
250592
|
+
"value": "string"
|
|
250593
|
+
},
|
|
250594
|
+
"description": "",
|
|
250595
|
+
"declarations": [
|
|
250596
|
+
{
|
|
250597
|
+
"name": "fileName",
|
|
250598
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
249301
250599
|
}
|
|
249302
250600
|
],
|
|
249303
250601
|
"tags": {}
|
|
@@ -249361,101 +250659,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249361
250659
|
},
|
|
249362
250660
|
{
|
|
249363
250661
|
"kind": "parameter",
|
|
249364
|
-
"name": "
|
|
249365
|
-
"defaultValue": {
|
|
249366
|
-
"kind": "object",
|
|
249367
|
-
"properties": [
|
|
249368
|
-
{
|
|
249369
|
-
"kind": "property",
|
|
249370
|
-
"name": "prefix",
|
|
249371
|
-
"defaultValue": {
|
|
249372
|
-
"kind": "string",
|
|
249373
|
-
"value": "css"
|
|
249374
|
-
},
|
|
249375
|
-
"type": {
|
|
249376
|
-
"kind": "primitive",
|
|
249377
|
-
"value": "string"
|
|
249378
|
-
},
|
|
249379
|
-
"required": true,
|
|
249380
|
-
"description": "",
|
|
249381
|
-
"declarations": [
|
|
249382
|
-
{
|
|
249383
|
-
"name": "prefix",
|
|
249384
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
249385
|
-
}
|
|
249386
|
-
],
|
|
249387
|
-
"tags": {}
|
|
249388
|
-
},
|
|
249389
|
-
{
|
|
249390
|
-
"kind": "property",
|
|
249391
|
-
"name": "variables",
|
|
249392
|
-
"defaultValue": {
|
|
249393
|
-
"kind": "object",
|
|
249394
|
-
"properties": []
|
|
249395
|
-
},
|
|
249396
|
-
"type": {
|
|
249397
|
-
"kind": "object",
|
|
249398
|
-
"properties": []
|
|
249399
|
-
},
|
|
249400
|
-
"required": true,
|
|
249401
|
-
"description": "",
|
|
249402
|
-
"declarations": [
|
|
249403
|
-
{
|
|
249404
|
-
"name": "variables",
|
|
249405
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
249406
|
-
}
|
|
249407
|
-
],
|
|
249408
|
-
"tags": {}
|
|
249409
|
-
},
|
|
249410
|
-
{
|
|
249411
|
-
"kind": "property",
|
|
249412
|
-
"name": "keyframes",
|
|
249413
|
-
"defaultValue": {
|
|
249414
|
-
"kind": "object",
|
|
249415
|
-
"properties": []
|
|
249416
|
-
},
|
|
249417
|
-
"type": {
|
|
249418
|
-
"kind": "object",
|
|
249419
|
-
"properties": []
|
|
249420
|
-
},
|
|
249421
|
-
"required": true,
|
|
249422
|
-
"description": "",
|
|
249423
|
-
"declarations": [
|
|
249424
|
-
{
|
|
249425
|
-
"name": "keyframes",
|
|
249426
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
249427
|
-
}
|
|
249428
|
-
],
|
|
249429
|
-
"tags": {}
|
|
249430
|
-
},
|
|
249431
|
-
{
|
|
249432
|
-
"kind": "property",
|
|
249433
|
-
"name": "transformers",
|
|
249434
|
-
"defaultValue": {
|
|
249435
|
-
"kind": "unknown",
|
|
249436
|
-
"value": "unknown",
|
|
249437
|
-
"text": "defaultTransformers"
|
|
249438
|
-
},
|
|
249439
|
-
"type": {
|
|
249440
|
-
"kind": "array",
|
|
249441
|
-
"value": {
|
|
249442
|
-
"kind": "symbol",
|
|
249443
|
-
"name": "NodeTransformer",
|
|
249444
|
-
"value": "any"
|
|
249445
|
-
}
|
|
249446
|
-
},
|
|
249447
|
-
"required": true,
|
|
249448
|
-
"description": "",
|
|
249449
|
-
"declarations": [
|
|
249450
|
-
{
|
|
249451
|
-
"name": "transformers",
|
|
249452
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
249453
|
-
}
|
|
249454
|
-
],
|
|
249455
|
-
"tags": {}
|
|
249456
|
-
}
|
|
249457
|
-
]
|
|
249458
|
-
},
|
|
250662
|
+
"name": "options",
|
|
249459
250663
|
"type": {
|
|
249460
250664
|
"kind": "symbol",
|
|
249461
250665
|
"name": "Partial",
|
|
@@ -249473,7 +250677,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249473
250677
|
"description": "",
|
|
249474
250678
|
"declarations": [
|
|
249475
250679
|
{
|
|
249476
|
-
"name": "
|
|
250680
|
+
"name": "options",
|
|
249477
250681
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
249478
250682
|
}
|
|
249479
250683
|
],
|
|
@@ -249495,6 +250699,88 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249495
250699
|
}
|
|
249496
250700
|
}
|
|
249497
250701
|
},
|
|
250702
|
+
{
|
|
250703
|
+
"name": "withDefaultContext",
|
|
250704
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
250705
|
+
"description": "",
|
|
250706
|
+
"declarations": [
|
|
250707
|
+
{
|
|
250708
|
+
"name": "withDefaultContext",
|
|
250709
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250710
|
+
}
|
|
250711
|
+
],
|
|
250712
|
+
"tags": {},
|
|
250713
|
+
"type": {
|
|
250714
|
+
"kind": "function",
|
|
250715
|
+
"typeParameters": [
|
|
250716
|
+
{
|
|
250717
|
+
"kind": "typeParameter",
|
|
250718
|
+
"name": "T",
|
|
250719
|
+
"constraint": {
|
|
250720
|
+
"kind": "symbol",
|
|
250721
|
+
"name": "TransformerContext",
|
|
250722
|
+
"value": "TransformerContext"
|
|
250723
|
+
},
|
|
250724
|
+
"required": true
|
|
250725
|
+
}
|
|
250726
|
+
],
|
|
250727
|
+
"parameters": [
|
|
250728
|
+
{
|
|
250729
|
+
"kind": "parameter",
|
|
250730
|
+
"name": "checker",
|
|
250731
|
+
"type": {
|
|
250732
|
+
"kind": "symbol",
|
|
250733
|
+
"name": "ts.TypeChecker",
|
|
250734
|
+
"value": "TypeChecker"
|
|
250735
|
+
},
|
|
250736
|
+
"required": true,
|
|
250737
|
+
"rest": false,
|
|
250738
|
+
"description": "",
|
|
250739
|
+
"declarations": [
|
|
250740
|
+
{
|
|
250741
|
+
"name": "checker",
|
|
250742
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250743
|
+
}
|
|
250744
|
+
],
|
|
250745
|
+
"tags": {}
|
|
250746
|
+
},
|
|
250747
|
+
{
|
|
250748
|
+
"kind": "parameter",
|
|
250749
|
+
"name": "input",
|
|
250750
|
+
"defaultValue": {
|
|
250751
|
+
"kind": "object",
|
|
250752
|
+
"properties": []
|
|
250753
|
+
},
|
|
250754
|
+
"type": {
|
|
250755
|
+
"kind": "symbol",
|
|
250756
|
+
"name": "Partial",
|
|
250757
|
+
"typeParameters": [
|
|
250758
|
+
{
|
|
250759
|
+
"kind": "generic",
|
|
250760
|
+
"name": "T"
|
|
250761
|
+
}
|
|
250762
|
+
],
|
|
250763
|
+
"value": "Partial<T>"
|
|
250764
|
+
},
|
|
250765
|
+
"required": false,
|
|
250766
|
+
"rest": false,
|
|
250767
|
+
"description": "",
|
|
250768
|
+
"declarations": [
|
|
250769
|
+
{
|
|
250770
|
+
"name": "input",
|
|
250771
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250772
|
+
}
|
|
250773
|
+
],
|
|
250774
|
+
"tags": {}
|
|
250775
|
+
}
|
|
250776
|
+
],
|
|
250777
|
+
"members": [],
|
|
250778
|
+
"returnType": {
|
|
250779
|
+
"kind": "generic",
|
|
250780
|
+
"name": "T"
|
|
250781
|
+
}
|
|
250782
|
+
}
|
|
250783
|
+
},
|
|
249498
250784
|
{
|
|
249499
250785
|
"name": "transform",
|
|
249500
250786
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
@@ -249531,11 +250817,15 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249531
250817
|
{
|
|
249532
250818
|
"kind": "parameter",
|
|
249533
250819
|
"name": "fileName",
|
|
250820
|
+
"defaultValue": {
|
|
250821
|
+
"kind": "string",
|
|
250822
|
+
"value": "test.ts"
|
|
250823
|
+
},
|
|
249534
250824
|
"type": {
|
|
249535
250825
|
"kind": "primitive",
|
|
249536
250826
|
"value": "string"
|
|
249537
250827
|
},
|
|
249538
|
-
"required":
|
|
250828
|
+
"required": false,
|
|
249539
250829
|
"rest": false,
|
|
249540
250830
|
"description": "",
|
|
249541
250831
|
"declarations": [
|
|
@@ -249580,6 +250870,59 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249580
250870
|
}
|
|
249581
250871
|
}
|
|
249582
250872
|
},
|
|
250873
|
+
{
|
|
250874
|
+
"name": "getConfig",
|
|
250875
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
250876
|
+
"description": "",
|
|
250877
|
+
"declarations": [
|
|
250878
|
+
{
|
|
250879
|
+
"name": "getConfig",
|
|
250880
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250881
|
+
}
|
|
250882
|
+
],
|
|
250883
|
+
"tags": {},
|
|
250884
|
+
"type": {
|
|
250885
|
+
"kind": "function",
|
|
250886
|
+
"parameters": [
|
|
250887
|
+
{
|
|
250888
|
+
"kind": "parameter",
|
|
250889
|
+
"name": "basePath",
|
|
250890
|
+
"defaultValue": {
|
|
250891
|
+
"kind": "string",
|
|
250892
|
+
"value": "."
|
|
250893
|
+
},
|
|
250894
|
+
"type": {
|
|
250895
|
+
"kind": "primitive",
|
|
250896
|
+
"value": "string"
|
|
250897
|
+
},
|
|
250898
|
+
"required": false,
|
|
250899
|
+
"rest": false,
|
|
250900
|
+
"description": "",
|
|
250901
|
+
"declarations": [
|
|
250902
|
+
{
|
|
250903
|
+
"name": "basePath",
|
|
250904
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
250905
|
+
}
|
|
250906
|
+
],
|
|
250907
|
+
"tags": {}
|
|
250908
|
+
}
|
|
250909
|
+
],
|
|
250910
|
+
"members": [],
|
|
250911
|
+
"returnType": {
|
|
250912
|
+
"kind": "union",
|
|
250913
|
+
"value": [
|
|
250914
|
+
{
|
|
250915
|
+
"kind": "primitive",
|
|
250916
|
+
"value": "string"
|
|
250917
|
+
},
|
|
250918
|
+
{
|
|
250919
|
+
"kind": "primitive",
|
|
250920
|
+
"value": "undefined"
|
|
250921
|
+
}
|
|
250922
|
+
]
|
|
250923
|
+
}
|
|
250924
|
+
}
|
|
250925
|
+
},
|
|
249583
250926
|
{
|
|
249584
250927
|
"name": "createStyleObjectNode",
|
|
249585
250928
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts",
|
|
@@ -249596,27 +250939,17 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249596
250939
|
"parameters": [
|
|
249597
250940
|
{
|
|
249598
250941
|
"kind": "parameter",
|
|
249599
|
-
"name": "
|
|
250942
|
+
"name": "styles",
|
|
249600
250943
|
"type": {
|
|
249601
|
-
"kind": "
|
|
249602
|
-
"value":
|
|
249603
|
-
{
|
|
249604
|
-
"kind": "symbol",
|
|
249605
|
-
"name": "NestedStyleObject",
|
|
249606
|
-
"value": "NestedStyleObject"
|
|
249607
|
-
},
|
|
249608
|
-
{
|
|
249609
|
-
"kind": "primitive",
|
|
249610
|
-
"value": "string"
|
|
249611
|
-
}
|
|
249612
|
-
]
|
|
250944
|
+
"kind": "primitive",
|
|
250945
|
+
"value": "string"
|
|
249613
250946
|
},
|
|
249614
250947
|
"required": true,
|
|
249615
250948
|
"rest": false,
|
|
249616
250949
|
"description": "",
|
|
249617
250950
|
"declarations": [
|
|
249618
250951
|
{
|
|
249619
|
-
"name": "
|
|
250952
|
+
"name": "styles",
|
|
249620
250953
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249621
250954
|
}
|
|
249622
250955
|
],
|
|
@@ -249650,12 +250983,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249650
250983
|
}
|
|
249651
250984
|
},
|
|
249652
250985
|
{
|
|
249653
|
-
"name": "
|
|
250986
|
+
"name": "compileCSS",
|
|
249654
250987
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts",
|
|
249655
|
-
"description": "
|
|
250988
|
+
"description": "Compiles CSS using stylis. Emotion's `serializeStyles` creates an unwrapped string for cache\nstorage and it often needs to be wrapped by a CSS selector or `@keyframes`. This function does\nthis the same way Emotion does it internally.",
|
|
249656
250989
|
"declarations": [
|
|
249657
250990
|
{
|
|
249658
|
-
"name": "
|
|
250991
|
+
"name": "compileCSS",
|
|
249659
250992
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249660
250993
|
}
|
|
249661
250994
|
],
|
|
@@ -249665,18 +250998,17 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249665
250998
|
"parameters": [
|
|
249666
250999
|
{
|
|
249667
251000
|
"kind": "parameter",
|
|
249668
|
-
"name": "
|
|
251001
|
+
"name": "input",
|
|
249669
251002
|
"type": {
|
|
249670
|
-
"kind": "
|
|
249671
|
-
"
|
|
249672
|
-
"value": "Node"
|
|
251003
|
+
"kind": "primitive",
|
|
251004
|
+
"value": "string"
|
|
249673
251005
|
},
|
|
249674
251006
|
"required": true,
|
|
249675
251007
|
"rest": false,
|
|
249676
251008
|
"description": "",
|
|
249677
251009
|
"declarations": [
|
|
249678
251010
|
{
|
|
249679
|
-
"name": "
|
|
251011
|
+
"name": "input",
|
|
249680
251012
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249681
251013
|
}
|
|
249682
251014
|
],
|
|
@@ -249690,6 +251022,57 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249690
251022
|
}
|
|
249691
251023
|
}
|
|
249692
251024
|
},
|
|
251025
|
+
{
|
|
251026
|
+
"name": "serializeStyles",
|
|
251027
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts",
|
|
251028
|
+
"description": "",
|
|
251029
|
+
"declarations": [
|
|
251030
|
+
{
|
|
251031
|
+
"name": "serializeStyles",
|
|
251032
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
251033
|
+
}
|
|
251034
|
+
],
|
|
251035
|
+
"tags": {},
|
|
251036
|
+
"type": {
|
|
251037
|
+
"kind": "function",
|
|
251038
|
+
"parameters": [
|
|
251039
|
+
{
|
|
251040
|
+
"kind": "parameter",
|
|
251041
|
+
"name": "input",
|
|
251042
|
+
"type": {
|
|
251043
|
+
"kind": "union",
|
|
251044
|
+
"value": [
|
|
251045
|
+
{
|
|
251046
|
+
"kind": "symbol",
|
|
251047
|
+
"name": "NestedStyleObject",
|
|
251048
|
+
"value": "NestedStyleObject"
|
|
251049
|
+
},
|
|
251050
|
+
{
|
|
251051
|
+
"kind": "primitive",
|
|
251052
|
+
"value": "string"
|
|
251053
|
+
}
|
|
251054
|
+
]
|
|
251055
|
+
},
|
|
251056
|
+
"required": true,
|
|
251057
|
+
"rest": false,
|
|
251058
|
+
"description": "",
|
|
251059
|
+
"declarations": [
|
|
251060
|
+
{
|
|
251061
|
+
"name": "input",
|
|
251062
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
251063
|
+
}
|
|
251064
|
+
],
|
|
251065
|
+
"tags": {}
|
|
251066
|
+
}
|
|
251067
|
+
],
|
|
251068
|
+
"members": [],
|
|
251069
|
+
"returnType": {
|
|
251070
|
+
"kind": "symbol",
|
|
251071
|
+
"name": "SerializedStyles",
|
|
251072
|
+
"value": "SerializedStyles"
|
|
251073
|
+
}
|
|
251074
|
+
}
|
|
251075
|
+
},
|
|
249693
251076
|
{
|
|
249694
251077
|
"name": "getVariablesFromFiles",
|
|
249695
251078
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts",
|
|
@@ -249873,6 +251256,25 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
249873
251256
|
}
|
|
249874
251257
|
],
|
|
249875
251258
|
"tags": {}
|
|
251259
|
+
},
|
|
251260
|
+
{
|
|
251261
|
+
"kind": "parameter",
|
|
251262
|
+
"name": "context",
|
|
251263
|
+
"type": {
|
|
251264
|
+
"kind": "symbol",
|
|
251265
|
+
"name": "TransformerContext",
|
|
251266
|
+
"value": "TransformerContext"
|
|
251267
|
+
},
|
|
251268
|
+
"required": true,
|
|
251269
|
+
"rest": false,
|
|
251270
|
+
"description": "",
|
|
251271
|
+
"declarations": [
|
|
251272
|
+
{
|
|
251273
|
+
"name": "context",
|
|
251274
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getErrorMessage.ts"
|
|
251275
|
+
}
|
|
251276
|
+
],
|
|
251277
|
+
"tags": {}
|
|
249876
251278
|
}
|
|
249877
251279
|
],
|
|
249878
251280
|
"members": [],
|
|
@@ -250029,7 +251431,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250029
251431
|
{
|
|
250030
251432
|
"name": "handleCalc",
|
|
250031
251433
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCalc.ts",
|
|
250032
|
-
"description": "
|
|
251434
|
+
"description": "",
|
|
250033
251435
|
"declarations": [
|
|
250034
251436
|
{
|
|
250035
251437
|
"name": "handleCalc",
|
|
@@ -250038,9 +251440,61 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250038
251440
|
],
|
|
250039
251441
|
"tags": {},
|
|
250040
251442
|
"type": {
|
|
250041
|
-
"kind": "
|
|
250042
|
-
"
|
|
250043
|
-
|
|
251443
|
+
"kind": "function",
|
|
251444
|
+
"parameters": [
|
|
251445
|
+
{
|
|
251446
|
+
"kind": "parameter",
|
|
251447
|
+
"name": "node",
|
|
251448
|
+
"type": {
|
|
251449
|
+
"kind": "symbol",
|
|
251450
|
+
"name": "ts.Node",
|
|
251451
|
+
"value": "Node"
|
|
251452
|
+
},
|
|
251453
|
+
"required": true,
|
|
251454
|
+
"rest": false,
|
|
251455
|
+
"description": "",
|
|
251456
|
+
"declarations": [
|
|
251457
|
+
{
|
|
251458
|
+
"name": "node",
|
|
251459
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
251460
|
+
}
|
|
251461
|
+
],
|
|
251462
|
+
"tags": {}
|
|
251463
|
+
},
|
|
251464
|
+
{
|
|
251465
|
+
"kind": "parameter",
|
|
251466
|
+
"name": "context",
|
|
251467
|
+
"type": {
|
|
251468
|
+
"kind": "symbol",
|
|
251469
|
+
"name": "TransformerContext",
|
|
251470
|
+
"value": "TransformerContext"
|
|
251471
|
+
},
|
|
251472
|
+
"required": true,
|
|
251473
|
+
"rest": false,
|
|
251474
|
+
"description": "",
|
|
251475
|
+
"declarations": [
|
|
251476
|
+
{
|
|
251477
|
+
"name": "context",
|
|
251478
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
251479
|
+
}
|
|
251480
|
+
],
|
|
251481
|
+
"tags": {}
|
|
251482
|
+
}
|
|
251483
|
+
],
|
|
251484
|
+
"members": [],
|
|
251485
|
+
"returnType": {
|
|
251486
|
+
"kind": "union",
|
|
251487
|
+
"value": [
|
|
251488
|
+
{
|
|
251489
|
+
"kind": "primitive",
|
|
251490
|
+
"value": "string"
|
|
251491
|
+
},
|
|
251492
|
+
{
|
|
251493
|
+
"kind": "primitive",
|
|
251494
|
+
"value": "void"
|
|
251495
|
+
}
|
|
251496
|
+
]
|
|
251497
|
+
}
|
|
250044
251498
|
}
|
|
250045
251499
|
},
|
|
250046
251500
|
{
|
|
@@ -250097,7 +251551,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250097
251551
|
{
|
|
250098
251552
|
"name": "handleCssVar",
|
|
250099
251553
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCssVar.ts",
|
|
250100
|
-
"description": "
|
|
251554
|
+
"description": "",
|
|
250101
251555
|
"declarations": [
|
|
250102
251556
|
{
|
|
250103
251557
|
"name": "handleCssVar",
|
|
@@ -250106,26 +251560,61 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250106
251560
|
],
|
|
250107
251561
|
"tags": {},
|
|
250108
251562
|
"type": {
|
|
250109
|
-
"kind": "
|
|
250110
|
-
"
|
|
250111
|
-
|
|
250112
|
-
|
|
250113
|
-
|
|
250114
|
-
|
|
250115
|
-
|
|
250116
|
-
|
|
250117
|
-
|
|
250118
|
-
|
|
250119
|
-
|
|
250120
|
-
|
|
250121
|
-
|
|
251563
|
+
"kind": "function",
|
|
251564
|
+
"parameters": [
|
|
251565
|
+
{
|
|
251566
|
+
"kind": "parameter",
|
|
251567
|
+
"name": "node",
|
|
251568
|
+
"type": {
|
|
251569
|
+
"kind": "symbol",
|
|
251570
|
+
"name": "ts.Node",
|
|
251571
|
+
"value": "Node"
|
|
251572
|
+
},
|
|
251573
|
+
"required": true,
|
|
251574
|
+
"rest": false,
|
|
251575
|
+
"description": "",
|
|
251576
|
+
"declarations": [
|
|
251577
|
+
{
|
|
251578
|
+
"name": "node",
|
|
251579
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
251580
|
+
}
|
|
251581
|
+
],
|
|
251582
|
+
"tags": {}
|
|
251583
|
+
},
|
|
251584
|
+
{
|
|
251585
|
+
"kind": "parameter",
|
|
251586
|
+
"name": "context",
|
|
251587
|
+
"type": {
|
|
251588
|
+
"kind": "symbol",
|
|
251589
|
+
"name": "TransformerContext",
|
|
251590
|
+
"value": "TransformerContext"
|
|
251591
|
+
},
|
|
251592
|
+
"required": true,
|
|
251593
|
+
"rest": false,
|
|
251594
|
+
"description": "",
|
|
251595
|
+
"declarations": [
|
|
251596
|
+
{
|
|
251597
|
+
"name": "context",
|
|
251598
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
251599
|
+
}
|
|
251600
|
+
],
|
|
251601
|
+
"tags": {}
|
|
251602
|
+
}
|
|
251603
|
+
],
|
|
251604
|
+
"members": [],
|
|
251605
|
+
"returnType": {
|
|
251606
|
+
"kind": "union",
|
|
251607
|
+
"value": [
|
|
251608
|
+
{
|
|
251609
|
+
"kind": "primitive",
|
|
251610
|
+
"value": "string"
|
|
251611
|
+
},
|
|
251612
|
+
{
|
|
251613
|
+
"kind": "primitive",
|
|
251614
|
+
"value": "void"
|
|
251615
|
+
}
|
|
251616
|
+
]
|
|
250122
251617
|
}
|
|
250123
|
-
],
|
|
250124
|
-
"tags": {},
|
|
250125
|
-
"type": {
|
|
250126
|
-
"kind": "symbol",
|
|
250127
|
-
"name": "NodeTransformer",
|
|
250128
|
-
"value": "NodeTransformer"
|
|
250129
251618
|
}
|
|
250130
251619
|
},
|
|
250131
251620
|
{
|
|
@@ -250148,7 +251637,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250148
251637
|
{
|
|
250149
251638
|
"name": "handlePx2Rem",
|
|
250150
251639
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handlePx2Rem.ts",
|
|
250151
|
-
"description": "
|
|
251640
|
+
"description": "",
|
|
250152
251641
|
"declarations": [
|
|
250153
251642
|
{
|
|
250154
251643
|
"name": "handlePx2Rem",
|
|
@@ -250157,9 +251646,61 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250157
251646
|
],
|
|
250158
251647
|
"tags": {},
|
|
250159
251648
|
"type": {
|
|
250160
|
-
"kind": "
|
|
250161
|
-
"
|
|
250162
|
-
|
|
251649
|
+
"kind": "function",
|
|
251650
|
+
"parameters": [
|
|
251651
|
+
{
|
|
251652
|
+
"kind": "parameter",
|
|
251653
|
+
"name": "node",
|
|
251654
|
+
"type": {
|
|
251655
|
+
"kind": "symbol",
|
|
251656
|
+
"name": "ts.Node",
|
|
251657
|
+
"value": "Node"
|
|
251658
|
+
},
|
|
251659
|
+
"required": true,
|
|
251660
|
+
"rest": false,
|
|
251661
|
+
"description": "",
|
|
251662
|
+
"declarations": [
|
|
251663
|
+
{
|
|
251664
|
+
"name": "node",
|
|
251665
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
251666
|
+
}
|
|
251667
|
+
],
|
|
251668
|
+
"tags": {}
|
|
251669
|
+
},
|
|
251670
|
+
{
|
|
251671
|
+
"kind": "parameter",
|
|
251672
|
+
"name": "context",
|
|
251673
|
+
"type": {
|
|
251674
|
+
"kind": "symbol",
|
|
251675
|
+
"name": "TransformerContext",
|
|
251676
|
+
"value": "TransformerContext"
|
|
251677
|
+
},
|
|
251678
|
+
"required": true,
|
|
251679
|
+
"rest": false,
|
|
251680
|
+
"description": "",
|
|
251681
|
+
"declarations": [
|
|
251682
|
+
{
|
|
251683
|
+
"name": "context",
|
|
251684
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
251685
|
+
}
|
|
251686
|
+
],
|
|
251687
|
+
"tags": {}
|
|
251688
|
+
}
|
|
251689
|
+
],
|
|
251690
|
+
"members": [],
|
|
251691
|
+
"returnType": {
|
|
251692
|
+
"kind": "union",
|
|
251693
|
+
"value": [
|
|
251694
|
+
{
|
|
251695
|
+
"kind": "primitive",
|
|
251696
|
+
"value": "string"
|
|
251697
|
+
},
|
|
251698
|
+
{
|
|
251699
|
+
"kind": "primitive",
|
|
251700
|
+
"value": "void"
|
|
251701
|
+
}
|
|
251702
|
+
]
|
|
251703
|
+
}
|
|
250163
251704
|
}
|
|
250164
251705
|
},
|
|
250165
251706
|
{
|
|
@@ -250322,44 +251863,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250322
251863
|
}
|
|
250323
251864
|
}
|
|
250324
251865
|
},
|
|
250325
|
-
{
|
|
250326
|
-
"name": "NestedStyleObject",
|
|
250327
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts",
|
|
250328
|
-
"description": "",
|
|
250329
|
-
"declarations": [
|
|
250330
|
-
{
|
|
250331
|
-
"name": "NestedStyleObject",
|
|
250332
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
250333
|
-
}
|
|
250334
|
-
],
|
|
250335
|
-
"tags": {},
|
|
250336
|
-
"type": {
|
|
250337
|
-
"kind": "object",
|
|
250338
|
-
"properties": [],
|
|
250339
|
-
"indexSignature": {
|
|
250340
|
-
"kind": "indexSignature",
|
|
250341
|
-
"name": "key",
|
|
250342
|
-
"type": {
|
|
250343
|
-
"kind": "primitive",
|
|
250344
|
-
"value": "string"
|
|
250345
|
-
},
|
|
250346
|
-
"value": {
|
|
250347
|
-
"kind": "union",
|
|
250348
|
-
"value": [
|
|
250349
|
-
{
|
|
250350
|
-
"kind": "primitive",
|
|
250351
|
-
"value": "string"
|
|
250352
|
-
},
|
|
250353
|
-
{
|
|
250354
|
-
"kind": "symbol",
|
|
250355
|
-
"name": "NestedStyleObject",
|
|
250356
|
-
"value": "NestedStyleObject"
|
|
250357
|
-
}
|
|
250358
|
-
]
|
|
250359
|
-
}
|
|
250360
|
-
}
|
|
250361
|
-
}
|
|
250362
|
-
},
|
|
250363
251866
|
{
|
|
250364
251867
|
"name": "parseObjectToStaticValue",
|
|
250365
251868
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts",
|
|
@@ -250482,6 +251985,23 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250482
251985
|
}
|
|
250483
251986
|
}
|
|
250484
251987
|
},
|
|
251988
|
+
{
|
|
251989
|
+
"name": "prettyStringify",
|
|
251990
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/stylisFns.ts",
|
|
251991
|
+
"description": "",
|
|
251992
|
+
"declarations": [
|
|
251993
|
+
{
|
|
251994
|
+
"name": "prettyStringify",
|
|
251995
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/stylisFns.ts"
|
|
251996
|
+
}
|
|
251997
|
+
],
|
|
251998
|
+
"tags": {},
|
|
251999
|
+
"type": {
|
|
252000
|
+
"kind": "symbol",
|
|
252001
|
+
"name": "Middleware",
|
|
252002
|
+
"value": "Middleware"
|
|
252003
|
+
}
|
|
252004
|
+
},
|
|
250485
252005
|
{
|
|
250486
252006
|
"name": "TransformerContext",
|
|
250487
252007
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
@@ -250586,10 +252106,166 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250586
252106
|
}
|
|
250587
252107
|
],
|
|
250588
252108
|
"tags": {}
|
|
252109
|
+
},
|
|
252110
|
+
{
|
|
252111
|
+
"kind": "property",
|
|
252112
|
+
"name": "styles",
|
|
252113
|
+
"required": true,
|
|
252114
|
+
"type": {
|
|
252115
|
+
"kind": "symbol",
|
|
252116
|
+
"name": "StylesOutput",
|
|
252117
|
+
"value": "StylesOutput"
|
|
252118
|
+
},
|
|
252119
|
+
"description": "",
|
|
252120
|
+
"declarations": [
|
|
252121
|
+
{
|
|
252122
|
+
"name": "styles",
|
|
252123
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252124
|
+
}
|
|
252125
|
+
],
|
|
252126
|
+
"tags": {}
|
|
252127
|
+
},
|
|
252128
|
+
{
|
|
252129
|
+
"kind": "property",
|
|
252130
|
+
"name": "getFileName",
|
|
252131
|
+
"required": true,
|
|
252132
|
+
"type": {
|
|
252133
|
+
"kind": "function",
|
|
252134
|
+
"parameters": [
|
|
252135
|
+
{
|
|
252136
|
+
"kind": "parameter",
|
|
252137
|
+
"name": "path",
|
|
252138
|
+
"type": {
|
|
252139
|
+
"kind": "primitive",
|
|
252140
|
+
"value": "string"
|
|
252141
|
+
},
|
|
252142
|
+
"required": true,
|
|
252143
|
+
"rest": false,
|
|
252144
|
+
"description": "",
|
|
252145
|
+
"declarations": [
|
|
252146
|
+
{
|
|
252147
|
+
"name": "path",
|
|
252148
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252149
|
+
}
|
|
252150
|
+
],
|
|
252151
|
+
"tags": {}
|
|
252152
|
+
}
|
|
252153
|
+
],
|
|
252154
|
+
"members": [],
|
|
252155
|
+
"returnType": {
|
|
252156
|
+
"kind": "primitive",
|
|
252157
|
+
"value": "string"
|
|
252158
|
+
}
|
|
252159
|
+
},
|
|
252160
|
+
"description": "",
|
|
252161
|
+
"declarations": [
|
|
252162
|
+
{
|
|
252163
|
+
"name": "getFileName",
|
|
252164
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252165
|
+
}
|
|
252166
|
+
],
|
|
252167
|
+
"tags": {}
|
|
252168
|
+
},
|
|
252169
|
+
{
|
|
252170
|
+
"kind": "property",
|
|
252171
|
+
"name": "objectTransforms",
|
|
252172
|
+
"required": true,
|
|
252173
|
+
"type": {
|
|
252174
|
+
"kind": "array",
|
|
252175
|
+
"value": {
|
|
252176
|
+
"kind": "symbol",
|
|
252177
|
+
"name": "ObjectTransform",
|
|
252178
|
+
"value": "ObjectTransform"
|
|
252179
|
+
}
|
|
252180
|
+
},
|
|
252181
|
+
"description": "",
|
|
252182
|
+
"declarations": [
|
|
252183
|
+
{
|
|
252184
|
+
"name": "objectTransforms",
|
|
252185
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252186
|
+
}
|
|
252187
|
+
],
|
|
252188
|
+
"tags": {}
|
|
252189
|
+
},
|
|
252190
|
+
{
|
|
252191
|
+
"kind": "property",
|
|
252192
|
+
"name": "propertyTransforms",
|
|
252193
|
+
"required": true,
|
|
252194
|
+
"type": {
|
|
252195
|
+
"kind": "array",
|
|
252196
|
+
"value": {
|
|
252197
|
+
"kind": "symbol",
|
|
252198
|
+
"name": "PropertyTransform",
|
|
252199
|
+
"value": "PropertyTransform"
|
|
252200
|
+
}
|
|
252201
|
+
},
|
|
252202
|
+
"description": "",
|
|
252203
|
+
"declarations": [
|
|
252204
|
+
{
|
|
252205
|
+
"name": "propertyTransforms",
|
|
252206
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252207
|
+
}
|
|
252208
|
+
],
|
|
252209
|
+
"tags": {}
|
|
252210
|
+
},
|
|
252211
|
+
{
|
|
252212
|
+
"kind": "property",
|
|
252213
|
+
"name": "fileName",
|
|
252214
|
+
"required": true,
|
|
252215
|
+
"type": {
|
|
252216
|
+
"kind": "primitive",
|
|
252217
|
+
"value": "string"
|
|
252218
|
+
},
|
|
252219
|
+
"description": "",
|
|
252220
|
+
"declarations": [
|
|
252221
|
+
{
|
|
252222
|
+
"name": "fileName",
|
|
252223
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252224
|
+
}
|
|
252225
|
+
],
|
|
252226
|
+
"tags": {}
|
|
250589
252227
|
}
|
|
250590
252228
|
]
|
|
250591
252229
|
}
|
|
250592
252230
|
},
|
|
252231
|
+
{
|
|
252232
|
+
"name": "NestedStyleObject",
|
|
252233
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
252234
|
+
"description": "",
|
|
252235
|
+
"declarations": [
|
|
252236
|
+
{
|
|
252237
|
+
"name": "NestedStyleObject",
|
|
252238
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252239
|
+
}
|
|
252240
|
+
],
|
|
252241
|
+
"tags": {},
|
|
252242
|
+
"type": {
|
|
252243
|
+
"kind": "object",
|
|
252244
|
+
"properties": [],
|
|
252245
|
+
"indexSignature": {
|
|
252246
|
+
"kind": "indexSignature",
|
|
252247
|
+
"name": "key",
|
|
252248
|
+
"type": {
|
|
252249
|
+
"kind": "primitive",
|
|
252250
|
+
"value": "string"
|
|
252251
|
+
},
|
|
252252
|
+
"value": {
|
|
252253
|
+
"kind": "union",
|
|
252254
|
+
"value": [
|
|
252255
|
+
{
|
|
252256
|
+
"kind": "primitive",
|
|
252257
|
+
"value": "string"
|
|
252258
|
+
},
|
|
252259
|
+
{
|
|
252260
|
+
"kind": "symbol",
|
|
252261
|
+
"name": "NestedStyleObject",
|
|
252262
|
+
"value": "NestedStyleObject"
|
|
252263
|
+
}
|
|
252264
|
+
]
|
|
252265
|
+
}
|
|
252266
|
+
}
|
|
252267
|
+
}
|
|
252268
|
+
},
|
|
250593
252269
|
{
|
|
250594
252270
|
"name": "NodeTransformer",
|
|
250595
252271
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
@@ -250664,6 +252340,345 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
250664
252340
|
}
|
|
250665
252341
|
}
|
|
250666
252342
|
},
|
|
252343
|
+
{
|
|
252344
|
+
"name": "StylesOutput",
|
|
252345
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
252346
|
+
"description": "Used to collect styles. The format will be:\n\n```js\n{\n '/absolute/file/name': [\n '.styles-1 { ... }'\n ]\n}\n```",
|
|
252347
|
+
"declarations": [
|
|
252348
|
+
{
|
|
252349
|
+
"name": "StylesOutput",
|
|
252350
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252351
|
+
}
|
|
252352
|
+
],
|
|
252353
|
+
"tags": {},
|
|
252354
|
+
"type": {
|
|
252355
|
+
"kind": "type",
|
|
252356
|
+
"typeParameters": [],
|
|
252357
|
+
"value": {
|
|
252358
|
+
"kind": "external",
|
|
252359
|
+
"name": "Record",
|
|
252360
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
252361
|
+
"typeParameters": [
|
|
252362
|
+
{
|
|
252363
|
+
"kind": "primitive",
|
|
252364
|
+
"value": "string"
|
|
252365
|
+
},
|
|
252366
|
+
{
|
|
252367
|
+
"kind": "array",
|
|
252368
|
+
"value": {
|
|
252369
|
+
"kind": "primitive",
|
|
252370
|
+
"value": "string"
|
|
252371
|
+
}
|
|
252372
|
+
}
|
|
252373
|
+
]
|
|
252374
|
+
}
|
|
252375
|
+
}
|
|
252376
|
+
},
|
|
252377
|
+
{
|
|
252378
|
+
"name": "Config",
|
|
252379
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
252380
|
+
"description": "",
|
|
252381
|
+
"declarations": [
|
|
252382
|
+
{
|
|
252383
|
+
"name": "Config",
|
|
252384
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252385
|
+
}
|
|
252386
|
+
],
|
|
252387
|
+
"tags": {},
|
|
252388
|
+
"type": {
|
|
252389
|
+
"kind": "object",
|
|
252390
|
+
"properties": [
|
|
252391
|
+
{
|
|
252392
|
+
"kind": "property",
|
|
252393
|
+
"name": "prefix",
|
|
252394
|
+
"required": false,
|
|
252395
|
+
"type": {
|
|
252396
|
+
"kind": "primitive",
|
|
252397
|
+
"value": "string"
|
|
252398
|
+
},
|
|
252399
|
+
"description": "The prefix for all CSS class names and variables. This should be something short and\ndistinguish your CSS class names from others on the page.",
|
|
252400
|
+
"declarations": [
|
|
252401
|
+
{
|
|
252402
|
+
"name": "prefix",
|
|
252403
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252404
|
+
}
|
|
252405
|
+
],
|
|
252406
|
+
"tags": {}
|
|
252407
|
+
},
|
|
252408
|
+
{
|
|
252409
|
+
"kind": "property",
|
|
252410
|
+
"name": "fallbackFiles",
|
|
252411
|
+
"required": false,
|
|
252412
|
+
"type": {
|
|
252413
|
+
"kind": "array",
|
|
252414
|
+
"value": {
|
|
252415
|
+
"kind": "primitive",
|
|
252416
|
+
"value": "string"
|
|
252417
|
+
}
|
|
252418
|
+
},
|
|
252419
|
+
"description": "If you wish to automatically include CSS variable fallbacks, you can provide paths to CSS files\nthat contain CSS variables. Fallbacks are useful if you expect your CSS to be loaded in an\nenvironment that might not include these CSS files. An example might be Storybook or other dev\nenvironments where you want your CSS to look good even in these environments. Fallbacks make\nbigger files because fallbacks are embedded.\n\nFor example:\n```ts\nconst myComponent = createStyles({\n color: '--primary-color-100'\n})\n```\n\nIf you provide a fallback file that defines `--primary-color-100`, the fallback will be\ninlined:\n```css\n// without\n.my-component{color:var(--primary-color-100);}\n\n// with fallback\n.my-component{color:var(--primary-color-100,#0000ff);}\n```\n\nThe benefit is your CSS will work even without the files that define all your global CSS\nvariables.",
|
|
252420
|
+
"declarations": [
|
|
252421
|
+
{
|
|
252422
|
+
"name": "fallbackFiles",
|
|
252423
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252424
|
+
}
|
|
252425
|
+
],
|
|
252426
|
+
"tags": {}
|
|
252427
|
+
},
|
|
252428
|
+
{
|
|
252429
|
+
"kind": "property",
|
|
252430
|
+
"name": "additionalTransforms",
|
|
252431
|
+
"required": false,
|
|
252432
|
+
"type": {
|
|
252433
|
+
"kind": "array",
|
|
252434
|
+
"value": {
|
|
252435
|
+
"kind": "symbol",
|
|
252436
|
+
"name": "NodeTransformer",
|
|
252437
|
+
"value": "NodeTransformer"
|
|
252438
|
+
}
|
|
252439
|
+
},
|
|
252440
|
+
"description": "Optional additional transforms. A transform takes an AST node and optionally returns a new AST\nnode. This is useful if your source files use custom utility functions. The style\ntransformation process must receive static strings while reading your source files. The base\ntransformers handle all style utilities provided by `@workday/canvas-kit-styling`, but you may\nuse more. The transformer makes use of TypeScript's type checker to extract a static types out\nof variables, but will throw errors if it finds a generic type like `string` or `number`. If\nyou get these errors and the error points to a function, maybe you need an additional\ntransformer to understand the code. Some simple examples from `@workday/canvas-kit-styling` are\n`px2rem` and `calc.*`. Those have special handlers that are allowed to return new AST nodes\nthat can be further processed. You can return `NumericLiteral`, `StringLiteral`, or\n`TemplateExpression` AST nodes. You can see `handlePx2Rem` and `handleCalc` transformers as\nexamples as well as associated tests.\n\nTransforms are called using the visitor pattern. The order is innermost to outermost of the\nAST. This means if you have a special utility function used to return a style property, it will\nbe called before the `createStyles` or `createStencils` is called.\n\nhttps://ts-ast-viewer.com/#code/MYewdgzgLgBAtgTwMIjgB3AUzLAvDYAJ0wEMpMBlKBAG0wgAoBvAKBhjRIBMuBLMAOYAuGAMxQACtz6CGAcgAeNOQEoWAXxVA\n```ts\nconst myComponent = createStyles({\n padding: getPadding('xl')\n})\n```\n\nIn this example, your transform will be called with `'xl'`, `getPadding`, the `padding`\nPropertyAssignment, `createStyles`, then variable declarations for `myComponent`. You must\ncreate your own filters for each AST node so you only transform the correct nodes. You can\nvisit ts-ast-viewer.com to see the AST and types. You can also use the factory creator to\nreturn new AST.",
|
|
252441
|
+
"declarations": [
|
|
252442
|
+
{
|
|
252443
|
+
"name": "additionalTransforms",
|
|
252444
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252445
|
+
}
|
|
252446
|
+
],
|
|
252447
|
+
"tags": {}
|
|
252448
|
+
},
|
|
252449
|
+
{
|
|
252450
|
+
"kind": "property",
|
|
252451
|
+
"name": "getFileName",
|
|
252452
|
+
"required": false,
|
|
252453
|
+
"type": {
|
|
252454
|
+
"kind": "function",
|
|
252455
|
+
"parameters": [
|
|
252456
|
+
{
|
|
252457
|
+
"kind": "parameter",
|
|
252458
|
+
"name": "path",
|
|
252459
|
+
"type": {
|
|
252460
|
+
"kind": "primitive",
|
|
252461
|
+
"value": "string"
|
|
252462
|
+
},
|
|
252463
|
+
"required": true,
|
|
252464
|
+
"rest": false,
|
|
252465
|
+
"description": "",
|
|
252466
|
+
"declarations": [
|
|
252467
|
+
{
|
|
252468
|
+
"name": "path",
|
|
252469
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252470
|
+
}
|
|
252471
|
+
],
|
|
252472
|
+
"tags": {}
|
|
252473
|
+
}
|
|
252474
|
+
],
|
|
252475
|
+
"members": [],
|
|
252476
|
+
"returnType": {
|
|
252477
|
+
"kind": "primitive",
|
|
252478
|
+
"value": "string"
|
|
252479
|
+
}
|
|
252480
|
+
},
|
|
252481
|
+
"description": "This will be called every time a style or keyframe needs to be injected into extracted style\nfiles. By default, the file name will be the current file with the `.tsx` replaced with a\n`.css`. If you wish to move or combine styles into a file, provide a custom `getFileName`. You\ncan return the same file path for multiple sources. If the same file is used (maybe always\nreturning `index.css`), new styles will be appended to the end of the file.",
|
|
252482
|
+
"declarations": [
|
|
252483
|
+
{
|
|
252484
|
+
"name": "getFileName",
|
|
252485
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252486
|
+
}
|
|
252487
|
+
],
|
|
252488
|
+
"tags": {}
|
|
252489
|
+
},
|
|
252490
|
+
{
|
|
252491
|
+
"kind": "property",
|
|
252492
|
+
"name": "objectTransforms",
|
|
252493
|
+
"required": false,
|
|
252494
|
+
"type": {
|
|
252495
|
+
"kind": "array",
|
|
252496
|
+
"value": {
|
|
252497
|
+
"kind": "symbol",
|
|
252498
|
+
"name": "ObjectTransform",
|
|
252499
|
+
"value": "ObjectTransform"
|
|
252500
|
+
}
|
|
252501
|
+
},
|
|
252502
|
+
"description": "Object transforms take an AST node that represents a style object and turn it into a\n`NestedStyleObject` or return `void`. If an object transform returns an object, transformation\nparsing stops on that node. If `void` is returned, processing continues using\n`parseObjectToStaticValue`. These transforms are useful if you have custom utility functions\nthat are not statically parsable by the static styling transformer.",
|
|
252503
|
+
"declarations": [
|
|
252504
|
+
{
|
|
252505
|
+
"name": "objectTransforms",
|
|
252506
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252507
|
+
}
|
|
252508
|
+
],
|
|
252509
|
+
"tags": {}
|
|
252510
|
+
},
|
|
252511
|
+
{
|
|
252512
|
+
"kind": "property",
|
|
252513
|
+
"name": "propertyTransforms",
|
|
252514
|
+
"required": false,
|
|
252515
|
+
"type": {
|
|
252516
|
+
"kind": "array",
|
|
252517
|
+
"value": {
|
|
252518
|
+
"kind": "symbol",
|
|
252519
|
+
"name": "PropertyTransform",
|
|
252520
|
+
"value": "PropertyTransform"
|
|
252521
|
+
}
|
|
252522
|
+
},
|
|
252523
|
+
"description": "",
|
|
252524
|
+
"declarations": [
|
|
252525
|
+
{
|
|
252526
|
+
"name": "propertyTransforms",
|
|
252527
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252528
|
+
}
|
|
252529
|
+
],
|
|
252530
|
+
"tags": {}
|
|
252531
|
+
}
|
|
252532
|
+
]
|
|
252533
|
+
}
|
|
252534
|
+
},
|
|
252535
|
+
{
|
|
252536
|
+
"name": "ObjectTransform",
|
|
252537
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
252538
|
+
"description": "",
|
|
252539
|
+
"declarations": [
|
|
252540
|
+
{
|
|
252541
|
+
"name": "ObjectTransform",
|
|
252542
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252543
|
+
}
|
|
252544
|
+
],
|
|
252545
|
+
"tags": {},
|
|
252546
|
+
"type": {
|
|
252547
|
+
"kind": "type",
|
|
252548
|
+
"typeParameters": [],
|
|
252549
|
+
"value": {
|
|
252550
|
+
"kind": "function",
|
|
252551
|
+
"parameters": [
|
|
252552
|
+
{
|
|
252553
|
+
"kind": "parameter",
|
|
252554
|
+
"name": "node",
|
|
252555
|
+
"type": {
|
|
252556
|
+
"kind": "symbol",
|
|
252557
|
+
"name": "ts.Node",
|
|
252558
|
+
"value": "Node"
|
|
252559
|
+
},
|
|
252560
|
+
"required": true,
|
|
252561
|
+
"rest": false,
|
|
252562
|
+
"description": "",
|
|
252563
|
+
"declarations": [
|
|
252564
|
+
{
|
|
252565
|
+
"name": "node",
|
|
252566
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252567
|
+
}
|
|
252568
|
+
],
|
|
252569
|
+
"tags": {}
|
|
252570
|
+
},
|
|
252571
|
+
{
|
|
252572
|
+
"kind": "parameter",
|
|
252573
|
+
"name": "context",
|
|
252574
|
+
"type": {
|
|
252575
|
+
"kind": "symbol",
|
|
252576
|
+
"name": "TransformerContext",
|
|
252577
|
+
"value": "TransformerContext"
|
|
252578
|
+
},
|
|
252579
|
+
"required": true,
|
|
252580
|
+
"rest": false,
|
|
252581
|
+
"description": "",
|
|
252582
|
+
"declarations": [
|
|
252583
|
+
{
|
|
252584
|
+
"name": "context",
|
|
252585
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252586
|
+
}
|
|
252587
|
+
],
|
|
252588
|
+
"tags": {}
|
|
252589
|
+
}
|
|
252590
|
+
],
|
|
252591
|
+
"members": [],
|
|
252592
|
+
"returnType": {
|
|
252593
|
+
"kind": "union",
|
|
252594
|
+
"value": [
|
|
252595
|
+
{
|
|
252596
|
+
"kind": "symbol",
|
|
252597
|
+
"name": "NestedStyleObject",
|
|
252598
|
+
"value": "NestedStyleObject"
|
|
252599
|
+
},
|
|
252600
|
+
{
|
|
252601
|
+
"kind": "primitive",
|
|
252602
|
+
"value": "void"
|
|
252603
|
+
}
|
|
252604
|
+
]
|
|
252605
|
+
}
|
|
252606
|
+
}
|
|
252607
|
+
}
|
|
252608
|
+
},
|
|
252609
|
+
{
|
|
252610
|
+
"name": "PropertyTransform",
|
|
252611
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
252612
|
+
"description": "",
|
|
252613
|
+
"declarations": [
|
|
252614
|
+
{
|
|
252615
|
+
"name": "PropertyTransform",
|
|
252616
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252617
|
+
}
|
|
252618
|
+
],
|
|
252619
|
+
"tags": {},
|
|
252620
|
+
"type": {
|
|
252621
|
+
"kind": "type",
|
|
252622
|
+
"typeParameters": [],
|
|
252623
|
+
"value": {
|
|
252624
|
+
"kind": "function",
|
|
252625
|
+
"parameters": [
|
|
252626
|
+
{
|
|
252627
|
+
"kind": "parameter",
|
|
252628
|
+
"name": "node",
|
|
252629
|
+
"type": {
|
|
252630
|
+
"kind": "symbol",
|
|
252631
|
+
"name": "ts.Node",
|
|
252632
|
+
"value": "Node"
|
|
252633
|
+
},
|
|
252634
|
+
"required": true,
|
|
252635
|
+
"rest": false,
|
|
252636
|
+
"description": "",
|
|
252637
|
+
"declarations": [
|
|
252638
|
+
{
|
|
252639
|
+
"name": "node",
|
|
252640
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252641
|
+
}
|
|
252642
|
+
],
|
|
252643
|
+
"tags": {}
|
|
252644
|
+
},
|
|
252645
|
+
{
|
|
252646
|
+
"kind": "parameter",
|
|
252647
|
+
"name": "context",
|
|
252648
|
+
"type": {
|
|
252649
|
+
"kind": "symbol",
|
|
252650
|
+
"name": "TransformerContext",
|
|
252651
|
+
"value": "TransformerContext"
|
|
252652
|
+
},
|
|
252653
|
+
"required": true,
|
|
252654
|
+
"rest": false,
|
|
252655
|
+
"description": "",
|
|
252656
|
+
"declarations": [
|
|
252657
|
+
{
|
|
252658
|
+
"name": "context",
|
|
252659
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
252660
|
+
}
|
|
252661
|
+
],
|
|
252662
|
+
"tags": {}
|
|
252663
|
+
}
|
|
252664
|
+
],
|
|
252665
|
+
"members": [],
|
|
252666
|
+
"returnType": {
|
|
252667
|
+
"kind": "union",
|
|
252668
|
+
"value": [
|
|
252669
|
+
{
|
|
252670
|
+
"kind": "primitive",
|
|
252671
|
+
"value": "string"
|
|
252672
|
+
},
|
|
252673
|
+
{
|
|
252674
|
+
"kind": "primitive",
|
|
252675
|
+
"value": "void"
|
|
252676
|
+
}
|
|
252677
|
+
]
|
|
252678
|
+
}
|
|
252679
|
+
}
|
|
252680
|
+
}
|
|
252681
|
+
},
|
|
250667
252682
|
{
|
|
250668
252683
|
"name": "calc",
|
|
250669
252684
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/calc.ts",
|