@workday/canvas-kit-docs 11.0.0-alpha.761-next.0 → 11.0.0-alpha.764-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 +479 -24
- package/dist/mdx/10.0-UPGRADE-GUIDE.mdx +13 -1
- package/package.json +6 -6
package/dist/es6/lib/docs.js
CHANGED
|
@@ -64136,20 +64136,492 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64136
64136
|
}
|
|
64137
64137
|
},
|
|
64138
64138
|
{
|
|
64139
|
-
"name": "
|
|
64139
|
+
"name": "checkboxBackgroundStencil",
|
|
64140
64140
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx",
|
|
64141
64141
|
"description": "",
|
|
64142
64142
|
"declarations": [
|
|
64143
64143
|
{
|
|
64144
|
-
"name": "
|
|
64144
|
+
"name": "checkboxBackgroundStencil",
|
|
64145
64145
|
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckBackground.tsx"
|
|
64146
64146
|
}
|
|
64147
64147
|
],
|
|
64148
64148
|
"tags": {},
|
|
64149
64149
|
"type": {
|
|
64150
|
-
"kind": "
|
|
64151
|
-
"
|
|
64152
|
-
|
|
64150
|
+
"kind": "function",
|
|
64151
|
+
"parameters": [
|
|
64152
|
+
{
|
|
64153
|
+
"kind": "parameter",
|
|
64154
|
+
"name": "options",
|
|
64155
|
+
"type": {
|
|
64156
|
+
"kind": "conditional",
|
|
64157
|
+
"check": {
|
|
64158
|
+
"kind": "tuple",
|
|
64159
|
+
"value": [
|
|
64160
|
+
{
|
|
64161
|
+
"kind": "symbol",
|
|
64162
|
+
"name": "E",
|
|
64163
|
+
"value": "E"
|
|
64164
|
+
}
|
|
64165
|
+
]
|
|
64166
|
+
},
|
|
64167
|
+
"extends": {
|
|
64168
|
+
"kind": "tuple",
|
|
64169
|
+
"value": [
|
|
64170
|
+
{
|
|
64171
|
+
"kind": "primitive",
|
|
64172
|
+
"value": "never"
|
|
64173
|
+
}
|
|
64174
|
+
]
|
|
64175
|
+
},
|
|
64176
|
+
"trueType": {
|
|
64177
|
+
"kind": "intersection",
|
|
64178
|
+
"value": [
|
|
64179
|
+
{
|
|
64180
|
+
"kind": "symbol",
|
|
64181
|
+
"name": "ModifierValuesStencil",
|
|
64182
|
+
"typeParameters": [
|
|
64183
|
+
{
|
|
64184
|
+
"kind": "symbol",
|
|
64185
|
+
"name": "M",
|
|
64186
|
+
"value": "M"
|
|
64187
|
+
},
|
|
64188
|
+
{
|
|
64189
|
+
"kind": "symbol",
|
|
64190
|
+
"name": "V",
|
|
64191
|
+
"value": "V"
|
|
64192
|
+
}
|
|
64193
|
+
],
|
|
64194
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
64195
|
+
},
|
|
64196
|
+
{
|
|
64197
|
+
"kind": "symbol",
|
|
64198
|
+
"name": "VariableValuesStencil",
|
|
64199
|
+
"typeParameters": [
|
|
64200
|
+
{
|
|
64201
|
+
"kind": "symbol",
|
|
64202
|
+
"name": "V",
|
|
64203
|
+
"value": "V"
|
|
64204
|
+
}
|
|
64205
|
+
],
|
|
64206
|
+
"value": "VariableValuesStencil<V>"
|
|
64207
|
+
}
|
|
64208
|
+
]
|
|
64209
|
+
},
|
|
64210
|
+
"falseType": {
|
|
64211
|
+
"kind": "conditional",
|
|
64212
|
+
"check": {
|
|
64213
|
+
"kind": "symbol",
|
|
64214
|
+
"name": "E",
|
|
64215
|
+
"value": "E"
|
|
64216
|
+
},
|
|
64217
|
+
"extends": {
|
|
64218
|
+
"kind": "symbol",
|
|
64219
|
+
"name": "BaseStencil",
|
|
64220
|
+
"typeParameters": [
|
|
64221
|
+
{
|
|
64222
|
+
"kind": "infer",
|
|
64223
|
+
"value": {
|
|
64224
|
+
"kind": "typeParameter",
|
|
64225
|
+
"name": "ME",
|
|
64226
|
+
"required": true
|
|
64227
|
+
}
|
|
64228
|
+
},
|
|
64229
|
+
{
|
|
64230
|
+
"kind": "infer",
|
|
64231
|
+
"value": {
|
|
64232
|
+
"kind": "typeParameter",
|
|
64233
|
+
"name": "VE",
|
|
64234
|
+
"required": true
|
|
64235
|
+
}
|
|
64236
|
+
},
|
|
64237
|
+
{
|
|
64238
|
+
"kind": "primitive",
|
|
64239
|
+
"value": "any"
|
|
64240
|
+
},
|
|
64241
|
+
{
|
|
64242
|
+
"kind": "primitive",
|
|
64243
|
+
"value": "any"
|
|
64244
|
+
}
|
|
64245
|
+
],
|
|
64246
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
64247
|
+
},
|
|
64248
|
+
"trueType": {
|
|
64249
|
+
"kind": "intersection",
|
|
64250
|
+
"value": [
|
|
64251
|
+
{
|
|
64252
|
+
"kind": "symbol",
|
|
64253
|
+
"name": "ModifierValuesStencil",
|
|
64254
|
+
"typeParameters": [
|
|
64255
|
+
{
|
|
64256
|
+
"kind": "intersection",
|
|
64257
|
+
"value": [
|
|
64258
|
+
{
|
|
64259
|
+
"kind": "symbol",
|
|
64260
|
+
"name": "ME",
|
|
64261
|
+
"value": "ME"
|
|
64262
|
+
},
|
|
64263
|
+
{
|
|
64264
|
+
"kind": "symbol",
|
|
64265
|
+
"name": "M",
|
|
64266
|
+
"value": "M"
|
|
64267
|
+
}
|
|
64268
|
+
]
|
|
64269
|
+
}
|
|
64270
|
+
],
|
|
64271
|
+
"value": "ModifierValuesStencil<M, V>"
|
|
64272
|
+
},
|
|
64273
|
+
{
|
|
64274
|
+
"kind": "symbol",
|
|
64275
|
+
"name": "VariableValuesStencil",
|
|
64276
|
+
"typeParameters": [
|
|
64277
|
+
{
|
|
64278
|
+
"kind": "intersection",
|
|
64279
|
+
"value": [
|
|
64280
|
+
{
|
|
64281
|
+
"kind": "symbol",
|
|
64282
|
+
"name": "VE",
|
|
64283
|
+
"value": "VE"
|
|
64284
|
+
},
|
|
64285
|
+
{
|
|
64286
|
+
"kind": "symbol",
|
|
64287
|
+
"name": "V",
|
|
64288
|
+
"value": "V"
|
|
64289
|
+
}
|
|
64290
|
+
]
|
|
64291
|
+
}
|
|
64292
|
+
],
|
|
64293
|
+
"value": "VariableValuesStencil<V>"
|
|
64294
|
+
}
|
|
64295
|
+
]
|
|
64296
|
+
},
|
|
64297
|
+
"falseType": {
|
|
64298
|
+
"kind": "primitive",
|
|
64299
|
+
"value": "never"
|
|
64300
|
+
}
|
|
64301
|
+
}
|
|
64302
|
+
},
|
|
64303
|
+
"required": false,
|
|
64304
|
+
"rest": false,
|
|
64305
|
+
"description": "",
|
|
64306
|
+
"declarations": [
|
|
64307
|
+
{
|
|
64308
|
+
"name": "options",
|
|
64309
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64310
|
+
}
|
|
64311
|
+
],
|
|
64312
|
+
"tags": {}
|
|
64313
|
+
}
|
|
64314
|
+
],
|
|
64315
|
+
"members": [
|
|
64316
|
+
{
|
|
64317
|
+
"kind": "property",
|
|
64318
|
+
"name": "vars",
|
|
64319
|
+
"required": true,
|
|
64320
|
+
"type": {
|
|
64321
|
+
"kind": "symbol",
|
|
64322
|
+
"name": "StencilDefaultVars",
|
|
64323
|
+
"typeParameters": [
|
|
64324
|
+
{
|
|
64325
|
+
"kind": "symbol",
|
|
64326
|
+
"name": "V",
|
|
64327
|
+
"value": "V"
|
|
64328
|
+
},
|
|
64329
|
+
{
|
|
64330
|
+
"kind": "symbol",
|
|
64331
|
+
"name": "E",
|
|
64332
|
+
"value": "E"
|
|
64333
|
+
},
|
|
64334
|
+
{
|
|
64335
|
+
"kind": "symbol",
|
|
64336
|
+
"name": "ID",
|
|
64337
|
+
"value": "ID"
|
|
64338
|
+
}
|
|
64339
|
+
],
|
|
64340
|
+
"value": "StencilDefaultVars<V, E, ID>"
|
|
64341
|
+
},
|
|
64342
|
+
"description": "",
|
|
64343
|
+
"declarations": [
|
|
64344
|
+
{
|
|
64345
|
+
"name": "vars",
|
|
64346
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64347
|
+
}
|
|
64348
|
+
],
|
|
64349
|
+
"tags": {}
|
|
64350
|
+
},
|
|
64351
|
+
{
|
|
64352
|
+
"kind": "property",
|
|
64353
|
+
"name": "base",
|
|
64354
|
+
"required": true,
|
|
64355
|
+
"type": {
|
|
64356
|
+
"kind": "primitive",
|
|
64357
|
+
"value": "string"
|
|
64358
|
+
},
|
|
64359
|
+
"description": "",
|
|
64360
|
+
"declarations": [
|
|
64361
|
+
{
|
|
64362
|
+
"name": "base",
|
|
64363
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64364
|
+
}
|
|
64365
|
+
],
|
|
64366
|
+
"tags": {}
|
|
64367
|
+
},
|
|
64368
|
+
{
|
|
64369
|
+
"kind": "property",
|
|
64370
|
+
"name": "modifiers",
|
|
64371
|
+
"required": true,
|
|
64372
|
+
"type": {
|
|
64373
|
+
"kind": "conditional",
|
|
64374
|
+
"check": {
|
|
64375
|
+
"kind": "tuple",
|
|
64376
|
+
"value": [
|
|
64377
|
+
{
|
|
64378
|
+
"kind": "symbol",
|
|
64379
|
+
"name": "E",
|
|
64380
|
+
"value": "E"
|
|
64381
|
+
}
|
|
64382
|
+
]
|
|
64383
|
+
},
|
|
64384
|
+
"extends": {
|
|
64385
|
+
"kind": "tuple",
|
|
64386
|
+
"value": [
|
|
64387
|
+
{
|
|
64388
|
+
"kind": "symbol",
|
|
64389
|
+
"name": "BaseStencil",
|
|
64390
|
+
"typeParameters": [
|
|
64391
|
+
{
|
|
64392
|
+
"kind": "infer",
|
|
64393
|
+
"value": {
|
|
64394
|
+
"kind": "typeParameter",
|
|
64395
|
+
"name": "ME",
|
|
64396
|
+
"required": true
|
|
64397
|
+
}
|
|
64398
|
+
},
|
|
64399
|
+
{
|
|
64400
|
+
"kind": "infer",
|
|
64401
|
+
"value": {
|
|
64402
|
+
"kind": "typeParameter",
|
|
64403
|
+
"name": "VE",
|
|
64404
|
+
"required": true
|
|
64405
|
+
}
|
|
64406
|
+
},
|
|
64407
|
+
{
|
|
64408
|
+
"kind": "primitive",
|
|
64409
|
+
"value": "any"
|
|
64410
|
+
},
|
|
64411
|
+
{
|
|
64412
|
+
"kind": "primitive",
|
|
64413
|
+
"value": "any"
|
|
64414
|
+
}
|
|
64415
|
+
],
|
|
64416
|
+
"value": "BaseStencil<M, V, E, ID>"
|
|
64417
|
+
}
|
|
64418
|
+
]
|
|
64419
|
+
},
|
|
64420
|
+
"trueType": {
|
|
64421
|
+
"kind": "symbol",
|
|
64422
|
+
"name": "StencilModifierReturn",
|
|
64423
|
+
"typeParameters": [
|
|
64424
|
+
{
|
|
64425
|
+
"kind": "intersection",
|
|
64426
|
+
"value": [
|
|
64427
|
+
{
|
|
64428
|
+
"kind": "symbol",
|
|
64429
|
+
"name": "ME",
|
|
64430
|
+
"value": "ME"
|
|
64431
|
+
},
|
|
64432
|
+
{
|
|
64433
|
+
"kind": "symbol",
|
|
64434
|
+
"name": "M",
|
|
64435
|
+
"value": "M"
|
|
64436
|
+
}
|
|
64437
|
+
]
|
|
64438
|
+
},
|
|
64439
|
+
{
|
|
64440
|
+
"kind": "intersection",
|
|
64441
|
+
"value": [
|
|
64442
|
+
{
|
|
64443
|
+
"kind": "symbol",
|
|
64444
|
+
"name": "VE",
|
|
64445
|
+
"value": "VE"
|
|
64446
|
+
},
|
|
64447
|
+
{
|
|
64448
|
+
"kind": "symbol",
|
|
64449
|
+
"name": "V",
|
|
64450
|
+
"value": "V"
|
|
64451
|
+
}
|
|
64452
|
+
]
|
|
64453
|
+
}
|
|
64454
|
+
],
|
|
64455
|
+
"value": "StencilModifierReturn<M, V>"
|
|
64456
|
+
},
|
|
64457
|
+
"falseType": {
|
|
64458
|
+
"kind": "symbol",
|
|
64459
|
+
"name": "StencilModifierReturn",
|
|
64460
|
+
"typeParameters": [
|
|
64461
|
+
{
|
|
64462
|
+
"kind": "symbol",
|
|
64463
|
+
"name": "M",
|
|
64464
|
+
"value": "M"
|
|
64465
|
+
},
|
|
64466
|
+
{
|
|
64467
|
+
"kind": "symbol",
|
|
64468
|
+
"name": "V",
|
|
64469
|
+
"value": "V"
|
|
64470
|
+
}
|
|
64471
|
+
],
|
|
64472
|
+
"value": "StencilModifierReturn<M, V>"
|
|
64473
|
+
}
|
|
64474
|
+
},
|
|
64475
|
+
"description": "",
|
|
64476
|
+
"declarations": [
|
|
64477
|
+
{
|
|
64478
|
+
"name": "modifiers",
|
|
64479
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64480
|
+
}
|
|
64481
|
+
],
|
|
64482
|
+
"tags": {}
|
|
64483
|
+
},
|
|
64484
|
+
{
|
|
64485
|
+
"kind": "property",
|
|
64486
|
+
"name": "defaultModifiers",
|
|
64487
|
+
"required": true,
|
|
64488
|
+
"type": {
|
|
64489
|
+
"kind": "unknown",
|
|
64490
|
+
"value": "unknown",
|
|
64491
|
+
"text": "{\n [K in keyof M]?: keyof M[K];\n }"
|
|
64492
|
+
},
|
|
64493
|
+
"description": "",
|
|
64494
|
+
"declarations": [
|
|
64495
|
+
{
|
|
64496
|
+
"name": "defaultModifiers",
|
|
64497
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64498
|
+
}
|
|
64499
|
+
],
|
|
64500
|
+
"tags": {}
|
|
64501
|
+
},
|
|
64502
|
+
{
|
|
64503
|
+
"kind": "property",
|
|
64504
|
+
"name": "__extends",
|
|
64505
|
+
"required": false,
|
|
64506
|
+
"type": {
|
|
64507
|
+
"kind": "symbol",
|
|
64508
|
+
"name": "E",
|
|
64509
|
+
"value": "E"
|
|
64510
|
+
},
|
|
64511
|
+
"description": "",
|
|
64512
|
+
"declarations": [
|
|
64513
|
+
{
|
|
64514
|
+
"name": "__extends",
|
|
64515
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64516
|
+
}
|
|
64517
|
+
],
|
|
64518
|
+
"tags": {}
|
|
64519
|
+
},
|
|
64520
|
+
{
|
|
64521
|
+
"kind": "property",
|
|
64522
|
+
"name": "__vars",
|
|
64523
|
+
"required": true,
|
|
64524
|
+
"type": {
|
|
64525
|
+
"kind": "symbol",
|
|
64526
|
+
"name": "V",
|
|
64527
|
+
"value": "V"
|
|
64528
|
+
},
|
|
64529
|
+
"description": "",
|
|
64530
|
+
"declarations": [
|
|
64531
|
+
{
|
|
64532
|
+
"name": "__vars",
|
|
64533
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64534
|
+
}
|
|
64535
|
+
],
|
|
64536
|
+
"tags": {}
|
|
64537
|
+
},
|
|
64538
|
+
{
|
|
64539
|
+
"kind": "property",
|
|
64540
|
+
"name": "__modifiers",
|
|
64541
|
+
"required": true,
|
|
64542
|
+
"type": {
|
|
64543
|
+
"kind": "symbol",
|
|
64544
|
+
"name": "M",
|
|
64545
|
+
"value": "M"
|
|
64546
|
+
},
|
|
64547
|
+
"description": "",
|
|
64548
|
+
"declarations": [
|
|
64549
|
+
{
|
|
64550
|
+
"name": "__modifiers",
|
|
64551
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64552
|
+
}
|
|
64553
|
+
],
|
|
64554
|
+
"tags": {}
|
|
64555
|
+
},
|
|
64556
|
+
{
|
|
64557
|
+
"kind": "property",
|
|
64558
|
+
"name": "__id",
|
|
64559
|
+
"required": true,
|
|
64560
|
+
"type": {
|
|
64561
|
+
"kind": "symbol",
|
|
64562
|
+
"name": "ID",
|
|
64563
|
+
"value": "ID"
|
|
64564
|
+
},
|
|
64565
|
+
"description": "",
|
|
64566
|
+
"declarations": [
|
|
64567
|
+
{
|
|
64568
|
+
"name": "__id",
|
|
64569
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64570
|
+
}
|
|
64571
|
+
],
|
|
64572
|
+
"tags": {}
|
|
64573
|
+
}
|
|
64574
|
+
],
|
|
64575
|
+
"returnType": {
|
|
64576
|
+
"kind": "object",
|
|
64577
|
+
"properties": [
|
|
64578
|
+
{
|
|
64579
|
+
"kind": "property",
|
|
64580
|
+
"name": "className",
|
|
64581
|
+
"required": true,
|
|
64582
|
+
"type": {
|
|
64583
|
+
"kind": "primitive",
|
|
64584
|
+
"value": "string"
|
|
64585
|
+
},
|
|
64586
|
+
"description": "",
|
|
64587
|
+
"declarations": [
|
|
64588
|
+
{
|
|
64589
|
+
"name": "className",
|
|
64590
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64591
|
+
}
|
|
64592
|
+
],
|
|
64593
|
+
"tags": {}
|
|
64594
|
+
},
|
|
64595
|
+
{
|
|
64596
|
+
"kind": "property",
|
|
64597
|
+
"name": "style",
|
|
64598
|
+
"required": false,
|
|
64599
|
+
"type": {
|
|
64600
|
+
"kind": "external",
|
|
64601
|
+
"name": "Record",
|
|
64602
|
+
"url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
|
|
64603
|
+
"typeParameters": [
|
|
64604
|
+
{
|
|
64605
|
+
"kind": "primitive",
|
|
64606
|
+
"value": "string"
|
|
64607
|
+
},
|
|
64608
|
+
{
|
|
64609
|
+
"kind": "primitive",
|
|
64610
|
+
"value": "string"
|
|
64611
|
+
}
|
|
64612
|
+
]
|
|
64613
|
+
},
|
|
64614
|
+
"description": "",
|
|
64615
|
+
"declarations": [
|
|
64616
|
+
{
|
|
64617
|
+
"name": "style",
|
|
64618
|
+
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
|
|
64619
|
+
}
|
|
64620
|
+
],
|
|
64621
|
+
"tags": {}
|
|
64622
|
+
}
|
|
64623
|
+
]
|
|
64624
|
+
}
|
|
64153
64625
|
}
|
|
64154
64626
|
},
|
|
64155
64627
|
{
|
|
@@ -64734,23 +65206,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
64734
65206
|
}
|
|
64735
65207
|
}
|
|
64736
65208
|
},
|
|
64737
|
-
{
|
|
64738
|
-
"name": "inputVars",
|
|
64739
|
-
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx",
|
|
64740
|
-
"description": "",
|
|
64741
|
-
"declarations": [
|
|
64742
|
-
{
|
|
64743
|
-
"name": "inputVars",
|
|
64744
|
-
"filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx"
|
|
64745
|
-
}
|
|
64746
|
-
],
|
|
64747
|
-
"tags": {},
|
|
64748
|
-
"type": {
|
|
64749
|
-
"kind": "symbol",
|
|
64750
|
-
"name": "CsVars",
|
|
64751
|
-
"value": "CsVars<\"errorInner\" | \"errorOuter\" | \"alertInner\" | \"alertOuter\", never>"
|
|
64752
|
-
}
|
|
64753
|
-
},
|
|
64754
65209
|
{
|
|
64755
65210
|
"name": "CheckboxContainer",
|
|
64756
65211
|
"fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/react/checkbox/lib/CheckboxContainer.tsx",
|
|
@@ -204704,7 +205159,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
204704
205159
|
{
|
|
204705
205160
|
"name": "Card",
|
|
204706
205161
|
"symbol": "SelectCard",
|
|
204707
|
-
"description": "`Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.\n\n**Note: The card will be the width of its corresponding `Select.Input`**.\n\n```tsx\n<Select
|
|
205162
|
+
"description": "`Select.Card` renders a {@link ComboboxCard Combobox.Card}. You have access to all `Card` props.\n\n**Note: The card will be the width of its corresponding `Select.Input`**.\n\n```tsx\n<Select items={options}>\n <FormField label=\"Your Label\">\n <Select.Input onChange={(event) => handleChange(event)}>\n <Select.Popper>\n <Select.Card>\n ...\n </Select.Card>\n </Select.Popper>\n </FormField>\n</Select>\n```",
|
|
204708
205163
|
"declarations": [
|
|
204709
205164
|
{
|
|
204710
205165
|
"name": "Card",
|
|
@@ -204716,7 +205171,7 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
|
|
|
204716
205171
|
{
|
|
204717
205172
|
"name": "Item",
|
|
204718
205173
|
"symbol": "SelectItem",
|
|
204719
|
-
"description": "`Select.Item` renders a {@link ComboboxMenuItem Combobox.Menu.Item} with aria role of `option`. You can optionally render a `Icon`.\n\n```tsx\n<Select
|
|
205174
|
+
"description": "`Select.Item` renders a {@link ComboboxMenuItem Combobox.Menu.Item} with aria role of `option`. You can optionally render a `Icon`.\n\n```tsx\n<Select items={options}>\n <FormField label=\"Your Label\">\n <Select.Input onChange={(event) => handleChange(event)}>\n <Select.Popper>\n <Select.Card>\n <Select.List>\n {(item) => <Select.Item><Select.Item.Icon icon={icon} />{item}</Select.Item>}\n </Select.List\n </Select.Card>\n </Select.Popper>\n </FormField>\n</Select>\n```",
|
|
204720
205175
|
"declarations": [
|
|
204721
205176
|
{
|
|
204722
205177
|
"name": "Item",
|
|
@@ -259,6 +259,9 @@ We've converted `Select` into a
|
|
|
259
259
|
a flexible API and access to its internals via its subcomponents.
|
|
260
260
|
|
|
261
261
|
```tsx
|
|
262
|
+
import {Select} from '@workday/canvas-kit-react/select';
|
|
263
|
+
import {FormField} from '@workday/canvas-kit-react/form-field';
|
|
264
|
+
|
|
262
265
|
// v9
|
|
263
266
|
<FormField label="Pizza Size">
|
|
264
267
|
<Select onChange={handleChange} value={value}>
|
|
@@ -270,6 +273,9 @@ a flexible API and access to its internals via its subcomponents.
|
|
|
270
273
|
```
|
|
271
274
|
|
|
272
275
|
```tsx
|
|
276
|
+
import {Select} from '@workday/canvas-kit-react/select';
|
|
277
|
+
import {FormField} from '@workday/canvas-kit-react/form-field';
|
|
278
|
+
|
|
273
279
|
// v10
|
|
274
280
|
<Select items={['Small', 'Medium', 'Large']}>
|
|
275
281
|
<FormField label="Pizza Size" inputId="pizza">
|
|
@@ -287,7 +293,13 @@ a flexible API and access to its internals via its subcomponents.
|
|
|
287
293
|
</Select>
|
|
288
294
|
```
|
|
289
295
|
|
|
290
|
-
|
|
296
|
+
Notice that `Select` is now outside the `FormField`. This is due to the update in `Select` and how
|
|
297
|
+
the `FormField` in main applies attributes. Previously, `Select` was a styled native `<select>`
|
|
298
|
+
input and `FormField` applied attributes automatically to that input. The new `Select` is solely a
|
|
299
|
+
React context provider for its subcomponents. `FormField` needs `Select.Input` to be a direct child
|
|
300
|
+
to apply attributes correctly.
|
|
301
|
+
|
|
302
|
+
Also, unlike the
|
|
291
303
|
[Select in Preview](https://workday.github.io/canvas-kit/?path=/story/preview-select-left-label--default),
|
|
292
304
|
this component does not have a border around its menu.
|
|
293
305
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@workday/canvas-kit-docs",
|
|
3
|
-
"version": "11.0.0-alpha.
|
|
3
|
+
"version": "11.0.0-alpha.764-next.0",
|
|
4
4
|
"description": "Documentation components of Canvas Kit components",
|
|
5
5
|
"author": "Workday, Inc. (https://www.workday.com)",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -44,10 +44,10 @@
|
|
|
44
44
|
"dependencies": {
|
|
45
45
|
"@emotion/styled": "^11.6.0",
|
|
46
46
|
"@storybook/csf": "0.0.1",
|
|
47
|
-
"@workday/canvas-kit-labs-react": "^11.0.0-alpha.
|
|
48
|
-
"@workday/canvas-kit-preview-react": "^11.0.0-alpha.
|
|
49
|
-
"@workday/canvas-kit-react": "^11.0.0-alpha.
|
|
50
|
-
"@workday/canvas-kit-styling": "^11.0.0-alpha.
|
|
47
|
+
"@workday/canvas-kit-labs-react": "^11.0.0-alpha.764-next.0",
|
|
48
|
+
"@workday/canvas-kit-preview-react": "^11.0.0-alpha.764-next.0",
|
|
49
|
+
"@workday/canvas-kit-react": "^11.0.0-alpha.764-next.0",
|
|
50
|
+
"@workday/canvas-kit-styling": "^11.0.0-alpha.764-next.0",
|
|
51
51
|
"@workday/canvas-system-icons-web": "^3.0.0",
|
|
52
52
|
"@workday/canvas-tokens-web": "^1.3.0",
|
|
53
53
|
"markdown-to-jsx": "^6.10.3",
|
|
@@ -59,5 +59,5 @@
|
|
|
59
59
|
"mkdirp": "^1.0.3",
|
|
60
60
|
"typescript": "4.2"
|
|
61
61
|
},
|
|
62
|
-
"gitHead": "
|
|
62
|
+
"gitHead": "d76c7698a6761ca15f9d54814fc53db72c183ebe"
|
|
63
63
|
}
|