@govtechsg/sgds-web-component 3.21.1 → 3.21.2-rc.1

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 (40) hide show
  1. package/components/Button/index.umd.min.js +5 -3
  2. package/components/Button/index.umd.min.js.map +1 -1
  3. package/components/Button/sgds-button.d.ts +4 -0
  4. package/components/Button/sgds-button.js +8 -0
  5. package/components/Button/sgds-button.js.map +1 -1
  6. package/components/Datepicker/index.umd.min.js +14 -12
  7. package/components/Datepicker/index.umd.min.js.map +1 -1
  8. package/components/FileUpload/index.umd.min.js +4 -2
  9. package/components/FileUpload/index.umd.min.js.map +1 -1
  10. package/components/Pagination/index.umd.min.js +4 -2
  11. package/components/Pagination/index.umd.min.js.map +1 -1
  12. package/components/Tab/index.umd.min.js +1 -1
  13. package/components/Tab/index.umd.min.js.map +1 -1
  14. package/components/Tab/sgds-tab-panel.js +1 -0
  15. package/components/Tab/sgds-tab-panel.js.map +1 -1
  16. package/components/index.umd.min.js +5 -3
  17. package/components/index.umd.min.js.map +1 -1
  18. package/css/fouc.css +1 -1
  19. package/custom-elements.json +643 -607
  20. package/index.umd.min.js +5 -3
  21. package/index.umd.min.js.map +1 -1
  22. package/package.json +1 -1
  23. package/react/components/Button/sgds-button.cjs.js +8 -0
  24. package/react/components/Button/sgds-button.cjs.js.map +1 -1
  25. package/react/components/Button/sgds-button.js +8 -0
  26. package/react/components/Button/sgds-button.js.map +1 -1
  27. package/react/components/Tab/sgds-tab-panel.cjs.js +1 -0
  28. package/react/components/Tab/sgds-tab-panel.cjs.js.map +1 -1
  29. package/react/components/Tab/sgds-tab-panel.js +1 -0
  30. package/react/components/Tab/sgds-tab-panel.js.map +1 -1
  31. package/react/index.cjs.js +6 -6
  32. package/react/index.d.ts +1 -1
  33. package/react/index.js +1 -1
  34. package/react/utils/formSubmitController.cjs.js +5 -0
  35. package/react/utils/formSubmitController.cjs.js.map +1 -1
  36. package/react/utils/formSubmitController.js +5 -0
  37. package/react/utils/formSubmitController.js.map +1 -1
  38. package/types/react.d.ts +92 -88
  39. package/utils/formSubmitController.js +5 -0
  40. package/utils/formSubmitController.js.map +1 -1
@@ -1214,167 +1214,287 @@
1214
1214
  },
