@workday/canvas-kit-docs 14.2.3 → 14.2.5

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.
Files changed (13) hide show
  1. package/dist/es6/lib/docs.js +1033 -3
  2. package/dist/es6/lib/stackblitzFiles/packageJSONFile.js +5 -5
  3. package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts +5 -5
  4. package/dist/mdx/labs-react/side-panel/SidePanel.mdx +85 -54
  5. package/dist/mdx/labs-react/side-panel/examples/AlwaysOpen.tsx +3 -3
  6. package/dist/mdx/labs-react/side-panel/examples/Basic.tsx +17 -37
  7. package/dist/mdx/labs-react/side-panel/examples/ExternalControl.tsx +6 -20
  8. package/dist/mdx/labs-react/side-panel/examples/{HiddenName.tsx → Heading.tsx} +4 -3
  9. package/dist/mdx/labs-react/side-panel/examples/OnStateTransition.tsx +3 -1
  10. package/dist/mdx/labs-react/side-panel/examples/RightOrigin.tsx +3 -9
  11. package/dist/mdx/labs-react/side-panel/examples/Variant.tsx +2 -8
  12. package/dist/mdx/react/layout/Box.mdx +1 -1
  13. package/package.json +6 -6
package/dist/es6/lib/docs.js CHANGED
@@ -4904,8 +4904,1038 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
4904
4904
  }
4905
4905
  ],
4906
4906
  "tags": {}
