@workday/canvas-kit-docs 11.0.0-alpha.758-next.0 → 11.0.0-alpha.760-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 +1654 -187
- package/dist/mdx/react/card/card.mdx +10 -18
- package/dist/mdx/react/card/examples/CustomStyles.tsx +21 -0
- package/dist/mdx/react/card/examples/Stencils.tsx +108 -0
- package/package.json +6 -6
- package/dist/mdx/react/card/examples/Depth.tsx +0 -20
- package/dist/mdx/react/card/examples/Padding.tsx +0 -21
package/dist/es6/lib/docs.js
CHANGED
|
@@ -62271,52 +62271,213 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
62271
62271
|
}
|
|
62272
62272
|
},
|
|
62273
62273
|
{
|
|
62274
|
-
"name": "
|
|
62274
|
+
"name": "cardStencil",
|
|
62275
62275
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx",
|
|
62276
|
-
"description": "
|
|
62276
|
+
"description": "",
|
|
62277
62277
|
"declarations": [
|
|
62278
62278
|
{
|
|
62279
|
-
"name": "
|
|
62279
|
+
"name": "cardStencil",
|
|
62280
62280
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx"
|
|
62281
62281
|
}
|
|
62282
62282
|
],
|
|
62283
62283
|
"tags": {},
|
|
62284
62284
|
"type": {
|
|
62285
|
-
"kind": "
|
|
62286
|
-
"
|
|
62287
|
-
"displayName": "Card",
|
|
62288
|
-
"props": [
|
|
62285
|
+
"kind": "function",
|
|
62286
|
+
"parameters": [
|
|
62289
62287
|
{
|
|
62290
|
-
"kind": "
|
|
62291
|
-
"name": "
|
|
62292
|
-
"required": false,
|
|
62288
|
+
"kind": "parameter",
|
|
62289
|
+
"name": "options",
|
|
62293
62290
|
"type": {
|
|
62294
|
-
"kind": "
|
|
62295
|
-
"
|
|
62296
|
-
|
|
62291
|
+
"kind": "conditional",
|
|
62292
|
+
"check": {
|
|
62293
|
+
"kind": "tuple",
|
|
62294
|
+
"value": [
|
|
62295
|
+
{
|
|
62296
|
+
"kind": "symbol",
|
|
62297
|
+
"name": "E",
|
|
62298
|
+
"value": "E"
|
|
62299
|
+
}
|
|
62300
|
+
]
|
|
62301
|
+
},
|
|
62302
|
+
"extends": {
|
|
62303
|
+
"kind": "tuple",
|
|
62304
|
+
"value": [
|
|
62305
|
+
{
|
|
62306
|
+
"kind": "primitive",
|
|
62307
|
+
"value": "never"
|
|
62308
|
+
}
|
|
62309
|
+
]
|
|
62310
|
+
},
|
|
62311
|
+
"trueType": {
|
|
62312
|
+
"kind": "intersection",
|
|
62313
|
+
"value": [
|
|
62314
|
+
{
|
|
62315
|
+
"kind": "symbol",
|
|
62316
|
+
"name": "ModifierValuesStencil",
|
|
62317
|
+
"typeParameters": [
|
|
62318
|
+
{
|
|
62319
|
+
"kind": "symbol",
|
|
62320
|
+
"name": "M",
|
|
62321
|
+
"value": "M"
|
|
62322
|
+
},
|
|
62323
|
+
{
|
|
62324
|
+
"kind": "symbol",
|
|
62325
|
+
"name": "V",
|
|
62326
|
+
"value": "V"
|
|
62327
|
+
}
|
|
62328
|
+
],
|
|
62329
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
62330
|
+
},
|
|
62331
|
+
{
|
|
62332
|
+
"kind": "symbol",
|
|
62333
|
+
"name": "VariableValuesStencil",
|
|
62334
|
+
"typeParameters": [
|
|
62335
|
+
{
|
|
62336
|
+
"kind": "symbol",
|
|
62337
|
+
"name": "V",
|
|
62338
|
+
"value": "V"
|
|
62339
|
+
}
|
|
62340
|
+
],
|
|
62341
|
+
"value": "VariableValuesStencil<V>"
|
|
62342
|
+
}
|
|
62343
|
+
]
|
|
62344
|
+
},
|
|
62345
|
+
"falseType": {
|
|
62346
|
+
"kind": "conditional",
|
|
62347
|
+
"check": {
|
|
62348
|
+
"kind": "symbol",
|
|
62349
|
+
"name": "E",
|
|
62350
|
+
"value": "E"
|
|
62351
|
+
},
|
|
62352
|
+
"extends": {
|
|
62353
|
+
"kind": "symbol",
|
|
62354
|
+
"name": "BaseStencil",
|
|
62355
|
+
"typeParameters": [
|
|
62356
|
+
{
|
|
62357
|
+
"kind": "infer",
|
|
62358
|
+
"value": {
|
|
62359
|
+
"kind": "typeParameter",
|
|
62360
|
+
"name": "ME",
|
|
62361
|
+
"required": true
|
|
62362
|
+
}
|
|
62363
|
+
},
|
|
62364
|
+
{
|
|
62365
|
+
"kind": "infer",
|
|
62366
|
+
"value": {
|
|
62367
|
+
"kind": "typeParameter",
|
|
62368
|
+
"name": "VE",
|
|
62369
|
+
"required": true
|
|
62370
|
+
}
|
|
62371
|
+
},
|
|
62372
|
+
{
|
|
62373
|
+
"kind": "primitive",
|
|
62374
|
+
"value": "any"
|
|
62375
|
+
},
|
|
62376
|
+
{
|
|
62377
|
+
"kind": "primitive",
|
|
62378
|
+
"value": "any"
|
|
62379
|
+
}
|
|
62380
|
+
],
|
|
62381
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
62382
|
+
},
|
|
62383
|
+
"trueType": {
|
|
62384
|
+
"kind": "intersection",
|
|
62385
|
+
"value": [
|
|
62386
|
+
{
|
|
62387
|
+
"kind": "symbol",
|
|
62388
|
+
"name": "ModifierValuesStencil",
|
|
62389
|
+
"typeParameters": [
|
|
62390
|
+
{
|
|
62391
|
+
"kind": "intersection",
|
|
62392
|
+
"value": [
|
|
62393
|
+
{
|
|
62394
|
+
"kind": "symbol",
|
|
62395
|
+
"name": "ME",
|
|
62396
|
+
"value": "ME"
|
|
62397
|
+
},
|
|
62398
|
+
{
|
|
62399
|
+
"kind": "symbol",
|
|
62400
|
+
"name": "M",
|
|
62401
|
+
"value": "M"
|
|
62402
|
+
}
|
|
62403
|
+
]
|
|
62404
|
+
}
|
|
62405
|
+
],
|
|
62406
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
62407
|
+
},
|
|
62408
|
+
{
|
|
62409
|
+
"kind": "symbol",
|
|
62410
|
+
"name": "VariableValuesStencil",
|
|
62411
|
+
"typeParameters": [
|
|
62412
|
+
{
|
|
62413
|
+
"kind": "intersection",
|
|
62414
|
+
"value": [
|
|
62415
|
+
{
|
|
62416
|
+
"kind": "symbol",
|
|
62417
|
+
"name": "VE",
|
|
62418
|
+
"value": "VE"
|
|
62419
|
+
},
|
|
62420
|
+
{
|
|
62421
|
+
"kind": "symbol",
|
|
62422
|
+
"name": "V",
|
|
62423
|
+
"value": "V"
|
|
62424
|
+
}
|
|
62425
|
+
]
|
|
62426
|
+
}
|
|
62427
|
+
],
|
|
62428
|
+
"value": "VariableValuesStencil<V>"
|
|
62429
|
+
}
|
|
62430
|
+
]
|
|
62431
|
+
},
|
|
62432
|
+
"falseType": {
|
|
62433
|
+
"kind": "primitive",
|
|
62434
|
+
"value": "never"
|
|
62435
|
+
}
|
|
62436
|
+
}
|
|
62297
62437
|
},
|
|
62298
|
-
"
|
|
62438
|
+
"required": false,
|
|
62439
|
+
"rest": false,
|
|
62440
|
+
"description": "",
|
|
62299
62441
|
"declarations": [
|
|
62300
62442
|
{
|
|
62301
|
-
"name": "
|
|
62302
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
62443
|
+
"name": "options",
|
|
62444
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62303
62445
|
}
|
|
62304
62446
|
],
|
|
62305
62447
|
"tags": {}
|
|
62306
|
-
}
|
|
62448
|
+
}
|
|
62449
|
+
],
|
|
62450
|
+
"members": [
|
|
62307
62451
|
{
|
|
62308
62452
|
"kind": "property",
|
|
62309
|
-
"name": "
|
|
62310
|
-
"required":
|
|
62453
|
+
"name": "vars",
|
|
62454
|
+
"required": true,
|
|
62311
62455
|
"type": {
|
|
62312
62456
|
"kind": "symbol",
|
|
62313
|
-
"name": "
|
|
62314
|
-
"
|
|
62457
|
+
"name": "StencilDefaultVars",
|
|
62458
|
+
"typeParameters": [
|
|
62459
|
+
{
|
|
62460
|
+
"kind": "symbol",
|
|
62461
|
+
"name": "V",
|
|
62462
|
+
"value": "V"
|
|
62463
|
+
},
|
|
62464
|
+
{
|
|
62465
|
+
"kind": "symbol",
|
|
62466
|
+
"name": "E",
|
|
62467
|
+
"value": "E"
|
|
62468
|
+
},
|
|
62469
|
+
{
|
|
62470
|
+
"kind": "symbol",
|
|
62471
|
+
"name": "ID",
|
|
62472
|
+
"value": "ID"
|
|
62473
|
+
}
|
|
62474
|
+
],
|
|
62475
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
62315
62476
|
},
|
|
62316
|
-
"description": "
|
|
62477
|
+
"description": "",
|
|
62317
62478
|
"declarations": [
|
|
62318
62479
|
{
|
|
62319
|
-
"name": "
|
|
62480
|
+
"name": "vars",
|
|
62320
62481
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62321
62482
|
}
|
|
62322
62483
|
],
|
|
@@ -62324,136 +62485,1422 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
62324
62485
|
},
|
|
62325
62486
|
{
|
|
62326
62487
|
"kind": "property",
|
|
62327
|
-
"name": "
|
|
62328
|
-
"
|
|
62329
|
-
"tags": {},
|
|
62330
|
-
"declarations": [],
|
|
62488
|
+
"name": "base",
|
|
62489
|
+
"required": true,
|
|
62331
62490
|
"type": {
|
|
62332
|
-
"kind": "
|
|
62333
|
-
"
|
|
62334
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
62491
|
+
"kind": "primitive",
|
|
62492
|
+
"value": "string"
|
|
62335
62493
|
},
|
|
62336
|
-
"
|
|
62337
|
-
|
|
62338
|
-
|
|
62339
|
-
|
|
62340
|
-
|
|
62494
|
+
"description": "",
|
|
62495
|
+
"declarations": [
|
|
62496
|
+
{
|
|
62497
|
+
"name": "base",
|
|
62498
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62499
|
+
}
|
|
62500
|
+
],
|
|
62501
|
+
"tags": {}
|
|
62341
62502
|
},
|
|
62342
62503
|
{
|
|
62343
62504
|
"kind": "property",
|
|
62344
|
-
"name": "
|
|
62345
|
-
"
|
|
62346
|
-
"tags": {},
|
|
62347
|
-
"declarations": [],
|
|
62505
|
+
"name": "modifiers",
|
|
62506
|
+
"required": true,
|
|
62348
62507
|
"type": {
|
|
62349
|
-
"kind": "
|
|
62350
|
-
"
|
|
62351
|
-
|
|
62352
|
-
|
|
62353
|
-
|
|
62354
|
-
|
|
62355
|
-
|
|
62356
|
-
|
|
62357
|
-
|
|
62358
|
-
|
|
62359
|
-
|
|
62360
|
-
|
|
62508
|
+
"kind": "conditional",
|
|
62509
|
+
"check": {
|
|
62510
|
+
"kind": "tuple",
|
|
62511
|
+
"value": [
|
|
62512
|
+
{
|
|
62513
|
+
"kind": "symbol",
|
|
62514
|
+
"name": "E",
|
|
62515
|
+
"value": "E"
|
|
62516
|
+
}
|
|
62517
|
+
]
|
|
62518
|
+
},
|
|
62519
|
+
"extends": {
|
|
62520
|
+
"kind": "tuple",
|
|
62521
|
+
"value": [
|
|
62522
|
+
{
|
|
62523
|
+
"kind": "symbol",
|
|
62524
|
+
"name": "BaseStencil",
|
|
62525
|
+
"typeParameters": [
|
|
62526
|
+
{
|
|
62527
|
+
"kind": "infer",
|
|
62528
|
+
"value": {
|
|
62529
|
+
"kind": "typeParameter",
|
|
62530
|
+
"name": "ME",
|
|
62531
|
+
"required": true
|
|
62532
|
+
}
|
|
62533
|
+
},
|
|
62534
|
+
{
|
|
62535
|
+
"kind": "infer",
|
|
62536
|
+
"value": {
|
|
62537
|
+
"kind": "typeParameter",
|
|
62538
|
+
"name": "VE",
|
|
62539
|
+
"required": true
|
|
62540
|
+
}
|
|
62541
|
+
},
|
|
62542
|
+
{
|
|
62543
|
+
"kind": "primitive",
|
|
62544
|
+
"value": "any"
|
|
62545
|
+
},
|
|
62546
|
+
{
|
|
62547
|
+
"kind": "primitive",
|
|
62548
|
+
"value": "any"
|
|
62549
|
+
}
|
|
62550
|
+
],
|
|
62551
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
62552
|
+
}
|
|
62553
|
+
]
|
|
62554
|
+
},
|
|
62555
|
+
"trueType": {
|
|
62556
|
+
"kind": "symbol",
|
|
62557
|
+
"name": "StencilModifierReturn",
|
|
62558
|
+
"typeParameters": [
|
|
62559
|
+
{
|
|
62560
|
+
"kind": "intersection",
|
|
62561
|
+
"value": [
|
|
62562
|
+
{
|
|
62563
|
+
"kind": "symbol",
|
|
62564
|
+
"name": "ME",
|
|
62565
|
+
"value": "ME"
|
|
62566
|
+
},
|
|
62567
|
+
{
|
|
62568
|
+
"kind": "symbol",
|
|
62569
|
+
"name": "M",
|
|
62570
|
+
"value": "M"
|
|
62571
|
+
}
|
|
62572
|
+
]
|
|
62573
|
+
},
|
|
62574
|
+
{
|
|
62575
|
+
"kind": "intersection",
|
|
62576
|
+
"value": [
|
|
62577
|
+
{
|
|
62578
|
+
"kind": "symbol",
|
|
62579
|
+
"name": "VE",
|
|
62580
|
+
"value": "VE"
|
|
62581
|
+
},
|
|
62582
|
+
{
|
|
62583
|
+
"kind": "symbol",
|
|
62584
|
+
"name": "V",
|
|
62585
|
+
"value": "V"
|
|
62586
|
+
}
|
|
62587
|
+
]
|
|
62588
|
+
}
|
|
62589
|
+
],
|
|
62590
|
+
"value": "StencilModifierReturn<M, V>"
|
|
62591
|
+
},
|
|
62592
|
+
"falseType": {
|
|
62593
|
+
"kind": "symbol",
|
|
62594
|
+
"name": "StencilModifierReturn",
|
|
62595
|
+
"typeParameters": [
|
|
62596
|
+
{
|
|
62597
|
+
"kind": "symbol",
|
|
62598
|
+
"name": "M",
|
|
62599
|
+
"value": "M"
|
|
62600
|
+
},
|
|
62601
|
+
{
|
|
62602
|
+
"kind": "symbol",
|
|
62603
|
+
"name": "V",
|
|
62604
|
+
"value": "V"
|
|
62605
|
+
}
|
|
62606
|
+
],
|
|
62607
|
+
"value": "StencilModifierReturn<M, V>"
|
|
62608
|
+
}
|
|
62609
|
+
},
|
|
62610
|
+
"description": "",
|
|
62611
|
+
"declarations": [
|
|
62612
|
+
{
|
|
62613
|
+
"name": "modifiers",
|
|
62614
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62615
|
+
}
|
|
62616
|
+
],
|
|
62617
|
+
"tags": {}
|
|
62618
|
+
},
|
|
62619
|
+
{
|
|
62620
|
+
"kind": "property",
|
|
62621
|
+
"name": "defaultModifiers",
|
|
62622
|
+
"required": true,
|
|
62623
|
+
"type": {
|
|
62624
|
+
"kind": "unknown",
|
|
62625
|
+
"value": "unknown",
|
|
62626
|
+
"text": "{\n [K in keyof M]?: keyof M[K];\n }"
|
|
62627
|
+
},
|
|
62628
|
+
"description": "",
|
|
62629
|
+
"declarations": [
|
|
62630
|
+
{
|
|
62631
|
+
"name": "defaultModifiers",
|
|
62632
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62633
|
+
}
|
|
62634
|
+
],
|
|
62635
|
+
"tags": {}
|
|
62636
|
+
},
|
|
62637
|
+
{
|
|
62638
|
+
"kind": "property",
|
|
62639
|
+
"name": "__extends",
|
|
62640
|
+
"required": false,
|
|
62641
|
+
"type": {
|
|
62642
|
+
"kind": "symbol",
|
|
62643
|
+
"name": "E",
|
|
62644
|
+
"value": "E"
|
|
62645
|
+
},
|
|
62646
|
+
"description": "",
|
|
62647
|
+
"declarations": [
|
|
62648
|
+
{
|
|
62649
|
+
"name": "__extends",
|
|
62650
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62651
|
+
}
|
|
62652
|
+
],
|
|
62653
|
+
"tags": {}
|
|
62654
|
+
},
|
|
62655
|
+
{
|
|
62656
|
+
"kind": "property",
|
|
62657
|
+
"name": "__vars",
|
|
62658
|
+
"required": true,
|
|
62659
|
+
"type": {
|
|
62660
|
+
"kind": "symbol",
|
|
62661
|
+
"name": "V",
|
|
62662
|
+
"value": "V"
|
|
62663
|
+
},
|
|
62664
|
+
"description": "",
|
|
62665
|
+
"declarations": [
|
|
62666
|
+
{
|
|
62667
|
+
"name": "__vars",
|
|
62668
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62669
|
+
}
|
|
62670
|
+
],
|
|
62671
|
+
"tags": {}
|
|
62672
|
+
},
|
|
62673
|
+
{
|
|
62674
|
+
"kind": "property",
|
|
62675
|
+
"name": "__modifiers",
|
|
62676
|
+
"required": true,
|
|
62677
|
+
"type": {
|
|
62678
|
+
"kind": "symbol",
|
|
62679
|
+
"name": "M",
|
|
62680
|
+
"value": "M"
|
|
62681
|
+
},
|
|
62682
|
+
"description": "",
|
|
62683
|
+
"declarations": [
|
|
62684
|
+
{
|
|
62685
|
+
"name": "__modifiers",
|
|
62686
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62687
|
+
}
|
|
62688
|
+
],
|
|
62689
|
+
"tags": {}
|
|
62690
|
+
},
|
|
62691
|
+
{
|
|
62692
|
+
"kind": "property",
|
|
62693
|
+
"name": "__id",
|
|
62694
|
+
"required": true,
|
|
62695
|
+
"type": {
|
|
62696
|
+
"kind": "symbol",
|
|
62697
|
+
"name": "ID",
|
|
62698
|
+
"value": "ID"
|
|
62699
|
+
},
|
|
62700
|
+
"description": "",
|
|
62701
|
+
"declarations": [
|
|
62702
|
+
{
|
|
62703
|
+
"name": "__id",
|
|
62704
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62705
|
+
}
|
|
62706
|
+
],
|
|
62707
|
+
"tags": {}
|
|
62708
|
+
}
|
|
62709
|
+
],
|
|
62710
|
+
"returnType": {
|
|
62711
|
+
"kind": "object",
|
|
62712
|
+
"properties": [
|
|
62713
|
+
{
|
|
62714
|
+
"kind": "property",
|
|
62715
|
+
"name": "className",
|
|
62716
|
+
"required": true,
|
|
62717
|
+
"type": {
|
|
62718
|
+
"kind": "primitive",
|
|
62719
|
+
"value": "string"
|
|
62720
|
+
},
|
|
62721
|
+
"description": "",
|
|
62722
|
+
"declarations": [
|
|
62723
|
+
{
|
|
62724
|
+
"name": "className",
|
|
62725
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62726
|
+
}
|
|
62727
|
+
],
|
|
62728
|
+
"tags": {}
|
|
62729
|
+
},
|
|
62730
|
+
{
|
|
62731
|
+
"kind": "property",
|
|
62732
|
+
"name": "style",
|
|
62733
|
+
"required": false,
|
|
62734
|
+
"type": {
|
|
62735
|
+
"kind": "external",
|
|
62736
|
+
"name": "Record",
|
|
62737
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
62738
|
+
"typeParameters": [
|
|
62739
|
+
{
|
|
62740
|
+
"kind": "primitive",
|
|
62741
|
+
"value": "string"
|
|
62742
|
+
},
|
|
62743
|
+
{
|
|
62744
|
+
"kind": "primitive",
|
|
62745
|
+
"value": "string"
|
|
62746
|
+
}
|
|
62747
|
+
]
|
|
62748
|
+
},
|
|
62749
|
+
"description": "",
|
|
62750
|
+
"declarations": [
|
|
62751
|
+
{
|
|
62752
|
+
"name": "style",
|
|
62753
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62754
|
+
}
|
|
62755
|
+
],
|
|
62756
|
+
"tags": {}
|
|
62757
|
+
}
|
|
62758
|
+
]
|
|
62759
|
+
}
|
|
62760
|
+
}
|
|
62761
|
+
},
|
|
62762
|
+
{
|
|
62763
|
+
"name": "Card",
|
|
62764
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx",
|
|
62765
|
+
"description": "`Card` is a container component that holds a {@link CardBody Card.Body} and an optional\n{@link CardHeading Card.Heading}. `Card` wraps a non-semantic `div` element. The element can be\nreplaced using the `as` prop, or a `role` or other `aria-*` attributes can be added to give\n`Card` semantic meaning.\n\n**Note**: Changing the `Card` container to certain semantic elements will put accessibility at\nrisk. For example, using the `as` prop to change the cards to buttons will flatten the content in\nthe card. Headings, calls to action, etc. will not function as expected for users with\ndisabilities. Semantic container elements like `<section>`, or using `<li>` grouped together in a\ncommon `<ul>` can be a useful way to elevate the accessibility of your design.",
|
|
62766
|
+
"declarations": [
|
|
62767
|
+
{
|
|
62768
|
+
"name": "Card",
|
|
62769
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx"
|
|
62770
|
+
}
|
|
62771
|
+
],
|
|
62772
|
+
"tags": {},
|
|
62773
|
+
"type": {
|
|
62774
|
+
"kind": "enhancedComponent",
|
|
62775
|
+
"componentType": "regular",
|
|
62776
|
+
"displayName": "Card",
|
|
62777
|
+
"props": [
|
|
62778
|
+
{
|
|
62779
|
+
"kind": "property",
|
|
62780
|
+
"name": "children",
|
|
62781
|
+
"required": false,
|
|
62782
|
+
"type": {
|
|
62783
|
+
"kind": "external",
|
|
62784
|
+
"name": "ReactNode",
|
|
62785
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
62786
|
+
},
|
|
62787
|
+
"description": "Children of the Card. Should contain a `<Card.Body>` and an optional `<Card.Heading>`",
|
|
62788
|
+
"declarations": [
|
|
62789
|
+
{
|
|
62790
|
+
"name": "children",
|
|
62791
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx"
|
|
62792
|
+
}
|
|
62793
|
+
],
|
|
62794
|
+
"tags": {}
|
|
62795
|
+
},
|
|
62796
|
+
{
|
|
62797
|
+
"kind": "property",
|
|
62798
|
+
"name": "cs",
|
|
62799
|
+
"required": false,
|
|
62800
|
+
"type": {
|
|
62801
|
+
"kind": "symbol",
|
|
62802
|
+
"name": "CSToPropsInput",
|
|
62803
|
+
"value": "CSToPropsInput"
|
|
62804
|
+
},
|
|
62805
|
+
"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```",
|
|
62806
|
+
"declarations": [
|
|
62807
|
+
{
|
|
62808
|
+
"name": "cs",
|
|
62809
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62810
|
+
}
|
|
62811
|
+
],
|
|
62812
|
+
"tags": {}
|
|
62813
|
+
},
|
|
62814
|
+
{
|
|
62815
|
+
"kind": "property",
|
|
62816
|
+
"name": "as",
|
|
62817
|
+
"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.",
|
|
62818
|
+
"tags": {},
|
|
62819
|
+
"declarations": [],
|
|
62820
|
+
"type": {
|
|
62821
|
+
"kind": "external",
|
|
62822
|
+
"name": "React.ElementType",
|
|
62823
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
62824
|
+
},
|
|
62825
|
+
"defaultValue": {
|
|
62826
|
+
"kind": "external",
|
|
62827
|
+
"name": "div",
|
|
62828
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
62829
|
+
}
|
|
62830
|
+
},
|
|
62831
|
+
{
|
|
62832
|
+
"kind": "property",
|
|
62833
|
+
"name": "ref",
|
|
62834
|
+
"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`).",
|
|
62835
|
+
"tags": {},
|
|
62836
|
+
"declarations": [],
|
|
62837
|
+
"type": {
|
|
62838
|
+
"kind": "external",
|
|
62839
|
+
"name": "React.Ref",
|
|
62840
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
62841
|
+
"typeParameters": [
|
|
62842
|
+
{
|
|
62843
|
+
"kind": "typeParameter",
|
|
62844
|
+
"name": "R",
|
|
62845
|
+
"required": true,
|
|
62846
|
+
"defaultValue": {
|
|
62847
|
+
"kind": "external",
|
|
62848
|
+
"name": "div",
|
|
62849
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
62850
|
+
}
|
|
62851
|
+
}
|
|
62852
|
+
]
|
|
62853
|
+
}
|
|
62854
|
+
}
|
|
62855
|
+
],
|
|
62856
|
+
"baseElement": {
|
|
62857
|
+
"kind": "external",
|
|
62858
|
+
"name": "div",
|
|
62859
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
62860
|
+
},
|
|
62861
|
+
"subComponents": [
|
|
62862
|
+
{
|
|
62863
|
+
"name": "Heading",
|
|
62864
|
+
"symbol": "CardHeading",
|
|
62865
|
+
"description": "`Card.Heading` is an optional subcomponent that is meant to describe the Card. Since `Card`\nis a non-semantic presentational component, `Card.Heading` does not automatically have any\nsemantic meaning. If your use case requires the Heading to label the Card, you must do so\nmanually.\n\nFor example, {@link Modal} (which uses a `Card`) adds an `aria-labelledby` and a `role` to\nthe `Card`, as well as an `id` to the `Card.Heading`.\n\n```tsx\n<Card role=\"dialog\" aria-labelledby=\"card-heading\">\n <Card.Heading id=\"card-heading\">Card Title</Card.Heading>\n <Card.Body>Card Contents</Card.Body>\n</Card>\n```\n\n`Card.Heading` defaults to an `<h3>` element, but it can be changed using the `as` prop.",
|
|
62866
|
+
"declarations": [
|
|
62867
|
+
{
|
|
62868
|
+
"name": "Heading",
|
|
62869
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx"
|
|
62870
|
+
},
|
|
62871
|
+
{
|
|
62872
|
+
"name": "CardHeading",
|
|
62873
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx"
|
|
62874
|
+
}
|
|
62875
|
+
],
|
|
62876
|
+
"tags": {}
|
|
62877
|
+
},
|
|
62878
|
+
{
|
|
62879
|
+
"name": "Body",
|
|
62880
|
+
"symbol": "CardBody",
|
|
62881
|
+
"description": "`Card.Body` is a non-semantic subcomponent that contains the body of the card. Attributes may\nbe added to give `Card.Body` semantic meaning. If `Card.Body` is brief (like in a short\ndialog), it may be helpful to add an `aria-describedby` referencing the `id` of the\n`Card.Body` to the `Card` container.",
|
|
62882
|
+
"declarations": [
|
|
62883
|
+
{
|
|
62884
|
+
"name": "Body",
|
|
62885
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/Card.tsx"
|
|
62886
|
+
},
|
|
62887
|
+
{
|
|
62888
|
+
"name": "CardBody",
|
|
62889
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
62890
|
+
}
|
|
62891
|
+
],
|
|
62892
|
+
"tags": {}
|
|
62893
|
+
}
|
|
62894
|
+
],
|
|
62895
|
+
"styleComponent": {
|
|
62896
|
+
"kind": "symbol",
|
|
62897
|
+
"name": "Box"
|
|
62898
|
+
}
|
|
62899
|
+
}
|
|
62900
|
+
},
|
|
62901
|
+
{
|
|
62902
|
+
"name": "CardBodyProps",
|
|
62903
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
62904
|
+
"description": "",
|
|
62905
|
+
"declarations": [
|
|
62906
|
+
{
|
|
62907
|
+
"name": "CardBodyProps",
|
|
62908
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
62909
|
+
}
|
|
62910
|
+
],
|
|
62911
|
+
"tags": {},
|
|
62912
|
+
"type": {
|
|
62913
|
+
"kind": "alias",
|
|
62914
|
+
"name": "CardBody"
|
|
62915
|
+
}
|
|
62916
|
+
},
|
|
62917
|
+
{
|
|
62918
|
+
"name": "cardBodyStencil",
|
|
62919
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
62920
|
+
"description": "",
|
|
62921
|
+
"declarations": [
|
|
62922
|
+
{
|
|
62923
|
+
"name": "cardBodyStencil",
|
|
62924
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
62925
|
+
}
|
|
62926
|
+
],
|
|
62927
|
+
"tags": {},
|
|
62928
|
+
"type": {
|
|
62929
|
+
"kind": "function",
|
|
62930
|
+
"parameters": [
|
|
62931
|
+
{
|
|
62932
|
+
"kind": "parameter",
|
|
62933
|
+
"name": "options",
|
|
62934
|
+
"type": {
|
|
62935
|
+
"kind": "conditional",
|
|
62936
|
+
"check": {
|
|
62937
|
+
"kind": "tuple",
|
|
62938
|
+
"value": [
|
|
62939
|
+
{
|
|
62940
|
+
"kind": "symbol",
|
|
62941
|
+
"name": "E",
|
|
62942
|
+
"value": "E"
|
|
62943
|
+
}
|
|
62944
|
+
]
|
|
62945
|
+
},
|
|
62946
|
+
"extends": {
|
|
62947
|
+
"kind": "tuple",
|
|
62948
|
+
"value": [
|
|
62949
|
+
{
|
|
62950
|
+
"kind": "primitive",
|
|
62951
|
+
"value": "never"
|
|
62952
|
+
}
|
|
62953
|
+
]
|
|
62954
|
+
},
|
|
62955
|
+
"trueType": {
|
|
62956
|
+
"kind": "intersection",
|
|
62957
|
+
"value": [
|
|
62958
|
+
{
|
|
62959
|
+
"kind": "symbol",
|
|
62960
|
+
"name": "ModifierValuesStencil",
|
|
62961
|
+
"typeParameters": [
|
|
62962
|
+
{
|
|
62963
|
+
"kind": "symbol",
|
|
62964
|
+
"name": "M",
|
|
62965
|
+
"value": "M"
|
|
62966
|
+
},
|
|
62967
|
+
{
|
|
62968
|
+
"kind": "symbol",
|
|
62969
|
+
"name": "V",
|
|
62970
|
+
"value": "V"
|
|
62971
|
+
}
|
|
62972
|
+
],
|
|
62973
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
62974
|
+
},
|
|
62975
|
+
{
|
|
62976
|
+
"kind": "symbol",
|
|
62977
|
+
"name": "VariableValuesStencil",
|
|
62978
|
+
"typeParameters": [
|
|
62979
|
+
{
|
|
62980
|
+
"kind": "symbol",
|
|
62981
|
+
"name": "V",
|
|
62982
|
+
"value": "V"
|
|
62983
|
+
}
|
|
62984
|
+
],
|
|
62985
|
+
"value": "VariableValuesStencil<V>"
|
|
62986
|
+
}
|
|
62987
|
+
]
|
|
62988
|
+
},
|
|
62989
|
+
"falseType": {
|
|
62990
|
+
"kind": "conditional",
|
|
62991
|
+
"check": {
|
|
62992
|
+
"kind": "symbol",
|
|
62993
|
+
"name": "E",
|
|
62994
|
+
"value": "E"
|
|
62995
|
+
},
|
|
62996
|
+
"extends": {
|
|
62997
|
+
"kind": "symbol",
|
|
62998
|
+
"name": "BaseStencil",
|
|
62999
|
+
"typeParameters": [
|
|
63000
|
+
{
|
|
63001
|
+
"kind": "infer",
|
|
63002
|
+
"value": {
|
|
63003
|
+
"kind": "typeParameter",
|
|
63004
|
+
"name": "ME",
|
|
63005
|
+
"required": true
|
|
63006
|
+
}
|
|
63007
|
+
},
|
|
63008
|
+
{
|
|
63009
|
+
"kind": "infer",
|
|
63010
|
+
"value": {
|
|
63011
|
+
"kind": "typeParameter",
|
|
63012
|
+
"name": "VE",
|
|
63013
|
+
"required": true
|
|
63014
|
+
}
|
|
63015
|
+
},
|
|
63016
|
+
{
|
|
63017
|
+
"kind": "primitive",
|
|
63018
|
+
"value": "any"
|
|
63019
|
+
},
|
|
63020
|
+
{
|
|
63021
|
+
"kind": "primitive",
|
|
63022
|
+
"value": "any"
|
|
63023
|
+
}
|
|
63024
|
+
],
|
|
63025
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
63026
|
+
},
|
|
63027
|
+
"trueType": {
|
|
63028
|
+
"kind": "intersection",
|
|
63029
|
+
"value": [
|
|
63030
|
+
{
|
|
63031
|
+
"kind": "symbol",
|
|
63032
|
+
"name": "ModifierValuesStencil",
|
|
63033
|
+
"typeParameters": [
|
|
63034
|
+
{
|
|
63035
|
+
"kind": "intersection",
|
|
63036
|
+
"value": [
|
|
63037
|
+
{
|
|
63038
|
+
"kind": "symbol",
|
|
63039
|
+
"name": "ME",
|
|
63040
|
+
"value": "ME"
|
|
63041
|
+
},
|
|
63042
|
+
{
|
|
63043
|
+
"kind": "symbol",
|
|
63044
|
+
"name": "M",
|
|
63045
|
+
"value": "M"
|
|
63046
|
+
}
|
|
63047
|
+
]
|
|
63048
|
+
}
|
|
63049
|
+
],
|
|
63050
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
63051
|
+
},
|
|
63052
|
+
{
|
|
63053
|
+
"kind": "symbol",
|
|
63054
|
+
"name": "VariableValuesStencil",
|
|
63055
|
+
"typeParameters": [
|
|
63056
|
+
{
|
|
63057
|
+
"kind": "intersection",
|
|
63058
|
+
"value": [
|
|
63059
|
+
{
|
|
63060
|
+
"kind": "symbol",
|
|
63061
|
+
"name": "VE",
|
|
63062
|
+
"value": "VE"
|
|
63063
|
+
},
|
|
63064
|
+
{
|
|
63065
|
+
"kind": "symbol",
|
|
63066
|
+
"name": "V",
|
|
63067
|
+
"value": "V"
|
|
63068
|
+
}
|
|
63069
|
+
]
|
|
63070
|
+
}
|
|
63071
|
+
],
|
|
63072
|
+
"value": "VariableValuesStencil<V>"
|
|
63073
|
+
}
|
|
63074
|
+
]
|
|
63075
|
+
},
|
|
63076
|
+
"falseType": {
|
|
63077
|
+
"kind": "primitive",
|
|
63078
|
+
"value": "never"
|
|
63079
|
+
}
|
|
63080
|
+
}
|
|
63081
|
+
},
|
|
63082
|
+
"required": false,
|
|
63083
|
+
"rest": false,
|
|
63084
|
+
"description": "",
|
|
63085
|
+
"declarations": [
|
|
63086
|
+
{
|
|
63087
|
+
"name": "options",
|
|
63088
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63089
|
+
}
|
|
63090
|
+
],
|
|
63091
|
+
"tags": {}
|
|
63092
|
+
}
|
|
63093
|
+
],
|
|
63094
|
+
"members": [
|
|
63095
|
+
{
|
|
63096
|
+
"kind": "property",
|
|
63097
|
+
"name": "vars",
|
|
63098
|
+
"required": true,
|
|
63099
|
+
"type": {
|
|
63100
|
+
"kind": "symbol",
|
|
63101
|
+
"name": "StencilDefaultVars",
|
|
63102
|
+
"typeParameters": [
|
|
63103
|
+
{
|
|
63104
|
+
"kind": "symbol",
|
|
63105
|
+
"name": "V",
|
|
63106
|
+
"value": "V"
|
|
63107
|
+
},
|
|
63108
|
+
{
|
|
63109
|
+
"kind": "symbol",
|
|
63110
|
+
"name": "E",
|
|
63111
|
+
"value": "E"
|
|
63112
|
+
},
|
|
63113
|
+
{
|
|
63114
|
+
"kind": "symbol",
|
|
63115
|
+
"name": "ID",
|
|
63116
|
+
"value": "ID"
|
|
63117
|
+
}
|
|
63118
|
+
],
|
|
63119
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
63120
|
+
},
|
|
63121
|
+
"description": "",
|
|
63122
|
+
"declarations": [
|
|
63123
|
+
{
|
|
63124
|
+
"name": "vars",
|
|
63125
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63126
|
+
}
|
|
63127
|
+
],
|
|
63128
|
+
"tags": {}
|
|
63129
|
+
},
|
|
63130
|
+
{
|
|
63131
|
+
"kind": "property",
|
|
63132
|
+
"name": "base",
|
|
63133
|
+
"required": true,
|
|
63134
|
+
"type": {
|
|
63135
|
+
"kind": "primitive",
|
|
63136
|
+
"value": "string"
|
|
63137
|
+
},
|
|
63138
|
+
"description": "",
|
|
63139
|
+
"declarations": [
|
|
63140
|
+
{
|
|
63141
|
+
"name": "base",
|
|
63142
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63143
|
+
}
|
|
63144
|
+
],
|
|
63145
|
+
"tags": {}
|
|
63146
|
+
},
|
|
63147
|
+
{
|
|
63148
|
+
"kind": "property",
|
|
63149
|
+
"name": "modifiers",
|
|
63150
|
+
"required": true,
|
|
63151
|
+
"type": {
|
|
63152
|
+
"kind": "conditional",
|
|
63153
|
+
"check": {
|
|
63154
|
+
"kind": "tuple",
|
|
63155
|
+
"value": [
|
|
63156
|
+
{
|
|
63157
|
+
"kind": "symbol",
|
|
63158
|
+
"name": "E",
|
|
63159
|
+
"value": "E"
|
|
63160
|
+
}
|
|
63161
|
+
]
|
|
63162
|
+
},
|
|
63163
|
+
"extends": {
|
|
63164
|
+
"kind": "tuple",
|
|
63165
|
+
"value": [
|
|
63166
|
+
{
|
|
63167
|
+
"kind": "symbol",
|
|
63168
|
+
"name": "BaseStencil",
|
|
63169
|
+
"typeParameters": [
|
|
63170
|
+
{
|
|
63171
|
+
"kind": "infer",
|
|
63172
|
+
"value": {
|
|
63173
|
+
"kind": "typeParameter",
|
|
63174
|
+
"name": "ME",
|
|
63175
|
+
"required": true
|
|
63176
|
+
}
|
|
63177
|
+
},
|
|
63178
|
+
{
|
|
63179
|
+
"kind": "infer",
|
|
63180
|
+
"value": {
|
|
63181
|
+
"kind": "typeParameter",
|
|
63182
|
+
"name": "VE",
|
|
63183
|
+
"required": true
|
|
63184
|
+
}
|
|
63185
|
+
},
|
|
63186
|
+
{
|
|
63187
|
+
"kind": "primitive",
|
|
63188
|
+
"value": "any"
|
|
63189
|
+
},
|
|
63190
|
+
{
|
|
63191
|
+
"kind": "primitive",
|
|
63192
|
+
"value": "any"
|
|
63193
|
+
}
|
|
63194
|
+
],
|
|
63195
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
63196
|
+
}
|
|
63197
|
+
]
|
|
63198
|
+
},
|
|
63199
|
+
"trueType": {
|
|
63200
|
+
"kind": "symbol",
|
|
63201
|
+
"name": "StencilModifierReturn",
|
|
63202
|
+
"typeParameters": [
|
|
63203
|
+
{
|
|
63204
|
+
"kind": "intersection",
|
|
63205
|
+
"value": [
|
|
63206
|
+
{
|
|
63207
|
+
"kind": "symbol",
|
|
63208
|
+
"name": "ME",
|
|
63209
|
+
"value": "ME"
|
|
63210
|
+
},
|
|
63211
|
+
{
|
|
63212
|
+
"kind": "symbol",
|
|
63213
|
+
"name": "M",
|
|
63214
|
+
"value": "M"
|
|
63215
|
+
}
|
|
63216
|
+
]
|
|
63217
|
+
},
|
|
63218
|
+
{
|
|
63219
|
+
"kind": "intersection",
|
|
63220
|
+
"value": [
|
|
63221
|
+
{
|
|
63222
|
+
"kind": "symbol",
|
|
63223
|
+
"name": "VE",
|
|
63224
|
+
"value": "VE"
|
|
63225
|
+
},
|
|
63226
|
+
{
|
|
63227
|
+
"kind": "symbol",
|
|
63228
|
+
"name": "V",
|
|
63229
|
+
"value": "V"
|
|
63230
|
+
}
|
|
63231
|
+
]
|
|
63232
|
+
}
|
|
63233
|
+
],
|
|
63234
|
+
"value": "StencilModifierReturn<M, V>"
|
|
63235
|
+
},
|
|
63236
|
+
"falseType": {
|
|
63237
|
+
"kind": "symbol",
|
|
63238
|
+
"name": "StencilModifierReturn",
|
|
63239
|
+
"typeParameters": [
|
|
63240
|
+
{
|
|
63241
|
+
"kind": "symbol",
|
|
63242
|
+
"name": "M",
|
|
63243
|
+
"value": "M"
|
|
63244
|
+
},
|
|
63245
|
+
{
|
|
63246
|
+
"kind": "symbol",
|
|
63247
|
+
"name": "V",
|
|
63248
|
+
"value": "V"
|
|
63249
|
+
}
|
|
63250
|
+
],
|
|
63251
|
+
"value": "StencilModifierReturn<M, V>"
|
|
63252
|
+
}
|
|
63253
|
+
},
|
|
63254
|
+
"description": "",
|
|
63255
|
+
"declarations": [
|
|
63256
|
+
{
|
|
63257
|
+
"name": "modifiers",
|
|
63258
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63259
|
+
}
|
|
63260
|
+
],
|
|
63261
|
+
"tags": {}
|
|
63262
|
+
},
|
|
63263
|
+
{
|
|
63264
|
+
"kind": "property",
|
|
63265
|
+
"name": "defaultModifiers",
|
|
63266
|
+
"required": true,
|
|
63267
|
+
"type": {
|
|
63268
|
+
"kind": "unknown",
|
|
63269
|
+
"value": "unknown",
|
|
63270
|
+
"text": "{\n [K in keyof M]?: keyof M[K];\n }"
|
|
63271
|
+
},
|
|
63272
|
+
"description": "",
|
|
63273
|
+
"declarations": [
|
|
63274
|
+
{
|
|
63275
|
+
"name": "defaultModifiers",
|
|
63276
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63277
|
+
}
|
|
63278
|
+
],
|
|
63279
|
+
"tags": {}
|
|
63280
|
+
},
|
|
63281
|
+
{
|
|
63282
|
+
"kind": "property",
|
|
63283
|
+
"name": "__extends",
|
|
63284
|
+
"required": false,
|
|
63285
|
+
"type": {
|
|
63286
|
+
"kind": "symbol",
|
|
63287
|
+
"name": "E",
|
|
63288
|
+
"value": "E"
|
|
63289
|
+
},
|
|
63290
|
+
"description": "",
|
|
63291
|
+
"declarations": [
|
|
63292
|
+
{
|
|
63293
|
+
"name": "__extends",
|
|
63294
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63295
|
+
}
|
|
63296
|
+
],
|
|
63297
|
+
"tags": {}
|
|
63298
|
+
},
|
|
63299
|
+
{
|
|
63300
|
+
"kind": "property",
|
|
63301
|
+
"name": "__vars",
|
|
63302
|
+
"required": true,
|
|
63303
|
+
"type": {
|
|
63304
|
+
"kind": "symbol",
|
|
63305
|
+
"name": "V",
|
|
63306
|
+
"value": "V"
|
|
63307
|
+
},
|
|
63308
|
+
"description": "",
|
|
63309
|
+
"declarations": [
|
|
63310
|
+
{
|
|
63311
|
+
"name": "__vars",
|
|
63312
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63313
|
+
}
|
|
63314
|
+
],
|
|
63315
|
+
"tags": {}
|
|
63316
|
+
},
|
|
63317
|
+
{
|
|
63318
|
+
"kind": "property",
|
|
63319
|
+
"name": "__modifiers",
|
|
63320
|
+
"required": true,
|
|
63321
|
+
"type": {
|
|
63322
|
+
"kind": "symbol",
|
|
63323
|
+
"name": "M",
|
|
63324
|
+
"value": "M"
|
|
63325
|
+
},
|
|
63326
|
+
"description": "",
|
|
63327
|
+
"declarations": [
|
|
63328
|
+
{
|
|
63329
|
+
"name": "__modifiers",
|
|
63330
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63331
|
+
}
|
|
63332
|
+
],
|
|
63333
|
+
"tags": {}
|
|
63334
|
+
},
|
|
63335
|
+
{
|
|
63336
|
+
"kind": "property",
|
|
63337
|
+
"name": "__id",
|
|
63338
|
+
"required": true,
|
|
63339
|
+
"type": {
|
|
63340
|
+
"kind": "symbol",
|
|
63341
|
+
"name": "ID",
|
|
63342
|
+
"value": "ID"
|
|
63343
|
+
},
|
|
63344
|
+
"description": "",
|
|
63345
|
+
"declarations": [
|
|
63346
|
+
{
|
|
63347
|
+
"name": "__id",
|
|
63348
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63349
|
+
}
|
|
63350
|
+
],
|
|
63351
|
+
"tags": {}
|
|
63352
|
+
}
|
|
63353
|
+
],
|
|
63354
|
+
"returnType": {
|
|
63355
|
+
"kind": "object",
|
|
63356
|
+
"properties": [
|
|
63357
|
+
{
|
|
63358
|
+
"kind": "property",
|
|
63359
|
+
"name": "className",
|
|
63360
|
+
"required": true,
|
|
63361
|
+
"type": {
|
|
63362
|
+
"kind": "primitive",
|
|
63363
|
+
"value": "string"
|
|
63364
|
+
},
|
|
63365
|
+
"description": "",
|
|
63366
|
+
"declarations": [
|
|
63367
|
+
{
|
|
63368
|
+
"name": "className",
|
|
63369
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63370
|
+
}
|
|
63371
|
+
],
|
|
63372
|
+
"tags": {}
|
|
63373
|
+
},
|
|
63374
|
+
{
|
|
63375
|
+
"kind": "property",
|
|
63376
|
+
"name": "style",
|
|
63377
|
+
"required": false,
|
|
63378
|
+
"type": {
|
|
63379
|
+
"kind": "external",
|
|
63380
|
+
"name": "Record",
|
|
63381
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
63382
|
+
"typeParameters": [
|
|
63383
|
+
{
|
|
63384
|
+
"kind": "primitive",
|
|
63385
|
+
"value": "string"
|
|
63386
|
+
},
|
|
63387
|
+
{
|
|
63388
|
+
"kind": "primitive",
|
|
63389
|
+
"value": "string"
|
|
63390
|
+
}
|
|
63391
|
+
]
|
|
63392
|
+
},
|
|
63393
|
+
"description": "",
|
|
63394
|
+
"declarations": [
|
|
63395
|
+
{
|
|
63396
|
+
"name": "style",
|
|
63397
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63398
|
+
}
|
|
63399
|
+
],
|
|
63400
|
+
"tags": {}
|
|
63401
|
+
}
|
|
63402
|
+
]
|
|
63403
|
+
}
|
|
63404
|
+
}
|
|
63405
|
+
},
|
|
63406
|
+
{
|
|
63407
|
+
"name": "CardBody",
|
|
63408
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
63409
|
+
"description": "",
|
|
63410
|
+
"declarations": [
|
|
63411
|
+
{
|
|
63412
|
+
"name": "CardBody",
|
|
63413
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
63414
|
+
}
|
|
63415
|
+
],
|
|
63416
|
+
"tags": {},
|
|
63417
|
+
"type": {
|
|
63418
|
+
"kind": "enhancedComponent",
|
|
63419
|
+
"componentType": "regular",
|
|
63420
|
+
"displayName": "Card.Body",
|
|
63421
|
+
"props": [
|
|
63422
|
+
{
|
|
63423
|
+
"kind": "property",
|
|
63424
|
+
"name": "cs",
|
|
63425
|
+
"required": false,
|
|
63426
|
+
"type": {
|
|
63427
|
+
"kind": "symbol",
|
|
63428
|
+
"name": "CSToPropsInput",
|
|
63429
|
+
"value": "CSToPropsInput"
|
|
63430
|
+
},
|
|
63431
|
+
"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```",
|
|
63432
|
+
"declarations": [
|
|
63433
|
+
{
|
|
63434
|
+
"name": "cs",
|
|
63435
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63436
|
+
}
|
|
63437
|
+
],
|
|
63438
|
+
"tags": {}
|
|
63439
|
+
},
|
|
63440
|
+
{
|
|
63441
|
+
"kind": "property",
|
|
63442
|
+
"name": "children",
|
|
63443
|
+
"required": false,
|
|
63444
|
+
"type": {
|
|
63445
|
+
"kind": "external",
|
|
63446
|
+
"name": "ReactNode",
|
|
63447
|
+
"url": "https://reactjs.org/docs/rendering-elements.html"
|
|
63448
|
+
},
|
|
63449
|
+
"description": "",
|
|
63450
|
+
"declarations": [
|
|
63451
|
+
{
|
|
63452
|
+
"name": "children",
|
|
63453
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/layout/lib/Box.tsx"
|
|
63454
|
+
}
|
|
63455
|
+
],
|
|
63456
|
+
"tags": {}
|
|
63457
|
+
},
|
|
63458
|
+
{
|
|
63459
|
+
"kind": "property",
|
|
63460
|
+
"name": "as",
|
|
63461
|
+
"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.",
|
|
63462
|
+
"tags": {},
|
|
63463
|
+
"declarations": [],
|
|
63464
|
+
"type": {
|
|
63465
|
+
"kind": "external",
|
|
63466
|
+
"name": "React.ElementType",
|
|
63467
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
|
|
63468
|
+
},
|
|
63469
|
+
"defaultValue": {
|
|
63470
|
+
"kind": "external",
|
|
63471
|
+
"name": "div",
|
|
63472
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
63473
|
+
}
|
|
63474
|
+
},
|
|
63475
|
+
{
|
|
63476
|
+
"kind": "property",
|
|
63477
|
+
"name": "ref",
|
|
63478
|
+
"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`).",
|
|
63479
|
+
"tags": {},
|
|
63480
|
+
"declarations": [],
|
|
63481
|
+
"type": {
|
|
63482
|
+
"kind": "external",
|
|
63483
|
+
"name": "React.Ref",
|
|
63484
|
+
"url": "https://reactjs.org/docs/refs-and-the-dom.html",
|
|
63485
|
+
"typeParameters": [
|
|
63486
|
+
{
|
|
63487
|
+
"kind": "typeParameter",
|
|
63488
|
+
"name": "R",
|
|
63489
|
+
"required": true,
|
|
63490
|
+
"defaultValue": {
|
|
63491
|
+
"kind": "external",
|
|
63492
|
+
"name": "div",
|
|
63493
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
63494
|
+
}
|
|
63495
|
+
}
|
|
63496
|
+
]
|
|
63497
|
+
}
|
|
63498
|
+
}
|
|
63499
|
+
],
|
|
63500
|
+
"baseElement": {
|
|
63501
|
+
"kind": "external",
|
|
63502
|
+
"name": "div",
|
|
63503
|
+
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
63504
|
+
},
|
|
63505
|
+
"styleComponent": {
|
|
63506
|
+
"kind": "symbol",
|
|
63507
|
+
"name": "Box"
|
|
63508
|
+
}
|
|
63509
|
+
}
|
|
63510
|
+
},
|
|
63511
|
+
{
|
|
63512
|
+
"name": "CardHeadingProps",
|
|
63513
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx",
|
|
63514
|
+
"description": "",
|
|
63515
|
+
"declarations": [
|
|
63516
|
+
{
|
|
63517
|
+
"name": "CardHeadingProps",
|
|
63518
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx"
|
|
63519
|
+
}
|
|
63520
|
+
],
|
|
63521
|
+
"tags": {},
|
|
63522
|
+
"type": {
|
|
63523
|
+
"kind": "alias",
|
|
63524
|
+
"name": "CardHeading"
|
|
63525
|
+
}
|
|
63526
|
+
},
|
|
63527
|
+
{
|
|
63528
|
+
"name": "cardHeadingStencil",
|
|
63529
|
+
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx",
|
|
63530
|
+
"description": "",
|
|
63531
|
+
"declarations": [
|
|
63532
|
+
{
|
|
63533
|
+
"name": "cardHeadingStencil",
|
|
63534
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx"
|
|
63535
|
+
}
|
|
63536
|
+
],
|
|
63537
|
+
"tags": {},
|
|
63538
|
+
"type": {
|
|
63539
|
+
"kind": "function",
|
|
63540
|
+
"parameters": [
|
|
63541
|
+
{
|
|
63542
|
+
"kind": "parameter",
|
|
63543
|
+
"name": "options",
|
|
63544
|
+
"type": {
|
|
63545
|
+
"kind": "conditional",
|
|
63546
|
+
"check": {
|
|
63547
|
+
"kind": "tuple",
|
|
63548
|
+
"value": [
|
|
63549
|
+
{
|
|
63550
|
+
"kind": "symbol",
|
|
63551
|
+
"name": "E",
|
|
63552
|
+
"value": "E"
|
|
63553
|
+
}
|
|
63554
|
+
]
|
|
63555
|
+
},
|
|
63556
|
+
"extends": {
|
|
63557
|
+
"kind": "tuple",
|
|
63558
|
+
"value": [
|
|
63559
|
+
{
|
|
63560
|
+
"kind": "primitive",
|
|
63561
|
+
"value": "never"
|
|
63562
|
+
}
|
|
63563
|
+
]
|
|
63564
|
+
},
|
|
63565
|
+
"trueType": {
|
|
63566
|
+
"kind": "intersection",
|
|
63567
|
+
"value": [
|
|
63568
|
+
{
|
|
63569
|
+
"kind": "symbol",
|
|
63570
|
+
"name": "ModifierValuesStencil",
|
|
63571
|
+
"typeParameters": [
|
|
63572
|
+
{
|
|
63573
|
+
"kind": "symbol",
|
|
63574
|
+
"name": "M",
|
|
63575
|
+
"value": "M"
|
|
63576
|
+
},
|
|
63577
|
+
{
|
|
63578
|
+
"kind": "symbol",
|
|
63579
|
+
"name": "V",
|
|
63580
|
+
"value": "V"
|
|
63581
|
+
}
|
|
63582
|
+
],
|
|
63583
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
63584
|
+
},
|
|
63585
|
+
{
|
|
63586
|
+
"kind": "symbol",
|
|
63587
|
+
"name": "VariableValuesStencil",
|
|
63588
|
+
"typeParameters": [
|
|
63589
|
+
{
|
|
63590
|
+
"kind": "symbol",
|
|
63591
|
+
"name": "V",
|
|
63592
|
+
"value": "V"
|
|
63593
|
+
}
|
|
63594
|
+
],
|
|
63595
|
+
"value": "VariableValuesStencil<V>"
|
|
63596
|
+
}
|
|
63597
|
+
]
|
|
63598
|
+
},
|
|
63599
|
+
"falseType": {
|
|
63600
|
+
"kind": "conditional",
|
|
63601
|
+
"check": {
|
|
63602
|
+
"kind": "symbol",
|
|
63603
|
+
"name": "E",
|
|
63604
|
+
"value": "E"
|
|
63605
|
+
},
|
|
63606
|
+
"extends": {
|
|
63607
|
+
"kind": "symbol",
|
|
63608
|
+
"name": "BaseStencil",
|
|
63609
|
+
"typeParameters": [
|
|
63610
|
+
{
|
|
63611
|
+
"kind": "infer",
|
|
63612
|
+
"value": {
|
|
63613
|
+
"kind": "typeParameter",
|
|
63614
|
+
"name": "ME",
|
|
63615
|
+
"required": true
|
|
63616
|
+
}
|
|
63617
|
+
},
|
|
63618
|
+
{
|
|
63619
|
+
"kind": "infer",
|
|
63620
|
+
"value": {
|
|
63621
|
+
"kind": "typeParameter",
|
|
63622
|
+
"name": "VE",
|
|
63623
|
+
"required": true
|
|
63624
|
+
}
|
|
63625
|
+
},
|
|
63626
|
+
{
|
|
63627
|
+
"kind": "primitive",
|
|
63628
|
+
"value": "any"
|
|
63629
|
+
},
|
|
63630
|
+
{
|
|
63631
|
+
"kind": "primitive",
|
|
63632
|
+
"value": "any"
|
|
63633
|
+
}
|
|
63634
|
+
],
|
|
63635
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
63636
|
+
},
|
|
63637
|
+
"trueType": {
|
|
63638
|
+
"kind": "intersection",
|
|
63639
|
+
"value": [
|
|
63640
|
+
{
|
|
63641
|
+
"kind": "symbol",
|
|
63642
|
+
"name": "ModifierValuesStencil",
|
|
63643
|
+
"typeParameters": [
|
|
63644
|
+
{
|
|
63645
|
+
"kind": "intersection",
|
|
63646
|
+
"value": [
|
|
63647
|
+
{
|
|
63648
|
+
"kind": "symbol",
|
|
63649
|
+
"name": "ME",
|
|
63650
|
+
"value": "ME"
|
|
63651
|
+
},
|
|
63652
|
+
{
|
|
63653
|
+
"kind": "symbol",
|
|
63654
|
+
"name": "M",
|
|
63655
|
+
"value": "M"
|
|
63656
|
+
}
|
|
63657
|
+
]
|
|
63658
|
+
}
|
|
63659
|
+
],
|
|
63660
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
63661
|
+
},
|
|
63662
|
+
{
|
|
63663
|
+
"kind": "symbol",
|
|
63664
|
+
"name": "VariableValuesStencil",
|
|
63665
|
+
"typeParameters": [
|
|
63666
|
+
{
|
|
63667
|
+
"kind": "intersection",
|
|
63668
|
+
"value": [
|
|
63669
|
+
{
|
|
63670
|
+
"kind": "symbol",
|
|
63671
|
+
"name": "VE",
|
|
63672
|
+
"value": "VE"
|
|
63673
|
+
},
|
|
63674
|
+
{
|
|
63675
|
+
"kind": "symbol",
|
|
63676
|
+
"name": "V",
|
|
63677
|
+
"value": "V"
|
|
63678
|
+
}
|
|
63679
|
+
]
|
|
63680
|
+
}
|
|
63681
|
+
],
|
|
63682
|
+
"value": "VariableValuesStencil<V>"
|
|
63683
|
+
}
|
|
63684
|
+
]
|
|
63685
|
+
},
|
|
63686
|
+
"falseType": {
|
|
63687
|
+
"kind": "primitive",
|
|
63688
|
+
"value": "never"
|
|
63689
|
+
}
|
|
63690
|
+
}
|
|
63691
|
+
},
|
|
63692
|
+
"required": false,
|
|
63693
|
+
"rest": false,
|
|
63694
|
+
"description": "",
|
|
63695
|
+
"declarations": [
|
|
63696
|
+
{
|
|
63697
|
+
"name": "options",
|
|
63698
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63699
|
+
}
|
|
63700
|
+
],
|
|
63701
|
+
"tags": {}
|
|
63702
|
+
}
|
|
63703
|
+
],
|
|
63704
|
+
"members": [
|
|
63705
|
+
{
|
|
63706
|
+
"kind": "property",
|
|
63707
|
+
"name": "vars",
|
|
63708
|
+
"required": true,
|
|
63709
|
+
"type": {
|
|
63710
|
+
"kind": "symbol",
|
|
63711
|
+
"name": "StencilDefaultVars",
|
|
63712
|
+
"typeParameters": [
|
|
63713
|
+
{
|
|
63714
|
+
"kind": "symbol",
|
|
63715
|
+
"name": "V",
|
|
63716
|
+
"value": "V"
|
|
63717
|
+
},
|
|
63718
|
+
{
|
|
63719
|
+
"kind": "symbol",
|
|
63720
|
+
"name": "E",
|
|
63721
|
+
"value": "E"
|
|
63722
|
+
},
|
|
63723
|
+
{
|
|
63724
|
+
"kind": "symbol",
|
|
63725
|
+
"name": "ID",
|
|
63726
|
+
"value": "ID"
|
|
63727
|
+
}
|
|
63728
|
+
],
|
|
63729
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
63730
|
+
},
|
|
63731
|
+
"description": "",
|
|
63732
|
+
"declarations": [
|
|
63733
|
+
{
|
|
63734
|
+
"name": "vars",
|
|
63735
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63736
|
+
}
|
|
63737
|
+
],
|
|
63738
|
+
"tags": {}
|
|
63739
|
+
},
|
|
63740
|
+
{
|
|
63741
|
+
"kind": "property",
|
|
63742
|
+
"name": "base",
|
|
63743
|
+
"required": true,
|
|
63744
|
+
"type": {
|
|
63745
|
+
"kind": "primitive",
|
|
63746
|
+
"value": "string"
|
|
63747
|
+
},
|
|
63748
|
+
"description": "",
|
|
63749
|
+
"declarations": [
|
|
63750
|
+
{
|
|
63751
|
+
"name": "base",
|
|
63752
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63753
|
+
}
|
|
63754
|
+
],
|
|
63755
|
+
"tags": {}
|
|
63756
|
+
},
|
|
63757
|
+
{
|
|
63758
|
+
"kind": "property",
|
|
63759
|
+
"name": "modifiers",
|
|
63760
|
+
"required": true,
|
|
63761
|
+
"type": {
|
|
63762
|
+
"kind": "conditional",
|
|
63763
|
+
"check": {
|
|
63764
|
+
"kind": "tuple",
|
|
63765
|
+
"value": [
|
|
63766
|
+
{
|
|
63767
|
+
"kind": "symbol",
|
|
63768
|
+
"name": "E",
|
|
63769
|
+
"value": "E"
|
|
63770
|
+
}
|
|
63771
|
+
]
|
|
63772
|
+
},
|
|
63773
|
+
"extends": {
|
|
63774
|
+
"kind": "tuple",
|
|
63775
|
+
"value": [
|
|
63776
|
+
{
|
|
63777
|
+
"kind": "symbol",
|
|
63778
|
+
"name": "BaseStencil",
|
|
63779
|
+
"typeParameters": [
|
|
63780
|
+
{
|
|
63781
|
+
"kind": "infer",
|
|
63782
|
+
"value": {
|
|
63783
|
+
"kind": "typeParameter",
|
|
63784
|
+
"name": "ME",
|
|
63785
|
+
"required": true
|
|
63786
|
+
}
|
|
63787
|
+
},
|
|
63788
|
+
{
|
|
63789
|
+
"kind": "infer",
|
|
63790
|
+
"value": {
|
|
63791
|
+
"kind": "typeParameter",
|
|
63792
|
+
"name": "VE",
|
|
63793
|
+
"required": true
|
|
63794
|
+
}
|
|
63795
|
+
},
|
|
63796
|
+
{
|
|
63797
|
+
"kind": "primitive",
|
|
63798
|
+
"value": "any"
|
|
63799
|
+
},
|
|
63800
|
+
{
|
|
63801
|
+
"kind": "primitive",
|
|
63802
|
+
"value": "any"
|
|
63803
|
+
}
|
|
63804
|
+
],
|
|
63805
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
63806
|
+
}
|
|
63807
|
+
]
|
|
63808
|
+
},
|
|
63809
|
+
"trueType": {
|
|
63810
|
+
"kind": "symbol",
|
|
63811
|
+
"name": "StencilModifierReturn",
|
|
63812
|
+
"typeParameters": [
|
|
63813
|
+
{
|
|
63814
|
+
"kind": "intersection",
|
|
63815
|
+
"value": [
|
|
63816
|
+
{
|
|
63817
|
+
"kind": "symbol",
|
|
63818
|
+
"name": "ME",
|
|
63819
|
+
"value": "ME"
|
|
63820
|
+
},
|
|
63821
|
+
{
|
|
63822
|
+
"kind": "symbol",
|
|
63823
|
+
"name": "M",
|
|
63824
|
+
"value": "M"
|
|
63825
|
+
}
|
|
63826
|
+
]
|
|
63827
|
+
},
|
|
63828
|
+
{
|
|
63829
|
+
"kind": "intersection",
|
|
63830
|
+
"value": [
|
|
63831
|
+
{
|
|
63832
|
+
"kind": "symbol",
|
|
63833
|
+
"name": "VE",
|
|
63834
|
+
"value": "VE"
|
|
63835
|
+
},
|
|
63836
|
+
{
|
|
63837
|
+
"kind": "symbol",
|
|
63838
|
+
"name": "V",
|
|
63839
|
+
"value": "V"
|
|
63840
|
+
}
|
|
63841
|
+
]
|
|
63842
|
+
}
|
|
63843
|
+
],
|
|
63844
|
+
"value": "StencilModifierReturn<M, V>"
|
|
63845
|
+
},
|
|
63846
|
+
"falseType": {
|
|
63847
|
+
"kind": "symbol",
|
|
63848
|
+
"name": "StencilModifierReturn",
|
|
63849
|
+
"typeParameters": [
|
|
63850
|
+
{
|
|
63851
|
+
"kind": "symbol",
|
|
63852
|
+
"name": "M",
|
|
63853
|
+
"value": "M"
|
|
63854
|
+
},
|
|
63855
|
+
{
|
|
63856
|
+
"kind": "symbol",
|
|
63857
|
+
"name": "V",
|
|
63858
|
+
"value": "V"
|
|
62361
63859
|
}
|
|
62362
|
-
|
|
62363
|
-
|
|
62364
|
-
|
|
62365
|
-
|
|
62366
|
-
|
|
62367
|
-
"baseElement": {
|
|
62368
|
-
"kind": "external",
|
|
62369
|
-
"name": "div",
|
|
62370
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
62371
|
-
},
|
|
62372
|
-
"subComponents": [
|
|
62373
|
-
{
|
|
62374
|
-
"name": "Heading",
|
|
62375
|
-
"symbol": "CardHeading",
|
|
62376
|
-
"description": "`Card.Heading` is an optional subcomponent that is meant to describe the Card. Since `Card`\nis a non-semantic presentational component, `Card.Heading` does not automatically have any\nsemantic meaning. If your use case requires the Heading to label the Card, you must do so\nmanually.\n\nFor example, {@link Modal} (which uses a `Card`) adds an `aria-labelledby` and a `role` to\nthe `Card`, as well as an `id` to the `Card.Heading`.\n\n```tsx\n<Card role=\"dialog\" aria-labelledby=\"card-heading\">\n <Card.Heading id=\"card-heading\">Card Title</Card.Heading>\n <Card.Body>Card Contents</Card.Body>\n</Card>\n```\n\n`Card.Heading` defaults to an `<h3>` element, but it can be changed using the `as` prop.",
|
|
63860
|
+
],
|
|
63861
|
+
"value": "StencilModifierReturn<M, V>"
|
|
63862
|
+
}
|
|
63863
|
+
},
|
|
63864
|
+
"description": "",
|
|
62377
63865
|
"declarations": [
|
|
62378
63866
|
{
|
|
62379
|
-
"name": "
|
|
62380
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
62381
|
-
},
|
|
62382
|
-
{
|
|
62383
|
-
"name": "CardHeading",
|
|
62384
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx"
|
|
63867
|
+
"name": "modifiers",
|
|
63868
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62385
63869
|
}
|
|
62386
63870
|
],
|
|
62387
63871
|
"tags": {}
|
|
62388
63872
|
},
|
|
62389
63873
|
{
|
|
62390
|
-
"
|
|
62391
|
-
"
|
|
62392
|
-
"
|
|
63874
|
+
"kind": "property",
|
|
63875
|
+
"name": "defaultModifiers",
|
|
63876
|
+
"required": true,
|
|
63877
|
+
"type": {
|
|
63878
|
+
"kind": "unknown",
|
|
63879
|
+
"value": "unknown",
|
|
63880
|
+
"text": "{\n [K in keyof M]?: keyof M[K];\n }"
|
|
63881
|
+
},
|
|
63882
|
+
"description": "",
|
|
62393
63883
|
"declarations": [
|
|
62394
63884
|
{
|
|
62395
|
-
"name": "
|
|
62396
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
62397
|
-
},
|
|
62398
|
-
{
|
|
62399
|
-
"name": "CardBody",
|
|
62400
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
63885
|
+
"name": "defaultModifiers",
|
|
63886
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62401
63887
|
}
|
|
62402
63888
|
],
|
|
62403
63889
|
"tags": {}
|
|
62404
|
-
}
|
|
62405
|
-
],
|
|
62406
|
-
"styleComponent": {
|
|
62407
|
-
"kind": "symbol",
|
|
62408
|
-
"name": "Box"
|
|
62409
|
-
}
|
|
62410
|
-
}
|
|
62411
|
-
},
|
|
62412
|
-
{
|
|
62413
|
-
"name": "CardBodyProps",
|
|
62414
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
62415
|
-
"description": "",
|
|
62416
|
-
"declarations": [
|
|
62417
|
-
{
|
|
62418
|
-
"name": "CardBodyProps",
|
|
62419
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
62420
|
-
}
|
|
62421
|
-
],
|
|
62422
|
-
"tags": {},
|
|
62423
|
-
"type": {
|
|
62424
|
-
"kind": "alias",
|
|
62425
|
-
"name": "CardBody"
|
|
62426
|
-
}
|
|
62427
|
-
},
|
|
62428
|
-
{
|
|
62429
|
-
"name": "CardBody",
|
|
62430
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx",
|
|
62431
|
-
"description": "",
|
|
62432
|
-
"declarations": [
|
|
62433
|
-
{
|
|
62434
|
-
"name": "CardBody",
|
|
62435
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardBody.tsx"
|
|
62436
|
-
}
|
|
62437
|
-
],
|
|
62438
|
-
"tags": {},
|
|
62439
|
-
"type": {
|
|
62440
|
-
"kind": "enhancedComponent",
|
|
62441
|
-
"componentType": "regular",
|
|
62442
|
-
"displayName": "Card.Body",
|
|
62443
|
-
"props": [
|
|
63890
|
+
},
|
|
62444
63891
|
{
|
|
62445
63892
|
"kind": "property",
|
|
62446
|
-
"name": "
|
|
63893
|
+
"name": "__extends",
|
|
62447
63894
|
"required": false,
|
|
62448
63895
|
"type": {
|
|
62449
63896
|
"kind": "symbol",
|
|
62450
|
-
"name": "
|
|
62451
|
-
"value": "
|
|
63897
|
+
"name": "E",
|
|
63898
|
+
"value": "E"
|
|
62452
63899
|
},
|
|
62453
|
-
"description": "
|
|
63900
|
+
"description": "",
|
|
62454
63901
|
"declarations": [
|
|
62455
63902
|
{
|
|
62456
|
-
"name": "
|
|
63903
|
+
"name": "__extends",
|
|
62457
63904
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62458
63905
|
}
|
|
62459
63906
|
],
|
|
@@ -62461,89 +63908,109 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
62461
63908
|
},
|
|
62462
63909
|
{
|
|
62463
63910
|
"kind": "property",
|
|
62464
|
-
"name": "
|
|
62465
|
-
"required":
|
|
63911
|
+
"name": "__vars",
|
|
63912
|
+
"required": true,
|
|
62466
63913
|
"type": {
|
|
62467
|
-
"kind": "
|
|
62468
|
-
"name": "
|
|
62469
|
-
"
|
|
63914
|
+
"kind": "symbol",
|
|
63915
|
+
"name": "V",
|
|
63916
|
+
"value": "V"
|
|
62470
63917
|
},
|
|
62471
63918
|
"description": "",
|
|
62472
63919
|
"declarations": [
|
|
62473
63920
|
{
|
|
62474
|
-
"name": "
|
|
62475
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/
|
|
63921
|
+
"name": "__vars",
|
|
63922
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62476
63923
|
}
|
|
62477
63924
|
],
|
|
62478
63925
|
"tags": {}
|
|
62479
63926
|
},
|
|
62480
63927
|
{
|
|
62481
63928
|
"kind": "property",
|
|
62482
|
-
"name": "
|
|
62483
|
-
"
|
|
62484
|
-
"tags": {},
|
|
62485
|
-
"declarations": [],
|
|
63929
|
+
"name": "__modifiers",
|
|
63930
|
+
"required": true,
|
|
62486
63931
|
"type": {
|
|
62487
|
-
"kind": "
|
|
62488
|
-
"name": "
|
|
62489
|
-
"
|
|
63932
|
+
"kind": "symbol",
|
|
63933
|
+
"name": "M",
|
|
63934
|
+
"value": "M"
|
|
62490
63935
|
},
|
|
62491
|
-
"
|
|
62492
|
-
|
|
62493
|
-
|
|
62494
|
-
|
|
62495
|
-
|
|
63936
|
+
"description": "",
|
|
63937
|
+
"declarations": [
|
|
63938
|
+
{
|
|
63939
|
+
"name": "__modifiers",
|
|
63940
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63941
|
+
}
|
|
63942
|
+
],
|
|
63943
|
+
"tags": {}
|
|
62496
63944
|
},
|
|
62497
63945
|
{
|
|
62498
63946
|
"kind": "property",
|
|
62499
|
-
"name": "
|
|
62500
|
-
"
|
|
62501
|
-
"tags": {},
|
|
62502
|
-
"declarations": [],
|
|
63947
|
+
"name": "__id",
|
|
63948
|
+
"required": true,
|
|
62503
63949
|
"type": {
|
|
62504
|
-
"kind": "
|
|
62505
|
-
"name": "
|
|
62506
|
-
"
|
|
62507
|
-
|
|
63950
|
+
"kind": "symbol",
|
|
63951
|
+
"name": "ID",
|
|
63952
|
+
"value": "ID"
|
|
63953
|
+
},
|
|
63954
|
+
"description": "",
|
|
63955
|
+
"declarations": [
|
|
63956
|
+
{
|
|
63957
|
+
"name": "__id",
|
|
63958
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63959
|
+
}
|
|
63960
|
+
],
|
|
63961
|
+
"tags": {}
|
|
63962
|
+
}
|
|
63963
|
+
],
|
|
63964
|
+
"returnType": {
|
|
63965
|
+
"kind": "object",
|
|
63966
|
+
"properties": [
|
|
63967
|
+
{
|
|
63968
|
+
"kind": "property",
|
|
63969
|
+
"name": "className",
|
|
63970
|
+
"required": true,
|
|
63971
|
+
"type": {
|
|
63972
|
+
"kind": "primitive",
|
|
63973
|
+
"value": "string"
|
|
63974
|
+
},
|
|
63975
|
+
"description": "",
|
|
63976
|
+
"declarations": [
|
|
62508
63977
|
{
|
|
62509
|
-
"
|
|
62510
|
-
"
|
|
62511
|
-
|
|
62512
|
-
|
|
62513
|
-
|
|
62514
|
-
|
|
62515
|
-
|
|
63978
|
+
"name": "className",
|
|
63979
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
63980
|
+
}
|
|
63981
|
+
],
|
|
63982
|
+
"tags": {}
|
|
63983
|
+
},
|
|
63984
|
+
{
|
|
63985
|
+
"kind": "property",
|
|
63986
|
+
"name": "style",
|
|
63987
|
+
"required": false,
|
|
63988
|
+
"type": {
|
|
63989
|
+
"kind": "external",
|
|
63990
|
+
"name": "Record",
|
|
63991
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
63992
|
+
"typeParameters": [
|
|
63993
|
+
{
|
|
63994
|
+
"kind": "primitive",
|
|
63995
|
+
"value": "string"
|
|
63996
|
+
},
|
|
63997
|
+
{
|
|
63998
|
+
"kind": "primitive",
|
|
63999
|
+
"value": "string"
|
|
62516
64000
|
}
|
|
64001
|
+
]
|
|
64002
|
+
},
|
|
64003
|
+
"description": "",
|
|
64004
|
+
"declarations": [
|
|
64005
|
+
{
|
|
64006
|
+
"name": "style",
|
|
64007
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
62517
64008
|
}
|
|
62518
|
-
]
|
|
64009
|
+
],
|
|
64010
|
+
"tags": {}
|
|
62519
64011
|
}
|
|
62520
|
-
|
|
62521
|
-
],
|
|
62522
|
-
"baseElement": {
|
|
62523
|
-
"kind": "external",
|
|
62524
|
-
"name": "div",
|
|
62525
|
-
"url": "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/div"
|
|
62526
|
-
},
|
|
62527
|
-
"styleComponent": {
|
|
62528
|
-
"kind": "symbol",
|
|
62529
|
-
"name": "Box"
|
|
62530
|
-
}
|
|
62531
|
-
}
|
|
62532
|
-
},
|
|
62533
|
-
{
|
|
62534
|
-
"name": "CardHeadingProps",
|
|
62535
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx",
|
|
62536
|
-
"description": "",
|
|
62537
|
-
"declarations": [
|
|
62538
|
-
{
|
|
62539
|
-
"name": "CardHeadingProps",
|
|
62540
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/card/lib/CardHeading.tsx"
|
|
64012
|
+
]
|
|
62541
64013
|
}
|
|
62542
|
-
],
|
|
62543
|
-
"tags": {},
|
|
62544
|
-
"type": {
|
|
62545
|
-
"kind": "alias",
|
|
62546
|
-
"name": "CardHeading"
|
|
62547
64014
|
}
|
|
62548
64015
|
},
|
|
62549
64016
|
{
|