@workday/canvas-kit-docs 15.0.0-alpha.0060-next.0 → 15.0.0-alpha.0074-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.
Files changed (28) hide show
  1. package/dist/es6/lib/docs.js +90 -2575
  2. package/dist/es6/lib/stackblitzFiles/packageJSONFile.js +5 -5
  3. package/dist/es6/lib/stackblitzFiles/packageJSONFile.ts +5 -5
  4. package/dist/mdx/14.0-UPGRADE-GUIDE.mdx +4 -4
  5. package/dist/mdx/15.0-UPGRADE-GUIDE.mdx +39 -2
  6. package/dist/mdx/CODEMODS.mdx +2 -2
  7. package/dist/mdx/react/action-bar/ActionBar.mdx +3 -3
  8. package/dist/mdx/react/button/button/Button.mdx +6 -7
  9. package/dist/mdx/react/expandable/Expandable.mdx +49 -2
  10. package/dist/mdx/react/expandable/examples/HoistedModel.tsx +24 -17
  11. package/dist/mdx/react/menu/Menu.mdx +63 -26
  12. package/dist/mdx/react/menu/examples/SelectableMenu.tsx +13 -2
  13. package/package.json +6 -6
  14. package/dist/mdx/labs-react/combobox/Combobox.mdx +0 -68
  15. package/dist/mdx/labs-react/combobox/examples/Basic.tsx +0 -88
  16. package/dist/mdx/labs-react/combobox/examples/DisabledItem.tsx +0 -88
  17. package/dist/mdx/labs-react/combobox/examples/GroupOfResult.tsx +0 -88
  18. package/dist/mdx/labs-react/combobox/examples/Grow.tsx +0 -88
  19. package/dist/mdx/labs-react/combobox/examples/NoClearButton.tsx +0 -88
  20. package/dist/mdx/labs-react/combobox/examples/RTL.tsx +0 -90
  21. package/dist/mdx/labs-react/search-form/SearchForm.mdx +0 -92
  22. package/dist/mdx/labs-react/search-form/examples/Basic.tsx +0 -63
  23. package/dist/mdx/labs-react/search-form/examples/Collapsed.tsx +0 -64
  24. package/dist/mdx/labs-react/search-form/examples/CustomStyles.tsx +0 -91
  25. package/dist/mdx/labs-react/search-form/examples/CustomTheme.tsx +0 -73
  26. package/dist/mdx/labs-react/search-form/examples/Grow.tsx +0 -64
  27. package/dist/mdx/labs-react/search-form/examples/RTL.tsx +0 -66
  28. package/dist/mdx/labs-react/search-form/examples/Theming.tsx +0 -66
@@ -1170,1880 +1170,117 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
1170
1170
  }
1171
1171
  },
