@momentum-design/components 0.56.1 → 0.57.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +201 -179
- package/dist/browser/index.js.map +4 -4
- package/dist/components/link/link.component.d.ts +7 -59
- package/dist/components/link/link.component.js +7 -109
- package/dist/components/link/link.constants.d.ts +0 -2
- package/dist/components/link/link.constants.js +0 -2
- package/dist/components/link/link.styles.d.ts +2 -2
- package/dist/components/link/link.styles.js +4 -57
- package/dist/components/linksimple/index.d.ts +7 -0
- package/dist/components/linksimple/index.js +4 -0
- package/dist/components/linksimple/linksimple.component.d.ts +73 -0
- package/dist/components/linksimple/linksimple.component.js +141 -0
- package/dist/components/linksimple/linksimple.constants.d.ts +6 -0
- package/dist/components/linksimple/linksimple.constants.js +7 -0
- package/dist/components/linksimple/linksimple.styles.d.ts +2 -0
- package/dist/components/linksimple/linksimple.styles.js +72 -0
- package/dist/components/linksimple/linksimple.types.d.ts +7 -0
- package/dist/components/linksimple/linksimple.types.js +1 -0
- package/dist/components/popover/popover.styles.js +4 -1
- package/dist/components/select/select.styles.js +1 -0
- package/dist/custom-elements.json +1241 -881
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +2 -1
- package/dist/react/index.js +2 -1
- package/dist/react/link/index.d.ts +4 -16
- package/dist/react/link/index.js +4 -16
- package/dist/react/linksimple/index.d.ts +34 -0
- package/dist/react/linksimple/index.js +42 -0
- package/package.json +1 -1
@@ -1437,327 +1437,6 @@
|
|
1437
1437
|
}
|
1438
1438
|
]
|
1439
1439
|
},
|
1440
|
-
{
|
1441
|
-
"kind": "javascript-module",
|
1442
|
-
"path": "components/badge/badge.component.js",
|
1443
|
-
"declarations": [
|
1444
|
-
{
|
1445
|
-
"kind": "class",
|
1446
|
-
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
1447
|
-
"name": "Badge",
|
1448
|
-
"cssProperties": [
|
1449
|
-
{
|
1450
|
-
"description": "The foreground color of the primary badge.",
|
1451
|
-
"name": "--mdc-badge-primary-foreground-color"
|
1452
|
-
},
|
1453
|
-
{
|
1454
|
-
"description": "The background color of the primary badge.",
|
1455
|
-
"name": "--mdc-badge-primary-background-color"
|
1456
|
-
},
|
1457
|
-
{
|
1458
|
-
"description": "The foreground color of the secondary badge.",
|
1459
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
1460
|
-
},
|
1461
|
-
{
|
1462
|
-
"description": "The background color of the secondary badge.",
|
1463
|
-
"name": "--mdc-badge-secondary-background-color"
|
1464
|
-
},
|
1465
|
-
{
|
1466
|
-
"description": "The foreground color of the success badge.",
|
1467
|
-
"name": "--mdc-badge-success-foreground-color"
|
1468
|
-
},
|
1469
|
-
{
|
1470
|
-
"description": "The background color of the success badge.",
|
1471
|
-
"name": "--mdc-badge-success-background-color"
|
1472
|
-
},
|
1473
|
-
{
|
1474
|
-
"description": "The foreground color of the warning badge.",
|
1475
|
-
"name": "--mdc-badge-warning-foreground-color"
|
1476
|
-
},
|
1477
|
-
{
|
1478
|
-
"description": "The background color of the warning badge.",
|
1479
|
-
"name": "--mdc-badge-warning-background-color"
|
1480
|
-
},
|
1481
|
-
{
|
1482
|
-
"description": "The foreground color of the error badge.",
|
1483
|
-
"name": "--mdc-badge-error-foreground-color"
|
1484
|
-
},
|
1485
|
-
{
|
1486
|
-
"description": "The background color of the error badge.",
|
1487
|
-
"name": "--mdc-badge-error-background-color"
|
1488
|
-
},
|
1489
|
-
{
|
1490
|
-
"description": "The background color of the badge overlay.",
|
1491
|
-
"name": "--mdc-badge-overlay-background-color"
|
1492
|
-
}
|
1493
|
-
],
|
1494
|
-
"members": [
|
1495
|
-
{
|
1496
|
-
"kind": "field",
|
1497
|
-
"name": "type",
|
1498
|
-
"type": {
|
1499
|
-
"text": "BadgeType | undefined"
|
1500
|
-
},
|
1501
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1502
|
-
"attribute": "type",
|
1503
|
-
"reflects": true
|
1504
|
-
},
|
1505
|
-
{
|
1506
|
-
"kind": "field",
|
1507
|
-
"name": "variant",
|
1508
|
-
"type": {
|
1509
|
-
"text": "IconVariant"
|
1510
|
-
},
|
1511
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1512
|
-
"default": "primary",
|
1513
|
-
"attribute": "variant",
|
1514
|
-
"reflects": true
|
1515
|
-
},
|
1516
|
-
{
|
1517
|
-
"kind": "field",
|
1518
|
-
"name": "counter",
|
1519
|
-
"type": {
|
1520
|
-
"text": "number | undefined"
|
1521
|
-
},
|
1522
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1523
|
-
"attribute": "counter"
|
1524
|
-
},
|
1525
|
-
{
|
1526
|
-
"kind": "field",
|
1527
|
-
"name": "maxCounter",
|
1528
|
-
"type": {
|
1529
|
-
"text": "number"
|
1530
|
-
},
|
1531
|
-
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1532
|
-
"default": "99",
|
1533
|
-
"attribute": "max-counter",
|
1534
|
-
"reflects": true
|
1535
|
-
},
|
1536
|
-
{
|
1537
|
-
"kind": "field",
|
1538
|
-
"name": "overlay",
|
1539
|
-
"type": {
|
1540
|
-
"text": "boolean"
|
1541
|
-
},
|
1542
|
-
"default": "false",
|
1543
|
-
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1544
|
-
"attribute": "overlay"
|
1545
|
-
},
|
1546
|
-
{
|
1547
|
-
"kind": "field",
|
1548
|
-
"name": "ariaLabel",
|
1549
|
-
"type": {
|
1550
|
-
"text": "string | null"
|
1551
|
-
},
|
1552
|
-
"default": "null",
|
1553
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1554
|
-
"attribute": "aria-label"
|
1555
|
-
},
|
1556
|
-
{
|
1557
|
-
"kind": "method",
|
1558
|
-
"name": "getCounterText",
|
1559
|
-
"privacy": "private",
|
1560
|
-
"return": {
|
1561
|
-
"type": {
|
1562
|
-
"text": ""
|
1563
|
-
}
|
1564
|
-
},
|
1565
|
-
"parameters": [
|
1566
|
-
{
|
1567
|
-
"name": "maxCounter",
|
1568
|
-
"type": {
|
1569
|
-
"text": "number"
|
1570
|
-
},
|
1571
|
-
"description": "the maximum limit which can be displayed on the badge"
|
1572
|
-
},
|
1573
|
-
{
|
1574
|
-
"name": "counter",
|
1575
|
-
"optional": true,
|
1576
|
-
"type": {
|
1577
|
-
"text": "number"
|
1578
|
-
},
|
1579
|
-
"description": "the number to be displayed on the badge"
|
1580
|
-
}
|
1581
|
-
],
|
1582
|
-
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
1583
|
-
},
|
1584
|
-
{
|
1585
|
-
"kind": "method",
|
1586
|
-
"name": "getBadgeIcon",
|
1587
|
-
"privacy": "private",
|
1588
|
-
"return": {
|
1589
|
-
"type": {
|
1590
|
-
"text": ""
|
1591
|
-
}
|
1592
|
-
},
|
1593
|
-
"parameters": [
|
1594
|
-
{
|
1595
|
-
"name": "iconName",
|
1596
|
-
"type": {
|
1597
|
-
"text": "string"
|
1598
|
-
},
|
1599
|
-
"description": "the name of the icon from the icon set"
|
1600
|
-
},
|
1601
|
-
{
|
1602
|
-
"name": "backgroundClassPostfix",
|
1603
|
-
"type": {
|
1604
|
-
"text": "string"
|
1605
|
-
},
|
1606
|
-
"description": "postfix for the class to style the badge icon."
|
1607
|
-
}
|
1608
|
-
],
|
1609
|
-
"description": "Method to generate the badge icon."
|
1610
|
-
},
|
1611
|
-
{
|
1612
|
-
"kind": "method",
|
1613
|
-
"name": "getBadgeDot",
|
1614
|
-
"privacy": "private",
|
1615
|
-
"return": {
|
1616
|
-
"type": {
|
1617
|
-
"text": ""
|
1618
|
-
}
|
1619
|
-
},
|
1620
|
-
"description": "Method to generate the badge dot template."
|
1621
|
-
},
|
1622
|
-
{
|
1623
|
-
"kind": "method",
|
1624
|
-
"name": "getBadgeCounterText",
|
1625
|
-
"privacy": "private",
|
1626
|
-
"return": {
|
1627
|
-
"type": {
|
1628
|
-
"text": ""
|
1629
|
-
}
|
1630
|
-
},
|
1631
|
-
"description": "Method to generate the badge text and counter template."
|
1632
|
-
},
|
1633
|
-
{
|
1634
|
-
"kind": "method",
|
1635
|
-
"name": "setRoleByAriaLabel",
|
1636
|
-
"privacy": "private",
|
1637
|
-
"return": {
|
1638
|
-
"type": {
|
1639
|
-
"text": "void"
|
1640
|
-
}
|
1641
|
-
},
|
1642
|
-
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
1643
|
-
},
|
1644
|
-
{
|
1645
|
-
"kind": "method",
|
1646
|
-
"name": "getBadgeContentBasedOnType",
|
1647
|
-
"privacy": "private",
|
1648
|
-
"return": {
|
1649
|
-
"type": {
|
1650
|
-
"text": ""
|
1651
|
-
}
|
1652
|
-
},
|
1653
|
-
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
1654
|
-
},
|
1655
|
-
{
|
1656
|
-
"kind": "field",
|
1657
|
-
"name": "iconName",
|
1658
|
-
"type": {
|
1659
|
-
"text": "IconNames | undefined"
|
1660
|
-
},
|
1661
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1662
|
-
"attribute": "icon-name",
|
1663
|
-
"inheritedFrom": {
|
1664
|
-
"name": "IconNameMixin",
|
1665
|
-
"module": "utils/mixins/IconNameMixin.js"
|
1666
|
-
}
|
1667
|
-
}
|
1668
|
-
],
|
1669
|
-
"attributes": [
|
1670
|
-
{
|
1671
|
-
"name": "type",
|
1672
|
-
"type": {
|
1673
|
-
"text": "BadgeType | undefined"
|
1674
|
-
},
|
1675
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1676
|
-
"fieldName": "type"
|
1677
|
-
},
|
1678
|
-
{
|
1679
|
-
"name": "variant",
|
1680
|
-
"type": {
|
1681
|
-
"text": "IconVariant"
|
1682
|
-
},
|
1683
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1684
|
-
"default": "primary",
|
1685
|
-
"fieldName": "variant"
|
1686
|
-
},
|
1687
|
-
{
|
1688
|
-
"name": "counter",
|
1689
|
-
"type": {
|
1690
|
-
"text": "number | undefined"
|
1691
|
-
},
|
1692
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1693
|
-
"fieldName": "counter"
|
1694
|
-
},
|
1695
|
-
{
|
1696
|
-
"name": "max-counter",
|
1697
|
-
"type": {
|
1698
|
-
"text": "number"
|
1699
|
-
},
|
1700
|
-
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
1701
|
-
"default": "99",
|
1702
|
-
"fieldName": "maxCounter"
|
1703
|
-
},
|
1704
|
-
{
|
1705
|
-
"name": "overlay",
|
1706
|
-
"type": {
|
1707
|
-
"text": "boolean"
|
1708
|
-
},
|
1709
|
-
"default": "false",
|
1710
|
-
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
1711
|
-
"fieldName": "overlay"
|
1712
|
-
},
|
1713
|
-
{
|
1714
|
-
"name": "aria-label",
|
1715
|
-
"type": {
|
1716
|
-
"text": "string | null"
|
1717
|
-
},
|
1718
|
-
"default": "null",
|
1719
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1720
|
-
"fieldName": "ariaLabel"
|
1721
|
-
},
|
1722
|
-
{
|
1723
|
-
"name": "icon-name",
|
1724
|
-
"type": {
|
1725
|
-
"text": "IconNames | undefined"
|
1726
|
-
},
|
1727
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1728
|
-
"fieldName": "iconName",
|
1729
|
-
"inheritedFrom": {
|
1730
|
-
"name": "IconNameMixin",
|
1731
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
1732
|
-
}
|
1733
|
-
}
|
1734
|
-
],
|
1735
|
-
"mixins": [
|
1736
|
-
{
|
1737
|
-
"name": "IconNameMixin",
|
1738
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
1739
|
-
}
|
1740
|
-
],
|
1741
|
-
"superclass": {
|
1742
|
-
"name": "Component",
|
1743
|
-
"module": "/src/models"
|
1744
|
-
},
|
1745
|
-
"tagName": "mdc-badge",
|
1746
|
-
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
1747
|
-
"customElement": true
|
1748
|
-
}
|
1749
|
-
],
|
1750
|
-
"exports": [
|
1751
|
-
{
|
1752
|
-
"kind": "js",
|
1753
|
-
"name": "default",
|
1754
|
-
"declaration": {
|
1755
|
-
"name": "Badge",
|
1756
|
-
"module": "components/badge/badge.component.js"
|
1757
|
-
}
|
1758
|
-
}
|
1759
|
-
]
|
1760
|
-
},
|
1761
1440
|
{
|
1762
1441
|
"kind": "javascript-module",
|
1763
1442
|
"path": "components/brandvisual/brandvisual.component.js",
|
@@ -1950,43 +1629,215 @@
|
|
1950
1629
|
"members": [
|
1951
1630
|
{
|
1952
1631
|
"kind": "field",
|
1953
|
-
"name": "prefixIcon",
|
1632
|
+
"name": "prefixIcon",
|
1633
|
+
"type": {
|
1634
|
+
"text": "IconNames | undefined"
|
1635
|
+
},
|
1636
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1637
|
+
"attribute": "prefix-icon",
|
1638
|
+
"reflects": true
|
1639
|
+
},
|
1640
|
+
{
|
1641
|
+
"kind": "field",
|
1642
|
+
"name": "postfixIcon",
|
1643
|
+
"type": {
|
1644
|
+
"text": "IconNames | undefined"
|
1645
|
+
},
|
1646
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1647
|
+
"attribute": "postfix-icon",
|
1648
|
+
"reflects": true
|
1649
|
+
},
|
1650
|
+
{
|
1651
|
+
"kind": "field",
|
1652
|
+
"name": "variant",
|
1653
|
+
"type": {
|
1654
|
+
"text": "ButtonVariant"
|
1655
|
+
},
|
1656
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
1657
|
+
"default": "primary",
|
1658
|
+
"attribute": "variant"
|
1659
|
+
},
|
1660
|
+
{
|
1661
|
+
"kind": "field",
|
1662
|
+
"name": "size",
|
1663
|
+
"type": {
|
1664
|
+
"text": "ButtonSize"
|
1665
|
+
},
|
1666
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1667
|
+
"default": "32",
|
1668
|
+
"attribute": "size",
|
1669
|
+
"reflects": true,
|
1670
|
+
"inheritedFrom": {
|
1671
|
+
"name": "Buttonsimple",
|
1672
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1673
|
+
}
|
1674
|
+
},
|
1675
|
+
{
|
1676
|
+
"kind": "field",
|
1677
|
+
"name": "color",
|
1678
|
+
"type": {
|
1679
|
+
"text": "ButtonColor"
|
1680
|
+
},
|
1681
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1682
|
+
"default": "default",
|
1683
|
+
"attribute": "color"
|
1684
|
+
},
|
1685
|
+
{
|
1686
|
+
"kind": "field",
|
1687
|
+
"name": "role",
|
1688
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
1689
|
+
"default": "'button'",
|
1690
|
+
"attribute": "role",
|
1691
|
+
"reflects": true,
|
1692
|
+
"type": {
|
1693
|
+
"text": "string"
|
1694
|
+
},
|
1695
|
+
"inheritedFrom": {
|
1696
|
+
"name": "Buttonsimple",
|
1697
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1698
|
+
}
|
1699
|
+
},
|
1700
|
+
{
|
1701
|
+
"kind": "method",
|
1702
|
+
"name": "inferFilledIconName",
|
1703
|
+
"privacy": "private",
|
1704
|
+
"parameters": [
|
1705
|
+
{
|
1706
|
+
"name": "active",
|
1707
|
+
"optional": true,
|
1708
|
+
"type": {
|
1709
|
+
"text": "boolean"
|
1710
|
+
},
|
1711
|
+
"description": "The active state."
|
1712
|
+
}
|
1713
|
+
],
|
1714
|
+
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
1715
|
+
},
|
1716
|
+
{
|
1717
|
+
"kind": "method",
|
1718
|
+
"name": "setVariant",
|
1719
|
+
"privacy": "private",
|
1720
|
+
"parameters": [
|
1721
|
+
{
|
1722
|
+
"name": "variant",
|
1723
|
+
"type": {
|
1724
|
+
"text": "ButtonVariant"
|
1725
|
+
},
|
1726
|
+
"description": "The variant to set."
|
1727
|
+
}
|
1728
|
+
],
|
1729
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT."
|
1730
|
+
},
|
1731
|
+
{
|
1732
|
+
"kind": "method",
|
1733
|
+
"name": "setSize",
|
1734
|
+
"privacy": "private",
|
1735
|
+
"parameters": [
|
1736
|
+
{
|
1737
|
+
"name": "size",
|
1738
|
+
"type": {
|
1739
|
+
"text": "PillButtonSize | IconButtonSize"
|
1740
|
+
},
|
1741
|
+
"description": "The size to set."
|
1742
|
+
}
|
1743
|
+
],
|
1744
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid."
|
1745
|
+
},
|
1746
|
+
{
|
1747
|
+
"kind": "method",
|
1748
|
+
"name": "setColor",
|
1749
|
+
"privacy": "private",
|
1750
|
+
"parameters": [
|
1751
|
+
{
|
1752
|
+
"name": "color",
|
1753
|
+
"type": {
|
1754
|
+
"text": "ButtonColor"
|
1755
|
+
},
|
1756
|
+
"description": "The color to set."
|
1757
|
+
}
|
1758
|
+
],
|
1759
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary buttons."
|
1760
|
+
},
|
1761
|
+
{
|
1762
|
+
"kind": "method",
|
1763
|
+
"name": "inferButtonType",
|
1764
|
+
"privacy": "private",
|
1765
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
1766
|
+
"parameters": [
|
1767
|
+
{
|
1768
|
+
"description": "default slot of button",
|
1769
|
+
"name": "slot"
|
1770
|
+
}
|
1771
|
+
]
|
1772
|
+
},
|
1773
|
+
{
|
1774
|
+
"kind": "field",
|
1775
|
+
"name": "tabIndex",
|
1776
|
+
"type": {
|
1777
|
+
"text": "number"
|
1778
|
+
},
|
1779
|
+
"default": "0",
|
1780
|
+
"description": "This property specifies the tab order of the element.",
|
1781
|
+
"attribute": "tabIndex",
|
1782
|
+
"reflects": true,
|
1783
|
+
"inheritedFrom": {
|
1784
|
+
"name": "TabIndexMixin",
|
1785
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1786
|
+
}
|
1787
|
+
},
|
1788
|
+
{
|
1789
|
+
"kind": "field",
|
1790
|
+
"name": "disabled",
|
1954
1791
|
"type": {
|
1955
|
-
"text": "
|
1792
|
+
"text": "boolean | undefined"
|
1956
1793
|
},
|
1957
|
-
"description": "
|
1958
|
-
"
|
1959
|
-
"
|
1794
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1795
|
+
"default": "undefined",
|
1796
|
+
"attribute": "disabled",
|
1797
|
+
"reflects": true,
|
1798
|
+
"inheritedFrom": {
|
1799
|
+
"name": "DisabledMixin",
|
1800
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1801
|
+
}
|
1960
1802
|
},
|
1961
1803
|
{
|
1962
1804
|
"kind": "field",
|
1963
|
-
"name": "
|
1805
|
+
"name": "active",
|
1964
1806
|
"type": {
|
1965
|
-
"text": "
|
1807
|
+
"text": "boolean | undefined"
|
1966
1808
|
},
|
1967
|
-
"description": "The
|
1968
|
-
"
|
1969
|
-
"
|
1809
|
+
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
1810
|
+
"default": "undefined",
|
1811
|
+
"attribute": "active",
|
1812
|
+
"reflects": true,
|
1813
|
+
"inheritedFrom": {
|
1814
|
+
"name": "Buttonsimple",
|
1815
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1816
|
+
}
|
1970
1817
|
},
|
1971
1818
|
{
|
1972
1819
|
"kind": "field",
|
1973
|
-
"name": "
|
1820
|
+
"name": "softDisabled",
|
1974
1821
|
"type": {
|
1975
|
-
"text": "
|
1822
|
+
"text": "boolean | undefined"
|
1976
1823
|
},
|
1977
|
-
"description": "
|
1978
|
-
"default": "
|
1979
|
-
"attribute": "
|
1824
|
+
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
1825
|
+
"default": "undefined",
|
1826
|
+
"attribute": "soft-disabled",
|
1827
|
+
"inheritedFrom": {
|
1828
|
+
"name": "Buttonsimple",
|
1829
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1830
|
+
}
|
1980
1831
|
},
|
1981
1832
|
{
|
1982
1833
|
"kind": "field",
|
1983
|
-
"name": "
|
1834
|
+
"name": "ariaStateKey",
|
1984
1835
|
"type": {
|
1985
|
-
"text": "
|
1836
|
+
"text": "string | undefined"
|
1986
1837
|
},
|
1987
|
-
"description": "
|
1988
|
-
"default": "
|
1989
|
-
"attribute": "
|
1838
|
+
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
1839
|
+
"default": "'aria-pressed' (when)",
|
1840
|
+
"attribute": "ariaStateKey",
|
1990
1841
|
"reflects": true,
|
1991
1842
|
"inheritedFrom": {
|
1992
1843
|
"name": "Buttonsimple",
|
@@ -1995,24 +1846,23 @@
|
|
1995
1846
|
},
|
1996
1847
|
{
|
1997
1848
|
"kind": "field",
|
1998
|
-
"name": "
|
1849
|
+
"name": "type",
|
1999
1850
|
"type": {
|
2000
|
-
"text": "
|
1851
|
+
"text": "ButtonType"
|
2001
1852
|
},
|
2002
|
-
"description": "
|
2003
|
-
"default": "
|
2004
|
-
"attribute": "
|
1853
|
+
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
1854
|
+
"default": "button",
|
1855
|
+
"attribute": "type",
|
1856
|
+
"reflects": true,
|
1857
|
+
"inheritedFrom": {
|
1858
|
+
"name": "Buttonsimple",
|
1859
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1860
|
+
}
|
2005
1861
|
},
|
2006
1862
|
{
|
2007
|
-
"kind": "
|
2008
|
-
"name": "
|
2009
|
-
"
|
2010
|
-
"default": "'button'",
|
2011
|
-
"attribute": "role",
|
2012
|
-
"reflects": true,
|
2013
|
-
"type": {
|
2014
|
-
"text": "string"
|
2015
|
-
},
|
1863
|
+
"kind": "method",
|
1864
|
+
"name": "executeAction",
|
1865
|
+
"privacy": "protected",
|
2016
1866
|
"inheritedFrom": {
|
2017
1867
|
"name": "Buttonsimple",
|
2018
1868
|
"module": "components/buttonsimple/buttonsimple.component.js"
|
@@ -2020,498 +1870,648 @@
|
|
2020
1870
|
},
|
2021
1871
|
{
|
2022
1872
|
"kind": "method",
|
2023
|
-
"name": "
|
2024
|
-
"privacy": "
|
1873
|
+
"name": "setActive",
|
1874
|
+
"privacy": "protected",
|
2025
1875
|
"parameters": [
|
1876
|
+
{
|
1877
|
+
"name": "element",
|
1878
|
+
"type": {
|
1879
|
+
"text": "HTMLElement"
|
1880
|
+
},
|
1881
|
+
"description": "The button element"
|
1882
|
+
},
|
2026
1883
|
{
|
2027
1884
|
"name": "active",
|
2028
1885
|
"optional": true,
|
2029
1886
|
"type": {
|
2030
1887
|
"text": "boolean"
|
2031
1888
|
},
|
2032
|
-
"description": "The active state
|
1889
|
+
"description": "The active state of the element"
|
2033
1890
|
}
|
2034
1891
|
],
|
2035
|
-
"description": "
|
1892
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
1893
|
+
"inheritedFrom": {
|
1894
|
+
"name": "Buttonsimple",
|
1895
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1896
|
+
}
|
2036
1897
|
},
|
2037
1898
|
{
|
2038
1899
|
"kind": "method",
|
2039
|
-
"name": "
|
1900
|
+
"name": "setSoftDisabled",
|
2040
1901
|
"privacy": "private",
|
2041
1902
|
"parameters": [
|
2042
1903
|
{
|
2043
|
-
"name": "
|
1904
|
+
"name": "element",
|
2044
1905
|
"type": {
|
2045
|
-
"text": "
|
1906
|
+
"text": "HTMLElement"
|
2046
1907
|
},
|
2047
|
-
"description": "The
|
1908
|
+
"description": "The button element."
|
1909
|
+
},
|
1910
|
+
{
|
1911
|
+
"name": "softDisabled",
|
1912
|
+
"optional": true,
|
1913
|
+
"type": {
|
1914
|
+
"text": "boolean"
|
1915
|
+
},
|
1916
|
+
"description": "The soft-disabled state."
|
2048
1917
|
}
|
2049
1918
|
],
|
2050
|
-
"description": "Sets the
|
1919
|
+
"description": "Sets the soft-disabled attribute for the button.\nWhen soft-disabled, the button looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute.",
|
1920
|
+
"inheritedFrom": {
|
1921
|
+
"name": "Buttonsimple",
|
1922
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1923
|
+
}
|
2051
1924
|
},
|
2052
1925
|
{
|
2053
1926
|
"kind": "method",
|
2054
|
-
"name": "
|
1927
|
+
"name": "setDisabled",
|
2055
1928
|
"privacy": "private",
|
2056
1929
|
"parameters": [
|
2057
1930
|
{
|
2058
|
-
"name": "
|
1931
|
+
"name": "element",
|
2059
1932
|
"type": {
|
2060
|
-
"text": "
|
1933
|
+
"text": "HTMLElement"
|
2061
1934
|
},
|
2062
|
-
"description": "The
|
1935
|
+
"description": "The button element."
|
1936
|
+
},
|
1937
|
+
{
|
1938
|
+
"name": "disabled",
|
1939
|
+
"type": {
|
1940
|
+
"text": "boolean"
|
1941
|
+
},
|
1942
|
+
"description": "The disabled state."
|
2063
1943
|
}
|
2064
1944
|
],
|
2065
|
-
"description": "Sets the
|
1945
|
+
"description": "Sets the disabled attribute for the button.\nWhen disabled, the button is not focusable or clickable, and tabindex is set to -1.\nThe previous tabindex is stored and restored when enabled.\nAlso sets/removes aria-disabled attribute.",
|
1946
|
+
"inheritedFrom": {
|
1947
|
+
"name": "Buttonsimple",
|
1948
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1949
|
+
}
|
2066
1950
|
},
|
2067
1951
|
{
|
2068
1952
|
"kind": "method",
|
2069
|
-
"name": "
|
1953
|
+
"name": "triggerClickEvent",
|
1954
|
+
"privacy": "private",
|
1955
|
+
"inheritedFrom": {
|
1956
|
+
"name": "Buttonsimple",
|
1957
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1958
|
+
}
|
1959
|
+
},
|
1960
|
+
{
|
1961
|
+
"kind": "method",
|
1962
|
+
"name": "handleBlur",
|
1963
|
+
"privacy": "private",
|
1964
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
1965
|
+
"inheritedFrom": {
|
1966
|
+
"name": "Buttonsimple",
|
1967
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1968
|
+
}
|
1969
|
+
},
|
1970
|
+
{
|
1971
|
+
"kind": "method",
|
1972
|
+
"name": "handleKeyDown",
|
2070
1973
|
"privacy": "private",
|
2071
1974
|
"parameters": [
|
2072
1975
|
{
|
2073
|
-
"name": "
|
1976
|
+
"name": "event",
|
2074
1977
|
"type": {
|
2075
|
-
"text": "
|
1978
|
+
"text": "KeyboardEvent"
|
2076
1979
|
},
|
2077
|
-
"description": "The
|
1980
|
+
"description": "The keyboard event."
|
2078
1981
|
}
|
2079
1982
|
],
|
2080
|
-
"description": "
|
1983
|
+
"description": "Handles the keydown event on the button.\nIf the key is 'Enter' or 'Space', the button is pressed.\nIf the key is 'Enter', the button is pressed. The native HTML button works in the same way.\nIf the key is 'Space', the button's default is prevent to avoid scrolling etc in the host application.",
|
1984
|
+
"inheritedFrom": {
|
1985
|
+
"name": "Buttonsimple",
|
1986
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1987
|
+
}
|
2081
1988
|
},
|
2082
1989
|
{
|
2083
1990
|
"kind": "method",
|
2084
|
-
"name": "
|
1991
|
+
"name": "handleKeyUp",
|
2085
1992
|
"privacy": "private",
|
2086
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2087
1993
|
"parameters": [
|
2088
1994
|
{
|
2089
|
-
"
|
2090
|
-
"
|
1995
|
+
"name": "event",
|
1996
|
+
"type": {
|
1997
|
+
"text": "KeyboardEvent"
|
1998
|
+
},
|
1999
|
+
"description": "The keyboard event."
|
2091
2000
|
}
|
2092
|
-
]
|
2001
|
+
],
|
2002
|
+
"description": "Handles the keyup event on the button.\nIf the key is 'Enter' or 'Space', the button is clicked.\nIf the key is 'Space', the button is pressed. The native HTML button works in the same way.",
|
2003
|
+
"inheritedFrom": {
|
2004
|
+
"name": "Buttonsimple",
|
2005
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2006
|
+
}
|
2007
|
+
}
|
2008
|
+
],
|
2009
|
+
"attributes": [
|
2010
|
+
{
|
2011
|
+
"name": "prefix-icon",
|
2012
|
+
"type": {
|
2013
|
+
"text": "IconNames | undefined"
|
2014
|
+
},
|
2015
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2016
|
+
"fieldName": "prefixIcon"
|
2017
|
+
},
|
2018
|
+
{
|
2019
|
+
"name": "postfix-icon",
|
2020
|
+
"type": {
|
2021
|
+
"text": "IconNames | undefined"
|
2022
|
+
},
|
2023
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2024
|
+
"fieldName": "postfixIcon"
|
2025
|
+
},
|
2026
|
+
{
|
2027
|
+
"name": "variant",
|
2028
|
+
"type": {
|
2029
|
+
"text": "ButtonVariant"
|
2030
|
+
},
|
2031
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2032
|
+
"default": "primary",
|
2033
|
+
"fieldName": "variant"
|
2034
|
+
},
|
2035
|
+
{
|
2036
|
+
"name": "size",
|
2037
|
+
"type": {
|
2038
|
+
"text": "ButtonSize"
|
2039
|
+
},
|
2040
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2041
|
+
"default": "32",
|
2042
|
+
"fieldName": "size",
|
2043
|
+
"inheritedFrom": {
|
2044
|
+
"name": "Buttonsimple",
|
2045
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2046
|
+
}
|
2047
|
+
},
|
2048
|
+
{
|
2049
|
+
"name": "color",
|
2050
|
+
"type": {
|
2051
|
+
"text": "ButtonColor"
|
2052
|
+
},
|
2053
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2054
|
+
"default": "default",
|
2055
|
+
"fieldName": "color"
|
2056
|
+
},
|
2057
|
+
{
|
2058
|
+
"name": "role",
|
2059
|
+
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2060
|
+
"default": "'button'",
|
2061
|
+
"fieldName": "role",
|
2062
|
+
"type": {
|
2063
|
+
"text": "string"
|
2064
|
+
},
|
2065
|
+
"inheritedFrom": {
|
2066
|
+
"name": "Buttonsimple",
|
2067
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2068
|
+
}
|
2093
2069
|
},
|
2094
2070
|
{
|
2095
|
-
"kind": "field",
|
2096
2071
|
"name": "tabIndex",
|
2097
2072
|
"type": {
|
2098
2073
|
"text": "number"
|
2099
2074
|
},
|
2100
2075
|
"default": "0",
|
2101
2076
|
"description": "This property specifies the tab order of the element.",
|
2102
|
-
"
|
2103
|
-
"reflects": true,
|
2077
|
+
"fieldName": "tabIndex",
|
2104
2078
|
"inheritedFrom": {
|
2105
2079
|
"name": "TabIndexMixin",
|
2106
|
-
"module": "utils/mixins/TabIndexMixin.
|
2080
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2107
2081
|
}
|
2108
2082
|
},
|
2109
2083
|
{
|
2110
|
-
"kind": "field",
|
2111
2084
|
"name": "disabled",
|
2112
2085
|
"type": {
|
2113
2086
|
"text": "boolean | undefined"
|
2114
2087
|
},
|
2115
2088
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2116
2089
|
"default": "undefined",
|
2117
|
-
"
|
2118
|
-
"reflects": true,
|
2090
|
+
"fieldName": "disabled",
|
2119
2091
|
"inheritedFrom": {
|
2120
2092
|
"name": "DisabledMixin",
|
2121
|
-
"module": "utils/mixins/DisabledMixin.
|
2093
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2122
2094
|
}
|
2123
2095
|
},
|
2124
2096
|
{
|
2125
|
-
"kind": "field",
|
2126
2097
|
"name": "active",
|
2127
2098
|
"type": {
|
2128
2099
|
"text": "boolean | undefined"
|
2129
2100
|
},
|
2130
2101
|
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2131
2102
|
"default": "undefined",
|
2132
|
-
"
|
2133
|
-
"reflects": true,
|
2103
|
+
"fieldName": "active",
|
2134
2104
|
"inheritedFrom": {
|
2135
2105
|
"name": "Buttonsimple",
|
2136
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2106
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2137
2107
|
}
|
2138
2108
|
},
|
2139
2109
|
{
|
2140
|
-
"
|
2141
|
-
"name": "softDisabled",
|
2110
|
+
"name": "soft-disabled",
|
2142
2111
|
"type": {
|
2143
2112
|
"text": "boolean | undefined"
|
2144
2113
|
},
|
2145
2114
|
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2146
2115
|
"default": "undefined",
|
2147
|
-
"
|
2116
|
+
"fieldName": "softDisabled",
|
2148
2117
|
"inheritedFrom": {
|
2149
2118
|
"name": "Buttonsimple",
|
2150
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2119
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2151
2120
|
}
|
2152
2121
|
},
|
2153
2122
|
{
|
2154
|
-
"kind": "field",
|
2155
2123
|
"name": "ariaStateKey",
|
2156
2124
|
"type": {
|
2157
2125
|
"text": "string | undefined"
|
2158
2126
|
},
|
2159
2127
|
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2160
2128
|
"default": "'aria-pressed' (when)",
|
2161
|
-
"
|
2162
|
-
"reflects": true,
|
2129
|
+
"fieldName": "ariaStateKey",
|
2163
2130
|
"inheritedFrom": {
|
2164
2131
|
"name": "Buttonsimple",
|
2165
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2132
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2166
2133
|
}
|
2167
2134
|
},
|
2168
2135
|
{
|
2169
|
-
"kind": "field",
|
2170
2136
|
"name": "type",
|
2171
2137
|
"type": {
|
2172
2138
|
"text": "ButtonType"
|
2173
2139
|
},
|
2174
2140
|
"description": "This property defines the type attribute for the button element.\nThe type attribute specifies the behavior of the button when it is clicked.\n- **submit**: The button submits the form data to the server.\n- **reset**: The button resets the form data to its initial state.\n- **button**: The button does nothing when clicked.",
|
2175
2141
|
"default": "button",
|
2176
|
-
"
|
2177
|
-
"reflects": true,
|
2142
|
+
"fieldName": "type",
|
2178
2143
|
"inheritedFrom": {
|
2179
2144
|
"name": "Buttonsimple",
|
2180
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2145
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2146
|
+
}
|
2147
|
+
}
|
2148
|
+
],
|
2149
|
+
"superclass": {
|
2150
|
+
"name": "Buttonsimple",
|
2151
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2152
|
+
},
|
2153
|
+
"tagName": "mdc-button",
|
2154
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2155
|
+
"customElement": true,
|
2156
|
+
"events": [
|
2157
|
+
{
|
2158
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2159
|
+
"name": "click",
|
2160
|
+
"reactName": "onClick",
|
2161
|
+
"inheritedFrom": {
|
2162
|
+
"name": "Buttonsimple",
|
2163
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2181
2164
|
}
|
2182
2165
|
},
|
2183
2166
|
{
|
2184
|
-
"
|
2185
|
-
"name": "
|
2186
|
-
"
|
2167
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2168
|
+
"name": "keydown",
|
2169
|
+
"reactName": "onKeyDown",
|
2187
2170
|
"inheritedFrom": {
|
2188
2171
|
"name": "Buttonsimple",
|
2189
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2172
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2190
2173
|
}
|
2191
2174
|
},
|
2192
2175
|
{
|
2193
|
-
"
|
2194
|
-
"name": "
|
2195
|
-
"
|
2196
|
-
"parameters": [
|
2197
|
-
{
|
2198
|
-
"name": "element",
|
2199
|
-
"type": {
|
2200
|
-
"text": "HTMLElement"
|
2201
|
-
},
|
2202
|
-
"description": "The button element"
|
2203
|
-
},
|
2204
|
-
{
|
2205
|
-
"name": "active",
|
2206
|
-
"optional": true,
|
2207
|
-
"type": {
|
2208
|
-
"text": "boolean"
|
2209
|
-
},
|
2210
|
-
"description": "The active state of the element"
|
2211
|
-
}
|
2212
|
-
],
|
2213
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2176
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2177
|
+
"name": "keyup",
|
2178
|
+
"reactName": "onKeyUp",
|
2214
2179
|
"inheritedFrom": {
|
2215
2180
|
"name": "Buttonsimple",
|
2216
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2181
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2182
|
+
}
|
2183
|
+
},
|
2184
|
+
{
|
2185
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2186
|
+
"name": "focus",
|
2187
|
+
"reactName": "onFocus",
|
2188
|
+
"inheritedFrom": {
|
2189
|
+
"name": "Buttonsimple",
|
2190
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2217
2191
|
}
|
2192
|
+
}
|
2193
|
+
]
|
2194
|
+
}
|
2195
|
+
],
|
2196
|
+
"exports": [
|
2197
|
+
{
|
2198
|
+
"kind": "js",
|
2199
|
+
"name": "default",
|
2200
|
+
"declaration": {
|
2201
|
+
"name": "Button",
|
2202
|
+
"module": "components/button/button.component.js"
|
2203
|
+
}
|
2204
|
+
}
|
2205
|
+
]
|
2206
|
+
},
|
2207
|
+
{
|
2208
|
+
"kind": "javascript-module",
|
2209
|
+
"path": "components/badge/badge.component.js",
|
2210
|
+
"declarations": [
|
2211
|
+
{
|
2212
|
+
"kind": "class",
|
2213
|
+
"description": "The `mdc-badge` component is a versatile UI element used to\ndisplay dot, icons, counters, success, warning and error type badge.\n\nSupported badge types:\n- `dot`: Displays a dot notification badge with a blue color.\n- `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n- `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\nit shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n- `success`: Displays a success badge with a check circle icon and green color.\n- `warning`: Displays a warning badge with a warning icon and yellow color.\n- `error`: Displays a error badge with a error legacy icon and red color.\n\nFor `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n\nFor the `counter` type, the `mdc-text` component is used to render the counter value.",
|
2214
|
+
"name": "Badge",
|
2215
|
+
"cssProperties": [
|
2216
|
+
{
|
2217
|
+
"description": "The foreground color of the primary badge.",
|
2218
|
+
"name": "--mdc-badge-primary-foreground-color"
|
2219
|
+
},
|
2220
|
+
{
|
2221
|
+
"description": "The background color of the primary badge.",
|
2222
|
+
"name": "--mdc-badge-primary-background-color"
|
2223
|
+
},
|
2224
|
+
{
|
2225
|
+
"description": "The foreground color of the secondary badge.",
|
2226
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
2227
|
+
},
|
2228
|
+
{
|
2229
|
+
"description": "The background color of the secondary badge.",
|
2230
|
+
"name": "--mdc-badge-secondary-background-color"
|
2231
|
+
},
|
2232
|
+
{
|
2233
|
+
"description": "The foreground color of the success badge.",
|
2234
|
+
"name": "--mdc-badge-success-foreground-color"
|
2235
|
+
},
|
2236
|
+
{
|
2237
|
+
"description": "The background color of the success badge.",
|
2238
|
+
"name": "--mdc-badge-success-background-color"
|
2239
|
+
},
|
2240
|
+
{
|
2241
|
+
"description": "The foreground color of the warning badge.",
|
2242
|
+
"name": "--mdc-badge-warning-foreground-color"
|
2243
|
+
},
|
2244
|
+
{
|
2245
|
+
"description": "The background color of the warning badge.",
|
2246
|
+
"name": "--mdc-badge-warning-background-color"
|
2247
|
+
},
|
2248
|
+
{
|
2249
|
+
"description": "The foreground color of the error badge.",
|
2250
|
+
"name": "--mdc-badge-error-foreground-color"
|
2251
|
+
},
|
2252
|
+
{
|
2253
|
+
"description": "The background color of the error badge.",
|
2254
|
+
"name": "--mdc-badge-error-background-color"
|
2255
|
+
},
|
2256
|
+
{
|
2257
|
+
"description": "The background color of the badge overlay.",
|
2258
|
+
"name": "--mdc-badge-overlay-background-color"
|
2259
|
+
}
|
2260
|
+
],
|
2261
|
+
"members": [
|
2262
|
+
{
|
2263
|
+
"kind": "field",
|
2264
|
+
"name": "type",
|
2265
|
+
"type": {
|
2266
|
+
"text": "BadgeType | undefined"
|
2267
|
+
},
|
2268
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
2269
|
+
"attribute": "type",
|
2270
|
+
"reflects": true
|
2271
|
+
},
|
2272
|
+
{
|
2273
|
+
"kind": "field",
|
2274
|
+
"name": "variant",
|
2275
|
+
"type": {
|
2276
|
+
"text": "IconVariant"
|
2277
|
+
},
|
2278
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
2279
|
+
"default": "primary",
|
2280
|
+
"attribute": "variant",
|
2281
|
+
"reflects": true
|
2282
|
+
},
|
2283
|
+
{
|
2284
|
+
"kind": "field",
|
2285
|
+
"name": "counter",
|
2286
|
+
"type": {
|
2287
|
+
"text": "number | undefined"
|
2288
|
+
},
|
2289
|
+
"description": "Counter is the number which can be provided in the badge.",
|
2290
|
+
"attribute": "counter"
|
2291
|
+
},
|
2292
|
+
{
|
2293
|
+
"kind": "field",
|
2294
|
+
"name": "maxCounter",
|
2295
|
+
"type": {
|
2296
|
+
"text": "number"
|
2297
|
+
},
|
2298
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
2299
|
+
"default": "99",
|
2300
|
+
"attribute": "max-counter",
|
2301
|
+
"reflects": true
|
2302
|
+
},
|
2303
|
+
{
|
2304
|
+
"kind": "field",
|
2305
|
+
"name": "overlay",
|
2306
|
+
"type": {
|
2307
|
+
"text": "boolean"
|
2308
|
+
},
|
2309
|
+
"default": "false",
|
2310
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
2311
|
+
"attribute": "overlay"
|
2312
|
+
},
|
2313
|
+
{
|
2314
|
+
"kind": "field",
|
2315
|
+
"name": "ariaLabel",
|
2316
|
+
"type": {
|
2317
|
+
"text": "string | null"
|
2318
|
+
},
|
2319
|
+
"default": "null",
|
2320
|
+
"description": "Aria-label attribute to be set for accessibility",
|
2321
|
+
"attribute": "aria-label"
|
2218
2322
|
},
|
2219
2323
|
{
|
2220
2324
|
"kind": "method",
|
2221
|
-
"name": "
|
2325
|
+
"name": "getCounterText",
|
2222
2326
|
"privacy": "private",
|
2327
|
+
"return": {
|
2328
|
+
"type": {
|
2329
|
+
"text": ""
|
2330
|
+
}
|
2331
|
+
},
|
2223
2332
|
"parameters": [
|
2224
2333
|
{
|
2225
|
-
"name": "
|
2334
|
+
"name": "maxCounter",
|
2226
2335
|
"type": {
|
2227
|
-
"text": "
|
2336
|
+
"text": "number"
|
2228
2337
|
},
|
2229
|
-
"description": "
|
2338
|
+
"description": "the maximum limit which can be displayed on the badge"
|
2230
2339
|
},
|
2231
2340
|
{
|
2232
|
-
"name": "
|
2341
|
+
"name": "counter",
|
2233
2342
|
"optional": true,
|
2234
2343
|
"type": {
|
2235
|
-
"text": "
|
2344
|
+
"text": "number"
|
2236
2345
|
},
|
2237
|
-
"description": "
|
2346
|
+
"description": "the number to be displayed on the badge"
|
2238
2347
|
}
|
2239
2348
|
],
|
2240
|
-
"description": "
|
2241
|
-
"inheritedFrom": {
|
2242
|
-
"name": "Buttonsimple",
|
2243
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2244
|
-
}
|
2349
|
+
"description": "If `type` is set to `counter` and if `counter` is greater than `maxCounter`,\nthen it will return a string the maxCounter value as string.\nOtherwise, it will return a string representation of `counter`.\nIf `counter` is not a number, it will return an empty string."
|
2245
2350
|
},
|
2246
2351
|
{
|
2247
2352
|
"kind": "method",
|
2248
|
-
"name": "
|
2353
|
+
"name": "getBadgeIcon",
|
2249
2354
|
"privacy": "private",
|
2355
|
+
"return": {
|
2356
|
+
"type": {
|
2357
|
+
"text": ""
|
2358
|
+
}
|
2359
|
+
},
|
2250
2360
|
"parameters": [
|
2251
2361
|
{
|
2252
|
-
"name": "
|
2362
|
+
"name": "iconName",
|
2253
2363
|
"type": {
|
2254
|
-
"text": "
|
2364
|
+
"text": "string"
|
2255
2365
|
},
|
2256
|
-
"description": "
|
2366
|
+
"description": "the name of the icon from the icon set"
|
2257
2367
|
},
|
2258
2368
|
{
|
2259
|
-
"name": "
|
2369
|
+
"name": "backgroundClassPostfix",
|
2260
2370
|
"type": {
|
2261
|
-
"text": "
|
2371
|
+
"text": "string"
|
2262
2372
|
},
|
2263
|
-
"description": "
|
2373
|
+
"description": "postfix for the class to style the badge icon."
|
2264
2374
|
}
|
2265
2375
|
],
|
2266
|
-
"description": "
|
2267
|
-
"inheritedFrom": {
|
2268
|
-
"name": "Buttonsimple",
|
2269
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2270
|
-
}
|
2376
|
+
"description": "Method to generate the badge icon."
|
2271
2377
|
},
|
2272
2378
|
{
|
2273
2379
|
"kind": "method",
|
2274
|
-
"name": "
|
2380
|
+
"name": "getBadgeDot",
|
2275
2381
|
"privacy": "private",
|
2276
|
-
"
|
2277
|
-
"
|
2278
|
-
|
2279
|
-
|
2382
|
+
"return": {
|
2383
|
+
"type": {
|
2384
|
+
"text": ""
|
2385
|
+
}
|
2386
|
+
},
|
2387
|
+
"description": "Method to generate the badge dot template."
|
2280
2388
|
},
|
2281
2389
|
{
|
2282
2390
|
"kind": "method",
|
2283
|
-
"name": "
|
2391
|
+
"name": "getBadgeCounterText",
|
2284
2392
|
"privacy": "private",
|
2285
|
-
"
|
2286
|
-
|
2287
|
-
|
2288
|
-
|
2289
|
-
}
|
2393
|
+
"return": {
|
2394
|
+
"type": {
|
2395
|
+
"text": ""
|
2396
|
+
}
|
2397
|
+
},
|
2398
|
+
"description": "Method to generate the badge text and counter template."
|
2290
2399
|
},
|
2291
2400
|
{
|
2292
2401
|
"kind": "method",
|
2293
|
-
"name": "
|
2402
|
+
"name": "setRoleByAriaLabel",
|
2294
2403
|
"privacy": "private",
|
2295
|
-
"
|
2296
|
-
{
|
2297
|
-
"
|
2298
|
-
"type": {
|
2299
|
-
"text": "KeyboardEvent"
|
2300
|
-
},
|
2301
|
-
"description": "The keyboard event."
|
2404
|
+
"return": {
|
2405
|
+
"type": {
|
2406
|
+
"text": "void"
|
2302
2407
|
}
|
2303
|
-
|
2304
|
-
"description": "
|
2305
|
-
"inheritedFrom": {
|
2306
|
-
"name": "Buttonsimple",
|
2307
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2308
|
-
}
|
2408
|
+
},
|
2409
|
+
"description": "Method to set the role based on the aria-label provided.\nIf the aria-label is provided, the role of the element will be 'img'.\nOtherwise, the role will be null."
|
2309
2410
|
},
|
2310
2411
|
{
|
2311
2412
|
"kind": "method",
|
2312
|
-
"name": "
|
2413
|
+
"name": "getBadgeContentBasedOnType",
|
2313
2414
|
"privacy": "private",
|
2314
|
-
"
|
2315
|
-
{
|
2316
|
-
"
|
2317
|
-
"type": {
|
2318
|
-
"text": "KeyboardEvent"
|
2319
|
-
},
|
2320
|
-
"description": "The keyboard event."
|
2415
|
+
"return": {
|
2416
|
+
"type": {
|
2417
|
+
"text": ""
|
2321
2418
|
}
|
2322
|
-
|
2323
|
-
"description": "
|
2419
|
+
},
|
2420
|
+
"description": "Generates the badge content based on the badge type.\nUtilizes various helper methods to create the appropriate badge template based on the\ncurrent badge type. Supports 'dot', 'icon', 'counter', 'success', 'warning', and 'error'\ntypes, returning the corresponding template result for each type."
|
2421
|
+
},
|
2422
|
+
{
|
2423
|
+
"kind": "field",
|
2424
|
+
"name": "iconName",
|
2425
|
+
"type": {
|
2426
|
+
"text": "IconNames | undefined"
|
2427
|
+
},
|
2428
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2429
|
+
"attribute": "icon-name",
|
2324
2430
|
"inheritedFrom": {
|
2325
|
-
"name": "
|
2326
|
-
"module": "
|
2431
|
+
"name": "IconNameMixin",
|
2432
|
+
"module": "utils/mixins/IconNameMixin.js"
|
2327
2433
|
}
|
2328
2434
|
}
|
2329
2435
|
],
|
2330
2436
|
"attributes": [
|
2331
2437
|
{
|
2332
|
-
"name": "
|
2333
|
-
"type": {
|
2334
|
-
"text": "IconNames | undefined"
|
2335
|
-
},
|
2336
|
-
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2337
|
-
"fieldName": "prefixIcon"
|
2338
|
-
},
|
2339
|
-
{
|
2340
|
-
"name": "postfix-icon",
|
2438
|
+
"name": "type",
|
2341
2439
|
"type": {
|
2342
|
-
"text": "
|
2440
|
+
"text": "BadgeType | undefined"
|
2343
2441
|
},
|
2344
|
-
"description": "
|
2345
|
-
"fieldName": "
|
2442
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
2443
|
+
"fieldName": "type"
|
2346
2444
|
},
|
2347
2445
|
{
|
2348
2446
|
"name": "variant",
|
2349
2447
|
"type": {
|
2350
|
-
"text": "
|
2448
|
+
"text": "IconVariant"
|
2351
2449
|
},
|
2352
|
-
"description": "
|
2450
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
2353
2451
|
"default": "primary",
|
2354
2452
|
"fieldName": "variant"
|
2355
2453
|
},
|
2356
2454
|
{
|
2357
|
-
"name": "
|
2358
|
-
"type": {
|
2359
|
-
"text": "ButtonSize"
|
2360
|
-
},
|
2361
|
-
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2362
|
-
"default": "32",
|
2363
|
-
"fieldName": "size",
|
2364
|
-
"inheritedFrom": {
|
2365
|
-
"name": "Buttonsimple",
|
2366
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2367
|
-
}
|
2368
|
-
},
|
2369
|
-
{
|
2370
|
-
"name": "color",
|
2371
|
-
"type": {
|
2372
|
-
"text": "ButtonColor"
|
2373
|
-
},
|
2374
|
-
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2375
|
-
"default": "default",
|
2376
|
-
"fieldName": "color"
|
2377
|
-
},
|
2378
|
-
{
|
2379
|
-
"name": "role",
|
2380
|
-
"description": "This property defines the ARIA role for the element. By default, it is set to 'button'.\nConsumers should override this role when:\n- The element is being used in a context where a different role is more appropriate.\n- Custom behaviors are implemented that require a specific ARIA role for accessibility purposes.",
|
2381
|
-
"default": "'button'",
|
2382
|
-
"fieldName": "role",
|
2455
|
+
"name": "counter",
|
2383
2456
|
"type": {
|
2384
|
-
"text": "
|
2457
|
+
"text": "number | undefined"
|
2385
2458
|
},
|
2386
|
-
"
|
2387
|
-
|
2388
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2389
|
-
}
|
2459
|
+
"description": "Counter is the number which can be provided in the badge.",
|
2460
|
+
"fieldName": "counter"
|
2390
2461
|
},
|
2391
2462
|
{
|
2392
|
-
"name": "
|
2463
|
+
"name": "max-counter",
|
2393
2464
|
"type": {
|
2394
2465
|
"text": "number"
|
2395
2466
|
},
|
2396
|
-
"
|
2397
|
-
"
|
2398
|
-
"fieldName": "
|
2399
|
-
"inheritedFrom": {
|
2400
|
-
"name": "TabIndexMixin",
|
2401
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2402
|
-
}
|
2403
|
-
},
|
2404
|
-
{
|
2405
|
-
"name": "disabled",
|
2406
|
-
"type": {
|
2407
|
-
"text": "boolean | undefined"
|
2408
|
-
},
|
2409
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2410
|
-
"default": "undefined",
|
2411
|
-
"fieldName": "disabled",
|
2412
|
-
"inheritedFrom": {
|
2413
|
-
"name": "DisabledMixin",
|
2414
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
2415
|
-
}
|
2416
|
-
},
|
2417
|
-
{
|
2418
|
-
"name": "active",
|
2419
|
-
"type": {
|
2420
|
-
"text": "boolean | undefined"
|
2421
|
-
},
|
2422
|
-
"description": "The button's active state indicates whether it is currently toggled on (active) or off (inactive).\nWhen the active state is true, the button is considered to be in an active state, meaning it is toggled on.\nConversely, when the active state is false, the button is in an inactive state, indicating it is toggled off.\n\nThis attribute is used to set the provided `ariaStateKey` to true or false.",
|
2423
|
-
"default": "undefined",
|
2424
|
-
"fieldName": "active",
|
2425
|
-
"inheritedFrom": {
|
2426
|
-
"name": "Buttonsimple",
|
2427
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2428
|
-
}
|
2429
|
-
},
|
2430
|
-
{
|
2431
|
-
"name": "soft-disabled",
|
2432
|
-
"type": {
|
2433
|
-
"text": "boolean | undefined"
|
2434
|
-
},
|
2435
|
-
"description": "Indicates whether the button is soft disabled.\nWhen set to `true`, the button appears visually disabled but still allows\nfocus, click, and keyboard actions to be passed through.\n\n**Important:** When using soft disabled, consumers must ensure that\nthe button behaves like a disabled button, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
2436
|
-
"default": "undefined",
|
2437
|
-
"fieldName": "softDisabled",
|
2438
|
-
"inheritedFrom": {
|
2439
|
-
"name": "Buttonsimple",
|
2440
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2441
|
-
}
|
2442
|
-
},
|
2443
|
-
{
|
2444
|
-
"name": "ariaStateKey",
|
2445
|
-
"type": {
|
2446
|
-
"text": "string | undefined"
|
2447
|
-
},
|
2448
|
-
"description": "This property defines the ARIA state key, which will be toggled when the\nButton is set to `active`.\nThe default value is 'aria-pressed', which is commonly used for toggle buttons.\n\nConsumers can override this property to use a different ARIA state key if needed.\nIn case multiple aria attributes should be toggled, they can be passed in as\na comma separated string.\nFor example: `aria-pressed,aria-expanded`",
|
2449
|
-
"default": "'aria-pressed' (when)",
|
2450
|
-
"fieldName": "ariaStateKey",
|
2451
|
-
"inheritedFrom": {
|
2452
|
-
"name": "Buttonsimple",
|
2453
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2454
|
-
}
|
2467
|
+
"description": "The maximum number can be set up to 999, anything above that will be rendered as _999+_.\nThe max counter can be `9`, `99` or `999`.",
|
2468
|
+
"default": "99",
|
2469
|
+
"fieldName": "maxCounter"
|
2455
2470
|
},
|
2456
2471
|
{
|
2457
|
-
"name": "
|
2472
|
+
"name": "overlay",
|
2458
2473
|
"type": {
|
2459
|
-
"text": "
|
2460
|
-
},
|
2461
|
-
"
|
2462
|
-
"
|
2463
|
-
"fieldName": "
|
2464
|
-
"inheritedFrom": {
|
2465
|
-
"name": "Buttonsimple",
|
2466
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2467
|
-
}
|
2468
|
-
}
|
2469
|
-
],
|
2470
|
-
"superclass": {
|
2471
|
-
"name": "Buttonsimple",
|
2472
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2473
|
-
},
|
2474
|
-
"tagName": "mdc-button",
|
2475
|
-
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2476
|
-
"customElement": true,
|
2477
|
-
"events": [
|
2478
|
-
{
|
2479
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2480
|
-
"name": "click",
|
2481
|
-
"reactName": "onClick",
|
2482
|
-
"inheritedFrom": {
|
2483
|
-
"name": "Buttonsimple",
|
2484
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2485
|
-
}
|
2486
|
-
},
|
2487
|
-
{
|
2488
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2489
|
-
"name": "keydown",
|
2490
|
-
"reactName": "onKeyDown",
|
2491
|
-
"inheritedFrom": {
|
2492
|
-
"name": "Buttonsimple",
|
2493
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2494
|
-
}
|
2474
|
+
"text": "boolean"
|
2475
|
+
},
|
2476
|
+
"default": "false",
|
2477
|
+
"description": "Overlay is to add a thin outline to the badge.\nThis will help distinguish between the badge and the button,\nwhere the badge will be layered on top of a button.",
|
2478
|
+
"fieldName": "overlay"
|
2495
2479
|
},
|
2496
2480
|
{
|
2497
|
-
"
|
2498
|
-
"
|
2499
|
-
|
2500
|
-
|
2501
|
-
|
2502
|
-
|
2503
|
-
|
2481
|
+
"name": "aria-label",
|
2482
|
+
"type": {
|
2483
|
+
"text": "string | null"
|
2484
|
+
},
|
2485
|
+
"default": "null",
|
2486
|
+
"description": "Aria-label attribute to be set for accessibility",
|
2487
|
+
"fieldName": "ariaLabel"
|
2504
2488
|
},
|
2505
2489
|
{
|
2506
|
-
"
|
2507
|
-
"
|
2508
|
-
|
2490
|
+
"name": "icon-name",
|
2491
|
+
"type": {
|
2492
|
+
"text": "IconNames | undefined"
|
2493
|
+
},
|
2494
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2495
|
+
"fieldName": "iconName",
|
2509
2496
|
"inheritedFrom": {
|
2510
|
-
"name": "
|
2511
|
-
"module": "src/
|
2497
|
+
"name": "IconNameMixin",
|
2498
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
2512
2499
|
}
|
2513
2500
|
}
|
2514
|
-
]
|
2501
|
+
],
|
2502
|
+
"mixins": [
|
2503
|
+
{
|
2504
|
+
"name": "IconNameMixin",
|
2505
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
2506
|
+
}
|
2507
|
+
],
|
2508
|
+
"superclass": {
|
2509
|
+
"name": "Component",
|
2510
|
+
"module": "/src/models"
|
2511
|
+
},
|
2512
|
+
"tagName": "mdc-badge",
|
2513
|
+
"jsDoc": "/**\n * The `mdc-badge` component is a versatile UI element used to\n * display dot, icons, counters, success, warning and error type badge.\n *\n * Supported badge types:\n * - `dot`: Displays a dot notification badge with a blue color.\n * - `icon`: Displays a badge with a specified icon using the `icon-name` attribute.\n * - `counter`: Displays a badge with a counter value. If the counter exceeds the `max-counter`,\n * it shows `maxCounter+`. The maximum value of the counter is 999 and anything above that will be set to `999+`.\n * - `success`: Displays a success badge with a check circle icon and green color.\n * - `warning`: Displays a warning badge with a warning icon and yellow color.\n * - `error`: Displays a error badge with a error legacy icon and red color.\n *\n * For `icon`, `success`, `warning` and `error` types, the `mdc-icon` component is used to render the icon.\n *\n * For the `counter` type, the `mdc-text` component is used to render the counter value.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @tagname mdc-badge\n *\n * @cssproperty --mdc-badge-primary-foreground-color - The foreground color of the primary badge.\n * @cssproperty --mdc-badge-primary-background-color - The background color of the primary badge.\n * @cssproperty --mdc-badge-secondary-foreground-color - The foreground color of the secondary badge.\n * @cssproperty --mdc-badge-secondary-background-color - The background color of the secondary badge.\n * @cssproperty --mdc-badge-success-foreground-color - The foreground color of the success badge.\n * @cssproperty --mdc-badge-success-background-color - The background color of the success badge.\n * @cssproperty --mdc-badge-warning-foreground-color - The foreground color of the warning badge.\n * @cssproperty --mdc-badge-warning-background-color - The background color of the warning badge.\n * @cssproperty --mdc-badge-error-foreground-color - The foreground color of the error badge.\n * @cssproperty --mdc-badge-error-background-color - The background color of the error badge.\n * @cssproperty --mdc-badge-overlay-background-color - The background color of the badge overlay.\n */",
|
2514
|
+
"customElement": true
|
2515
2515
|
}
|
2516
2516
|
],
|
2517
2517
|
"exports": [
|
@@ -2519,8 +2519,8 @@
|
|
2519
2519
|
"kind": "js",
|
2520
2520
|
"name": "default",
|
2521
2521
|
"declaration": {
|
2522
|
-
"name": "
|
2523
|
-
"module": "components/
|
2522
|
+
"name": "Badge",
|
2523
|
+
"module": "components/badge/badge.component.js"
|
2524
2524
|
}
|
2525
2525
|
}
|
2526
2526
|
]
|
@@ -8300,101 +8300,300 @@
|
|
8300
8300
|
},
|
8301
8301
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8302
8302
|
"default": "undefined",
|
8303
|
-
"fieldName": "disabled",
|
8303
|
+
"fieldName": "disabled",
|
8304
|
+
"inheritedFrom": {
|
8305
|
+
"name": "FormfieldWrapper",
|
8306
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8307
|
+
}
|
8308
|
+
},
|
8309
|
+
{
|
8310
|
+
"name": "label",
|
8311
|
+
"type": {
|
8312
|
+
"text": "string | undefined"
|
8313
|
+
},
|
8314
|
+
"description": "The label of the input field. It is linked to the input field using the `for` attribute.",
|
8315
|
+
"fieldName": "label",
|
8316
|
+
"inheritedFrom": {
|
8317
|
+
"name": "FormfieldWrapper",
|
8318
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8319
|
+
}
|
8320
|
+
},
|
8321
|
+
{
|
8322
|
+
"name": "required-label",
|
8323
|
+
"type": {
|
8324
|
+
"text": "string | undefined"
|
8325
|
+
},
|
8326
|
+
"description": "The required label of the input field.\nWhen an appropriate string value is set,\nthe input field is marked as required and the label is appended with this text.",
|
8327
|
+
"fieldName": "requiredLabel",
|
8328
|
+
"inheritedFrom": {
|
8329
|
+
"name": "FormfieldWrapper",
|
8330
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8331
|
+
}
|
8332
|
+
},
|
8333
|
+
{
|
8334
|
+
"name": "id",
|
8335
|
+
"type": {
|
8336
|
+
"text": "string"
|
8337
|
+
},
|
8338
|
+
"default": "''",
|
8339
|
+
"description": "The unique id of the input field. It is used to link the input field with the label.",
|
8340
|
+
"fieldName": "id",
|
8341
|
+
"inheritedFrom": {
|
8342
|
+
"name": "FormfieldWrapper",
|
8343
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8344
|
+
}
|
8345
|
+
},
|
8346
|
+
{
|
8347
|
+
"name": "help-text-type",
|
8348
|
+
"type": {
|
8349
|
+
"text": "ValidationType"
|
8350
|
+
},
|
8351
|
+
"description": "The type of help text. It can be 'default', 'error', 'warning', 'success', 'priority'.",
|
8352
|
+
"fieldName": "helpTextType",
|
8353
|
+
"inheritedFrom": {
|
8354
|
+
"name": "FormfieldWrapper",
|
8355
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8356
|
+
}
|
8357
|
+
},
|
8358
|
+
{
|
8359
|
+
"name": "help-text",
|
8360
|
+
"type": {
|
8361
|
+
"text": "string | undefined"
|
8362
|
+
},
|
8363
|
+
"description": "The help text that is displayed below the input field.",
|
8364
|
+
"fieldName": "helpText",
|
8365
|
+
"inheritedFrom": {
|
8366
|
+
"name": "FormfieldWrapper",
|
8367
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8368
|
+
}
|
8369
|
+
}
|
8370
|
+
],
|
8371
|
+
"mixins": [
|
8372
|
+
{
|
8373
|
+
"name": "FormInternalsMixin",
|
8374
|
+
"module": "/src/utils/mixins/FormInternalsMixin"
|
8375
|
+
},
|
8376
|
+
{
|
8377
|
+
"name": "DataAriaLabelMixin",
|
8378
|
+
"module": "/src/utils/mixins/DataAriaLabelMixin"
|
8379
|
+
}
|
8380
|
+
],
|
8381
|
+
"superclass": {
|
8382
|
+
"name": "FormfieldWrapper",
|
8383
|
+
"module": "/src/components/formfieldwrapper"
|
8384
|
+
},
|
8385
|
+
"tagName": "mdc-input",
|
8386
|
+
"jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
|
8387
|
+
"customElement": true,
|
8388
|
+
"slots": [
|
8389
|
+
{
|
8390
|
+
"description": "slot to add the label info icon",
|
8391
|
+
"name": "label-info",
|
8392
|
+
"inheritedFrom": {
|
8393
|
+
"name": "FormfieldWrapper",
|
8394
|
+
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8395
|
+
}
|
8396
|
+
}
|
8397
|
+
]
|
8398
|
+
}
|
8399
|
+
],
|
8400
|
+
"exports": [
|
8401
|
+
{
|
8402
|
+
"kind": "js",
|
8403
|
+
"name": "default",
|
8404
|
+
"declaration": {
|
8405
|
+
"name": "Input",
|
8406
|
+
"module": "components/input/input.component.js"
|
8407
|
+
}
|
8408
|
+
}
|
8409
|
+
]
|
8410
|
+
},
|
8411
|
+
{
|
8412
|
+
"kind": "javascript-module",
|
8413
|
+
"path": "components/inputchip/inputchip.component.js",
|
8414
|
+
"declarations": [
|
8415
|
+
{
|
8416
|
+
"kind": "class",
|
8417
|
+
"description": "mdc-inputchip component is an interactive chip that consumers can use to represent an input.\n\n- It supports a leading icon along with label.\n- It supports an error state for validation.\n- It supports a close button to remove the chip.",
|
8418
|
+
"name": "InputChip",
|
8419
|
+
"cssProperties": [
|
8420
|
+
{
|
8421
|
+
"description": "The color of the chip.",
|
8422
|
+
"name": "--mdc-chip-color"
|
8423
|
+
},
|
8424
|
+
{
|
8425
|
+
"description": "The border color of the chip.",
|
8426
|
+
"name": "--mdc-chip-border-color"
|
8427
|
+
},
|
8428
|
+
{
|
8429
|
+
"description": "The background color of the chip.",
|
8430
|
+
"name": "--mdc-chip-background-color"
|
8431
|
+
}
|
8432
|
+
],
|
8433
|
+
"members": [
|
8434
|
+
{
|
8435
|
+
"kind": "field",
|
8436
|
+
"name": "label",
|
8437
|
+
"type": {
|
8438
|
+
"text": "string"
|
8439
|
+
},
|
8440
|
+
"default": "''",
|
8441
|
+
"description": "The label of the inputchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
8442
|
+
"attribute": "label"
|
8443
|
+
},
|
8444
|
+
{
|
8445
|
+
"kind": "field",
|
8446
|
+
"name": "error",
|
8447
|
+
"type": {
|
8448
|
+
"text": "boolean"
|
8449
|
+
},
|
8450
|
+
"default": "false",
|
8451
|
+
"description": "The error state of the inputchip.",
|
8452
|
+
"attribute": "error"
|
8453
|
+
},
|
8454
|
+
{
|
8455
|
+
"kind": "field",
|
8456
|
+
"name": "clearAriaLabel",
|
8457
|
+
"type": {
|
8458
|
+
"text": "string"
|
8459
|
+
},
|
8460
|
+
"default": "''",
|
8461
|
+
"description": "The aria-label of the close button.",
|
8462
|
+
"attribute": "clear-aria-label"
|
8463
|
+
},
|
8464
|
+
{
|
8465
|
+
"kind": "method",
|
8466
|
+
"name": "renderIcon",
|
8467
|
+
"privacy": "private",
|
8468
|
+
"description": "Renders the icon element if available.",
|
8469
|
+
"return": {
|
8470
|
+
"type": {
|
8471
|
+
"text": ""
|
8472
|
+
}
|
8473
|
+
}
|
8474
|
+
},
|
8475
|
+
{
|
8476
|
+
"kind": "method",
|
8477
|
+
"name": "handleClose",
|
8478
|
+
"privacy": "private",
|
8479
|
+
"description": "Handles the behavior of the close button on click event.",
|
8480
|
+
"parameters": [
|
8481
|
+
{
|
8482
|
+
"description": "The event object.",
|
8483
|
+
"name": "event"
|
8484
|
+
}
|
8485
|
+
]
|
8486
|
+
},
|
8487
|
+
{
|
8488
|
+
"kind": "field",
|
8489
|
+
"name": "iconName",
|
8490
|
+
"type": {
|
8491
|
+
"text": "IconNames | undefined"
|
8492
|
+
},
|
8493
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8494
|
+
"attribute": "icon-name",
|
8495
|
+
"inheritedFrom": {
|
8496
|
+
"name": "IconNameMixin",
|
8497
|
+
"module": "utils/mixins/IconNameMixin.js"
|
8498
|
+
}
|
8499
|
+
},
|
8500
|
+
{
|
8501
|
+
"kind": "field",
|
8502
|
+
"name": "disabled",
|
8503
|
+
"type": {
|
8504
|
+
"text": "boolean | undefined"
|
8505
|
+
},
|
8506
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8507
|
+
"default": "undefined",
|
8508
|
+
"attribute": "disabled",
|
8509
|
+
"reflects": true,
|
8304
8510
|
"inheritedFrom": {
|
8305
|
-
"name": "
|
8306
|
-
"module": "
|
8511
|
+
"name": "DisabledMixin",
|
8512
|
+
"module": "utils/mixins/DisabledMixin.js"
|
8307
8513
|
}
|
8308
|
-
}
|
8514
|
+
}
|
8515
|
+
],
|
8516
|
+
"events": [
|
8517
|
+
{
|
8518
|
+
"name": "remove",
|
8519
|
+
"type": {
|
8520
|
+
"text": "CustomEvent"
|
8521
|
+
},
|
8522
|
+
"description": "This event is dispatched when the close button is activated. It bubbles and is composed.",
|
8523
|
+
"reactName": "onRemove"
|
8524
|
+
}
|
8525
|
+
],
|
8526
|
+
"attributes": [
|
8309
8527
|
{
|
8310
8528
|
"name": "label",
|
8311
8529
|
"type": {
|
8312
|
-
"text": "string
|
8530
|
+
"text": "string"
|
8313
8531
|
},
|
8314
|
-
"
|
8315
|
-
"
|
8316
|
-
"
|
8317
|
-
"name": "FormfieldWrapper",
|
8318
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8319
|
-
}
|
8532
|
+
"default": "''",
|
8533
|
+
"description": "The label of the inputchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
8534
|
+
"fieldName": "label"
|
8320
8535
|
},
|
8321
8536
|
{
|
8322
|
-
"name": "
|
8537
|
+
"name": "error",
|
8323
8538
|
"type": {
|
8324
|
-
"text": "
|
8539
|
+
"text": "boolean"
|
8325
8540
|
},
|
8326
|
-
"
|
8327
|
-
"
|
8328
|
-
"
|
8329
|
-
"name": "FormfieldWrapper",
|
8330
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8331
|
-
}
|
8541
|
+
"default": "false",
|
8542
|
+
"description": "The error state of the inputchip.",
|
8543
|
+
"fieldName": "error"
|
8332
8544
|
},
|
8333
8545
|
{
|
8334
|
-
"name": "
|
8546
|
+
"name": "clear-aria-label",
|
8335
8547
|
"type": {
|
8336
8548
|
"text": "string"
|
8337
8549
|
},
|
8338
8550
|
"default": "''",
|
8339
|
-
"description": "The
|
8340
|
-
"fieldName": "
|
8341
|
-
"inheritedFrom": {
|
8342
|
-
"name": "FormfieldWrapper",
|
8343
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8344
|
-
}
|
8551
|
+
"description": "The aria-label of the close button.",
|
8552
|
+
"fieldName": "clearAriaLabel"
|
8345
8553
|
},
|
8346
8554
|
{
|
8347
|
-
"name": "
|
8555
|
+
"name": "icon-name",
|
8348
8556
|
"type": {
|
8349
|
-
"text": "
|
8557
|
+
"text": "IconNames | undefined"
|
8350
8558
|
},
|
8351
|
-
"description": "
|
8352
|
-
"fieldName": "
|
8559
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8560
|
+
"fieldName": "iconName",
|
8353
8561
|
"inheritedFrom": {
|
8354
|
-
"name": "
|
8355
|
-
"module": "src/
|
8562
|
+
"name": "IconNameMixin",
|
8563
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
8356
8564
|
}
|
8357
8565
|
},
|
8358
8566
|
{
|
8359
|
-
"name": "
|
8567
|
+
"name": "disabled",
|
8360
8568
|
"type": {
|
8361
|
-
"text": "
|
8569
|
+
"text": "boolean | undefined"
|
8362
8570
|
},
|
8363
|
-
"description": "
|
8364
|
-
"
|
8571
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8572
|
+
"default": "undefined",
|
8573
|
+
"fieldName": "disabled",
|
8365
8574
|
"inheritedFrom": {
|
8366
|
-
"name": "
|
8367
|
-
"module": "src/
|
8575
|
+
"name": "DisabledMixin",
|
8576
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
8368
8577
|
}
|
8369
8578
|
}
|
8370
8579
|
],
|
8371
8580
|
"mixins": [
|
8372
8581
|
{
|
8373
|
-
"name": "
|
8374
|
-
"module": "/src/utils/mixins/
|
8582
|
+
"name": "IconNameMixin",
|
8583
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
8375
8584
|
},
|
8376
8585
|
{
|
8377
|
-
"name": "
|
8378
|
-
"module": "/src/utils/mixins/
|
8586
|
+
"name": "DisabledMixin",
|
8587
|
+
"module": "/src/utils/mixins/DisabledMixin"
|
8379
8588
|
}
|
8380
8589
|
],
|
8381
8590
|
"superclass": {
|
8382
|
-
"name": "
|
8383
|
-
"module": "/src/
|
8591
|
+
"name": "Component",
|
8592
|
+
"module": "/src/models"
|
8384
8593
|
},
|
8385
|
-
"tagName": "mdc-
|
8386
|
-
"jsDoc": "/**\n * mdc-
|
8387
|
-
"customElement": true
|
8388
|
-
"slots": [
|
8389
|
-
{
|
8390
|
-
"description": "slot to add the label info icon",
|
8391
|
-
"name": "label-info",
|
8392
|
-
"inheritedFrom": {
|
8393
|
-
"name": "FormfieldWrapper",
|
8394
|
-
"module": "src/components/formfieldwrapper/formfieldwrapper.component.ts"
|
8395
|
-
}
|
8396
|
-
}
|
8397
|
-
]
|
8594
|
+
"tagName": "mdc-inputchip",
|
8595
|
+
"jsDoc": "/**\n * mdc-inputchip component is an interactive chip that consumers can use to represent an input.\n *\n * - It supports a leading icon along with label.\n * - It supports an error state for validation.\n * - It supports a close button to remove the chip.\n *\n * @tagname mdc-inputchip\n *\n * @dependency mdc-button\n * @dependency mdc-icon\n * @dependency mdc-text\n *\n * @event remove - This event is dispatched when the close button is activated. It bubbles and is composed.\n *\n * @cssproperty --mdc-chip-color - The color of the chip.\n * @cssproperty --mdc-chip-border-color - The border color of the chip.\n * @cssproperty --mdc-chip-background-color - The background color of the chip.\n *\n */",
|
8596
|
+
"customElement": true
|
8398
8597
|
}
|
8399
8598
|
],
|
8400
8599
|
"exports": [
|
@@ -8402,178 +8601,337 @@
|
|
8402
8601
|
"kind": "js",
|
8403
8602
|
"name": "default",
|
8404
8603
|
"declaration": {
|
8405
|
-
"name": "
|
8406
|
-
"module": "components/
|
8604
|
+
"name": "InputChip",
|
8605
|
+
"module": "components/inputchip/inputchip.component.js"
|
8407
8606
|
}
|
8408
8607
|
}
|
8409
8608
|
]
|
8410
8609
|
},
|
8411
8610
|
{
|
8412
8611
|
"kind": "javascript-module",
|
8413
|
-
"path": "components/
|
8612
|
+
"path": "components/link/link.component.js",
|
8414
8613
|
"declarations": [
|
8415
8614
|
{
|
8416
8615
|
"kind": "class",
|
8417
|
-
"description": "mdc-
|
8418
|
-
"name": "
|
8419
|
-
"
|
8616
|
+
"description": "`mdc-link` component can be used to navigate to a different page\nwithin the application or to an external site. It can be used to link to\nemails or phone numbers.\n\nThe `children` of the link component is expected to be the text content.\n\nFor `icon`, the `mdc-icon` component is used to render the icon.",
|
8617
|
+
"name": "Link",
|
8618
|
+
"members": [
|
8420
8619
|
{
|
8421
|
-
"
|
8422
|
-
"name": "
|
8620
|
+
"kind": "field",
|
8621
|
+
"name": "size",
|
8622
|
+
"type": {
|
8623
|
+
"text": "LinkSize"
|
8624
|
+
},
|
8625
|
+
"description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
|
8626
|
+
"default": "large",
|
8627
|
+
"attribute": "size",
|
8628
|
+
"reflects": true
|
8423
8629
|
},
|
8424
8630
|
{
|
8425
|
-
"
|
8426
|
-
"name": "
|
8631
|
+
"kind": "method",
|
8632
|
+
"name": "getIconSize",
|
8633
|
+
"privacy": "private",
|
8634
|
+
"return": {
|
8635
|
+
"type": {
|
8636
|
+
"text": ""
|
8637
|
+
}
|
8638
|
+
},
|
8639
|
+
"description": "Method to get the size of the trailing icon based on the link size."
|
8427
8640
|
},
|
8428
8641
|
{
|
8429
|
-
"
|
8430
|
-
"name": "
|
8431
|
-
|
8432
|
-
|
8433
|
-
|
8642
|
+
"kind": "field",
|
8643
|
+
"name": "iconName",
|
8644
|
+
"type": {
|
8645
|
+
"text": "IconNames | undefined"
|
8646
|
+
},
|
8647
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8648
|
+
"attribute": "icon-name",
|
8649
|
+
"inheritedFrom": {
|
8650
|
+
"name": "IconNameMixin",
|
8651
|
+
"module": "utils/mixins/IconNameMixin.js"
|
8652
|
+
}
|
8653
|
+
},
|
8434
8654
|
{
|
8435
8655
|
"kind": "field",
|
8436
|
-
"name": "
|
8656
|
+
"name": "disabled",
|
8437
8657
|
"type": {
|
8438
|
-
"text": "
|
8658
|
+
"text": "boolean | undefined"
|
8439
8659
|
},
|
8440
|
-
"
|
8441
|
-
"
|
8442
|
-
"attribute": "
|
8660
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8661
|
+
"default": "undefined",
|
8662
|
+
"attribute": "disabled",
|
8663
|
+
"reflects": true,
|
8664
|
+
"inheritedFrom": {
|
8665
|
+
"name": "DisabledMixin",
|
8666
|
+
"module": "utils/mixins/DisabledMixin.js"
|
8667
|
+
}
|
8443
8668
|
},
|
8444
8669
|
{
|
8445
8670
|
"kind": "field",
|
8446
|
-
"name": "
|
8671
|
+
"name": "tabIndex",
|
8672
|
+
"type": {
|
8673
|
+
"text": "number"
|
8674
|
+
},
|
8675
|
+
"default": "0",
|
8676
|
+
"description": "This property specifies the tab order of the element.",
|
8677
|
+
"attribute": "tabIndex",
|
8678
|
+
"reflects": true,
|
8679
|
+
"inheritedFrom": {
|
8680
|
+
"name": "TabIndexMixin",
|
8681
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
8682
|
+
}
|
8683
|
+
},
|
8684
|
+
{
|
8685
|
+
"kind": "field",
|
8686
|
+
"name": "inline",
|
8687
|
+
"type": {
|
8688
|
+
"text": "boolean"
|
8689
|
+
},
|
8690
|
+
"description": "The link can be inline or standalone.",
|
8691
|
+
"default": "false",
|
8692
|
+
"attribute": "inline",
|
8693
|
+
"reflects": true,
|
8694
|
+
"inheritedFrom": {
|
8695
|
+
"name": "Linksimple",
|
8696
|
+
"module": "components/linksimple/linksimple.component.js"
|
8697
|
+
}
|
8698
|
+
},
|
8699
|
+
{
|
8700
|
+
"kind": "field",
|
8701
|
+
"name": "inverted",
|
8447
8702
|
"type": {
|
8448
8703
|
"text": "boolean"
|
8449
8704
|
},
|
8705
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
8450
8706
|
"default": "false",
|
8451
|
-
"
|
8452
|
-
"
|
8707
|
+
"attribute": "inverted",
|
8708
|
+
"reflects": true,
|
8709
|
+
"inheritedFrom": {
|
8710
|
+
"name": "Linksimple",
|
8711
|
+
"module": "components/linksimple/linksimple.component.js"
|
8712
|
+
}
|
8453
8713
|
},
|
8454
8714
|
{
|
8455
8715
|
"kind": "field",
|
8456
|
-
"name": "
|
8716
|
+
"name": "href",
|
8457
8717
|
"type": {
|
8458
8718
|
"text": "string"
|
8459
8719
|
},
|
8460
|
-
"default": "''",
|
8461
|
-
"description": "The
|
8462
|
-
"attribute": "
|
8720
|
+
"default": "'#'",
|
8721
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
8722
|
+
"attribute": "href",
|
8723
|
+
"reflects": true,
|
8724
|
+
"inheritedFrom": {
|
8725
|
+
"name": "Linksimple",
|
8726
|
+
"module": "components/linksimple/linksimple.component.js"
|
8727
|
+
}
|
8463
8728
|
},
|
8464
8729
|
{
|
8465
|
-
"kind": "
|
8466
|
-
"name": "
|
8730
|
+
"kind": "field",
|
8731
|
+
"name": "target",
|
8732
|
+
"type": {
|
8733
|
+
"text": "string"
|
8734
|
+
},
|
8735
|
+
"default": "'_self'",
|
8736
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
8737
|
+
"attribute": "target",
|
8738
|
+
"reflects": true,
|
8739
|
+
"inheritedFrom": {
|
8740
|
+
"name": "Linksimple",
|
8741
|
+
"module": "components/linksimple/linksimple.component.js"
|
8742
|
+
}
|
8743
|
+
},
|
8744
|
+
{
|
8745
|
+
"kind": "field",
|
8746
|
+
"name": "rel",
|
8747
|
+
"type": {
|
8748
|
+
"text": "string | undefined"
|
8749
|
+
},
|
8750
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
8751
|
+
"attribute": "rel",
|
8752
|
+
"reflects": true,
|
8753
|
+
"inheritedFrom": {
|
8754
|
+
"name": "Linksimple",
|
8755
|
+
"module": "components/linksimple/linksimple.component.js"
|
8756
|
+
}
|
8757
|
+
},
|
8758
|
+
{
|
8759
|
+
"kind": "field",
|
8760
|
+
"name": "handleNavigation",
|
8467
8761
|
"privacy": "private",
|
8468
|
-
"
|
8469
|
-
|
8470
|
-
"
|
8471
|
-
"text": ""
|
8472
|
-
}
|
8762
|
+
"inheritedFrom": {
|
8763
|
+
"name": "Linksimple",
|
8764
|
+
"module": "components/linksimple/linksimple.component.js"
|
8473
8765
|
}
|
8474
8766
|
},
|
8475
8767
|
{
|
8476
8768
|
"kind": "method",
|
8477
|
-
"name": "
|
8769
|
+
"name": "setDisabled",
|
8478
8770
|
"privacy": "private",
|
8479
|
-
"description": "Handles the behavior of the close button on click event.",
|
8480
8771
|
"parameters": [
|
8481
8772
|
{
|
8482
|
-
"
|
8483
|
-
"
|
8773
|
+
"name": "disabled",
|
8774
|
+
"type": {
|
8775
|
+
"text": "boolean"
|
8776
|
+
},
|
8777
|
+
"description": "Whether the element should be disabled"
|
8484
8778
|
}
|
8485
|
-
]
|
8779
|
+
],
|
8780
|
+
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored.",
|
8781
|
+
"inheritedFrom": {
|
8782
|
+
"name": "Linksimple",
|
8783
|
+
"module": "components/linksimple/linksimple.component.js"
|
8784
|
+
}
|
8785
|
+
}
|
8786
|
+
],
|
8787
|
+
"events": [
|
8788
|
+
{
|
8789
|
+
"description": "(React: onClick) Fired when the user activates the Link using a mouse or assistive technology.",
|
8790
|
+
"name": "click",
|
8791
|
+
"reactName": "onClick",
|
8792
|
+
"inheritedFrom": {
|
8793
|
+
"name": "Linksimple",
|
8794
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8795
|
+
}
|
8486
8796
|
},
|
8487
8797
|
{
|
8488
|
-
"
|
8489
|
-
"name": "
|
8798
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the Link has focus.",
|
8799
|
+
"name": "keydown",
|
8800
|
+
"reactName": "onKeyDown",
|
8801
|
+
"inheritedFrom": {
|
8802
|
+
"name": "Linksimple",
|
8803
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8804
|
+
}
|
8805
|
+
},
|
8806
|
+
{
|
8807
|
+
"description": "(React: onFocus) Fired when the Link receives keyboard or mouse focus.",
|
8808
|
+
"name": "focus",
|
8809
|
+
"reactName": "onFocus",
|
8810
|
+
"inheritedFrom": {
|
8811
|
+
"name": "Linksimple",
|
8812
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8813
|
+
}
|
8814
|
+
},
|
8815
|
+
{
|
8816
|
+
"description": "(React: onBlur) Fired when the Link loses keyboard or mouse focus.",
|
8817
|
+
"name": "blur",
|
8818
|
+
"reactName": "onBlur",
|
8819
|
+
"inheritedFrom": {
|
8820
|
+
"name": "Linksimple",
|
8821
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8822
|
+
}
|
8823
|
+
}
|
8824
|
+
],
|
8825
|
+
"attributes": [
|
8826
|
+
{
|
8827
|
+
"name": "size",
|
8828
|
+
"type": {
|
8829
|
+
"text": "LinkSize"
|
8830
|
+
},
|
8831
|
+
"description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
|
8832
|
+
"default": "large",
|
8833
|
+
"fieldName": "size"
|
8834
|
+
},
|
8835
|
+
{
|
8836
|
+
"name": "icon-name",
|
8490
8837
|
"type": {
|
8491
8838
|
"text": "IconNames | undefined"
|
8492
8839
|
},
|
8493
8840
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8494
|
-
"
|
8841
|
+
"fieldName": "iconName",
|
8495
8842
|
"inheritedFrom": {
|
8496
8843
|
"name": "IconNameMixin",
|
8497
|
-
"module": "utils/mixins/IconNameMixin.
|
8844
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
8498
8845
|
}
|
8499
8846
|
},
|
8500
8847
|
{
|
8501
|
-
"kind": "field",
|
8502
8848
|
"name": "disabled",
|
8503
8849
|
"type": {
|
8504
8850
|
"text": "boolean | undefined"
|
8505
8851
|
},
|
8506
8852
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
8507
8853
|
"default": "undefined",
|
8508
|
-
"
|
8509
|
-
"reflects": true,
|
8854
|
+
"fieldName": "disabled",
|
8510
8855
|
"inheritedFrom": {
|
8511
8856
|
"name": "DisabledMixin",
|
8512
|
-
"module": "utils/mixins/DisabledMixin.
|
8857
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
8513
8858
|
}
|
8514
|
-
}
|
8515
|
-
],
|
8516
|
-
"events": [
|
8859
|
+
},
|
8517
8860
|
{
|
8518
|
-
"name": "
|
8861
|
+
"name": "tabIndex",
|
8519
8862
|
"type": {
|
8520
|
-
"text": "
|
8863
|
+
"text": "number"
|
8521
8864
|
},
|
8522
|
-
"
|
8523
|
-
"
|
8524
|
-
|
8525
|
-
|
8526
|
-
|
8865
|
+
"default": "0",
|
8866
|
+
"description": "This property specifies the tab order of the element.",
|
8867
|
+
"fieldName": "tabIndex",
|
8868
|
+
"inheritedFrom": {
|
8869
|
+
"name": "TabIndexMixin",
|
8870
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
8871
|
+
}
|
8872
|
+
},
|
8527
8873
|
{
|
8528
|
-
"name": "
|
8874
|
+
"name": "inline",
|
8529
8875
|
"type": {
|
8530
|
-
"text": "
|
8876
|
+
"text": "boolean"
|
8531
8877
|
},
|
8532
|
-
"
|
8533
|
-
"
|
8534
|
-
"fieldName": "
|
8878
|
+
"description": "The link can be inline or standalone.",
|
8879
|
+
"default": "false",
|
8880
|
+
"fieldName": "inline",
|
8881
|
+
"inheritedFrom": {
|
8882
|
+
"name": "Linksimple",
|
8883
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8884
|
+
}
|
8535
8885
|
},
|
8536
8886
|
{
|
8537
|
-
"name": "
|
8887
|
+
"name": "inverted",
|
8538
8888
|
"type": {
|
8539
8889
|
"text": "boolean"
|
8540
8890
|
},
|
8891
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
8541
8892
|
"default": "false",
|
8542
|
-
"
|
8543
|
-
"
|
8893
|
+
"fieldName": "inverted",
|
8894
|
+
"inheritedFrom": {
|
8895
|
+
"name": "Linksimple",
|
8896
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8897
|
+
}
|
8544
8898
|
},
|
8545
8899
|
{
|
8546
|
-
"name": "
|
8900
|
+
"name": "href",
|
8547
8901
|
"type": {
|
8548
8902
|
"text": "string"
|
8549
8903
|
},
|
8550
|
-
"default": "''",
|
8551
|
-
"description": "The
|
8552
|
-
"fieldName": "
|
8904
|
+
"default": "'#'",
|
8905
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
8906
|
+
"fieldName": "href",
|
8907
|
+
"inheritedFrom": {
|
8908
|
+
"name": "Linksimple",
|
8909
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8910
|
+
}
|
8553
8911
|
},
|
8554
8912
|
{
|
8555
|
-
"name": "
|
8913
|
+
"name": "target",
|
8556
8914
|
"type": {
|
8557
|
-
"text": "
|
8915
|
+
"text": "string"
|
8558
8916
|
},
|
8559
|
-
"
|
8560
|
-
"
|
8917
|
+
"default": "'_self'",
|
8918
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
8919
|
+
"fieldName": "target",
|
8561
8920
|
"inheritedFrom": {
|
8562
|
-
"name": "
|
8563
|
-
"module": "src/
|
8921
|
+
"name": "Linksimple",
|
8922
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8564
8923
|
}
|
8565
8924
|
},
|
8566
8925
|
{
|
8567
|
-
"name": "
|
8926
|
+
"name": "rel",
|
8568
8927
|
"type": {
|
8569
|
-
"text": "
|
8928
|
+
"text": "string | undefined"
|
8570
8929
|
},
|
8571
|
-
"description": "
|
8572
|
-
"
|
8573
|
-
"fieldName": "disabled",
|
8930
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
8931
|
+
"fieldName": "rel",
|
8574
8932
|
"inheritedFrom": {
|
8575
|
-
"name": "
|
8576
|
-
"module": "src/
|
8933
|
+
"name": "Linksimple",
|
8934
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8577
8935
|
}
|
8578
8936
|
}
|
8579
8937
|
],
|
@@ -8581,19 +8939,89 @@
|
|
8581
8939
|
{
|
8582
8940
|
"name": "IconNameMixin",
|
8583
8941
|
"module": "/src/utils/mixins/IconNameMixin"
|
8584
|
-
},
|
8585
|
-
{
|
8586
|
-
"name": "DisabledMixin",
|
8587
|
-
"module": "/src/utils/mixins/DisabledMixin"
|
8588
8942
|
}
|
8589
8943
|
],
|
8590
8944
|
"superclass": {
|
8591
|
-
"name": "
|
8592
|
-
"module": "/src/
|
8945
|
+
"name": "Linksimple",
|
8946
|
+
"module": "/src/components/linksimple/linksimple.component"
|
8593
8947
|
},
|
8594
|
-
"tagName": "mdc-
|
8595
|
-
"jsDoc": "/**\n * mdc-
|
8596
|
-
"customElement": true
|
8948
|
+
"tagName": "mdc-link",
|
8949
|
+
"jsDoc": "/**\n * `mdc-link` component can be used to navigate to a different page\n * within the application or to an external site. It can be used to link to\n * emails or phone numbers.\n *\n * The `children` of the link component is expected to be the text content.\n *\n * For `icon`, the `mdc-icon` component is used to render the icon.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-link\n *\n * @event click - (React: onClick) Fired when the user activates the Link using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the Link has focus.\n * @event focus - (React: onFocus) Fired when the Link receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the Link loses keyboard or mouse focus.\n */",
|
8950
|
+
"customElement": true,
|
8951
|
+
"cssProperties": [
|
8952
|
+
{
|
8953
|
+
"description": "Border radius of the link.",
|
8954
|
+
"name": "--mdc-link-border-radius",
|
8955
|
+
"inheritedFrom": {
|
8956
|
+
"name": "Linksimple",
|
8957
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8958
|
+
}
|
8959
|
+
},
|
8960
|
+
{
|
8961
|
+
"description": "Color of the link’s child content in the active state.",
|
8962
|
+
"name": "--mdc-link-color-active",
|
8963
|
+
"inheritedFrom": {
|
8964
|
+
"name": "Linksimple",
|
8965
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8966
|
+
}
|
8967
|
+
},
|
8968
|
+
{
|
8969
|
+
"description": "Color of the link’s child content in the disabled state.",
|
8970
|
+
"name": "--mdc-link-color-disabled",
|
8971
|
+
"inheritedFrom": {
|
8972
|
+
"name": "Linksimple",
|
8973
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8974
|
+
}
|
8975
|
+
},
|
8976
|
+
{
|
8977
|
+
"description": "Color of the link’s child content in the hover state.",
|
8978
|
+
"name": "--mdc-link-color-hover",
|
8979
|
+
"inheritedFrom": {
|
8980
|
+
"name": "Linksimple",
|
8981
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8982
|
+
}
|
8983
|
+
},
|
8984
|
+
{
|
8985
|
+
"description": "Color of the link’s child content in the normal state.",
|
8986
|
+
"name": "--mdc-link-color-normal",
|
8987
|
+
"inheritedFrom": {
|
8988
|
+
"name": "Linksimple",
|
8989
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8990
|
+
}
|
8991
|
+
},
|
8992
|
+
{
|
8993
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
8994
|
+
"name": "--mdc-link-inverted-color-active",
|
8995
|
+
"inheritedFrom": {
|
8996
|
+
"name": "Linksimple",
|
8997
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
8998
|
+
}
|
8999
|
+
},
|
9000
|
+
{
|
9001
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
9002
|
+
"name": "--mdc-link-inverted-color-disabled",
|
9003
|
+
"inheritedFrom": {
|
9004
|
+
"name": "Linksimple",
|
9005
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
9006
|
+
}
|
9007
|
+
},
|
9008
|
+
{
|
9009
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
9010
|
+
"name": "--mdc-link-inverted-color-hover",
|
9011
|
+
"inheritedFrom": {
|
9012
|
+
"name": "Linksimple",
|
9013
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
9014
|
+
}
|
9015
|
+
},
|
9016
|
+
{
|
9017
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
9018
|
+
"name": "--mdc-link-inverted-color-normal",
|
9019
|
+
"inheritedFrom": {
|
9020
|
+
"name": "Linksimple",
|
9021
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
9022
|
+
}
|
9023
|
+
}
|
9024
|
+
]
|
8597
9025
|
}
|
8598
9026
|
],
|
8599
9027
|
"exports": [
|
@@ -8601,64 +9029,56 @@
|
|
8601
9029
|
"kind": "js",
|
8602
9030
|
"name": "default",
|
8603
9031
|
"declaration": {
|
8604
|
-
"name": "
|
8605
|
-
"module": "components/
|
9032
|
+
"name": "Link",
|
9033
|
+
"module": "components/link/link.component.js"
|
8606
9034
|
}
|
8607
9035
|
}
|
8608
9036
|
]
|
8609
9037
|
},
|
8610
9038
|
{
|
8611
9039
|
"kind": "javascript-module",
|
8612
|
-
"path": "components/
|
9040
|
+
"path": "components/linksimple/linksimple.component.js",
|
8613
9041
|
"declarations": [
|
8614
9042
|
{
|
8615
9043
|
"kind": "class",
|
8616
|
-
"description": "`mdc-
|
8617
|
-
"name": "
|
9044
|
+
"description": "`mdc-linksimple` is a lightweight link component that can be used to navigate\nwithin the application or to an external URL. It does not have any predefined default size.\n\nThe `children` of the `mdc-linksimple` component can be customized to suit\ndifferent use cases, including text, icons, or other inline content. For the child to be an icon,\nthe `mdc-icon` component should be used to render.",
|
9045
|
+
"name": "Linksimple",
|
8618
9046
|
"cssProperties": [
|
8619
9047
|
{
|
8620
|
-
"description": "Border radius of the link",
|
9048
|
+
"description": "Border radius of the link.",
|
8621
9049
|
"name": "--mdc-link-border-radius"
|
8622
9050
|
},
|
8623
9051
|
{
|
8624
|
-
"description": "
|
9052
|
+
"description": "Color of the link’s child content in the active state.",
|
8625
9053
|
"name": "--mdc-link-color-active"
|
8626
9054
|
},
|
8627
9055
|
{
|
8628
|
-
"description": "
|
9056
|
+
"description": "Color of the link’s child content in the disabled state.",
|
8629
9057
|
"name": "--mdc-link-color-disabled"
|
8630
9058
|
},
|
8631
9059
|
{
|
8632
|
-
"description": "
|
9060
|
+
"description": "Color of the link’s child content in the hover state.",
|
8633
9061
|
"name": "--mdc-link-color-hover"
|
8634
9062
|
},
|
8635
9063
|
{
|
8636
|
-
"description": "
|
9064
|
+
"description": "Color of the link’s child content in the normal state.",
|
8637
9065
|
"name": "--mdc-link-color-normal"
|
8638
9066
|
},
|
8639
9067
|
{
|
8640
|
-
"description": "
|
8641
|
-
"name": "--mdc-link-icon-margin-left"
|
8642
|
-
},
|
8643
|
-
{
|
8644
|
-
"description": "Text and icon color of the inverted link in active state",
|
9068
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
8645
9069
|
"name": "--mdc-link-inverted-color-active"
|
8646
9070
|
},
|
8647
9071
|
{
|
8648
|
-
"description": "
|
9072
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
8649
9073
|
"name": "--mdc-link-inverted-color-disabled"
|
8650
9074
|
},
|
8651
9075
|
{
|
8652
|
-
"description": "
|
9076
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
8653
9077
|
"name": "--mdc-link-inverted-color-hover"
|
8654
9078
|
},
|
8655
9079
|
{
|
8656
|
-
"description": "
|
9080
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
8657
9081
|
"name": "--mdc-link-inverted-color-normal"
|
8658
|
-
},
|
8659
|
-
{
|
8660
|
-
"description": "Text decoration of the link in disabled state for all variants",
|
8661
|
-
"name": "--mdc-link-text-decoration-disabled"
|
8662
9082
|
}
|
8663
9083
|
],
|
8664
9084
|
"members": [
|
@@ -8684,17 +9104,6 @@
|
|
8684
9104
|
"attribute": "inverted",
|
8685
9105
|
"reflects": true
|
8686
9106
|
},
|
8687
|
-
{
|
8688
|
-
"kind": "field",
|
8689
|
-
"name": "size",
|
8690
|
-
"type": {
|
8691
|
-
"text": "LinkSize"
|
8692
|
-
},
|
8693
|
-
"description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
|
8694
|
-
"default": "large",
|
8695
|
-
"attribute": "size",
|
8696
|
-
"reflects": true
|
8697
|
-
},
|
8698
9107
|
{
|
8699
9108
|
"kind": "field",
|
8700
9109
|
"name": "href",
|
@@ -8732,17 +9141,6 @@
|
|
8732
9141
|
"name": "handleNavigation",
|
8733
9142
|
"privacy": "private"
|
8734
9143
|
},
|
8735
|
-
{
|
8736
|
-
"kind": "method",
|
8737
|
-
"name": "getIconSize",
|
8738
|
-
"privacy": "private",
|
8739
|
-
"return": {
|
8740
|
-
"type": {
|
8741
|
-
"text": ""
|
8742
|
-
}
|
8743
|
-
},
|
8744
|
-
"description": "Method to get the size of the trailing icon based on the link size."
|
8745
|
-
},
|
8746
9144
|
{
|
8747
9145
|
"kind": "method",
|
8748
9146
|
"name": "setDisabled",
|
@@ -8787,19 +9185,6 @@
|
|
8787
9185
|
"name": "TabIndexMixin",
|
8788
9186
|
"module": "utils/mixins/TabIndexMixin.js"
|
8789
9187
|
}
|
8790
|
-
},
|
8791
|
-
{
|
8792
|
-
"kind": "field",
|
8793
|
-
"name": "iconName",
|
8794
|
-
"type": {
|
8795
|
-
"text": "IconNames | undefined"
|
8796
|
-
},
|
8797
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8798
|
-
"attribute": "icon-name",
|
8799
|
-
"inheritedFrom": {
|
8800
|
-
"name": "IconNameMixin",
|
8801
|
-
"module": "utils/mixins/IconNameMixin.js"
|
8802
|
-
}
|
8803
9188
|
}
|
8804
9189
|
],
|
8805
9190
|
"events": [
|
@@ -8843,15 +9228,6 @@
|
|
8843
9228
|
"default": "false",
|
8844
9229
|
"fieldName": "inverted"
|
8845
9230
|
},
|
8846
|
-
{
|
8847
|
-
"name": "size",
|
8848
|
-
"type": {
|
8849
|
-
"text": "LinkSize"
|
8850
|
-
},
|
8851
|
-
"description": "Size of the link.\nAcceptable values include:\n\n- 'small'\n- 'midsize'\n- 'large'",
|
8852
|
-
"default": "large",
|
8853
|
-
"fieldName": "size"
|
8854
|
-
},
|
8855
9231
|
{
|
8856
9232
|
"name": "href",
|
8857
9233
|
"type": {
|
@@ -8903,18 +9279,6 @@
|
|
8903
9279
|
"name": "TabIndexMixin",
|
8904
9280
|
"module": "src/utils/mixins/TabIndexMixin.ts"
|
8905
9281
|
}
|
8906
|
-
},
|
8907
|
-
{
|
8908
|
-
"name": "icon-name",
|
8909
|
-
"type": {
|
8910
|
-
"text": "IconNames | undefined"
|
8911
|
-
},
|
8912
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
8913
|
-
"fieldName": "iconName",
|
8914
|
-
"inheritedFrom": {
|
8915
|
-
"name": "IconNameMixin",
|
8916
|
-
"module": "src/utils/mixins/IconNameMixin.ts"
|
8917
|
-
}
|
8918
9282
|
}
|
8919
9283
|
],
|
8920
9284
|
"mixins": [
|
@@ -8925,18 +9289,14 @@
|
|
8925
9289
|
{
|
8926
9290
|
"name": "TabIndexMixin",
|
8927
9291
|
"module": "/src/utils/mixins/TabIndexMixin"
|
8928
|
-
},
|
8929
|
-
{
|
8930
|
-
"name": "IconNameMixin",
|
8931
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
8932
9292
|
}
|
8933
9293
|
],
|
8934
9294
|
"superclass": {
|
8935
9295
|
"name": "Component",
|
8936
9296
|
"module": "/src/models"
|
8937
9297
|
},
|
8938
|
-
"tagName": "mdc-
|
8939
|
-
"jsDoc": "/**\n * `mdc-
|
9298
|
+
"tagName": "mdc-linksimple",
|
9299
|
+
"jsDoc": "/**\n * `mdc-linksimple` is a lightweight link component that can be used to navigate\n * within the application or to an external URL. It does not have any predefined default size.\n *\n * The `children` of the `mdc-linksimple` component can be customized to suit\n * different use cases, including text, icons, or other inline content. For the child to be an icon,\n * the `mdc-icon` component should be used to render.\n *\n * @tagname mdc-linksimple\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n * @cssproperty --mdc-link-border-radius - Border radius of the link.\n * @cssproperty --mdc-link-color-active - Color of the link’s child content in the active state.\n * @cssproperty --mdc-link-color-disabled - Color of the link’s child content in the disabled state.\n * @cssproperty --mdc-link-color-hover - Color of the link’s child content in the hover state.\n * @cssproperty --mdc-link-color-normal - Color of the link’s child content in the normal state.\n * @cssproperty --mdc-link-inverted-color-active - Color of the inverted link’s child content in the active state.\n * @cssproperty --mdc-link-inverted-color-disabled - Color of the inverted link’s child content in the disabled state.\n * @cssproperty --mdc-link-inverted-color-hover - Color of the inverted link’s child content in the hover state.\n * @cssproperty --mdc-link-inverted-color-normal - Color of the inverted link’s child content in the normal state.\n */",
|
8940
9300
|
"customElement": true
|
8941
9301
|
}
|
8942
9302
|
],
|
@@ -8945,8 +9305,8 @@
|
|
8945
9305
|
"kind": "js",
|
8946
9306
|
"name": "default",
|
8947
9307
|
"declaration": {
|
8948
|
-
"name": "
|
8949
|
-
"module": "components/
|
9308
|
+
"name": "Linksimple",
|
9309
|
+
"module": "components/linksimple/linksimple.component.js"
|
8950
9310
|
}
|
8951
9311
|
}
|
8952
9312
|
]
|