@workday/canvas-kit-docs 13.0.0-alpha.1011-next.0 → 13.0.0-alpha.1016-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 +1078 -297
- package/dist/es6/mdx/welcomePage.d.ts.map +1 -1
- package/dist/es6/mdx/welcomePage.js +72 -48
- package/dist/mdx/13.0-UPGRADE-GUIDE.mdx +2 -1
- package/dist/mdx/react/_examples/Tooltips.mdx +15 -0
- package/dist/mdx/react/_examples/examples/Tooltips/ListOfUploadedFiles.tsx +38 -0
- package/dist/mdx/react/menu/examples/Icons.tsx +1 -1
- package/dist/mdx/react/tooltip/Tooltip.mdx +31 -1
- package/dist/mdx/react/tooltip/examples/DescriptionType.tsx +22 -0
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -11032,6 +11032,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
11032
11032
|
],
|
|
11033
11033
|
"tags": {}
|
|
11034
11034
|
},
|
|
11035
|
+
{
|
|
11036
|
+
"kind": "property",
|
|
11037
|
+
"name": "cs",
|
|
11038
|
+
"required": false,
|
|
11039
|
+
"type": {
|
|
11040
|
+
"kind": "symbol",
|
|
11041
|
+
"name": "CSToPropsInput",
|
|
11042
|
+
"value": "CSToPropsInput"
|
|
11043
|
+
},
|
|
11044
|
+
"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```",
|
|
11045
|
+
"declarations": [
|
|
11046
|
+
{
|
|
11047
|
+
"name": "cs",
|
|
11048
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
11049
|
+
}
|
|
11050
|
+
],
|
|
11051
|
+
"tags": {}
|
|
11052
|
+
},
|
|
11035
11053
|
{
|
|
11036
11054
|
"kind": "property",
|
|
11037
11055
|
"name": "as",
|
|
@@ -59114,6 +59132,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
59114
59132
|
"value": false
|
|
59115
59133
|
}
|
|
59116
59134
|
},
|
|
59135
|
+
{
|
|
59136
|
+
"kind": "property",
|
|
59137
|
+
"name": "cs",
|
|
59138
|
+
"required": false,
|
|
59139
|
+
"type": {
|
|
59140
|
+
"kind": "symbol",
|
|
59141
|
+
"name": "CSToPropsInput",
|
|
59142
|
+
"value": "CSToPropsInput"
|
|
59143
|
+
},
|
|
59144
|
+
"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```",
|
|
59145
|
+
"declarations": [
|
|
59146
|
+
{
|
|
59147
|
+
"name": "cs",
|
|
59148
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
59149
|
+
}
|
|
59150
|
+
],
|
|
59151
|
+
"tags": {}
|
|
59152
|
+
},
|
|
59117
59153
|
{
|
|
59118
59154
|
"kind": "property",
|
|
59119
59155
|
"name": "model",
|
|
@@ -190592,6 +190628,604 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
190592
190628
|
"model": "MenuModel"
|
|
190593
190629
|
}
|
|
190594
190630
|
},
|
|
190631
|
+
{
|
|
190632
|
+
"name": "DividerProps",
|
|
190633
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuDivider.tsx",
|
|
190634
|
+
"description": "",
|
|
190635
|
+
"declarations": [
|
|
190636
|
+
{
|
|
190637
|
+
"name": "DividerProps",
|
|
190638
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuDivider.tsx"
|
|
190639
|
+
}
|
|
190640
|
+
],
|
|
190641
|
+
"tags": {},
|
|
190642
|
+
"type": {
|
|
190643
|
+
"kind": "object",
|
|
190644
|
+
"properties": [
|
|
190645
|
+
{
|
|
190646
|
+
"kind": "property",
|
|
190647
|
+
"name": "cs",
|
|
190648
|
+
"required": false,
|
|
190649
|
+
"type": {
|
|
190650
|
+
"kind": "symbol",
|
|
190651
|
+
"name": "CSToPropsInput",
|
|
190652
|
+
"value": "CSToPropsInput"
|
|
190653
|
+
},
|
|
190654
|
+
"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```",
|
|
190655
|
+
"declarations": [
|
|
190656
|
+
{
|
|
190657
|
+
"name": "cs",
|
|
190658
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
190659
|
+
}
|
|
190660
|
+
],
|
|
190661
|
+
"tags": {}
|
|
190662
|
+
}
|
|
190663
|
+
]
|
|
190664
|
+
}
|
|
190665
|
+
},
|
|
190666
|
+
{
|
|
190667
|
+
"name": "menuDividerStencil",
|
|
190668
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuDivider.tsx",
|
|
190669
|
+
"description": "",
|
|
190670
|
+
"declarations": [
|
|
190671
|
+
{
|
|
190672
|
+
"name": "menuDividerStencil",
|
|
190673
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuDivider.tsx"
|
|
190674
|
+
}
|
|
190675
|
+
],
|
|
190676
|
+
"tags": {},
|
|
190677
|
+
"type": {
|
|
190678
|
+
"kind": "function",
|
|
190679
|
+
"parameters": [
|
|
190680
|
+
{
|
|
190681
|
+
"kind": "parameter",
|
|
190682
|
+
"name": "options",
|
|
190683
|
+
"type": {
|
|
190684
|
+
"kind": "conditional",
|
|
190685
|
+
"check": {
|
|
190686
|
+
"kind": "tuple",
|
|
190687
|
+
"value": [
|
|
190688
|
+
{
|
|
190689
|
+
"kind": "symbol",
|
|
190690
|
+
"name": "E",
|
|
190691
|
+
"value": "E"
|
|
190692
|
+
}
|
|
190693
|
+
]
|
|
190694
|
+
},
|
|
190695
|
+
"extends": {
|
|
190696
|
+
"kind": "tuple",
|
|
190697
|
+
"value": [
|
|
190698
|
+
{
|
|
190699
|
+
"kind": "primitive",
|
|
190700
|
+
"value": "never"
|
|
190701
|
+
}
|
|
190702
|
+
]
|
|
190703
|
+
},
|
|
190704
|
+
"trueType": {
|
|
190705
|
+
"kind": "intersection",
|
|
190706
|
+
"value": [
|
|
190707
|
+
{
|
|
190708
|
+
"kind": "symbol",
|
|
190709
|
+
"name": "ModifierValuesStencil",
|
|
190710
|
+
"typeParameters": [
|
|
190711
|
+
{
|
|
190712
|
+
"kind": "symbol",
|
|
190713
|
+
"name": "M",
|
|
190714
|
+
"value": "M"
|
|
190715
|
+
},
|
|
190716
|
+
{
|
|
190717
|
+
"kind": "symbol",
|
|
190718
|
+
"name": "V",
|
|
190719
|
+
"value": "V"
|
|
190720
|
+
}
|
|
190721
|
+
],
|
|
190722
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
190723
|
+
},
|
|
190724
|
+
{
|
|
190725
|
+
"kind": "symbol",
|
|
190726
|
+
"name": "VariableValuesStencil",
|
|
190727
|
+
"typeParameters": [
|
|
190728
|
+
{
|
|
190729
|
+
"kind": "symbol",
|
|
190730
|
+
"name": "V",
|
|
190731
|
+
"value": "V"
|
|
190732
|
+
}
|
|
190733
|
+
],
|
|
190734
|
+
"value": "VariableValuesStencil<V>"
|
|
190735
|
+
}
|
|
190736
|
+
]
|
|
190737
|
+
},
|
|
190738
|
+
"falseType": {
|
|
190739
|
+
"kind": "conditional",
|
|
190740
|
+
"check": {
|
|
190741
|
+
"kind": "symbol",
|
|
190742
|
+
"name": "E",
|
|
190743
|
+
"value": "E"
|
|
190744
|
+
},
|
|
190745
|
+
"extends": {
|
|
190746
|
+
"kind": "symbol",
|
|
190747
|
+
"name": "BaseStencil",
|
|
190748
|
+
"typeParameters": [
|
|
190749
|
+
{
|
|
190750
|
+
"kind": "infer",
|
|
190751
|
+
"value": {
|
|
190752
|
+
"kind": "typeParameter",
|
|
190753
|
+
"name": "ME",
|
|
190754
|
+
"required": true
|
|
190755
|
+
}
|
|
190756
|
+
},
|
|
190757
|
+
{
|
|
190758
|
+
"kind": "infer",
|
|
190759
|
+
"value": {
|
|
190760
|
+
"kind": "typeParameter",
|
|
190761
|
+
"name": "VE",
|
|
190762
|
+
"required": true
|
|
190763
|
+
}
|
|
190764
|
+
},
|
|
190765
|
+
{
|
|
190766
|
+
"kind": "primitive",
|
|
190767
|
+
"value": "any"
|
|
190768
|
+
},
|
|
190769
|
+
{
|
|
190770
|
+
"kind": "primitive",
|
|
190771
|
+
"value": "any"
|
|
190772
|
+
}
|
|
190773
|
+
],
|
|
190774
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
190775
|
+
},
|
|
190776
|
+
"trueType": {
|
|
190777
|
+
"kind": "intersection",
|
|
190778
|
+
"value": [
|
|
190779
|
+
{
|
|
190780
|
+
"kind": "symbol",
|
|
190781
|
+
"name": "ModifierValuesStencil",
|
|
190782
|
+
"typeParameters": [
|
|
190783
|
+
{
|
|
190784
|
+
"kind": "intersection",
|
|
190785
|
+
"value": [
|
|
190786
|
+
{
|
|
190787
|
+
"kind": "symbol",
|
|
190788
|
+
"name": "ME",
|
|
190789
|
+
"value": "ME"
|
|
190790
|
+
},
|
|
190791
|
+
{
|
|
190792
|
+
"kind": "symbol",
|
|
190793
|
+
"name": "M",
|
|
190794
|
+
"value": "M"
|
|
190795
|
+
}
|
|
190796
|
+
]
|
|
190797
|
+
}
|
|
190798
|
+
],
|
|
190799
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
190800
|
+
},
|
|
190801
|
+
{
|
|
190802
|
+
"kind": "symbol",
|
|
190803
|
+
"name": "VariableValuesStencil",
|
|
190804
|
+
"typeParameters": [
|
|
190805
|
+
{
|
|
190806
|
+
"kind": "intersection",
|
|
190807
|
+
"value": [
|
|
190808
|
+
{
|
|
190809
|
+
"kind": "symbol",
|
|
190810
|
+
"name": "VE",
|
|
190811
|
+
"value": "VE"
|
|
190812
|
+
},
|
|
190813
|
+
{
|
|
190814
|
+
"kind": "symbol",
|
|
190815
|
+
"name": "V",
|
|
190816
|
+
"value": "V"
|
|
190817
|
+
}
|
|
190818
|
+
]
|
|
190819
|
+
}
|
|
190820
|
+
],
|
|
190821
|
+
"value": "VariableValuesStencil<V>"
|
|
190822
|
+
}
|
|
190823
|
+
]
|
|
190824
|
+
},
|
|
190825
|
+
"falseType": {
|
|
190826
|
+
"kind": "primitive",
|
|
190827
|
+
"value": "never"
|
|
190828
|
+
}
|
|
190829
|
+
}
|
|
190830
|
+
},
|
|
190831
|
+
"required": false,
|
|
190832
|
+
"rest": false,
|
|
190833
|
+
"description": "",
|
|
190834
|
+
"declarations": [
|
|
190835
|
+
{
|
|
190836
|
+
"name": "options",
|
|
190837
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
190838
|
+
}
|
|
190839
|
+
],
|
|
190840
|
+
"tags": {}
|
|
190841
|
+
}
|
|
190842
|
+
],
|
|
190843
|
+
"members": [
|
|
190844
|
+
{
|
|
190845
|
+
"kind": "property",
|
|
190846
|
+
"name": "vars",
|
|
190847
|
+
"required": true,
|
|
190848
|
+
"type": {
|
|
190849
|
+
"kind": "symbol",
|
|
190850
|
+
"name": "StencilDefaultVars",
|
|
190851
|
+
"typeParameters": [
|
|
190852
|
+
{
|
|
190853
|
+
"kind": "symbol",
|
|
190854
|
+
"name": "V",
|
|
190855
|
+
"value": "V"
|
|
190856
|
+
},
|
|
190857
|
+
{
|
|
190858
|
+
"kind": "symbol",
|
|
190859
|
+
"name": "E",
|
|
190860
|
+
"value": "E"
|
|
190861
|
+
},
|
|
190862
|
+
{
|
|
190863
|
+
"kind": "symbol",
|
|
190864
|
+
"name": "ID",
|
|
190865
|
+
"value": "ID"
|
|
190866
|
+
}
|
|
190867
|
+
],
|
|
190868
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
190869
|
+
},
|
|
190870
|
+
"description": "",
|
|
190871
|
+
"declarations": [
|
|
190872
|
+
{
|
|
190873
|
+
"name": "vars",
|
|
190874
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
190875
|
+
}
|
|
190876
|
+
],
|
|
190877
|
+
"tags": {}
|
|
190878
|
+
},
|
|
190879
|
+
{
|
|
190880
|
+
"kind": "property",
|
|
190881
|
+
"name": "base",
|
|
190882
|
+
"required": true,
|
|
190883
|
+
"type": {
|
|
190884
|
+
"kind": "primitive",
|
|
190885
|
+
"value": "string"
|
|
190886
|
+
},
|
|
190887
|
+
"description": "",
|
|
190888
|
+
"declarations": [
|
|
190889
|
+
{
|
|
190890
|
+
"name": "base",
|
|
190891
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
190892
|
+
}
|
|
190893
|
+
],
|
|
190894
|
+
"tags": {}
|
|
190895
|
+
},
|
|
190896
|
+
{
|
|
190897
|
+
"kind": "property",
|
|
190898
|
+
"name": "modifiers",
|
|
190899
|
+
"required": true,
|
|
190900
|
+
"type": {
|
|
190901
|
+
"kind": "conditional",
|
|
190902
|
+
"check": {
|
|
190903
|
+
"kind": "tuple",
|
|
190904
|
+
"value": [
|
|
190905
|
+
{
|
|
190906
|
+
"kind": "symbol",
|
|
190907
|
+
"name": "E",
|
|
190908
|
+
"value": "E"
|
|
190909
|
+
}
|
|
190910
|
+
]
|
|
190911
|
+
},
|
|
190912
|
+
"extends": {
|
|
190913
|
+
"kind": "tuple",
|
|
190914
|
+
"value": [
|
|
190915
|
+
{
|
|
190916
|
+
"kind": "symbol",
|
|
190917
|
+
"name": "BaseStencil",
|
|
190918
|
+
"typeParameters": [
|
|
190919
|
+
{
|
|
190920
|
+
"kind": "infer",
|
|
190921
|
+
"value": {
|
|
190922
|
+
"kind": "typeParameter",
|
|
190923
|
+
"name": "ME",
|
|
190924
|
+
"required": true
|
|
190925
|
+
}
|
|
190926
|
+
},
|
|
190927
|
+
{
|
|
190928
|
+
"kind": "infer",
|
|
190929
|
+
"value": {
|
|
190930
|
+
"kind": "typeParameter",
|
|
190931
|
+
"name": "VE",
|
|
190932
|
+
"required": true
|
|
190933
|
+
}
|
|
190934
|
+
},
|
|
190935
|
+
{
|
|
190936
|
+
"kind": "primitive",
|
|
190937
|
+
"value": "any"
|
|
190938
|
+
},
|
|
190939
|
+
{
|
|
190940
|
+
"kind": "primitive",
|
|
190941
|
+
"value": "any"
|
|
190942
|
+
}
|
|
190943
|
+
],
|
|
190944
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
190945
|
+
}
|
|
190946
|
+
]
|
|
190947
|
+
},
|
|
190948
|
+
"trueType": {
|
|
190949
|
+
"kind": "symbol",
|
|
190950
|
+
"name": "StencilModifierReturn",
|
|
190951
|
+
"typeParameters": [
|
|
190952
|
+
{
|
|
190953
|
+
"kind": "intersection",
|
|
190954
|
+
"value": [
|
|
190955
|
+
{
|
|
190956
|
+
"kind": "symbol",
|
|
190957
|
+
"name": "ME",
|
|
190958
|
+
"value": "ME"
|
|
190959
|
+
},
|
|
190960
|
+
{
|
|
190961
|
+
"kind": "symbol",
|
|
190962
|
+
"name": "M",
|
|
190963
|
+
"value": "M"
|
|
190964
|
+
}
|
|
190965
|
+
]
|
|
190966
|
+
},
|
|
190967
|
+
{
|
|
190968
|
+
"kind": "intersection",
|
|
190969
|
+
"value": [
|
|
190970
|
+
{
|
|
190971
|
+
"kind": "symbol",
|
|
190972
|
+
"name": "VE",
|
|
190973
|
+
"value": "VE"
|
|
190974
|
+
},
|
|
190975
|
+
{
|
|
190976
|
+
"kind": "symbol",
|
|
190977
|
+
"name": "V",
|
|
190978
|
+
"value": "V"
|
|
190979
|
+
}
|
|
190980
|
+
]
|
|
190981
|
+
}
|
|
190982
|
+
],
|
|
190983
|
+
"value": "StencilModifierReturn<M, V>"
|
|
190984
|
+
},
|
|
190985
|
+
"falseType": {
|
|
190986
|
+
"kind": "symbol",
|
|
190987
|
+
"name": "StencilModifierReturn",
|
|
190988
|
+
"typeParameters": [
|
|
190989
|
+
{
|
|
190990
|
+
"kind": "symbol",
|
|
190991
|
+
"name": "M",
|
|
190992
|
+
"value": "M"
|
|
190993
|
+
},
|
|
190994
|
+
{
|
|
190995
|
+
"kind": "symbol",
|
|
190996
|
+
"name": "V",
|
|
190997
|
+
"value": "V"
|
|
190998
|
+
}
|
|
190999
|
+
],
|
|
191000
|
+
"value": "StencilModifierReturn<M, V>"
|
|
191001
|
+
}
|
|
191002
|
+
},
|
|
191003
|
+
"description": "",
|
|
191004
|
+
"declarations": [
|
|
191005
|
+
{
|
|
191006
|
+
"name": "modifiers",
|
|
191007
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191008
|
+
}
|
|
191009
|
+
],
|
|
191010
|
+
"tags": {}
|
|
191011
|
+
},
|
|
191012
|
+
{
|
|
191013
|
+
"kind": "property",
|
|
191014
|
+
"name": "defaultModifiers",
|
|
191015
|
+
"required": true,
|
|
191016
|
+
"type": {
|
|
191017
|
+
"kind": "conditional",
|
|
191018
|
+
"check": {
|
|
191019
|
+
"kind": "tuple",
|
|
191020
|
+
"value": [
|
|
191021
|
+
{
|
|
191022
|
+
"kind": "symbol",
|
|
191023
|
+
"name": "E",
|
|
191024
|
+
"value": "E"
|
|
191025
|
+
}
|
|
191026
|
+
]
|
|
191027
|
+
},
|
|
191028
|
+
"extends": {
|
|
191029
|
+
"kind": "tuple",
|
|
191030
|
+
"value": [
|
|
191031
|
+
{
|
|
191032
|
+
"kind": "symbol",
|
|
191033
|
+
"name": "BaseStencil",
|
|
191034
|
+
"typeParameters": [
|
|
191035
|
+
{
|
|
191036
|
+
"kind": "infer",
|
|
191037
|
+
"value": {
|
|
191038
|
+
"kind": "typeParameter",
|
|
191039
|
+
"name": "ME",
|
|
191040
|
+
"required": true
|
|
191041
|
+
}
|
|
191042
|
+
},
|
|
191043
|
+
{
|
|
191044
|
+
"kind": "primitive",
|
|
191045
|
+
"value": "any"
|
|
191046
|
+
},
|
|
191047
|
+
{
|
|
191048
|
+
"kind": "primitive",
|
|
191049
|
+
"value": "any"
|
|
191050
|
+
},
|
|
191051
|
+
{
|
|
191052
|
+
"kind": "primitive",
|
|
191053
|
+
"value": "any"
|
|
191054
|
+
}
|
|
191055
|
+
],
|
|
191056
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
191057
|
+
}
|
|
191058
|
+
]
|
|
191059
|
+
},
|
|
191060
|
+
"trueType": {
|
|
191061
|
+
"kind": "symbol",
|
|
191062
|
+
"name": "StencilDefaultModifierReturn",
|
|
191063
|
+
"typeParameters": [
|
|
191064
|
+
{
|
|
191065
|
+
"kind": "intersection",
|
|
191066
|
+
"value": [
|
|
191067
|
+
{
|
|
191068
|
+
"kind": "symbol",
|
|
191069
|
+
"name": "ME",
|
|
191070
|
+
"value": "ME"
|
|
191071
|
+
},
|
|
191072
|
+
{
|
|
191073
|
+
"kind": "symbol",
|
|
191074
|
+
"name": "M",
|
|
191075
|
+
"value": "M"
|
|
191076
|
+
}
|
|
191077
|
+
]
|
|
191078
|
+
}
|
|
191079
|
+
],
|
|
191080
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
191081
|
+
},
|
|
191082
|
+
"falseType": {
|
|
191083
|
+
"kind": "symbol",
|
|
191084
|
+
"name": "StencilDefaultModifierReturn",
|
|
191085
|
+
"typeParameters": [
|
|
191086
|
+
{
|
|
191087
|
+
"kind": "symbol",
|
|
191088
|
+
"name": "M",
|
|
191089
|
+
"value": "M"
|
|
191090
|
+
}
|
|
191091
|
+
],
|
|
191092
|
+
"value": "StencilDefaultModifierReturn<M>"
|
|
191093
|
+
}
|
|
191094
|
+
},
|
|
191095
|
+
"description": "",
|
|
191096
|
+
"declarations": [
|
|
191097
|
+
{
|
|
191098
|
+
"name": "defaultModifiers",
|
|
191099
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191100
|
+
}
|
|
191101
|
+
],
|
|
191102
|
+
"tags": {}
|
|
191103
|
+
},
|
|
191104
|
+
{
|
|
191105
|
+
"kind": "property",
|
|
191106
|
+
"name": "__extends",
|
|
191107
|
+
"required": false,
|
|
191108
|
+
"type": {
|
|
191109
|
+
"kind": "symbol",
|
|
191110
|
+
"name": "E",
|
|
191111
|
+
"value": "E"
|
|
191112
|
+
},
|
|
191113
|
+
"description": "",
|
|
191114
|
+
"declarations": [
|
|
191115
|
+
{
|
|
191116
|
+
"name": "__extends",
|
|
191117
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191118
|
+
}
|
|
191119
|
+
],
|
|
191120
|
+
"tags": {}
|
|
191121
|
+
},
|
|
191122
|
+
{
|
|
191123
|
+
"kind": "property",
|
|
191124
|
+
"name": "__vars",
|
|
191125
|
+
"required": true,
|
|
191126
|
+
"type": {
|
|
191127
|
+
"kind": "symbol",
|
|
191128
|
+
"name": "V",
|
|
191129
|
+
"value": "V"
|
|
191130
|
+
},
|
|
191131
|
+
"description": "",
|
|
191132
|
+
"declarations": [
|
|
191133
|
+
{
|
|
191134
|
+
"name": "__vars",
|
|
191135
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191136
|
+
}
|
|
191137
|
+
],
|
|
191138
|
+
"tags": {}
|
|
191139
|
+
},
|
|
191140
|
+
{
|
|
191141
|
+
"kind": "property",
|
|
191142
|
+
"name": "__modifiers",
|
|
191143
|
+
"required": true,
|
|
191144
|
+
"type": {
|
|
191145
|
+
"kind": "symbol",
|
|
191146
|
+
"name": "M",
|
|
191147
|
+
"value": "M"
|
|
191148
|
+
},
|
|
191149
|
+
"description": "",
|
|
191150
|
+
"declarations": [
|
|
191151
|
+
{
|
|
191152
|
+
"name": "__modifiers",
|
|
191153
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191154
|
+
}
|
|
191155
|
+
],
|
|
191156
|
+
"tags": {}
|
|
191157
|
+
},
|
|
191158
|
+
{
|
|
191159
|
+
"kind": "property",
|
|
191160
|
+
"name": "__id",
|
|
191161
|
+
"required": true,
|
|
191162
|
+
"type": {
|
|
191163
|
+
"kind": "symbol",
|
|
191164
|
+
"name": "ID",
|
|
191165
|
+
"value": "ID"
|
|
191166
|
+
},
|
|
191167
|
+
"description": "",
|
|
191168
|
+
"declarations": [
|
|
191169
|
+
{
|
|
191170
|
+
"name": "__id",
|
|
191171
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191172
|
+
}
|
|
191173
|
+
],
|
|
191174
|
+
"tags": {}
|
|
191175
|
+
}
|
|
191176
|
+
],
|
|
191177
|
+
"returnType": {
|
|
191178
|
+
"kind": "object",
|
|
191179
|
+
"properties": [
|
|
191180
|
+
{
|
|
191181
|
+
"kind": "property",
|
|
191182
|
+
"name": "className",
|
|
191183
|
+
"required": true,
|
|
191184
|
+
"type": {
|
|
191185
|
+
"kind": "primitive",
|
|
191186
|
+
"value": "string"
|
|
191187
|
+
},
|
|
191188
|
+
"description": "",
|
|
191189
|
+
"declarations": [
|
|
191190
|
+
{
|
|
191191
|
+
"name": "className",
|
|
191192
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191193
|
+
}
|
|
191194
|
+
],
|
|
191195
|
+
"tags": {}
|
|
191196
|
+
},
|
|
191197
|
+
{
|
|
191198
|
+
"kind": "property",
|
|
191199
|
+
"name": "style",
|
|
191200
|
+
"required": false,
|
|
191201
|
+
"type": {
|
|
191202
|
+
"kind": "external",
|
|
191203
|
+
"name": "Record",
|
|
191204
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
191205
|
+
"typeParameters": [
|
|
191206
|
+
{
|
|
191207
|
+
"kind": "primitive",
|
|
191208
|
+
"value": "string"
|
|
191209
|
+
},
|
|
191210
|
+
{
|
|
191211
|
+
"kind": "primitive",
|
|
191212
|
+
"value": "string"
|
|
191213
|
+
}
|
|
191214
|
+
]
|
|
191215
|
+
},
|
|
191216
|
+
"description": "",
|
|
191217
|
+
"declarations": [
|
|
191218
|
+
{
|
|
191219
|
+
"name": "style",
|
|
191220
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191221
|
+
}
|
|
191222
|
+
],
|
|
191223
|
+
"tags": {}
|
|
191224
|
+
}
|
|
191225
|
+
]
|
|
191226
|
+
}
|
|
191227
|
+
}
|
|
191228
|
+
},
|
|
190595
191229
|
{
|
|
190596
191230
|
"name": "MenuDivider",
|
|
190597
191231
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuDivider.tsx",
|
|
@@ -190608,6 +191242,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
190608
191242
|
"componentType": "regular",
|
|
190609
191243
|
"displayName": "Menu.Divider",
|
|
190610
191244
|
"props": [
|
|
191245
|
+
{
|
|
191246
|
+
"kind": "property",
|
|
191247
|
+
"name": "cs",
|
|
191248
|
+
"required": false,
|
|
191249
|
+
"type": {
|
|
191250
|
+
"kind": "symbol",
|
|
191251
|
+
"name": "CSToPropsInput",
|
|
191252
|
+
"value": "CSToPropsInput"
|
|
191253
|
+
},
|
|
191254
|
+
"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```",
|
|
191255
|
+
"declarations": [
|
|
191256
|
+
{
|
|
191257
|
+
"name": "cs",
|
|
191258
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
191259
|
+
}
|
|
191260
|
+
],
|
|
191261
|
+
"tags": {}
|
|
191262
|
+
},
|
|
190611
191263
|
{
|
|
190612
191264
|
"kind": "property",
|
|
190613
191265
|
"name": "children",
|
|
@@ -191357,6 +192009,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
191357
192009
|
"value": false
|
|
191358
192010
|
}
|
|
191359
192011
|
},
|
|
192012
|
+
{
|
|
192013
|
+
"kind": "property",
|
|
192014
|
+
"name": "cs",
|
|
192015
|
+
"required": false,
|
|
192016
|
+
"type": {
|
|
192017
|
+
"kind": "symbol",
|
|
192018
|
+
"name": "CSToPropsInput",
|
|
192019
|
+
"value": "CSToPropsInput"
|
|
192020
|
+
},
|
|
192021
|
+
"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```",
|
|
192022
|
+
"declarations": [
|
|
192023
|
+
{
|
|
192024
|
+
"name": "cs",
|
|
192025
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
192026
|
+
}
|
|
192027
|
+
],
|
|
192028
|
+
"tags": {}
|
|
192029
|
+
},
|
|
191360
192030
|
{
|
|
191361
192031
|
"kind": "property",
|
|
191362
192032
|
"name": "as",
|
|
@@ -191731,6 +192401,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
191731
192401
|
"value": false
|
|
191732
192402
|
}
|
|
191733
192403
|
},
|
|
192404
|
+
{
|
|
192405
|
+
"kind": "property",
|
|
192406
|
+
"name": "cs",
|
|
192407
|
+
"required": false,
|
|
192408
|
+
"type": {
|
|
192409
|
+
"kind": "symbol",
|
|
192410
|
+
"name": "CSToPropsInput",
|
|
192411
|
+
"value": "CSToPropsInput"
|
|
192412
|
+
},
|
|
192413
|
+
"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```",
|
|
192414
|
+
"declarations": [
|
|
192415
|
+
{
|
|
192416
|
+
"name": "cs",
|
|
192417
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
192418
|
+
}
|
|
192419
|
+
],
|
|
192420
|
+
"tags": {}
|
|
192421
|
+
},
|
|
191734
192422
|
{
|
|
191735
192423
|
"kind": "property",
|
|
191736
192424
|
"name": "as",
|
|
@@ -193980,305 +194668,341 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
193980
194668
|
},
|
|
193981
194669
|
{
|
|
193982
194670
|
"kind": "property",
|
|
193983
|
-
"name": "
|
|
193984
|
-
"
|
|
193985
|
-
"
|
|
193986
|
-
|
|
193987
|
-
|
|
193988
|
-
"
|
|
193989
|
-
|
|
193990
|
-
|
|
193991
|
-
|
|
193992
|
-
|
|
193993
|
-
|
|
193994
|
-
|
|
193995
|
-
|
|
193996
|
-
|
|
193997
|
-
|
|
193998
|
-
|
|
193999
|
-
|
|
194000
|
-
"
|
|
194001
|
-
"
|
|
194002
|
-
"
|
|
194003
|
-
"
|
|
194004
|
-
"
|
|
194005
|
-
|
|
194006
|
-
"
|
|
194007
|
-
"
|
|
194008
|
-
"
|
|
194009
|
-
|
|
194010
|
-
|
|
194011
|
-
|
|
194012
|
-
|
|
194013
|
-
|
|
194014
|
-
|
|
194015
|
-
|
|
194016
|
-
|
|
194017
|
-
|
|
194018
|
-
|
|
194019
|
-
|
|
194020
|
-
}
|
|
194021
|
-
|
|
194022
|
-
|
|
194023
|
-
|
|
194024
|
-
|
|
194025
|
-
|
|
194026
|
-
|
|
194027
|
-
|
|
194028
|
-
|
|
194029
|
-
|
|
194030
|
-
|
|
194031
|
-
|
|
194032
|
-
|
|
194033
|
-
|
|
194034
|
-
|
|
194035
|
-
|
|
194036
|
-
|
|
194037
|
-
|
|
194038
|
-
|
|
194039
|
-
|
|
194040
|
-
|
|
194041
|
-
|
|
194042
|
-
|
|
194043
|
-
|
|
194044
|
-
"
|
|
194045
|
-
|
|
194046
|
-
|
|
194047
|
-
|
|
194048
|
-
|
|
194049
|
-
|
|
194050
|
-
|
|
194051
|
-
|
|
194052
|
-
|
|
194053
|
-
|
|
194054
|
-
|
|
194055
|
-
|
|
194056
|
-
|
|
194057
|
-
|
|
194058
|
-
|
|
194059
|
-
|
|
194060
|
-
|
|
194061
|
-
|
|
194062
|
-
|
|
194063
|
-
|
|
194064
|
-
|
|
194065
|
-
|
|
194066
|
-
|
|
194067
|
-
|
|
194068
|
-
|
|
194069
|
-
|
|
194070
|
-
|
|
194071
|
-
|
|
194072
|
-
|
|
194073
|
-
|
|
194074
|
-
|
|
194075
|
-
|
|
194076
|
-
|
|
194077
|
-
|
|
194078
|
-
|
|
194079
|
-
|
|
194080
|
-
|
|
194081
|
-
|
|
194082
|
-
|
|
194083
|
-
|
|
194084
|
-
|
|
194085
|
-
|
|
194086
|
-
|
|
194087
|
-
|
|
194088
|
-
|
|
194089
|
-
|
|
194090
|
-
|
|
194091
|
-
|
|
194092
|
-
|
|
194093
|
-
|
|
194094
|
-
|
|
194095
|
-
|
|
194096
|
-
|
|
194097
|
-
|
|
194098
|
-
|
|
194099
|
-
|
|
194100
|
-
|
|
194101
|
-
|
|
194102
|
-
|
|
194103
|
-
|
|
194104
|
-
|
|
194105
|
-
|
|
194106
|
-
|
|
194107
|
-
|
|
194108
|
-
|
|
194109
|
-
|
|
194110
|
-
|
|
194111
|
-
|
|
194112
|
-
|
|
194113
|
-
|
|
194114
|
-
|
|
194115
|
-
|
|
194116
|
-
|
|
194117
|
-
|
|
194118
|
-
|
|
194119
|
-
|
|
194120
|
-
|
|
194121
|
-
|
|
194122
|
-
"
|
|
194123
|
-
"
|
|
194124
|
-
"
|
|
194125
|
-
},
|
|
194126
|
-
|
|
194127
|
-
|
|
194128
|
-
|
|
194129
|
-
|
|
194130
|
-
|
|
194131
|
-
|
|
194132
|
-
|
|
194133
|
-
|
|
194134
|
-
"
|
|
194135
|
-
"
|
|
194136
|
-
"
|
|
194137
|
-
|
|
194138
|
-
|
|
194139
|
-
|
|
194140
|
-
"
|
|
194141
|
-
"
|
|
194142
|
-
"
|
|
194143
|
-
|
|
194144
|
-
|
|
194145
|
-
|
|
194146
|
-
|
|
194147
|
-
|
|
194148
|
-
|
|
194149
|
-
|
|
194150
|
-
|
|
194151
|
-
|
|
194152
|
-
|
|
194153
|
-
|
|
194154
|
-
|
|
194155
|
-
|
|
194156
|
-
|
|
194157
|
-
|
|
194158
|
-
|
|
194159
|
-
|
|
194160
|
-
|
|
194161
|
-
|
|
194162
|
-
|
|
194163
|
-
|
|
194164
|
-
|
|
194165
|
-
|
|
194166
|
-
|
|
194167
|
-
|
|
194168
|
-
|
|
194169
|
-
|
|
194170
|
-
|
|
194171
|
-
|
|
194172
|
-
|
|
194173
|
-
|
|
194174
|
-
|
|
194175
|
-
|
|
194176
|
-
|
|
194177
|
-
|
|
194178
|
-
|
|
194179
|
-
|
|
194180
|
-
|
|
194181
|
-
|
|
194182
|
-
|
|
194183
|
-
|
|
194184
|
-
|
|
194185
|
-
|
|
194186
|
-
|
|
194187
|
-
|
|
194188
|
-
|
|
194189
|
-
|
|
194190
|
-
|
|
194191
|
-
|
|
194192
|
-
|
|
194193
|
-
|
|
194194
|
-
|
|
194195
|
-
|
|
194196
|
-
|
|
194197
|
-
|
|
194198
|
-
|
|
194199
|
-
|
|
194200
|
-
|
|
194201
|
-
|
|
194202
|
-
|
|
194203
|
-
|
|
194204
|
-
|
|
194205
|
-
|
|
194206
|
-
|
|
194207
|
-
|
|
194208
|
-
|
|
194209
|
-
|
|
194210
|
-
|
|
194211
|
-
|
|
194212
|
-
|
|
194213
|
-
|
|
194214
|
-
|
|
194215
|
-
|
|
194216
|
-
|
|
194217
|
-
|
|
194218
|
-
|
|
194219
|
-
|
|
194220
|
-
|
|
194221
|
-
|
|
194222
|
-
|
|
194223
|
-
|
|
194224
|
-
|
|
194225
|
-
|
|
194226
|
-
|
|
194227
|
-
|
|
194228
|
-
|
|
194229
|
-
|
|
194230
|
-
|
|
194231
|
-
|
|
194232
|
-
|
|
194233
|
-
|
|
194234
|
-
|
|
194235
|
-
|
|
194236
|
-
"
|
|
194237
|
-
"
|
|
194238
|
-
"
|
|
194239
|
-
|
|
194240
|
-
"
|
|
194241
|
-
"
|
|
194242
|
-
},
|
|
194243
|
-
"description": "
|
|
194244
|
-
"declarations": [
|
|
194245
|
-
{
|
|
194246
|
-
"name": "
|
|
194247
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194248
|
-
}
|
|
194249
|
-
],
|
|
194250
|
-
"tags": {}
|
|
194251
|
-
},
|
|
194252
|
-
{
|
|
194253
|
-
"kind": "property",
|
|
194254
|
-
"name": "
|
|
194255
|
-
"required": false,
|
|
194256
|
-
"type": {
|
|
194257
|
-
"kind": "
|
|
194258
|
-
"
|
|
194259
|
-
|
|
194260
|
-
|
|
194261
|
-
"
|
|
194262
|
-
|
|
194263
|
-
|
|
194264
|
-
"
|
|
194265
|
-
|
|
194266
|
-
|
|
194267
|
-
|
|
194268
|
-
|
|
194269
|
-
|
|
194270
|
-
|
|
194271
|
-
"
|
|
194671
|
+
"name": "cs",
|
|
194672
|
+
"required": false,
|
|
194673
|
+
"type": {
|
|
194674
|
+
"kind": "symbol",
|
|
194675
|
+
"name": "CSToPropsInput",
|
|
194676
|
+
"value": "CSToPropsInput"
|
|
194677
|
+
},
|
|
194678
|
+
"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```",
|
|
194679
|
+
"declarations": [
|
|
194680
|
+
{
|
|
194681
|
+
"name": "cs",
|
|
194682
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
194683
|
+
}
|
|
194684
|
+
],
|
|
194685
|
+
"tags": {}
|
|
194686
|
+
},
|
|
194687
|
+
{
|
|
194688
|
+
"kind": "property",
|
|
194689
|
+
"name": "as",
|
|
194690
|
+
"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.",
|
|
194691
|
+
"tags": {},
|
|
194692
|
+
"declarations": [],
|
|
194693
|
+
"type": {
|
|
194694
|
+
"kind": "external",
|
|
194695
|
+
"name": "React.ElementType",
|
|
194696
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
194697
|
+
},
|
|
194698
|
+
"defaultValue": {
|
|
194699
|
+
"kind": "external",
|
|
194700
|
+
"name": "button",
|
|
194701
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
|
|
194702
|
+
}
|
|
194703
|
+
},
|
|
194704
|
+
{
|
|
194705
|
+
"kind": "property",
|
|
194706
|
+
"name": "ref",
|
|
194707
|
+
"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`).",
|
|
194708
|
+
"tags": {},
|
|
194709
|
+
"declarations": [],
|
|
194710
|
+
"type": {
|
|
194711
|
+
"kind": "external",
|
|
194712
|
+
"name": "React.Ref",
|
|
194713
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
194714
|
+
"typeParameters": [
|
|
194715
|
+
{
|
|
194716
|
+
"kind": "typeParameter",
|
|
194717
|
+
"name": "R",
|
|
194718
|
+
"required": true,
|
|
194719
|
+
"defaultValue": {
|
|
194720
|
+
"kind": "external",
|
|
194721
|
+
"name": "button",
|
|
194722
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
|
|
194723
|
+
}
|
|
194724
|
+
}
|
|
194725
|
+
]
|
|
194726
|
+
}
|
|
194727
|
+
}
|
|
194728
|
+
],
|
|
194729
|
+
"baseElement": {
|
|
194730
|
+
"kind": "external",
|
|
194731
|
+
"name": "button",
|
|
194732
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button"
|
|
194733
|
+
}
|
|
194734
|
+
}
|
|
194735
|
+
},
|
|
194736
|
+
{
|
|
194737
|
+
"name": "useMenuOption",
|
|
194738
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx",
|
|
194739
|
+
"description": "",
|
|
194740
|
+
"declarations": [
|
|
194741
|
+
{
|
|
194742
|
+
"name": "useMenuOption",
|
|
194743
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194744
|
+
}
|
|
194745
|
+
],
|
|
194746
|
+
"tags": {},
|
|
194747
|
+
"type": {
|
|
194748
|
+
"kind": "callExpression",
|
|
194749
|
+
"name": {
|
|
194750
|
+
"kind": "symbol",
|
|
194751
|
+
"name": "composeHooks"
|
|
194752
|
+
},
|
|
194753
|
+
"parameters": [
|
|
194754
|
+
{
|
|
194755
|
+
"kind": "function",
|
|
194756
|
+
"name": {
|
|
194757
|
+
"kind": "symbol",
|
|
194758
|
+
"name": "createElemPropsHook"
|
|
194759
|
+
},
|
|
194760
|
+
"parameters": [
|
|
194761
|
+
{
|
|
194762
|
+
"kind": "parameter",
|
|
194763
|
+
"name": "model",
|
|
194764
|
+
"description": "",
|
|
194765
|
+
"tags": {},
|
|
194766
|
+
"declarations": [],
|
|
194767
|
+
"type": {
|
|
194768
|
+
"kind": "symbol",
|
|
194769
|
+
"name": "MenuModel"
|
|
194770
|
+
},
|
|
194771
|
+
"required": true
|
|
194772
|
+
},
|
|
194773
|
+
{
|
|
194774
|
+
"kind": "parameter",
|
|
194775
|
+
"name": "elemProps",
|
|
194776
|
+
"description": "",
|
|
194777
|
+
"tags": {},
|
|
194778
|
+
"declarations": [],
|
|
194779
|
+
"type": {
|
|
194780
|
+
"kind": "object",
|
|
194781
|
+
"properties": [
|
|
194782
|
+
{
|
|
194783
|
+
"kind": "property",
|
|
194784
|
+
"name": "data-id",
|
|
194785
|
+
"required": false,
|
|
194786
|
+
"type": {
|
|
194787
|
+
"kind": "primitive",
|
|
194788
|
+
"value": "string"
|
|
194789
|
+
},
|
|
194790
|
+
"description": "",
|
|
194791
|
+
"declarations": [
|
|
194792
|
+
{
|
|
194793
|
+
"name": "data-id",
|
|
194794
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194795
|
+
}
|
|
194796
|
+
],
|
|
194797
|
+
"tags": {}
|
|
194798
|
+
}
|
|
194799
|
+
]
|
|
194800
|
+
},
|
|
194801
|
+
"required": false
|
|
194802
|
+
},
|
|
194803
|
+
{
|
|
194804
|
+
"kind": "parameter",
|
|
194805
|
+
"name": "ref",
|
|
194806
|
+
"description": "",
|
|
194807
|
+
"tags": {},
|
|
194808
|
+
"declarations": [],
|
|
194809
|
+
"type": {
|
|
194810
|
+
"kind": "external",
|
|
194811
|
+
"name": "React.Ref",
|
|
194812
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html"
|
|
194813
|
+
},
|
|
194814
|
+
"required": false
|
|
194815
|
+
}
|
|
194816
|
+
],
|
|
194817
|
+
"returnType": {
|
|
194818
|
+
"kind": "object",
|
|
194819
|
+
"properties": [
|
|
194820
|
+
{
|
|
194821
|
+
"kind": "property",
|
|
194822
|
+
"name": "role",
|
|
194823
|
+
"required": true,
|
|
194824
|
+
"type": {
|
|
194825
|
+
"kind": "string",
|
|
194826
|
+
"value": "option"
|
|
194827
|
+
},
|
|
194828
|
+
"description": "",
|
|
194829
|
+
"tags": {},
|
|
194830
|
+
"declarations": []
|
|
194831
|
+
},
|
|
194832
|
+
{
|
|
194833
|
+
"kind": "property",
|
|
194834
|
+
"name": "aria-selected",
|
|
194835
|
+
"required": true,
|
|
194836
|
+
"type": {
|
|
194837
|
+
"kind": "primitive",
|
|
194838
|
+
"value": "boolean"
|
|
194839
|
+
},
|
|
194840
|
+
"description": "",
|
|
194841
|
+
"tags": {},
|
|
194842
|
+
"declarations": []
|
|
194843
|
+
},
|
|
194844
|
+
{
|
|
194845
|
+
"kind": "property",
|
|
194846
|
+
"name": "onMouseDown",
|
|
194847
|
+
"required": true,
|
|
194848
|
+
"type": {
|
|
194849
|
+
"kind": "function",
|
|
194850
|
+
"parameters": [
|
|
194851
|
+
{
|
|
194852
|
+
"kind": "parameter",
|
|
194853
|
+
"name": "event",
|
|
194854
|
+
"type": {
|
|
194855
|
+
"kind": "symbol",
|
|
194856
|
+
"name": "React.MouseEvent",
|
|
194857
|
+
"typeParameters": [
|
|
194858
|
+
{
|
|
194859
|
+
"kind": "symbol",
|
|
194860
|
+
"name": "HTMLElement",
|
|
194861
|
+
"value": "HTMLElement"
|
|
194862
|
+
}
|
|
194863
|
+
],
|
|
194864
|
+
"value": "MouseEvent<T, E>"
|
|
194865
|
+
},
|
|
194866
|
+
"required": true,
|
|
194867
|
+
"rest": false,
|
|
194868
|
+
"description": "",
|
|
194869
|
+
"declarations": [
|
|
194870
|
+
{
|
|
194871
|
+
"name": "event",
|
|
194872
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194873
|
+
}
|
|
194874
|
+
],
|
|
194875
|
+
"tags": {}
|
|
194876
|
+
}
|
|
194877
|
+
],
|
|
194878
|
+
"members": [],
|
|
194879
|
+
"returnType": {
|
|
194880
|
+
"kind": "primitive",
|
|
194881
|
+
"value": "void"
|
|
194882
|
+
}
|
|
194883
|
+
},
|
|
194884
|
+
"description": "",
|
|
194885
|
+
"tags": {},
|
|
194886
|
+
"declarations": []
|
|
194887
|
+
}
|
|
194888
|
+
]
|
|
194889
|
+
}
|
|
194890
|
+
},
|
|
194891
|
+
{
|
|
194892
|
+
"kind": "symbol",
|
|
194893
|
+
"name": "useListItemActiveDescendant",
|
|
194894
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx",
|
|
194895
|
+
"value": "useListItemActiveDescendant"
|
|
194896
|
+
},
|
|
194897
|
+
{
|
|
194898
|
+
"kind": "symbol",
|
|
194899
|
+
"name": "useListItemRegister",
|
|
194900
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx",
|
|
194901
|
+
"value": "useListItemRegister"
|
|
194902
|
+
}
|
|
194903
|
+
]
|
|
194904
|
+
}
|
|
194905
|
+
},
|
|
194906
|
+
{
|
|
194907
|
+
"name": "MenuOption",
|
|
194908
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx",
|
|
194909
|
+
"description": "",
|
|
194910
|
+
"declarations": [
|
|
194911
|
+
{
|
|
194912
|
+
"name": "MenuOption",
|
|
194913
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194914
|
+
}
|
|
194915
|
+
],
|
|
194916
|
+
"tags": {},
|
|
194917
|
+
"type": {
|
|
194918
|
+
"kind": "enhancedComponent",
|
|
194919
|
+
"componentType": "subcomponent",
|
|
194920
|
+
"elemPropsHook": "useMenuOption",
|
|
194921
|
+
"displayName": "Menu.Item",
|
|
194922
|
+
"props": [
|
|
194923
|
+
{
|
|
194924
|
+
"kind": "property",
|
|
194925
|
+
"name": "index",
|
|
194926
|
+
"required": false,
|
|
194927
|
+
"type": {
|
|
194928
|
+
"kind": "primitive",
|
|
194929
|
+
"value": "number"
|
|
194930
|
+
},
|
|
194931
|
+
"description": "Optionally pass index to menu item. This should be done if `Menu.Item` components were created\nvia a `Array::map` function. This index will ensure keyboard navigation works even if items are\ninserted out of order.",
|
|
194932
|
+
"declarations": [
|
|
194933
|
+
{
|
|
194934
|
+
"name": "index",
|
|
194935
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194936
|
+
}
|
|
194937
|
+
],
|
|
194938
|
+
"tags": {}
|
|
194939
|
+
},
|
|
194940
|
+
{
|
|
194941
|
+
"kind": "property",
|
|
194942
|
+
"name": "children",
|
|
194943
|
+
"required": false,
|
|
194944
|
+
"type": {
|
|
194945
|
+
"kind": "external",
|
|
194946
|
+
"name": "ReactNode",
|
|
194947
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
194948
|
+
},
|
|
194949
|
+
"description": "The label text of the MenuOption.",
|
|
194950
|
+
"declarations": [
|
|
194951
|
+
{
|
|
194952
|
+
"name": "children",
|
|
194953
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194954
|
+
}
|
|
194955
|
+
],
|
|
194956
|
+
"tags": {}
|
|
194957
|
+
},
|
|
194958
|
+
{
|
|
194959
|
+
"kind": "property",
|
|
194960
|
+
"name": "data-id",
|
|
194961
|
+
"required": false,
|
|
194962
|
+
"type": {
|
|
194963
|
+
"kind": "primitive",
|
|
194964
|
+
"value": "string"
|
|
194965
|
+
},
|
|
194966
|
+
"description": "The name of the menu item. This name will be used in the `onSelect` callback in the model. If\nthis property is not provided, it will default to a string representation of the the zero-based\nindex of the Tab when it was initialized.",
|
|
194967
|
+
"declarations": [
|
|
194968
|
+
{
|
|
194969
|
+
"name": "data-id",
|
|
194970
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194971
|
+
}
|
|
194972
|
+
],
|
|
194973
|
+
"tags": {}
|
|
194974
|
+
},
|
|
194975
|
+
{
|
|
194976
|
+
"kind": "property",
|
|
194977
|
+
"name": "aria-disabled",
|
|
194978
|
+
"required": false,
|
|
194979
|
+
"type": {
|
|
194980
|
+
"kind": "primitive",
|
|
194981
|
+
"value": "boolean"
|
|
194982
|
+
},
|
|
194983
|
+
"description": "`aria-disabled` is used for keyboard and screen reader users to discover disabled content with\nthe keyboard or screen reader caret tool. For more information, see\nhttps://www.w3.org/WAI/ARIA/apg/practices/keyboard-interface/#kbd_disabled_controls",
|
|
194984
|
+
"declarations": [
|
|
194985
|
+
{
|
|
194986
|
+
"name": "aria-disabled",
|
|
194987
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/menu/lib/MenuOption.tsx"
|
|
194988
|
+
}
|
|
194989
|
+
],
|
|
194990
|
+
"tags": {}
|
|
194991
|
+
},
|
|
194992
|
+
{
|
|
194993
|
+
"kind": "property",
|
|
194994
|
+
"name": "cs",
|
|
194272
194995
|
"required": false,
|
|
194273
194996
|
"type": {
|
|
194274
|
-
"kind": "
|
|
194275
|
-
"
|
|
194997
|
+
"kind": "symbol",
|
|
194998
|
+
"name": "CSToPropsInput",
|
|
194999
|
+
"value": "CSToPropsInput"
|
|
194276
195000
|
},
|
|
194277
|
-
"description": "`
|
|
195001
|
+
"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```",
|
|
194278
195002
|
"declarations": [
|
|
194279
195003
|
{
|
|
194280
|
-
"name": "
|
|
194281
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
195004
|
+
"name": "cs",
|
|
195005
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
194282
195006
|
}
|
|
194283
195007
|
],
|
|
194284
195008
|
"tags": {}
|
|
@@ -245522,6 +246246,24 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
245522
246246
|
],
|
|
245523
246247
|
"tags": {}
|
|
245524
246248
|
},
|
|
246249
|
+
{
|
|
246250
|
+
"kind": "property",
|
|
246251
|
+
"name": "cs",
|
|
246252
|
+
"required": false,
|
|
246253
|
+
"type": {
|
|
246254
|
+
"kind": "symbol",
|
|
246255
|
+
"name": "CSToPropsInput",
|
|
246256
|
+
"value": "CSToPropsInput"
|
|
246257
|
+
},
|
|
246258
|
+
"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```",
|
|
246259
|
+
"declarations": [
|
|
246260
|
+
{
|
|
246261
|
+
"name": "cs",
|
|
246262
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
246263
|
+
}
|
|
246264
|
+
],
|
|
246265
|
+
"tags": {}
|
|
246266
|
+
},
|
|
245525
246267
|
{
|
|
245526
246268
|
"kind": "property",
|
|
245527
246269
|
"name": "as",
|
|
@@ -303663,7 +304405,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
303663
304405
|
"name": "ReactNode",
|
|
303664
304406
|
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
303665
304407
|
},
|
|
303666
|
-
"description": "This should be a string in most cases. HTML is supported, but only text is understood\nby assistive technology. This is true for both `label` and `describe` modes
|
|
304408
|
+
"description": "This should be a string in most cases. HTML is supported, but only text is understood\nby assistive technology. This is true for both `label` and `describe` modes.\n\n**Note:** If you use `description` type and want to pass `jsx`, it **must* be inline and **not** a component to ensure the inner text is properly translated.\n\n```jsx\n// The text will be understood as: You must accept terms and conditions\n<Tooltip type=\"description\" title={<span>You<i>must</i> accept terms and conditions</span>}/>\n\n// This will render a string including the html and will not be properly understood by voice over.\nconst MyComponent = () => <span>You<i>must</i> accept terms and conditions</span>\n<Tooltip type=\"description\" title={MyComponent/>\n```",
|
|
303667
304409
|
"declarations": [
|
|
303668
304410
|
{
|
|
303669
304411
|
"name": "title",
|
|
@@ -303759,10 +304501,14 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
303759
304501
|
{
|
|
303760
304502
|
"kind": "string",
|
|
303761
304503
|
"value": "muted"
|
|
304504
|
+
},
|
|
304505
|
+
{
|
|
304506
|
+
"kind": "string",
|
|
304507
|
+
"value": "description"
|
|
303762
304508
|
}
|
|
303763
304509
|
]
|
|
303764
304510
|
},
|
|
303765
|
-
"description": "Determines the tooltip type for accessibility.\n\n- `label`: Sets the accessible name for the wrapped element. Use for icons or if tooltip\n `title` prop is the same as the text content of the wrapped element. E.g. TertiaryButtons that render an icon or\n Ellipsis tooltips.\n- `describe`: Sets `aria-describedby` of the wrapped element. Use if the tooltip has additional\n information about the target.\n- `muted`: No effort is made to make the tooltip accessible to screen readers. Use if the\n tooltip contents are not useful to a screen reader or if you have handled accessibility of\n the tooltip yourself.\n\n**Note**: Assistive technology may ignore `describe` techniques based on verbosity settings.\nConsider an alternate way to inform a user of additional important information.",
|
|
304511
|
+
"description": "Determines the tooltip type for accessibility.\n\n- `label`: Sets the accessible name for the wrapped element. Use for icons or if tooltip\n `title` prop is the same as the text content of the wrapped element. E.g. TertiaryButtons that render an icon or\n Ellipsis tooltips.\n- **Deprecated: `describe` is deprecated, please use `description`**.`describe`: Sets `aria-describedby` of the wrapped element. Use if the tooltip has additional\n information about the target.\n- `muted`: No effort is made to make the tooltip accessible to screen readers. Use if the\n tooltip contents are not useful to a screen reader or if you have handled accessibility of\n the tooltip yourself.\n\n**Note**: Assistive technology may ignore `describe` techniques based on verbosity settings.\nConsider an alternate way to inform a user of additional important information.",
|
|
303766
304512
|
"declarations": [
|
|
303767
304513
|
{
|
|
303768
304514
|
"name": "type",
|
|
@@ -304268,10 +305014,14 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
304268
305014
|
{
|
|
304269
305015
|
"kind": "string",
|
|
304270
305016
|
"value": "muted"
|
|
305017
|
+
},
|
|
305018
|
+
{
|
|
305019
|
+
"kind": "string",
|
|
305020
|
+
"value": "description"
|
|
304271
305021
|
}
|
|
304272
305022
|
]
|
|
304273
305023
|
},
|
|
304274
|
-
"description": "Determines the tooltip type for accessibility.\n\n- `label`: Sets the accessible name for the wrapped element. Use for icons or if tooltip\n `title` prop is the same as the text content of the wrapped element. E.g. TertiaryButton that renders an icon or\n Ellipsis tooltips.\n- `describe`: Sets `aria-describedby` of the wrapped element. Use if the tooltip has additional
|
|
305024
|
+
"description": "Determines the tooltip type for accessibility.\n\n- `label`: Sets the accessible name for the wrapped element. Use for icons or if tooltip\n `title` prop is the same as the text content of the wrapped element. E.g. TertiaryButton that renders an icon or\n Ellipsis tooltips.\n- **Deprecated: `describe` is deprecated, please use `description`.**`describe`: Sets `aria-describedby` of the wrapped element. Use if the tooltip has additional information about the target\n- `muted`: No effort is made to make the tooltip accessible to screen readers. Use if the\n tooltip contents are not useful to a screen reader or if you have handled accessibility of\n the tooltip yourself.\n- `description`: Sets `aria-description` strings for the wrapped element. Use if the tooltip has additional about the target\n\n**Note**: Assistive technology may ignore `describe` techniques based on verbosity settings.\nConsider an alternate way to inform a user of additional important information.",
|
|
304275
305025
|
"declarations": [
|
|
304276
305026
|
{
|
|
304277
305027
|
"name": "type",
|
|
@@ -304404,6 +305154,37 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
304404
305154
|
],
|
|
304405
305155
|
"tags": {}
|
|
304406
305156
|
},
|
|
305157
|
+
{
|
|
305158
|
+
"kind": "property",
|
|
305159
|
+
"name": "aria-description",
|
|
305160
|
+
"defaultValue": {
|
|
305161
|
+
"kind": "unknown",
|
|
305162
|
+
"value": "unknown",
|
|
305163
|
+
"text": "type === 'description' ? titleText : undefined"
|
|
305164
|
+
},
|
|
305165
|
+
"type": {
|
|
305166
|
+
"kind": "union",
|
|
305167
|
+
"value": [
|
|
305168
|
+
{
|
|
305169
|
+
"kind": "primitive",
|
|
305170
|
+
"value": "string"
|
|
305171
|
+
},
|
|
305172
|
+
{
|
|
305173
|
+
"kind": "primitive",
|
|
305174
|
+
"value": "undefined"
|
|
305175
|
+
}
|
|
305176
|
+
]
|
|
305177
|
+
},
|
|
305178
|
+
"required": false,
|
|
305179
|
+
"description": "",
|
|
305180
|
+
"declarations": [
|
|
305181
|
+
{
|
|
305182
|
+
"name": "aria-description",
|
|
305183
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/tooltip/lib/useTooltip.tsx"
|
|
305184
|
+
}
|
|
305185
|
+
],
|
|
305186
|
+
"tags": {}
|
|
305187
|
+
},
|
|
304407
305188
|
{
|
|
304408
305189
|
"kind": "property",
|
|
304409
305190
|
"name": "aria-label",
|