1215
1215
  {
1216
1216
  "kind": "javascript-module",
1217
- "path": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
1217
+ "path": "src/components/Button/sgds-button.ts",
1218
1218
  "declarations": [
1219
1219
  {
1220
1220
  "kind": "class",
1221
1221
  "description": "",
1222
- "name": "SgdsBreadcrumbItem",
1222
+ "name": "SgdsButton",
1223
1223
  "slots": [
1224
1224
  {
1225
- "description": "The link of the item. Pass in anchor tags into this slot",
1225
+ "description": "The button's label.",
1226
1226
  "name": "default"
1227
+ },
1228
+ {
1229
+ "description": "The slot for icon to the left of the button text",
1230
+ "name": "leftIcon"
1231
+ },
1232
+ {
1233
+ "description": "The slot for icon to the right of the button text",
1234
+ "name": "rightIcon"
1227
1235
  }
1228
1236
  ],
1229
1237
  "members": [
1230
1238
  {
1231
1239
  "kind": "field",
1232
- "name": "dependencies",
1240
+ "name": "name",
1233
1241
  "type": {
1234
- "text": "Record<string, typeof SgdsElement>"
1242
+ "text": "string"
1235
1243
  },
1236
- "static": true,
1237
- "default": "{\n \"sgds-link\": SgdsLink,\n \"sgds-icon\": SgdsIcon\n }"
1244
+ "description": "The name of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1245
+ "attribute": "name",
1246
+ "reflects": true
1238
1247
  },
1239
1248
  {
1240
1249
  "kind": "field",
1241
- "name": "active",
1250
+ "name": "value",
1251
+ "type": {
1252
+ "text": "string"
1253
+ },
1254
+ "description": "The value of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1255
+ "attribute": "value",
1256
+ "reflects": true
1257
+ },
1258
+ {
1259
+ "kind": "field",
1260
+ "name": "type",
1261
+ "type": {
1262
+ "text": "\"button\" | \"submit\" | \"reset\""
1263
+ },
1264
+ "default": "\"button\"",
1265
+ "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server",
1266
+ "attribute": "type",
1267
+ "reflects": true
1268
+ },
1269
+ {
1270
+ "kind": "field",
1271
+ "name": "form",
1272
+ "type": {
1273
+ "text": "string"
1274
+ },
1275
+ "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1276
+ "attribute": "form",
1277
+ "reflects": true
1278
+ },
1279
+ {
1280
+ "kind": "field",
1281
+ "name": "formAction",
1282
+ "type": {
1283
+ "text": "string"
1284
+ },
1285
+ "description": "Used to override the form owner's `action` attribute.",
1286
+ "attribute": "formaction",
1287
+ "reflects": true
1288
+ },
1289
+ {
1290
+ "kind": "field",
1291
+ "name": "formMethod",
1292
+ "type": {
1293
+ "text": "\"post\" | \"get\""
1294
+ },
1295
+ "description": "Used to override the form owner's `method` attribute.",
1296
+ "attribute": "formmethod",
1297
+ "reflects": true
1298
+ },
1299
+ {
1300
+ "kind": "field",
1301
+ "name": "formNoValidate",
1302
+ "type": {
1303
+ "text": "boolean"
1304
+ },
1305
+ "description": "Used to override the form owner's `novalidate` attribute.",
1306
+ "attribute": "formnovalidate",
1307
+ "reflects": true
1308
+ },
1309
+ {
1310
+ "kind": "field",
1311
+ "name": "formTarget",
1312
+ "type": {
1313
+ "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
1314
+ },
1315
+ "description": "Used to override the form owner's `target` attribute.",
1316
+ "attribute": "formtarget",
1317
+ "reflects": true
1318
+ },
1319
+ {
1320
+ "kind": "field",
1321
+ "name": "fullWidth",
1242
1322
  "type": {
1243
1323
  "text": "boolean"
1244
1324
  },
1245
1325
  "default": "false",
1246
- "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
1247
- "attribute": "active",
1326
+ "description": "When set, the button will be in full width.",
1327
+ "attribute": "fullWidth",
1248
1328
  "reflects": true
1249
1329
  },
1250
1330
  {
1251
1331
  "kind": "field",
1252
- "name": "_preventNavigation",
1332
+ "name": "hasLeftIconSlot",
1333
+ "type": {
1334
+ "text": "boolean"
1335
+ },
1336
+ "default": "false",
1337
+ "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
1338
+ "attribute": "hasLeftIconSlot"
1339
+ },
1340
+ {
1341
+ "kind": "field",
1342
+ "name": "hasRightIconSlot",
1343
+ "type": {
1344
+ "text": "boolean"
1345
+ },
1346
+ "default": "false",
1347
+ "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
1348
+ "attribute": "hasRightIconSlot"
1349
+ },
1350
+ {
1351
+ "kind": "field",
1352
+ "name": "hasSlotController",
1253
1353
  "privacy": "private",
1354
+ "default": "new HasSlotController(this, \"leftIcon\", \"rightIcon\")",
1254
1355
  "type": {}
1255
1356
  },
1256
1357
  {
1257
1358
  "kind": "method",
1258
- "name": "emit",
1359
+ "name": "_handleClick",
1360
+ "privacy": "protected",
1259
1361
  "parameters": [
1260
1362
  {
1261
- "name": "name",
1262
- "type": {
1263
- "text": "string"
1264
- }
1265
- },
1266
- {
1267
- "name": "options",
1268
- "optional": true,
1363
+ "name": "event",
1269
1364
  "type": {
1270
- "text": "CustomEventInit<T>"
1365
+ "text": "MouseEvent"
1271
1366
  }
1272
1367
  }
1273
1368
  ],
1274
- "description": "Emits a custom event with more convenient defaults.",
1275
1369
  "type": {},
1276
1370
  "inheritedFrom": {
1277
- "name": "SgdsElement",
1278
- "module": "src/base/sgds-element.ts"
1371
+ "name": "ButtonElement",
1372
+ "module": "src/base/button-element.ts"
1279
1373
  }
1280
1374
  },
1281
1375
  {
1282
- "kind": "method",
1283
- "name": "define",
1284
- "static": true,
1285
- "parameters": [
1286
- {
1287
- "name": "name",
1288
- "type": {
1289
- "text": "string"
1290
- }
1291
- },
1292
- {
1293
- "name": "elementConstructor",
1294
- "default": "this"
1295
- },
1296
- {
1297
- "name": "options",
1298
- "default": "{}",
1299
- "type": {
1300
- "text": "ElementDefinitionOptions"
1301
- }
1302
- }
1303
- ],
1304
- "type": {},
1376
+ "kind": "field",
1377
+ "name": "_clickHandler",
1378
+ "privacy": "private",
1379
+ "type": {}
1380
+ },
1381
+ {
1382
+ "kind": "field",
1383
+ "name": "variant",
1384
+ "type": {
1385
+ "text": "\"primary\" | \"outline\" | \"ghost\" | \"danger\""
1386
+ },
1387
+ "default": "\"primary\"",
1388
+ "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6",
1389
+ "attribute": "variant",
1390
+ "reflects": true,
1305
1391
  "inheritedFrom": {
1306
- "name": "SgdsElement",
1307
- "module": "src/base/sgds-element.ts"
1392
+ "name": "ButtonElement",
1393
+ "module": "src/base/button-element.ts"
1308
1394
  }
1309
- }
1310
- ],
1311
- "attributes": [
1395
+ },
1396
+ {
1397
+ "kind": "field",
1398
+ "name": "tone",
1399
+ "type": {
1400
+ "text": "\"brand\" | \"danger\" | \"fixed-light\" | \"neutral\""
1401
+ },
1402
+ "default": "\"brand\"",
1403
+ "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
1404
+ "attribute": "tone",
1405
+ "reflects": true,
1406
+ "inheritedFrom": {
1407
+ "name": "ButtonElement",
1408
+ "module": "src/base/button-element.ts"
1409
+ }
1410
+ },
1312
1411
  {
1412
+ "kind": "field",
1413
+ "name": "size",
1414
+ "type": {
1415
+ "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1416
+ },
1417
+ "default": "\"md\"",
1418
+ "description": "Specifies a small, medium or large button, the size is medium by default.",
1419
+ "attribute": "size",
1420
+ "reflects": true,
1421
+ "inheritedFrom": {
1422
+ "name": "ButtonElement",
1423
+ "module": "src/base/button-element.ts"
1424
+ }
1425
+ },
1426
+ {
1427
+ "kind": "field",
1313
1428
  "name": "active",
1314
1429
  "type": {
1315
1430
  "text": "boolean"
1316
1431
  },
1317
1432
  "default": "false",
1318
- "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
1319
- "fieldName": "active"
1320
- }
1321
- ],
1322
- "superclass": {
1323
- "name": "SgdsElement",
1324
- "module": "/src/base/sgds-element"
1325
- },
1326
- "summary": "Breadcrumb Item are navigational links used in Breadcrumb component",
1327
- "tagName": "sgds-breadcrumb-item",
1328
- "customElement": true,
1329
- "modulePath": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
1330
- "cssProperties": [],
1331
- "cssParts": [],
1332
- "cssStates": [],
1333
- "events": []
1334
- }
1335
- ],
1336
- "exports": [
1337
- {
1338
- "kind": "js",
1339
- "name": "SgdsBreadcrumbItem",
1340
- "declaration": {
1341
- "name": "SgdsBreadcrumbItem",
1342
- "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
1343
- }
1344
- },
1345
- {
1346
- "kind": "js",
1347
- "name": "default",
1348
- "declaration": {
1349
- "name": "SgdsBreadcrumbItem",
1350
- "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
1351
- }
1352
- }
1353
- ]
1354
- },
1355
- {
1356
- "kind": "javascript-module",
1357
- "path": "src/components/Breadcrumb/sgds-breadcrumb.ts",
1358
- "declarations": [
1359
- {
1360
- "kind": "class",
1361
- "description": "",
1362
- "name": "SgdsBreadcrumb",
1363
- "slots": [
1433
+ "description": "Manually set the visual state of the button to `:active`",
1434
+ "attribute": "active",
1435
+ "reflects": true,
1436
+ "inheritedFrom": {
1437
+ "name": "ButtonElement",
1438
+ "module": "src/base/button-element.ts"
1439
+ }
1440
+ },
1364
1441
  {
1365
- "description": "The slot to pass in custom elements of `SgdsBreadcrumbItems`.",
1366
- "name": "default"
1367
- }
1368
- ],
1369
- "members": [
1442
+ "kind": "field",
1443
+ "name": "disabled",
1444
+ "type": {
1445
+ "text": "boolean"
1446
+ },
1447
+ "default": "false",
1448
+ "description": "The disabled state of the button",
1449
+ "attribute": "disabled",
1450
+ "reflects": true,
1451
+ "inheritedFrom": {
1452
+ "name": "ButtonElement",
1453
+ "module": "src/base/button-element.ts"
1454
+ }
1455
+ },
1370
1456
  {
1371
1457
  "kind": "field",
1372
- "name": "dependencies",
1458
+ "name": "href",
1373
1459
  "type": {
1374
- "text": "object"
1460
+ "text": "string"
1375
1461
  },
1376
- "static": true,
1377
- "default": "{\n \"sgds-overflow-menu\": SgdsOverflowMenu\n }"
1462
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1463
+ "attribute": "href",
1464
+ "reflects": true,
1465
+ "inheritedFrom": {
1466
+ "name": "ButtonElement",
1467
+ "module": "src/base/button-element.ts"
1468
+ }
1469
+ },
1470
+ {
1471
+ "kind": "field",
1472
+ "name": "target",
1473
+ "type": {
1474
+ "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1475
+ },
1476
+ "default": "\"_self\"",
1477
+ "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1478
+ "attribute": "target",
1479
+ "reflects": true,
1480
+ "inheritedFrom": {
1481
+ "name": "ButtonElement",
1482
+ "module": "src/base/button-element.ts"
1483
+ }
1484
+ },
1485
+ {
1486
+ "kind": "field",
1487
+ "name": "download",
1488
+ "type": {
1489
+ "text": "string"
1490
+ },
1491
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1492
+ "attribute": "download",
1493
+ "reflects": true,
1494
+ "inheritedFrom": {
1495
+ "name": "ButtonElement",
1496
+ "module": "src/base/button-element.ts"
1497
+ }
1378
1498
  },
1379
1499
  {
1380
1500
  "kind": "field",
@@ -1382,38 +1502,152 @@
1382
1502
  "type": {
1383
1503
  "text": "string"
1384
1504
  },
1385
- "default": "\"breadcrumb\"",
1386
- "description": "The aria-label of nav element within breadcrumb component.",
1387
- "attribute": "ariaLabel"
1505
+ "description": "The aria-label attribute to passed to button element when necessary",
1506
+ "attribute": "ariaLabel",
1507
+ "inheritedFrom": {
1508
+ "name": "ButtonElement",
1509
+ "module": "src/base/button-element.ts"
1510
+ }
1511
+ },
1512
+ {
1513
+ "kind": "field",
1514
+ "name": "loading",
1515
+ "type": {
1516
+ "text": "boolean"
1517
+ },
1518
+ "description": "When true, shows a loading spinner",
1519
+ "attribute": "loading",
1520
+ "inheritedFrom": {
1521
+ "name": "ButtonElement",
1522
+ "module": "src/base/button-element.ts"
1523
+ }
1388
1524
  },
1389
1525
  {
1390
1526
  "kind": "method",
1391
- "name": "_replaceExcessItemsWithDropdown",
1392
- "privacy": "private",
1527
+ "name": "focus",
1528
+ "privacy": "public",
1393
1529
  "parameters": [
1394
1530
  {
1395
- "name": "items",
1531
+ "name": "options",
1532
+ "optional": true,
1396
1533
  "type": {
1397
- "text": "SgdsBreadcrumbItem[]"
1534
+ "text": "FocusOptions"
1398
1535
  }
1399
1536
  }
1400
1537
  ],
1401
- "description": "creates `<sgds-breadcrumb-item>\n <sgds-overflow-menu>\n <sgds-dropdown-item></sgds-dropdown-item>\n ...\n </sgds-overflow-menu>\n <sgds-breadcrumb-item>`",
1402
- "type": {}
1538
+ "description": "Sets focus on the button.",
1539
+ "type": {},
1540
+ "inheritedFrom": {
1541
+ "name": "ButtonElement",
1542
+ "module": "src/base/button-element.ts"
1543
+ }
1403
1544
  },
1404
1545
  {
1405
1546
  "kind": "method",
1406
- "name": "_handleSlotChange",
1407
- "privacy": "private",
1547
+ "name": "click",
1548
+ "privacy": "public",
1549
+ "description": "Simulates a click on the button.",
1550
+ "type": {},
1551
+ "inheritedFrom": {
1552
+ "name": "ButtonElement",
1553
+ "module": "src/base/button-element.ts"
1554
+ }
1555
+ },
1556
+ {
1557
+ "kind": "method",
1558
+ "name": "blur",
1559
+ "privacy": "public",
1560
+ "description": "Removes focus from the button.",
1561
+ "type": {},
1562
+ "inheritedFrom": {
1563
+ "name": "ButtonElement",
1564
+ "module": "src/base/button-element.ts"
1565
+ }
1566
+ },
1567
+ {
1568
+ "kind": "method",
1569
+ "name": "_handleBlur",
1570
+ "privacy": "protected",
1571
+ "type": {},
1572
+ "inheritedFrom": {
1573
+ "name": "ButtonElement",
1574
+ "module": "src/base/button-element.ts"
1575
+ }
1576
+ },
1577
+ {
1578
+ "kind": "method",
1579
+ "name": "_handleFocus",
1580
+ "privacy": "protected",
1581
+ "type": {},
1582
+ "inheritedFrom": {
1583
+ "name": "ButtonElement",
1584
+ "module": "src/base/button-element.ts"
1585
+ }
1586
+ },
1587
+ {
1588
+ "kind": "method",
1589
+ "name": "_handleKeydown",
1590
+ "privacy": "protected",
1408
1591
  "parameters": [
1409
1592
  {
1410
- "name": "e",
1593
+ "name": "event",
1411
1594
  "type": {
1412
- "text": "Event"
1595
+ "text": "KeyboardEvent"
1413
1596
  }
1414
1597
  }
1415
1598
  ],
1416
- "type": {}
1599
+ "type": {},
1600
+ "inheritedFrom": {
1601
+ "name": "ButtonElement",
1602
+ "module": "src/base/button-element.ts"
1603
+ }
1604
+ },
1605
+ {
1606
+ "kind": "method",
1607
+ "name": "_assignSpinnerSize",
1608
+ "privacy": "protected",
1609
+ "parameters": [
1610
+ {
1611
+ "name": "buttonSize",
1612
+ "type": {
1613
+ "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1614
+ }
1615
+ }
1616
+ ],
1617
+ "type": {},
1618
+ "inheritedFrom": {
1619
+ "name": "ButtonElement",
1620
+ "module": "src/base/button-element.ts"
1621
+ }
1622
+ },
1623
+ {
1624
+ "kind": "method",
1625
+ "name": "_assignSpinnerTone",
1626
+ "privacy": "protected",
1627
+ "return": {
1628
+ "type": {
1629
+ "text": "SpinnerTone"
1630
+ }
1631
+ },
1632
+ "parameters": [
1633
+ {
1634
+ "name": "buttonTone",
1635
+ "type": {
1636
+ "text": "ButtonTone"
1637
+ }
1638
+ },
1639
+ {
1640
+ "name": "buttonVariant",
1641
+ "type": {
1642
+ "text": "ButtonVariant"
1643
+ }
1644
+ }
1645
+ ],
1646
+ "type": {},
1647
+ "inheritedFrom": {
1648
+ "name": "ButtonElement",
1649
+ "module": "src/base/button-element.ts"
1650
+ }
1417
1651
  },
1418
1652
  {
1419
1653
  "kind": "method",
@@ -1470,466 +1704,472 @@
1470
1704
  }
1471
1705
  }
1472
1706
  ],