1172
1172
  {
1173
- "name": "AutocompleteList",
1174
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx",
1175
- "description": "",
1176
- "declarations": [
1177
- {
1178
- "name": "AutocompleteList",
1179
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1180
- }
1181
- ],
1182
- "tags": {
1183
- "deprecated": "⚠️ `AutocompleteList` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1184
- },
1185
- "type": {
1186
- "kind": "component",
1187
- "props": [
1188
- {
1189
- "kind": "property",
1190
- "name": "autocompleteItems",
1191
- "required": true,
1192
- "type": {
1193
- "kind": "union",
1194
- "value": [
1195
- {
1196
- "kind": "array",
1197
- "value": {
1198
- "kind": "external",
1199
- "name": "ReactElement",
1200
- "url": "https://reactjs.org/docs/rendering-elements.html",
1201
- "typeParameters": [
1202
- {
1203
- "kind": "primitive",
1204
- "value": "any"
1205
- }
1206
- ]
1207
- }
1208
- },
1209
- {
1210
- "kind": "array",
1211
- "value": {
1212
- "kind": "symbol",
1213
- "name": "ComboBoxMenuItemGroup",
1214
- "value": "ComboBoxMenuItemGroup"
1215
- }
1216
- }
1217
- ]
1218
- },
1219
- "description": "The autocomplete items of the Combobox. This array of menu items is shown under the text input.",
1220
- "declarations": [
1221
- {
1222
- "name": "autocompleteItems",
1223
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1224
- }
1225
- ],
1226
- "tags": {}
1227
- },
1228
- {
1229
- "kind": "property",
1230
- "name": "selectedIndex",
1231
- "required": true,
1232
- "type": {
1233
- "kind": "union",
1234
- "value": [
1235
- {
1236
- "kind": "primitive",
1237
- "value": "number"
1238
- },
1239
- {
1240
- "kind": "primitive",
1241
- "value": "null"
1242
- }
1243
- ]
1244
- },
1245
- "description": "Index of the active autocomplete item",
1246
- "declarations": [
1247
- {
1248
- "name": "selectedIndex",
1249
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1250
- }
1251
- ],
1252
- "tags": {}
1253
- },
1254
- {
1255
- "kind": "property",
1256
- "name": "handleAutocompleteClick",
1257
- "required": true,
1258
- "type": {
1259
- "kind": "function",
1260
- "parameters": [
1261
- {
1262
- "kind": "parameter",
1263
- "name": "event",
1264
- "type": {
1265
- "kind": "external",
1266
- "name": "SyntheticEvent",
1267
- "url": "https://reactjs.org/docs/events.html",
1268
- "typeParameters": [
1269
- {
1270
- "kind": "external",
1271
- "name": "Element",
1272
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/element"
1273
- },
1274
- {
1275
- "kind": "external",
1276
- "name": "Event",
1277
- "url": "https://developer.mozilla.org/en-US/docs/Web/API/event"
1278
- }
1279
- ]
1280
- },
1281
- "required": true,
1282
- "rest": false,
1283
- "description": "",
1284
- "declarations": [
1285
- {
1286
- "name": "event",
1287
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1288
- }
1289
- ],
1290
- "tags": {}
1291
- },
1292
- {
1293
- "kind": "parameter",
1294
- "name": "menuItemProps",
1295
- "type": {
1296
- "kind": "primitive",
1297
- "value": "any"
1298
- },
1299
- "required": true,
1300
- "rest": false,
1301
- "description": "",
1302
- "declarations": [
1303
- {
1304
- "name": "menuItemProps",
1305
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1306
- }
1307
- ],
1308
- "tags": {}
1309
- }
1310
- ],
1311
- "members": [],
1312
- "returnType": {
1313
- "kind": "primitive",
1314
- "value": "void"
1315
- }
1316
- },
1317
- "description": "The function called when an autocomplete item is selected",
1318
- "declarations": [
1319
- {
1320
- "name": "handleAutocompleteClick",
1321
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1322
- }
1323
- ],
1324
- "tags": {}
1325
- },
1326
- {
1327
- "kind": "property",
1328
- "name": "labelId",
1329
- "required": true,
1330
- "type": {
1331
- "kind": "primitive",
1332
- "value": "string"
1333
- },
1334
- "description": "The id of the form field.",
1335
- "declarations": [
1336
- {
1337
- "name": "labelId",
1338
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1339
- }
1340
- ],
1341
- "tags": {}
1342
- },
1343
- {
1344
- "kind": "property",
1345
- "name": "comboboxId",
1346
- "required": true,
1347
- "type": {
1348
- "kind": "primitive",
1349
- "value": "string"
1350
- },
1351
- "description": "The id of the combobox.",
1352
- "declarations": [
1353
- {
1354
- "name": "comboboxId",
1355
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1356
- }
1357
- ],
1358
- "tags": {}
1359
- },
1360
- {
1361
- "kind": "property",
1362
- "name": "showGroupText",
1363
- "required": true,
1364
- "type": {
1365
- "kind": "primitive",
1366
- "value": "boolean"
1367
- },
1368
- "description": "True when group changes via keyboard control",
1369
- "declarations": [
1370
- {
1371
- "name": "showGroupText",
1372
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/AutocompleteList.tsx"
1373
- }
1374
- ],
1375
- "tags": {}
1376
- }
1377
- ]
1378
- }
1379
- },
1380
- {
1381
- "name": "ComboBoxMenuItemGroup",
1382
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
1383
- "description": "",
1384
- "declarations": [
1385
- {
1386
- "name": "ComboBoxMenuItemGroup",
1387
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1388
- }
1389
- ],
1390
- "tags": {
1391
- "deprecated": "⚠️ `ComboBoxMenuItemGroup` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1392
- },
1393
- "type": {
1394
- "kind": "object",
1395
- "properties": [
1396
- {
1397
- "kind": "property",
1398
- "name": "header",
1399
- "required": true,
1400
- "type": {
1401
- "kind": "external",
1402
- "name": "ReactElement",
1403
- "url": "https://reactjs.org/docs/rendering-elements.html",
1404
- "typeParameters": [
1405
- {
1406
- "kind": "primitive",
1407
- "value": "any"
1408
- }
1409
- ]
1410
- },
1411
- "description": "",
1412
- "declarations": [
1413
- {
1414
- "name": "header",
1415
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1416
- }
1417
- ],
1418
- "tags": {}
1419
- },
1420
- {
1421
- "kind": "property",
1422
- "name": "items",
1423
- "required": true,
1424
- "type": {
1425
- "kind": "array",
1426
- "value": {
1427
- "kind": "external",
1428
- "name": "ReactElement",
1429
- "url": "https://reactjs.org/docs/rendering-elements.html",
1430
- "typeParameters": [
1431
- {
1432
- "kind": "primitive",
1433
- "value": "any"
1434
- }
1435
- ]
1436
- }
1437
- },
1438
- "description": "",
1439
- "declarations": [
1440
- {
1441
- "name": "items",
1442
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1443
- }
1444
- ],
1445
- "tags": {}
1446
- }
1447
- ]
1448
- }
1449
- },
1450
- {
1451
- "name": "ComboboxProps",
1452
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
1453
- "description": "",
1454
- "declarations": [
1455
- {
1456
- "name": "ComboboxProps",
1457
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1458
- }
1459
- ],
1460
- "tags": {
1461
- "deprecated": "⚠️ `ComboboxProps` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1462
- },
1463
- "type": {
1464
- "kind": "alias",
1465
- "name": "Combobox"
1466
- }
1467
- },
1468
- {
1469
- "name": "listBoxIdPart",
1470
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
1471
- "description": "",
1472
- "declarations": [
1473
- {
1474
- "name": "listBoxIdPart",
1475
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1476
- }
1477
- ],
1478
- "tags": {
1479
- "deprecated": "⚠️ `listBoxIdPart` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1480
- },
1481
- "type": {
1482
- "kind": "string",
1483
- "value": "listbox"
1484
- }
1485
- },
1486
- {
1487
- "name": "getOptionId",
1488
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
1489
- "description": "",
1490
- "declarations": [
1491
- {
1492
- "name": "getOptionId",
1493
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1494
- }
1495
- ],
1496
- "tags": {
1497
- "deprecated": "⚠️ `getOptionId` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1498
- },
1499
- "type": {
1500
- "kind": "function",
1501
- "parameters": [
1502
- {
1503
- "kind": "parameter",
1504
- "name": "baseId",
1505
- "type": {
1506
- "kind": "primitive",
1507
- "value": "string"
1508
- },
1509
- "required": false,
1510
- "rest": false,
1511
- "description": "",
1512
- "declarations": [
1513
- {
1514
- "name": "baseId",
1515
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1516
- }
1517
- ],
1518
- "tags": {}
1519
- },
1520
- {
1521
- "kind": "parameter",
1522
- "name": "index",
1523
- "type": {
1524
- "kind": "primitive",
1525
- "value": "number"
1526
- },
1527
- "required": false,
1528
- "rest": false,
1529
- "description": "",
1530
- "declarations": [
1531
- {
1532
- "name": "index",
1533
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1534
- }
1535
- ],
1536
- "tags": {}
1537
- }
1538
- ],
1539
- "members": [],
1540
- "returnType": {
1541
- "kind": "primitive",
1542
- "value": "string"
1543
- }
1544
- }
1545
- },
1546
- {
1547
- "name": "getTextFromElement",
1548
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
1549
- "description": "",
1550
- "declarations": [
1551
- {
1552
- "name": "getTextFromElement",
1553
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1554
- }
1555
- ],
1556
- "tags": {
1557
- "deprecated": "⚠️ `getTextFromElement` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1558
- },
1559
- "type": {
1560
- "kind": "function",
1561
- "parameters": [
1562
- {
1563
- "kind": "parameter",
1564
- "name": "children",
1565
- "type": {
1566
- "kind": "external",
1567
- "name": "ReactNode",
1568
- "url": "https://reactjs.org/docs/rendering-elements.html"
1569
- },
1570
- "required": false,
1571
- "rest": false,
1572
- "description": "",
1573
- "declarations": [
1574
- {
1575
- "name": "children",
1576
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1577
- }
1578
- ],
1579
- "tags": {}
1580
- }
1581
- ],
1582
- "members": [],
1583
- "returnType": {
1584
- "kind": "primitive",
1585
- "value": "string"
1586
- }
1587
- }
1588
- },
1589
- {
1590
- "name": "Combobox",
1591
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx",
1592
- "description": "",
1593
- "declarations": [
1594
- {
1595
- "name": "Combobox",
1596
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1597
- }
1598
- ],
1599
- "tags": {
1600
- "deprecated": "⚠️ `Combobox` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1601
- },
1602
- "type": {
1603
- "kind": "component",
1604
- "props": [
1605
- {
1606
- "kind": "property",
1607
- "name": "children",
1608
- "required": true,
1609
- "type": {
1610
- "kind": "external",
1611
- "name": "ReactElement",
1612
- "url": "https://reactjs.org/docs/rendering-elements.html",
1613
- "typeParameters": [
1614
- {
1615
- "kind": "symbol",
1616
- "name": "TextInputProps",
1617
- "value": "TextInputProps"
1618
- }
1619
- ]
1620
- },
1621
- "description": "The TextInput child of the Combobox.",
1622
- "declarations": [
1623
- {
1624
- "name": "children",
1625
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1626
- }
1627
- ],
1628
- "tags": {}
1629
- },
1630
- {
1631
- "kind": "property",
1632
- "name": "initialValue",
1633
- "required": false,
1634
- "type": {
1635
- "kind": "primitive",
1636
- "value": "string"
1637
- },
1638
- "description": "The initial value of the Combobox.",
1639
- "declarations": [
1640
- {
1641
- "name": "initialValue",
1642
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1643
- }
1644
- ],
1645
- "tags": {}
1646
- },
1647
- {
1648
- "kind": "property",
1649
- "name": "clearButtonVariant",
1650
- "required": false,
1651
- "type": {
1652
- "kind": "union",
1653
- "value": [
1654
- {
1655
- "kind": "string",
1656
- "value": "inverse"
1657
- },
1658
- {
1659
- "kind": "primitive",
1660
- "value": "undefined"
1661
- }
1662
- ]
1663
- },
1664
- "description": "The variant of the Combobox clear button. The default is a TertiaryButton",
1665
- "declarations": [
1666
- {
1667
- "name": "clearButtonVariant",
1668
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1669
- }
1670
- ],
1671
- "tags": {}
1672
- },
1673
- {
1674
- "kind": "property",
1675
- "name": "showClearButton",
1676
- "required": false,
1677
- "type": {
1678
- "kind": "primitive",
1679
- "value": "boolean"
1680
- },
1681
- "description": "If true, render the Combobox with a button to clear the text input.",
1682
- "declarations": [
1683
- {
1684
- "name": "showClearButton",
1685
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1686
- }
1687
- ],
1688
- "tags": {
1689
- "default": "false"
1690
- },
1691
- "defaultValue": {
1692
- "kind": "boolean",
1693
- "value": false
1694
- }
1695
- },
1696
- {
1697
- "kind": "property",
1698
- "name": "clearButtonAriaLabel",
1699
- "required": false,
1700
- "type": {
1701
- "kind": "primitive",
1702
- "value": "string"
1703
- },
1704
- "description": "The `aria-label` for the Combobox clear button.",
1705
- "declarations": [
1706
- {
1707
- "name": "clearButtonAriaLabel",
1708
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1709
- }
1710
- ],
1711
- "tags": {
1712
- "default": "Reset Search Input"
1713
- },
1714
- "defaultValue": {
1715
- "kind": "symbol",
1716
- "name": "Reset Search Input",
1717
- "value": "Reset Search Input"
1718
- }
1719
- },
1720
- {
1721
- "kind": "property",
1722
- "name": "autocompleteItems",
1723
- "required": false,
1724
- "type": {
1725
- "kind": "union",
1726
- "value": [
1727
- {
1728
- "kind": "array",
1729
- "value": {
1730
- "kind": "external",
1731
- "name": "ReactElement",
1732
- "url": "https://reactjs.org/docs/rendering-elements.html",
1733
- "typeParameters": [
1734
- {
1735
- "kind": "primitive",
1736
- "value": "any"
1737
- }
1738
- ]
1739
- }
1740
- },
1741
- {
1742
- "kind": "array",
1743
- "value": {
1744
- "kind": "symbol",
1745
- "name": "ComboBoxMenuItemGroup",
1746
- "value": "ComboBoxMenuItemGroup"
1747
- }
1748
- }
1749
- ]
1750
- },
1751
- "description": "The autocomplete items of the Combobox. This array of menu items is shown under the text input.",
1752
- "declarations": [
1753
- {
1754
- "name": "autocompleteItems",
1755
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1756
- }
1757
- ],
1758
- "tags": {}
1759
- },
1760
- {
1761
- "kind": "property",
1762
- "name": "onChange",
1763
- "required": false,
1764
- "type": {
1765
- "kind": "function",
1766
- "parameters": [
1767
- {
1768
- "kind": "parameter",
1769
- "name": "e",
1770
- "type": {
1771
- "kind": "symbol",
1772
- "name": "React.ChangeEvent",
1773
- "typeParameters": [
1774
- {
1775
- "kind": "symbol",
1776
- "name": "HTMLInputElement",
1777
- "value": "HTMLInputElement"
1778
- }
1779
- ],
1780
- "value": "ChangeEvent<T>"
1781
- },
1782
- "required": true,
1783
- "rest": false,
1784
- "description": "",
1785
- "declarations": [
1786
- {
1787
- "name": "e",
1788
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1789
- }
1790
- ],
1791
- "tags": {}
1792
- }
1793
- ],
1794
- "members": [],
1795
- "returnType": {
1796
- "kind": "primitive",
1797
- "value": "void"
1798
- }
1799
- },
1800
- "description": "The function called when the Combobox text input changes.",
1801
- "declarations": [
1802
- {
1803
- "name": "onChange",
1804
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1805
- }
1806
- ],
1807
- "tags": {}
1808
- },
1809
- {
1810
- "kind": "property",
1811
- "name": "onFocus",
1812
- "required": false,
1813
- "type": {
1814
- "kind": "symbol",
1815
- "name": "React.FocusEventHandler",
1816
- "value": "FocusEventHandler<T>"
1817
- },
1818
- "description": "The function called when the Combobox text input focuses.",
1819
- "declarations": [
1820
- {
1821
- "name": "onFocus",
1822
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1823
- }
1824
- ],
1825
- "tags": {}
1826
- },
1827
- {
1828
- "kind": "property",
1829
- "name": "onBlur",
1830
- "required": false,
1831
- "type": {
1832
- "kind": "symbol",
1833
- "name": "React.FocusEventHandler",
1834
- "value": "FocusEventHandler<T>"
1835
- },
1836
- "description": "The function called when the Combobox text input blurs.",
1837
- "declarations": [
1838
- {
1839
- "name": "onBlur",
1840
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1841
- }
1842
- ],
1843
- "tags": {}
1844
- },
1845
- {
1846
- "kind": "property",
1847
- "name": "labelId",
1848
- "required": false,
1849
- "type": {
1850
- "kind": "primitive",
1851
- "value": "string"
1852
- },
1853
- "description": "The id of the form field.",
1854
- "declarations": [
1855
- {
1856
- "name": "labelId",
1857
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1858
- }
1859
- ],
1860
- "tags": {}
1861
- },
1862
- {
1863
- "kind": "property",
1864
- "name": "getStatusText",
1865
- "required": false,
1866
- "type": {
1867
- "kind": "function",
1868
- "parameters": [
1869
- {
1870
- "kind": "parameter",
1871
- "name": "listCount",
1872
- "type": {
1873
- "kind": "primitive",
1874
- "value": "number"
1875
- },
1876
- "required": true,
1877
- "rest": false,
1878
- "description": "",
1879
- "declarations": [
1880
- {
1881
- "name": "listCount",
1882
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1883
- }
1884
- ],
1885
- "tags": {}
1886
- }
1887
- ],
1888
- "members": [],
1889
- "returnType": {
1890
- "kind": "primitive",
1891
- "value": "string"
1892
- }
1893
- },
1894
- "description": "The text for screen readers announcing the autocomplete count",
1895
- "declarations": [
1896
- {
1897
- "name": "getStatusText",
1898
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Combobox.tsx"
1899
- }
1900
- ],
1901
- "tags": {}
1902
- },
1903
- {
1904
- "kind": "property",
1905
- "name": "grow",
1906
- "required": false,
1907
- "type": {
1908
- "kind": "primitive",
1909
- "value": "boolean"
1910
- },
1911
- "description": "True if the component should grow to its container's width. False otherwise.",
1912
- "declarations": [
1913
- {
1914
- "name": "grow",
1915
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
1916
- }
1917
- ],
1918
- "tags": {}
1919
- }
1920
- ]
1921
- }
1922
- },
1923
- {
1924
- "name": "StatusProps",
1925
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx",
1926
- "description": "",
1927
- "declarations": [
1928
- {
1929
- "name": "StatusProps",
1930
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
1931
- }
1932
- ],
1933
- "tags": {
1934
- "deprecated": "⚠️ `StatusProps` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1935
- },
1936
- "type": {
1937
- "kind": "alias",
1938
- "name": "Status"
1939
- }
1940
- },
1941
- {
1942
- "name": "Status",
1943
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx",
1944
- "description": "",
1945
- "declarations": [
1946
- {
1947
- "name": "Status",
1948
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
1949
- }
1950
- ],
1951
- "tags": {
1952
- "deprecated": "⚠️ `Status` in Labs has been deprecated and will be removed in a future major version. Please use [`Combobox` in Main](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs) instead."
1953
- },
1954
- "type": {
1955
- "kind": "component",
1956
- "props": [
1957
- {
1958
- "kind": "property",
1959
- "name": "ariaLive",
1960
- "required": false,
1961
- "type": {
1962
- "kind": "union",
1963
- "value": [
1964
- {
1965
- "kind": "string",
1966
- "value": "polite"
1967
- },
1968
- {
1969
- "kind": "string",
1970
- "value": "assertive"
1971
- },
1972
- {
1973
- "kind": "string",
1974
- "value": "off"
1975
- }
1976
- ]
1977
- },
1978
- "description": "",
1979
- "declarations": [
1980
- {
1981
- "name": "ariaLive",
1982
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
1983
- }
1984
- ],
1985
- "tags": {},
1986
- "defaultValue": {
1987
- "kind": "string",
1988
- "value": "polite"
1989
- }
1990
- },
1991
- {
1992
- "kind": "property",
1993
- "name": "role",
1994
- "required": false,
1995
- "type": {
1996
- "kind": "union",
1997
- "value": [
1998
- {
1999
- "kind": "string",
2000
- "value": "log"
2001
- },
2002
- {
2003
- "kind": "string",
2004
- "value": "status"
2005
- },
2006
- {
2007
- "kind": "string",
2008
- "value": "alert"
2009
- },
2010
- {
2011
- "kind": "string",
2012
- "value": "progressbar"
2013
- },
2014
- {
2015
- "kind": "string",
2016
- "value": "marquee"
2017
- },
2018
- {
2019
- "kind": "string",
2020
- "value": "timer"
2021
- }
2022
- ]
2023
- },
2024
- "description": "",
2025
- "declarations": [
2026
- {
2027
- "name": "role",
2028
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
2029
- }
2030
- ],
2031
- "tags": {},
2032
- "defaultValue": {
2033
- "kind": "string",
2034
- "value": "status"
2035
- }
2036
- },
2037
- {
2038
- "kind": "property",
2039
- "name": "ariaRelevant",
2040
- "required": false,
2041
- "type": {
2042
- "kind": "union",
2043
- "value": [
2044
- {
2045
- "kind": "string",
2046
- "value": "additions"
2047
- },
2048
- {
2049
- "kind": "string",
2050
- "value": "additions text"
2051
- },
2052
- {
2053
- "kind": "string",
2054
- "value": "all"
2055
- },
2056
- {
2057
- "kind": "string",
2058
- "value": "removals"
2059
- },
2060
- {
2061
- "kind": "string",
2062
- "value": "text"
2063
- }
2064
- ]
2065
- },
2066
- "description": "",
2067
- "declarations": [
2068
- {
2069
- "name": "ariaRelevant",
2070
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
2071
- }
2072
- ],
2073
- "tags": {},
2074
- "defaultValue": {
2075
- "kind": "string",
2076
- "value": "additions"
2077
- }
2078
- },
2079
- {
2080
- "kind": "property",
2081
- "name": "ariaAtomic",
2082
- "required": false,
2083
- "type": {
2084
- "kind": "primitive",
2085
- "value": "boolean"
2086
- },
2087
- "description": "",
2088
- "declarations": [
2089
- {
2090
- "name": "ariaAtomic",
2091
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
2092
- }
2093
- ],
2094
- "tags": {}
2095
- },
2096
- {
2097
- "kind": "property",
2098
- "name": "expireMilliseconds",
2099
- "required": false,
2100
- "type": {
2101
- "kind": "primitive",
2102
- "value": "number"
2103
- },
2104
- "description": "",
2105
- "declarations": [
2106
- {
2107
- "name": "expireMilliseconds",
2108
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
2109
- }
2110
- ],
2111
- "tags": {},
2112
- "defaultValue": {
2113
- "kind": "number",
2114
- "value": 500
2115
- }
2116
- },
2117
- {
2118
- "kind": "property",
2119
- "name": "announcementText",
2120
- "required": false,
2121
- "type": {
2122
- "kind": "primitive",
2123
- "value": "string"
2124
- },
2125
- "description": "",
2126
- "declarations": [
2127
- {
2128
- "name": "announcementText",
2129
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/combobox/lib/Status.tsx"
2130
- }
2131
- ],
2132
- "tags": {},
2133
- "defaultValue": {
2134
- "kind": "string",
2135
- "value": ""
2136
- }
2137
- }
2138
- ]
2139
- }
2140
- },
2141
- {
2142
- "name": "ComponentStyles",
2143
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
2144
- "description": "",
2145
- "declarations": [
2146
- {
2147
- "name": "ComponentStyles",
2148
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
2149
- }
2150
- ],
2151
- "tags": {},
2152
- "type": {
2153
- "kind": "type",
2154
- "typeParameters": [],
2155
- "value": {
2156
- "kind": "external",
2157
- "name": "Record",
2158
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
2159
- "typeParameters": [
2160
- {
2161
- "kind": "primitive",
2162
- "value": "string"
2163
- },
2164
- {
2165
- "kind": "symbol",
2166
- "name": "CSSProperties",
2167
- "value": "CSSProperties"
2168
- }
2169
- ]
2170
- }
2171
- }
2172
- },
2173
- {
2174
- "name": "useThemeRTL",
2175
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
2176
- "description": "A helpful hook for supporting bidirectional styles.\n* Read below for more detail or [view the docs](https://github.com/Workday/canvas-kit/blob/master/modules/labs-react/common/README.md#useThemeRTL).",
2177
- "declarations": [
2178
- {
2179
- "name": "useThemeRTL",
2180
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
2181
- }
2182
- ],
2183
- "tags": {
2184
- "returns": "* `themeRTL` - a function to transform bidirectional styles\n* `theme` - the Canvas theme object (optional, provided for convenience)\n\n`themeRTL` allows you to support bidirectionality with a single set of styles and pass them along to a component.\nIt accepts CSS object styles and transforms CSS attributes based on the content direction set in the theme (LTR or RTL).",
2185
- "example": "import { type } from '@workday/canvas-kit-react/tokens';\nimport { useThemeRTL } from '@workday/canvas-kit-labs-react/common';\n\nconst ErrorText: React.FC = (props) => {\n const { themeRTL, theme } = useThemeRTL();\n // `borderLeft` will be converted to `borderRight`\n // when the theme direction is `RTL`.\n // All other styles will remain unchanged.\n const errorTextStyles = themeRTL({\n ...type.levels.subtext.medium,\n color: theme.canvas.palette.error.main,\n borderLeft: `solid 2px ${theme.canvas.palette.error.main}`,\n });\n\n return <span css={errorTextStyles} {...props} />;\n}",
2186
- "deprecated": "⚠️ `useThemeRTL` has been deprecated and will be removed in a future major version. Now that IE11 is no longer supported, we encourage consumers to use [CSS logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties)."
2187
- },
2188
- "type": {
2189
- "kind": "function",
2190
- "parameters": [],
2191
- "members": [],
2192
- "returnType": {
2193
- "kind": "object",
2194
- "properties": [
2195
- {
2196
- "kind": "property",
2197
- "name": "themeRTL",
2198
- "type": {
2199
- "kind": "function",
2200
- "parameters": [
2201
- {
2202
- "kind": "parameter",
2203
- "name": "cssObject",
2204
- "type": {
2205
- "kind": "array",
2206
- "value": {
2207
- "kind": "symbol",
2208
- "name": "CSSProperties",
2209
- "value": "CSSProperties"
2210
- }
2211
- },
2212
- "required": true,
2213
- "rest": true,
2214
- "description": "",
2215
- "declarations": [
2216
- {
2217
- "name": "cssObject",
2218
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
2219
- }
2220
- ],
2221
- "tags": {}
2222
- }
2223
- ],
2224
- "members": [],
2225
- "returnType": {
2226
- "kind": "external",
2227
- "name": "CSSProperties",
2228
- "url": "https://emotion.sh/docs/object-styles"
2229
- }
2230
- },
2231
- "description": "",
2232
- "declarations": [
2233
- {
2234
- "name": "themeRTL",
2235
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
2236
- }
2237
- ],
2238
- "tags": {}
2239
- },
2240
- {
2241
- "kind": "property",
2242
- "name": "theme",
2243
- "type": {
2244
- "kind": "symbol",
2245
- "name": "EmotionCanvasTheme",
2246
- "value": "EmotionCanvasTheme"
2247
- },
2248
- "description": "",
2249
- "declarations": [
2250
- {
2251
- "name": "theme",
2252
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
2253
- }
2254
- ],
2255
- "tags": {}
2256
- }
2257
- ]
2258
- }
2259
- }
2260
- },
2261
- {
2262
- "name": "SearchFormProps",
2263
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx",
2264
- "description": "",
2265
- "declarations": [
2266
- {
2267
- "name": "SearchFormProps",
2268
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
2269
- }
2270
- ],
2271
- "tags": {
2272
- "deprecated": "⚠️ `SearchFormProps` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
2273
- },
2274
- "type": {
2275
- "kind": "alias",
2276
- "name": "SearchForm"
2277
- }
2278
- },
2279
- {
2280
- "name": "SearchFormState",
2281
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx",
2282
- "description": "",
2283
- "declarations": [
2284
- {
2285
- "name": "SearchFormState",
2286
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
2287
- }
2288
- ],
2289
- "tags": {
2290
- "deprecated": "⚠️ `SearchFormState` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
2291
- },
2292
- "type": {
2293
- "kind": "object",
2294
- "properties": [
2295
- {
2296
- "kind": "property",
2297
- "name": "showForm",
2298
- "required": true,
2299
- "type": {
2300
- "kind": "primitive",
2301
- "value": "boolean"
2302
- },
2303
- "description": "",
2304
- "declarations": [
2305
- {
2306
- "name": "showForm",
2307
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
2308
- }
2309
- ],
2310
- "tags": {}
2311
- },
2312
- {
2313
- "kind": "property",
2314
- "name": "searchQuery",
2315
- "required": true,
2316
- "type": {
2317
- "kind": "primitive",
2318
- "value": "string"
2319
- },
2320
- "description": "",
2321
- "declarations": [
2322
- {
2323
- "name": "searchQuery",
2324
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
2325
- }
2326
- ],
2327
- "tags": {}
2328
- },
2329
- {
2330
- "kind": "property",
2331
- "name": "isFocused",
2332
- "required": true,
2333
- "type": {
2334
- "kind": "primitive",
2335
- "value": "boolean"
2336
- },
2337
- "description": "",
2338
- "declarations": [
2339
- {
2340
- "name": "isFocused",
2341
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
2342
- }
2343
- ],
2344
- "tags": {}
2345
- }
2346
- ]
2347
- }
2348
- },
2349
- {
2350
- "name": "searchFormStencil",
2351
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx",
2352
- "description": "",
2353
- "declarations": [
2354
- {
2355
- "name": "searchFormStencil",
2356
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
2357
- }
2358
- ],
2359
- "tags": {
2360
- "deprecated": "⚠️ `searchFormStencil` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
2361
- },
2362
- "type": {
2363
- "kind": "function",
2364
- "parameters": [
2365
- {
2366
- "kind": "parameter",
2367
- "name": "options",
2368
- "type": {
2369
- "kind": "conditional",
2370
- "check": {
2371
- "kind": "tuple",
2372
- "value": [
2373
- {
2374
- "kind": "symbol",
2375
- "name": "E",
2376
- "value": "E"
2377
- }
2378
- ]
2379
- },
2380
- "extends": {
2381
- "kind": "tuple",
2382
- "value": [
2383
- {
2384
- "kind": "primitive",
2385
- "value": "never"
2386
- }
2387
- ]
2388
- },
2389
- "trueType": {
2390
- "kind": "intersection",
2391
- "value": [
2392
- {
2393
- "kind": "symbol",
2394
- "name": "ModifierValuesStencil",
2395
- "typeParameters": [
2396
- {
2397
- "kind": "symbol",
2398
- "name": "M",
2399
- "value": "M"
2400
- },
2401
- {
2402
- "kind": "symbol",
2403
- "name": "V",
2404
- "value": "V"
2405
- }
2406
- ],
2407
- "value": "ModifierValuesStencil<M, V>"
2408
- },
2409
- {
2410
- "kind": "symbol",
2411
- "name": "VariableValuesStencil",
2412
- "typeParameters": [
2413
- {
2414
- "kind": "symbol",
2415
- "name": "V",
2416
- "value": "V"
2417
- }
2418
- ],
2419
- "value": "VariableValuesStencil<V>"
2420
- }
2421
- ]
2422
- },
2423
- "falseType": {
2424
- "kind": "conditional",
2425
- "check": {
2426
- "kind": "symbol",
2427
- "name": "E",
2428
- "value": "E"
2429
- },
2430
- "extends": {
2431
- "kind": "symbol",
2432
- "name": "BaseStencil",
2433
- "typeParameters": [
2434
- {
2435
- "kind": "infer",
2436
- "value": {
2437
- "kind": "typeParameter",
2438
- "name": "ME",
2439
- "required": true
2440
- }
2441
- },
2442
- {
2443
- "kind": "primitive",
2444
- "value": "any"
2445
- },
2446
- {
2447
- "kind": "infer",
2448
- "value": {
2449
- "kind": "typeParameter",
2450
- "name": "VE",
2451
- "required": true
2452
- }
2453
- },
2454
- {
2455
- "kind": "primitive",
2456
- "value": "any"
2457
- },
2458
- {
2459
- "kind": "primitive",
2460
- "value": "any"
2461
- }
2462
- ],
2463
- "value": "BaseStencil<M, P, V, E, ID>"
2464
- },
2465
- "trueType": {
2466
- "kind": "intersection",
2467
- "value": [
2468
- {
2469
- "kind": "symbol",
2470
- "name": "ModifierValuesStencil",
2471
- "typeParameters": [
2472
- {
2473
- "kind": "intersection",
2474
- "value": [
2475
- {
2476
- "kind": "symbol",
2477
- "name": "ME",
2478
- "value": "ME"
2479
- },
2480
- {
2481
- "kind": "symbol",
2482
- "name": "M",
2483
- "value": "M"
2484
- }
2485
- ]
2486
- },
2487
- {
2488
- "kind": "intersection",
2489
- "value": [
2490
- {
2491
- "kind": "symbol",
2492
- "name": "VE",
2493
- "value": "VE"
2494
- },
2495
- {
2496
- "kind": "symbol",
2497
- "name": "V",
2498
- "value": "V"
2499
- }
2500
- ]
2501
- }
2502
- ],
2503
- "value": "ModifierValuesStencil<M, V>"
2504
- },
2505
- {
2506
- "kind": "symbol",
2507
- "name": "VariableValuesStencil",
2508
- "typeParameters": [
2509
- {
2510
- "kind": "intersection",
2511
- "value": [
2512
- {
2513
- "kind": "symbol",
2514
- "name": "VE",
2515
- "value": "VE"
2516
- },
2517
- {
2518
- "kind": "symbol",
2519
- "name": "V",
2520
- "value": "V"
2521
- }
2522
- ]
2523
- }
2524
- ],
2525
- "value": "VariableValuesStencil<V>"
2526
- }
2527
- ]
2528
- },
2529
- "falseType": {
2530
- "kind": "primitive",
2531
- "value": "never"
2532
- }
2533
- }
2534
- },
2535
- "required": false,
2536
- "rest": false,
2537
- "description": "",
2538
- "declarations": [
2539
- {
2540
- "name": "options",
2541
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2542
- }
2543
- ],
2544
- "tags": {}
2545
- }
2546
- ],
2547
- "members": [
2548
- {
2549
- "kind": "property",
2550
- "name": "parts",
2551
- "required": true,
2552
- "type": {
2553
- "kind": "conditional",
2554
- "check": {
2555
- "kind": "tuple",
2556
- "value": [
2557
- {
2558
- "kind": "symbol",
2559
- "name": "E",
2560
- "value": "E"
2561
- }
2562
- ]
2563
- },
2564
- "extends": {
2565
- "kind": "tuple",
2566
- "value": [
2567
- {
2568
- "kind": "symbol",
2569
- "name": "BaseStencil",
2570
- "typeParameters": [
2571
- {
2572
- "kind": "primitive",
2573
- "value": "any"
2574
- },
2575
- {
2576
- "kind": "infer",
2577
- "value": {
2578
- "kind": "typeParameter",
2579
- "name": "PE",
2580
- "required": true
2581
- }
2582
- },
2583
- {
2584
- "kind": "primitive",
2585
- "value": "any"
2586
- },
2587
- {
2588
- "kind": "primitive",
2589
- "value": "any"
2590
- },
2591
- {
2592
- "kind": "primitive",
2593
- "value": "any"
2594
- }
2595
- ],
2596
- "value": "BaseStencil<M, P, V, E, ID>"
2597
- }
2598
- ]
2599
- },
2600
- "trueType": {
2601
- "kind": "symbol",
2602
- "name": "StencilPartProps",
2603
- "typeParameters": [
2604
- {
2605
- "kind": "intersection",
2606
- "value": [
2607
- {
2608
- "kind": "symbol",
2609
- "name": "PE",
2610
- "value": "PE"
2611
- },
2612
- {
2613
- "kind": "symbol",
2614
- "name": "P",
2615
- "value": "P"
2616
- }
2617
- ]
2618
- }
2619
- ],
2620
- "value": "StencilPartProps<T>"
2621
- },
2622
- "falseType": {
2623
- "kind": "symbol",
2624
- "name": "StencilPartProps",
2625
- "typeParameters": [
2626
- {
2627
- "kind": "symbol",
2628
- "name": "P",
2629
- "value": "P"
2630
- }
2631
- ],
2632
- "value": "StencilPartProps<T>"
2633
- }
2634
- },
2635
- "description": "",
2636
- "declarations": [
2637
- {
2638
- "name": "parts",
2639
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2640
- }
2641
- ],
2642
- "tags": {}
2643
- },
2644
- {
2645
- "kind": "property",
2646
- "name": "vars",
2647
- "required": true,
2648
- "type": {
2649
- "kind": "symbol",
2650
- "name": "StencilDefaultVars",
2651
- "typeParameters": [
2652
- {
2653
- "kind": "symbol",
2654
- "name": "V",
2655
- "value": "V"
2656
- },
2657
- {
2658
- "kind": "symbol",
2659
- "name": "E",
2660
- "value": "E"
2661
- },
2662
- {
2663
- "kind": "symbol",
2664
- "name": "ID",
2665
- "value": "ID"
2666
- }
2667
- ],
2668
- "value": "StencilDefaultVars<V, E, ID>"
2669
- },
2670
- "description": "",
2671
- "declarations": [
2672
- {
2673
- "name": "vars",
2674
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2675
- }
2676
- ],
2677
- "tags": {}
2678
- },
2679
- {
2680
- "kind": "property",
2681
- "name": "base",
2682
- "required": true,
2683
- "type": {
1173
+ "name": "ComponentStyles",
1174
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
1175
+ "description": "",
1176
+ "declarations": [
1177
+ {
1178
+ "name": "ComponentStyles",
1179
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
1180
+ }
1181
+ ],
1182
+ "tags": {},
1183
+ "type": {
1184
+ "kind": "type",
1185
+ "typeParameters": [],
1186
+ "value": {
1187
+ "kind": "external",
1188
+ "name": "Record",
1189
+ "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
1190
+ "typeParameters": [
1191
+ {
2684
1192
  "kind": "primitive",
2685
1193
  "value": "string"
2686
1194
  },
2687
- "description": "",
2688
- "declarations": [
2689
- {
2690
- "name": "base",
2691
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2692
- }
2693
- ],
2694
- "tags": {}
2695
- },
2696
- {
2697
- "kind": "property",
2698
- "name": "modifiers",
2699
- "required": true,
2700
- "type": {
2701
- "kind": "conditional",
2702
- "check": {
2703
- "kind": "tuple",
2704
- "value": [
2705
- {
2706
- "kind": "symbol",
2707
- "name": "E",
2708
- "value": "E"
2709
- }
2710
- ]
2711
- },
2712
- "extends": {
2713
- "kind": "tuple",
2714
- "value": [
2715
- {
2716
- "kind": "symbol",
2717
- "name": "BaseStencil",
2718
- "typeParameters": [
2719
- {
2720
- "kind": "infer",
2721
- "value": {
2722
- "kind": "typeParameter",
2723
- "name": "ME",
2724
- "required": true
2725
- }
2726
- },
2727
- {
2728
- "kind": "primitive",
2729
- "value": "any"
2730
- },
2731
- {
2732
- "kind": "infer",
2733
- "value": {
2734
- "kind": "typeParameter",
2735
- "name": "VE",
2736
- "required": true
2737
- }
2738
- },
2739
- {
2740
- "kind": "primitive",
2741
- "value": "any"
2742
- },
2743
- {
2744
- "kind": "primitive",
2745
- "value": "any"
2746
- }
2747
- ],
2748
- "value": "BaseStencil<M, P, V, E, ID>"
2749
- }
2750
- ]
2751
- },
2752
- "trueType": {
2753
- "kind": "symbol",
2754
- "name": "StencilModifierReturn",
2755
- "typeParameters": [
2756
- {
2757
- "kind": "intersection",
2758
- "value": [
2759
- {
2760
- "kind": "symbol",
2761
- "name": "ME",
2762
- "value": "ME"
2763
- },
2764
- {
2765
- "kind": "symbol",
2766
- "name": "M",
2767
- "value": "M"
2768
- }
2769
- ]
2770
- },
1195
+ {
1196
+ "kind": "symbol",
1197
+ "name": "CSSProperties",
1198
+ "value": "CSSProperties"
1199
+ }
1200
+ ]
1201
+ }
1202
+ }
1203
+ },
1204
+ {
1205
+ "name": "useThemeRTL",
1206
+ "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts",
1207
+ "description": "A helpful hook for supporting bidirectional styles.\n* Read below for more detail or [view the docs](https://github.com/Workday/canvas-kit/blob/master/modules/labs-react/common/README.md#useThemeRTL).",
1208
+ "declarations": [
1209
+ {
1210
+ "name": "useThemeRTL",
1211
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
1212
+ }
1213
+ ],
1214
+ "tags": {
1215
+ "returns": "* `themeRTL` - a function to transform bidirectional styles\n* `theme` - the Canvas theme object (optional, provided for convenience)\n\n`themeRTL` allows you to support bidirectionality with a single set of styles and pass them along to a component.\nIt accepts CSS object styles and transforms CSS attributes based on the content direction set in the theme (LTR or RTL).",
1216
+ "example": "import { type } from '@workday/canvas-kit-react/tokens';\nimport { useThemeRTL } from '@workday/canvas-kit-labs-react/common';\n\nconst ErrorText: React.FC = (props) => {\n const { themeRTL, theme } = useThemeRTL();\n // `borderLeft` will be converted to `borderRight`\n // when the theme direction is `RTL`.\n // All other styles will remain unchanged.\n const errorTextStyles = themeRTL({\n ...type.levels.subtext.medium,\n color: theme.canvas.palette.error.main,\n borderLeft: `solid 2px ${theme.canvas.palette.error.main}`,\n });\n\n return <span css={errorTextStyles} {...props} />;\n}",
1217
+ "deprecated": "⚠️ `useThemeRTL` has been deprecated and will be removed in a future major version. Now that IE11 is no longer supported, we encourage consumers to use [CSS logical properties](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Logical_Properties)."
1218
+ },
1219
+ "type": {
1220
+ "kind": "function",
1221
+ "parameters": [],
1222
+ "members": [],
1223
+ "returnType": {
1224
+ "kind": "object",
1225
+ "properties": [
1226
+ {
1227
+ "kind": "property",
1228
+ "name": "themeRTL",
1229
+ "type": {
1230
+ "kind": "function",
1231
+ "parameters": [
2771
1232
  {
2772
- "kind": "intersection",
2773
- "value": [
2774
- {
2775
- "kind": "symbol",
2776
- "name": "VE",
2777
- "value": "VE"
2778
- },
2779
- {
1233
+ "kind": "parameter",
1234
+ "name": "cssObject",
1235
+ "type": {
1236
+ "kind": "array",
1237
+ "value": {
2780
1238
  "kind": "symbol",
2781
- "name": "V",
2782
- "value": "V"
1239
+ "name": "CSSProperties",
1240
+ "value": "CSSProperties"
2783
1241
  }
2784
- ]
2785
- }
2786
- ],
2787
- "value": "StencilModifierReturn<M, V>"
2788
- },
2789
- "falseType": {
2790
- "kind": "symbol",
2791
- "name": "StencilModifierReturn",
2792
- "typeParameters": [
2793
- {
2794
- "kind": "symbol",
2795
- "name": "M",
2796
- "value": "M"
2797
- },
2798
- {
2799
- "kind": "symbol",
2800
- "name": "V",
2801
- "value": "V"
2802
- }
2803
- ],
2804
- "value": "StencilModifierReturn<M, V>"
2805
- }
2806
- },
2807
- "description": "",
2808
- "declarations": [
2809
- {
2810
- "name": "modifiers",
2811
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2812
- }
2813
- ],
2814
- "tags": {}
2815
- },
2816
- {
2817
- "kind": "property",
2818
- "name": "defaultModifiers",
2819
- "required": true,
2820
- "type": {
2821
- "kind": "conditional",
2822
- "check": {
2823
- "kind": "tuple",
2824
- "value": [
2825
- {
2826
- "kind": "symbol",
2827
- "name": "E",
2828
- "value": "E"
2829
- }
2830
- ]
2831
- },
2832
- "extends": {
2833
- "kind": "tuple",
2834
- "value": [
2835
- {
2836
- "kind": "symbol",
2837
- "name": "BaseStencil",
2838
- "typeParameters": [
2839
- {
2840
- "kind": "infer",
2841
- "value": {
2842
- "kind": "typeParameter",
2843
- "name": "ME",
2844
- "required": true
2845
- }
2846
- },
2847
- {
2848
- "kind": "primitive",
2849
- "value": "any"
2850
- },
2851
- {
2852
- "kind": "primitive",
2853
- "value": "any"
2854
- },
2855
- {
2856
- "kind": "primitive",
2857
- "value": "any"
2858
- },
1242
+ },
1243
+ "required": true,
1244
+ "rest": true,
1245
+ "description": "",
1246
+ "declarations": [
2859
1247
  {
2860
- "kind": "primitive",
2861
- "value": "any"
1248
+ "name": "cssObject",
1249
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
2862
1250
  }
2863
1251
  ],
2864
- "value": "BaseStencil<M, P, V, E, ID>"
2865
- }
2866
- ]
2867
- },
2868
- "trueType": {
2869
- "kind": "symbol",
2870
- "name": "StencilDefaultModifierReturn",
2871
- "typeParameters": [
2872
- {
2873
- "kind": "intersection",
2874
- "value": [
2875
- {
2876
- "kind": "symbol",
2877
- "name": "ME",
2878
- "value": "ME"
2879
- },
2880
- {
2881
- "kind": "symbol",
2882
- "name": "M",
2883
- "value": "M"
2884
- }
2885
- ]
2886
- }
2887
- ],
2888
- "value": "StencilDefaultModifierReturn<M>"
2889
- },
2890
- "falseType": {
2891
- "kind": "symbol",
2892
- "name": "StencilDefaultModifierReturn",
2893
- "typeParameters": [
2894
- {
2895
- "kind": "symbol",
2896
- "name": "M",
2897
- "value": "M"
1252
+ "tags": {}
2898
1253
  }
2899
1254
  ],
2900
- "value": "StencilDefaultModifierReturn<M>"
2901
- }
2902
- },
2903
- "description": "",
2904
- "declarations": [
2905
- {
2906
- "name": "defaultModifiers",
2907
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2908
- }
2909
- ],
2910
- "tags": {}
2911
- },
2912
- {
2913
- "kind": "property",
2914
- "name": "__extends",
2915
- "required": false,
2916
- "type": {
2917
- "kind": "symbol",
2918
- "name": "E",
2919
- "value": "E"
2920
- },
2921
- "description": "",
2922
- "declarations": [
2923
- {
2924
- "name": "__extends",
2925
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2926
- }
2927
- ],
2928
- "tags": {}
2929
- },
2930
- {
2931
- "kind": "property",
2932
- "name": "__vars",
2933
- "required": true,
2934
- "type": {
2935
- "kind": "symbol",
2936
- "name": "V",
2937
- "value": "V"
2938
- },
2939
- "description": "",
2940
- "declarations": [
2941
- {
2942
- "name": "__vars",
2943
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2944
- }
2945
- ],
2946
- "tags": {}
2947
- },
2948
- {
2949
- "kind": "property",
2950
- "name": "__modifiers",
2951
- "required": true,
2952
- "type": {
2953
- "kind": "symbol",
2954
- "name": "M",
2955
- "value": "M"
2956
- },
2957
- "description": "",
2958
- "declarations": [
2959
- {
2960
- "name": "__modifiers",
2961
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2962
- }
2963
- ],
2964
- "tags": {}
2965
- },
2966
- {
2967
- "kind": "property",
2968
- "name": "__id",
2969
- "required": true,
2970
- "type": {
2971
- "kind": "symbol",
2972
- "name": "ID",
2973
- "value": "ID"
2974
- },
2975
- "description": "",
2976
- "declarations": [
2977
- {
2978
- "name": "__id",
2979
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2980
- }
2981
- ],
2982
- "tags": {}
2983
- },
2984
- {
2985
- "kind": "property",
2986
- "name": "__parts",
2987
- "required": false,
2988
- "type": {
2989
- "kind": "symbol",
2990
- "name": "P",
2991
- "value": "P"
2992
- },
2993
- "description": "",
2994
- "declarations": [
2995
- {
2996
- "name": "__parts",
2997
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
2998
- }
2999
- ],
3000
- "tags": {}
3001
- }
3002
- ],
3003
- "returnType": {
3004
- "kind": "object",
3005
- "properties": [
3006
- {
3007
- "kind": "property",
3008
- "name": "className",
3009
- "required": true,
3010
- "type": {
3011
- "kind": "primitive",
3012
- "value": "string"
1255
+ "members": [],
1256
+ "returnType": {
1257
+ "kind": "external",
1258
+ "name": "CSSProperties",
1259
+ "url": "https://emotion.sh/docs/object-styles"
1260
+ }
3013
1261
  },
3014
1262
  "description": "",
3015
1263
  "declarations": [
3016
1264
  {
3017
- "name": "className",
3018
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
1265
+ "name": "themeRTL",
1266
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
3019
1267
  }
3020
1268
  ],
3021
1269
  "tags": {}
3022
1270
  },
3023
1271
  {
3024
1272
  "kind": "property",
3025
- "name": "style",
3026
- "required": false,
1273
+ "name": "theme",
3027
1274
  "type": {
3028
- "kind": "external",
3029
- "name": "Record",
3030
- "url": "https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type",
3031
- "typeParameters": [
3032
- {
3033
- "kind": "primitive",
3034
- "value": "string"
3035
- },
3036
- {
3037
- "kind": "primitive",
3038
- "value": "string"
3039
- }
3040
- ]
1275
+ "kind": "symbol",
1276
+ "name": "EmotionCanvasTheme",
1277
+ "value": "EmotionCanvasTheme"
3041
1278
  },
3042
1279
  "description": "",
3043
1280
  "declarations": [
3044
1281
  {
3045
- "name": "style",
3046
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
1282
+ "name": "theme",
1283
+ "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/common/lib/theming/useThemeRTL.ts"
3047
1284
  }
3048
1285
  ],
3049
1286
  "tags": {}
@@ -3052,732 +1289,6 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
3052
1289
  }
3053
1290
  }
3054
1291
  },
3055
- {
3056
- "name": "SearchForm",
3057
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx",
3058
- "description": "",
3059
- "declarations": [
3060
- {
3061
- "name": "SearchForm",
3062
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3063
- }
3064
- ],
3065
- "tags": {
3066
- "deprecated": "⚠️ `SearchForm` is deprecated and will be removed in a future major version. Please reference our [Autocomplete example](https://workday.github.io/canvas-kit/?path=/docs/features-combobox--docs#usage)."
3067
- },
3068
- "type": {
3069
- "kind": "component",
3070
- "props": [
3071
- {
3072
- "kind": "property",
3073
- "name": "onSubmit",
3074
- "required": true,
3075
- "type": {
3076
- "kind": "symbol",
3077
- "name": "React.FormEventHandler",
3078
- "typeParameters": [
3079
- {
3080
- "kind": "symbol",
3081
- "name": "HTMLFormElement",
3082
- "value": "HTMLFormElement"
3083
- }
3084
- ],
3085
- "value": "FormEventHandler<T>"
3086
- },
3087
- "description": "The function called when the SearchForm form is submitted. The current input value is passed to the callback function.",
3088
- "declarations": [
3089
- {
3090
- "name": "onSubmit",
3091
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3092
- }
3093
- ],
3094
- "tags": {}
3095
- },
3096
- {
3097
- "kind": "property",
3098
- "name": "isCollapsed",
3099
- "required": false,
3100
- "type": {
3101
- "kind": "primitive",
3102
- "value": "boolean"
3103
- },
3104
- "description": "If true, collapse the SearchForm text input into a toggle icon. Useful for responsive layouts.",
3105
- "declarations": [
3106
- {
3107
- "name": "isCollapsed",
3108
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3109
- }
3110
- ],
3111
- "tags": {
3112
- "default": "false"
3113
- },
3114
- "defaultValue": {
3115
- "kind": "boolean",
3116
- "value": false
3117
- }
3118
- },
3119
- {
3120
- "kind": "property",
3121
- "name": "onInputChange",
3122
- "required": false,
3123
- "type": {
3124
- "kind": "symbol",
3125
- "name": "React.ChangeEventHandler",
3126
- "typeParameters": [
3127
- {
3128
- "kind": "symbol",
3129
- "name": "HTMLInputElement",
3130
- "value": "HTMLInputElement"
3131
- }
3132
- ],
3133
- "value": "ChangeEventHandler<T>"
3134
- },
3135
- "description": "The function called when the SearchForm text input changes.",
3136
- "declarations": [
3137
- {
3138
- "name": "onInputChange",
3139
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3140
- }
3141
- ],
3142
- "tags": {}
3143
- },
3144
- {
3145
- "kind": "property",
3146
- "name": "autocompleteItems",
3147
- "required": false,
3148
- "type": {
3149
- "kind": "array",
3150
- "value": {
3151
- "kind": "external",
3152
- "name": "ReactElement",
3153
- "url": "https://reactjs.org/docs/rendering-elements.html",
3154
- "typeParameters": [
3155
- {
3156
- "kind": "primitive",
3157
- "value": "any"
3158
- }
3159
- ]
3160
- }
3161
- },
3162
- "description": "The autocomplete items of the SearchForm. This array of menu items is shown under the search bar.",
3163
- "declarations": [
3164
- {
3165
- "name": "autocompleteItems",
3166
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3167
- }
3168
- ],
3169
- "tags": {}
3170
- },
3171
- {
3172
- "kind": "property",
3173
- "name": "searchTheme",
3174
- "required": false,
3175
- "type": {
3176
- "kind": "union",
3177
- "value": [
3178
- {
3179
- "kind": "symbol",
3180
- "name": "SearchTheme",
3181
- "value": "SearchTheme"
3182
- },
3183
- {
3184
- "kind": "symbol",
3185
- "name": "SearchThemeAttributes",
3186
- "value": "SearchThemeAttributes"
3187
- }
3188
- ]
3189
- },
3190
- "description": "The theme of the header the search input is being rendered in.",
3191
- "declarations": [
3192
- {
3193
- "name": "searchTheme",
3194
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3195
- }
3196
- ],
3197
- "tags": {}
3198
- },
3199
- {
3200
- "kind": "property",
3201
- "name": "placeholder",
3202
- "required": false,
3203
- "type": {
3204
- "kind": "primitive",
3205
- "value": "string"
3206
- },
3207
- "description": "The placeholder text of the SearchForm text input.",
3208
- "declarations": [
3209
- {
3210
- "name": "placeholder",
3211
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3212
- }
3213
- ],
3214
- "tags": {
3215
- "default": "Search"
3216
- },
3217
- "defaultValue": {
3218
- "kind": "symbol",
3219
- "name": "Search",
3220
- "value": "Search"
3221
- }
3222
- },
3223
- {
3224
- "kind": "property",
3225
- "name": "initialValue",
3226
- "required": false,
3227
- "type": {
3228
- "kind": "primitive",
3229
- "value": "string"
3230
- },
3231
- "description": "The initial value of the SearchForm text input.",
3232
- "declarations": [
3233
- {
3234
- "name": "initialValue",
3235
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3236
- }
3237
- ],
3238
- "tags": {}
3239
- },
3240
- {
3241
- "kind": "property",
3242
- "name": "rightAlign",
3243
- "required": false,
3244
- "type": {
3245
- "kind": "primitive",
3246
- "value": "boolean"
3247
- },
3248
- "description": "If true, right-align the SearchForm. If false, the text input should grow to left-align the SearchForm.",
3249
- "declarations": [
3250
- {
3251
- "name": "rightAlign",
3252
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3253
- }
3254
- ],
3255
- "tags": {
3256
- "default": "false"
3257
- },
3258
- "defaultValue": {
3259
- "kind": "boolean",
3260
- "value": false
3261
- }
3262
- },
3263
- {
3264
- "kind": "property",
3265
- "name": "inputLabel",
3266
- "required": false,
3267
- "type": {
3268
- "kind": "primitive",
3269
- "value": "string"
3270
- },
3271
- "description": "The screenreader label text for the SearchForm text input.",
3272
- "declarations": [
3273
- {
3274
- "name": "inputLabel",
3275
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3276
- }
3277
- ],
3278
- "tags": {
3279
- "default": "Search"
3280
- },
3281
- "defaultValue": {
3282
- "kind": "symbol",
3283
- "name": "Search",
3284
- "value": "Search"
3285
- }
3286
- },
3287
- {
3288
- "kind": "property",
3289
- "name": "submitAriaLabel",
3290
- "required": false,
3291
- "type": {
3292
- "kind": "primitive",
3293
- "value": "string"
3294
- },
3295
- "description": "The screenreader label text for the SearchForm submit button.",
3296
- "declarations": [
3297
- {
3298
- "name": "submitAriaLabel",
3299
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3300
- }
3301
- ],
3302
- "tags": {
3303
- "default": "Search"
3304
- },
3305
- "defaultValue": {
3306
- "kind": "symbol",
3307
- "name": "Search",
3308
- "value": "Search"
3309
- }
3310
- },
3311
- {
3312
- "kind": "property",
3313
- "name": "clearButtonAriaLabel",
3314
- "required": false,
3315
- "type": {
3316
- "kind": "primitive",
3317
- "value": "string"
3318
- },
3319
- "description": "The screenreader label text for the SearchForm clear button.",
3320
- "declarations": [
3321
- {
3322
- "name": "clearButtonAriaLabel",
3323
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3324
- }
3325
- ],
3326
- "tags": {
3327
- "default": "Reset Search Form"
3328
- },
3329
- "defaultValue": {
3330
- "kind": "symbol",
3331
- "name": "Reset Search Form",
3332
- "value": "Reset Search Form"
3333
- }
3334
- },
3335
- {
3336
- "kind": "property",
3337
- "name": "openButtonAriaLabel",
3338
- "required": false,
3339
- "type": {
3340
- "kind": "primitive",
3341
- "value": "string"
3342
- },
3343
- "description": "The screenreader label text for the button to open the collapsed SearchForm.",
3344
- "declarations": [
3345
- {
3346
- "name": "openButtonAriaLabel",
3347
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3348
- }
3349
- ],
3350
- "tags": {
3351
- "default": "Open Search"
3352
- },
3353
- "defaultValue": {
3354
- "kind": "symbol",
3355
- "name": "Open Search",
3356
- "value": "Open Search"
3357
- }
3358
- },
3359
- {
3360
- "kind": "property",
3361
- "name": "closeButtonAriaLabel",
3362
- "required": false,
3363
- "type": {
3364
- "kind": "primitive",
3365
- "value": "string"
3366
- },
3367
- "description": "The screenreader label text for the button to close the open SearchForm.",
3368
- "declarations": [
3369
- {
3370
- "name": "closeButtonAriaLabel",
3371
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3372
- }
3373
- ],
3374
- "tags": {
3375
- "default": "Cancel"
3376
- },
3377
- "defaultValue": {
3378
- "kind": "symbol",
3379
- "name": "Cancel",
3380
- "value": "Cancel"
3381
- }
3382
- },
3383
- {
3384
- "kind": "property",
3385
- "name": "showClearButton",
3386
- "required": false,
3387
- "type": {
3388
- "kind": "primitive",
3389
- "value": "boolean"
3390
- },
3391
- "description": "If true, render the SearchForm with a button to clear the text input.",
3392
- "declarations": [
3393
- {
3394
- "name": "showClearButton",
3395
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3396
- }
3397
- ],
3398
- "tags": {
3399
- "default": "true"
3400
- },
3401
- "defaultValue": {
3402
- "kind": "boolean",
3403
- "value": true
3404
- }
3405
- },
3406
- {
3407
- "kind": "property",
3408
- "name": "height",
3409
- "required": false,
3410
- "type": {
3411
- "kind": "primitive",
3412
- "value": "number"
3413
- },
3414
- "description": "Height of the Search Form in pixels",
3415
- "declarations": [
3416
- {
3417
- "name": "height",
3418
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3419
- }
3420
- ],
3421
- "tags": {
3422
- "default": "40"
3423
- },
3424
- "defaultValue": {
3425
- "kind": "number",
3426
- "value": 40
3427
- }
3428
- },
3429
- {
3430
- "kind": "property",
3431
- "name": "allowEmptyStringSearch",
3432
- "required": false,
3433
- "type": {
3434
- "kind": "primitive",
3435
- "value": "boolean"
3436
- },
3437
- "description": "If true, allow onSubmit being called when input value is empty.",
3438
- "declarations": [
3439
- {
3440
- "name": "allowEmptyStringSearch",
3441
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3442
- }
3443
- ],
3444
- "tags": {
3445
- "default": "false"
3446
- },
3447
- "defaultValue": {
3448
- "kind": "boolean",
3449
- "value": false
3450
- }
3451
- },
3452
- {
3453
- "kind": "property",
3454
- "name": "labelId",
3455
- "required": false,
3456
- "type": {
3457
- "kind": "primitive",
3458
- "value": "string"
3459
- },
3460
- "description": "Sets the `id` for the label",
3461
- "declarations": [
3462
- {
3463
- "name": "labelId",
3464
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/SearchForm.tsx"
3465
- }
3466
- ],
3467
- "tags": {
3468
- "default": "unique identifier"
3469
- },
3470
- "defaultValue": {
3471
- "kind": "symbol",
3472
- "name": "unique identifier",
3473
- "value": "unique identifier"
3474
- }
3475
- },
3476
- {
3477
- "kind": "property",
3478
- "name": "grow",
3479
- "required": false,
3480
- "type": {
3481
- "kind": "primitive",
3482
- "value": "boolean"
3483
- },
3484
- "description": "True if the component should grow to its container's width. False otherwise.",
3485
- "declarations": [
3486
- {
3487
- "name": "grow",
3488
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/react/common/lib/types.ts"
3489
- }
3490
- ],
3491
- "tags": {}
3492
- },
3493
- {
3494
- "kind": "property",
3495
- "name": "cs",
3496
- "required": false,
3497
- "type": {
3498
- "kind": "symbol",
3499
- "name": "CSToPropsInput",
3500
- "value": "CSToPropsInput"
3501
- },
3502
- "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```",
3503
- "declarations": [
3504
- {
3505
- "name": "cs",
3506
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/styling/dist/es6/lib/cs.d.ts"
3507
- }
3508
- ],
3509
- "tags": {}
3510
- }
3511
- ]
3512
- }
3513
- },
3514
- {
3515
- "name": "SearchTheme",
3516
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts",
3517
- "description": "",
3518
- "declarations": [
3519
- {
3520
- "name": "SearchTheme",
3521
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3522
- }
3523
- ],
3524
- "tags": {
3525
- "deprecated": "⚠️ `SearchTheme` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
3526
- },
3527
- "type": {
3528
- "kind": "object",
3529
- "typeParameters": [],
3530
- "properties": [
3531
- {
3532
- "kind": "property",
3533
- "name": "Light",
3534
- "type": {
3535
- "kind": "string",
3536
- "value": "light"
3537
- }
3538
- },
3539
- {
3540
- "kind": "property",
3541
- "name": "Dark",
3542
- "type": {
3543
- "kind": "string",
3544
- "value": "dark"
3545
- }
3546
- },
3547
- {
3548
- "kind": "property",
3549
- "name": "Transparent",
3550
- "type": {
3551
- "kind": "string",
3552
- "value": "transparent"
3553
- }
3554
- }
3555
- ],
3556
- "callSignatures": []
3557
- }
3558
- },
3559
- {
3560
- "name": "SearchThemeAttributes",
3561
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts",
3562
- "description": "",
3563
- "declarations": [
3564
- {
3565
- "name": "SearchThemeAttributes",
3566
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3567
- }
3568
- ],
3569
- "tags": {
3570
- "deprecated": "⚠️ `SearchThemeAttributes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
3571
- },
3572
- "type": {
3573
- "kind": "object",
3574
- "properties": [
3575
- {
3576
- "kind": "property",
3577
- "name": "background",
3578
- "required": false,
3579
- "type": {
3580
- "kind": "primitive",
3581
- "value": "string"
3582
- },
3583
- "description": "",
3584
- "declarations": [
3585
- {
3586
- "name": "background",
3587
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3588
- }
3589
- ],
3590
- "tags": {}
3591
- },
3592
- {
3593
- "kind": "property",
3594
- "name": "backgroundFocus",
3595
- "required": false,
3596
- "type": {
3597
- "kind": "primitive",
3598
- "value": "string"
3599
- },
3600
- "description": "",
3601
- "declarations": [
3602
- {
3603
- "name": "backgroundFocus",
3604
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3605
- }
3606
- ],
3607
- "tags": {}
3608
- },
3609
- {
3610
- "kind": "property",
3611
- "name": "backgroundHover",
3612
- "required": false,
3613
- "type": {
3614
- "kind": "primitive",
3615
- "value": "string"
3616
- },
3617
- "description": "",
3618
- "declarations": [
3619
- {
3620
- "name": "backgroundHover",
3621
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3622
- }
3623
- ],
3624
- "tags": {}
3625
- },
3626
- {
3627
- "kind": "property",
3628
- "name": "color",
3629
- "required": false,
3630
- "type": {
3631
- "kind": "primitive",
3632
- "value": "string"
3633
- },
3634
- "description": "",
3635
- "declarations": [
3636
- {
3637
- "name": "color",
3638
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3639
- }
3640
- ],
3641
- "tags": {}
3642
- },
3643
- {
3644
- "kind": "property",
3645
- "name": "colorFocus",
3646
- "required": false,
3647
- "type": {
3648
- "kind": "primitive",
3649
- "value": "string"
3650
- },
3651
- "description": "",
3652
- "declarations": [
3653
- {
3654
- "name": "colorFocus",
3655
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3656
- }
3657
- ],
3658
- "tags": {}
3659
- },
3660
- {
3661
- "kind": "property",
3662
- "name": "placeholderColor",
3663
- "required": false,
3664
- "type": {
3665
- "kind": "primitive",
3666
- "value": "string"
3667
- },
3668
- "description": "",
3669
- "declarations": [
3670
- {
3671
- "name": "placeholderColor",
3672
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3673
- }
3674
- ],
3675
- "tags": {}
3676
- },
3677
- {
3678
- "kind": "property",
3679
- "name": "placeholderColorFocus",
3680
- "required": false,
3681
- "type": {
3682
- "kind": "primitive",
3683
- "value": "string"
3684
- },
3685
- "description": "",
3686
- "declarations": [
3687
- {
3688
- "name": "placeholderColorFocus",
3689
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3690
- }
3691
- ],
3692
- "tags": {}
3693
- },
3694
- {
3695
- "kind": "property",
3696
- "name": "boxShadow",
3697
- "required": false,
3698
- "type": {
3699
- "kind": "primitive",
3700
- "value": "string"
3701
- },
3702
- "description": "",
3703
- "declarations": [
3704
- {
3705
- "name": "boxShadow",
3706
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3707
- }
3708
- ],
3709
- "tags": {}
3710
- },
3711
- {
3712
- "kind": "property",
3713
- "name": "boxShadowFocus",
3714
- "required": false,
3715
- "type": {
3716
- "kind": "primitive",
3717
- "value": "string"
3718
- },
3719
- "description": "",
3720
- "declarations": [
3721
- {
3722
- "name": "boxShadowFocus",
3723
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3724
- }
3725
- ],
3726
- "tags": {}
3727
- }
3728
- ]
3729
- }
3730
- },
3731
- {
3732
- "name": "SearchThemes",
3733
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts",
3734
- "description": "",
3735
- "declarations": [
3736
- {
3737
- "name": "SearchThemes",
3738
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3739
- }
3740
- ],
3741
- "tags": {
3742
- "deprecated": "⚠️ `SearchThemes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
3743
- },
3744
- "type": {
3745
- "kind": "object",
3746
- "properties": [],
3747
- "indexSignature": {
3748
- "kind": "indexSignature",
3749
- "name": "key",
3750
- "type": {
3751
- "kind": "primitive",
3752
- "value": "string"
3753
- },
3754
- "value": {
3755
- "kind": "symbol",
3756
- "name": "SearchThemeAttributes",
3757
- "value": "SearchThemeAttributes"
3758
- }
3759
- }
3760
- }
3761
- },
3762
- {
3763
- "name": "searchThemes",
3764
- "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts",
3765
- "description": "",
3766
- "declarations": [
3767
- {
3768
- "name": "searchThemes",
3769
- "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/search-form/lib/themes.ts"
3770
- }
3771
- ],
3772
- "tags": {
3773
- "deprecated": "⚠️ `searchThemes` is deprecated and will be removed in a future major version. Please our CSS tokens to theme components."
3774
- },
3775
- "type": {
3776
- "kind": "symbol",
3777
- "name": "SearchThemes",
3778
- "value": "SearchThemes"
3779
- }
3780
- },
3781
1292
  {
3782
1293
  "name": "useSidePanelContainer",
3783
1294
  "fileName": "/home/runner/work/canvas-kit/canvas-kit/modules/labs-react/side-panel/lib/SidePanel.tsx",
@@ -212328,7 +209839,11 @@ export const docs = (typeof window !== 'undefined' && window.__docs) ||
212328
209839
  "filePath": "/home/runner/work/canvas-kit/canvas-kit/modules/preview-react/avatar/lib/Avatar.tsx"
212329
209840
  }
212330
209841
  ],
212331
- "tags": {}
209842
+ "tags": {},
209843
+ "defaultValue": {
209844
+ "kind": "boolean",
209845
+ "value": true
209846
+ }
212332
209847
  },
212333
209848
  {
212334
209849
  "kind": "property",