@govtechsg/sgds-web-component 3.16.1-rc.2 → 3.16.1-rc.3

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