1707
+ "events": [
1708
+ {
1709
+ "description": "Emitted when the button is blurred.",
1710
+ "name": "sgds-blur",
1711
+ "reactName": "onSgdsBlur"
1712
+ },
1713
+ {
1714
+ "description": "Emitted when the button is focused.",
1715
+ "name": "sgds-focus",
1716
+ "reactName": "onSgdsFocus"
1717
+ }
1718
+ ],
1473
1719
  "attributes": [
1474
1720
  {
1475
- "name": "ariaLabel",
1721
+ "name": "name",
1476
1722
  "type": {
1477
1723
  "text": "string"
1478
1724
  },
1479
- "default": "\"breadcrumb\"",
1480
- "description": "The aria-label of nav element within breadcrumb component.",
1481
- "fieldName": "ariaLabel"
1482
- }
1483
- ],
1484
- "superclass": {
1485
- "name": "SgdsElement",
1486
- "module": "/src/base/sgds-element"
1487
- },
1488
- "summary": "Breadcrumbs help users to navigate and understand where they are on the current website or service.",
1489
- "tagName": "sgds-breadcrumb",
1490
- "customElement": true,
1491
- "modulePath": "src/components/Breadcrumb/sgds-breadcrumb.ts",
1492
- "cssProperties": [],
1493
- "cssParts": [],
1494
- "cssStates": [],
1495
- "events": []
1496
- }
1497
- ],
1498
- "exports": [
1499
- {
1500
- "kind": "js",
1501
- "name": "SgdsBreadcrumb",
1502
- "declaration": {
1503
- "name": "SgdsBreadcrumb",
1504
- "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
1505
- }
1506
- },
1507
- {
1508
- "kind": "js",
1509
- "name": "default",
1510
- "declaration": {
1511
- "name": "SgdsBreadcrumb",
1512
- "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
1513
- }
1514
- }
1515
- ]
1516
- },
1517
- {
1518
- "kind": "javascript-module",
1519
- "path": "src/components/Button/sgds-button.ts",
1520
- "declarations": [
1521
- {
1522
- "kind": "class",
1523
- "description": "",
1524
- "name": "SgdsButton",
1525
- "slots": [
1526
- {
1527
- "description": "The button's label.",
1528
- "name": "default"
1725
+ "description": "The name of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1726
+ "fieldName": "name"
1529
1727
  },
1530
1728
  {
1531
- "description": "The slot for icon to the left of the button text",
1532
- "name": "leftIcon"
1729
+ "name": "value",
1730
+ "type": {
1731
+ "text": "string"
1732
+ },
1733
+ "description": "The value of the button, submitted as a name/value pair with form data only when this button is the submitter. Only works with `type=\"submit\"`. Has no effect when the button is rendered as a link (i.e. when `href` is set).",
1734
+ "fieldName": "value"
1533
1735
  },
1534
1736
  {
1535
- "description": "The slot for icon to the right of the button text",
1536
- "name": "rightIcon"
1537
- }
1538
- ],
1539
- "members": [
1540
- {
1541
- "kind": "field",
1542
1737
  "name": "type",
1543
1738
  "type": {
1544
1739
  "text": "\"button\" | \"submit\" | \"reset\""
1545
1740
  },
1546
1741
  "default": "\"button\"",
1547
1742
  "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server",
1548
- "attribute": "type",
1549
- "reflects": true
1743
+ "fieldName": "type"
1550
1744
  },
1551
1745
  {
1552
- "kind": "field",
1553
1746
  "name": "form",
1554
1747
  "type": {
1555
1748
  "text": "string"
1556
1749
  },
1557
1750
  "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
1558
- "attribute": "form",
1559
- "reflects": true
1751
+ "fieldName": "form"
1560
1752
  },
1561
1753
  {
1562
- "kind": "field",
1563
- "name": "formAction",
1754
+ "name": "formaction",
1564
1755
  "type": {
1565
1756
  "text": "string"
1566
1757
  },
1567
1758
  "description": "Used to override the form owner's `action` attribute.",
1568
- "attribute": "formaction",
1569
- "reflects": true
1759
+ "fieldName": "formAction"
1570
1760
  },
1571
1761
  {
1572
- "kind": "field",
1573
- "name": "formMethod",
1762
+ "name": "formmethod",
1574
1763
  "type": {
1575
1764
  "text": "\"post\" | \"get\""
1576
1765
  },
1577
1766
  "description": "Used to override the form owner's `method` attribute.",
1578
- "attribute": "formmethod",
1579
- "reflects": true
1767
+ "fieldName": "formMethod"
1580
1768
  },
1581
1769
  {
1582
- "kind": "field",
1583
- "name": "formNoValidate",
1770
+ "name": "formnovalidate",
1584
1771
  "type": {
1585
1772
  "text": "boolean"
1586
1773
  },
1587
1774
  "description": "Used to override the form owner's `novalidate` attribute.",
1588
- "attribute": "formnovalidate",
1589
- "reflects": true
1775
+ "fieldName": "formNoValidate"
1590
1776
  },
1591
1777
  {
1592
- "kind": "field",
1593
- "name": "formTarget",
1778
+ "name": "formtarget",
1594
1779
  "type": {
1595
1780
  "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
1596
1781
  },
1597
1782
  "description": "Used to override the form owner's `target` attribute.",
1598
- "attribute": "formtarget",
1599
- "reflects": true
1783
+ "fieldName": "formTarget"
1600
1784
  },
1601
1785
  {
1602
- "kind": "field",
1603
1786
  "name": "fullWidth",
1604
1787
  "type": {
1605
1788
  "text": "boolean"
1606
1789
  },
1607
1790
  "default": "false",
1608
1791
  "description": "When set, the button will be in full width.",
1609
- "attribute": "fullWidth",
1610
- "reflects": true
1792
+ "fieldName": "fullWidth"
1611
1793
  },
1612
1794
  {
1613
- "kind": "field",
1614
1795
  "name": "hasLeftIconSlot",
1615
1796
  "type": {
1616
1797
  "text": "boolean"
1617
1798
  },
1618
1799
  "default": "false",
1619
1800
  "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
1620
- "attribute": "hasLeftIconSlot"
1801
+ "fieldName": "hasLeftIconSlot"
1621
1802
  },
1622
1803
  {
1623
- "kind": "field",
1624
1804
  "name": "hasRightIconSlot",
1625
1805
  "type": {
1626
1806
  "text": "boolean"
1627
1807
  },
1628
1808
  "default": "false",
1629
1809
  "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
1630
- "attribute": "hasRightIconSlot"
1631
- },
1632
- {
1633
- "kind": "field",
1634
- "name": "hasSlotController",
1635
- "privacy": "private",
1636
- "default": "new HasSlotController(this, \"leftIcon\", \"rightIcon\")",
1637
- "type": {}
1638
- },
1639
- {
1640
- "kind": "method",
1641
- "name": "_handleClick",
1642
- "privacy": "protected",
1643
- "parameters": [
1644
- {
1645
- "name": "event",
1646
- "type": {
1647
- "text": "MouseEvent"
1648
- }
1649
- }
1650
- ],
1651
- "type": {},
1652
- "inheritedFrom": {
1653
- "name": "ButtonElement",
1654
- "module": "src/base/button-element.ts"
1655
- }
1656
- },
1657
- {
1658
- "kind": "field",
1659
- "name": "_clickHandler",
1660
- "privacy": "private",
1661
- "type": {}
1810
+ "fieldName": "hasRightIconSlot"
1662
1811
  },
1663
1812
  {
1664
- "kind": "field",
1665
1813
  "name": "variant",
1666
1814
  "type": {
1667
- "text": "\"primary\" | \"outline\" | \"ghost\" | \"danger\""
1815
+ "text": "ButtonVariant"
1668
1816
  },
1669
1817
  "default": "\"primary\"",
1670
1818
  "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6",
1671
- "attribute": "variant",
1672
- "reflects": true,
1819
+ "fieldName": "variant",
1673
1820
  "inheritedFrom": {
1674
1821
  "name": "ButtonElement",
1675
1822
  "module": "src/base/button-element.ts"
1676
1823
  }
1677
1824
  },
1678
1825
  {
1679
- "kind": "field",
1680
1826
  "name": "tone",
1681
1827
  "type": {
1682
- "text": "\"brand\" | \"danger\" | \"fixed-light\" | \"neutral\""
1828
+ "text": "ButtonTone"
1683
1829
  },
1684
1830
  "default": "\"brand\"",
1685
1831
  "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
1686
- "attribute": "tone",
1687
- "reflects": true,
1832
+ "fieldName": "tone",
1688
1833
  "inheritedFrom": {
1689
1834
  "name": "ButtonElement",
1690
1835
  "module": "src/base/button-element.ts"
1691
1836
  }
1692
1837
  },
1693
1838
  {
1694
- "kind": "field",
1695
1839
  "name": "size",
1696
1840
  "type": {
1697
1841
  "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
1698
1842
  },
1699
1843
  "default": "\"md\"",
1700
1844
  "description": "Specifies a small, medium or large button, the size is medium by default.",
1701
- "attribute": "size",
1702
- "reflects": true,
1845
+ "fieldName": "size",
1703
1846
  "inheritedFrom": {
1704
1847
  "name": "ButtonElement",
1705
1848
  "module": "src/base/button-element.ts"
1706
1849
  }
1707
1850
  },
1708
1851
  {
1709
- "kind": "field",
1710
1852
  "name": "active",
1711
1853
  "type": {
1712
1854
  "text": "boolean"
1713
1855
  },
1714
1856
  "default": "false",
1715
1857
  "description": "Manually set the visual state of the button to `:active`",
1716
- "attribute": "active",
1717
- "reflects": true,
1858
+ "fieldName": "active",
1718
1859
  "inheritedFrom": {
1719
1860
  "name": "ButtonElement",
1720
1861
  "module": "src/base/button-element.ts"
1721
1862
  }
1722
1863
  },
1723
1864
  {
1724
- "kind": "field",
1725
1865
  "name": "disabled",
1726
1866
  "type": {
1727
1867
  "text": "boolean"
1728
1868
  },
1729
1869
  "default": "false",
1730
1870
  "description": "The disabled state of the button",
1731
- "attribute": "disabled",
1732
- "reflects": true,
1733
- "inheritedFrom": {
1734
- "name": "ButtonElement",
1735
- "module": "src/base/button-element.ts"
1736
- }
1737
- },
1738
- {
1739
- "kind": "field",
1740
- "name": "href",
1741
- "type": {
1742
- "text": "string"
1743
- },
1744
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1745
- "attribute": "href",
1746
- "reflects": true,
1747
- "inheritedFrom": {
1748
- "name": "ButtonElement",
1749
- "module": "src/base/button-element.ts"
1750
- }
1751
- },
1752
- {
1753
- "kind": "field",
1754
- "name": "target",
1755
- "type": {
1756
- "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1757
- },
1758
- "default": "\"_self\"",
1759
- "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1760
- "attribute": "target",
1761
- "reflects": true,
1762
- "inheritedFrom": {
1763
- "name": "ButtonElement",
1764
- "module": "src/base/button-element.ts"
1765
- }
1766
- },
1767
- {
1768
- "kind": "field",
1769
- "name": "download",
1770
- "type": {
1771
- "text": "string"
1772
- },
1773
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1774
- "attribute": "download",
1775
- "reflects": true,
1776
- "inheritedFrom": {
1777
- "name": "ButtonElement",
1778
- "module": "src/base/button-element.ts"
1779
- }
1780
- },
1781
- {
1782
- "kind": "field",
1783
- "name": "ariaLabel",
1784
- "type": {
1785
- "text": "string"
1786
- },
1787
- "description": "The aria-label attribute to passed to button element when necessary",
1788
- "attribute": "ariaLabel",
1789
- "inheritedFrom": {
1790
- "name": "ButtonElement",
1791
- "module": "src/base/button-element.ts"
1792
- }
1793
- },
1794
- {
1795
- "kind": "field",
1796
- "name": "loading",
1797
- "type": {
1798
- "text": "boolean"
1799
- },
1800
- "description": "When true, shows a loading spinner",
1801
- "attribute": "loading",
1871
+ "fieldName": "disabled",
1802
1872
  "inheritedFrom": {
1803
1873
  "name": "ButtonElement",
1804
1874
  "module": "src/base/button-element.ts"
1805
1875
  }
1806
1876
  },
1807
1877
  {
1808
- "kind": "method",
1809
- "name": "focus",
1810
- "privacy": "public",
1811
- "parameters": [
1812
- {
1813
- "name": "options",
1814
- "optional": true,
1815
- "type": {
1816
- "text": "FocusOptions"
1817
- }
1818
- }
1819
- ],
1820
- "description": "Sets focus on the button.",
1821
- "type": {},
1878
+ "name": "href",
1879
+ "type": {
1880
+ "text": "string"
1881
+ },
1882
+ "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
1883
+ "fieldName": "href",
1822
1884
  "inheritedFrom": {
1823
1885
  "name": "ButtonElement",
1824
1886
  "module": "src/base/button-element.ts"
1825
1887
  }
1826
1888
  },
1827
1889
  {
1828
- "kind": "method",
1829
- "name": "click",
1830
- "privacy": "public",
1831
- "description": "Simulates a click on the button.",
1832
- "type": {},
1890
+ "name": "target",
1891
+ "type": {
1892
+ "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
1893
+ },
1894
+ "default": "\"_self\"",
1895
+ "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
1896
+ "fieldName": "target",
1833
1897
  "inheritedFrom": {
1834
1898
  "name": "ButtonElement",
1835
1899
  "module": "src/base/button-element.ts"
1836
1900
  }
1837
1901
  },
1838
1902
  {
1839
- "kind": "method",
1840
- "name": "blur",
1841
- "privacy": "public",
1842
- "description": "Removes focus from the button.",
1843
- "type": {},
1903
+ "name": "download",
1904
+ "type": {
1905
+ "text": "string"
1906
+ },
1907
+ "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
1908
+ "fieldName": "download",
1844
1909
  "inheritedFrom": {
1845
1910
  "name": "ButtonElement",
1846
1911
  "module": "src/base/button-element.ts"
1847
1912
  }
1848
1913
  },
1849
1914
  {
1850
- "kind": "method",
1851
- "name": "_handleBlur",
1852
- "privacy": "protected",
1853
- "type": {},
1915
+ "name": "ariaLabel",
1916
+ "type": {
1917
+ "text": "string"
1918
+ },
1919
+ "description": "The aria-label attribute to passed to button element when necessary",
1920
+ "fieldName": "ariaLabel",
1854
1921
  "inheritedFrom": {
1855
1922
  "name": "ButtonElement",
1856
1923
  "module": "src/base/button-element.ts"
1857
1924
  }
1858
1925
  },
1859
1926
  {
1860
- "kind": "method",
1861
- "name": "_handleFocus",
1862
- "privacy": "protected",
1863
- "type": {},
1927
+ "name": "loading",
1928
+ "type": {
1929
+ "text": "boolean"
1930
+ },
1931
+ "description": "When true, shows a loading spinner",
1932
+ "fieldName": "loading",
1864
1933
  "inheritedFrom": {
1865
1934
  "name": "ButtonElement",
1866
1935
  "module": "src/base/button-element.ts"
1867
1936
  }
1937
+ }
1938
+ ],
1939
+ "superclass": {
1940
+ "name": "ButtonElement",
1941
+ "module": "/src/base/button-element"
1942
+ },
1943
+ "summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
1944
+ "tagName": "sgds-button",
1945
+ "customElement": true,
1946
+ "modulePath": "src/components/Button/sgds-button.ts",
1947
+ "cssProperties": [],
1948
+ "cssParts": [],
1949
+ "cssStates": []
1950
+ }
1951
+ ],
1952
+ "exports": [
1953
+ {
1954
+ "kind": "js",
1955
+ "name": "SgdsButton",
1956
+ "declaration": {
1957
+ "name": "SgdsButton",
1958
+ "module": "src/components/Button/sgds-button.ts"
1959
+ }
1960
+ },
1961
+ {
1962
+ "kind": "js",
1963
+ "name": "default",
1964
+ "declaration": {
1965
+ "name": "SgdsButton",
1966
+ "module": "src/components/Button/sgds-button.ts"
1967
+ }
1968
+ }
1969
+ ]
1970
+ },
1971
+ {
1972
+ "kind": "javascript-module",
1973
+ "path": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
1974
+ "declarations": [
1975
+ {
1976
+ "kind": "class",
1977
+ "description": "",
1978
+ "name": "SgdsBreadcrumbItem",
1979
+ "slots": [
1980
+ {
1981
+ "description": "The link of the item. Pass in anchor tags into this slot",
1982
+ "name": "default"
1983
+ }
1984
+ ],
1985
+ "members": [
1986
+ {
1987
+ "kind": "field",
1988
+ "name": "dependencies",
1989
+ "type": {
1990
+ "text": "Record<string, typeof SgdsElement>"
1991
+ },
1992
+ "static": true,
1993
+ "default": "{\n \"sgds-link\": SgdsLink,\n \"sgds-icon\": SgdsIcon\n }"
1994
+ },
1995
+ {
1996
+ "kind": "field",
1997
+ "name": "active",
1998
+ "type": {
1999
+ "text": "boolean"
2000
+ },
2001
+ "default": "false",
2002
+ "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
2003
+ "attribute": "active",
2004
+ "reflects": true
2005
+ },
2006
+ {
2007
+ "kind": "field",
2008
+ "name": "_preventNavigation",
2009
+ "privacy": "private",
2010
+ "type": {}
1868
2011
  },
1869
2012
  {
1870
2013
  "kind": "method",
1871
- "name": "_handleKeydown",
1872
- "privacy": "protected",
2014
+ "name": "emit",
1873
2015
  "parameters": [
1874
2016
  {
1875
- "name": "event",
2017
+ "name": "name",
1876
2018
  "type": {
1877
- "text": "KeyboardEvent"
2019
+ "text": "string"
2020
+ }
2021
+ },
2022
+ {
2023
+ "name": "options",
2024
+ "optional": true,
2025
+ "type": {
2026
+ "text": "CustomEventInit<T>"
1878
2027
  }
1879
2028
  }
1880
2029
  ],
2030
+ "description": "Emits a custom event with more convenient defaults.",
1881
2031
  "type": {},
1882
2032
  "inheritedFrom": {
1883
- "name": "ButtonElement",
1884
- "module": "src/base/button-element.ts"
2033
+ "name": "SgdsElement",
2034
+ "module": "src/base/sgds-element.ts"
1885
2035
  }
1886
2036
  },
1887
2037
  {
1888
2038
  "kind": "method",
1889
- "name": "_assignSpinnerSize",
1890
- "privacy": "protected",
2039
+ "name": "define",
2040
+ "static": true,
1891
2041
  "parameters": [
1892
2042
  {
1893
- "name": "buttonSize",
2043
+ "name": "name",
1894
2044
  "type": {
1895
- "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
2045
+ "text": "string"
2046
+ }
2047
+ },
2048
+ {
2049
+ "name": "elementConstructor",
2050
+ "default": "this"
2051
+ },
2052
+ {
2053
+ "name": "options",
2054
+ "default": "{}",
2055
+ "type": {
2056
+ "text": "ElementDefinitionOptions"
1896
2057
  }
1897
2058
  }
1898
2059
  ],
1899
2060
  "type": {},
1900
2061
  "inheritedFrom": {
1901
- "name": "ButtonElement",
1902
- "module": "src/base/button-element.ts"
2062
+ "name": "SgdsElement",
2063
+ "module": "src/base/sgds-element.ts"
1903
2064
  }
2065
+ }
2066
+ ],
2067
+ "attributes": [
2068
+ {
2069
+ "name": "active",
2070
+ "type": {
2071
+ "text": "boolean"
2072
+ },
2073
+ "default": "false",
2074
+ "description": "Indicates the link matches the current location of the page. Programmatically handled by SgdsBreadcrumb to set this prop to true for the last breadcrumb item",
2075
+ "fieldName": "active"
2076
+ }
2077
+ ],
2078
+ "superclass": {
2079
+ "name": "SgdsElement",
2080
+ "module": "/src/base/sgds-element"
2081
+ },
2082
+ "summary": "Breadcrumb Item are navigational links used in Breadcrumb component",
2083
+ "tagName": "sgds-breadcrumb-item",
2084
+ "customElement": true,
2085
+ "modulePath": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
2086
+ "cssProperties": [],
2087
+ "cssParts": [],
2088
+ "cssStates": [],
2089
+ "events": []
2090
+ }
2091
+ ],
2092
+ "exports": [
2093
+ {
2094
+ "kind": "js",
2095
+ "name": "SgdsBreadcrumbItem",
2096
+ "declaration": {
2097
+ "name": "SgdsBreadcrumbItem",
2098
+ "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
2099
+ }
2100
+ },
2101
+ {
2102
+ "kind": "js",
2103
+ "name": "default",
2104
+ "declaration": {
2105
+ "name": "SgdsBreadcrumbItem",
2106
+ "module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
2107
+ }
2108
+ }
2109
+ ]
2110
+ },
2111
+ {
2112
+ "kind": "javascript-module",
2113
+ "path": "src/components/Breadcrumb/sgds-breadcrumb.ts",
2114
+ "declarations": [
2115
+ {
2116
+ "kind": "class",
2117
+ "description": "",
2118
+ "name": "SgdsBreadcrumb",
2119
+ "slots": [
2120
+ {
2121
+ "description": "The slot to pass in custom elements of `SgdsBreadcrumbItems`.",
2122
+ "name": "default"
2123
+ }
2124
+ ],
2125
+ "members": [
2126
+ {
2127
+ "kind": "field",
2128
+ "name": "dependencies",
2129
+ "type": {
2130
+ "text": "object"
2131
+ },
2132
+ "static": true,
2133
+ "default": "{\n \"sgds-overflow-menu\": SgdsOverflowMenu\n }"
1904
2134
  },
1905
2135
  {
1906
- "kind": "method",
1907
- "name": "_assignSpinnerTone",
1908
- "privacy": "protected",
1909
- "return": {
1910
- "type": {
1911
- "text": "SpinnerTone"
1912
- }
2136
+ "kind": "field",
2137
+ "name": "ariaLabel",
2138
+ "type": {
2139
+ "text": "string"
1913
2140
  },
2141
+ "default": "\"breadcrumb\"",
2142
+ "description": "The aria-label of nav element within breadcrumb component.",
2143
+ "attribute": "ariaLabel"
2144
+ },
2145
+ {
2146
+ "kind": "method",
2147
+ "name": "_replaceExcessItemsWithDropdown",
2148
+ "privacy": "private",
1914
2149
  "parameters": [
1915
2150
  {
1916
- "name": "buttonTone",
2151
+ "name": "items",
1917
2152
  "type": {
1918
- "text": "ButtonTone"
2153
+ "text": "SgdsBreadcrumbItem[]"
1919
2154
  }
1920
- },
2155
+ }
2156
+ ],
2157
+ "description": "creates `<sgds-breadcrumb-item>\n <sgds-overflow-menu>\n <sgds-dropdown-item></sgds-dropdown-item>\n ...\n </sgds-overflow-menu>\n <sgds-breadcrumb-item>`",
2158
+ "type": {}
2159
+ },
2160
+ {
2161
+ "kind": "method",
2162
+ "name": "_handleSlotChange",
2163
+ "privacy": "private",
2164
+ "parameters": [
1921
2165
  {
1922
- "name": "buttonVariant",
2166
+ "name": "e",
1923
2167
  "type": {
1924
- "text": "ButtonVariant"
2168
+ "text": "Event"
1925
2169
  }
1926
2170
  }
1927
2171
  ],
1928
- "type": {},
1929
- "inheritedFrom": {
1930
- "name": "ButtonElement",
1931
- "module": "src/base/button-element.ts"
1932
- }
2172
+ "type": {}
1933
2173
  },
1934
2174
  {
1935
2175
  "kind": "method",
@@ -1986,250 +2226,46 @@
1986
2226
  }
1987
2227
  }
1988
2228
  ],
1989
- "events": [
1990
- {
1991
- "description": "Emitted when the button is blurred.",
1992
- "name": "sgds-blur",
1993
- "reactName": "onSgdsBlur"
1994
- },
1995
- {
1996
- "description": "Emitted when the button is focused.",
1997
- "name": "sgds-focus",
1998
- "reactName": "onSgdsFocus"
1999
- }
2000
- ],
2001
2229
  "attributes": [
2002
- {
2003
- "name": "type",
2004
- "type": {
2005
- "text": "\"button\" | \"submit\" | \"reset\""
2006
- },
2007
- "default": "\"button\"",
2008
- "description": "The behavior of the button with default as `type='button', `reset` resets all the controls to their initial values and `submit` submits the form data to the server",
2009
- "fieldName": "type"
2010
- },
2011
- {
2012
- "name": "form",
2013
- "type": {
2014
- "text": "string"
2015
- },
2016
- "description": "The \"form owner\" to associate the button with. If omitted, the closest containing form will be used instead. The\nvalue of this attribute must be an id of a form in the same document or shadow root as the button.",
2017
- "fieldName": "form"
2018
- },
2019
- {
2020
- "name": "formaction",
2021
- "type": {
2022
- "text": "string"
2023
- },
2024
- "description": "Used to override the form owner's `action` attribute.",
2025
- "fieldName": "formAction"
2026
- },
2027
- {
2028
- "name": "formmethod",
2029
- "type": {
2030
- "text": "\"post\" | \"get\""
2031
- },
2032
- "description": "Used to override the form owner's `method` attribute.",
2033
- "fieldName": "formMethod"
2034
- },
2035
- {
2036
- "name": "formnovalidate",
2037
- "type": {
2038
- "text": "boolean"
2039
- },
2040
- "description": "Used to override the form owner's `novalidate` attribute.",
2041
- "fieldName": "formNoValidate"
2042
- },
2043
- {
2044
- "name": "formtarget",
2045
- "type": {
2046
- "text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
2047
- },
2048
- "description": "Used to override the form owner's `target` attribute.",
2049
- "fieldName": "formTarget"
2050
- },
2051
- {
2052
- "name": "fullWidth",
2053
- "type": {
2054
- "text": "boolean"
2055
- },
2056
- "default": "false",
2057
- "description": "When set, the button will be in full width.",
2058
- "fieldName": "fullWidth"
2059
- },
2060
- {
2061
- "name": "hasLeftIconSlot",
2062
- "type": {
2063
- "text": "boolean"
2064
- },
2065
- "default": "false",
2066
- "description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
2067
- "fieldName": "hasLeftIconSlot"
2068
- },
2069
- {
2070
- "name": "hasRightIconSlot",
2071
- "type": {
2072
- "text": "boolean"
2073
- },
2074
- "default": "false",
2075
- "description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
2076
- "fieldName": "hasRightIconSlot"
2077
- },
2078
- {
2079
- "name": "variant",
2080
- "type": {
2081
- "text": "ButtonVariant"
2082
- },
2083
- "default": "\"primary\"",
2084
- "description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. `danger` is @deprecated since v3.5.6",
2085
- "fieldName": "variant",
2086
- "inheritedFrom": {
2087
- "name": "ButtonElement",
2088
- "module": "src/base/button-element.ts"
2089
- }
2090
- },
2091
- {
2092
- "name": "tone",
2093
- "type": {
2094
- "text": "ButtonTone"
2095
- },
2096
- "default": "\"brand\"",
2097
- "description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
2098
- "fieldName": "tone",
2099
- "inheritedFrom": {
2100
- "name": "ButtonElement",
2101
- "module": "src/base/button-element.ts"
2102
- }
2103
- },
2104
- {
2105
- "name": "size",
2106
- "type": {
2107
- "text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
2108
- },
2109
- "default": "\"md\"",
2110
- "description": "Specifies a small, medium or large button, the size is medium by default.",
2111
- "fieldName": "size",
2112
- "inheritedFrom": {
2113
- "name": "ButtonElement",
2114
- "module": "src/base/button-element.ts"
2115
- }
2116
- },
2117
- {
2118
- "name": "active",
2119
- "type": {
2120
- "text": "boolean"
2121
- },
2122
- "default": "false",
2123
- "description": "Manually set the visual state of the button to `:active`",
2124
- "fieldName": "active",
2125
- "inheritedFrom": {
2126
- "name": "ButtonElement",
2127
- "module": "src/base/button-element.ts"
2128
- }
2129
- },
2130
- {
2131
- "name": "disabled",
2132
- "type": {
2133
- "text": "boolean"
2134
- },
2135
- "default": "false",
2136
- "description": "The disabled state of the button",
2137
- "fieldName": "disabled",
2138
- "inheritedFrom": {
2139
- "name": "ButtonElement",
2140
- "module": "src/base/button-element.ts"
2141
- }
2142
- },
2143
- {
2144
- "name": "href",
2145
- "type": {
2146
- "text": "string"
2147
- },
2148
- "description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
2149
- "fieldName": "href",
2150
- "inheritedFrom": {
2151
- "name": "ButtonElement",
2152
- "module": "src/base/button-element.ts"
2153
- }
2154
- },
2155
- {
2156
- "name": "target",
2157
- "type": {
2158
- "text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
2159
- },
2160
- "default": "\"_self\"",
2161
- "description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
2162
- "fieldName": "target",
2163
- "inheritedFrom": {
2164
- "name": "ButtonElement",
2165
- "module": "src/base/button-element.ts"
2166
- }
2167
- },
2168
- {
2169
- "name": "download",
2170
- "type": {
2171
- "text": "string"
2172
- },
2173
- "description": "Tells the browser to download the linked file as this filename. Only used when `href` is set.",
2174
- "fieldName": "download",
2175
- "inheritedFrom": {
2176
- "name": "ButtonElement",
2177
- "module": "src/base/button-element.ts"
2178
- }
2179
- },
2180
2230
  {
2181
2231
  "name": "ariaLabel",
2182
2232
  "type": {
2183
2233
  "text": "string"
2184
2234
  },
2185
- "description": "The aria-label attribute to passed to button element when necessary",
2186
- "fieldName": "ariaLabel",
2187
- "inheritedFrom": {
2188
- "name": "ButtonElement",
2189
- "module": "src/base/button-element.ts"
2190
- }
2191
- },
2192
- {
2193
- "name": "loading",
2194
- "type": {
2195
- "text": "boolean"
2196
- },
2197
- "description": "When true, shows a loading spinner",
2198
- "fieldName": "loading",
2199
- "inheritedFrom": {
2200
- "name": "ButtonElement",
2201
- "module": "src/base/button-element.ts"
2202
- }
2235
+ "default": "\"breadcrumb\"",
2236
+ "description": "The aria-label of nav element within breadcrumb component.",
2237
+ "fieldName": "ariaLabel"
2203
2238
  }
2204
2239
  ],
2205
2240
  "superclass": {
2206
- "name": "ButtonElement",
2207
- "module": "/src/base/button-element"
2241
+ "name": "SgdsElement",
2242
+ "module": "/src/base/sgds-element"
2208
2243
  },
2209
- "summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
2210
- "tagName": "sgds-button",
2244
+ "summary": "Breadcrumbs help users to navigate and understand where they are on the current website or service.",
2245
+ "tagName": "sgds-breadcrumb",
2211
2246
  "customElement": true,
2212
- "modulePath": "src/components/Button/sgds-button.ts",
2247
+ "modulePath": "src/components/Breadcrumb/sgds-breadcrumb.ts",
2213
2248
  "cssProperties": [],
2214
2249
  "cssParts": [],
2215
- "cssStates": []
2250
+ "cssStates": [],
2251
+ "events": []
2216
2252
  }
2217
2253
  ],
2218
2254
  "exports": [
2219
2255
  {
2220
2256
  "kind": "js",
2221
- "name": "SgdsButton",
2257
+ "name": "SgdsBreadcrumb",
2222
2258
  "declaration": {
2223
- "name": "SgdsButton",
2224
- "module": "src/components/Button/sgds-button.ts"
2259
+ "name": "SgdsBreadcrumb",
2260
+ "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
2225
2261
  }
2226
2262
  },
2227
2263
  {
2228
2264
  "kind": "js",
2229
2265
  "name": "default",
2230
2266
  "declaration": {
2231
- "name": "SgdsButton",
2232
- "module": "src/components/Button/sgds-button.ts"
2267
+ "name": "SgdsBreadcrumb",
2268
+ "module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
2233
2269
  }
2234
2270
  }
2235
2271
  ]
@@ -27502,7 +27538,7 @@
27502
27538
  "package": {
27503
27539
  "name": "@govtechsg/sgds-web-component",
27504
27540
  "description": "",
27505
- "version": "3.21.1",
27541
+ "version": "3.21.2-rc.1",
27506
27542
  "author": "GovTechSG",
27507
27543
  "license": "MIT"
27508
27544
  }