@workday/canvas-kit-docs 11.0.0-alpha.645-next.0 → 11.0.0-alpha.656-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 +1918 -705
- package/dist/mdx/11.0-UPGRADE-GUIDE.mdx +41 -9
- package/dist/mdx/preview-react/loading-sparkles/LoadingSparkles.mdx +33 -0
- package/dist/mdx/preview-react/loading-sparkles/examples/Basic.tsx +6 -0
- package/dist/mdx/preview-react/loading-sparkles/examples/RTL.tsx +16 -0
- package/dist/mdx/react/card/card.mdx +2 -2
- package/dist/mdx/react/card/examples/Depth.tsx +7 -1
- package/dist/mdx/react/card/examples/Padding.tsx +8 -1
- package/dist/mdx/react/text/LabelText.mdx +11 -1
- package/dist/mdx/react/text/examples/LabelText/Disabled.tsx +21 -1
- package/package.json +7 -7
package/dist/es6/lib/docs.js
CHANGED
|
@@ -6079,13 +6079,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6079
6079
|
"name": "variant",
|
|
6080
6080
|
"required": false,
|
|
6081
6081
|
"type": {
|
|
6082
|
-
"kind": "
|
|
6083
|
-
"
|
|
6084
|
-
|
|
6085
|
-
|
|
6086
|
-
|
|
6087
|
-
|
|
6088
|
-
|
|
6082
|
+
"kind": "union",
|
|
6083
|
+
"value": [
|
|
6084
|
+
{
|
|
6085
|
+
"kind": "string",
|
|
6086
|
+
"value": "error"
|
|
6087
|
+
},
|
|
6088
|
+
{
|
|
6089
|
+
"kind": "string",
|
|
6090
|
+
"value": "hint"
|
|
6091
|
+
},
|
|
6092
|
+
{
|
|
6093
|
+
"kind": "string",
|
|
6094
|
+
"value": "inverse"
|
|
6095
|
+
}
|
|
6096
|
+
]
|
|
6089
6097
|
},
|
|
6090
6098
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
6091
6099
|
"declarations": [
|
|
@@ -6440,41 +6448,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6440
6448
|
],
|
|
6441
6449
|
"tags": {}
|
|
6442
6450
|
},
|
|
6443
|
-
{
|
|
6444
|
-
"kind": "property",
|
|
6445
|
-
"name": "cursor",
|
|
6446
|
-
"required": false,
|
|
6447
|
-
"type": {
|
|
6448
|
-
"kind": "external",
|
|
6449
|
-
"name": "Property.Cursor",
|
|
6450
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/CSS/cursor"
|
|
6451
|
-
},
|
|
6452
|
-
"description": "sets [CSS cursor property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)",
|
|
6453
|
-
"declarations": [
|
|
6454
|
-
{
|
|
6455
|
-
"name": "cursor",
|
|
6456
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
6457
|
-
}
|
|
6458
|
-
],
|
|
6459
|
-
"tags": {}
|
|
6460
|
-
},
|
|
6461
|
-
{
|
|
6462
|
-
"kind": "property",
|
|
6463
|
-
"name": "disabled",
|
|
6464
|
-
"required": false,
|
|
6465
|
-
"type": {
|
|
6466
|
-
"kind": "primitive",
|
|
6467
|
-
"value": "boolean"
|
|
6468
|
-
},
|
|
6469
|
-
"description": "",
|
|
6470
|
-
"declarations": [
|
|
6471
|
-
{
|
|
6472
|
-
"name": "disabled",
|
|
6473
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
6474
|
-
}
|
|
6475
|
-
],
|
|
6476
|
-
"tags": {}
|
|
6477
|
-
},
|
|
6478
6451
|
{
|
|
6479
6452
|
"kind": "property",
|
|
6480
6453
|
"name": "typeLevel",
|
|
@@ -6508,57 +6481,82 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
6508
6481
|
},
|
|
6509
6482
|
{
|
|
6510
6483
|
"kind": "string",
|
|
6511
|
-
"value": "
|
|
6484
|
+
"value": "subtext.medium"
|
|
6512
6485
|
},
|
|
6513
6486
|
{
|
|
6514
6487
|
"kind": "string",
|
|
6515
|
-
"value": "
|
|
6488
|
+
"value": "subtext.large"
|
|
6516
6489
|
},
|
|
6517
6490
|
{
|
|
6518
6491
|
"kind": "string",
|
|
6519
|
-
"value": "
|
|
6492
|
+
"value": "subtext.small"
|
|
6520
6493
|
},
|
|
6521
6494
|
{
|
|
6522
6495
|
"kind": "string",
|
|
6523
|
-
"value": "
|
|
6496
|
+
"value": "heading.medium"
|
|
6524
6497
|
},
|
|
6525
6498
|
{
|
|
6526
6499
|
"kind": "string",
|
|
6527
|
-
"value": "
|
|
6500
|
+
"value": "heading.large"
|
|
6528
6501
|
},
|
|
6529
6502
|
{
|
|
6530
6503
|
"kind": "string",
|
|
6531
|
-
"value": "
|
|
6504
|
+
"value": "heading.small"
|
|
6532
6505
|
}
|
|
6533
6506
|
]
|
|
6534
6507
|
},
|
|
6535
|
-
"description": "
|
|
6508
|
+
"description": "",
|
|
6536
6509
|
"declarations": [
|
|
6537
6510
|
{
|
|
6538
6511
|
"name": "typeLevel",
|
|
6539
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/
|
|
6512
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
6540
6513
|
}
|
|
6541
6514
|
],
|
|
6542
6515
|
"tags": {}
|
|
6543
6516
|
},
|
|
6544
6517
|
{
|
|
6545
6518
|
"kind": "property",
|
|
6546
|
-
"name": "
|
|
6519
|
+
"name": "disabled",
|
|
6547
6520
|
"required": false,
|
|
6548
6521
|
"type": {
|
|
6549
|
-
"kind": "
|
|
6550
|
-
"
|
|
6551
|
-
|
|
6552
|
-
|
|
6553
|
-
|
|
6554
|
-
|
|
6522
|
+
"kind": "primitive",
|
|
6523
|
+
"value": "boolean"
|
|
6524
|
+
},
|
|
6525
|
+
"description": "Disabled state as a boolean\n\n```tsx\n<LabelText disabled={true}>Error text</LabelText>\n```",
|
|
6526
|
+
"declarations": [
|
|
6527
|
+
{
|
|
6528
|
+
"name": "disabled",
|
|
6529
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
6555
6530
|
}
|
|
6531
|
+
],
|
|
6532
|
+
"tags": {}
|
|
6533
|
+
},
|
|
6534
|
+
{
|
|
6535
|
+
"kind": "property",
|
|
6536
|
+
"name": "variant",
|
|
6537
|
+
"required": false,
|
|
6538
|
+
"type": {
|
|
6539
|
+
"kind": "union",
|
|
6540
|
+
"value": [
|
|
6541
|
+
{
|
|
6542
|
+
"kind": "string",
|
|
6543
|
+
"value": "error"
|
|
6544
|
+
},
|
|
6545
|
+
{
|
|
6546
|
+
"kind": "string",
|
|
6547
|
+
"value": "hint"
|
|
6548
|
+
},
|
|
6549
|
+
{
|
|
6550
|
+
"kind": "string",
|
|
6551
|
+
"value": "inverse"
|
|
6552
|
+
}
|
|
6553
|
+
]
|
|
6556
6554
|
},
|
|
6557
|
-
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<
|
|
6555
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<LabelText variant=\"error\">Error text</LabelText>\n```",
|
|
6558
6556
|
"declarations": [
|
|
6559
6557
|
{
|
|
6560
6558
|
"name": "variant",
|
|
6561
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/
|
|
6559
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
6562
6560
|
}
|
|
6563
6561
|
],
|
|
6564
6562
|
"tags": {}
|
|
@@ -7768,6 +7766,118 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
7768
7766
|
}
|
|
7769
7767
|
}
|
|
7770
7768
|
},
|
|
7769
|
+
{
|
|
7770
|
+
"name": "LoadingSparkles",
|
|
7771
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/loading-sparkles/lib/LoadingSparkles.tsx",
|
|
7772
|
+
"description": "A simple component that displays three horizontal sparkles, to be used when an AI operation is in progress.",
|
|
7773
|
+
"declarations": [
|
|
7774
|
+
{
|
|
7775
|
+
"name": "LoadingSparkles",
|
|
7776
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/loading-sparkles/lib/LoadingSparkles.tsx"
|
|
7777
|
+
}
|
|
7778
|
+
],
|
|
7779
|
+
"tags": {},
|
|
7780
|
+
"type": {
|
|
7781
|
+
"kind": "enhancedComponent",
|
|
7782
|
+
"componentType": "regular",
|
|
7783
|
+
"displayName": "LoadingSparkles",
|
|
7784
|
+
"props": [
|
|
7785
|
+
{
|
|
7786
|
+
"kind": "property",
|
|
7787
|
+
"name": "cs",
|
|
7788
|
+
"required": false,
|
|
7789
|
+
"type": {
|
|
7790
|
+
"kind": "symbol",
|
|
7791
|
+
"name": "CSToPropsInput",
|
|
7792
|
+
"value": "CSToPropsInput"
|
|
7793
|
+
},
|
|
7794
|
+
"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```",
|
|
7795
|
+
"declarations": [
|
|
7796
|
+
{
|
|
7797
|
+
"name": "cs",
|
|
7798
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
7799
|
+
}
|
|
7800
|
+
],
|
|
7801
|
+
"tags": {}
|
|
7802
|
+
},
|
|
7803
|
+
{
|
|
7804
|
+
"kind": "property",
|
|
7805
|
+
"name": "children",
|
|
7806
|
+
"description": "",
|
|
7807
|
+
"tags": {},
|
|
7808
|
+
"declarations": [],
|
|
7809
|
+
"type": {
|
|
7810
|
+
"kind": "external",
|
|
7811
|
+
"name": "React.ReactNode",
|
|
7812
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
7813
|
+
}
|
|
7814
|
+
},
|
|
7815
|
+
{
|
|
7816
|
+
"kind": "property",
|
|
7817
|
+
"name": "as",
|
|
7818
|
+
"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.",
|
|
7819
|
+
"tags": {},
|
|
7820
|
+
"declarations": [],
|
|
7821
|
+
"type": {
|
|
7822
|
+
"kind": "external",
|
|
7823
|
+
"name": "React.ElementType",
|
|
7824
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
7825
|
+
},
|
|
7826
|
+
"defaultValue": {
|
|
7827
|
+
"kind": "external",
|
|
7828
|
+
"name": "div",
|
|
7829
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
7830
|
+
}
|
|
7831
|
+
},
|
|
7832
|
+
{
|
|
7833
|
+
"kind": "property",
|
|
7834
|
+
"name": "ref",
|
|
7835
|
+
"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`).",
|
|
7836
|
+
"tags": {},
|
|
7837
|
+
"declarations": [],
|
|
7838
|
+
"type": {
|
|
7839
|
+
"kind": "external",
|
|
7840
|
+
"name": "React.Ref",
|
|
7841
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
7842
|
+
"typeParameters": [
|
|
7843
|
+
{
|
|
7844
|
+
"kind": "typeParameter",
|
|
7845
|
+
"name": "R",
|
|
7846
|
+
"required": true,
|
|
7847
|
+
"defaultValue": {
|
|
7848
|
+
"kind": "external",
|
|
7849
|
+
"name": "div",
|
|
7850
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
7851
|
+
}
|
|
7852
|
+
}
|
|
7853
|
+
]
|
|
7854
|
+
}
|
|
7855
|
+
}
|
|
7856
|
+
],
|
|
7857
|
+
"baseElement": {
|
|
7858
|
+
"kind": "external",
|
|
7859
|
+
"name": "div",
|
|
7860
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
7861
|
+
}
|
|
7862
|
+
}
|
|
7863
|
+
},
|
|
7864
|
+
{
|
|
7865
|
+
"name": "sparkleIcon",
|
|
7866
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/loading-sparkles/lib/sparkleIcon.ts",
|
|
7867
|
+
"description": "",
|
|
7868
|
+
"declarations": [
|
|
7869
|
+
{
|
|
7870
|
+
"name": "sparkleIcon",
|
|
7871
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/loading-sparkles/lib/sparkleIcon.ts"
|
|
7872
|
+
}
|
|
7873
|
+
],
|
|
7874
|
+
"tags": {},
|
|
7875
|
+
"type": {
|
|
7876
|
+
"kind": "symbol",
|
|
7877
|
+
"name": "CanvasSystemIcon",
|
|
7878
|
+
"value": "CanvasSystemIcon"
|
|
7879
|
+
}
|
|
7880
|
+
},
|
|
7771
7881
|
{
|
|
7772
7882
|
"name": "DeprecatedMenuProps",
|
|
7773
7883
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/menu/lib/Menu.tsx",
|
|
@@ -31421,27 +31531,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
31421
31531
|
},
|
|
31422
31532
|
{
|
|
31423
31533
|
"kind": "string",
|
|
31424
|
-
"value": "
|
|
31534
|
+
"value": "subtext.medium"
|
|
31425
31535
|
},
|
|
31426
31536
|
{
|
|
31427
31537
|
"kind": "string",
|
|
31428
|
-
"value": "
|
|
31538
|
+
"value": "subtext.large"
|
|
31429
31539
|
},
|
|
31430
31540
|
{
|
|
31431
31541
|
"kind": "string",
|
|
31432
|
-
"value": "
|
|
31542
|
+
"value": "subtext.small"
|
|
31433
31543
|
},
|
|
31434
31544
|
{
|
|
31435
31545
|
"kind": "string",
|
|
31436
|
-
"value": "
|
|
31546
|
+
"value": "heading.medium"
|
|
31437
31547
|
},
|
|
31438
31548
|
{
|
|
31439
31549
|
"kind": "string",
|
|
31440
|
-
"value": "
|
|
31550
|
+
"value": "heading.large"
|
|
31441
31551
|
},
|
|
31442
31552
|
{
|
|
31443
31553
|
"kind": "string",
|
|
31444
|
-
"value": "
|
|
31554
|
+
"value": "heading.small"
|
|
31445
31555
|
}
|
|
31446
31556
|
]
|
|
31447
31557
|
},
|
|
@@ -31463,13 +31573,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
31463
31573
|
"name": "variant",
|
|
31464
31574
|
"required": false,
|
|
31465
31575
|
"type": {
|
|
31466
|
-
"kind": "
|
|
31467
|
-
"
|
|
31468
|
-
|
|
31469
|
-
|
|
31470
|
-
|
|
31471
|
-
|
|
31472
|
-
|
|
31576
|
+
"kind": "union",
|
|
31577
|
+
"value": [
|
|
31578
|
+
{
|
|
31579
|
+
"kind": "string",
|
|
31580
|
+
"value": "error"
|
|
31581
|
+
},
|
|
31582
|
+
{
|
|
31583
|
+
"kind": "string",
|
|
31584
|
+
"value": "hint"
|
|
31585
|
+
},
|
|
31586
|
+
{
|
|
31587
|
+
"kind": "string",
|
|
31588
|
+
"value": "inverse"
|
|
31589
|
+
}
|
|
31590
|
+
]
|
|
31473
31591
|
},
|
|
31474
31592
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
31475
31593
|
"declarations": [
|
|
@@ -44148,27 +44266,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
44148
44266
|
},
|
|
44149
44267
|
{
|
|
44150
44268
|
"kind": "string",
|
|
44151
|
-
"value": "
|
|
44269
|
+
"value": "subtext.medium"
|
|
44152
44270
|
},
|
|
44153
44271
|
{
|
|
44154
44272
|
"kind": "string",
|
|
44155
|
-
"value": "
|
|
44273
|
+
"value": "subtext.large"
|
|
44156
44274
|
},
|
|
44157
44275
|
{
|
|
44158
44276
|
"kind": "string",
|
|
44159
|
-
"value": "
|
|
44277
|
+
"value": "subtext.small"
|
|
44160
44278
|
},
|
|
44161
44279
|
{
|
|
44162
44280
|
"kind": "string",
|
|
44163
|
-
"value": "
|
|
44281
|
+
"value": "heading.medium"
|
|
44164
44282
|
},
|
|
44165
44283
|
{
|
|
44166
44284
|
"kind": "string",
|
|
44167
|
-
"value": "
|
|
44285
|
+
"value": "heading.large"
|
|
44168
44286
|
},
|
|
44169
44287
|
{
|
|
44170
44288
|
"kind": "string",
|
|
44171
|
-
"value": "
|
|
44289
|
+
"value": "heading.small"
|
|
44172
44290
|
}
|
|
44173
44291
|
]
|
|
44174
44292
|
},
|
|
@@ -44190,13 +44308,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
44190
44308
|
"name": "variant",
|
|
44191
44309
|
"required": false,
|
|
44192
44310
|
"type": {
|
|
44193
|
-
"kind": "
|
|
44194
|
-
"
|
|
44195
|
-
|
|
44196
|
-
|
|
44197
|
-
|
|
44198
|
-
|
|
44199
|
-
|
|
44311
|
+
"kind": "union",
|
|
44312
|
+
"value": [
|
|
44313
|
+
{
|
|
44314
|
+
"kind": "string",
|
|
44315
|
+
"value": "error"
|
|
44316
|
+
},
|
|
44317
|
+
{
|
|
44318
|
+
"kind": "string",
|
|
44319
|
+
"value": "hint"
|
|
44320
|
+
},
|
|
44321
|
+
{
|
|
44322
|
+
"kind": "string",
|
|
44323
|
+
"value": "inverse"
|
|
44324
|
+
}
|
|
44325
|
+
]
|
|
44200
44326
|
},
|
|
44201
44327
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
44202
44328
|
"declarations": [
|
|
@@ -63667,6 +63793,22 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
63667
63793
|
}
|
|
63668
63794
|
}
|
|
63669
63795
|
},
|
|
63796
|
+
{
|
|
63797
|
+
"name": "CardBodyProps",
|
|
63798
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
63799
|
+
"description": "",
|
|
63800
|
+
"declarations": [
|
|
63801
|
+
{
|
|
63802
|
+
"name": "CardBodyProps",
|
|
63803
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
63804
|
+
}
|
|
63805
|
+
],
|
|
63806
|
+
"tags": {},
|
|
63807
|
+
"type": {
|
|
63808
|
+
"kind": "alias",
|
|
63809
|
+
"name": "CardBody"
|
|
63810
|
+
}
|
|
63811
|
+
},
|
|
63670
63812
|
{
|
|
63671
63813
|
"name": "CardBody",
|
|
63672
63814
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
@@ -163231,14 +163373,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
163231
163373
|
{
|
|
163232
163374
|
"kind": "property",
|
|
163233
163375
|
"name": "children",
|
|
163234
|
-
"
|
|
163235
|
-
"tags": {},
|
|
163236
|
-
"declarations": [],
|
|
163376
|
+
"required": false,
|
|
163237
163377
|
"type": {
|
|
163238
163378
|
"kind": "external",
|
|
163239
|
-
"name": "
|
|
163379
|
+
"name": "ReactNode",
|
|
163240
163380
|
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
163241
|
-
}
|
|
163381
|
+
},
|
|
163382
|
+
"description": "",
|
|
163383
|
+
"declarations": [
|
|
163384
|
+
{
|
|
163385
|
+
"name": "children",
|
|
163386
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
163387
|
+
}
|
|
163388
|
+
],
|
|
163389
|
+
"tags": {}
|
|
163242
163390
|
},
|
|
163243
163391
|
{
|
|
163244
163392
|
"kind": "property",
|
|
@@ -188197,14 +188345,20 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
188197
188345
|
{
|
|
188198
188346
|
"kind": "property",
|
|
188199
188347
|
"name": "children",
|
|
188200
|
-
"
|
|
188201
|
-
"tags": {},
|
|
188202
|
-
"declarations": [],
|
|
188348
|
+
"required": false,
|
|
188203
188349
|
"type": {
|
|
188204
188350
|
"kind": "external",
|
|
188205
|
-
"name": "
|
|
188351
|
+
"name": "ReactNode",
|
|
188206
188352
|
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
188207
|
-
}
|
|
188353
|
+
},
|
|
188354
|
+
"description": "",
|
|
188355
|
+
"declarations": [
|
|
188356
|
+
{
|
|
188357
|
+
"name": "children",
|
|
188358
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
188359
|
+
}
|
|
188360
|
+
],
|
|
188361
|
+
"tags": {}
|
|
188208
188362
|
},
|
|
188209
188363
|
{
|
|
188210
188364
|
"kind": "property",
|
|
@@ -223485,45 +223639,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
223485
223639
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
223486
223640
|
}
|
|
223487
223641
|
],
|
|
223488
|
-
"tags": {
|
|
223642
|
+
"tags": {
|
|
223643
|
+
"deprecated": "⚠️ `TypeLabelProps` has been deprecated and will be removed in a future major version."
|
|
223644
|
+
},
|
|
223489
223645
|
"type": {
|
|
223490
223646
|
"kind": "object",
|
|
223491
223647
|
"properties": [
|
|
223492
|
-
{
|
|
223493
|
-
"kind": "property",
|
|
223494
|
-
"name": "cursor",
|
|
223495
|
-
"required": false,
|
|
223496
|
-
"type": {
|
|
223497
|
-
"kind": "external",
|
|
223498
|
-
"name": "Property.Cursor",
|
|
223499
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/CSS/cursor"
|
|
223500
|
-
},
|
|
223501
|
-
"description": "sets [CSS cursor property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)",
|
|
223502
|
-
"declarations": [
|
|
223503
|
-
{
|
|
223504
|
-
"name": "cursor",
|
|
223505
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
223506
|
-
}
|
|
223507
|
-
],
|
|
223508
|
-
"tags": {}
|
|
223509
|
-
},
|
|
223510
|
-
{
|
|
223511
|
-
"kind": "property",
|
|
223512
|
-
"name": "disabled",
|
|
223513
|
-
"required": false,
|
|
223514
|
-
"type": {
|
|
223515
|
-
"kind": "primitive",
|
|
223516
|
-
"value": "boolean"
|
|
223517
|
-
},
|
|
223518
|
-
"description": "",
|
|
223519
|
-
"declarations": [
|
|
223520
|
-
{
|
|
223521
|
-
"name": "disabled",
|
|
223522
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
223523
|
-
}
|
|
223524
|
-
],
|
|
223525
|
-
"tags": {}
|
|
223526
|
-
},
|
|
223527
223648
|
{
|
|
223528
223649
|
"kind": "property",
|
|
223529
223650
|
"name": "typeLevel",
|
|
@@ -223557,57 +223678,82 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
223557
223678
|
},
|
|
223558
223679
|
{
|
|
223559
223680
|
"kind": "string",
|
|
223560
|
-
"value": "
|
|
223681
|
+
"value": "subtext.medium"
|
|
223561
223682
|
},
|
|
223562
223683
|
{
|
|
223563
223684
|
"kind": "string",
|
|
223564
|
-
"value": "
|
|
223685
|
+
"value": "subtext.large"
|
|
223565
223686
|
},
|
|
223566
223687
|
{
|
|
223567
223688
|
"kind": "string",
|
|
223568
|
-
"value": "
|
|
223689
|
+
"value": "subtext.small"
|
|
223569
223690
|
},
|
|
223570
223691
|
{
|
|
223571
223692
|
"kind": "string",
|
|
223572
|
-
"value": "
|
|
223693
|
+
"value": "heading.medium"
|
|
223573
223694
|
},
|
|
223574
223695
|
{
|
|
223575
223696
|
"kind": "string",
|
|
223576
|
-
"value": "
|
|
223697
|
+
"value": "heading.large"
|
|
223577
223698
|
},
|
|
223578
223699
|
{
|
|
223579
223700
|
"kind": "string",
|
|
223580
|
-
"value": "
|
|
223701
|
+
"value": "heading.small"
|
|
223581
223702
|
}
|
|
223582
223703
|
]
|
|
223583
223704
|
},
|
|
223584
|
-
"description": "
|
|
223705
|
+
"description": "",
|
|
223585
223706
|
"declarations": [
|
|
223586
223707
|
{
|
|
223587
223708
|
"name": "typeLevel",
|
|
223588
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/
|
|
223709
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
223589
223710
|
}
|
|
223590
223711
|
],
|
|
223591
223712
|
"tags": {}
|
|
223592
223713
|
},
|
|
223593
223714
|
{
|
|
223594
223715
|
"kind": "property",
|
|
223595
|
-
"name": "
|
|
223716
|
+
"name": "disabled",
|
|
223596
223717
|
"required": false,
|
|
223597
223718
|
"type": {
|
|
223598
|
-
"kind": "
|
|
223599
|
-
"
|
|
223600
|
-
|
|
223601
|
-
|
|
223602
|
-
|
|
223603
|
-
|
|
223719
|
+
"kind": "primitive",
|
|
223720
|
+
"value": "boolean"
|
|
223721
|
+
},
|
|
223722
|
+
"description": "Disabled state as a boolean\n\n```tsx\n<LabelText disabled={true}>Error text</LabelText>\n```",
|
|
223723
|
+
"declarations": [
|
|
223724
|
+
{
|
|
223725
|
+
"name": "disabled",
|
|
223726
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
223604
223727
|
}
|
|
223728
|
+
],
|
|
223729
|
+
"tags": {}
|
|
223730
|
+
},
|
|
223731
|
+
{
|
|
223732
|
+
"kind": "property",
|
|
223733
|
+
"name": "variant",
|
|
223734
|
+
"required": false,
|
|
223735
|
+
"type": {
|
|
223736
|
+
"kind": "union",
|
|
223737
|
+
"value": [
|
|
223738
|
+
{
|
|
223739
|
+
"kind": "string",
|
|
223740
|
+
"value": "error"
|
|
223741
|
+
},
|
|
223742
|
+
{
|
|
223743
|
+
"kind": "string",
|
|
223744
|
+
"value": "hint"
|
|
223745
|
+
},
|
|
223746
|
+
{
|
|
223747
|
+
"kind": "string",
|
|
223748
|
+
"value": "inverse"
|
|
223749
|
+
}
|
|
223750
|
+
]
|
|
223605
223751
|
},
|
|
223606
|
-
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<
|
|
223752
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<LabelText variant=\"error\">Error text</LabelText>\n```",
|
|
223607
223753
|
"declarations": [
|
|
223608
223754
|
{
|
|
223609
223755
|
"name": "variant",
|
|
223610
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/
|
|
223756
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
223611
223757
|
}
|
|
223612
223758
|
],
|
|
223613
223759
|
"tags": {}
|
|
@@ -225606,6 +225752,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
225606
225752
|
],
|
|
225607
225753
|
"tags": {}
|
|
225608
225754
|
},
|
|
225755
|
+
{
|
|
225756
|
+
"kind": "property",
|
|
225757
|
+
"name": "cursor",
|
|
225758
|
+
"required": false,
|
|
225759
|
+
"type": {
|
|
225760
|
+
"kind": "external",
|
|
225761
|
+
"name": "Property.Cursor",
|
|
225762
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/CSS/cursor"
|
|
225763
|
+
},
|
|
225764
|
+
"description": "sets [CSS cursor property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)",
|
|
225765
|
+
"declarations": [
|
|
225766
|
+
{
|
|
225767
|
+
"name": "cursor",
|
|
225768
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/utils/other.ts"
|
|
225769
|
+
}
|
|
225770
|
+
],
|
|
225771
|
+
"tags": {}
|
|
225772
|
+
},
|
|
225609
225773
|
{
|
|
225610
225774
|
"kind": "property",
|
|
225611
225775
|
"name": "fill",
|
|
@@ -228073,54 +228237,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228073
228237
|
{
|
|
228074
228238
|
"name": "LabelText",
|
|
228075
228239
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx",
|
|
228076
|
-
"description": "This component is intended to be used for labeling input fields
|
|
228240
|
+
"description": "This component is intended to be used for labeling input fields.\nBy default, it renders a semantic `label` element.\n\nIt also uses the `subtext.large` typeLevel by default:\n- font-size: 14px (0.875rem)\n- font-weight: regular (400)\n\n```tsx\nimport { LabelText } from '@workday/canvas-kit-react/text';\n\nconst CustomLabelText = () => (\n <LabelText>Input Label Text</LabelText>\n);\n```",
|
|
228077
228241
|
"declarations": [
|
|
228078
228242
|
{
|
|
228079
228243
|
"name": "LabelText",
|
|
228080
228244
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
228081
228245
|
}
|
|
228082
228246
|
],
|
|
228083
|
-
"tags": {
|
|
228247
|
+
"tags": {
|
|
228248
|
+
"deprecated": "⚠️ `LabelText` has been deprecated and will be removed in a future major version. Please use [FormField.Label](https://workday.github.io/canvas-kit/?path=/docs/preview-inputs-form-field--basic) from Preview instead."
|
|
228249
|
+
},
|
|
228084
228250
|
"type": {
|
|
228085
228251
|
"kind": "enhancedComponent",
|
|
228086
228252
|
"componentType": "regular",
|
|
228087
228253
|
"displayName": "Label",
|
|
228088
228254
|
"props": [
|
|
228089
|
-
{
|
|
228090
|
-
"kind": "property",
|
|
228091
|
-
"name": "cursor",
|
|
228092
|
-
"required": false,
|
|
228093
|
-
"type": {
|
|
228094
|
-
"kind": "external",
|
|
228095
|
-
"name": "Property.Cursor",
|
|
228096
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/CSS/cursor"
|
|
228097
|
-
},
|
|
228098
|
-
"description": "sets [CSS cursor property](https://developer.mozilla.org/en-US/docs/Web/CSS/cursor)",
|
|
228099
|
-
"declarations": [
|
|
228100
|
-
{
|
|
228101
|
-
"name": "cursor",
|
|
228102
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
228103
|
-
}
|
|
228104
|
-
],
|
|
228105
|
-
"tags": {}
|
|
228106
|
-
},
|
|
228107
|
-
{
|
|
228108
|
-
"kind": "property",
|
|
228109
|
-
"name": "disabled",
|
|
228110
|
-
"required": false,
|
|
228111
|
-
"type": {
|
|
228112
|
-
"kind": "primitive",
|
|
228113
|
-
"value": "boolean"
|
|
228114
|
-
},
|
|
228115
|
-
"description": "",
|
|
228116
|
-
"declarations": [
|
|
228117
|
-
{
|
|
228118
|
-
"name": "disabled",
|
|
228119
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
228120
|
-
}
|
|
228121
|
-
],
|
|
228122
|
-
"tags": {}
|
|
228123
|
-
},
|
|
228124
228255
|
{
|
|
228125
228256
|
"kind": "property",
|
|
228126
228257
|
"name": "typeLevel",
|
|
@@ -228154,61 +228285,82 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228154
228285
|
},
|
|
228155
228286
|
{
|
|
228156
228287
|
"kind": "string",
|
|
228157
|
-
"value": "
|
|
228288
|
+
"value": "subtext.medium"
|
|
228158
228289
|
},
|
|
228159
228290
|
{
|
|
228160
228291
|
"kind": "string",
|
|
228161
|
-
"value": "
|
|
228292
|
+
"value": "subtext.large"
|
|
228162
228293
|
},
|
|
228163
228294
|
{
|
|
228164
228295
|
"kind": "string",
|
|
228165
|
-
"value": "
|
|
228296
|
+
"value": "subtext.small"
|
|
228166
228297
|
},
|
|
228167
228298
|
{
|
|
228168
228299
|
"kind": "string",
|
|
228169
|
-
"value": "
|
|
228300
|
+
"value": "heading.medium"
|
|
228170
228301
|
},
|
|
228171
228302
|
{
|
|
228172
228303
|
"kind": "string",
|
|
228173
|
-
"value": "
|
|
228304
|
+
"value": "heading.large"
|
|
228174
228305
|
},
|
|
228175
228306
|
{
|
|
228176
228307
|
"kind": "string",
|
|
228177
|
-
"value": "
|
|
228308
|
+
"value": "heading.small"
|
|
228178
228309
|
}
|
|
228179
228310
|
]
|
|
228180
228311
|
},
|
|
228181
|
-
"description": "
|
|
228312
|
+
"description": "",
|
|
228182
228313
|
"declarations": [
|
|
228183
228314
|
{
|
|
228184
228315
|
"name": "typeLevel",
|
|
228185
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/
|
|
228316
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
228186
228317
|
}
|
|
228187
228318
|
],
|
|
228188
|
-
"tags": {}
|
|
228189
|
-
"defaultValue": {
|
|
228190
|
-
"kind": "string",
|
|
228191
|
-
"value": "subtext.large"
|
|
228192
|
-
}
|
|
228319
|
+
"tags": {}
|
|
228193
228320
|
},
|
|
228194
228321
|
{
|
|
228195
228322
|
"kind": "property",
|
|
228196
|
-
"name": "
|
|
228323
|
+
"name": "disabled",
|
|
228197
228324
|
"required": false,
|
|
228198
228325
|
"type": {
|
|
228199
|
-
"kind": "
|
|
228200
|
-
"
|
|
228201
|
-
|
|
228202
|
-
|
|
228203
|
-
|
|
228204
|
-
|
|
228326
|
+
"kind": "primitive",
|
|
228327
|
+
"value": "boolean"
|
|
228328
|
+
},
|
|
228329
|
+
"description": "Disabled state as a boolean\n\n```tsx\n<LabelText disabled={true}>Error text</LabelText>\n```",
|
|
228330
|
+
"declarations": [
|
|
228331
|
+
{
|
|
228332
|
+
"name": "disabled",
|
|
228333
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
228205
228334
|
}
|
|
228335
|
+
],
|
|
228336
|
+
"tags": {}
|
|
228337
|
+
},
|
|
228338
|
+
{
|
|
228339
|
+
"kind": "property",
|
|
228340
|
+
"name": "variant",
|
|
228341
|
+
"required": false,
|
|
228342
|
+
"type": {
|
|
228343
|
+
"kind": "union",
|
|
228344
|
+
"value": [
|
|
228345
|
+
{
|
|
228346
|
+
"kind": "string",
|
|
228347
|
+
"value": "error"
|
|
228348
|
+
},
|
|
228349
|
+
{
|
|
228350
|
+
"kind": "string",
|
|
228351
|
+
"value": "hint"
|
|
228352
|
+
},
|
|
228353
|
+
{
|
|
228354
|
+
"kind": "string",
|
|
228355
|
+
"value": "inverse"
|
|
228356
|
+
}
|
|
228357
|
+
]
|
|
228206
228358
|
},
|
|
228207
|
-
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<
|
|
228359
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<LabelText variant=\"error\">Error text</LabelText>\n```",
|
|
228208
228360
|
"declarations": [
|
|
228209
228361
|
{
|
|
228210
228362
|
"name": "variant",
|
|
228211
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/
|
|
228363
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/LabelText.tsx"
|
|
228212
228364
|
}
|
|
228213
228365
|
],
|
|
228214
228366
|
"tags": {}
|
|
@@ -228321,7 +228473,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228321
228473
|
{
|
|
228322
228474
|
"name": "Text",
|
|
228323
228475
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
228324
|
-
"description": "This is a generic base component intended to render any text
|
|
228476
|
+
"description": "This is a generic base component intended to render any text.\nIt has `typeLevel` and `variant` style props that simplify navigating\nour type hierarchy and using [Canvas type tokens](https://canvas.workday.com/tokens/type#type-styles).\nBy default, it renders a semantic `span` element,\nbut you can adjust this as needed with the `as` prop.\n\nThe type hierarchy is organized into four levels, which correspond to our [Canvas type\nlevels](https://canvas.workday.com/tokens/type#type-styles).\n\n- `title`: Intended to be used for large page titles.\n- `heading`: Intended to be used for headings and large text.\n- `body`: Intended to be used for standard body text.\n- `subtext`: Intended to be used for small subtext content or in tight spaces.\n\nEach level has three sizes: `large`, `medium`, and `small`.\n\nYou can provide any level and size to the `typeLevel` prop, and it will apply the correct styles\naccordingly. In the example below we're providing the `subtext` level and `small` size to the\ncomponent with the value `subtext.small`.\n\n```tsx\nimport { Text } from '@workday/canvas-kit-react/text';\n\nconst CustomErrorText = () => (\n <Text typeLevel=\"subtext.small\" variant=\"error\">\n Error Text\n </Text>\n);\n```",
|
|
228325
228477
|
"declarations": [
|
|
228326
228478
|
{
|
|
228327
228479
|
"name": "Text",
|
|
@@ -228367,27 +228519,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228367
228519
|
},
|
|
228368
228520
|
{
|
|
228369
228521
|
"kind": "string",
|
|
228370
|
-
"value": "
|
|
228522
|
+
"value": "subtext.medium"
|
|
228371
228523
|
},
|
|
228372
228524
|
{
|
|
228373
228525
|
"kind": "string",
|
|
228374
|
-
"value": "
|
|
228526
|
+
"value": "subtext.large"
|
|
228375
228527
|
},
|
|
228376
228528
|
{
|
|
228377
228529
|
"kind": "string",
|
|
228378
|
-
"value": "
|
|
228530
|
+
"value": "subtext.small"
|
|
228379
228531
|
},
|
|
228380
228532
|
{
|
|
228381
228533
|
"kind": "string",
|
|
228382
|
-
"value": "
|
|
228534
|
+
"value": "heading.medium"
|
|
228383
228535
|
},
|
|
228384
228536
|
{
|
|
228385
228537
|
"kind": "string",
|
|
228386
|
-
"value": "
|
|
228538
|
+
"value": "heading.large"
|
|
228387
228539
|
},
|
|
228388
228540
|
{
|
|
228389
228541
|
"kind": "string",
|
|
228390
|
-
"value": "
|
|
228542
|
+
"value": "heading.small"
|
|
228391
228543
|
}
|
|
228392
228544
|
]
|
|
228393
228545
|
},
|
|
@@ -228405,13 +228557,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228405
228557
|
"name": "variant",
|
|
228406
228558
|
"required": false,
|
|
228407
228559
|
"type": {
|
|
228408
|
-
"kind": "
|
|
228409
|
-
"
|
|
228410
|
-
|
|
228411
|
-
|
|
228412
|
-
|
|
228413
|
-
|
|
228414
|
-
|
|
228560
|
+
"kind": "union",
|
|
228561
|
+
"value": [
|
|
228562
|
+
{
|
|
228563
|
+
"kind": "string",
|
|
228564
|
+
"value": "error"
|
|
228565
|
+
},
|
|
228566
|
+
{
|
|
228567
|
+
"kind": "string",
|
|
228568
|
+
"value": "hint"
|
|
228569
|
+
},
|
|
228570
|
+
{
|
|
228571
|
+
"kind": "string",
|
|
228572
|
+
"value": "inverse"
|
|
228573
|
+
}
|
|
228574
|
+
]
|
|
228415
228575
|
},
|
|
228416
228576
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
228417
228577
|
"declarations": [
|
|
@@ -228530,21 +228690,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228530
228690
|
"name": "size",
|
|
228531
228691
|
"required": true,
|
|
228532
228692
|
"type": {
|
|
228533
|
-
"kind": "
|
|
228534
|
-
"
|
|
228535
|
-
|
|
228536
|
-
"kind": "string",
|
|
228537
|
-
"value": "large"
|
|
228538
|
-
},
|
|
228539
|
-
{
|
|
228540
|
-
"kind": "string",
|
|
228541
|
-
"value": "medium"
|
|
228542
|
-
},
|
|
228543
|
-
{
|
|
228544
|
-
"kind": "string",
|
|
228545
|
-
"value": "small"
|
|
228546
|
-
}
|
|
228547
|
-
]
|
|
228693
|
+
"kind": "symbol",
|
|
228694
|
+
"name": "Size",
|
|
228695
|
+
"value": "Size"
|
|
228548
228696
|
},
|
|
228549
228697
|
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
228550
228698
|
"declarations": [
|
|
@@ -228560,13 +228708,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
228560
228708
|
"name": "variant",
|
|
228561
228709
|
"required": false,
|
|
228562
228710
|
"type": {
|
|
228563
|
-
"kind": "
|
|
228564
|
-
"
|
|
228565
|
-
|
|
228566
|
-
|
|
228567
|
-
|
|
228568
|
-
|
|
228569
|
-
|
|
228711
|
+
"kind": "union",
|
|
228712
|
+
"value": [
|
|
228713
|
+
{
|
|
228714
|
+
"kind": "string",
|
|
228715
|
+
"value": "error"
|
|
228716
|
+
},
|
|
228717
|
+
{
|
|
228718
|
+
"kind": "string",
|
|
228719
|
+
"value": "hint"
|
|
228720
|
+
},
|
|
228721
|
+
{
|
|
228722
|
+
"kind": "string",
|
|
228723
|
+
"value": "inverse"
|
|
228724
|
+
}
|
|
228725
|
+
]
|
|
228570
228726
|
},
|
|
228571
228727
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
228572
228728
|
"declarations": [
|
|
@@ -233074,21 +233230,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
233074
233230
|
"name": "size",
|
|
233075
233231
|
"required": true,
|
|
233076
233232
|
"type": {
|
|
233077
|
-
"kind": "
|
|
233078
|
-
"
|
|
233079
|
-
|
|
233080
|
-
"kind": "string",
|
|
233081
|
-
"value": "large"
|
|
233082
|
-
},
|
|
233083
|
-
{
|
|
233084
|
-
"kind": "string",
|
|
233085
|
-
"value": "medium"
|
|
233086
|
-
},
|
|
233087
|
-
{
|
|
233088
|
-
"kind": "string",
|
|
233089
|
-
"value": "small"
|
|
233090
|
-
}
|
|
233091
|
-
]
|
|
233233
|
+
"kind": "symbol",
|
|
233234
|
+
"name": "Size",
|
|
233235
|
+
"value": "Size"
|
|
233092
233236
|
},
|
|
233093
233237
|
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
233094
233238
|
"declarations": [
|
|
@@ -233104,13 +233248,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
233104
233248
|
"name": "variant",
|
|
233105
233249
|
"required": false,
|
|
233106
233250
|
"type": {
|
|
233107
|
-
"kind": "
|
|
233108
|
-
"
|
|
233109
|
-
|
|
233110
|
-
|
|
233111
|
-
|
|
233112
|
-
|
|
233113
|
-
|
|
233251
|
+
"kind": "union",
|
|
233252
|
+
"value": [
|
|
233253
|
+
{
|
|
233254
|
+
"kind": "string",
|
|
233255
|
+
"value": "error"
|
|
233256
|
+
},
|
|
233257
|
+
{
|
|
233258
|
+
"kind": "string",
|
|
233259
|
+
"value": "hint"
|
|
233260
|
+
},
|
|
233261
|
+
{
|
|
233262
|
+
"kind": "string",
|
|
233263
|
+
"value": "inverse"
|
|
233264
|
+
}
|
|
233265
|
+
]
|
|
233114
233266
|
},
|
|
233115
233267
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
233116
233268
|
"declarations": [
|
|
@@ -233231,21 +233383,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
233231
233383
|
"name": "size",
|
|
233232
233384
|
"required": true,
|
|
233233
233385
|
"type": {
|
|
233234
|
-
"kind": "
|
|
233235
|
-
"
|
|
233236
|
-
|
|
233237
|
-
"kind": "string",
|
|
233238
|
-
"value": "large"
|
|
233239
|
-
},
|
|
233240
|
-
{
|
|
233241
|
-
"kind": "string",
|
|
233242
|
-
"value": "medium"
|
|
233243
|
-
},
|
|
233244
|
-
{
|
|
233245
|
-
"kind": "string",
|
|
233246
|
-
"value": "small"
|
|
233247
|
-
}
|
|
233248
|
-
]
|
|
233386
|
+
"kind": "symbol",
|
|
233387
|
+
"name": "Size",
|
|
233388
|
+
"value": "Size"
|
|
233249
233389
|
},
|
|
233250
233390
|
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
233251
233391
|
"declarations": [
|
|
@@ -233261,13 +233401,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
233261
233401
|
"name": "variant",
|
|
233262
233402
|
"required": false,
|
|
233263
233403
|
"type": {
|
|
233264
|
-
"kind": "
|
|
233265
|
-
"
|
|
233266
|
-
|
|
233267
|
-
|
|
233268
|
-
|
|
233269
|
-
|
|
233270
|
-
|
|
233404
|
+
"kind": "union",
|
|
233405
|
+
"value": [
|
|
233406
|
+
{
|
|
233407
|
+
"kind": "string",
|
|
233408
|
+
"value": "error"
|
|
233409
|
+
},
|
|
233410
|
+
{
|
|
233411
|
+
"kind": "string",
|
|
233412
|
+
"value": "hint"
|
|
233413
|
+
},
|
|
233414
|
+
{
|
|
233415
|
+
"kind": "string",
|
|
233416
|
+
"value": "inverse"
|
|
233417
|
+
}
|
|
233418
|
+
]
|
|
233271
233419
|
},
|
|
233272
233420
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
233273
233421
|
"declarations": [
|
|
@@ -233387,22 +233535,163 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
233387
233535
|
"kind": "property",
|
|
233388
233536
|
"name": "size",
|
|
233389
233537
|
"required": true,
|
|
233538
|
+
"type": {
|
|
233539
|
+
"kind": "symbol",
|
|
233540
|
+
"name": "Size",
|
|
233541
|
+
"value": "Size"
|
|
233542
|
+
},
|
|
233543
|
+
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
233544
|
+
"declarations": [
|
|
233545
|
+
{
|
|
233546
|
+
"name": "size",
|
|
233547
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
|
|
233548
|
+
}
|
|
233549
|
+
],
|
|
233550
|
+
"tags": {}
|
|
233551
|
+
},
|
|
233552
|
+
{
|
|
233553
|
+
"kind": "property",
|
|
233554
|
+
"name": "variant",
|
|
233555
|
+
"required": false,
|
|
233390
233556
|
"type": {
|
|
233391
233557
|
"kind": "union",
|
|
233392
233558
|
"value": [
|
|
233393
233559
|
{
|
|
233394
233560
|
"kind": "string",
|
|
233395
|
-
"value": "
|
|
233561
|
+
"value": "error"
|
|
233396
233562
|
},
|
|
233397
233563
|
{
|
|
233398
233564
|
"kind": "string",
|
|
233399
|
-
"value": "
|
|
233565
|
+
"value": "hint"
|
|
233400
233566
|
},
|
|
233401
233567
|
{
|
|
233402
233568
|
"kind": "string",
|
|
233403
|
-
"value": "
|
|
233569
|
+
"value": "inverse"
|
|
233570
|
+
}
|
|
233571
|
+
]
|
|
233572
|
+
},
|
|
233573
|
+
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
233574
|
+
"declarations": [
|
|
233575
|
+
{
|
|
233576
|
+
"name": "variant",
|
|
233577
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
|
|
233578
|
+
}
|
|
233579
|
+
],
|
|
233580
|
+
"tags": {}
|
|
233581
|
+
},
|
|
233582
|
+
{
|
|
233583
|
+
"kind": "property",
|
|
233584
|
+
"name": "cs",
|
|
233585
|
+
"required": false,
|
|
233586
|
+
"type": {
|
|
233587
|
+
"kind": "symbol",
|
|
233588
|
+
"name": "CSToPropsInput",
|
|
233589
|
+
"value": "CSToPropsInput"
|
|
233590
|
+
},
|
|
233591
|
+
"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```",
|
|
233592
|
+
"declarations": [
|
|
233593
|
+
{
|
|
233594
|
+
"name": "cs",
|
|
233595
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
233596
|
+
}
|
|
233597
|
+
],
|
|
233598
|
+
"tags": {}
|
|
233599
|
+
},
|
|
233600
|
+
{
|
|
233601
|
+
"kind": "property",
|
|
233602
|
+
"name": "children",
|
|
233603
|
+
"required": false,
|
|
233604
|
+
"type": {
|
|
233605
|
+
"kind": "external",
|
|
233606
|
+
"name": "ReactNode",
|
|
233607
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
233608
|
+
},
|
|
233609
|
+
"description": "",
|
|
233610
|
+
"declarations": [
|
|
233611
|
+
{
|
|
233612
|
+
"name": "children",
|
|
233613
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
233614
|
+
}
|
|
233615
|
+
],
|
|
233616
|
+
"tags": {}
|
|
233617
|
+
},
|
|
233618
|
+
{
|
|
233619
|
+
"kind": "property",
|
|
233620
|
+
"name": "as",
|
|
233621
|
+
"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.",
|
|
233622
|
+
"tags": {},
|
|
233623
|
+
"declarations": [],
|
|
233624
|
+
"type": {
|
|
233625
|
+
"kind": "external",
|
|
233626
|
+
"name": "React.ElementType",
|
|
233627
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
233628
|
+
},
|
|
233629
|
+
"defaultValue": {
|
|
233630
|
+
"kind": "external",
|
|
233631
|
+
"name": "h2",
|
|
233632
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h2"
|
|
233633
|
+
}
|
|
233634
|
+
},
|
|
233635
|
+
{
|
|
233636
|
+
"kind": "property",
|
|
233637
|
+
"name": "ref",
|
|
233638
|
+
"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`).",
|
|
233639
|
+
"tags": {},
|
|
233640
|
+
"declarations": [],
|
|
233641
|
+
"type": {
|
|
233642
|
+
"kind": "external",
|
|
233643
|
+
"name": "React.Ref",
|
|
233644
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
233645
|
+
"typeParameters": [
|
|
233646
|
+
{
|
|
233647
|
+
"kind": "typeParameter",
|
|
233648
|
+
"name": "R",
|
|
233649
|
+
"required": true,
|
|
233650
|
+
"defaultValue": {
|
|
233651
|
+
"kind": "external",
|
|
233652
|
+
"name": "h2",
|
|
233653
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h2"
|
|
233654
|
+
}
|
|
233404
233655
|
}
|
|
233405
233656
|
]
|
|
233657
|
+
}
|
|
233658
|
+
}
|
|
233659
|
+
],
|
|
233660
|
+
"baseElement": {
|
|
233661
|
+
"kind": "external",
|
|
233662
|
+
"name": "h2",
|
|
233663
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h2"
|
|
233664
|
+
},
|
|
233665
|
+
"styleComponent": {
|
|
233666
|
+
"kind": "symbol",
|
|
233667
|
+
"name": "Box"
|
|
233668
|
+
}
|
|
233669
|
+
}
|
|
233670
|
+
},
|
|
233671
|
+
{
|
|
233672
|
+
"name": "Title",
|
|
233673
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx",
|
|
233674
|
+
"description": "This component is intended to be used large page titles.\nBy default, it renders a semantic `h1` element, but you can adjust this as needed with the `as` prop.\nIt has three sizes: large, medium, and small.\nHere's a quick reference for font-sizes and weights:\n\n- `large`\n - font-size: 56px (3/5rem)\n - font-weight: bold (700)\n- `medium`\n - font-size: 48px (3rem)\n - font-weight: bold (700)\n- `small`\n - font-size: 40px (2.5rem)\n - font-weight: bold (700)\n\n```tsx\nimport { Title } from '@workday/canvas-kit-react/text';\n\nconst CustomTitle = () => (\n <Title size=\"small\">Title Text</Title>\n);\n```",
|
|
233675
|
+
"declarations": [
|
|
233676
|
+
{
|
|
233677
|
+
"name": "Title",
|
|
233678
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
|
|
233679
|
+
}
|
|
233680
|
+
],
|
|
233681
|
+
"tags": {},
|
|
233682
|
+
"type": {
|
|
233683
|
+
"kind": "enhancedComponent",
|
|
233684
|
+
"componentType": "regular",
|
|
233685
|
+
"displayName": "Title",
|
|
233686
|
+
"props": [
|
|
233687
|
+
{
|
|
233688
|
+
"kind": "property",
|
|
233689
|
+
"name": "size",
|
|
233690
|
+
"required": true,
|
|
233691
|
+
"type": {
|
|
233692
|
+
"kind": "symbol",
|
|
233693
|
+
"name": "Size",
|
|
233694
|
+
"value": "Size"
|
|
233406
233695
|
},
|
|
233407
233696
|
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
233408
233697
|
"declarations": [
|
|
@@ -233418,170 +233707,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
233418
233707
|
"name": "variant",
|
|
233419
233708
|
"required": false,
|
|
233420
233709
|
"type": {
|
|
233421
|
-
"kind": "
|
|
233422
|
-
"
|
|
233423
|
-
|
|
233424
|
-
|
|
233425
|
-
|
|
233426
|
-
|
|
233427
|
-
|
|
233428
|
-
|
|
233429
|
-
|
|
233430
|
-
|
|
233431
|
-
|
|
233432
|
-
|
|
233433
|
-
|
|
233434
|
-
|
|
233435
|
-
|
|
233436
|
-
"tags": {}
|
|
233437
|
-
},
|
|
233438
|
-
{
|
|
233439
|
-
"kind": "property",
|
|
233440
|
-
"name": "cs",
|
|
233441
|
-
"required": false,
|
|
233442
|
-
"type": {
|
|
233443
|
-
"kind": "symbol",
|
|
233444
|
-
"name": "CSToPropsInput",
|
|
233445
|
-
"value": "CSToPropsInput"
|
|
233446
|
-
},
|
|
233447
|
-
"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```",
|
|
233448
|
-
"declarations": [
|
|
233449
|
-
{
|
|
233450
|
-
"name": "cs",
|
|
233451
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
233452
|
-
}
|
|
233453
|
-
],
|
|
233454
|
-
"tags": {}
|
|
233455
|
-
},
|
|
233456
|
-
{
|
|
233457
|
-
"kind": "property",
|
|
233458
|
-
"name": "children",
|
|
233459
|
-
"required": false,
|
|
233460
|
-
"type": {
|
|
233461
|
-
"kind": "external",
|
|
233462
|
-
"name": "ReactNode",
|
|
233463
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
233464
|
-
},
|
|
233465
|
-
"description": "",
|
|
233466
|
-
"declarations": [
|
|
233467
|
-
{
|
|
233468
|
-
"name": "children",
|
|
233469
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
233470
|
-
}
|
|
233471
|
-
],
|
|
233472
|
-
"tags": {}
|
|
233473
|
-
},
|
|
233474
|
-
{
|
|
233475
|
-
"kind": "property",
|
|
233476
|
-
"name": "as",
|
|
233477
|
-
"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.",
|
|
233478
|
-
"tags": {},
|
|
233479
|
-
"declarations": [],
|
|
233480
|
-
"type": {
|
|
233481
|
-
"kind": "external",
|
|
233482
|
-
"name": "React.ElementType",
|
|
233483
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
233484
|
-
},
|
|
233485
|
-
"defaultValue": {
|
|
233486
|
-
"kind": "external",
|
|
233487
|
-
"name": "h2",
|
|
233488
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h2"
|
|
233489
|
-
}
|
|
233490
|
-
},
|
|
233491
|
-
{
|
|
233492
|
-
"kind": "property",
|
|
233493
|
-
"name": "ref",
|
|
233494
|
-
"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`).",
|
|
233495
|
-
"tags": {},
|
|
233496
|
-
"declarations": [],
|
|
233497
|
-
"type": {
|
|
233498
|
-
"kind": "external",
|
|
233499
|
-
"name": "React.Ref",
|
|
233500
|
-
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
233501
|
-
"typeParameters": [
|
|
233502
|
-
{
|
|
233503
|
-
"kind": "typeParameter",
|
|
233504
|
-
"name": "R",
|
|
233505
|
-
"required": true,
|
|
233506
|
-
"defaultValue": {
|
|
233507
|
-
"kind": "external",
|
|
233508
|
-
"name": "h2",
|
|
233509
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h2"
|
|
233510
|
-
}
|
|
233511
|
-
}
|
|
233512
|
-
]
|
|
233513
|
-
}
|
|
233514
|
-
}
|
|
233515
|
-
],
|
|
233516
|
-
"baseElement": {
|
|
233517
|
-
"kind": "external",
|
|
233518
|
-
"name": "h2",
|
|
233519
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/h2"
|
|
233520
|
-
},
|
|
233521
|
-
"styleComponent": {
|
|
233522
|
-
"kind": "symbol",
|
|
233523
|
-
"name": "Box"
|
|
233524
|
-
}
|
|
233525
|
-
}
|
|
233526
|
-
},
|
|
233527
|
-
{
|
|
233528
|
-
"name": "Title",
|
|
233529
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx",
|
|
233530
|
-
"description": "This component is intended to be used large page titles.\nBy default, it renders a semantic `h1` element, but you can adjust this as needed with the `as` prop.\nIt has three sizes: large, medium, and small.\nHere's a quick reference for font-sizes and weights:\n\n- `large`\n - font-size: 56px (3/5rem)\n - font-weight: bold (700)\n- `medium`\n - font-size: 48px (3rem)\n - font-weight: bold (700)\n- `small`\n - font-size: 40px (2.5rem)\n - font-weight: bold (700)\n\n```tsx\nimport { Title } from '@workday/canvas-kit-react/text';\n\nconst CustomTitle = () => (\n <Title size=\"small\">Title Text</Title>\n);\n```",
|
|
233531
|
-
"declarations": [
|
|
233532
|
-
{
|
|
233533
|
-
"name": "Title",
|
|
233534
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
|
|
233535
|
-
}
|
|
233536
|
-
],
|
|
233537
|
-
"tags": {},
|
|
233538
|
-
"type": {
|
|
233539
|
-
"kind": "enhancedComponent",
|
|
233540
|
-
"componentType": "regular",
|
|
233541
|
-
"displayName": "Title",
|
|
233542
|
-
"props": [
|
|
233543
|
-
{
|
|
233544
|
-
"kind": "property",
|
|
233545
|
-
"name": "size",
|
|
233546
|
-
"required": true,
|
|
233547
|
-
"type": {
|
|
233548
|
-
"kind": "union",
|
|
233549
|
-
"value": [
|
|
233550
|
-
{
|
|
233551
|
-
"kind": "string",
|
|
233552
|
-
"value": "large"
|
|
233553
|
-
},
|
|
233554
|
-
{
|
|
233555
|
-
"kind": "string",
|
|
233556
|
-
"value": "medium"
|
|
233557
|
-
},
|
|
233558
|
-
{
|
|
233559
|
-
"kind": "string",
|
|
233560
|
-
"value": "small"
|
|
233561
|
-
}
|
|
233562
|
-
]
|
|
233563
|
-
},
|
|
233564
|
-
"description": "Each type level has three sizes: `large`, `medium`, and `small`.",
|
|
233565
|
-
"declarations": [
|
|
233566
|
-
{
|
|
233567
|
-
"name": "size",
|
|
233568
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
|
|
233569
|
-
}
|
|
233570
|
-
],
|
|
233571
|
-
"tags": {}
|
|
233572
|
-
},
|
|
233573
|
-
{
|
|
233574
|
-
"kind": "property",
|
|
233575
|
-
"name": "variant",
|
|
233576
|
-
"required": false,
|
|
233577
|
-
"type": {
|
|
233578
|
-
"kind": "keyof",
|
|
233579
|
-
"name": {
|
|
233580
|
-
"kind": "symbol",
|
|
233581
|
-
"name": "CanvasTypeVariants",
|
|
233582
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx",
|
|
233583
|
-
"value": "keyof CanvasTypeVariants"
|
|
233584
|
-
}
|
|
233710
|
+
"kind": "union",
|
|
233711
|
+
"value": [
|
|
233712
|
+
{
|
|
233713
|
+
"kind": "string",
|
|
233714
|
+
"value": "error"
|
|
233715
|
+
},
|
|
233716
|
+
{
|
|
233717
|
+
"kind": "string",
|
|
233718
|
+
"value": "hint"
|
|
233719
|
+
},
|
|
233720
|
+
{
|
|
233721
|
+
"kind": "string",
|
|
233722
|
+
"value": "inverse"
|
|
233723
|
+
}
|
|
233724
|
+
]
|
|
233585
233725
|
},
|
|
233586
233726
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
233587
233727
|
"declarations": [
|
|
@@ -234260,6 +234400,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
234260
234400
|
],
|
|
234261
234401
|
"tags": {}
|
|
234262
234402
|
},
|
|
234403
|
+
{
|
|
234404
|
+
"kind": "property",
|
|
234405
|
+
"name": "children",
|
|
234406
|
+
"required": false,
|
|
234407
|
+
"type": {
|
|
234408
|
+
"kind": "external",
|
|
234409
|
+
"name": "ReactNode",
|
|
234410
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
234411
|
+
},
|
|
234412
|
+
"description": "",
|
|
234413
|
+
"declarations": [
|
|
234414
|
+
{
|
|
234415
|
+
"name": "children",
|
|
234416
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
234417
|
+
}
|
|
234418
|
+
],
|
|
234419
|
+
"tags": {}
|
|
234420
|
+
},
|
|
234263
234421
|
{
|
|
234264
234422
|
"kind": "property",
|
|
234265
234423
|
"name": "model",
|
|
@@ -234380,18 +234538,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
234380
234538
|
],
|
|
234381
234539
|
"tags": {}
|
|
234382
234540
|
},
|
|
234383
|
-
{
|
|
234384
|
-
"kind": "property",
|
|
234385
|
-
"name": "children",
|
|
234386
|
-
"description": "",
|
|
234387
|
-
"tags": {},
|
|
234388
|
-
"declarations": [],
|
|
234389
|
-
"type": {
|
|
234390
|
-
"kind": "external",
|
|
234391
|
-
"name": "React.ReactNode",
|
|
234392
|
-
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
234393
|
-
}
|
|
234394
|
-
},
|
|
234395
234541
|
{
|
|
234396
234542
|
"kind": "property",
|
|
234397
234543
|
"name": "as",
|
|
@@ -235594,13 +235740,21 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
235594
235740
|
"name": "variant",
|
|
235595
235741
|
"required": false,
|
|
235596
235742
|
"type": {
|
|
235597
|
-
"kind": "
|
|
235598
|
-
"
|
|
235599
|
-
|
|
235600
|
-
|
|
235601
|
-
|
|
235602
|
-
|
|
235603
|
-
|
|
235743
|
+
"kind": "union",
|
|
235744
|
+
"value": [
|
|
235745
|
+
{
|
|
235746
|
+
"kind": "string",
|
|
235747
|
+
"value": "error"
|
|
235748
|
+
},
|
|
235749
|
+
{
|
|
235750
|
+
"kind": "string",
|
|
235751
|
+
"value": "hint"
|
|
235752
|
+
},
|
|
235753
|
+
{
|
|
235754
|
+
"kind": "string",
|
|
235755
|
+
"value": "inverse"
|
|
235756
|
+
}
|
|
235757
|
+
]
|
|
235604
235758
|
},
|
|
235605
235759
|
"description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
|
|
235606
235760
|
"declarations": [
|
|
@@ -244067,15 +244221,15 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
244067
244221
|
"value": [
|
|
244068
244222
|
{
|
|
244069
244223
|
"kind": "string",
|
|
244070
|
-
"value": "
|
|
244224
|
+
"value": "0.75rem"
|
|
244071
244225
|
},
|
|
244072
244226
|
{
|
|
244073
244227
|
"kind": "string",
|
|
244074
|
-
"value": "
|
|
244228
|
+
"value": "0"
|
|
244075
244229
|
},
|
|
244076
244230
|
{
|
|
244077
244231
|
"kind": "string",
|
|
244078
|
-
"value": "
|
|
244232
|
+
"value": "0.5rem"
|
|
244079
244233
|
},
|
|
244080
244234
|
{
|
|
244081
244235
|
"kind": "string",
|
|
@@ -244083,27 +244237,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
244083
244237
|
},
|
|
244084
244238
|
{
|
|
244085
244239
|
"kind": "string",
|
|
244086
|
-
"value": "
|
|
244240
|
+
"value": "2rem"
|
|
244087
244241
|
},
|
|
244088
244242
|
{
|
|
244089
244243
|
"kind": "string",
|
|
244090
|
-
"value": "
|
|
244244
|
+
"value": "1.5rem"
|
|
244091
244245
|
},
|
|
244092
244246
|
{
|
|
244093
244247
|
"kind": "string",
|
|
244094
|
-
"value": "0.
|
|
244248
|
+
"value": "0.25rem"
|
|
244095
244249
|
},
|
|
244096
244250
|
{
|
|
244097
244251
|
"kind": "string",
|
|
244098
|
-
"value": "
|
|
244252
|
+
"value": "1rem"
|
|
244099
244253
|
},
|
|
244100
244254
|
{
|
|
244101
244255
|
"kind": "string",
|
|
244102
|
-
"value": "
|
|
244256
|
+
"value": "4rem"
|
|
244103
244257
|
},
|
|
244104
244258
|
{
|
|
244105
244259
|
"kind": "string",
|
|
244106
|
-
"value": "
|
|
244260
|
+
"value": "5rem"
|
|
244107
244261
|
}
|
|
244108
244262
|
]
|
|
244109
244263
|
}
|
|
@@ -244769,27 +244923,27 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
244769
244923
|
"value": [
|
|
244770
244924
|
{
|
|
244771
244925
|
"kind": "string",
|
|
244772
|
-
"value": "
|
|
244926
|
+
"value": "0.875rem"
|
|
244773
244927
|
},
|
|
244774
244928
|
{
|
|
244775
244929
|
"kind": "string",
|
|
244776
|
-
"value": "
|
|
244930
|
+
"value": "0.75rem"
|
|
244777
244931
|
},
|
|
244778
244932
|
{
|
|
244779
244933
|
"kind": "string",
|
|
244780
|
-
"value": "
|
|
244934
|
+
"value": "2.5rem"
|
|
244781
244935
|
},
|
|
244782
244936
|
{
|
|
244783
244937
|
"kind": "string",
|
|
244784
|
-
"value": "
|
|
244938
|
+
"value": "2rem"
|
|
244785
244939
|
},
|
|
244786
244940
|
{
|
|
244787
244941
|
"kind": "string",
|
|
244788
|
-
"value": "
|
|
244942
|
+
"value": "1.5rem"
|
|
244789
244943
|
},
|
|
244790
244944
|
{
|
|
244791
244945
|
"kind": "string",
|
|
244792
|
-
"value": "
|
|
244946
|
+
"value": "1rem"
|
|
244793
244947
|
},
|
|
244794
244948
|
{
|
|
244795
244949
|
"kind": "string",
|
|
@@ -248429,14 +248583,548 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248429
248583
|
}
|
|
248430
248584
|
}
|
|
248431
248585
|
},
|
|
248586
|
+
{
|
|
248587
|
+
"name": "NestedStyleObject",
|
|
248588
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
248589
|
+
"description": "",
|
|
248590
|
+
"declarations": [
|
|
248591
|
+
{
|
|
248592
|
+
"name": "NestedStyleObject",
|
|
248593
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248594
|
+
}
|
|
248595
|
+
],
|
|
248596
|
+
"tags": {},
|
|
248597
|
+
"type": {
|
|
248598
|
+
"kind": "object",
|
|
248599
|
+
"properties": [],
|
|
248600
|
+
"indexSignature": {
|
|
248601
|
+
"kind": "indexSignature",
|
|
248602
|
+
"name": "key",
|
|
248603
|
+
"type": {
|
|
248604
|
+
"kind": "primitive",
|
|
248605
|
+
"value": "string"
|
|
248606
|
+
},
|
|
248607
|
+
"value": {
|
|
248608
|
+
"kind": "union",
|
|
248609
|
+
"value": [
|
|
248610
|
+
{
|
|
248611
|
+
"kind": "primitive",
|
|
248612
|
+
"value": "string"
|
|
248613
|
+
},
|
|
248614
|
+
{
|
|
248615
|
+
"kind": "symbol",
|
|
248616
|
+
"name": "NestedStyleObject",
|
|
248617
|
+
"value": "NestedStyleObject"
|
|
248618
|
+
}
|
|
248619
|
+
]
|
|
248620
|
+
}
|
|
248621
|
+
}
|
|
248622
|
+
}
|
|
248623
|
+
},
|
|
248624
|
+
{
|
|
248625
|
+
"name": "StyleTransformerOptions",
|
|
248626
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
248627
|
+
"description": "",
|
|
248628
|
+
"declarations": [
|
|
248629
|
+
{
|
|
248630
|
+
"name": "StyleTransformerOptions",
|
|
248631
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248632
|
+
}
|
|
248633
|
+
],
|
|
248634
|
+
"tags": {},
|
|
248635
|
+
"type": {
|
|
248636
|
+
"kind": "object",
|
|
248637
|
+
"properties": [
|
|
248638
|
+
{
|
|
248639
|
+
"kind": "property",
|
|
248640
|
+
"name": "prefix",
|
|
248641
|
+
"required": true,
|
|
248642
|
+
"type": {
|
|
248643
|
+
"kind": "primitive",
|
|
248644
|
+
"value": "string"
|
|
248645
|
+
},
|
|
248646
|
+
"description": "",
|
|
248647
|
+
"declarations": [
|
|
248648
|
+
{
|
|
248649
|
+
"name": "prefix",
|
|
248650
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248651
|
+
}
|
|
248652
|
+
],
|
|
248653
|
+
"tags": {}
|
|
248654
|
+
},
|
|
248655
|
+
{
|
|
248656
|
+
"kind": "property",
|
|
248657
|
+
"name": "variables",
|
|
248658
|
+
"required": true,
|
|
248659
|
+
"type": {
|
|
248660
|
+
"kind": "external",
|
|
248661
|
+
"name": "Record",
|
|
248662
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"
|
|
248663
|
+
},
|
|
248664
|
+
"description": "",
|
|
248665
|
+
"declarations": [
|
|
248666
|
+
{
|
|
248667
|
+
"name": "variables",
|
|
248668
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248669
|
+
}
|
|
248670
|
+
],
|
|
248671
|
+
"tags": {}
|
|
248672
|
+
},
|
|
248673
|
+
{
|
|
248674
|
+
"kind": "property",
|
|
248675
|
+
"name": "keyframes",
|
|
248676
|
+
"required": true,
|
|
248677
|
+
"type": {
|
|
248678
|
+
"kind": "external",
|
|
248679
|
+
"name": "Record",
|
|
248680
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"
|
|
248681
|
+
},
|
|
248682
|
+
"description": "",
|
|
248683
|
+
"declarations": [
|
|
248684
|
+
{
|
|
248685
|
+
"name": "keyframes",
|
|
248686
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248687
|
+
}
|
|
248688
|
+
],
|
|
248689
|
+
"tags": {}
|
|
248690
|
+
},
|
|
248691
|
+
{
|
|
248692
|
+
"kind": "property",
|
|
248693
|
+
"name": "fallbackFiles",
|
|
248694
|
+
"required": false,
|
|
248695
|
+
"type": {
|
|
248696
|
+
"kind": "array",
|
|
248697
|
+
"value": {
|
|
248698
|
+
"kind": "primitive",
|
|
248699
|
+
"value": "string"
|
|
248700
|
+
}
|
|
248701
|
+
},
|
|
248702
|
+
"description": "",
|
|
248703
|
+
"declarations": [
|
|
248704
|
+
{
|
|
248705
|
+
"name": "fallbackFiles",
|
|
248706
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248707
|
+
}
|
|
248708
|
+
],
|
|
248709
|
+
"tags": {}
|
|
248710
|
+
},
|
|
248711
|
+
{
|
|
248712
|
+
"kind": "property",
|
|
248713
|
+
"name": "transformers",
|
|
248714
|
+
"required": false,
|
|
248715
|
+
"type": {
|
|
248716
|
+
"kind": "array",
|
|
248717
|
+
"value": {
|
|
248718
|
+
"kind": "symbol",
|
|
248719
|
+
"name": "NodeTransformer",
|
|
248720
|
+
"value": "NodeTransformer"
|
|
248721
|
+
}
|
|
248722
|
+
},
|
|
248723
|
+
"description": "",
|
|
248724
|
+
"declarations": [
|
|
248725
|
+
{
|
|
248726
|
+
"name": "transformers",
|
|
248727
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248728
|
+
}
|
|
248729
|
+
],
|
|
248730
|
+
"tags": {}
|
|
248731
|
+
}
|
|
248732
|
+
]
|
|
248733
|
+
}
|
|
248734
|
+
},
|
|
248735
|
+
{
|
|
248736
|
+
"name": "_reset",
|
|
248737
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
248738
|
+
"description": "The reset is used in tests and should not be called normally.",
|
|
248739
|
+
"declarations": [
|
|
248740
|
+
{
|
|
248741
|
+
"name": "_reset",
|
|
248742
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248743
|
+
}
|
|
248744
|
+
],
|
|
248745
|
+
"tags": {},
|
|
248746
|
+
"type": {
|
|
248747
|
+
"kind": "function",
|
|
248748
|
+
"parameters": [],
|
|
248749
|
+
"members": [],
|
|
248750
|
+
"returnType": {
|
|
248751
|
+
"kind": "primitive",
|
|
248752
|
+
"value": "void"
|
|
248753
|
+
}
|
|
248754
|
+
}
|
|
248755
|
+
},
|
|
248756
|
+
{
|
|
248757
|
+
"name": "default",
|
|
248758
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
248759
|
+
"description": "",
|
|
248760
|
+
"declarations": [
|
|
248761
|
+
{
|
|
248762
|
+
"name": "default",
|
|
248763
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248764
|
+
}
|
|
248765
|
+
],
|
|
248766
|
+
"tags": {},
|
|
248767
|
+
"type": {
|
|
248768
|
+
"kind": "function",
|
|
248769
|
+
"parameters": [
|
|
248770
|
+
{
|
|
248771
|
+
"kind": "parameter",
|
|
248772
|
+
"name": "program",
|
|
248773
|
+
"type": {
|
|
248774
|
+
"kind": "symbol",
|
|
248775
|
+
"name": "ts.Program",
|
|
248776
|
+
"value": "Program"
|
|
248777
|
+
},
|
|
248778
|
+
"required": true,
|
|
248779
|
+
"rest": false,
|
|
248780
|
+
"description": "",
|
|
248781
|
+
"declarations": [
|
|
248782
|
+
{
|
|
248783
|
+
"name": "program",
|
|
248784
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248785
|
+
}
|
|
248786
|
+
],
|
|
248787
|
+
"tags": {}
|
|
248788
|
+
},
|
|
248789
|
+
{
|
|
248790
|
+
"kind": "parameter",
|
|
248791
|
+
"name": "__1",
|
|
248792
|
+
"defaultValue": {
|
|
248793
|
+
"kind": "object",
|
|
248794
|
+
"properties": [
|
|
248795
|
+
{
|
|
248796
|
+
"kind": "property",
|
|
248797
|
+
"name": "prefix",
|
|
248798
|
+
"defaultValue": {
|
|
248799
|
+
"kind": "string",
|
|
248800
|
+
"value": "css"
|
|
248801
|
+
},
|
|
248802
|
+
"type": {
|
|
248803
|
+
"kind": "primitive",
|
|
248804
|
+
"value": "string"
|
|
248805
|
+
},
|
|
248806
|
+
"required": true,
|
|
248807
|
+
"description": "",
|
|
248808
|
+
"declarations": [
|
|
248809
|
+
{
|
|
248810
|
+
"name": "prefix",
|
|
248811
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248812
|
+
}
|
|
248813
|
+
],
|
|
248814
|
+
"tags": {}
|
|
248815
|
+
},
|
|
248816
|
+
{
|
|
248817
|
+
"kind": "property",
|
|
248818
|
+
"name": "variables",
|
|
248819
|
+
"defaultValue": {
|
|
248820
|
+
"kind": "object",
|
|
248821
|
+
"properties": []
|
|
248822
|
+
},
|
|
248823
|
+
"type": {
|
|
248824
|
+
"kind": "object",
|
|
248825
|
+
"properties": []
|
|
248826
|
+
},
|
|
248827
|
+
"required": true,
|
|
248828
|
+
"description": "",
|
|
248829
|
+
"declarations": [
|
|
248830
|
+
{
|
|
248831
|
+
"name": "variables",
|
|
248832
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248833
|
+
}
|
|
248834
|
+
],
|
|
248835
|
+
"tags": {}
|
|
248836
|
+
},
|
|
248837
|
+
{
|
|
248838
|
+
"kind": "property",
|
|
248839
|
+
"name": "keyframes",
|
|
248840
|
+
"defaultValue": {
|
|
248841
|
+
"kind": "object",
|
|
248842
|
+
"properties": []
|
|
248843
|
+
},
|
|
248844
|
+
"type": {
|
|
248845
|
+
"kind": "object",
|
|
248846
|
+
"properties": []
|
|
248847
|
+
},
|
|
248848
|
+
"required": true,
|
|
248849
|
+
"description": "",
|
|
248850
|
+
"declarations": [
|
|
248851
|
+
{
|
|
248852
|
+
"name": "keyframes",
|
|
248853
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248854
|
+
}
|
|
248855
|
+
],
|
|
248856
|
+
"tags": {}
|
|
248857
|
+
},
|
|
248858
|
+
{
|
|
248859
|
+
"kind": "property",
|
|
248860
|
+
"name": "transformers",
|
|
248861
|
+
"defaultValue": {
|
|
248862
|
+
"kind": "unknown",
|
|
248863
|
+
"value": "unknown",
|
|
248864
|
+
"text": "defaultTransformers"
|
|
248865
|
+
},
|
|
248866
|
+
"type": {
|
|
248867
|
+
"kind": "array",
|
|
248868
|
+
"value": {
|
|
248869
|
+
"kind": "symbol",
|
|
248870
|
+
"name": "NodeTransformer",
|
|
248871
|
+
"value": "any"
|
|
248872
|
+
}
|
|
248873
|
+
},
|
|
248874
|
+
"required": true,
|
|
248875
|
+
"description": "",
|
|
248876
|
+
"declarations": [
|
|
248877
|
+
{
|
|
248878
|
+
"name": "transformers",
|
|
248879
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248880
|
+
}
|
|
248881
|
+
],
|
|
248882
|
+
"tags": {}
|
|
248883
|
+
}
|
|
248884
|
+
]
|
|
248885
|
+
},
|
|
248886
|
+
"type": {
|
|
248887
|
+
"kind": "symbol",
|
|
248888
|
+
"name": "Partial",
|
|
248889
|
+
"typeParameters": [
|
|
248890
|
+
{
|
|
248891
|
+
"kind": "symbol",
|
|
248892
|
+
"name": "StyleTransformerOptions",
|
|
248893
|
+
"value": "StyleTransformerOptions"
|
|
248894
|
+
}
|
|
248895
|
+
],
|
|
248896
|
+
"value": "Partial<T>"
|
|
248897
|
+
},
|
|
248898
|
+
"required": false,
|
|
248899
|
+
"rest": false,
|
|
248900
|
+
"description": "",
|
|
248901
|
+
"declarations": [
|
|
248902
|
+
{
|
|
248903
|
+
"name": "__1",
|
|
248904
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248905
|
+
}
|
|
248906
|
+
],
|
|
248907
|
+
"tags": {}
|
|
248908
|
+
}
|
|
248909
|
+
],
|
|
248910
|
+
"members": [],
|
|
248911
|
+
"returnType": {
|
|
248912
|
+
"kind": "symbol",
|
|
248913
|
+
"name": "ts.TransformerFactory",
|
|
248914
|
+
"typeParameters": [
|
|
248915
|
+
{
|
|
248916
|
+
"kind": "symbol",
|
|
248917
|
+
"name": "ts.SourceFile",
|
|
248918
|
+
"value": "SourceFile"
|
|
248919
|
+
}
|
|
248920
|
+
],
|
|
248921
|
+
"value": "TransformerFactory<T>"
|
|
248922
|
+
}
|
|
248923
|
+
}
|
|
248924
|
+
},
|
|
248925
|
+
{
|
|
248926
|
+
"name": "transform",
|
|
248927
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
248928
|
+
"description": "This function is useful for tests or a custom build. The `styleTransformer` function is used by\nthe https://www.npmjs.com/package/ttypescript package.",
|
|
248929
|
+
"declarations": [
|
|
248930
|
+
{
|
|
248931
|
+
"name": "transform",
|
|
248932
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248933
|
+
}
|
|
248934
|
+
],
|
|
248935
|
+
"tags": {},
|
|
248936
|
+
"type": {
|
|
248937
|
+
"kind": "function",
|
|
248938
|
+
"parameters": [
|
|
248939
|
+
{
|
|
248940
|
+
"kind": "parameter",
|
|
248941
|
+
"name": "program",
|
|
248942
|
+
"type": {
|
|
248943
|
+
"kind": "symbol",
|
|
248944
|
+
"name": "ts.Program",
|
|
248945
|
+
"value": "Program"
|
|
248946
|
+
},
|
|
248947
|
+
"required": true,
|
|
248948
|
+
"rest": false,
|
|
248949
|
+
"description": "",
|
|
248950
|
+
"declarations": [
|
|
248951
|
+
{
|
|
248952
|
+
"name": "program",
|
|
248953
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248954
|
+
}
|
|
248955
|
+
],
|
|
248956
|
+
"tags": {}
|
|
248957
|
+
},
|
|
248958
|
+
{
|
|
248959
|
+
"kind": "parameter",
|
|
248960
|
+
"name": "fileName",
|
|
248961
|
+
"type": {
|
|
248962
|
+
"kind": "primitive",
|
|
248963
|
+
"value": "string"
|
|
248964
|
+
},
|
|
248965
|
+
"required": true,
|
|
248966
|
+
"rest": false,
|
|
248967
|
+
"description": "",
|
|
248968
|
+
"declarations": [
|
|
248969
|
+
{
|
|
248970
|
+
"name": "fileName",
|
|
248971
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248972
|
+
}
|
|
248973
|
+
],
|
|
248974
|
+
"tags": {}
|
|
248975
|
+
},
|
|
248976
|
+
{
|
|
248977
|
+
"kind": "parameter",
|
|
248978
|
+
"name": "options",
|
|
248979
|
+
"type": {
|
|
248980
|
+
"kind": "symbol",
|
|
248981
|
+
"name": "Partial",
|
|
248982
|
+
"typeParameters": [
|
|
248983
|
+
{
|
|
248984
|
+
"kind": "symbol",
|
|
248985
|
+
"name": "StyleTransformerOptions",
|
|
248986
|
+
"value": "StyleTransformerOptions"
|
|
248987
|
+
}
|
|
248988
|
+
],
|
|
248989
|
+
"value": "Partial<T>"
|
|
248990
|
+
},
|
|
248991
|
+
"required": false,
|
|
248992
|
+
"rest": false,
|
|
248993
|
+
"description": "",
|
|
248994
|
+
"declarations": [
|
|
248995
|
+
{
|
|
248996
|
+
"name": "options",
|
|
248997
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248998
|
+
}
|
|
248999
|
+
],
|
|
249000
|
+
"tags": {}
|
|
249001
|
+
}
|
|
249002
|
+
],
|
|
249003
|
+
"members": [],
|
|
249004
|
+
"returnType": {
|
|
249005
|
+
"kind": "primitive",
|
|
249006
|
+
"value": "string"
|
|
249007
|
+
}
|
|
249008
|
+
}
|
|
249009
|
+
},
|
|
249010
|
+
{
|
|
249011
|
+
"name": "createStyleObjectNode",
|
|
249012
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts",
|
|
249013
|
+
"description": "Creates an AST node representation of the passed in `styleObj`, but in the format of `{name:\nstring, styles: serializedStyles}`. The `name` is hard-coded here to work with both server-side\nand client-side style injection. This results in a stable style key for Emotion while also\noptimizing style serialization.\n\nIf `name` is provided, the name will be whatever `name` is, replacing \"{hash}\" with the hash\ncreated via `serializeStyles`. For example: 'animation-{hash}' will be converted into\n'animation-abc123'",
|
|
249014
|
+
"declarations": [
|
|
249015
|
+
{
|
|
249016
|
+
"name": "createStyleObjectNode",
|
|
249017
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249018
|
+
}
|
|
249019
|
+
],
|
|
249020
|
+
"tags": {},
|
|
249021
|
+
"type": {
|
|
249022
|
+
"kind": "function",
|
|
249023
|
+
"parameters": [
|
|
249024
|
+
{
|
|
249025
|
+
"kind": "parameter",
|
|
249026
|
+
"name": "styleObj",
|
|
249027
|
+
"type": {
|
|
249028
|
+
"kind": "union",
|
|
249029
|
+
"value": [
|
|
249030
|
+
{
|
|
249031
|
+
"kind": "symbol",
|
|
249032
|
+
"name": "NestedStyleObject",
|
|
249033
|
+
"value": "NestedStyleObject"
|
|
249034
|
+
},
|
|
249035
|
+
{
|
|
249036
|
+
"kind": "primitive",
|
|
249037
|
+
"value": "string"
|
|
249038
|
+
}
|
|
249039
|
+
]
|
|
249040
|
+
},
|
|
249041
|
+
"required": true,
|
|
249042
|
+
"rest": false,
|
|
249043
|
+
"description": "",
|
|
249044
|
+
"declarations": [
|
|
249045
|
+
{
|
|
249046
|
+
"name": "styleObj",
|
|
249047
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249048
|
+
}
|
|
249049
|
+
],
|
|
249050
|
+
"tags": {}
|
|
249051
|
+
},
|
|
249052
|
+
{
|
|
249053
|
+
"kind": "parameter",
|
|
249054
|
+
"name": "name",
|
|
249055
|
+
"type": {
|
|
249056
|
+
"kind": "primitive",
|
|
249057
|
+
"value": "string"
|
|
249058
|
+
},
|
|
249059
|
+
"required": false,
|
|
249060
|
+
"rest": false,
|
|
249061
|
+
"description": "",
|
|
249062
|
+
"declarations": [
|
|
249063
|
+
{
|
|
249064
|
+
"name": "name",
|
|
249065
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249066
|
+
}
|
|
249067
|
+
],
|
|
249068
|
+
"tags": {}
|
|
249069
|
+
}
|
|
249070
|
+
],
|
|
249071
|
+
"members": [],
|
|
249072
|
+
"returnType": {
|
|
249073
|
+
"kind": "symbol",
|
|
249074
|
+
"name": "ObjectLiteralExpression",
|
|
249075
|
+
"value": "ObjectLiteralExpression"
|
|
249076
|
+
}
|
|
249077
|
+
}
|
|
249078
|
+
},
|
|
249079
|
+
{
|
|
249080
|
+
"name": "getStaticCssClassName",
|
|
249081
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts",
|
|
249082
|
+
"description": "Returns the name created by `createStyleObjectNode`",
|
|
249083
|
+
"declarations": [
|
|
249084
|
+
{
|
|
249085
|
+
"name": "getStaticCssClassName",
|
|
249086
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249087
|
+
}
|
|
249088
|
+
],
|
|
249089
|
+
"tags": {},
|
|
249090
|
+
"type": {
|
|
249091
|
+
"kind": "function",
|
|
249092
|
+
"parameters": [
|
|
249093
|
+
{
|
|
249094
|
+
"kind": "parameter",
|
|
249095
|
+
"name": "node",
|
|
249096
|
+
"type": {
|
|
249097
|
+
"kind": "symbol",
|
|
249098
|
+
"name": "ts.Node",
|
|
249099
|
+
"value": "Node"
|
|
249100
|
+
},
|
|
249101
|
+
"required": true,
|
|
249102
|
+
"rest": false,
|
|
249103
|
+
"description": "",
|
|
249104
|
+
"declarations": [
|
|
249105
|
+
{
|
|
249106
|
+
"name": "node",
|
|
249107
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/createStyleObjectNode.ts"
|
|
249108
|
+
}
|
|
249109
|
+
],
|
|
249110
|
+
"tags": {}
|
|
249111
|
+
}
|
|
249112
|
+
],
|
|
249113
|
+
"members": [],
|
|
249114
|
+
"returnType": {
|
|
249115
|
+
"kind": "primitive",
|
|
249116
|
+
"value": "string"
|
|
249117
|
+
}
|
|
249118
|
+
}
|
|
249119
|
+
},
|
|
248432
249120
|
{
|
|
248433
249121
|
"name": "getVariablesFromFiles",
|
|
248434
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts",
|
|
249122
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts",
|
|
248435
249123
|
"description": "",
|
|
248436
249124
|
"declarations": [
|
|
248437
249125
|
{
|
|
248438
249126
|
"name": "getVariablesFromFiles",
|
|
248439
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts"
|
|
249127
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts"
|
|
248440
249128
|
}
|
|
248441
249129
|
],
|
|
248442
249130
|
"tags": {},
|
|
@@ -248459,7 +249147,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248459
249147
|
"declarations": [
|
|
248460
249148
|
{
|
|
248461
249149
|
"name": "files",
|
|
248462
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts"
|
|
249150
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts"
|
|
248463
249151
|
}
|
|
248464
249152
|
],
|
|
248465
249153
|
"tags": {}
|
|
@@ -248485,12 +249173,12 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248485
249173
|
},
|
|
248486
249174
|
{
|
|
248487
249175
|
"name": "extractVariables",
|
|
248488
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts",
|
|
249176
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts",
|
|
248489
249177
|
"description": "",
|
|
248490
249178
|
"declarations": [
|
|
248491
249179
|
{
|
|
248492
249180
|
"name": "extractVariables",
|
|
248493
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts"
|
|
249181
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts"
|
|
248494
249182
|
}
|
|
248495
249183
|
],
|
|
248496
249184
|
"tags": {},
|
|
@@ -248523,7 +249211,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248523
249211
|
"declarations": [
|
|
248524
249212
|
{
|
|
248525
249213
|
"name": "blocks",
|
|
248526
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts"
|
|
249214
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts"
|
|
248527
249215
|
}
|
|
248528
249216
|
],
|
|
248529
249217
|
"tags": {}
|
|
@@ -248556,7 +249244,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248556
249244
|
"declarations": [
|
|
248557
249245
|
{
|
|
248558
249246
|
"name": "variables",
|
|
248559
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/getCssVariables.ts"
|
|
249247
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getCssVariables.ts"
|
|
248560
249248
|
}
|
|
248561
249249
|
],
|
|
248562
249250
|
"tags": {}
|
|
@@ -248580,14 +249268,55 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248580
249268
|
}
|
|
248581
249269
|
}
|
|
248582
249270
|
},
|
|
249271
|
+
{
|
|
249272
|
+
"name": "getErrorMessage",
|
|
249273
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getErrorMessage.ts",
|
|
249274
|
+
"description": "Creates an error message around a node. It will look something like:\n\n```\nUnknown type at: \"fontSize\".\nFile: test.ts, Line: 6, Character: 17.\nconst styles = createStyles({\n fontSize: fontSize\n ========\n})\n```",
|
|
249275
|
+
"declarations": [
|
|
249276
|
+
{
|
|
249277
|
+
"name": "getErrorMessage",
|
|
249278
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getErrorMessage.ts"
|
|
249279
|
+
}
|
|
249280
|
+
],
|
|
249281
|
+
"tags": {},
|
|
249282
|
+
"type": {
|
|
249283
|
+
"kind": "function",
|
|
249284
|
+
"parameters": [
|
|
249285
|
+
{
|
|
249286
|
+
"kind": "parameter",
|
|
249287
|
+
"name": "node",
|
|
249288
|
+
"type": {
|
|
249289
|
+
"kind": "symbol",
|
|
249290
|
+
"name": "ts.Node",
|
|
249291
|
+
"value": "Node"
|
|
249292
|
+
},
|
|
249293
|
+
"required": true,
|
|
249294
|
+
"rest": false,
|
|
249295
|
+
"description": "",
|
|
249296
|
+
"declarations": [
|
|
249297
|
+
{
|
|
249298
|
+
"name": "node",
|
|
249299
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getErrorMessage.ts"
|
|
249300
|
+
}
|
|
249301
|
+
],
|
|
249302
|
+
"tags": {}
|
|
249303
|
+
}
|
|
249304
|
+
],
|
|
249305
|
+
"members": [],
|
|
249306
|
+
"returnType": {
|
|
249307
|
+
"kind": "primitive",
|
|
249308
|
+
"value": "string"
|
|
249309
|
+
}
|
|
249310
|
+
}
|
|
249311
|
+
},
|
|
248583
249312
|
{
|
|
248584
249313
|
"name": "getFallbackVariable",
|
|
248585
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
248586
|
-
"description": "",
|
|
249314
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getFallbackVariable.ts",
|
|
249315
|
+
"description": "Looks for a variable value that doesn't include a fallback and automatically adds one if found in\nthe current cache of variables. This allows fallbacks to be automatically included in\nenvironments without the variables defined. This is most useful for Storybook or other sandboxes\nthat may not have CSS Variables defined. The fallbacks will allow the UI to look correct without\nadditional setup. Fallbacks come from the `fallbackFiles` transform configuration.",
|
|
248587
249316
|
"declarations": [
|
|
248588
249317
|
{
|
|
248589
249318
|
"name": "getFallbackVariable",
|
|
248590
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249319
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getFallbackVariable.ts"
|
|
248591
249320
|
}
|
|
248592
249321
|
],
|
|
248593
249322
|
"tags": {},
|
|
@@ -248607,7 +249336,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248607
249336
|
"declarations": [
|
|
248608
249337
|
{
|
|
248609
249338
|
"name": "variableName",
|
|
248610
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249339
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getFallbackVariable.ts"
|
|
248611
249340
|
}
|
|
248612
249341
|
],
|
|
248613
249342
|
"tags": {}
|
|
@@ -248636,7 +249365,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248636
249365
|
"declarations": [
|
|
248637
249366
|
{
|
|
248638
249367
|
"name": "variables",
|
|
248639
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249368
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getFallbackVariable.ts"
|
|
248640
249369
|
}
|
|
248641
249370
|
],
|
|
248642
249371
|
"tags": {}
|
|
@@ -248658,14 +249387,376 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248658
249387
|
}
|
|
248659
249388
|
}
|
|
248660
249389
|
},
|
|
249390
|
+
{
|
|
249391
|
+
"name": "getVarName",
|
|
249392
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getVarName.ts",
|
|
249393
|
+
"description": "This function returns a calculated name of a node by walking up the AST and looking for nodes\nwith a `name` property that has an `Identifier` node type. The result is dash-case. This is\nuseful for automatically generating variable names based on a TS file.\n\nIn the following example, the `baz` node would have a name of `foo-bar-baz`.\n```ts\nconst foo = {\n bar: {\n baz: ''\n }\n}\n```",
|
|
249394
|
+
"declarations": [
|
|
249395
|
+
{
|
|
249396
|
+
"name": "getVarName",
|
|
249397
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getVarName.ts"
|
|
249398
|
+
}
|
|
249399
|
+
],
|
|
249400
|
+
"tags": {},
|
|
249401
|
+
"type": {
|
|
249402
|
+
"kind": "function",
|
|
249403
|
+
"parameters": [
|
|
249404
|
+
{
|
|
249405
|
+
"kind": "parameter",
|
|
249406
|
+
"name": "node",
|
|
249407
|
+
"type": {
|
|
249408
|
+
"kind": "symbol",
|
|
249409
|
+
"name": "ts.Node",
|
|
249410
|
+
"value": "Node"
|
|
249411
|
+
},
|
|
249412
|
+
"required": true,
|
|
249413
|
+
"rest": false,
|
|
249414
|
+
"description": "",
|
|
249415
|
+
"declarations": [
|
|
249416
|
+
{
|
|
249417
|
+
"name": "node",
|
|
249418
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getVarName.ts"
|
|
249419
|
+
}
|
|
249420
|
+
],
|
|
249421
|
+
"tags": {}
|
|
249422
|
+
},
|
|
249423
|
+
{
|
|
249424
|
+
"kind": "parameter",
|
|
249425
|
+
"name": "parts",
|
|
249426
|
+
"defaultValue": {
|
|
249427
|
+
"kind": "tuple",
|
|
249428
|
+
"value": []
|
|
249429
|
+
},
|
|
249430
|
+
"type": {
|
|
249431
|
+
"kind": "array",
|
|
249432
|
+
"value": {
|
|
249433
|
+
"kind": "primitive",
|
|
249434
|
+
"value": "string"
|
|
249435
|
+
}
|
|
249436
|
+
},
|
|
249437
|
+
"required": false,
|
|
249438
|
+
"rest": false,
|
|
249439
|
+
"description": "",
|
|
249440
|
+
"declarations": [
|
|
249441
|
+
{
|
|
249442
|
+
"name": "parts",
|
|
249443
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/getVarName.ts"
|
|
249444
|
+
}
|
|
249445
|
+
],
|
|
249446
|
+
"tags": {}
|
|
249447
|
+
}
|
|
249448
|
+
],
|
|
249449
|
+
"members": [],
|
|
249450
|
+
"returnType": {
|
|
249451
|
+
"kind": "primitive",
|
|
249452
|
+
"value": "string"
|
|
249453
|
+
}
|
|
249454
|
+
}
|
|
249455
|
+
},
|
|
249456
|
+
{
|
|
249457
|
+
"name": "handleCalc",
|
|
249458
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCalc.ts",
|
|
249459
|
+
"description": "Handle all instances of `calc.*()` statically. It converts `calc.*` call expressions to template\nstring literals. The transformer will then transform the template literal into static values.\n\n```ts\n// in\ncalc.add('80%', '2px')\n\n// out\n`calc(${'80%'} + ${'2px'})`\n```\n\nA template literal is used because the values might be Identifiers, PropertyAccessExpressions,\netc. The transform can handle template string literals with different spans, so we'll convert to\nthose as an intermediate step.",
|
|
249460
|
+
"declarations": [
|
|
249461
|
+
{
|
|
249462
|
+
"name": "handleCalc",
|
|
249463
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCalc.ts"
|
|
249464
|
+
}
|
|
249465
|
+
],
|
|
249466
|
+
"tags": {},
|
|
249467
|
+
"type": {
|
|
249468
|
+
"kind": "symbol",
|
|
249469
|
+
"name": "NodeTransformer",
|
|
249470
|
+
"value": "NodeTransformer"
|
|
249471
|
+
}
|
|
249472
|
+
},
|
|
249473
|
+
{
|
|
249474
|
+
"name": "handleCreateStencil",
|
|
249475
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCreateStencil.ts",
|
|
249476
|
+
"description": "Handle all arguments of the CallExpression `createStencil()`",
|
|
249477
|
+
"declarations": [
|
|
249478
|
+
{
|
|
249479
|
+
"name": "handleCreateStencil",
|
|
249480
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCreateStencil.ts"
|
|
249481
|
+
}
|
|
249482
|
+
],
|
|
249483
|
+
"tags": {},
|
|
249484
|
+
"type": {
|
|
249485
|
+
"kind": "symbol",
|
|
249486
|
+
"name": "NodeTransformer",
|
|
249487
|
+
"value": "NodeTransformer"
|
|
249488
|
+
}
|
|
249489
|
+
},
|
|
249490
|
+
{
|
|
249491
|
+
"name": "handleCreateStyles",
|
|
249492
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCreateStyles.ts",
|
|
249493
|
+
"description": "",
|
|
249494
|
+
"declarations": [
|
|
249495
|
+
{
|
|
249496
|
+
"name": "handleCreateStyles",
|
|
249497
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCreateStyles.ts"
|
|
249498
|
+
}
|
|
249499
|
+
],
|
|
249500
|
+
"tags": {},
|
|
249501
|
+
"type": {
|
|
249502
|
+
"kind": "symbol",
|
|
249503
|
+
"name": "NodeTransformer",
|
|
249504
|
+
"value": "NodeTransformer"
|
|
249505
|
+
}
|
|
249506
|
+
},
|
|
249507
|
+
{
|
|
249508
|
+
"name": "handleCreateVars",
|
|
249509
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCreateVars.ts",
|
|
249510
|
+
"description": "",
|
|
249511
|
+
"declarations": [
|
|
249512
|
+
{
|
|
249513
|
+
"name": "handleCreateVars",
|
|
249514
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCreateVars.ts"
|
|
249515
|
+
}
|
|
249516
|
+
],
|
|
249517
|
+
"tags": {},
|
|
249518
|
+
"type": {
|
|
249519
|
+
"kind": "symbol",
|
|
249520
|
+
"name": "NodeTransformer",
|
|
249521
|
+
"value": "NodeTransformer"
|
|
249522
|
+
}
|
|
249523
|
+
},
|
|
249524
|
+
{
|
|
249525
|
+
"name": "handleCssVar",
|
|
249526
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCssVar.ts",
|
|
249527
|
+
"description": "Converts `cssVar` to a `TemplateExpression` with each argument as a span\n\n- `cssVar('--foo')` => `\\`var(${'--foo'})\\``\n- `cssVar('--foo', 'fallback')` => `\\`var(${'--foo'}, ${'fallback'})\\``\n\nThe value parser will figure out what to do from there. We don't have access to variables at this\npoint, so we forward CallExpression arguments in ways the value parser understands.",
|
|
249528
|
+
"declarations": [
|
|
249529
|
+
{
|
|
249530
|
+
"name": "handleCssVar",
|
|
249531
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleCssVar.ts"
|
|
249532
|
+
}
|
|
249533
|
+
],
|
|
249534
|
+
"tags": {},
|
|
249535
|
+
"type": {
|
|
249536
|
+
"kind": "symbol",
|
|
249537
|
+
"name": "NodeTransformer",
|
|
249538
|
+
"value": "NodeTransformer"
|
|
249539
|
+
}
|
|
249540
|
+
},
|
|
249541
|
+
{
|
|
249542
|
+
"name": "handleFocusRing",
|
|
249543
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleFocusRing.ts",
|
|
249544
|
+
"description": "",
|
|
249545
|
+
"declarations": [
|
|
249546
|
+
{
|
|
249547
|
+
"name": "handleFocusRing",
|
|
249548
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleFocusRing.ts"
|
|
249549
|
+
}
|
|
249550
|
+
],
|
|
249551
|
+
"tags": {},
|
|
249552
|
+
"type": {
|
|
249553
|
+
"kind": "symbol",
|
|
249554
|
+
"name": "NodeTransformer",
|
|
249555
|
+
"value": "NodeTransformer"
|
|
249556
|
+
}
|
|
249557
|
+
},
|
|
249558
|
+
{
|
|
249559
|
+
"name": "handleKeyframes",
|
|
249560
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleKeyframes.ts",
|
|
249561
|
+
"description": "",
|
|
249562
|
+
"declarations": [
|
|
249563
|
+
{
|
|
249564
|
+
"name": "handleKeyframes",
|
|
249565
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handleKeyframes.ts"
|
|
249566
|
+
}
|
|
249567
|
+
],
|
|
249568
|
+
"tags": {},
|
|
249569
|
+
"type": {
|
|
249570
|
+
"kind": "symbol",
|
|
249571
|
+
"name": "NodeTransformer",
|
|
249572
|
+
"value": "NodeTransformer"
|
|
249573
|
+
}
|
|
249574
|
+
},
|
|
249575
|
+
{
|
|
249576
|
+
"name": "handlePx2Rem",
|
|
249577
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handlePx2Rem.ts",
|
|
249578
|
+
"description": "Handle the CallExpression `px2rem` to do static conversion and remove the CallExpression.",
|
|
249579
|
+
"declarations": [
|
|
249580
|
+
{
|
|
249581
|
+
"name": "handlePx2Rem",
|
|
249582
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/handlePx2Rem.ts"
|
|
249583
|
+
}
|
|
249584
|
+
],
|
|
249585
|
+
"tags": {},
|
|
249586
|
+
"type": {
|
|
249587
|
+
"kind": "symbol",
|
|
249588
|
+
"name": "NodeTransformer",
|
|
249589
|
+
"value": "NodeTransformer"
|
|
249590
|
+
}
|
|
249591
|
+
},
|
|
249592
|
+
{
|
|
249593
|
+
"name": "isImportedFromStyling",
|
|
249594
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/isImportedFromStyling.ts",
|
|
249595
|
+
"description": "Checks if the node was imported from '@workday/canvas-kit-styling'. This is useful if you want to\nlimit transformation to only styling imports.",
|
|
249596
|
+
"declarations": [
|
|
249597
|
+
{
|
|
249598
|
+
"name": "isImportedFromStyling",
|
|
249599
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/isImportedFromStyling.ts"
|
|
249600
|
+
}
|
|
249601
|
+
],
|
|
249602
|
+
"tags": {},
|
|
249603
|
+
"type": {
|
|
249604
|
+
"kind": "function",
|
|
249605
|
+
"parameters": [
|
|
249606
|
+
{
|
|
249607
|
+
"kind": "parameter",
|
|
249608
|
+
"name": "node",
|
|
249609
|
+
"type": {
|
|
249610
|
+
"kind": "symbol",
|
|
249611
|
+
"name": "ts.Node",
|
|
249612
|
+
"value": "Node"
|
|
249613
|
+
},
|
|
249614
|
+
"required": true,
|
|
249615
|
+
"rest": false,
|
|
249616
|
+
"description": "",
|
|
249617
|
+
"declarations": [
|
|
249618
|
+
{
|
|
249619
|
+
"name": "node",
|
|
249620
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/isImportedFromStyling.ts"
|
|
249621
|
+
}
|
|
249622
|
+
],
|
|
249623
|
+
"tags": {}
|
|
249624
|
+
},
|
|
249625
|
+
{
|
|
249626
|
+
"kind": "parameter",
|
|
249627
|
+
"name": "checker",
|
|
249628
|
+
"type": {
|
|
249629
|
+
"kind": "symbol",
|
|
249630
|
+
"name": "ts.TypeChecker",
|
|
249631
|
+
"value": "TypeChecker"
|
|
249632
|
+
},
|
|
249633
|
+
"required": true,
|
|
249634
|
+
"rest": false,
|
|
249635
|
+
"description": "",
|
|
249636
|
+
"declarations": [
|
|
249637
|
+
{
|
|
249638
|
+
"name": "checker",
|
|
249639
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/isImportedFromStyling.ts"
|
|
249640
|
+
}
|
|
249641
|
+
],
|
|
249642
|
+
"tags": {}
|
|
249643
|
+
}
|
|
249644
|
+
],
|
|
249645
|
+
"members": [],
|
|
249646
|
+
"returnType": {
|
|
249647
|
+
"kind": "primitive",
|
|
249648
|
+
"value": "boolean"
|
|
249649
|
+
}
|
|
249650
|
+
}
|
|
249651
|
+
},
|
|
249652
|
+
{
|
|
249653
|
+
"name": "makeEmotionSafe",
|
|
249654
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/makeEmotionSafe.ts",
|
|
249655
|
+
"description": "Util function to fix an issue with Emotion by\nappending `EmotionIssue#3066` to end of css variable\nSee issue: [#3066](https://github.com/emotion-js/emotion/issues/3066)",
|
|
249656
|
+
"declarations": [
|
|
249657
|
+
{
|
|
249658
|
+
"name": "makeEmotionSafe",
|
|
249659
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/makeEmotionSafe.ts"
|
|
249660
|
+
}
|
|
249661
|
+
],
|
|
249662
|
+
"tags": {},
|
|
249663
|
+
"type": {
|
|
249664
|
+
"kind": "function",
|
|
249665
|
+
"parameters": [
|
|
249666
|
+
{
|
|
249667
|
+
"kind": "parameter",
|
|
249668
|
+
"name": "key",
|
|
249669
|
+
"type": {
|
|
249670
|
+
"kind": "primitive",
|
|
249671
|
+
"value": "string"
|
|
249672
|
+
},
|
|
249673
|
+
"required": true,
|
|
249674
|
+
"rest": false,
|
|
249675
|
+
"description": "",
|
|
249676
|
+
"declarations": [
|
|
249677
|
+
{
|
|
249678
|
+
"name": "key",
|
|
249679
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/makeEmotionSafe.ts"
|
|
249680
|
+
}
|
|
249681
|
+
],
|
|
249682
|
+
"tags": {}
|
|
249683
|
+
}
|
|
249684
|
+
],
|
|
249685
|
+
"members": [],
|
|
249686
|
+
"returnType": {
|
|
249687
|
+
"kind": "primitive",
|
|
249688
|
+
"value": "string"
|
|
249689
|
+
}
|
|
249690
|
+
}
|
|
249691
|
+
},
|
|
249692
|
+
{
|
|
249693
|
+
"name": "parseNodeToStaticValue",
|
|
249694
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseNodeToStaticValue.ts",
|
|
249695
|
+
"description": "This is the workhorse of statically analyzing style values",
|
|
249696
|
+
"declarations": [
|
|
249697
|
+
{
|
|
249698
|
+
"name": "parseNodeToStaticValue",
|
|
249699
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseNodeToStaticValue.ts"
|
|
249700
|
+
}
|
|
249701
|
+
],
|
|
249702
|
+
"tags": {},
|
|
249703
|
+
"type": {
|
|
249704
|
+
"kind": "function",
|
|
249705
|
+
"parameters": [
|
|
249706
|
+
{
|
|
249707
|
+
"kind": "parameter",
|
|
249708
|
+
"name": "node",
|
|
249709
|
+
"type": {
|
|
249710
|
+
"kind": "symbol",
|
|
249711
|
+
"name": "ts.Node",
|
|
249712
|
+
"value": "Node"
|
|
249713
|
+
},
|
|
249714
|
+
"required": true,
|
|
249715
|
+
"rest": false,
|
|
249716
|
+
"description": "",
|
|
249717
|
+
"declarations": [
|
|
249718
|
+
{
|
|
249719
|
+
"name": "node",
|
|
249720
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseNodeToStaticValue.ts"
|
|
249721
|
+
}
|
|
249722
|
+
],
|
|
249723
|
+
"tags": {}
|
|
249724
|
+
},
|
|
249725
|
+
{
|
|
249726
|
+
"kind": "parameter",
|
|
249727
|
+
"name": "context",
|
|
249728
|
+
"type": {
|
|
249729
|
+
"kind": "symbol",
|
|
249730
|
+
"name": "TransformerContext",
|
|
249731
|
+
"value": "TransformerContext"
|
|
249732
|
+
},
|
|
249733
|
+
"required": true,
|
|
249734
|
+
"rest": false,
|
|
249735
|
+
"description": "",
|
|
249736
|
+
"declarations": [
|
|
249737
|
+
{
|
|
249738
|
+
"name": "context",
|
|
249739
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseNodeToStaticValue.ts"
|
|
249740
|
+
}
|
|
249741
|
+
],
|
|
249742
|
+
"tags": {}
|
|
249743
|
+
}
|
|
249744
|
+
],
|
|
249745
|
+
"members": [],
|
|
249746
|
+
"returnType": {
|
|
249747
|
+
"kind": "primitive",
|
|
249748
|
+
"value": "string"
|
|
249749
|
+
}
|
|
249750
|
+
}
|
|
249751
|
+
},
|
|
248661
249752
|
{
|
|
248662
249753
|
"name": "NestedStyleObject",
|
|
248663
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249754
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts",
|
|
248664
249755
|
"description": "",
|
|
248665
249756
|
"declarations": [
|
|
248666
249757
|
{
|
|
248667
249758
|
"name": "NestedStyleObject",
|
|
248668
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249759
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
248669
249760
|
}
|
|
248670
249761
|
],
|
|
248671
249762
|
"tags": {},
|
|
@@ -248697,19 +249788,159 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248697
249788
|
}
|
|
248698
249789
|
},
|
|
248699
249790
|
{
|
|
248700
|
-
"name": "
|
|
248701
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249791
|
+
"name": "parseObjectToStaticValue",
|
|
249792
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts",
|
|
248702
249793
|
"description": "",
|
|
248703
249794
|
"declarations": [
|
|
248704
249795
|
{
|
|
248705
|
-
"name": "
|
|
248706
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249796
|
+
"name": "parseObjectToStaticValue",
|
|
249797
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
249798
|
+
}
|
|
249799
|
+
],
|
|
249800
|
+
"tags": {},
|
|
249801
|
+
"type": {
|
|
249802
|
+
"kind": "function",
|
|
249803
|
+
"parameters": [
|
|
249804
|
+
{
|
|
249805
|
+
"kind": "parameter",
|
|
249806
|
+
"name": "node",
|
|
249807
|
+
"type": {
|
|
249808
|
+
"kind": "symbol",
|
|
249809
|
+
"name": "ts.Node",
|
|
249810
|
+
"value": "Node"
|
|
249811
|
+
},
|
|
249812
|
+
"required": true,
|
|
249813
|
+
"rest": false,
|
|
249814
|
+
"description": "",
|
|
249815
|
+
"declarations": [
|
|
249816
|
+
{
|
|
249817
|
+
"name": "node",
|
|
249818
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
249819
|
+
}
|
|
249820
|
+
],
|
|
249821
|
+
"tags": {}
|
|
249822
|
+
},
|
|
249823
|
+
{
|
|
249824
|
+
"kind": "parameter",
|
|
249825
|
+
"name": "context",
|
|
249826
|
+
"type": {
|
|
249827
|
+
"kind": "symbol",
|
|
249828
|
+
"name": "TransformerContext",
|
|
249829
|
+
"value": "TransformerContext"
|
|
249830
|
+
},
|
|
249831
|
+
"required": true,
|
|
249832
|
+
"rest": false,
|
|
249833
|
+
"description": "",
|
|
249834
|
+
"declarations": [
|
|
249835
|
+
{
|
|
249836
|
+
"name": "context",
|
|
249837
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
249838
|
+
}
|
|
249839
|
+
],
|
|
249840
|
+
"tags": {}
|
|
249841
|
+
}
|
|
249842
|
+
],
|
|
249843
|
+
"members": [],
|
|
249844
|
+
"returnType": {
|
|
249845
|
+
"kind": "symbol",
|
|
249846
|
+
"name": "NestedStyleObject",
|
|
249847
|
+
"value": "NestedStyleObject"
|
|
249848
|
+
}
|
|
249849
|
+
}
|
|
249850
|
+
},
|
|
249851
|
+
{
|
|
249852
|
+
"name": "parseStyleObjFromType",
|
|
249853
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts",
|
|
249854
|
+
"description": "If we're here, we have a `ts.Type` that represents a style object. We try to parse a style object\nfrom the AST, but we might have something that is more complicated like a function call or an\nidentifier that represents an object. It could be imported from another file.",
|
|
249855
|
+
"declarations": [
|
|
249856
|
+
{
|
|
249857
|
+
"name": "parseStyleObjFromType",
|
|
249858
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
249859
|
+
}
|
|
249860
|
+
],
|
|
249861
|
+
"tags": {},
|
|
249862
|
+
"type": {
|
|
249863
|
+
"kind": "function",
|
|
249864
|
+
"parameters": [
|
|
249865
|
+
{
|
|
249866
|
+
"kind": "parameter",
|
|
249867
|
+
"name": "type",
|
|
249868
|
+
"type": {
|
|
249869
|
+
"kind": "symbol",
|
|
249870
|
+
"name": "ts.Type",
|
|
249871
|
+
"value": "Type"
|
|
249872
|
+
},
|
|
249873
|
+
"required": true,
|
|
249874
|
+
"rest": false,
|
|
249875
|
+
"description": "",
|
|
249876
|
+
"declarations": [
|
|
249877
|
+
{
|
|
249878
|
+
"name": "type",
|
|
249879
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
249880
|
+
}
|
|
249881
|
+
],
|
|
249882
|
+
"tags": {}
|
|
249883
|
+
},
|
|
249884
|
+
{
|
|
249885
|
+
"kind": "parameter",
|
|
249886
|
+
"name": "context",
|
|
249887
|
+
"type": {
|
|
249888
|
+
"kind": "symbol",
|
|
249889
|
+
"name": "TransformerContext",
|
|
249890
|
+
"value": "TransformerContext"
|
|
249891
|
+
},
|
|
249892
|
+
"required": true,
|
|
249893
|
+
"rest": false,
|
|
249894
|
+
"description": "",
|
|
249895
|
+
"declarations": [
|
|
249896
|
+
{
|
|
249897
|
+
"name": "context",
|
|
249898
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/parseObjectToStaticValue.ts"
|
|
249899
|
+
}
|
|
249900
|
+
],
|
|
249901
|
+
"tags": {}
|
|
249902
|
+
}
|
|
249903
|
+
],
|
|
249904
|
+
"members": [],
|
|
249905
|
+
"returnType": {
|
|
249906
|
+
"kind": "external",
|
|
249907
|
+
"name": "Record",
|
|
249908
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type"
|
|
249909
|
+
}
|
|
249910
|
+
}
|
|
249911
|
+
},
|
|
249912
|
+
{
|
|
249913
|
+
"name": "TransformerContext",
|
|
249914
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
249915
|
+
"description": "",
|
|
249916
|
+
"declarations": [
|
|
249917
|
+
{
|
|
249918
|
+
"name": "TransformerContext",
|
|
249919
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248707
249920
|
}
|
|
248708
249921
|
],
|
|
248709
249922
|
"tags": {},
|
|
248710
249923
|
"type": {
|
|
248711
249924
|
"kind": "object",
|
|
248712
249925
|
"properties": [
|
|
249926
|
+
{
|
|
249927
|
+
"kind": "property",
|
|
249928
|
+
"name": "checker",
|
|
249929
|
+
"required": true,
|
|
249930
|
+
"type": {
|
|
249931
|
+
"kind": "symbol",
|
|
249932
|
+
"name": "ts.TypeChecker",
|
|
249933
|
+
"value": "TypeChecker"
|
|
249934
|
+
},
|
|
249935
|
+
"description": "",
|
|
249936
|
+
"declarations": [
|
|
249937
|
+
{
|
|
249938
|
+
"name": "checker",
|
|
249939
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
249940
|
+
}
|
|
249941
|
+
],
|
|
249942
|
+
"tags": {}
|
|
249943
|
+
},
|
|
248713
249944
|
{
|
|
248714
249945
|
"kind": "property",
|
|
248715
249946
|
"name": "prefix",
|
|
@@ -248722,7 +249953,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248722
249953
|
"declarations": [
|
|
248723
249954
|
{
|
|
248724
249955
|
"name": "prefix",
|
|
248725
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249956
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248726
249957
|
}
|
|
248727
249958
|
],
|
|
248728
249959
|
"tags": {}
|
|
@@ -248750,27 +249981,35 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248750
249981
|
"declarations": [
|
|
248751
249982
|
{
|
|
248752
249983
|
"name": "variables",
|
|
248753
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
249984
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248754
249985
|
}
|
|
248755
249986
|
],
|
|
248756
249987
|
"tags": {}
|
|
248757
249988
|
},
|
|
248758
249989
|
{
|
|
248759
249990
|
"kind": "property",
|
|
248760
|
-
"name": "
|
|
248761
|
-
"required":
|
|
249991
|
+
"name": "keyframes",
|
|
249992
|
+
"required": true,
|
|
248762
249993
|
"type": {
|
|
248763
|
-
"kind": "
|
|
248764
|
-
"
|
|
248765
|
-
|
|
248766
|
-
|
|
248767
|
-
|
|
249994
|
+
"kind": "external",
|
|
249995
|
+
"name": "Record",
|
|
249996
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
249997
|
+
"typeParameters": [
|
|
249998
|
+
{
|
|
249999
|
+
"kind": "primitive",
|
|
250000
|
+
"value": "string"
|
|
250001
|
+
},
|
|
250002
|
+
{
|
|
250003
|
+
"kind": "primitive",
|
|
250004
|
+
"value": "string"
|
|
250005
|
+
}
|
|
250006
|
+
]
|
|
248768
250007
|
},
|
|
248769
250008
|
"description": "",
|
|
248770
250009
|
"declarations": [
|
|
248771
250010
|
{
|
|
248772
|
-
"name": "
|
|
248773
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250011
|
+
"name": "keyframes",
|
|
250012
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248774
250013
|
}
|
|
248775
250014
|
],
|
|
248776
250015
|
"tags": {}
|
|
@@ -248779,209 +250018,76 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
248779
250018
|
}
|
|
248780
250019
|
},
|
|
248781
250020
|
{
|
|
248782
|
-
"name": "
|
|
248783
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
248784
|
-
"description": "",
|
|
250021
|
+
"name": "NodeTransformer",
|
|
250022
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts",
|
|
250023
|
+
"description": "Transformer function type. A transformer will be called by the TypeScript AST transformer visitor\nfrom the bottom of the tree to the top (inside-out/leaf first, root last). If a transformer knows\nhow to handle the AST node, a node should be returned. Even if no transformation is desired,\nreturning a node shortcuts processing. The visitor will call all NodeTransformers until a match\nis met.",
|
|
248785
250024
|
"declarations": [
|
|
248786
250025
|
{
|
|
248787
|
-
"name": "
|
|
248788
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/
|
|
250026
|
+
"name": "NodeTransformer",
|
|
250027
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248789
250028
|
}
|
|
248790
250029
|
],
|
|
248791
250030
|
"tags": {},
|
|
248792
250031
|
"type": {
|
|
248793
|
-
"kind": "
|
|
248794
|
-
"
|
|
248795
|
-
|
|
248796
|
-
|
|
248797
|
-
|
|
248798
|
-
|
|
248799
|
-
"kind": "
|
|
248800
|
-
"name": "
|
|
248801
|
-
"
|
|
248802
|
-
|
|
248803
|
-
|
|
248804
|
-
|
|
248805
|
-
|
|
248806
|
-
|
|
248807
|
-
|
|
248808
|
-
|
|
248809
|
-
|
|
248810
|
-
}
|
|
248811
|
-
],
|
|
248812
|
-
"tags": {}
|
|
248813
|
-
},
|
|
248814
|
-
{
|
|
248815
|
-
"kind": "parameter",
|
|
248816
|
-
"name": "__1",
|
|
248817
|
-
"defaultValue": {
|
|
248818
|
-
"kind": "object",
|
|
248819
|
-
"properties": [
|
|
248820
|
-
{
|
|
248821
|
-
"kind": "property",
|
|
248822
|
-
"name": "prefix",
|
|
248823
|
-
"defaultValue": {
|
|
248824
|
-
"kind": "string",
|
|
248825
|
-
"value": "css"
|
|
248826
|
-
},
|
|
248827
|
-
"type": {
|
|
248828
|
-
"kind": "primitive",
|
|
248829
|
-
"value": "string"
|
|
248830
|
-
},
|
|
248831
|
-
"required": true,
|
|
248832
|
-
"description": "",
|
|
248833
|
-
"declarations": [
|
|
248834
|
-
{
|
|
248835
|
-
"name": "prefix",
|
|
248836
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248837
|
-
}
|
|
248838
|
-
],
|
|
248839
|
-
"tags": {}
|
|
248840
|
-
},
|
|
250032
|
+
"kind": "type",
|
|
250033
|
+
"typeParameters": [],
|
|
250034
|
+
"value": {
|
|
250035
|
+
"kind": "function",
|
|
250036
|
+
"parameters": [
|
|
250037
|
+
{
|
|
250038
|
+
"kind": "parameter",
|
|
250039
|
+
"name": "node",
|
|
250040
|
+
"type": {
|
|
250041
|
+
"kind": "symbol",
|
|
250042
|
+
"name": "ts.Node",
|
|
250043
|
+
"value": "Node"
|
|
250044
|
+
},
|
|
250045
|
+
"required": true,
|
|
250046
|
+
"rest": false,
|
|
250047
|
+
"description": "",
|
|
250048
|
+
"declarations": [
|
|
248841
250049
|
{
|
|
248842
|
-
"
|
|
248843
|
-
"
|
|
248844
|
-
"defaultValue": {
|
|
248845
|
-
"kind": "object",
|
|
248846
|
-
"properties": []
|
|
248847
|
-
},
|
|
248848
|
-
"type": {
|
|
248849
|
-
"kind": "object",
|
|
248850
|
-
"properties": []
|
|
248851
|
-
},
|
|
248852
|
-
"required": true,
|
|
248853
|
-
"description": "",
|
|
248854
|
-
"declarations": [
|
|
248855
|
-
{
|
|
248856
|
-
"name": "variables",
|
|
248857
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248858
|
-
}
|
|
248859
|
-
],
|
|
248860
|
-
"tags": {}
|
|
250050
|
+
"name": "node",
|
|
250051
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248861
250052
|
}
|
|
248862
|
-
]
|
|
250053
|
+
],
|
|
250054
|
+
"tags": {}
|
|
248863
250055
|
},
|
|
248864
|
-
|
|
248865
|
-
"kind": "
|
|
248866
|
-
"name": "
|
|
248867
|
-
"
|
|
250056
|
+
{
|
|
250057
|
+
"kind": "parameter",
|
|
250058
|
+
"name": "context",
|
|
250059
|
+
"type": {
|
|
250060
|
+
"kind": "symbol",
|
|
250061
|
+
"name": "TransformerContext",
|
|
250062
|
+
"value": "TransformerContext"
|
|
250063
|
+
},
|
|
250064
|
+
"required": true,
|
|
250065
|
+
"rest": false,
|
|
250066
|
+
"description": "",
|
|
250067
|
+
"declarations": [
|
|
248868
250068
|
{
|
|
248869
|
-
"
|
|
248870
|
-
"
|
|
248871
|
-
"value": "StyleTransformerOptions"
|
|
250069
|
+
"name": "context",
|
|
250070
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/utils/types.ts"
|
|
248872
250071
|
}
|
|
248873
250072
|
],
|
|
248874
|
-
"
|
|
248875
|
-
},
|
|
248876
|
-
"required": false,
|
|
248877
|
-
"rest": false,
|
|
248878
|
-
"description": "",
|
|
248879
|
-
"declarations": [
|
|
248880
|
-
{
|
|
248881
|
-
"name": "__1",
|
|
248882
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248883
|
-
}
|
|
248884
|
-
],
|
|
248885
|
-
"tags": {}
|
|
248886
|
-
}
|
|
248887
|
-
],
|
|
248888
|
-
"members": [],
|
|
248889
|
-
"returnType": {
|
|
248890
|
-
"kind": "symbol",
|
|
248891
|
-
"name": "ts.TransformerFactory",
|
|
248892
|
-
"typeParameters": [
|
|
248893
|
-
{
|
|
248894
|
-
"kind": "symbol",
|
|
248895
|
-
"name": "ts.SourceFile",
|
|
248896
|
-
"value": "SourceFile"
|
|
250073
|
+
"tags": {}
|
|
248897
250074
|
}
|
|
248898
250075
|
],
|
|
248899
|
-
"
|
|
248900
|
-
|
|
248901
|
-
|
|
248902
|
-
|
|
248903
|
-
{
|
|
248904
|
-
"name": "transform",
|
|
248905
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts",
|
|
248906
|
-
"description": "",
|
|
248907
|
-
"declarations": [
|
|
248908
|
-
{
|
|
248909
|
-
"name": "transform",
|
|
248910
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248911
|
-
}
|
|
248912
|
-
],
|
|
248913
|
-
"tags": {},
|
|
248914
|
-
"type": {
|
|
248915
|
-
"kind": "function",
|
|
248916
|
-
"parameters": [
|
|
248917
|
-
{
|
|
248918
|
-
"kind": "parameter",
|
|
248919
|
-
"name": "program",
|
|
248920
|
-
"type": {
|
|
248921
|
-
"kind": "symbol",
|
|
248922
|
-
"name": "ts.Program",
|
|
248923
|
-
"value": "Program"
|
|
248924
|
-
},
|
|
248925
|
-
"required": true,
|
|
248926
|
-
"rest": false,
|
|
248927
|
-
"description": "",
|
|
248928
|
-
"declarations": [
|
|
248929
|
-
{
|
|
248930
|
-
"name": "program",
|
|
248931
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling-transform/lib/styleTransform.ts"
|
|
248932
|
-
}
|
|
248933
|
-
],
|
|
248934
|
-
"tags": {}
|
|
248935
|
-
},
|
|
248936
|
-
{
|
|
248937
|
-
"kind": "parameter",
|
|
248938
|
-
"name": "fileName",
|
|
248939
|
-
"type": {
|
|
248940
|
-
"kind": "primitive",
|
|
248941
|
-
"value": "string"
|
|
248942
|
-
},
|
|
248943
|
-
"required": true,
|
|
248944
|
-
"rest": false,
|
|
248945
|
-
"description": "",
|
|
248946
|
-
"declarations": [
|
|
250076
|
+
"members": [],
|
|
250077
|
+
"returnType": {
|
|
250078
|
+
"kind": "union",
|
|
250079
|
+
"value": [
|
|
248947
250080
|
{
|
|
248948
|
-
"
|
|
248949
|
-
"
|
|
248950
|
-
|
|
248951
|
-
|
|
248952
|
-
"tags": {}
|
|
248953
|
-
},
|
|
248954
|
-
{
|
|
248955
|
-
"kind": "parameter",
|
|
248956
|
-
"name": "options",
|
|
248957
|
-
"type": {
|
|
248958
|
-
"kind": "symbol",
|
|
248959
|
-
"name": "Partial",
|
|
248960
|
-
"typeParameters": [
|
|
248961
|
-
{
|
|
248962
|
-
"kind": "symbol",
|
|
248963
|
-
"name": "StyleTransformerOptions",
|
|
248964
|
-
"value": "StyleTransformerOptions"
|
|
248965
|
-
}
|
|
248966
|
-
],
|
|
248967
|
-
"value": "Partial<T>"
|
|
248968
|
-
},
|
|
248969
|
-
"required": false,
|
|
248970
|
-
"rest": false,
|
|
248971
|
-
"description": "",
|
|
248972
|
-
"declarations": [
|
|
250081
|
+
"kind": "symbol",
|
|
250082
|
+
"name": "ts.Node",
|
|
250083
|
+
"value": "Node"
|
|
250084
|
+
},
|
|
248973
250085
|
{
|
|
248974
|
-
"
|
|
248975
|
-
"
|
|
250086
|
+
"kind": "primitive",
|
|
250087
|
+
"value": "void"
|
|
248976
250088
|
}
|
|
248977
|
-
]
|
|
248978
|
-
"tags": {}
|
|
250089
|
+
]
|
|
248979
250090
|
}
|
|
248980
|
-
],
|
|
248981
|
-
"members": [],
|
|
248982
|
-
"returnType": {
|
|
248983
|
-
"kind": "primitive",
|
|
248984
|
-
"value": "string"
|
|
248985
250091
|
}
|
|
248986
250092
|
}
|
|
248987
250093
|
},
|
|
@@ -251307,9 +252413,9 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
251307
252413
|
"value": "SerializedStyles"
|
|
251308
252414
|
},
|
|
251309
252415
|
{
|
|
251310
|
-
"kind": "
|
|
251311
|
-
"name": "
|
|
251312
|
-
"
|
|
252416
|
+
"kind": "symbol",
|
|
252417
|
+
"name": "CSSObjectWithVars",
|
|
252418
|
+
"value": "CSSObjectWithVars<CSSObject>"
|
|
251313
252419
|
}
|
|
251314
252420
|
]
|
|
251315
252421
|
},
|
|
@@ -251889,6 +252995,113 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
251889
252995
|
}
|
|
251890
252996
|
}
|
|
251891
252997
|
},
|
|
252998
|
+
{
|
|
252999
|
+
"name": "keyframes",
|
|
253000
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts",
|
|
253001
|
+
"description": "",
|
|
253002
|
+
"declarations": [
|
|
253003
|
+
{
|
|
253004
|
+
"name": "keyframes",
|
|
253005
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
|
|
253006
|
+
}
|
|
253007
|
+
],
|
|
253008
|
+
"tags": {},
|
|
253009
|
+
"type": {
|
|
253010
|
+
"kind": "function",
|
|
253011
|
+
"typeParameters": [
|
|
253012
|
+
{
|
|
253013
|
+
"kind": "typeParameter",
|
|
253014
|
+
"name": "ID",
|
|
253015
|
+
"constraint": {
|
|
253016
|
+
"kind": "primitive",
|
|
253017
|
+
"value": "string"
|
|
253018
|
+
},
|
|
253019
|
+
"required": true
|
|
253020
|
+
}
|
|
253021
|
+
],
|
|
253022
|
+
"parameters": [
|
|
253023
|
+
{
|
|
253024
|
+
"kind": "parameter",
|
|
253025
|
+
"name": "args",
|
|
253026
|
+
"type": {
|
|
253027
|
+
"kind": "array",
|
|
253028
|
+
"value": {
|
|
253029
|
+
"kind": "parenthesis",
|
|
253030
|
+
"value": {
|
|
253031
|
+
"kind": "union",
|
|
253032
|
+
"value": [
|
|
253033
|
+
{
|
|
253034
|
+
"kind": "object",
|
|
253035
|
+
"properties": [
|
|
253036
|
+
{
|
|
253037
|
+
"kind": "property",
|
|
253038
|
+
"name": "name",
|
|
253039
|
+
"required": true,
|
|
253040
|
+
"type": {
|
|
253041
|
+
"kind": "generic",
|
|
253042
|
+
"name": "ID"
|
|
253043
|
+
},
|
|
253044
|
+
"description": "",
|
|
253045
|
+
"declarations": [
|
|
253046
|
+
{
|
|
253047
|
+
"name": "name",
|
|
253048
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
|
|
253049
|
+
}
|
|
253050
|
+
],
|
|
253051
|
+
"tags": {}
|
|
253052
|
+
},
|
|
253053
|
+
{
|
|
253054
|
+
"kind": "property",
|
|
253055
|
+
"name": "styles",
|
|
253056
|
+
"required": true,
|
|
253057
|
+
"type": {
|
|
253058
|
+
"kind": "primitive",
|
|
253059
|
+
"value": "string"
|
|
253060
|
+
},
|
|
253061
|
+
"description": "",
|
|
253062
|
+
"declarations": [
|
|
253063
|
+
{
|
|
253064
|
+
"name": "styles",
|
|
253065
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
|
|
253066
|
+
}
|
|
253067
|
+
],
|
|
253068
|
+
"tags": {}
|
|
253069
|
+
}
|
|
253070
|
+
]
|
|
253071
|
+
},
|
|
253072
|
+
{
|
|
253073
|
+
"kind": "symbol",
|
|
253074
|
+
"name": "StyleProps",
|
|
253075
|
+
"value": "StyleProps"
|
|
253076
|
+
},
|
|
253077
|
+
{
|
|
253078
|
+
"kind": "symbol",
|
|
253079
|
+
"name": "TemplateStringsArray",
|
|
253080
|
+
"value": "TemplateStringsArray"
|
|
253081
|
+
}
|
|
253082
|
+
]
|
|
253083
|
+
}
|
|
253084
|
+
}
|
|
253085
|
+
},
|
|
253086
|
+
"required": true,
|
|
253087
|
+
"rest": true,
|
|
253088
|
+
"description": "",
|
|
253089
|
+
"declarations": [
|
|
253090
|
+
{
|
|
253091
|
+
"name": "args",
|
|
253092
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/cs.ts"
|
|
253093
|
+
}
|
|
253094
|
+
],
|
|
253095
|
+
"tags": {}
|
|
253096
|
+
}
|
|
253097
|
+
],
|
|
253098
|
+
"members": [],
|
|
253099
|
+
"returnType": {
|
|
253100
|
+
"kind": "generic",
|
|
253101
|
+
"name": "ID"
|
|
253102
|
+
}
|
|
253103
|
+
}
|
|
253104
|
+
},
|
|
251892
253105
|
{
|
|
251893
253106
|
"name": "px2rem",
|
|
251894
253107
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/lib/px2rem.ts",
|