@govtechsg/sgds-web-component 3.23.0-rc.1 → 3.23.0-rc.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/base/select-element.d.ts +4 -0
- package/base/select-element.js +6 -0
- package/base/select-element.js.map +1 -1
- package/components/Checkbox/index.umd.min.js +3 -3
- package/components/Checkbox/index.umd.min.js.map +1 -1
- package/components/Checkbox/sgds-checkbox-group.d.ts +5 -0
- package/components/Checkbox/sgds-checkbox-group.js +10 -0
- package/components/Checkbox/sgds-checkbox-group.js.map +1 -1
- package/components/Checkbox/sgds-checkbox.d.ts +5 -1
- package/components/Checkbox/sgds-checkbox.js +10 -1
- package/components/Checkbox/sgds-checkbox.js.map +1 -1
- package/components/ComboBox/index.umd.min.js +7 -6
- package/components/ComboBox/index.umd.min.js.map +1 -1
- package/components/ComboBox/sgds-combo-box.d.ts +11 -0
- package/components/ComboBox/sgds-combo-box.js +34 -0
- package/components/ComboBox/sgds-combo-box.js.map +1 -1
- package/components/Datepicker/index.umd.min.js +1 -1
- package/components/Datepicker/index.umd.min.js.map +1 -1
- package/components/Drawer/index.umd.min.js +10 -5
- package/components/Drawer/index.umd.min.js.map +1 -1
- package/components/Drawer/sgds-drawer.js +5 -4
- package/components/Drawer/sgds-drawer.js.map +1 -1
- package/components/FileUpload/index.umd.min.js +1 -1
- package/components/FileUpload/index.umd.min.js.map +1 -1
- package/components/Input/index.umd.min.js +1 -1
- package/components/Input/index.umd.min.js.map +1 -1
- package/components/Mainnav/index.umd.min.js +3 -1
- package/components/Mainnav/index.umd.min.js.map +1 -1
- package/components/Mainnav/sgds-mainnav-dropdown.d.ts +4 -0
- package/components/Mainnav/sgds-mainnav-dropdown.js +6 -0
- package/components/Mainnav/sgds-mainnav-dropdown.js.map +1 -1
- package/components/QuantityToggle/index.umd.min.js +1 -1
- package/components/QuantityToggle/index.umd.min.js.map +1 -1
- package/components/Radio/index.umd.min.js +2 -2
- package/components/Radio/index.umd.min.js.map +1 -1
- package/components/Radio/sgds-radio-group.d.ts +4 -0
- package/components/Radio/sgds-radio-group.js +9 -0
- package/components/Radio/sgds-radio-group.js.map +1 -1
- package/components/Select/index.umd.min.js +3 -3
- package/components/Select/index.umd.min.js.map +1 -1
- package/components/Select/sgds-select.d.ts +4 -0
- package/components/Select/sgds-select.js +10 -1
- package/components/Select/sgds-select.js.map +1 -1
- package/components/Textarea/index.umd.min.js +1 -1
- package/components/Textarea/index.umd.min.js.map +1 -1
- package/components/index.umd.min.js +80 -77
- package/components/index.umd.min.js.map +1 -1
- package/css/fouc.css +2 -2
- package/custom-elements.json +1249 -968
- package/index.umd.min.js +83 -80
- package/index.umd.min.js.map +1 -1
- package/package.json +1 -1
- package/react/base/select-element.cjs.js +6 -0
- package/react/base/select-element.cjs.js.map +1 -1
- package/react/base/select-element.js +6 -0
- package/react/base/select-element.js.map +1 -1
- package/react/checkbox/index.cjs.js +3 -1
- package/react/checkbox/index.cjs.js.map +1 -1
- package/react/checkbox/index.js +3 -1
- package/react/checkbox/index.js.map +1 -1
- package/react/checkbox-group/index.cjs.js +3 -1
- package/react/checkbox-group/index.cjs.js.map +1 -1
- package/react/checkbox-group/index.js +3 -1
- package/react/checkbox-group/index.js.map +1 -1
- package/react/combo-box/index.cjs.js +1 -0
- package/react/combo-box/index.cjs.js.map +1 -1
- package/react/combo-box/index.js +1 -0
- package/react/combo-box/index.js.map +1 -1
- package/react/components/Checkbox/sgds-checkbox-group.cjs.js +10 -0
- package/react/components/Checkbox/sgds-checkbox-group.cjs.js.map +1 -1
- package/react/components/Checkbox/sgds-checkbox-group.js +10 -0
- package/react/components/Checkbox/sgds-checkbox-group.js.map +1 -1
- package/react/components/Checkbox/sgds-checkbox.cjs.js +10 -1
- package/react/components/Checkbox/sgds-checkbox.cjs.js.map +1 -1
- package/react/components/Checkbox/sgds-checkbox.js +10 -1
- package/react/components/Checkbox/sgds-checkbox.js.map +1 -1
- package/react/components/ComboBox/sgds-combo-box.cjs.js +34 -0
- package/react/components/ComboBox/sgds-combo-box.cjs.js.map +1 -1
- package/react/components/ComboBox/sgds-combo-box.js +34 -0
- package/react/components/ComboBox/sgds-combo-box.js.map +1 -1
- package/react/components/Drawer/sgds-drawer.cjs.js +4 -3
- package/react/components/Drawer/sgds-drawer.cjs.js.map +1 -1
- package/react/components/Drawer/sgds-drawer.js +5 -4
- package/react/components/Drawer/sgds-drawer.js.map +1 -1
- package/react/components/Mainnav/sgds-mainnav-dropdown.cjs.js +6 -0
- package/react/components/Mainnav/sgds-mainnav-dropdown.cjs.js.map +1 -1
- package/react/components/Mainnav/sgds-mainnav-dropdown.js +6 -0
- package/react/components/Mainnav/sgds-mainnav-dropdown.js.map +1 -1
- package/react/components/Radio/sgds-radio-group.cjs.js +9 -0
- package/react/components/Radio/sgds-radio-group.cjs.js.map +1 -1
- package/react/components/Radio/sgds-radio-group.js +9 -0
- package/react/components/Radio/sgds-radio-group.js.map +1 -1
- package/react/components/Select/sgds-select.cjs.js +9 -0
- package/react/components/Select/sgds-select.cjs.js.map +1 -1
- package/react/components/Select/sgds-select.js +10 -1
- package/react/components/Select/sgds-select.js.map +1 -1
- package/react/index.cjs.js +8 -8
- package/react/index.d.ts +2 -2
- package/react/index.js +2 -2
- package/react/radio-group/index.cjs.js +3 -1
- package/react/radio-group/index.cjs.js.map +1 -1
- package/react/radio-group/index.js +3 -1
- package/react/radio-group/index.js.map +1 -1
- package/react/select/index.cjs.js +2 -0
- package/react/select/index.cjs.js.map +1 -1
- package/react/select/index.js +2 -0
- package/react/select/index.js.map +1 -1
- package/react/utils/validatorMixin.cjs.js +9 -11
- package/react/utils/validatorMixin.cjs.js.map +1 -1
- package/react/utils/validatorMixin.js +9 -11
- package/react/utils/validatorMixin.js.map +1 -1
- package/types/react.d.ts +48 -21
- package/utils/validatorMixin.js +9 -11
- package/utils/validatorMixin.js.map +1 -1
package/custom-elements.json
CHANGED
|
@@ -1214,27 +1214,214 @@
|
|
|
1214
1214
|
},
|
|
1215
1215
|
{
|
|
1216
1216
|
"kind": "javascript-module",
|
|
1217
|
-
"path": "src/components/
|
|
1217
|
+
"path": "src/components/Button/sgds-button.ts",
|
|
1218
1218
|
"declarations": [
|
|
1219
1219
|
{
|
|
1220
1220
|
"kind": "class",
|
|
1221
1221
|
"description": "",
|
|
1222
|
-
"name": "
|
|
1222
|
+
"name": "SgdsButton",
|
|
1223
1223
|
"slots": [
|
|
1224
1224
|
{
|
|
1225
|
-
"description": "The
|
|
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": "
|
|
1240
|
+
"name": "name",
|
|
1233
1241
|
"type": {
|
|
1234
|
-
"text": "
|
|
1242
|
+
"text": "string"
|
|
1235
1243
|
},
|
|
1236
|
-
"
|
|
1237
|
-
"
|
|
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
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"kind": "field",
|
|
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",
|
|
1322
|
+
"type": {
|
|
1323
|
+
"text": "boolean"
|
|
1324
|
+
},
|
|
1325
|
+
"default": "false",
|
|
1326
|
+
"description": "When set, the button will be in full width.",
|
|
1327
|
+
"attribute": "fullWidth",
|
|
1328
|
+
"reflects": true
|
|
1329
|
+
},
|
|
1330
|
+
{
|
|
1331
|
+
"kind": "field",
|
|
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",
|
|
1353
|
+
"privacy": "private",
|
|
1354
|
+
"default": "new HasSlotController(this, \"leftIcon\", \"rightIcon\")",
|
|
1355
|
+
"type": {}
|
|
1356
|
+
},
|
|
1357
|
+
{
|
|
1358
|
+
"kind": "method",
|
|
1359
|
+
"name": "_handleClick",
|
|
1360
|
+
"privacy": "protected",
|
|
1361
|
+
"parameters": [
|
|
1362
|
+
{
|
|
1363
|
+
"name": "event",
|
|
1364
|
+
"type": {
|
|
1365
|
+
"text": "MouseEvent"
|
|
1366
|
+
}
|
|
1367
|
+
}
|
|
1368
|
+
],
|
|
1369
|
+
"type": {},
|
|
1370
|
+
"inheritedFrom": {
|
|
1371
|
+
"name": "ButtonElement",
|
|
1372
|
+
"module": "src/base/button-element.ts"
|
|
1373
|
+
}
|
|
1374
|
+
},
|
|
1375
|
+
{
|
|
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`. The `danger` value is deprecated since v3.5.6 — use `variant=\"primary\"` with `tone=\"danger\"` instead.",
|
|
1389
|
+
"attribute": "variant",
|
|
1390
|
+
"reflects": true,
|
|
1391
|
+
"inheritedFrom": {
|
|
1392
|
+
"name": "ButtonElement",
|
|
1393
|
+
"module": "src/base/button-element.ts"
|
|
1394
|
+
}
|
|
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
|
+
},
|
|
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
|
+
}
|
|
1238
1425
|
},
|
|
1239
1426
|
{
|
|
1240
1427
|
"kind": "field",
|
|
@@ -1243,15 +1430,224 @@
|
|
|
1243
1430
|
"text": "boolean"
|
|
1244
1431
|
},
|
|
1245
1432
|
"default": "false",
|
|
1246
|
-
"description": "
|
|
1433
|
+
"description": "Manually set the visual state of the button to `:active`",
|
|
1247
1434
|
"attribute": "active",
|
|
1248
|
-
"reflects": true
|
|
1435
|
+
"reflects": true,
|
|
1436
|
+
"inheritedFrom": {
|
|
1437
|
+
"name": "ButtonElement",
|
|
1438
|
+
"module": "src/base/button-element.ts"
|
|
1439
|
+
}
|
|
1440
|
+
},
|
|
1441
|
+
{
|
|
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
|
+
},
|
|
1456
|
+
{
|
|
1457
|
+
"kind": "field",
|
|
1458
|
+
"name": "href",
|
|
1459
|
+
"type": {
|
|
1460
|
+
"text": "string"
|
|
1461
|
+
},
|
|
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
|
+
}
|
|
1498
|
+
},
|
|
1499
|
+
{
|
|
1500
|
+
"kind": "field",
|
|
1501
|
+
"name": "ariaLabel",
|
|
1502
|
+
"type": {
|
|
1503
|
+
"text": "string"
|
|
1504
|
+
},
|
|
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
|
+
}
|
|
1524
|
+
},
|
|
1525
|
+
{
|
|
1526
|
+
"kind": "method",
|
|
1527
|
+
"name": "focus",
|
|
1528
|
+
"privacy": "public",
|
|
1529
|
+
"parameters": [
|
|
1530
|
+
{
|
|
1531
|
+
"name": "options",
|
|
1532
|
+
"optional": true,
|
|
1533
|
+
"type": {
|
|
1534
|
+
"text": "FocusOptions"
|
|
1535
|
+
}
|
|
1536
|
+
}
|
|
1537
|
+
],
|
|
1538
|
+
"description": "Sets focus on the button.",
|
|
1539
|
+
"type": {},
|
|
1540
|
+
"inheritedFrom": {
|
|
1541
|
+
"name": "ButtonElement",
|
|
1542
|
+
"module": "src/base/button-element.ts"
|
|
1543
|
+
}
|
|
1544
|
+
},
|
|
1545
|
+
{
|
|
1546
|
+
"kind": "method",
|
|
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",
|
|
1591
|
+
"parameters": [
|
|
1592
|
+
{
|
|
1593
|
+
"name": "event",
|
|
1594
|
+
"type": {
|
|
1595
|
+
"text": "KeyboardEvent"
|
|
1596
|
+
}
|
|
1597
|
+
}
|
|
1598
|
+
],
|
|
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
|
+
}
|
|
1249
1622
|
},
|
|
1250
1623
|
{
|
|
1251
|
-
"kind": "
|
|
1252
|
-
"name": "
|
|
1253
|
-
"privacy": "
|
|
1254
|
-
"
|
|
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
|
+
}
|
|
1255
1651
|
},
|
|
1256
1652
|
{
|
|
1257
1653
|
"kind": "method",
|
|
@@ -1308,436 +1704,442 @@
|
|
|
1308
1704
|
}
|
|
1309
1705
|
}
|
|
1310
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
|
+
],
|
|
1311
1719
|
"attributes": [
|
|
1312
1720
|
{
|
|
1313
|
-
"name": "
|
|
1721
|
+
"name": "name",
|
|
1722
|
+
"type": {
|
|
1723
|
+
"text": "string"
|
|
1724
|
+
},
|
|
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"
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
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"
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"name": "type",
|
|
1738
|
+
"type": {
|
|
1739
|
+
"text": "\"button\" | \"submit\" | \"reset\""
|
|
1740
|
+
},
|
|
1741
|
+
"default": "\"button\"",
|
|
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",
|
|
1743
|
+
"fieldName": "type"
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
"name": "form",
|
|
1747
|
+
"type": {
|
|
1748
|
+
"text": "string"
|
|
1749
|
+
},
|
|
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.",
|
|
1751
|
+
"fieldName": "form"
|
|
1752
|
+
},
|
|
1753
|
+
{
|
|
1754
|
+
"name": "formaction",
|
|
1755
|
+
"type": {
|
|
1756
|
+
"text": "string"
|
|
1757
|
+
},
|
|
1758
|
+
"description": "Used to override the form owner's `action` attribute.",
|
|
1759
|
+
"fieldName": "formAction"
|
|
1760
|
+
},
|
|
1761
|
+
{
|
|
1762
|
+
"name": "formmethod",
|
|
1763
|
+
"type": {
|
|
1764
|
+
"text": "\"post\" | \"get\""
|
|
1765
|
+
},
|
|
1766
|
+
"description": "Used to override the form owner's `method` attribute.",
|
|
1767
|
+
"fieldName": "formMethod"
|
|
1768
|
+
},
|
|
1769
|
+
{
|
|
1770
|
+
"name": "formnovalidate",
|
|
1771
|
+
"type": {
|
|
1772
|
+
"text": "boolean"
|
|
1773
|
+
},
|
|
1774
|
+
"description": "Used to override the form owner's `novalidate` attribute.",
|
|
1775
|
+
"fieldName": "formNoValidate"
|
|
1776
|
+
},
|
|
1777
|
+
{
|
|
1778
|
+
"name": "formtarget",
|
|
1779
|
+
"type": {
|
|
1780
|
+
"text": "| \"_self\"\n | \"_blank\"\n | \"_parent\"\n | \"_top\"\n | string"
|
|
1781
|
+
},
|
|
1782
|
+
"description": "Used to override the form owner's `target` attribute.",
|
|
1783
|
+
"fieldName": "formTarget"
|
|
1784
|
+
},
|
|
1785
|
+
{
|
|
1786
|
+
"name": "fullWidth",
|
|
1314
1787
|
"type": {
|
|
1315
1788
|
"text": "boolean"
|
|
1316
1789
|
},
|
|
1317
1790
|
"default": "false",
|
|
1318
|
-
"description": "
|
|
1319
|
-
"fieldName": "
|
|
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": [
|
|
1791
|
+
"description": "When set, the button will be in full width.",
|
|
1792
|
+
"fieldName": "fullWidth"
|
|
1793
|
+
},
|
|
1364
1794
|
{
|
|
1365
|
-
"
|
|
1366
|
-
"
|
|
1367
|
-
|
|
1368
|
-
|
|
1369
|
-
|
|
1795
|
+
"name": "hasLeftIconSlot",
|
|
1796
|
+
"type": {
|
|
1797
|
+
"text": "boolean"
|
|
1798
|
+
},
|
|
1799
|
+
"default": "false",
|
|
1800
|
+
"description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
|
|
1801
|
+
"fieldName": "hasLeftIconSlot"
|
|
1802
|
+
},
|
|
1370
1803
|
{
|
|
1371
|
-
"
|
|
1372
|
-
"name": "dependencies",
|
|
1804
|
+
"name": "hasRightIconSlot",
|
|
1373
1805
|
"type": {
|
|
1374
|
-
"text": "
|
|
1806
|
+
"text": "boolean"
|
|
1375
1807
|
},
|
|
1376
|
-
"
|
|
1377
|
-
"
|
|
1808
|
+
"default": "false",
|
|
1809
|
+
"description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
|
|
1810
|
+
"fieldName": "hasRightIconSlot"
|
|
1378
1811
|
},
|
|
1379
1812
|
{
|
|
1380
|
-
"
|
|
1381
|
-
"name": "ariaLabel",
|
|
1813
|
+
"name": "variant",
|
|
1382
1814
|
"type": {
|
|
1383
|
-
"text": "
|
|
1815
|
+
"text": "ButtonVariant"
|
|
1384
1816
|
},
|
|
1385
|
-
"default": "\"
|
|
1386
|
-
"description": "The
|
|
1387
|
-
"
|
|
1817
|
+
"default": "\"primary\"",
|
|
1818
|
+
"description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant=\"primary\"` with `tone=\"danger\"` instead.",
|
|
1819
|
+
"fieldName": "variant",
|
|
1820
|
+
"inheritedFrom": {
|
|
1821
|
+
"name": "ButtonElement",
|
|
1822
|
+
"module": "src/base/button-element.ts"
|
|
1823
|
+
}
|
|
1388
1824
|
},
|
|
1389
1825
|
{
|
|
1390
|
-
"
|
|
1391
|
-
"
|
|
1392
|
-
|
|
1393
|
-
|
|
1394
|
-
|
|
1395
|
-
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
|
|
1399
|
-
|
|
1400
|
-
|
|
1401
|
-
|
|
1402
|
-
|
|
1826
|
+
"name": "tone",
|
|
1827
|
+
"type": {
|
|
1828
|
+
"text": "ButtonTone"
|
|
1829
|
+
},
|
|
1830
|
+
"default": "\"brand\"",
|
|
1831
|
+
"description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
|
|
1832
|
+
"fieldName": "tone",
|
|
1833
|
+
"inheritedFrom": {
|
|
1834
|
+
"name": "ButtonElement",
|
|
1835
|
+
"module": "src/base/button-element.ts"
|
|
1836
|
+
}
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
"name": "size",
|
|
1840
|
+
"type": {
|
|
1841
|
+
"text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
|
|
1842
|
+
},
|
|
1843
|
+
"default": "\"md\"",
|
|
1844
|
+
"description": "Specifies a small, medium or large button, the size is medium by default.",
|
|
1845
|
+
"fieldName": "size",
|
|
1846
|
+
"inheritedFrom": {
|
|
1847
|
+
"name": "ButtonElement",
|
|
1848
|
+
"module": "src/base/button-element.ts"
|
|
1849
|
+
}
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
"name": "active",
|
|
1853
|
+
"type": {
|
|
1854
|
+
"text": "boolean"
|
|
1855
|
+
},
|
|
1856
|
+
"default": "false",
|
|
1857
|
+
"description": "Manually set the visual state of the button to `:active`",
|
|
1858
|
+
"fieldName": "active",
|
|
1859
|
+
"inheritedFrom": {
|
|
1860
|
+
"name": "ButtonElement",
|
|
1861
|
+
"module": "src/base/button-element.ts"
|
|
1862
|
+
}
|
|
1863
|
+
},
|
|
1864
|
+
{
|
|
1865
|
+
"name": "disabled",
|
|
1866
|
+
"type": {
|
|
1867
|
+
"text": "boolean"
|
|
1868
|
+
},
|
|
1869
|
+
"default": "false",
|
|
1870
|
+
"description": "The disabled state of the button",
|
|
1871
|
+
"fieldName": "disabled",
|
|
1872
|
+
"inheritedFrom": {
|
|
1873
|
+
"name": "ButtonElement",
|
|
1874
|
+
"module": "src/base/button-element.ts"
|
|
1875
|
+
}
|
|
1403
1876
|
},
|
|
1404
1877
|
{
|
|
1405
|
-
"
|
|
1406
|
-
"
|
|
1407
|
-
|
|
1408
|
-
|
|
1409
|
-
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
],
|
|
1416
|
-
"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",
|
|
1884
|
+
"inheritedFrom": {
|
|
1885
|
+
"name": "ButtonElement",
|
|
1886
|
+
"module": "src/base/button-element.ts"
|
|
1887
|
+
}
|
|
1417
1888
|
},
|
|
1418
1889
|
{
|
|
1419
|
-
"
|
|
1420
|
-
"
|
|
1421
|
-
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1425
|
-
|
|
1426
|
-
}
|
|
1427
|
-
},
|
|
1428
|
-
{
|
|
1429
|
-
"name": "options",
|
|
1430
|
-
"optional": true,
|
|
1431
|
-
"type": {
|
|
1432
|
-
"text": "CustomEventInit<T>"
|
|
1433
|
-
}
|
|
1434
|
-
}
|
|
1435
|
-
],
|
|
1436
|
-
"description": "Emits a custom event with more convenient defaults.",
|
|
1437
|
-
"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",
|
|
1438
1897
|
"inheritedFrom": {
|
|
1439
|
-
"name": "
|
|
1440
|
-
"module": "src/base/
|
|
1898
|
+
"name": "ButtonElement",
|
|
1899
|
+
"module": "src/base/button-element.ts"
|
|
1441
1900
|
}
|
|
1442
1901
|
},
|
|
1443
1902
|
{
|
|
1444
|
-
"
|
|
1445
|
-
"
|
|
1446
|
-
|
|
1447
|
-
|
|
1448
|
-
|
|
1449
|
-
|
|
1450
|
-
"type": {
|
|
1451
|
-
"text": "string"
|
|
1452
|
-
}
|
|
1453
|
-
},
|
|
1454
|
-
{
|
|
1455
|
-
"name": "elementConstructor",
|
|
1456
|
-
"default": "this"
|
|
1457
|
-
},
|
|
1458
|
-
{
|
|
1459
|
-
"name": "options",
|
|
1460
|
-
"default": "{}",
|
|
1461
|
-
"type": {
|
|
1462
|
-
"text": "ElementDefinitionOptions"
|
|
1463
|
-
}
|
|
1464
|
-
}
|
|
1465
|
-
],
|
|
1466
|
-
"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",
|
|
1467
1909
|
"inheritedFrom": {
|
|
1468
|
-
"name": "
|
|
1469
|
-
"module": "src/base/
|
|
1910
|
+
"name": "ButtonElement",
|
|
1911
|
+
"module": "src/base/button-element.ts"
|
|
1470
1912
|
}
|
|
1471
|
-
}
|
|
1472
|
-
],
|
|
1473
|
-
"attributes": [
|
|
1913
|
+
},
|
|
1474
1914
|
{
|
|
1475
1915
|
"name": "ariaLabel",
|
|
1476
1916
|
"type": {
|
|
1477
1917
|
"text": "string"
|
|
1478
1918
|
},
|
|
1479
|
-
"
|
|
1480
|
-
"
|
|
1481
|
-
"
|
|
1919
|
+
"description": "The aria-label attribute to passed to button element when necessary",
|
|
1920
|
+
"fieldName": "ariaLabel",
|
|
1921
|
+
"inheritedFrom": {
|
|
1922
|
+
"name": "ButtonElement",
|
|
1923
|
+
"module": "src/base/button-element.ts"
|
|
1924
|
+
}
|
|
1925
|
+
},
|
|
1926
|
+
{
|
|
1927
|
+
"name": "loading",
|
|
1928
|
+
"type": {
|
|
1929
|
+
"text": "boolean"
|
|
1930
|
+
},
|
|
1931
|
+
"description": "When true, shows a loading spinner",
|
|
1932
|
+
"fieldName": "loading",
|
|
1933
|
+
"inheritedFrom": {
|
|
1934
|
+
"name": "ButtonElement",
|
|
1935
|
+
"module": "src/base/button-element.ts"
|
|
1936
|
+
}
|
|
1482
1937
|
}
|
|
1483
1938
|
],
|
|
1484
1939
|
"superclass": {
|
|
1485
|
-
"name": "
|
|
1486
|
-
"module": "/src/base/
|
|
1940
|
+
"name": "ButtonElement",
|
|
1941
|
+
"module": "/src/base/button-element"
|
|
1487
1942
|
},
|
|
1488
|
-
"summary": "
|
|
1489
|
-
"tagName": "sgds-
|
|
1943
|
+
"summary": "Custom button styles for actions in forms, dialogs, and more with support for multiple sizes, states, and more.",
|
|
1944
|
+
"tagName": "sgds-button",
|
|
1490
1945
|
"customElement": true,
|
|
1491
|
-
"modulePath": "src/components/
|
|
1946
|
+
"modulePath": "src/components/Button/sgds-button.ts",
|
|
1492
1947
|
"cssProperties": [],
|
|
1493
1948
|
"cssParts": [],
|
|
1494
|
-
"cssStates": []
|
|
1495
|
-
"events": []
|
|
1949
|
+
"cssStates": []
|
|
1496
1950
|
}
|
|
1497
1951
|
],
|
|
1498
1952
|
"exports": [
|
|
1499
1953
|
{
|
|
1500
1954
|
"kind": "js",
|
|
1501
|
-
"name": "
|
|
1955
|
+
"name": "SgdsButton",
|
|
1502
1956
|
"declaration": {
|
|
1503
|
-
"name": "
|
|
1504
|
-
"module": "src/components/
|
|
1957
|
+
"name": "SgdsButton",
|
|
1958
|
+
"module": "src/components/Button/sgds-button.ts"
|
|
1505
1959
|
}
|
|
1506
1960
|
},
|
|
1507
1961
|
{
|
|
1508
1962
|
"kind": "js",
|
|
1509
1963
|
"name": "default",
|
|
1510
1964
|
"declaration": {
|
|
1511
|
-
"name": "
|
|
1512
|
-
"module": "src/components/
|
|
1965
|
+
"name": "SgdsButton",
|
|
1966
|
+
"module": "src/components/Button/sgds-button.ts"
|
|
1513
1967
|
}
|
|
1514
1968
|
}
|
|
1515
1969
|
]
|
|
1516
1970
|
},
|
|
1517
1971
|
{
|
|
1518
1972
|
"kind": "javascript-module",
|
|
1519
|
-
"path": "src/components/
|
|
1973
|
+
"path": "src/components/Card/sgds-card.ts",
|
|
1520
1974
|
"declarations": [
|
|
1521
1975
|
{
|
|
1522
1976
|
"kind": "class",
|
|
1523
1977
|
"description": "",
|
|
1524
|
-
"name": "
|
|
1978
|
+
"name": "SgdsCard",
|
|
1525
1979
|
"slots": [
|
|
1526
1980
|
{
|
|
1527
|
-
"description": "The
|
|
1981
|
+
"description": "The content area of the card, placed directly under the title. Accepts any HTML or custom elements.",
|
|
1528
1982
|
"name": "default"
|
|
1529
1983
|
},
|
|
1530
1984
|
{
|
|
1531
|
-
"description": "
|
|
1532
|
-
"name": "
|
|
1985
|
+
"description": "Accepts an element for an overflow or contextual menu, positioned at the top-right corner of the card. Typically used for action menus or dropdowns.",
|
|
1986
|
+
"name": "menu"
|
|
1533
1987
|
},
|
|
1534
1988
|
{
|
|
1535
|
-
"description": "
|
|
1536
|
-
"name": "
|
|
1537
|
-
}
|
|
1538
|
-
],
|
|
1539
|
-
"members": [
|
|
1989
|
+
"description": "Accepts an element to be displayed above the card content. When used, it overrides image and icon slot content.",
|
|
1990
|
+
"name": "upper"
|
|
1991
|
+
},
|
|
1540
1992
|
{
|
|
1541
|
-
"
|
|
1542
|
-
"name": "
|
|
1543
|
-
"type": {
|
|
1544
|
-
"text": "string"
|
|
1545
|
-
},
|
|
1546
|
-
"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).",
|
|
1547
|
-
"attribute": "name",
|
|
1548
|
-
"reflects": true
|
|
1993
|
+
"description": "Accepts an image or svg element of the card. Only a single element is allowed to be passed in.",
|
|
1994
|
+
"name": "image"
|
|
1549
1995
|
},
|
|
1550
1996
|
{
|
|
1551
|
-
"
|
|
1552
|
-
"name": "
|
|
1553
|
-
|
|
1554
|
-
|
|
1555
|
-
|
|
1556
|
-
"
|
|
1557
|
-
|
|
1558
|
-
|
|
1997
|
+
"description": "Accepts an icon element to visually represent the card. Only a single element is allowed to be passed in.",
|
|
1998
|
+
"name": "icon"
|
|
1999
|
+
},
|
|
2000
|
+
{
|
|
2001
|
+
"description": "The subtitle of the card",
|
|
2002
|
+
"name": "subtitle"
|
|
2003
|
+
},
|
|
2004
|
+
{
|
|
2005
|
+
"description": "The title of the card",
|
|
2006
|
+
"name": "title"
|
|
2007
|
+
},
|
|
2008
|
+
{
|
|
2009
|
+
"description": "The paragrapher text of the card",
|
|
2010
|
+
"name": "description"
|
|
2011
|
+
},
|
|
2012
|
+
{
|
|
2013
|
+
"description": "Accepts any additional content to be displayed below the card description, such as badges, metadata, or supplementary information.",
|
|
2014
|
+
"name": "lower"
|
|
2015
|
+
},
|
|
2016
|
+
{
|
|
2017
|
+
"description": "Footer area of the card. Accepts links, actions, or any custom content.",
|
|
2018
|
+
"name": "footer"
|
|
1559
2019
|
},
|
|
2020
|
+
{
|
|
2021
|
+
"description": "(@deprecated) Deprecated since 3.3.2 in favour of `footer` slot. Legacy slot for anchor elements. Use `footer` instead.",
|
|
2022
|
+
"name": "link"
|
|
2023
|
+
}
|
|
2024
|
+
],
|
|
2025
|
+
"members": [
|
|
1560
2026
|
{
|
|
1561
2027
|
"kind": "field",
|
|
1562
|
-
"name": "
|
|
2028
|
+
"name": "footerNode",
|
|
1563
2029
|
"type": {
|
|
1564
|
-
"text": "
|
|
2030
|
+
"text": "HTMLElement[]"
|
|
1565
2031
|
},
|
|
1566
|
-
"
|
|
1567
|
-
"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",
|
|
1568
|
-
"attribute": "type",
|
|
1569
|
-
"reflects": true
|
|
2032
|
+
"privacy": "private"
|
|
1570
2033
|
},
|
|
1571
2034
|
{
|
|
1572
2035
|
"kind": "field",
|
|
1573
|
-
"name": "
|
|
2036
|
+
"name": "linkNode",
|
|
1574
2037
|
"type": {
|
|
1575
|
-
"text": "
|
|
2038
|
+
"text": "HTMLAnchorElement[] | SgdsLink[]"
|
|
1576
2039
|
},
|
|
1577
|
-
"
|
|
1578
|
-
"attribute": "form",
|
|
1579
|
-
"reflects": true
|
|
2040
|
+
"privacy": "private"
|
|
1580
2041
|
},
|
|
1581
2042
|
{
|
|
1582
2043
|
"kind": "field",
|
|
1583
|
-
"name": "
|
|
2044
|
+
"name": "imagePosition",
|
|
1584
2045
|
"type": {
|
|
1585
|
-
"text": "
|
|
2046
|
+
"text": "CardImagePosition"
|
|
1586
2047
|
},
|
|
1587
|
-
"
|
|
1588
|
-
"
|
|
2048
|
+
"default": "\"before\"",
|
|
2049
|
+
"description": "Sets the image position of the card. Available options: `before`, `after`",
|
|
2050
|
+
"attribute": "imagePosition",
|
|
1589
2051
|
"reflects": true
|
|
1590
2052
|
},
|
|
1591
2053
|
{
|
|
1592
2054
|
"kind": "field",
|
|
1593
|
-
"name": "
|
|
2055
|
+
"name": "imageAdjustment",
|
|
1594
2056
|
"type": {
|
|
1595
|
-
"text": "
|
|
2057
|
+
"text": "CardImageAdjustment"
|
|
1596
2058
|
},
|
|
1597
|
-
"
|
|
1598
|
-
"
|
|
2059
|
+
"default": "\"default\"",
|
|
2060
|
+
"description": "Controls how the image is sized and aligned within the card. Available options: `default`, `padding around`, `aspect ratio`",
|
|
2061
|
+
"attribute": "imageAdjustment",
|
|
1599
2062
|
"reflects": true
|
|
1600
2063
|
},
|
|
1601
2064
|
{
|
|
1602
2065
|
"kind": "field",
|
|
1603
|
-
"name": "
|
|
2066
|
+
"name": "hasImageSlot",
|
|
1604
2067
|
"type": {
|
|
1605
2068
|
"text": "boolean"
|
|
1606
2069
|
},
|
|
1607
|
-
"
|
|
1608
|
-
"
|
|
1609
|
-
"
|
|
2070
|
+
"default": "false",
|
|
2071
|
+
"description": "Used only for SSR to indicate the presence of the `image` slot.",
|
|
2072
|
+
"attribute": "hasImageSlot"
|
|
1610
2073
|
},
|
|
1611
2074
|
{
|
|
1612
2075
|
"kind": "field",
|
|
1613
|
-
"name": "
|
|
2076
|
+
"name": "hasIconSlot",
|
|
1614
2077
|
"type": {
|
|
1615
|
-
"text": "
|
|
1616
|
-
},
|
|
1617
|
-
"
|
|
1618
|
-
"
|
|
1619
|
-
"
|
|
2078
|
+
"text": "boolean"
|
|
2079
|
+
},
|
|
2080
|
+
"default": "false",
|
|
2081
|
+
"description": "Used only for SSR to indicate the presence of the `icon` slot.",
|
|
2082
|
+
"attribute": "hasIconSlot"
|
|
1620
2083
|
},
|
|
1621
2084
|
{
|
|
1622
2085
|
"kind": "field",
|
|
1623
|
-
"name": "
|
|
2086
|
+
"name": "hasUpperSlot",
|
|
1624
2087
|
"type": {
|
|
1625
2088
|
"text": "boolean"
|
|
1626
2089
|
},
|
|
1627
2090
|
"default": "false",
|
|
1628
|
-
"description": "
|
|
1629
|
-
"attribute": "
|
|
1630
|
-
"reflects": true
|
|
2091
|
+
"description": "Used only for SSR to indicate the presence of the `upper` slot.",
|
|
2092
|
+
"attribute": "hasUpperSlot"
|
|
1631
2093
|
},
|
|
1632
2094
|
{
|
|
1633
2095
|
"kind": "field",
|
|
1634
|
-
"name": "
|
|
2096
|
+
"name": "linkSlotItems",
|
|
1635
2097
|
"type": {
|
|
1636
|
-
"text": "
|
|
2098
|
+
"text": "HTMLAnchorElement | null"
|
|
1637
2099
|
},
|
|
1638
|
-
"
|
|
1639
|
-
"description": "Used only for SSR to indicate the presence of the `leftIcon` slot.",
|
|
1640
|
-
"attribute": "hasLeftIconSlot"
|
|
2100
|
+
"privacy": "private"
|
|
1641
2101
|
},
|
|
1642
2102
|
{
|
|
1643
2103
|
"kind": "field",
|
|
1644
|
-
"name": "
|
|
2104
|
+
"name": "footerSlotItems",
|
|
1645
2105
|
"type": {
|
|
1646
|
-
"text": "
|
|
2106
|
+
"text": "HTMLAnchorElement | null"
|
|
1647
2107
|
},
|
|
1648
|
-
"
|
|
1649
|
-
"description": "Used only for SSR to indicate the presence of the `rightIcon` slot.",
|
|
1650
|
-
"attribute": "hasRightIconSlot"
|
|
2108
|
+
"privacy": "private"
|
|
1651
2109
|
},
|
|
1652
2110
|
{
|
|
1653
2111
|
"kind": "field",
|
|
1654
2112
|
"name": "hasSlotController",
|
|
1655
2113
|
"privacy": "private",
|
|
1656
|
-
"default": "new HasSlotController(this, \"
|
|
2114
|
+
"default": "new HasSlotController(this, \"image\", \"icon\", \"upper\")",
|
|
1657
2115
|
"type": {}
|
|
1658
2116
|
},
|
|
1659
2117
|
{
|
|
1660
2118
|
"kind": "method",
|
|
1661
|
-
"name": "
|
|
1662
|
-
"privacy": "protected",
|
|
2119
|
+
"name": "handleImgSlotChange",
|
|
1663
2120
|
"parameters": [
|
|
1664
2121
|
{
|
|
1665
|
-
"name": "
|
|
2122
|
+
"name": "e",
|
|
1666
2123
|
"type": {
|
|
1667
|
-
"text": "
|
|
2124
|
+
"text": "Event"
|
|
1668
2125
|
}
|
|
1669
2126
|
}
|
|
1670
2127
|
],
|
|
1671
|
-
"type": {},
|
|
1672
|
-
"inheritedFrom": {
|
|
1673
|
-
"name": "ButtonElement",
|
|
1674
|
-
"module": "src/base/button-element.ts"
|
|
1675
|
-
}
|
|
1676
|
-
},
|
|
1677
|
-
{
|
|
1678
|
-
"kind": "field",
|
|
1679
|
-
"name": "_clickHandler",
|
|
1680
|
-
"privacy": "private",
|
|
1681
2128
|
"type": {}
|
|
1682
2129
|
},
|
|
1683
2130
|
{
|
|
1684
2131
|
"kind": "field",
|
|
1685
|
-
"name": "
|
|
1686
|
-
"type": {
|
|
1687
|
-
"text": "\"primary\" | \"outline\" | \"ghost\" | \"danger\""
|
|
1688
|
-
},
|
|
1689
|
-
"default": "\"primary\"",
|
|
1690
|
-
"description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant=\"primary\"` with `tone=\"danger\"` instead.",
|
|
1691
|
-
"attribute": "variant",
|
|
1692
|
-
"reflects": true,
|
|
1693
|
-
"inheritedFrom": {
|
|
1694
|
-
"name": "ButtonElement",
|
|
1695
|
-
"module": "src/base/button-element.ts"
|
|
1696
|
-
}
|
|
1697
|
-
},
|
|
1698
|
-
{
|
|
1699
|
-
"kind": "field",
|
|
1700
|
-
"name": "tone",
|
|
1701
|
-
"type": {
|
|
1702
|
-
"text": "\"brand\" | \"danger\" | \"fixed-light\" | \"neutral\""
|
|
1703
|
-
},
|
|
1704
|
-
"default": "\"brand\"",
|
|
1705
|
-
"description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
|
|
1706
|
-
"attribute": "tone",
|
|
1707
|
-
"reflects": true,
|
|
1708
|
-
"inheritedFrom": {
|
|
1709
|
-
"name": "ButtonElement",
|
|
1710
|
-
"module": "src/base/button-element.ts"
|
|
1711
|
-
}
|
|
1712
|
-
},
|
|
1713
|
-
{
|
|
1714
|
-
"kind": "field",
|
|
1715
|
-
"name": "size",
|
|
1716
|
-
"type": {
|
|
1717
|
-
"text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
|
|
1718
|
-
},
|
|
1719
|
-
"default": "\"md\"",
|
|
1720
|
-
"description": "Specifies a small, medium or large button, the size is medium by default.",
|
|
1721
|
-
"attribute": "size",
|
|
1722
|
-
"reflects": true,
|
|
1723
|
-
"inheritedFrom": {
|
|
1724
|
-
"name": "ButtonElement",
|
|
1725
|
-
"module": "src/base/button-element.ts"
|
|
1726
|
-
}
|
|
1727
|
-
},
|
|
1728
|
-
{
|
|
1729
|
-
"kind": "field",
|
|
1730
|
-
"name": "active",
|
|
2132
|
+
"name": "stretchedLink",
|
|
1731
2133
|
"type": {
|
|
1732
2134
|
"text": "boolean"
|
|
1733
2135
|
},
|
|
1734
2136
|
"default": "false",
|
|
1735
|
-
"description": "
|
|
1736
|
-
"attribute": "
|
|
2137
|
+
"description": "Extends the link passed in either `footer` or `link`(deprecated) slot.",
|
|
2138
|
+
"attribute": "stretchedLink",
|
|
1737
2139
|
"reflects": true,
|
|
1738
2140
|
"inheritedFrom": {
|
|
1739
|
-
"name": "
|
|
1740
|
-
"module": "src/base/
|
|
2141
|
+
"name": "CardElement",
|
|
2142
|
+
"module": "src/base/card-element.ts"
|
|
1741
2143
|
}
|
|
1742
2144
|
},
|
|
1743
2145
|
{
|
|
@@ -1747,208 +2149,109 @@
|
|
|
1747
2149
|
"text": "boolean"
|
|
1748
2150
|
},
|
|
1749
2151
|
"default": "false",
|
|
1750
|
-
"description": "
|
|
2152
|
+
"description": "Disables the card",
|
|
1751
2153
|
"attribute": "disabled",
|
|
1752
2154
|
"reflects": true,
|
|
1753
2155
|
"inheritedFrom": {
|
|
1754
|
-
"name": "
|
|
1755
|
-
"module": "src/base/
|
|
2156
|
+
"name": "CardElement",
|
|
2157
|
+
"module": "src/base/card-element.ts"
|
|
1756
2158
|
}
|
|
1757
2159
|
},
|
|
1758
2160
|
{
|
|
1759
2161
|
"kind": "field",
|
|
1760
|
-
"name": "
|
|
2162
|
+
"name": "hideBorder",
|
|
1761
2163
|
"type": {
|
|
1762
|
-
"text": "
|
|
2164
|
+
"text": "boolean"
|
|
1763
2165
|
},
|
|
1764
|
-
"
|
|
1765
|
-
"
|
|
2166
|
+
"default": "false",
|
|
2167
|
+
"description": "When true, hides the default border of the card.",
|
|
2168
|
+
"attribute": "hideBorder",
|
|
1766
2169
|
"reflects": true,
|
|
1767
2170
|
"inheritedFrom": {
|
|
1768
|
-
"name": "
|
|
1769
|
-
"module": "src/base/
|
|
2171
|
+
"name": "CardElement",
|
|
2172
|
+
"module": "src/base/card-element.ts"
|
|
1770
2173
|
}
|
|
1771
2174
|
},
|
|
1772
2175
|
{
|
|
1773
2176
|
"kind": "field",
|
|
1774
|
-
"name": "
|
|
2177
|
+
"name": "tinted",
|
|
1775
2178
|
"type": {
|
|
1776
|
-
"text": "
|
|
2179
|
+
"text": "boolean"
|
|
1777
2180
|
},
|
|
1778
|
-
"default": "
|
|
1779
|
-
"description": "
|
|
1780
|
-
"attribute": "
|
|
2181
|
+
"default": "false",
|
|
2182
|
+
"description": "When true, applies a tinted background color to the card.",
|
|
2183
|
+
"attribute": "tinted",
|
|
1781
2184
|
"reflects": true,
|
|
1782
2185
|
"inheritedFrom": {
|
|
1783
|
-
"name": "
|
|
1784
|
-
"module": "src/base/
|
|
2186
|
+
"name": "CardElement",
|
|
2187
|
+
"module": "src/base/card-element.ts"
|
|
1785
2188
|
}
|
|
1786
2189
|
},
|
|
1787
2190
|
{
|
|
1788
2191
|
"kind": "field",
|
|
1789
|
-
"name": "
|
|
2192
|
+
"name": "orientation",
|
|
1790
2193
|
"type": {
|
|
1791
|
-
"text": "
|
|
2194
|
+
"text": "CardOrientation"
|
|
1792
2195
|
},
|
|
1793
|
-
"
|
|
1794
|
-
"
|
|
2196
|
+
"default": "\"vertical\"",
|
|
2197
|
+
"description": "Sets the orientation of the card. Available options: `vertical`, `horizontal`",
|
|
2198
|
+
"attribute": "orientation",
|
|
1795
2199
|
"reflects": true,
|
|
1796
2200
|
"inheritedFrom": {
|
|
1797
|
-
"name": "
|
|
1798
|
-
"module": "src/base/
|
|
1799
|
-
}
|
|
1800
|
-
},
|
|
1801
|
-
{
|
|
1802
|
-
"kind": "field",
|
|
1803
|
-
"name": "ariaLabel",
|
|
1804
|
-
"type": {
|
|
1805
|
-
"text": "string"
|
|
1806
|
-
},
|
|
1807
|
-
"description": "The aria-label attribute to passed to button element when necessary",
|
|
1808
|
-
"attribute": "ariaLabel",
|
|
1809
|
-
"inheritedFrom": {
|
|
1810
|
-
"name": "ButtonElement",
|
|
1811
|
-
"module": "src/base/button-element.ts"
|
|
1812
|
-
}
|
|
1813
|
-
},
|
|
1814
|
-
{
|
|
1815
|
-
"kind": "field",
|
|
1816
|
-
"name": "loading",
|
|
1817
|
-
"type": {
|
|
1818
|
-
"text": "boolean"
|
|
1819
|
-
},
|
|
1820
|
-
"description": "When true, shows a loading spinner",
|
|
1821
|
-
"attribute": "loading",
|
|
1822
|
-
"inheritedFrom": {
|
|
1823
|
-
"name": "ButtonElement",
|
|
1824
|
-
"module": "src/base/button-element.ts"
|
|
1825
|
-
}
|
|
1826
|
-
},
|
|
1827
|
-
{
|
|
1828
|
-
"kind": "method",
|
|
1829
|
-
"name": "focus",
|
|
1830
|
-
"privacy": "public",
|
|
1831
|
-
"parameters": [
|
|
1832
|
-
{
|
|
1833
|
-
"name": "options",
|
|
1834
|
-
"optional": true,
|
|
1835
|
-
"type": {
|
|
1836
|
-
"text": "FocusOptions"
|
|
1837
|
-
}
|
|
1838
|
-
}
|
|
1839
|
-
],
|
|
1840
|
-
"description": "Sets focus on the button.",
|
|
1841
|
-
"type": {},
|
|
1842
|
-
"inheritedFrom": {
|
|
1843
|
-
"name": "ButtonElement",
|
|
1844
|
-
"module": "src/base/button-element.ts"
|
|
1845
|
-
}
|
|
1846
|
-
},
|
|
1847
|
-
{
|
|
1848
|
-
"kind": "method",
|
|
1849
|
-
"name": "click",
|
|
1850
|
-
"privacy": "public",
|
|
1851
|
-
"description": "Simulates a click on the button.",
|
|
1852
|
-
"type": {},
|
|
1853
|
-
"inheritedFrom": {
|
|
1854
|
-
"name": "ButtonElement",
|
|
1855
|
-
"module": "src/base/button-element.ts"
|
|
1856
|
-
}
|
|
1857
|
-
},
|
|
1858
|
-
{
|
|
1859
|
-
"kind": "method",
|
|
1860
|
-
"name": "blur",
|
|
1861
|
-
"privacy": "public",
|
|
1862
|
-
"description": "Removes focus from the button.",
|
|
1863
|
-
"type": {},
|
|
1864
|
-
"inheritedFrom": {
|
|
1865
|
-
"name": "ButtonElement",
|
|
1866
|
-
"module": "src/base/button-element.ts"
|
|
1867
|
-
}
|
|
1868
|
-
},
|
|
1869
|
-
{
|
|
1870
|
-
"kind": "method",
|
|
1871
|
-
"name": "_handleBlur",
|
|
1872
|
-
"privacy": "protected",
|
|
1873
|
-
"type": {},
|
|
1874
|
-
"inheritedFrom": {
|
|
1875
|
-
"name": "ButtonElement",
|
|
1876
|
-
"module": "src/base/button-element.ts"
|
|
1877
|
-
}
|
|
1878
|
-
},
|
|
1879
|
-
{
|
|
1880
|
-
"kind": "method",
|
|
1881
|
-
"name": "_handleFocus",
|
|
1882
|
-
"privacy": "protected",
|
|
1883
|
-
"type": {},
|
|
1884
|
-
"inheritedFrom": {
|
|
1885
|
-
"name": "ButtonElement",
|
|
1886
|
-
"module": "src/base/button-element.ts"
|
|
2201
|
+
"name": "CardElement",
|
|
2202
|
+
"module": "src/base/card-element.ts"
|
|
1887
2203
|
}
|
|
1888
2204
|
},
|
|
1889
2205
|
{
|
|
1890
2206
|
"kind": "method",
|
|
1891
|
-
"name": "
|
|
1892
|
-
"privacy": "protected",
|
|
2207
|
+
"name": "handleTitleSlotChange",
|
|
1893
2208
|
"parameters": [
|
|
1894
2209
|
{
|
|
1895
|
-
"name": "
|
|
2210
|
+
"name": "e",
|
|
1896
2211
|
"type": {
|
|
1897
|
-
"text": "
|
|
2212
|
+
"text": "Event"
|
|
1898
2213
|
}
|
|
1899
2214
|
}
|
|
1900
2215
|
],
|
|
1901
2216
|
"type": {},
|
|
1902
2217
|
"inheritedFrom": {
|
|
1903
|
-
"name": "
|
|
1904
|
-
"module": "src/base/
|
|
2218
|
+
"name": "CardElement",
|
|
2219
|
+
"module": "src/base/card-element.ts"
|
|
1905
2220
|
}
|
|
1906
2221
|
},
|
|
1907
2222
|
{
|
|
1908
2223
|
"kind": "method",
|
|
1909
|
-
"name": "
|
|
2224
|
+
"name": "_forwardAnchorAttributes",
|
|
1910
2225
|
"privacy": "protected",
|
|
1911
2226
|
"parameters": [
|
|
1912
2227
|
{
|
|
1913
|
-
"name": "
|
|
2228
|
+
"name": "anchor",
|
|
1914
2229
|
"type": {
|
|
1915
|
-
"text": "
|
|
2230
|
+
"text": "HTMLAnchorElement | null"
|
|
1916
2231
|
}
|
|
1917
2232
|
}
|
|
1918
2233
|
],
|
|
1919
2234
|
"type": {},
|
|
1920
2235
|
"inheritedFrom": {
|
|
1921
|
-
"name": "
|
|
1922
|
-
"module": "src/base/
|
|
2236
|
+
"name": "CardElement",
|
|
2237
|
+
"module": "src/base/card-element.ts"
|
|
1923
2238
|
}
|
|
1924
2239
|
},
|
|
1925
2240
|
{
|
|
1926
2241
|
"kind": "method",
|
|
1927
|
-
"name": "
|
|
1928
|
-
"privacy": "protected",
|
|
1929
|
-
"return": {
|
|
1930
|
-
"type": {
|
|
1931
|
-
"text": "SpinnerTone"
|
|
1932
|
-
}
|
|
1933
|
-
},
|
|
2242
|
+
"name": "warnLinkSlotMisused",
|
|
1934
2243
|
"parameters": [
|
|
1935
2244
|
{
|
|
1936
|
-
"name": "
|
|
1937
|
-
"type": {
|
|
1938
|
-
"text": "ButtonTone"
|
|
1939
|
-
}
|
|
1940
|
-
},
|
|
1941
|
-
{
|
|
1942
|
-
"name": "buttonVariant",
|
|
2245
|
+
"name": "e",
|
|
1943
2246
|
"type": {
|
|
1944
|
-
"text": "
|
|
2247
|
+
"text": "Event"
|
|
1945
2248
|
}
|
|
1946
2249
|
}
|
|
1947
2250
|
],
|
|
1948
2251
|
"type": {},
|
|
1949
2252
|
"inheritedFrom": {
|
|
1950
|
-
"name": "
|
|
1951
|
-
"module": "src/base/
|
|
2253
|
+
"name": "CardElement",
|
|
2254
|
+
"module": "src/base/card-element.ts"
|
|
1952
2255
|
}
|
|
1953
2256
|
},
|
|
1954
2257
|
{
|
|
@@ -2006,161 +2309,63 @@
|
|
|
2006
2309
|
}
|
|
2007
2310
|
}
|
|
2008
2311
|
],
|
|
2009
|
-
"events": [
|
|
2010
|
-
{
|
|
2011
|
-
"description": "Emitted when the button is blurred.",
|
|
2012
|
-
"name": "sgds-blur",
|
|
2013
|
-
"reactName": "onSgdsBlur"
|
|
2014
|
-
},
|
|
2015
|
-
{
|
|
2016
|
-
"description": "Emitted when the button is focused.",
|
|
2017
|
-
"name": "sgds-focus",
|
|
2018
|
-
"reactName": "onSgdsFocus"
|
|
2019
|
-
}
|
|
2020
|
-
],
|
|
2021
2312
|
"attributes": [
|
|
2022
2313
|
{
|
|
2023
|
-
"name": "
|
|
2024
|
-
"type": {
|
|
2025
|
-
"text": "string"
|
|
2026
|
-
},
|
|
2027
|
-
"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).",
|
|
2028
|
-
"fieldName": "name"
|
|
2029
|
-
},
|
|
2030
|
-
{
|
|
2031
|
-
"name": "value",
|
|
2032
|
-
"type": {
|
|
2033
|
-
"text": "string"
|
|
2034
|
-
},
|
|
2035
|
-
"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).",
|
|
2036
|
-
"fieldName": "value"
|
|
2037
|
-
},
|
|
2038
|
-
{
|
|
2039
|
-
"name": "type",
|
|
2040
|
-
"type": {
|
|
2041
|
-
"text": "\"button\" | \"submit\" | \"reset\""
|
|
2042
|
-
},
|
|
2043
|
-
"default": "\"button\"",
|
|
2044
|
-
"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",
|
|
2045
|
-
"fieldName": "type"
|
|
2046
|
-
},
|
|
2047
|
-
{
|
|
2048
|
-
"name": "form",
|
|
2049
|
-
"type": {
|
|
2050
|
-
"text": "string"
|
|
2051
|
-
},
|
|
2052
|
-
"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.",
|
|
2053
|
-
"fieldName": "form"
|
|
2054
|
-
},
|
|
2055
|
-
{
|
|
2056
|
-
"name": "formaction",
|
|
2057
|
-
"type": {
|
|
2058
|
-
"text": "string"
|
|
2059
|
-
},
|
|
2060
|
-
"description": "Used to override the form owner's `action` attribute.",
|
|
2061
|
-
"fieldName": "formAction"
|
|
2062
|
-
},
|
|
2063
|
-
{
|
|
2064
|
-
"name": "formmethod",
|
|
2065
|
-
"type": {
|
|
2066
|
-
"text": "\"post\" | \"get\""
|
|
2067
|
-
},
|
|
2068
|
-
"description": "Used to override the form owner's `method` attribute.",
|
|
2069
|
-
"fieldName": "formMethod"
|
|
2070
|
-
},
|
|
2071
|
-
{
|
|
2072
|
-
"name": "formnovalidate",
|
|
2314
|
+
"name": "imagePosition",
|
|
2073
2315
|
"type": {
|
|
2074
|
-
"text": "
|
|
2316
|
+
"text": "CardImagePosition"
|
|
2075
2317
|
},
|
|
2076
|
-
"
|
|
2077
|
-
"
|
|
2318
|
+
"default": "\"before\"",
|
|
2319
|
+
"description": "Sets the image position of the card. Available options: `before`, `after`",
|
|
2320
|
+
"fieldName": "imagePosition"
|
|
2078
2321
|
},
|
|
2079
2322
|
{
|
|
2080
|
-
"name": "
|
|
2323
|
+
"name": "imageAdjustment",
|
|
2081
2324
|
"type": {
|
|
2082
|
-
"text": "
|
|
2325
|
+
"text": "CardImageAdjustment"
|
|
2083
2326
|
},
|
|
2084
|
-
"
|
|
2085
|
-
"
|
|
2327
|
+
"default": "\"default\"",
|
|
2328
|
+
"description": "Controls how the image is sized and aligned within the card. Available options: `default`, `padding around`, `aspect ratio`",
|
|
2329
|
+
"fieldName": "imageAdjustment"
|
|
2086
2330
|
},
|
|
2087
2331
|
{
|
|
2088
|
-
"name": "
|
|
2332
|
+
"name": "hasImageSlot",
|
|
2089
2333
|
"type": {
|
|
2090
2334
|
"text": "boolean"
|
|
2091
2335
|
},
|
|
2092
2336
|
"default": "false",
|
|
2093
|
-
"description": "
|
|
2094
|
-
"fieldName": "
|
|
2337
|
+
"description": "Used only for SSR to indicate the presence of the `image` slot.",
|
|
2338
|
+
"fieldName": "hasImageSlot"
|
|
2095
2339
|
},
|
|
2096
2340
|
{
|
|
2097
|
-
"name": "
|
|
2341
|
+
"name": "hasIconSlot",
|
|
2098
2342
|
"type": {
|
|
2099
2343
|
"text": "boolean"
|
|
2100
2344
|
},
|
|
2101
2345
|
"default": "false",
|
|
2102
|
-
"description": "Used only for SSR to indicate the presence of the `
|
|
2103
|
-
"fieldName": "
|
|
2346
|
+
"description": "Used only for SSR to indicate the presence of the `icon` slot.",
|
|
2347
|
+
"fieldName": "hasIconSlot"
|
|
2104
2348
|
},
|
|
2105
2349
|
{
|
|
2106
|
-
"name": "
|
|
2350
|
+
"name": "hasUpperSlot",
|
|
2107
2351
|
"type": {
|
|
2108
2352
|
"text": "boolean"
|
|
2109
2353
|
},
|
|
2110
2354
|
"default": "false",
|
|
2111
|
-
"description": "Used only for SSR to indicate the presence of the `
|
|
2112
|
-
"fieldName": "
|
|
2113
|
-
},
|
|
2114
|
-
{
|
|
2115
|
-
"name": "variant",
|
|
2116
|
-
"type": {
|
|
2117
|
-
"text": "ButtonVariant"
|
|
2118
|
-
},
|
|
2119
|
-
"default": "\"primary\"",
|
|
2120
|
-
"description": "Sets the visual variants such as: `primary`, `outline`, `ghost`. The `danger` value is deprecated since v3.5.6 — use `variant=\"primary\"` with `tone=\"danger\"` instead.",
|
|
2121
|
-
"fieldName": "variant",
|
|
2122
|
-
"inheritedFrom": {
|
|
2123
|
-
"name": "ButtonElement",
|
|
2124
|
-
"module": "src/base/button-element.ts"
|
|
2125
|
-
}
|
|
2126
|
-
},
|
|
2127
|
-
{
|
|
2128
|
-
"name": "tone",
|
|
2129
|
-
"type": {
|
|
2130
|
-
"text": "ButtonTone"
|
|
2131
|
-
},
|
|
2132
|
-
"default": "\"brand\"",
|
|
2133
|
-
"description": "Sets the visual colour of the button: `brand`, `danger`, `fixed-light`, `neutral`",
|
|
2134
|
-
"fieldName": "tone",
|
|
2135
|
-
"inheritedFrom": {
|
|
2136
|
-
"name": "ButtonElement",
|
|
2137
|
-
"module": "src/base/button-element.ts"
|
|
2138
|
-
}
|
|
2139
|
-
},
|
|
2140
|
-
{
|
|
2141
|
-
"name": "size",
|
|
2142
|
-
"type": {
|
|
2143
|
-
"text": "\"xs\" | \"sm\" | \"md\" | \"lg\""
|
|
2144
|
-
},
|
|
2145
|
-
"default": "\"md\"",
|
|
2146
|
-
"description": "Specifies a small, medium or large button, the size is medium by default.",
|
|
2147
|
-
"fieldName": "size",
|
|
2148
|
-
"inheritedFrom": {
|
|
2149
|
-
"name": "ButtonElement",
|
|
2150
|
-
"module": "src/base/button-element.ts"
|
|
2151
|
-
}
|
|
2355
|
+
"description": "Used only for SSR to indicate the presence of the `upper` slot.",
|
|
2356
|
+
"fieldName": "hasUpperSlot"
|
|
2152
2357
|
},
|
|
2153
2358
|
{
|
|
2154
|
-
"name": "
|
|
2359
|
+
"name": "stretchedLink",
|
|
2155
2360
|
"type": {
|
|
2156
2361
|
"text": "boolean"
|
|
2157
2362
|
},
|
|
2158
2363
|
"default": "false",
|
|
2159
|
-
"description": "
|
|
2160
|
-
"fieldName": "
|
|
2364
|
+
"description": "Extends the link passed in either `footer` or `link`(deprecated) slot.",
|
|
2365
|
+
"fieldName": "stretchedLink",
|
|
2161
2366
|
"inheritedFrom": {
|
|
2162
|
-
"name": "
|
|
2163
|
-
"module": "src/base/
|
|
2367
|
+
"name": "CardElement",
|
|
2368
|
+
"module": "src/base/card-element.ts"
|
|
2164
2369
|
}
|
|
2165
2370
|
},
|
|
2166
2371
|
{
|
|
@@ -2169,379 +2374,279 @@
|
|
|
2169
2374
|
"text": "boolean"
|
|
2170
2375
|
},
|
|
2171
2376
|
"default": "false",
|
|
2172
|
-
"description": "
|
|
2377
|
+
"description": "Disables the card",
|
|
2173
2378
|
"fieldName": "disabled",
|
|
2174
2379
|
"inheritedFrom": {
|
|
2175
|
-
"name": "
|
|
2176
|
-
"module": "src/base/
|
|
2177
|
-
}
|
|
2178
|
-
},
|
|
2179
|
-
{
|
|
2180
|
-
"name": "href",
|
|
2181
|
-
"type": {
|
|
2182
|
-
"text": "string"
|
|
2183
|
-
},
|
|
2184
|
-
"description": "When set, the underlying button will be rendered as an `<a>` with this `href` instead of a `<button>`.",
|
|
2185
|
-
"fieldName": "href",
|
|
2186
|
-
"inheritedFrom": {
|
|
2187
|
-
"name": "ButtonElement",
|
|
2188
|
-
"module": "src/base/button-element.ts"
|
|
2189
|
-
}
|
|
2190
|
-
},
|
|
2191
|
-
{
|
|
2192
|
-
"name": "target",
|
|
2193
|
-
"type": {
|
|
2194
|
-
"text": "\"_blank\" | \"_parent\" | \"_self\" | \"_top\""
|
|
2195
|
-
},
|
|
2196
|
-
"default": "\"_self\"",
|
|
2197
|
-
"description": "Where to display the linked URL, as the name for a browsing context. Forwards to the HTMLAnchor target attribute",
|
|
2198
|
-
"fieldName": "target",
|
|
2199
|
-
"inheritedFrom": {
|
|
2200
|
-
"name": "ButtonElement",
|
|
2201
|
-
"module": "src/base/button-element.ts"
|
|
2380
|
+
"name": "CardElement",
|
|
2381
|
+
"module": "src/base/card-element.ts"
|
|
2202
2382
|
}
|
|
2203
2383
|
},
|
|
2204
2384
|
{
|
|
2205
|
-
"name": "
|
|
2385
|
+
"name": "hideBorder",
|
|
2206
2386
|
"type": {
|
|
2207
|
-
"text": "
|
|
2387
|
+
"text": "boolean"
|
|
2208
2388
|
},
|
|
2209
|
-
"
|
|
2210
|
-
"
|
|
2389
|
+
"default": "false",
|
|
2390
|
+
"description": "When true, hides the default border of the card.",
|
|
2391
|
+
"fieldName": "hideBorder",
|
|
2211
2392
|
"inheritedFrom": {
|
|
2212
|
-
"name": "
|
|
2213
|
-
"module": "src/base/
|
|
2393
|
+
"name": "CardElement",
|
|
2394
|
+
"module": "src/base/card-element.ts"
|
|
2214
2395
|
}
|
|
2215
2396
|
},
|
|
2216
2397
|
{
|
|
2217
|
-
"name": "
|
|
2398
|
+
"name": "tinted",
|
|
2218
2399
|
"type": {
|
|
2219
|
-
"text": "
|
|
2400
|
+
"text": "boolean"
|
|
2220
2401
|
},
|
|
2221
|
-
"
|
|
2222
|
-
"
|
|
2402
|
+
"default": "false",
|
|
2403
|
+
"description": "When true, applies a tinted background color to the card.",
|
|
2404
|
+
"fieldName": "tinted",
|
|
2223
2405
|
"inheritedFrom": {
|
|
2224
|
-
"name": "
|
|
2225
|
-
"module": "src/base/
|
|
2406
|
+
"name": "CardElement",
|
|
2407
|
+
"module": "src/base/card-element.ts"
|
|
2226
2408
|
}
|
|
2227
2409
|
},
|
|
2228
2410
|
{
|
|
2229
|
-
"name": "
|
|
2411
|
+
"name": "orientation",
|
|
2230
2412
|
"type": {
|
|
2231
|
-
"text": "
|
|
2413
|
+
"text": "CardOrientation"
|
|
2232
2414
|
},
|
|
2233
|
-
"
|
|
2234
|
-
"
|
|
2415
|
+
"default": "\"vertical\"",
|
|
2416
|
+
"description": "Sets the orientation of the card. Available options: `vertical`, `horizontal`",
|
|
2417
|
+
"fieldName": "orientation",
|
|
2235
2418
|
"inheritedFrom": {
|
|
2236
|
-
"name": "
|
|
2237
|
-
"module": "src/base/
|
|
2419
|
+
"name": "CardElement",
|
|
2420
|
+
"module": "src/base/card-element.ts"
|
|
2238
2421
|
}
|
|
2239
2422
|
}
|
|
2240
2423
|
],
|
|
2241
2424
|
"superclass": {
|
|
2242
|
-
"name": "
|
|
2243
|
-
"module": "/src/base/
|
|
2425
|
+
"name": "CardElement",
|
|
2426
|
+
"module": "/src/base/card-element"
|
|
2244
2427
|
},
|
|
2245
|
-
"summary": "
|
|
2246
|
-
"tagName": "sgds-
|
|
2428
|
+
"summary": "Cards can be used for headers and footers, a wide variety of content, contain contextual background colors and images.",
|
|
2429
|
+
"tagName": "sgds-card",
|
|
2247
2430
|
"customElement": true,
|
|
2248
|
-
"modulePath": "src/components/
|
|
2431
|
+
"modulePath": "src/components/Card/sgds-card.ts",
|
|
2249
2432
|
"cssProperties": [],
|
|
2250
2433
|
"cssParts": [],
|
|
2251
|
-
"cssStates": []
|
|
2434
|
+
"cssStates": [],
|
|
2435
|
+
"events": []
|
|
2252
2436
|
}
|
|
2253
2437
|
],
|
|
2254
2438
|
"exports": [
|
|
2255
2439
|
{
|
|
2256
2440
|
"kind": "js",
|
|
2257
|
-
"name": "
|
|
2441
|
+
"name": "SgdsCard",
|
|
2258
2442
|
"declaration": {
|
|
2259
|
-
"name": "
|
|
2260
|
-
"module": "src/components/
|
|
2443
|
+
"name": "SgdsCard",
|
|
2444
|
+
"module": "src/components/Card/sgds-card.ts"
|
|
2261
2445
|
}
|
|
2262
2446
|
},
|
|
2263
2447
|
{
|
|
2264
2448
|
"kind": "js",
|
|
2265
2449
|
"name": "default",
|
|
2266
2450
|
"declaration": {
|
|
2267
|
-
"name": "
|
|
2268
|
-
"module": "src/components/
|
|
2451
|
+
"name": "SgdsCard",
|
|
2452
|
+
"module": "src/components/Card/sgds-card.ts"
|
|
2269
2453
|
}
|
|
2270
2454
|
}
|
|
2271
2455
|
]
|
|
2272
2456
|
},
|
|
2273
2457
|
{
|
|
2274
2458
|
"kind": "javascript-module",
|
|
2275
|
-
"path": "src/components/
|
|
2459
|
+
"path": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
|
|
2276
2460
|
"declarations": [
|
|
2277
2461
|
{
|
|
2278
2462
|
"kind": "class",
|
|
2279
2463
|
"description": "",
|
|
2280
|
-
"name": "
|
|
2464
|
+
"name": "SgdsBreadcrumbItem",
|
|
2281
2465
|
"slots": [
|
|
2282
2466
|
{
|
|
2283
|
-
"description": "The
|
|
2467
|
+
"description": "The link of the item. Pass in anchor tags into this slot",
|
|
2284
2468
|
"name": "default"
|
|
2285
|
-
},
|
|
2286
|
-
{
|
|
2287
|
-
"description": "Accepts an element for an overflow or contextual menu, positioned at the top-right corner of the card. Typically used for action menus or dropdowns.",
|
|
2288
|
-
"name": "menu"
|
|
2289
|
-
},
|
|
2290
|
-
{
|
|
2291
|
-
"description": "Accepts an element to be displayed above the card content. When used, it overrides image and icon slot content.",
|
|
2292
|
-
"name": "upper"
|
|
2293
|
-
},
|
|
2294
|
-
{
|
|
2295
|
-
"description": "Accepts an image or svg element of the card. Only a single element is allowed to be passed in.",
|
|
2296
|
-
"name": "image"
|
|
2297
|
-
},
|
|
2298
|
-
{
|
|
2299
|
-
"description": "Accepts an icon element to visually represent the card. Only a single element is allowed to be passed in.",
|
|
2300
|
-
"name": "icon"
|
|
2301
|
-
},
|
|
2302
|
-
{
|
|
2303
|
-
"description": "The subtitle of the card",
|
|
2304
|
-
"name": "subtitle"
|
|
2305
|
-
},
|
|
2306
|
-
{
|
|
2307
|
-
"description": "The title of the card",
|
|
2308
|
-
"name": "title"
|
|
2309
|
-
},
|
|
2310
|
-
{
|
|
2311
|
-
"description": "The paragrapher text of the card",
|
|
2312
|
-
"name": "description"
|
|
2313
|
-
},
|
|
2314
|
-
{
|
|
2315
|
-
"description": "Accepts any additional content to be displayed below the card description, such as badges, metadata, or supplementary information.",
|
|
2316
|
-
"name": "lower"
|
|
2317
|
-
},
|
|
2318
|
-
{
|
|
2319
|
-
"description": "Footer area of the card. Accepts links, actions, or any custom content.",
|
|
2320
|
-
"name": "footer"
|
|
2321
|
-
},
|
|
2322
|
-
{
|
|
2323
|
-
"description": "(@deprecated) Deprecated since 3.3.2 in favour of `footer` slot. Legacy slot for anchor elements. Use `footer` instead.",
|
|
2324
|
-
"name": "link"
|
|
2325
2469
|
}
|
|
2326
2470
|
],
|
|
2327
2471
|
"members": [
|
|
2328
2472
|
{
|
|
2329
2473
|
"kind": "field",
|
|
2330
|
-
"name": "
|
|
2331
|
-
"type": {
|
|
2332
|
-
"text": "HTMLElement[]"
|
|
2333
|
-
},
|
|
2334
|
-
"privacy": "private"
|
|
2335
|
-
},
|
|
2336
|
-
{
|
|
2337
|
-
"kind": "field",
|
|
2338
|
-
"name": "linkNode",
|
|
2339
|
-
"type": {
|
|
2340
|
-
"text": "HTMLAnchorElement[] | SgdsLink[]"
|
|
2341
|
-
},
|
|
2342
|
-
"privacy": "private"
|
|
2343
|
-
},
|
|
2344
|
-
{
|
|
2345
|
-
"kind": "field",
|
|
2346
|
-
"name": "imagePosition",
|
|
2347
|
-
"type": {
|
|
2348
|
-
"text": "CardImagePosition"
|
|
2349
|
-
},
|
|
2350
|
-
"default": "\"before\"",
|
|
2351
|
-
"description": "Sets the image position of the card. Available options: `before`, `after`",
|
|
2352
|
-
"attribute": "imagePosition",
|
|
2353
|
-
"reflects": true
|
|
2354
|
-
},
|
|
2355
|
-
{
|
|
2356
|
-
"kind": "field",
|
|
2357
|
-
"name": "imageAdjustment",
|
|
2358
|
-
"type": {
|
|
2359
|
-
"text": "CardImageAdjustment"
|
|
2360
|
-
},
|
|
2361
|
-
"default": "\"default\"",
|
|
2362
|
-
"description": "Controls how the image is sized and aligned within the card. Available options: `default`, `padding around`, `aspect ratio`",
|
|
2363
|
-
"attribute": "imageAdjustment",
|
|
2364
|
-
"reflects": true
|
|
2365
|
-
},
|
|
2366
|
-
{
|
|
2367
|
-
"kind": "field",
|
|
2368
|
-
"name": "hasImageSlot",
|
|
2369
|
-
"type": {
|
|
2370
|
-
"text": "boolean"
|
|
2371
|
-
},
|
|
2372
|
-
"default": "false",
|
|
2373
|
-
"description": "Used only for SSR to indicate the presence of the `image` slot.",
|
|
2374
|
-
"attribute": "hasImageSlot"
|
|
2375
|
-
},
|
|
2376
|
-
{
|
|
2377
|
-
"kind": "field",
|
|
2378
|
-
"name": "hasIconSlot",
|
|
2474
|
+
"name": "dependencies",
|
|
2379
2475
|
"type": {
|
|
2380
|
-
"text": "
|
|
2476
|
+
"text": "Record<string, typeof SgdsElement>"
|
|
2381
2477
|
},
|
|
2382
|
-
"
|
|
2383
|
-
"
|
|
2384
|
-
"attribute": "hasIconSlot"
|
|
2478
|
+
"static": true,
|
|
2479
|
+
"default": "{\n \"sgds-link\": SgdsLink,\n \"sgds-icon\": SgdsIcon\n }"
|
|
2385
2480
|
},
|
|
2386
2481
|
{
|
|
2387
2482
|
"kind": "field",
|
|
2388
|
-
"name": "
|
|
2483
|
+
"name": "active",
|
|
2389
2484
|
"type": {
|
|
2390
2485
|
"text": "boolean"
|
|
2391
2486
|
},
|
|
2392
2487
|
"default": "false",
|
|
2393
|
-
"description": "
|
|
2394
|
-
"attribute": "
|
|
2395
|
-
|
|
2396
|
-
{
|
|
2397
|
-
"kind": "field",
|
|
2398
|
-
"name": "linkSlotItems",
|
|
2399
|
-
"type": {
|
|
2400
|
-
"text": "HTMLAnchorElement | null"
|
|
2401
|
-
},
|
|
2402
|
-
"privacy": "private"
|
|
2403
|
-
},
|
|
2404
|
-
{
|
|
2405
|
-
"kind": "field",
|
|
2406
|
-
"name": "footerSlotItems",
|
|
2407
|
-
"type": {
|
|
2408
|
-
"text": "HTMLAnchorElement | null"
|
|
2409
|
-
},
|
|
2410
|
-
"privacy": "private"
|
|
2488
|
+
"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",
|
|
2489
|
+
"attribute": "active",
|
|
2490
|
+
"reflects": true
|
|
2411
2491
|
},
|
|
2412
2492
|
{
|
|
2413
2493
|
"kind": "field",
|
|
2414
|
-
"name": "
|
|
2494
|
+
"name": "_preventNavigation",
|
|
2415
2495
|
"privacy": "private",
|
|
2416
|
-
"default": "new HasSlotController(this, \"image\", \"icon\", \"upper\")",
|
|
2417
2496
|
"type": {}
|
|
2418
2497
|
},
|
|
2419
2498
|
{
|
|
2420
2499
|
"kind": "method",
|
|
2421
|
-
"name": "
|
|
2500
|
+
"name": "emit",
|
|
2422
2501
|
"parameters": [
|
|
2423
2502
|
{
|
|
2424
|
-
"name": "
|
|
2503
|
+
"name": "name",
|
|
2425
2504
|
"type": {
|
|
2426
|
-
"text": "
|
|
2505
|
+
"text": "string"
|
|
2506
|
+
}
|
|
2507
|
+
},
|
|
2508
|
+
{
|
|
2509
|
+
"name": "options",
|
|
2510
|
+
"optional": true,
|
|
2511
|
+
"type": {
|
|
2512
|
+
"text": "CustomEventInit<T>"
|
|
2427
2513
|
}
|
|
2428
2514
|
}
|
|
2429
2515
|
],
|
|
2430
|
-
"
|
|
2431
|
-
|
|
2432
|
-
{
|
|
2433
|
-
"kind": "field",
|
|
2434
|
-
"name": "stretchedLink",
|
|
2435
|
-
"type": {
|
|
2436
|
-
"text": "boolean"
|
|
2437
|
-
},
|
|
2438
|
-
"default": "false",
|
|
2439
|
-
"description": "Extends the link passed in either `footer` or `link`(deprecated) slot.",
|
|
2440
|
-
"attribute": "stretchedLink",
|
|
2441
|
-
"reflects": true,
|
|
2516
|
+
"description": "Emits a custom event with more convenient defaults.",
|
|
2517
|
+
"type": {},
|
|
2442
2518
|
"inheritedFrom": {
|
|
2443
|
-
"name": "
|
|
2444
|
-
"module": "src/base/
|
|
2519
|
+
"name": "SgdsElement",
|
|
2520
|
+
"module": "src/base/sgds-element.ts"
|
|
2445
2521
|
}
|
|
2446
2522
|
},
|
|
2447
2523
|
{
|
|
2448
|
-
"kind": "
|
|
2449
|
-
"name": "
|
|
2450
|
-
"
|
|
2451
|
-
|
|
2452
|
-
|
|
2453
|
-
|
|
2454
|
-
|
|
2455
|
-
|
|
2456
|
-
|
|
2524
|
+
"kind": "method",
|
|
2525
|
+
"name": "define",
|
|
2526
|
+
"static": true,
|
|
2527
|
+
"parameters": [
|
|
2528
|
+
{
|
|
2529
|
+
"name": "name",
|
|
2530
|
+
"type": {
|
|
2531
|
+
"text": "string"
|
|
2532
|
+
}
|
|
2533
|
+
},
|
|
2534
|
+
{
|
|
2535
|
+
"name": "elementConstructor",
|
|
2536
|
+
"default": "this"
|
|
2537
|
+
},
|
|
2538
|
+
{
|
|
2539
|
+
"name": "options",
|
|
2540
|
+
"default": "{}",
|
|
2541
|
+
"type": {
|
|
2542
|
+
"text": "ElementDefinitionOptions"
|
|
2543
|
+
}
|
|
2544
|
+
}
|
|
2545
|
+
],
|
|
2546
|
+
"type": {},
|
|
2457
2547
|
"inheritedFrom": {
|
|
2458
|
-
"name": "
|
|
2459
|
-
"module": "src/base/
|
|
2548
|
+
"name": "SgdsElement",
|
|
2549
|
+
"module": "src/base/sgds-element.ts"
|
|
2460
2550
|
}
|
|
2461
|
-
}
|
|
2551
|
+
}
|
|
2552
|
+
],
|
|
2553
|
+
"attributes": [
|
|
2462
2554
|
{
|
|
2463
|
-
"
|
|
2464
|
-
"name": "hideBorder",
|
|
2555
|
+
"name": "active",
|
|
2465
2556
|
"type": {
|
|
2466
2557
|
"text": "boolean"
|
|
2467
2558
|
},
|
|
2468
2559
|
"default": "false",
|
|
2469
|
-
"description": "
|
|
2470
|
-
"
|
|
2471
|
-
|
|
2472
|
-
|
|
2473
|
-
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
|
|
2560
|
+
"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",
|
|
2561
|
+
"fieldName": "active"
|
|
2562
|
+
}
|
|
2563
|
+
],
|
|
2564
|
+
"superclass": {
|
|
2565
|
+
"name": "SgdsElement",
|
|
2566
|
+
"module": "/src/base/sgds-element"
|
|
2567
|
+
},
|
|
2568
|
+
"summary": "Breadcrumb Item are navigational links used in Breadcrumb component",
|
|
2569
|
+
"tagName": "sgds-breadcrumb-item",
|
|
2570
|
+
"customElement": true,
|
|
2571
|
+
"modulePath": "src/components/Breadcrumb/sgds-breadcrumb-item.ts",
|
|
2572
|
+
"cssProperties": [],
|
|
2573
|
+
"cssParts": [],
|
|
2574
|
+
"cssStates": [],
|
|
2575
|
+
"events": []
|
|
2576
|
+
}
|
|
2577
|
+
],
|
|
2578
|
+
"exports": [
|
|
2579
|
+
{
|
|
2580
|
+
"kind": "js",
|
|
2581
|
+
"name": "SgdsBreadcrumbItem",
|
|
2582
|
+
"declaration": {
|
|
2583
|
+
"name": "SgdsBreadcrumbItem",
|
|
2584
|
+
"module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
|
|
2585
|
+
}
|
|
2586
|
+
},
|
|
2587
|
+
{
|
|
2588
|
+
"kind": "js",
|
|
2589
|
+
"name": "default",
|
|
2590
|
+
"declaration": {
|
|
2591
|
+
"name": "SgdsBreadcrumbItem",
|
|
2592
|
+
"module": "src/components/Breadcrumb/sgds-breadcrumb-item.ts"
|
|
2593
|
+
}
|
|
2594
|
+
}
|
|
2595
|
+
]
|
|
2596
|
+
},
|
|
2597
|
+
{
|
|
2598
|
+
"kind": "javascript-module",
|
|
2599
|
+
"path": "src/components/Breadcrumb/sgds-breadcrumb.ts",
|
|
2600
|
+
"declarations": [
|
|
2601
|
+
{
|
|
2602
|
+
"kind": "class",
|
|
2603
|
+
"description": "",
|
|
2604
|
+
"name": "SgdsBreadcrumb",
|
|
2605
|
+
"slots": [
|
|
2606
|
+
{
|
|
2607
|
+
"description": "The slot to pass in custom elements of `SgdsBreadcrumbItems`.",
|
|
2608
|
+
"name": "default"
|
|
2609
|
+
}
|
|
2610
|
+
],
|
|
2611
|
+
"members": [
|
|
2477
2612
|
{
|
|
2478
2613
|
"kind": "field",
|
|
2479
|
-
"name": "
|
|
2614
|
+
"name": "dependencies",
|
|
2480
2615
|
"type": {
|
|
2481
|
-
"text": "
|
|
2616
|
+
"text": "object"
|
|
2482
2617
|
},
|
|
2483
|
-
"
|
|
2484
|
-
"
|
|
2485
|
-
"attribute": "tinted",
|
|
2486
|
-
"reflects": true,
|
|
2487
|
-
"inheritedFrom": {
|
|
2488
|
-
"name": "CardElement",
|
|
2489
|
-
"module": "src/base/card-element.ts"
|
|
2490
|
-
}
|
|
2618
|
+
"static": true,
|
|
2619
|
+
"default": "{\n \"sgds-overflow-menu\": SgdsOverflowMenu\n }"
|
|
2491
2620
|
},
|
|
2492
2621
|
{
|
|
2493
2622
|
"kind": "field",
|
|
2494
|
-
"name": "
|
|
2623
|
+
"name": "ariaLabel",
|
|
2495
2624
|
"type": {
|
|
2496
|
-
"text": "
|
|
2625
|
+
"text": "string"
|
|
2497
2626
|
},
|
|
2498
|
-
"default": "\"
|
|
2499
|
-
"description": "
|
|
2500
|
-
"attribute": "
|
|
2501
|
-
"reflects": true,
|
|
2502
|
-
"inheritedFrom": {
|
|
2503
|
-
"name": "CardElement",
|
|
2504
|
-
"module": "src/base/card-element.ts"
|
|
2505
|
-
}
|
|
2506
|
-
},
|
|
2507
|
-
{
|
|
2508
|
-
"kind": "method",
|
|
2509
|
-
"name": "handleTitleSlotChange",
|
|
2510
|
-
"parameters": [
|
|
2511
|
-
{
|
|
2512
|
-
"name": "e",
|
|
2513
|
-
"type": {
|
|
2514
|
-
"text": "Event"
|
|
2515
|
-
}
|
|
2516
|
-
}
|
|
2517
|
-
],
|
|
2518
|
-
"type": {},
|
|
2519
|
-
"inheritedFrom": {
|
|
2520
|
-
"name": "CardElement",
|
|
2521
|
-
"module": "src/base/card-element.ts"
|
|
2522
|
-
}
|
|
2627
|
+
"default": "\"breadcrumb\"",
|
|
2628
|
+
"description": "The aria-label of nav element within breadcrumb component.",
|
|
2629
|
+
"attribute": "ariaLabel"
|
|
2523
2630
|
},
|
|
2524
2631
|
{
|
|
2525
2632
|
"kind": "method",
|
|
2526
|
-
"name": "
|
|
2527
|
-
"privacy": "
|
|
2633
|
+
"name": "_replaceExcessItemsWithDropdown",
|
|
2634
|
+
"privacy": "private",
|
|
2528
2635
|
"parameters": [
|
|
2529
2636
|
{
|
|
2530
|
-
"name": "
|
|
2637
|
+
"name": "items",
|
|
2531
2638
|
"type": {
|
|
2532
|
-
"text": "
|
|
2639
|
+
"text": "SgdsBreadcrumbItem[]"
|
|
2533
2640
|
}
|
|
2534
2641
|
}
|
|
2535
2642
|
],
|
|
2536
|
-
"
|
|
2537
|
-
"
|
|
2538
|
-
"name": "CardElement",
|
|
2539
|
-
"module": "src/base/card-element.ts"
|
|
2540
|
-
}
|
|
2643
|
+
"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>`",
|
|
2644
|
+
"type": {}
|
|
2541
2645
|
},
|
|
2542
2646
|
{
|
|
2543
2647
|
"kind": "method",
|
|
2544
|
-
"name": "
|
|
2648
|
+
"name": "_handleSlotChange",
|
|
2649
|
+
"privacy": "private",
|
|
2545
2650
|
"parameters": [
|
|
2546
2651
|
{
|
|
2547
2652
|
"name": "e",
|
|
@@ -2550,11 +2655,7 @@
|
|
|
2550
2655
|
}
|
|
2551
2656
|
}
|
|
2552
2657
|
],
|
|
2553
|
-
"type": {}
|
|
2554
|
-
"inheritedFrom": {
|
|
2555
|
-
"name": "CardElement",
|
|
2556
|
-
"module": "src/base/card-element.ts"
|
|
2557
|
-
}
|
|
2658
|
+
"type": {}
|
|
2558
2659
|
},
|
|
2559
2660
|
{
|
|
2560
2661
|
"kind": "method",
|
|
@@ -2613,124 +2714,23 @@
|
|
|
2613
2714
|
],
|
|
2614
2715
|
"attributes": [
|
|
2615
2716
|
{
|
|
2616
|
-
"name": "
|
|
2617
|
-
"type": {
|
|
2618
|
-
"text": "CardImagePosition"
|
|
2619
|
-
},
|
|
2620
|
-
"default": "\"before\"",
|
|
2621
|
-
"description": "Sets the image position of the card. Available options: `before`, `after`",
|
|
2622
|
-
"fieldName": "imagePosition"
|
|
2623
|
-
},
|
|
2624
|
-
{
|
|
2625
|
-
"name": "imageAdjustment",
|
|
2626
|
-
"type": {
|
|
2627
|
-
"text": "CardImageAdjustment"
|
|
2628
|
-
},
|
|
2629
|
-
"default": "\"default\"",
|
|
2630
|
-
"description": "Controls how the image is sized and aligned within the card. Available options: `default`, `padding around`, `aspect ratio`",
|
|
2631
|
-
"fieldName": "imageAdjustment"
|
|
2632
|
-
},
|
|
2633
|
-
{
|
|
2634
|
-
"name": "hasImageSlot",
|
|
2635
|
-
"type": {
|
|
2636
|
-
"text": "boolean"
|
|
2637
|
-
},
|
|
2638
|
-
"default": "false",
|
|
2639
|
-
"description": "Used only for SSR to indicate the presence of the `image` slot.",
|
|
2640
|
-
"fieldName": "hasImageSlot"
|
|
2641
|
-
},
|
|
2642
|
-
{
|
|
2643
|
-
"name": "hasIconSlot",
|
|
2644
|
-
"type": {
|
|
2645
|
-
"text": "boolean"
|
|
2646
|
-
},
|
|
2647
|
-
"default": "false",
|
|
2648
|
-
"description": "Used only for SSR to indicate the presence of the `icon` slot.",
|
|
2649
|
-
"fieldName": "hasIconSlot"
|
|
2650
|
-
},
|
|
2651
|
-
{
|
|
2652
|
-
"name": "hasUpperSlot",
|
|
2653
|
-
"type": {
|
|
2654
|
-
"text": "boolean"
|
|
2655
|
-
},
|
|
2656
|
-
"default": "false",
|
|
2657
|
-
"description": "Used only for SSR to indicate the presence of the `upper` slot.",
|
|
2658
|
-
"fieldName": "hasUpperSlot"
|
|
2659
|
-
},
|
|
2660
|
-
{
|
|
2661
|
-
"name": "stretchedLink",
|
|
2662
|
-
"type": {
|
|
2663
|
-
"text": "boolean"
|
|
2664
|
-
},
|
|
2665
|
-
"default": "false",
|
|
2666
|
-
"description": "Extends the link passed in either `footer` or `link`(deprecated) slot.",
|
|
2667
|
-
"fieldName": "stretchedLink",
|
|
2668
|
-
"inheritedFrom": {
|
|
2669
|
-
"name": "CardElement",
|
|
2670
|
-
"module": "src/base/card-element.ts"
|
|
2671
|
-
}
|
|
2672
|
-
},
|
|
2673
|
-
{
|
|
2674
|
-
"name": "disabled",
|
|
2675
|
-
"type": {
|
|
2676
|
-
"text": "boolean"
|
|
2677
|
-
},
|
|
2678
|
-
"default": "false",
|
|
2679
|
-
"description": "Disables the card",
|
|
2680
|
-
"fieldName": "disabled",
|
|
2681
|
-
"inheritedFrom": {
|
|
2682
|
-
"name": "CardElement",
|
|
2683
|
-
"module": "src/base/card-element.ts"
|
|
2684
|
-
}
|
|
2685
|
-
},
|
|
2686
|
-
{
|
|
2687
|
-
"name": "hideBorder",
|
|
2688
|
-
"type": {
|
|
2689
|
-
"text": "boolean"
|
|
2690
|
-
},
|
|
2691
|
-
"default": "false",
|
|
2692
|
-
"description": "When true, hides the default border of the card.",
|
|
2693
|
-
"fieldName": "hideBorder",
|
|
2694
|
-
"inheritedFrom": {
|
|
2695
|
-
"name": "CardElement",
|
|
2696
|
-
"module": "src/base/card-element.ts"
|
|
2697
|
-
}
|
|
2698
|
-
},
|
|
2699
|
-
{
|
|
2700
|
-
"name": "tinted",
|
|
2701
|
-
"type": {
|
|
2702
|
-
"text": "boolean"
|
|
2703
|
-
},
|
|
2704
|
-
"default": "false",
|
|
2705
|
-
"description": "When true, applies a tinted background color to the card.",
|
|
2706
|
-
"fieldName": "tinted",
|
|
2707
|
-
"inheritedFrom": {
|
|
2708
|
-
"name": "CardElement",
|
|
2709
|
-
"module": "src/base/card-element.ts"
|
|
2710
|
-
}
|
|
2711
|
-
},
|
|
2712
|
-
{
|
|
2713
|
-
"name": "orientation",
|
|
2717
|
+
"name": "ariaLabel",
|
|
2714
2718
|
"type": {
|
|
2715
|
-
"text": "
|
|
2719
|
+
"text": "string"
|
|
2716
2720
|
},
|
|
2717
|
-
"default": "\"
|
|
2718
|
-
"description": "
|
|
2719
|
-
"fieldName": "
|
|
2720
|
-
"inheritedFrom": {
|
|
2721
|
-
"name": "CardElement",
|
|
2722
|
-
"module": "src/base/card-element.ts"
|
|
2723
|
-
}
|
|
2721
|
+
"default": "\"breadcrumb\"",
|
|
2722
|
+
"description": "The aria-label of nav element within breadcrumb component.",
|
|
2723
|
+
"fieldName": "ariaLabel"
|
|
2724
2724
|
}
|
|
2725
2725
|
],
|
|
2726
2726
|
"superclass": {
|
|
2727
|
-
"name": "
|
|
2728
|
-
"module": "/src/base/
|
|
2727
|
+
"name": "SgdsElement",
|
|
2728
|
+
"module": "/src/base/sgds-element"
|
|
2729
2729
|
},
|
|
2730
|
-
"summary": "
|
|
2731
|
-
"tagName": "sgds-
|
|
2730
|
+
"summary": "Breadcrumbs help users to navigate and understand where they are on the current website or service.",
|
|
2731
|
+
"tagName": "sgds-breadcrumb",
|
|
2732
2732
|
"customElement": true,
|
|
2733
|
-
"modulePath": "src/components/
|
|
2733
|
+
"modulePath": "src/components/Breadcrumb/sgds-breadcrumb.ts",
|
|
2734
2734
|
"cssProperties": [],
|
|
2735
2735
|
"cssParts": [],
|
|
2736
2736
|
"cssStates": [],
|
|
@@ -2740,18 +2740,18 @@
|
|
|
2740
2740
|
"exports": [
|
|
2741
2741
|
{
|
|
2742
2742
|
"kind": "js",
|
|
2743
|
-
"name": "
|
|
2743
|
+
"name": "SgdsBreadcrumb",
|
|
2744
2744
|
"declaration": {
|
|
2745
|
-
"name": "
|
|
2746
|
-
"module": "src/components/
|
|
2745
|
+
"name": "SgdsBreadcrumb",
|
|
2746
|
+
"module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
|
|
2747
2747
|
}
|
|
2748
2748
|
},
|
|
2749
2749
|
{
|
|
2750
2750
|
"kind": "js",
|
|
2751
2751
|
"name": "default",
|
|
2752
2752
|
"declaration": {
|
|
2753
|
-
"name": "
|
|
2754
|
-
"module": "src/components/
|
|
2753
|
+
"name": "SgdsBreadcrumb",
|
|
2754
|
+
"module": "src/components/Breadcrumb/sgds-breadcrumb.ts"
|
|
2755
2755
|
}
|
|
2756
2756
|
}
|
|
2757
2757
|
]
|
|
@@ -2838,6 +2838,17 @@
|
|
|
2838
2838
|
"attribute": "required",
|
|
2839
2839
|
"reflects": true
|
|
2840
2840
|
},
|
|
2841
|
+
{
|
|
2842
|
+
"kind": "field",
|
|
2843
|
+
"name": "noValidate",
|
|
2844
|
+
"type": {
|
|
2845
|
+
"text": "boolean"
|
|
2846
|
+
},
|
|
2847
|
+
"default": "false",
|
|
2848
|
+
"description": "Disables native and sgds validation for the checkbox group.",
|
|
2849
|
+
"attribute": "noValidate",
|
|
2850
|
+
"reflects": true
|
|
2851
|
+
},
|
|
2841
2852
|
{
|
|
2842
2853
|
"kind": "field",
|
|
2843
2854
|
"name": "value",
|
|
@@ -2858,14 +2869,6 @@
|
|
|
2858
2869
|
"privacy": "private",
|
|
2859
2870
|
"default": "false"
|
|
2860
2871
|
},
|
|
2861
|
-
{
|
|
2862
|
-
"kind": "field",
|
|
2863
|
-
"name": "defaultValue",
|
|
2864
|
-
"type": {
|
|
2865
|
-
"text": "string"
|
|
2866
|
-
},
|
|
2867
|
-
"default": "\"\""
|
|
2868
|
-
},
|
|
2869
2872
|
{
|
|
2870
2873
|
"kind": "field",
|
|
2871
2874
|
"name": "_blurredCheckboxes",
|
|
@@ -3156,6 +3159,16 @@
|
|
|
3156
3159
|
"description": "Emitted when the value of the CheckboxGroup changes. This happens when checkboxes are checked or unchecked.",
|
|
3157
3160
|
"name": "sgds-change",
|
|
3158
3161
|
"reactName": "onSgdsChange"
|
|
3162
|
+
},
|
|
3163
|
+
{
|
|
3164
|
+
"description": "Emitted when the checkbox group's invalid state is set to true.",
|
|
3165
|
+
"name": "sgds-invalid",
|
|
3166
|
+
"reactName": "onSgdsInvalid"
|
|
3167
|
+
},
|
|
3168
|
+
{
|
|
3169
|
+
"description": "Emitted when the checkbox group's invalid state is set to false.",
|
|
3170
|
+
"name": "sgds-valid",
|
|
3171
|
+
"reactName": "onSgdsValid"
|
|
3159
3172
|
}
|
|
3160
3173
|
],
|
|
3161
3174
|
"attributes": [
|
|
@@ -3212,6 +3225,15 @@
|
|
|
3212
3225
|
"description": "Makes the checkbox group a required field. Only available for when multiselect is true",
|
|
3213
3226
|
"fieldName": "required"
|
|
3214
3227
|
},
|
|
3228
|
+
{
|
|
3229
|
+
"name": "noValidate",
|
|
3230
|
+
"type": {
|
|
3231
|
+
"text": "boolean"
|
|
3232
|
+
},
|
|
3233
|
+
"default": "false",
|
|
3234
|
+
"description": "Disables native and sgds validation for the checkbox group.",
|
|
3235
|
+
"fieldName": "noValidate"
|
|
3236
|
+
},
|
|
3215
3237
|
{
|
|
3216
3238
|
"name": "value",
|
|
3217
3239
|
"type": {
|
|
@@ -3346,33 +3368,35 @@
|
|
|
3346
3368
|
},
|
|
3347
3369
|
{
|
|
3348
3370
|
"kind": "field",
|
|
3349
|
-
"name": "
|
|
3371
|
+
"name": "indeterminate",
|
|
3350
3372
|
"type": {
|
|
3351
3373
|
"text": "boolean"
|
|
3352
3374
|
},
|
|
3353
3375
|
"default": "false",
|
|
3354
|
-
"description": "
|
|
3376
|
+
"description": "Marks the checkbox input as indeterminate , with indeterminate logo",
|
|
3377
|
+
"attribute": "indeterminate",
|
|
3378
|
+
"reflects": true
|
|
3355
3379
|
},
|
|
3356
3380
|
{
|
|
3357
3381
|
"kind": "field",
|
|
3358
|
-
"name": "
|
|
3382
|
+
"name": "required",
|
|
3359
3383
|
"type": {
|
|
3360
3384
|
"text": "boolean"
|
|
3361
3385
|
},
|
|
3362
3386
|
"default": "false",
|
|
3363
|
-
"description": "
|
|
3364
|
-
"attribute": "
|
|
3387
|
+
"description": "Makes the checkbox a required field.",
|
|
3388
|
+
"attribute": "required",
|
|
3365
3389
|
"reflects": true
|
|
3366
3390
|
},
|
|
3367
3391
|
{
|
|
3368
3392
|
"kind": "field",
|
|
3369
|
-
"name": "
|
|
3393
|
+
"name": "noValidate",
|
|
3370
3394
|
"type": {
|
|
3371
3395
|
"text": "boolean"
|
|
3372
3396
|
},
|
|
3373
3397
|
"default": "false",
|
|
3374
|
-
"description": "
|
|
3375
|
-
"attribute": "
|
|
3398
|
+
"description": "Disables native and sgds validation for the checkbox.",
|
|
3399
|
+
"attribute": "noValidate",
|
|
3376
3400
|
"reflects": true
|
|
3377
3401
|
},
|
|
3378
3402
|
{
|
|
@@ -3729,6 +3753,16 @@
|
|
|
3729
3753
|
"description": "Emitted when checkbox is unchecked",
|
|
3730
3754
|
"name": "sgds-uncheck",
|
|
3731
3755
|
"reactName": "onSgdsUncheck"
|
|
3756
|
+
},
|
|
3757
|
+
{
|
|
3758
|
+
"description": "Emitted when the checkbox's invalid state is set to true.",
|
|
3759
|
+
"name": "sgds-invalid",
|
|
3760
|
+
"reactName": "onSgdsInvalid"
|
|
3761
|
+
},
|
|
3762
|
+
{
|
|
3763
|
+
"description": "Emitted when the checkbox's invalid state is set to false.",
|
|
3764
|
+
"name": "sgds-valid",
|
|
3765
|
+
"reactName": "onSgdsValid"
|
|
3732
3766
|
}
|
|
3733
3767
|
],
|
|
3734
3768
|
"attributes": [
|
|
@@ -3775,6 +3809,15 @@
|
|
|
3775
3809
|
"description": "Makes the checkbox a required field.",
|
|
3776
3810
|
"fieldName": "required"
|
|
3777
3811
|
},
|
|
3812
|
+
{
|
|
3813
|
+
"name": "noValidate",
|
|
3814
|
+
"type": {
|
|
3815
|
+
"text": "boolean"
|
|
3816
|
+
},
|
|
3817
|
+
"default": "false",
|
|
3818
|
+
"description": "Disables native and sgds validation for the checkbox.",
|
|
3819
|
+
"fieldName": "noValidate"
|
|
3820
|
+
},
|
|
3778
3821
|
{
|
|
3779
3822
|
"name": "invalidFeedback",
|
|
3780
3823
|
"type": {
|
|
@@ -4332,6 +4375,17 @@
|
|
|
4332
4375
|
"attribute": "emptyMenuAsync",
|
|
4333
4376
|
"reflects": true
|
|
4334
4377
|
},
|
|
4378
|
+
{
|
|
4379
|
+
"kind": "field",
|
|
4380
|
+
"name": "scrollBottomOffset",
|
|
4381
|
+
"type": {
|
|
4382
|
+
"text": "number"
|
|
4383
|
+
},
|
|
4384
|
+
"default": "0",
|
|
4385
|
+
"description": "Number of pixels from the bottom of the menu at which the sgds-scroll-end event fires.",
|
|
4386
|
+
"attribute": "scrollBottomOffset",
|
|
4387
|
+
"reflects": true
|
|
4388
|
+
},
|
|
4335
4389
|
{
|
|
4336
4390
|
"kind": "field",
|
|
4337
4391
|
"name": "filterFunction",
|
|
@@ -4388,6 +4442,15 @@
|
|
|
4388
4442
|
"privacy": "protected",
|
|
4389
4443
|
"default": "false"
|
|
4390
4444
|
},
|
|
4445
|
+
{
|
|
4446
|
+
"kind": "field",
|
|
4447
|
+
"name": "isScrollEnd",
|
|
4448
|
+
"type": {
|
|
4449
|
+
"text": "boolean"
|
|
4450
|
+
},
|
|
4451
|
+
"privacy": "protected",
|
|
4452
|
+
"default": "false"
|
|
4453
|
+
},
|
|
4391
4454
|
{
|
|
4392
4455
|
"kind": "method",
|
|
4393
4456
|
"name": "_handleDefaultSlotChange",
|
|
@@ -4555,6 +4618,21 @@
|
|
|
4555
4618
|
"description": "For form reset",
|
|
4556
4619
|
"type": {}
|
|
4557
4620
|
},
|
|
4621
|
+
{
|
|
4622
|
+
"kind": "method",
|
|
4623
|
+
"name": "_handleScroll",
|
|
4624
|
+
"privacy": "private",
|
|
4625
|
+
"parameters": [
|
|
4626
|
+
{
|
|
4627
|
+
"name": "e",
|
|
4628
|
+
"type": {
|
|
4629
|
+
"text": "MouseEvent"
|
|
4630
|
+
}
|
|
4631
|
+
}
|
|
4632
|
+
],
|
|
4633
|
+
"description": "Handles scroll events on the menu. Emits `sgds-scroll-end` once when the\nscroll position reaches within `scrollBottomOffset` pixels of the bottom.\nThe event is suppressed until the user scrolls back up, preventing repeated\nemissions while the menu stays at the bottom.",
|
|
4634
|
+
"type": {}
|
|
4635
|
+
},
|
|
4558
4636
|
{
|
|
4559
4637
|
"kind": "field",
|
|
4560
4638
|
"name": "suffixIconTemplate",
|
|
@@ -4894,6 +4972,45 @@
|
|
|
4894
4972
|
"module": "src/base/select-element.ts"
|
|
4895
4973
|
}
|
|
4896
4974
|
},
|
|
4975
|
+
{
|
|
4976
|
+
"kind": "method",
|
|
4977
|
+
"name": "setValidity",
|
|
4978
|
+
"privacy": "public",
|
|
4979
|
+
"return": {
|
|
4980
|
+
"type": {
|
|
4981
|
+
"text": "void"
|
|
4982
|
+
}
|
|
4983
|
+
},
|
|
4984
|
+
"parameters": [
|
|
4985
|
+
{
|
|
4986
|
+
"name": "flags",
|
|
4987
|
+
"optional": true,
|
|
4988
|
+
"type": {
|
|
4989
|
+
"text": "ValidityStateFlags"
|
|
4990
|
+
}
|
|
4991
|
+
},
|
|
4992
|
+
{
|
|
4993
|
+
"name": "message",
|
|
4994
|
+
"optional": true,
|
|
4995
|
+
"type": {
|
|
4996
|
+
"text": "string"
|
|
4997
|
+
}
|
|
4998
|
+
},
|
|
4999
|
+
{
|
|
5000
|
+
"name": "anchor",
|
|
5001
|
+
"optional": true,
|
|
5002
|
+
"type": {
|
|
5003
|
+
"text": "HTMLElement"
|
|
5004
|
+
}
|
|
5005
|
+
}
|
|
5006
|
+
],
|
|
5007
|
+
"description": "Sets the validity state of the element",
|
|
5008
|
+
"type": {},
|
|
5009
|
+
"inheritedFrom": {
|
|
5010
|
+
"name": "SelectElement",
|
|
5011
|
+
"module": "src/base/select-element.ts"
|
|
5012
|
+
}
|
|
5013
|
+
},
|
|
4897
5014
|
{
|
|
4898
5015
|
"kind": "method",
|
|
4899
5016
|
"name": "checkValidity",
|
|
@@ -5431,6 +5548,11 @@
|
|
|
5431
5548
|
"name": "sgds-valid",
|
|
5432
5549
|
"reactName": "onSgdsValid"
|
|
5433
5550
|
},
|
|
5551
|
+
{
|
|
5552
|
+
"description": "Emitted once when the menu is scrolled to within `scrollBottomOffset` pixels of the bottom. Resets when the user scrolls back up.",
|
|
5553
|
+
"name": "sgds-scroll-end",
|
|
5554
|
+
"reactName": "onSgdsScrollEnd"
|
|
5555
|
+
},
|
|
5434
5556
|
{
|
|
5435
5557
|
"description": "Emitted event when show instance is called",
|
|
5436
5558
|
"name": "sgds-show",
|
|
@@ -5523,6 +5645,15 @@
|
|
|
5523
5645
|
"description": "When filtering remotely and there are no results, set this to true to enable no options feedback on the menu. Applicable for async combo box only.",
|
|
5524
5646
|
"fieldName": "emptyMenuAsync"
|
|
5525
5647
|
},
|
|
5648
|
+
{
|
|
5649
|
+
"name": "scrollBottomOffset",
|
|
5650
|
+
"type": {
|
|
5651
|
+
"text": "number"
|
|
5652
|
+
},
|
|
5653
|
+
"default": "0",
|
|
5654
|
+
"description": "Number of pixels from the bottom of the menu at which the sgds-scroll-end event fires.",
|
|
5655
|
+
"fieldName": "scrollBottomOffset"
|
|
5656
|
+
},
|
|
5526
5657
|
{
|
|
5527
5658
|
"name": "filterFunction",
|
|
5528
5659
|
"type": {
|
|
@@ -7501,10 +7632,9 @@
|
|
|
7501
7632
|
"type": {
|
|
7502
7633
|
"text": "string"
|
|
7503
7634
|
},
|
|
7504
|
-
"default": "\"\"",
|
|
7635
|
+
"default": "\"Drawer\"",
|
|
7505
7636
|
"description": "The accessible label for the drawer dialog. This is required for assistive technology.",
|
|
7506
|
-
"attribute": "ariaLabel"
|
|
7507
|
-
"reflects": true
|
|
7637
|
+
"attribute": "ariaLabel"
|
|
7508
7638
|
},
|
|
7509
7639
|
{
|
|
7510
7640
|
"kind": "field",
|
|
@@ -7710,7 +7840,7 @@
|
|
|
7710
7840
|
"type": {
|
|
7711
7841
|
"text": "string"
|
|
7712
7842
|
},
|
|
7713
|
-
"default": "\"\"",
|
|
7843
|
+
"default": "\"Drawer\"",
|
|
7714
7844
|
"description": "The accessible label for the drawer dialog. This is required for assistive technology.",
|
|
7715
7845
|
"fieldName": "ariaLabel"
|
|
7716
7846
|
},
|
|
@@ -12911,6 +13041,15 @@
|
|
|
12911
13041
|
"attribute": "disabled",
|
|
12912
13042
|
"reflects": true
|
|
12913
13043
|
},
|
|
13044
|
+
{
|
|
13045
|
+
"kind": "field",
|
|
13046
|
+
"name": "ariaLabel",
|
|
13047
|
+
"type": {
|
|
13048
|
+
"text": "string"
|
|
13049
|
+
},
|
|
13050
|
+
"description": "Accessible label for the dropdown's toggle button. Forwarded to the button's aria-label attribute.",
|
|
13051
|
+
"attribute": "ariaLabel"
|
|
13052
|
+
},
|
|
12914
13053
|
{
|
|
12915
13054
|
"kind": "method",
|
|
12916
13055
|
"name": "_handleSlotChange",
|
|
@@ -13095,6 +13234,14 @@
|
|
|
13095
13234
|
"default": "false",
|
|
13096
13235
|
"description": "When true, applies active styles on the dropdown button",
|
|
13097
13236
|
"fieldName": "disabled"
|
|
13237
|
+
},
|
|
13238
|
+
{
|
|
13239
|
+
"name": "ariaLabel",
|
|
13240
|
+
"type": {
|
|
13241
|
+
"text": "string"
|
|
13242
|
+
},
|
|
13243
|
+
"description": "Accessible label for the dropdown's toggle button. Forwarded to the button's aria-label attribute.",
|
|
13244
|
+
"fieldName": "ariaLabel"
|
|
13098
13245
|
}
|
|
13099
13246
|
],
|
|
13100
13247
|
"superclass": {
|
|
@@ -15611,6 +15758,17 @@
|
|
|
15611
15758
|
"attribute": "required",
|
|
15612
15759
|
"reflects": true
|
|
15613
15760
|
},
|
|
15761
|
+
{
|
|
15762
|
+
"kind": "field",
|
|
15763
|
+
"name": "noValidate",
|
|
15764
|
+
"type": {
|
|
15765
|
+
"text": "boolean"
|
|
15766
|
+
},
|
|
15767
|
+
"default": "false",
|
|
15768
|
+
"description": "Disables native and sgds validation for the radio group.",
|
|
15769
|
+
"attribute": "noValidate",
|
|
15770
|
+
"reflects": true
|
|
15771
|
+
},
|
|
15614
15772
|
{
|
|
15615
15773
|
"kind": "field",
|
|
15616
15774
|
"name": "autofocus",
|
|
@@ -15945,6 +16103,16 @@
|
|
|
15945
16103
|
"name": "sgds-change",
|
|
15946
16104
|
"detailType": "ISgdsRadioGroupChangeEventDetail",
|
|
15947
16105
|
"reactName": "onSgdsChange"
|
|
16106
|
+
},
|
|
16107
|
+
{
|
|
16108
|
+
"description": "Emitted when the radio group's invalid state is set to true.",
|
|
16109
|
+
"name": "sgds-invalid",
|
|
16110
|
+
"reactName": "onSgdsInvalid"
|
|
16111
|
+
},
|
|
16112
|
+
{
|
|
16113
|
+
"description": "Emitted when the radio group's invalid state is set to false.",
|
|
16114
|
+
"name": "sgds-valid",
|
|
16115
|
+
"reactName": "onSgdsValid"
|
|
15948
16116
|
}
|
|
15949
16117
|
],
|
|
15950
16118
|
"attributes": [
|
|
@@ -15984,6 +16152,15 @@
|
|
|
15984
16152
|
"description": "Makes the input as a required field.",
|
|
15985
16153
|
"fieldName": "required"
|
|
15986
16154
|
},
|
|
16155
|
+
{
|
|
16156
|
+
"name": "noValidate",
|
|
16157
|
+
"type": {
|
|
16158
|
+
"text": "boolean"
|
|
16159
|
+
},
|
|
16160
|
+
"default": "false",
|
|
16161
|
+
"description": "Disables native and sgds validation for the radio group.",
|
|
16162
|
+
"fieldName": "noValidate"
|
|
16163
|
+
},
|
|
15987
16164
|
{
|
|
15988
16165
|
"name": "autofocus",
|
|
15989
16166
|
"type": {
|
|
@@ -16571,6 +16748,17 @@
|
|
|
16571
16748
|
"module": "src/base/select-element.ts"
|
|
16572
16749
|
}
|
|
16573
16750
|
},
|
|
16751
|
+
{
|
|
16752
|
+
"kind": "field",
|
|
16753
|
+
"name": "noValidate",
|
|
16754
|
+
"type": {
|
|
16755
|
+
"text": "boolean"
|
|
16756
|
+
},
|
|
16757
|
+
"default": "false",
|
|
16758
|
+
"description": "Disables native and sgds validation for the select.",
|
|
16759
|
+
"attribute": "noValidate",
|
|
16760
|
+
"reflects": true
|
|
16761
|
+
},
|
|
16574
16762
|
{
|
|
16575
16763
|
"kind": "field",
|
|
16576
16764
|
"name": "options",
|
|
@@ -16968,6 +17156,45 @@
|
|
|
16968
17156
|
"module": "src/base/select-element.ts"
|
|
16969
17157
|
}
|
|
16970
17158
|
},
|
|
17159
|
+
{
|
|
17160
|
+
"kind": "method",
|
|
17161
|
+
"name": "setValidity",
|
|
17162
|
+
"privacy": "public",
|
|
17163
|
+
"return": {
|
|
17164
|
+
"type": {
|
|
17165
|
+
"text": "void"
|
|
17166
|
+
}
|
|
17167
|
+
},
|
|
17168
|
+
"parameters": [
|
|
17169
|
+
{
|
|
17170
|
+
"name": "flags",
|
|
17171
|
+
"optional": true,
|
|
17172
|
+
"type": {
|
|
17173
|
+
"text": "ValidityStateFlags"
|
|
17174
|
+
}
|
|
17175
|
+
},
|
|
17176
|
+
{
|
|
17177
|
+
"name": "message",
|
|
17178
|
+
"optional": true,
|
|
17179
|
+
"type": {
|
|
17180
|
+
"text": "string"
|
|
17181
|
+
}
|
|
17182
|
+
},
|
|
17183
|
+
{
|
|
17184
|
+
"name": "anchor",
|
|
17185
|
+
"optional": true,
|
|
17186
|
+
"type": {
|
|
17187
|
+
"text": "HTMLElement"
|
|
17188
|
+
}
|
|
17189
|
+
}
|
|
17190
|
+
],
|
|
17191
|
+
"description": "Sets the validity state of the element",
|
|
17192
|
+
"type": {},
|
|
17193
|
+
"inheritedFrom": {
|
|
17194
|
+
"name": "SelectElement",
|
|
17195
|
+
"module": "src/base/select-element.ts"
|
|
17196
|
+
}
|
|
17197
|
+
},
|
|
16971
17198
|
{
|
|
16972
17199
|
"kind": "method",
|
|
16973
17200
|
"name": "checkValidity",
|
|
@@ -17489,6 +17716,16 @@
|
|
|
17489
17716
|
"name": "sgds-blur",
|
|
17490
17717
|
"reactName": "onSgdsBlur"
|
|
17491
17718
|
},
|
|
17719
|
+
{
|
|
17720
|
+
"description": "Emitted when the select's invalid state is set to true.",
|
|
17721
|
+
"name": "sgds-invalid",
|
|
17722
|
+
"reactName": "onSgdsInvalid"
|
|
17723
|
+
},
|
|
17724
|
+
{
|
|
17725
|
+
"description": "Emitted when the select's invalid state is set to false.",
|
|
17726
|
+
"name": "sgds-valid",
|
|
17727
|
+
"reactName": "onSgdsValid"
|
|
17728
|
+
},
|
|
17492
17729
|
{
|
|
17493
17730
|
"description": "Emitted event when show instance is called",
|
|
17494
17731
|
"name": "sgds-show",
|
|
@@ -17526,14 +17763,16 @@
|
|
|
17526
17763
|
}
|
|
17527
17764
|
}
|
|
17528
17765
|
],
|
|
17529
|
-
"superclass": {
|
|
17530
|
-
"name": "SelectElement",
|
|
17531
|
-
"module": "/src/base/select-element"
|
|
17532
|
-
},
|
|
17533
|
-
"summary": "Select is used to make one selection from a list through keyboard or mouse actions",
|
|
17534
|
-
"tagName": "sgds-select",
|
|
17535
|
-
"customElement": true,
|
|
17536
17766
|
"attributes": [
|
|
17767
|
+
{
|
|
17768
|
+
"name": "noValidate",
|
|
17769
|
+
"type": {
|
|
17770
|
+
"text": "boolean"
|
|
17771
|
+
},
|
|
17772
|
+
"default": "false",
|
|
17773
|
+
"description": "Disables native and sgds validation for the select.",
|
|
17774
|
+
"fieldName": "noValidate"
|
|
17775
|
+
},
|
|
17537
17776
|
{
|
|
17538
17777
|
"name": "label",
|
|
17539
17778
|
"type": {
|
|
@@ -17767,6 +18006,13 @@
|
|
|
17767
18006
|
}
|
|
17768
18007
|
}
|
|
17769
18008
|
],
|
|
18009
|
+
"superclass": {
|
|
18010
|
+
"name": "SelectElement",
|
|
18011
|
+
"module": "/src/base/select-element"
|
|
18012
|
+
},
|
|
18013
|
+
"summary": "Select is used to make one selection from a list through keyboard or mouse actions",
|
|
18014
|
+
"tagName": "sgds-select",
|
|
18015
|
+
"customElement": true,
|
|
17770
18016
|
"modulePath": "src/components/Select/sgds-select.ts",
|
|
17771
18017
|
"cssProperties": [],
|
|
17772
18018
|
"cssParts": [],
|
|
@@ -26937,6 +27183,41 @@
|
|
|
26937
27183
|
"description": "Checks for validity. Under the hood, HTMLFormElement's reportValidity method calls this method to check for component's validity state\nNote that the native error popup is prevented for SGDS form components by default. Instead the validation message shows up in the feedback container of SgdsInput",
|
|
26938
27184
|
"type": {}
|
|
26939
27185
|
},
|
|
27186
|
+
{
|
|
27187
|
+
"kind": "method",
|
|
27188
|
+
"name": "setValidity",
|
|
27189
|
+
"privacy": "public",
|
|
27190
|
+
"return": {
|
|
27191
|
+
"type": {
|
|
27192
|
+
"text": "void"
|
|
27193
|
+
}
|
|
27194
|
+
},
|
|
27195
|
+
"parameters": [
|
|
27196
|
+
{
|
|
27197
|
+
"name": "flags",
|
|
27198
|
+
"optional": true,
|
|
27199
|
+
"type": {
|
|
27200
|
+
"text": "ValidityStateFlags"
|
|
27201
|
+
}
|
|
27202
|
+
},
|
|
27203
|
+
{
|
|
27204
|
+
"name": "message",
|
|
27205
|
+
"optional": true,
|
|
27206
|
+
"type": {
|
|
27207
|
+
"text": "string"
|
|
27208
|
+
}
|
|
27209
|
+
},
|
|
27210
|
+
{
|
|
27211
|
+
"name": "anchor",
|
|
27212
|
+
"optional": true,
|
|
27213
|
+
"type": {
|
|
27214
|
+
"text": "HTMLElement"
|
|
27215
|
+
}
|
|
27216
|
+
}
|
|
27217
|
+
],
|
|
27218
|
+
"description": "Sets the validity state of the element",
|
|
27219
|
+
"type": {}
|
|
27220
|
+
},
|
|
26940
27221
|
{
|
|
26941
27222
|
"kind": "method",
|
|
26942
27223
|
"name": "checkValidity",
|
|
@@ -27670,7 +27951,7 @@
|
|
|
27670
27951
|
"package": {
|
|
27671
27952
|
"name": "@govtechsg/sgds-web-component",
|
|
27672
27953
|
"description": "",
|
|
27673
|
-
"version": "3.23.0-rc.
|
|
27954
|
+
"version": "3.23.0-rc.2",
|
|
27674
27955
|
"author": "GovTechSG",
|
|
27675
27956
|
"license": "MIT"
|
|
27676
27957
|
}
|