4907
+ },
4908
+ {
4909
+ "name": "Heading",
4910
+ "symbol": "SidePanelHeading",
4911
+ "description": "`SidePanel.Heading` is a styled heading that provides the accessible name for the SidePanel.\nThe heading's `id` is automatically linked to the panel's `aria-labelledby` attribute.\nBy default, the heading is hidden when the panel is collapsed.",
4912
+ "declarations": [
4913
+ {
4914
+ "name": "Heading",
4915
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanel.tsx"
4916
+ },
4917
+ {
4918
+ "name": "SidePanelHeading",
4919
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
4920
+ }
4921
+ ],
4922
+ "tags": {}
4923
+ }
4924
+ ]
4925
+ }
4926
+ },
4927
+ {
4928
+ "name": "SidePanelHeadingProps",
4929
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
4930
+ "description": "",
4931
+ "declarations": [
4932
+ {
4933
+ "name": "SidePanelHeadingProps",
4934
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
4935
+ }
4936
+ ],
4937
+ "tags": {},
4938
+ "type": {
4939
+ "kind": "alias",
4940
+ "name": "SidePanelHeading"
4941
+ }
4942
+ },
4943
+ {
4944
+ "name": "sidePanelHeadingStencil",
4945
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
4946
+ "description": "",
4947
+ "declarations": [
4948
+ {
4949
+ "name": "sidePanelHeadingStencil",
4950
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
4951
+ }
4952
+ ],
4953
+ "tags": {},
4954
+ "type": {
4955
+ "kind": "function",
4956
+ "parameters": [
4957
+ {
4958
+ "kind": "parameter",
4959
+ "name": "options",
4960
+ "type": {
4961
+ "kind": "conditional",
4962
+ "check": {
4963
+ "kind": "tuple",
4964
+ "value": [
4965
+ {
4966
+ "kind": "symbol",
4967
+ "name": "E",
4968
+ "value": "E"
4969
+ }
4970
+ ]
4971
+ },
4972
+ "extends": {
4973
+ "kind": "tuple",
4974
+ "value": [
4975
+ {
4976
+ "kind": "primitive",
4977
+ "value": "never"
4978
+ }
4979
+ ]
4980
+ },
4981
+ "trueType": {
4982
+ "kind": "intersection",
4983
+ "value": [
4984
+ {
4985
+ "kind": "symbol",
4986
+ "name": "ModifierValuesStencil",
4987
+ "typeParameters": [
4988
+ {
4989
+ "kind": "symbol",
4990
+ "name": "M",
4991
+ "value": "M"
4992
+ },
4993
+ {
4994
+ "kind": "symbol",
4995
+ "name": "V",
4996
+ "value": "V"
4997
+ }
4998
+ ],
4999
+ "value": "ModifierValuesStencil<M, V>"
5000
+ },
5001
+ {
5002
+ "kind": "symbol",
5003
+ "name": "VariableValuesStencil",
5004
+ "typeParameters": [
5005
+ {
5006
+ "kind": "symbol",
5007
+ "name": "V",
5008
+ "value": "V"
5009
+ }
5010
+ ],
5011
+ "value": "VariableValuesStencil<V>"
5012
+ }
5013
+ ]
5014
+ },
5015
+ "falseType": {
5016
+ "kind": "conditional",
5017
+ "check": {
5018
+ "kind": "symbol",
5019
+ "name": "E",
5020
+ "value": "E"
5021
+ },
5022
+ "extends": {
5023
+ "kind": "symbol",
5024
+ "name": "BaseStencil",
5025
+ "typeParameters": [
5026
+ {
5027
+ "kind": "infer",
5028
+ "value": {
5029
+ "kind": "typeParameter",
5030
+ "name": "ME",
5031
+ "required": true
5032
+ }
5033
+ },
5034
+ {
5035
+ "kind": "primitive",
5036
+ "value": "any"
5037
+ },
5038
+ {
5039
+ "kind": "infer",
5040
+ "value": {
5041
+ "kind": "typeParameter",
5042
+ "name": "VE",
5043
+ "required": true
5044
+ }
5045
+ },
5046
+ {
5047
+ "kind": "primitive",
5048
+ "value": "any"
5049
+ },
5050
+ {
5051
+ "kind": "primitive",
5052
+ "value": "any"
5053
+ }
5054
+ ],
5055
+ "value": "BaseStencil<M, P, V, E, ID>"
5056
+ },
5057
+ "trueType": {
5058
+ "kind": "intersection",
5059
+ "value": [
5060
+ {
5061
+ "kind": "symbol",
5062
+ "name": "ModifierValuesStencil",
5063
+ "typeParameters": [
5064
+ {
5065
+ "kind": "intersection",
5066
+ "value": [
5067
+ {
5068
+ "kind": "symbol",
5069
+ "name": "ME",
5070
+ "value": "ME"
5071
+ },
5072
+ {
5073
+ "kind": "symbol",
5074
+ "name": "M",
5075
+ "value": "M"
5076
+ }
5077
+ ]
5078
+ },
5079
+ {
5080
+ "kind": "intersection",
5081
+ "value": [
5082
+ {
5083
+ "kind": "symbol",
5084
+ "name": "VE",
5085
+ "value": "VE"
5086
+ },
5087
+ {
5088
+ "kind": "symbol",
5089
+ "name": "V",
5090
+ "value": "V"
5091
+ }
5092
+ ]
5093
+ }
5094
+ ],
5095
+ "value": "ModifierValuesStencil<M, V>"
5096
+ },
5097
+ {
5098
+ "kind": "symbol",
5099
+ "name": "VariableValuesStencil",
5100
+ "typeParameters": [
5101
+ {
5102
+ "kind": "intersection",
5103
+ "value": [
5104
+ {
5105
+ "kind": "symbol",
5106
+ "name": "VE",
5107
+ "value": "VE"
5108
+ },
5109
+ {
5110
+ "kind": "symbol",
5111
+ "name": "V",
5112
+ "value": "V"
5113
+ }
5114
+ ]
5115
+ }
5116
+ ],
5117
+ "value": "VariableValuesStencil<V>"
5118
+ }
5119
+ ]
5120
+ },
5121
+ "falseType": {
5122
+ "kind": "primitive",
5123
+ "value": "never"
5124
+ }
5125
+ }
5126
+ },
5127
+ "required": false,
5128
+ "rest": false,
5129
+ "description": "",
5130
+ "declarations": [
5131
+ {
5132
+ "name": "options",
5133
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5134
+ }
5135
+ ],
5136
+ "tags": {}
5137
+ }
5138
+ ],
5139
+ "members": [
5140
+ {
5141
+ "kind": "property",
5142
+ "name": "parts",
5143
+ "required": true,
5144
+ "type": {
5145
+ "kind": "conditional",
5146
+ "check": {
5147
+ "kind": "tuple",
5148
+ "value": [
5149
+ {
5150
+ "kind": "symbol",
5151
+ "name": "E",
5152
+ "value": "E"
5153
+ }
5154
+ ]
5155
+ },
5156
+ "extends": {
5157
+ "kind": "tuple",
5158
+ "value": [
5159
+ {
5160
+ "kind": "symbol",
5161
+ "name": "BaseStencil",
5162
+ "typeParameters": [
5163
+ {
5164
+ "kind": "primitive",
5165
+ "value": "any"
5166
+ },
5167
+ {
5168
+ "kind": "infer",
5169
+ "value": {
5170
+ "kind": "typeParameter",
5171
+ "name": "PE",
5172
+ "required": true
5173
+ }
5174
+ },
5175
+ {
5176
+ "kind": "primitive",
5177
+ "value": "any"
5178
+ },
5179
+ {
5180
+ "kind": "primitive",
5181
+ "value": "any"
5182
+ },
5183
+ {
5184
+ "kind": "primitive",
5185
+ "value": "any"
5186
+ }
5187
+ ],
5188
+ "value": "BaseStencil<M, P, V, E, ID>"
5189
+ }
5190
+ ]
5191
+ },
5192
+ "trueType": {
5193
+ "kind": "symbol",
5194
+ "name": "StencilPartProps",
5195
+ "typeParameters": [
5196
+ {
5197
+ "kind": "intersection",
5198
+ "value": [
5199
+ {
5200
+ "kind": "symbol",
5201
+ "name": "PE",
5202
+ "value": "PE"
5203
+ },
5204
+ {
5205
+ "kind": "symbol",
5206
+ "name": "P",
5207
+ "value": "P"
5208
+ }
5209
+ ]
5210
+ }
5211
+ ],
5212
+ "value": "StencilPartProps<T>"
5213
+ },
5214
+ "falseType": {
5215
+ "kind": "symbol",
5216
+ "name": "StencilPartProps",
5217
+ "typeParameters": [
5218
+ {
5219
+ "kind": "symbol",
5220
+ "name": "P",
5221
+ "value": "P"
5222
+ }
5223
+ ],
5224
+ "value": "StencilPartProps<T>"
5225
+ }
5226
+ },
5227
+ "description": "",
5228
+ "declarations": [
5229
+ {
5230
+ "name": "parts",
5231
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5232
+ }
5233
+ ],
5234
+ "tags": {}
5235
+ },
5236
+ {
5237
+ "kind": "property",
5238
+ "name": "vars",
5239
+ "required": true,
5240
+ "type": {
5241
+ "kind": "symbol",
5242
+ "name": "StencilDefaultVars",
5243
+ "typeParameters": [
5244
+ {
5245
+ "kind": "symbol",
5246
+ "name": "V",
5247
+ "value": "V"
5248
+ },
5249
+ {
5250
+ "kind": "symbol",
5251
+ "name": "E",
5252
+ "value": "E"
5253
+ },
5254
+ {
5255
+ "kind": "symbol",
5256
+ "name": "ID",
5257
+ "value": "ID"
5258
+ }
5259
+ ],
5260
+ "value": "StencilDefaultVars<V, E, ID>"
5261
+ },
5262
+ "description": "",
5263
+ "declarations": [
5264
+ {
5265
+ "name": "vars",
5266
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5267
+ }
5268
+ ],
5269
+ "tags": {}
5270
+ },
5271
+ {
5272
+ "kind": "property",
5273
+ "name": "base",
5274
+ "required": true,
5275
+ "type": {
5276
+ "kind": "primitive",
5277
+ "value": "string"
5278
+ },
5279
+ "description": "",
5280
+ "declarations": [
5281
+ {
5282
+ "name": "base",
5283
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5284
+ }
5285
+ ],
5286
+ "tags": {}
5287
+ },
5288
+ {
5289
+ "kind": "property",
5290
+ "name": "modifiers",
5291
+ "required": true,
5292
+ "type": {
5293
+ "kind": "conditional",
5294
+ "check": {
5295
+ "kind": "tuple",
5296
+ "value": [
5297
+ {
5298
+ "kind": "symbol",
5299
+ "name": "E",
5300
+ "value": "E"
5301
+ }
5302
+ ]
5303
+ },
5304
+ "extends": {
5305
+ "kind": "tuple",
5306
+ "value": [
5307
+ {
5308
+ "kind": "symbol",
5309
+ "name": "BaseStencil",
5310
+ "typeParameters": [
5311
+ {
5312
+ "kind": "infer",
5313
+ "value": {
5314
+ "kind": "typeParameter",
5315
+ "name": "ME",
5316
+ "required": true
5317
+ }
5318
+ },
5319
+ {
5320
+ "kind": "primitive",
5321
+ "value": "any"
5322
+ },
5323
+ {
5324
+ "kind": "infer",
5325
+ "value": {
5326
+ "kind": "typeParameter",
5327
+ "name": "VE",
5328
+ "required": true
5329
+ }
5330
+ },
5331
+ {
5332
+ "kind": "primitive",
5333
+ "value": "any"
5334
+ },
5335
+ {
5336
+ "kind": "primitive",
5337
+ "value": "any"
5338
+ }
5339
+ ],
5340
+ "value": "BaseStencil<M, P, V, E, ID>"
5341
+ }
5342
+ ]
5343
+ },
5344
+ "trueType": {
5345
+ "kind": "symbol",
5346
+ "name": "StencilModifierReturn",
5347
+ "typeParameters": [
5348
+ {
5349
+ "kind": "intersection",
5350
+ "value": [
5351
+ {
5352
+ "kind": "symbol",
5353
+ "name": "ME",
5354
+ "value": "ME"
5355
+ },
5356
+ {
5357
+ "kind": "symbol",
5358
+ "name": "M",
5359
+ "value": "M"
5360
+ }
5361
+ ]
5362
+ },
5363
+ {
5364
+ "kind": "intersection",
5365
+ "value": [
5366
+ {
5367
+ "kind": "symbol",
5368
+ "name": "VE",
5369
+ "value": "VE"
5370
+ },
5371
+ {
5372
+ "kind": "symbol",
5373
+ "name": "V",
5374
+ "value": "V"
5375
+ }
5376
+ ]
5377
+ }
5378
+ ],
5379
+ "value": "StencilModifierReturn<M, V>"
5380
+ },
5381
+ "falseType": {
5382
+ "kind": "symbol",
5383
+ "name": "StencilModifierReturn",
5384
+ "typeParameters": [
5385
+ {
5386
+ "kind": "symbol",
5387
+ "name": "M",
5388
+ "value": "M"
5389
+ },
5390
+ {
5391
+ "kind": "symbol",
5392
+ "name": "V",
5393
+ "value": "V"
5394
+ }
5395
+ ],
5396
+ "value": "StencilModifierReturn<M, V>"
5397
+ }
5398
+ },
5399
+ "description": "",
5400
+ "declarations": [
5401
+ {
5402
+ "name": "modifiers",
5403
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5404
+ }
5405
+ ],
5406
+ "tags": {}
5407
+ },
5408
+ {
5409
+ "kind": "property",
5410
+ "name": "defaultModifiers",
5411
+ "required": true,
5412
+ "type": {
5413
+ "kind": "conditional",
5414
+ "check": {
5415
+ "kind": "tuple",
5416
+ "value": [
5417
+ {
5418
+ "kind": "symbol",
5419
+ "name": "E",
5420
+ "value": "E"
5421
+ }
5422
+ ]
5423
+ },
5424
+ "extends": {
5425
+ "kind": "tuple",
5426
+ "value": [
5427
+ {
5428
+ "kind": "symbol",
5429
+ "name": "BaseStencil",
5430
+ "typeParameters": [
5431
+ {
5432
+ "kind": "infer",
5433
+ "value": {
5434
+ "kind": "typeParameter",
5435
+ "name": "ME",
5436
+ "required": true
5437
+ }
5438
+ },
5439
+ {
5440
+ "kind": "primitive",
5441
+ "value": "any"
5442
+ },
5443
+ {
5444
+ "kind": "primitive",
5445
+ "value": "any"
5446
+ },
5447
+ {
5448
+ "kind": "primitive",
5449
+ "value": "any"
5450
+ },
5451
+ {
5452
+ "kind": "primitive",
5453
+ "value": "any"
5454
+ }
5455
+ ],
5456
+ "value": "BaseStencil<M, P, V, E, ID>"
5457
+ }
5458
+ ]
5459
+ },
5460
+ "trueType": {
5461
+ "kind": "symbol",
5462
+ "name": "StencilDefaultModifierReturn",
5463
+ "typeParameters": [
5464
+ {
5465
+ "kind": "intersection",
5466
+ "value": [
5467
+ {
5468
+ "kind": "symbol",
5469
+ "name": "ME",
5470
+ "value": "ME"
5471
+ },
5472
+ {
5473
+ "kind": "symbol",
5474
+ "name": "M",
5475
+ "value": "M"
5476
+ }
5477
+ ]
5478
+ }
5479
+ ],
5480
+ "value": "StencilDefaultModifierReturn<M>"
5481
+ },
5482
+ "falseType": {
5483
+ "kind": "symbol",
5484
+ "name": "StencilDefaultModifierReturn",
5485
+ "typeParameters": [
5486
+ {
5487
+ "kind": "symbol",
5488
+ "name": "M",
5489
+ "value": "M"
5490
+ }
5491
+ ],
5492
+ "value": "StencilDefaultModifierReturn<M>"
5493
+ }
5494
+ },
5495
+ "description": "",
5496
+ "declarations": [
5497
+ {
5498
+ "name": "defaultModifiers",
5499
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5500
+ }
5501
+ ],
5502
+ "tags": {}
5503
+ },
5504
+ {
5505
+ "kind": "property",
5506
+ "name": "__extends",
5507
+ "required": false,
5508
+ "type": {
5509
+ "kind": "symbol",
5510
+ "name": "E",
5511
+ "value": "E"
5512
+ },
5513
+ "description": "",
5514
+ "declarations": [
5515
+ {
5516
+ "name": "__extends",
5517
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5518
+ }
5519
+ ],
5520
+ "tags": {}
5521
+ },
5522
+ {
5523
+ "kind": "property",
5524
+ "name": "__vars",
5525
+ "required": true,
5526
+ "type": {
5527
+ "kind": "symbol",
5528
+ "name": "V",
5529
+ "value": "V"
5530
+ },
5531
+ "description": "",
5532
+ "declarations": [
5533
+ {
5534
+ "name": "__vars",
5535
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5536
+ }
5537
+ ],
5538
+ "tags": {}
5539
+ },
5540
+ {
5541
+ "kind": "property",
5542
+ "name": "__modifiers",
5543
+ "required": true,
5544
+ "type": {
5545
+ "kind": "symbol",
5546
+ "name": "M",
5547
+ "value": "M"
5548
+ },
5549
+ "description": "",
5550
+ "declarations": [
5551
+ {
5552
+ "name": "__modifiers",
5553
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5554
+ }
5555
+ ],
5556
+ "tags": {}
5557
+ },
5558
+ {
5559
+ "kind": "property",
5560
+ "name": "__id",
5561
+ "required": true,
5562
+ "type": {
5563
+ "kind": "symbol",
5564
+ "name": "ID",
5565
+ "value": "ID"
5566
+ },
5567
+ "description": "",
5568
+ "declarations": [
5569
+ {
5570
+ "name": "__id",
5571
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5572
+ }
5573
+ ],
5574
+ "tags": {}
5575
+ },
5576
+ {
5577
+ "kind": "property",
5578
+ "name": "__parts",
5579
+ "required": false,
5580
+ "type": {
5581
+ "kind": "symbol",
5582
+ "name": "P",
5583
+ "value": "P"
5584
+ },
5585
+ "description": "",
5586
+ "declarations": [
5587
+ {
5588
+ "name": "__parts",
5589
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5590
+ }
5591
+ ],
5592
+ "tags": {}
5593
+ }
5594
+ ],
5595
+ "returnType": {
5596
+ "kind": "object",
5597
+ "properties": [
5598
+ {
5599
+ "kind": "property",
5600
+ "name": "className",
5601
+ "required": true,
5602
+ "type": {
5603
+ "kind": "primitive",
5604
+ "value": "string"
5605
+ },
5606
+ "description": "",
5607
+ "declarations": [
5608
+ {
5609
+ "name": "className",
5610
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5611
+ }
5612
+ ],
5613
+ "tags": {}
5614
+ },
5615
+ {
5616
+ "kind": "property",
5617
+ "name": "style",
5618
+ "required": false,
5619
+ "type": {
5620
+ "kind": "external",
5621
+ "name": "Record",
5622
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
5623
+ "typeParameters": [
5624
+ {
5625
+ "kind": "primitive",
5626
+ "value": "string"
5627
+ },
5628
+ {
5629
+ "kind": "primitive",
5630
+ "value": "string"
5631
+ }
5632
+ ]
5633
+ },
5634
+ "description": "",
5635
+ "declarations": [
5636
+ {
5637
+ "name": "style",
5638
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5639
+ }
5640
+ ],
5641
+ "tags": {}
5642
+ }
5643
+ ]
5644
+ }
5645
+ }
5646
+ },
5647
+ {
5648
+ "name": "useSidePanelHeading",
5649
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
5650
+ "description": "Adds the necessary props to the SidePanelHeading subcomponent.\nThis sets the `id` to the `labelId` from the model for accessibility purposes,\nand hides the heading when the panel is not expanded.",
5651
+ "declarations": [
5652
+ {
5653
+ "name": "useSidePanelHeading",
5654
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
5655
+ }
5656
+ ],
5657
+ "tags": {},
5658
+ "type": {
5659
+ "kind": "function",
5660
+ "name": {
5661
+ "kind": "symbol",
5662
+ "name": "createElemPropsHook"
5663
+ },
5664
+ "parameters": [
5665
+ {
5666
+ "kind": "parameter",
5667
+ "name": "model",
5668
+ "description": "",
5669
+ "tags": {},
5670
+ "declarations": [],
5671
+ "type": {
5672
+ "kind": "symbol",
5673
+ "name": "SidePanelModel"
5674
+ },
5675
+ "required": true
5676
+ },
5677
+ {
5678
+ "kind": "parameter",
5679
+ "name": "elemProps",
5680
+ "description": "",
5681
+ "tags": {},
5682
+ "declarations": [],
5683
+ "type": {
5684
+ "kind": "object",
5685
+ "properties": []
5686
+ },
5687
+ "required": false
5688
+ },
5689
+ {
5690
+ "kind": "parameter",
5691
+ "name": "ref",
5692
+ "description": "",
5693
+ "tags": {},
5694
+ "declarations": [],
5695
+ "type": {
5696
+ "kind": "external",
5697
+ "name": "React.Ref",
5698
+ "url": "https://reactjs.org/docs/refs-and-the-dom.html"
5699
+ },
5700
+ "required": false
4907
5701
  }
4908
- ]
5702
+ ],
5703
+ "returnType": {
5704
+ "kind": "object",
5705
+ "properties": [
5706
+ {
5707
+ "kind": "property",
5708
+ "name": "id",
5709
+ "required": true,
5710
+ "type": {
5711
+ "kind": "primitive",
5712
+ "value": "string"
5713
+ },
5714
+ "description": "",
5715
+ "tags": {},
5716
+ "declarations": []
5717
+ },
5718
+ {
5719
+ "kind": "property",
5720
+ "name": "hidden",
5721
+ "required": true,
5722
+ "type": {
5723
+ "kind": "primitive",
5724
+ "value": "boolean"
5725
+ },
5726
+ "description": "",
5727
+ "tags": {},
5728
+ "declarations": []
5729
+ }
5730
+ ]
5731
+ }
5732
+ }
5733
+ },
5734
+ {
5735
+ "name": "SidePanelHeading",
5736
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx",
5737
+ "description": "`SidePanel.Heading` is a styled heading component that provides the accessible name\nfor the SidePanel. The heading's `id` is automatically set to the model's `labelId`,\nwhich is used by the panel's `aria-labelledby` attribute.\n\nThe heading is automatically hidden when the panel is collapsed.",
5738
+ "declarations": [
5739
+ {
5740
+ "name": "SidePanelHeading",
5741
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
5742
+ }
5743
+ ],
5744
+ "tags": {},
5745
+ "type": {
5746
+ "kind": "enhancedComponent",
5747
+ "componentType": "subcomponent",
5748
+ "elemPropsHook": "useSidePanelHeading",
5749
+ "displayName": "SidePanel.Heading",
5750
+ "props": [
5751
+ {
5752
+ "kind": "property",
5753
+ "name": "children",
5754
+ "required": false,
5755
+ "type": {
5756
+ "kind": "external",
5757
+ "name": "ReactNode",
5758
+ "url": "https://reactjs.org/docs/rendering-elements.html"
5759
+ },
5760
+ "description": "",
5761
+ "declarations": [
5762
+ {
5763
+ "name": "children",
5764
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanelHeading.tsx"
5765
+ }
5766
+ ],
5767
+ "tags": {}
5768
+ },
5769
+ {
5770
+ "kind": "property",
5771
+ "name": "size",
5772
+ "required": true,
5773
+ "type": {
5774
+ "kind": "symbol",
5775
+ "name": "Size",
5776
+ "value": "Size"
5777
+ },
5778
+ "description": "Each type level has three sizes: `large`, `medium`, and `small`.",
5779
+ "declarations": [
5780
+ {
5781
+ "name": "size",
5782
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/TypeLevelComponents.tsx"
5783
+ }
5784
+ ],
5785
+ "tags": {},
5786
+ "defaultValue": {
5787
+ "kind": "string",
5788
+ "value": "small"
5789
+ }
5790
+ },
5791
+ {
5792
+ "kind": "property",
5793
+ "name": "cs",
5794
+ "required": false,
5795
+ "type": {
5796
+ "kind": "symbol",
5797
+ "name": "CSToPropsInput",
5798
+ "value": "CSToPropsInput"
5799
+ },
5800
+ "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```",
5801
+ "declarations": [
5802
+ {
5803
+ "name": "cs",
5804
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
5805
+ }
5806
+ ],
5807
+ "tags": {}
5808
+ },
5809
+ {
5810
+ "kind": "property",
5811
+ "name": "variant",
5812
+ "required": false,
5813
+ "type": {
5814
+ "kind": "union",
5815
+ "value": [
5816
+ {
5817
+ "kind": "string",
5818
+ "value": "error"
5819
+ },
5820
+ {
5821
+ "kind": "string",
5822
+ "value": "hint"
5823
+ },
5824
+ {
5825
+ "kind": "string",
5826
+ "value": "inverse"
5827
+ }
5828
+ ]
5829
+ },
5830
+ "description": "Type variant token names: `error`, `hint` or `inverse`.\n\n```tsx\n<Text variant=\"error\" typeLevel=\"subtext.large\">Error text</Text>\n```",
5831
+ "declarations": [
5832
+ {
5833
+ "name": "variant",
5834
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/text/lib/Text.tsx"
5835
+ }
5836
+ ],
5837
+ "tags": {}
5838
+ },
5839
+ {
5840
+ "kind": "property",
5841
+ "name": "as",
5842
+ "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.",
5843
+ "tags": {},
5844
+ "declarations": [],
5845
+ "type": {
5846
+ "kind": "external",
5847
+ "name": "React.ElementType",
5848
+ "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
5849
+ },
5850
+ "defaultValue": {
5851
+ "kind": "symbol",
5852
+ "name": "Heading"
5853
+ }
5854
+ },
5855
+ {
5856
+ "kind": "property",
5857
+ "name": "ref",
5858
+ "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`).",
5859
+ "tags": {},
5860
+ "declarations": [],
5861
+ "type": {
5862
+ "kind": "external",
5863
+ "name": "React.Ref",
5864
+ "url": "https://reactjs.org/docs/refs-and-the-dom.html",
5865
+ "typeParameters": [
5866
+ {
5867
+ "kind": "typeParameter",
5868
+ "name": "R",
5869
+ "required": true,
5870
+ "defaultValue": {
5871
+ "kind": "symbol",
5872
+ "name": "Heading"
5873
+ }
5874
+ }
5875
+ ]
5876
+ }
5877
+ },
5878
+ {
5879
+ "kind": "property",
5880
+ "name": "model",
5881
+ "description": "Optional model to pass to the component. This will override the default model created for the component. This can be useful if you want to access to the state and events of the model, or if you have nested components of the same type and you need to override the model provided by React Context.",
5882
+ "tags": {},
5883
+ "declarations": [],
5884
+ "type": {
5885
+ "kind": "symbol",
5886
+ "name": "SidePanelModel"
5887
+ }
5888
+ },
5889
+ {
5890
+ "kind": "property",
5891
+ "name": "elemPropsHook",
5892
+ "description": "Optional hook that receives the model and all props to be applied to the element. If you use this, it is your responsibility to return props, merging as appropriate. For example, returning an empty object will disable all elemProps hooks associated with this component. This allows finer control over a component without creating a new one.",
5893
+ "tags": {},
5894
+ "declarations": [],
5895
+ "type": {
5896
+ "kind": "function",
5897
+ "parameters": [
5898
+ {
5899
+ "kind": "parameter",
5900
+ "description": "",
5901
+ "tags": {},
5902
+ "declarations": [],
5903
+ "name": "model",
5904
+ "type": {
5905
+ "kind": "symbol",
5906
+ "name": "SidePanelModel"
5907
+ },
5908
+ "required": true
5909
+ },
5910
+ {
5911
+ "kind": "parameter",
5912
+ "description": "",
5913
+ "tags": {},
5914
+ "declarations": [],
5915
+ "name": "elemProps",
5916
+ "type": {
5917
+ "kind": "generic",
5918
+ "name": "TProps"
5919
+ }
5920
+ }
5921
+ ],
5922
+ "returnType": {
5923
+ "kind": "external",
5924
+ "name": "HTML Attributes",
5925
+ "url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes"
5926
+ }
5927
+ }
5928
+ }
5929
+ ],
5930
+ "baseElement": {
5931
+ "kind": "symbol",
5932
+ "name": "Heading"
5933
+ },
5934
+ "styleComponent": {
5935
+ "kind": "symbol",
5936
+ "name": "Box"
5937
+ },
5938
+ "model": "SidePanelModel"
4909
5939
  }
4910
5940
  },
4911
5941
  {
@@ -5701,7 +6731,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
5701
6731
  },
5702
6732
  {
5703
6733
  "kind": "property",
5704
- "name": "aria-expanded",
6734
+ "name": "aria-pressed",
5705
6735
  "required": true,
5706
6736
  "type": {
5707
6737
  "kind": "primitive",
@@ -5713,7 +6743,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
5713
6743
  },
5714
6744
  {
5715
6745
  "kind": "property",
5716
- "name": "aria-labelledby",
6746
+ "name": "aria-describedby",
5717
6747
  "required": true,
5718
6748
  "type": {
5719
6749
  "kind": "primitive",