@momentum-design/components 0.90.0 → 0.91.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 +359 -308
- package/dist/browser/index.js.map +4 -4
- package/dist/components/listheader/index.d.ts +9 -0
- package/dist/components/listheader/index.js +6 -0
- package/dist/components/listheader/listheader.component.d.ts +45 -0
- package/dist/components/listheader/listheader.component.js +85 -0
- package/dist/components/listheader/listheader.constants.d.ts +2 -0
- package/dist/components/listheader/listheader.constants.js +3 -0
- package/dist/components/listheader/listheader.styles.d.ts +2 -0
- package/dist/components/listheader/listheader.styles.js +30 -0
- package/dist/components/menusection/index.d.ts +1 -0
- package/dist/components/menusection/index.js +1 -0
- package/dist/components/menusection/menusection.component.d.ts +11 -3
- package/dist/components/menusection/menusection.component.js +16 -8
- package/dist/components/menusection/menusection.styles.js +4 -2
- package/dist/custom-elements.json +1000 -860
- package/dist/index.d.ts +2 -1
- package/dist/index.js +2 -1
- package/dist/react/index.d.ts +5 -4
- package/dist/react/index.js +5 -4
- package/dist/react/listheader/index.d.ts +15 -0
- package/dist/react/listheader/index.js +24 -0
- package/package.json +1 -1
@@ -530,67 +530,6 @@
|
|
530
530
|
}
|
531
531
|
]
|
532
532
|
},
|
533
|
-
{
|
534
|
-
"kind": "javascript-module",
|
535
|
-
"path": "components/appheader/appheader.component.js",
|
536
|
-
"declarations": [
|
537
|
-
{
|
538
|
-
"kind": "class",
|
539
|
-
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
540
|
-
"name": "Appheader",
|
541
|
-
"cssParts": [
|
542
|
-
{
|
543
|
-
"description": "The main container for styling the header.",
|
544
|
-
"name": "container"
|
545
|
-
},
|
546
|
-
{
|
547
|
-
"description": "The leading section of the header.",
|
548
|
-
"name": "leading-section"
|
549
|
-
},
|
550
|
-
{
|
551
|
-
"description": "The center section of the header.",
|
552
|
-
"name": "center-section"
|
553
|
-
},
|
554
|
-
{
|
555
|
-
"description": "The trailing section of the header.",
|
556
|
-
"name": "trailing-section"
|
557
|
-
}
|
558
|
-
],
|
559
|
-
"slots": [
|
560
|
-
{
|
561
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
562
|
-
"name": "leading"
|
563
|
-
},
|
564
|
-
{
|
565
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
566
|
-
"name": "center"
|
567
|
-
},
|
568
|
-
{
|
569
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
570
|
-
"name": "trailing"
|
571
|
-
}
|
572
|
-
],
|
573
|
-
"members": [],
|
574
|
-
"superclass": {
|
575
|
-
"name": "Component",
|
576
|
-
"module": "/src/models"
|
577
|
-
},
|
578
|
-
"tagName": "mdc-appheader",
|
579
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
580
|
-
"customElement": true
|
581
|
-
}
|
582
|
-
],
|
583
|
-
"exports": [
|
584
|
-
{
|
585
|
-
"kind": "js",
|
586
|
-
"name": "default",
|
587
|
-
"declaration": {
|
588
|
-
"name": "Appheader",
|
589
|
-
"module": "components/appheader/appheader.component.js"
|
590
|
-
}
|
591
|
-
}
|
592
|
-
]
|
593
|
-
},
|
594
533
|
{
|
595
534
|
"kind": "javascript-module",
|
596
535
|
"path": "components/animation/animation.component.js",
|
@@ -803,6 +742,67 @@
|
|
803
742
|
}
|
804
743
|
]
|
805
744
|
},
|
745
|
+
{
|
746
|
+
"kind": "javascript-module",
|
747
|
+
"path": "components/appheader/appheader.component.js",
|
748
|
+
"declarations": [
|
749
|
+
{
|
750
|
+
"kind": "class",
|
751
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
752
|
+
"name": "Appheader",
|
753
|
+
"cssParts": [
|
754
|
+
{
|
755
|
+
"description": "The main container for styling the header.",
|
756
|
+
"name": "container"
|
757
|
+
},
|
758
|
+
{
|
759
|
+
"description": "The leading section of the header.",
|
760
|
+
"name": "leading-section"
|
761
|
+
},
|
762
|
+
{
|
763
|
+
"description": "The center section of the header.",
|
764
|
+
"name": "center-section"
|
765
|
+
},
|
766
|
+
{
|
767
|
+
"description": "The trailing section of the header.",
|
768
|
+
"name": "trailing-section"
|
769
|
+
}
|
770
|
+
],
|
771
|
+
"slots": [
|
772
|
+
{
|
773
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
774
|
+
"name": "leading"
|
775
|
+
},
|
776
|
+
{
|
777
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
778
|
+
"name": "center"
|
779
|
+
},
|
780
|
+
{
|
781
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
782
|
+
"name": "trailing"
|
783
|
+
}
|
784
|
+
],
|
785
|
+
"members": [],
|
786
|
+
"superclass": {
|
787
|
+
"name": "Component",
|
788
|
+
"module": "/src/models"
|
789
|
+
},
|
790
|
+
"tagName": "mdc-appheader",
|
791
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
792
|
+
"customElement": true
|
793
|
+
}
|
794
|
+
],
|
795
|
+
"exports": [
|
796
|
+
{
|
797
|
+
"kind": "js",
|
798
|
+
"name": "default",
|
799
|
+
"declaration": {
|
800
|
+
"name": "Appheader",
|
801
|
+
"module": "components/appheader/appheader.component.js"
|
802
|
+
}
|
803
|
+
}
|
804
|
+
]
|
805
|
+
},
|
806
806
|
{
|
807
807
|
"kind": "javascript-module",
|
808
808
|
"path": "components/avatar/avatar.component.js",
|
@@ -1071,1007 +1071,1007 @@
|
|
1071
1071
|
},
|
1072
1072
|
{
|
1073
1073
|
"kind": "javascript-module",
|
1074
|
-
"path": "components/
|
1074
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
1075
1075
|
"declarations": [
|
1076
1076
|
{
|
1077
1077
|
"kind": "class",
|
1078
|
-
"description": "The `mdc-
|
1079
|
-
"name": "
|
1078
|
+
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
1079
|
+
"name": "AvatarButton",
|
1080
1080
|
"cssProperties": [
|
1081
1081
|
{
|
1082
|
-
"description": "
|
1083
|
-
"name": "--mdc-
|
1084
|
-
},
|
1085
|
-
{
|
1086
|
-
"description": "The background color of the primary badge.",
|
1087
|
-
"name": "--mdc-badge-primary-background-color"
|
1088
|
-
},
|
1089
|
-
{
|
1090
|
-
"description": "The foreground color of the secondary badge.",
|
1091
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
1082
|
+
"description": "Background color of the overlay in rest state",
|
1083
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
1092
1084
|
},
|
1093
1085
|
{
|
1094
|
-
"description": "
|
1095
|
-
"name": "--mdc-
|
1086
|
+
"description": "Background color of the overlay in hover state",
|
1087
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
1096
1088
|
},
|
1097
1089
|
{
|
1098
|
-
"description": "
|
1099
|
-
"name": "--mdc-
|
1100
|
-
}
|
1090
|
+
"description": "Background color of the overlay in active state",
|
1091
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
1092
|
+
}
|
1093
|
+
],
|
1094
|
+
"cssParts": [
|
1101
1095
|
{
|
1102
|
-
"description": "The
|
1103
|
-
"name": "
|
1096
|
+
"description": "The overlay part of the avatar button.",
|
1097
|
+
"name": "overlay"
|
1104
1098
|
},
|
1105
1099
|
{
|
1106
|
-
"description": "The
|
1107
|
-
"name": "
|
1100
|
+
"description": "The main content of the avatar.",
|
1101
|
+
"name": "content"
|
1108
1102
|
},
|
1109
1103
|
{
|
1110
|
-
"description": "The
|
1111
|
-
"name": "
|
1104
|
+
"description": "The photo part of the avatar.",
|
1105
|
+
"name": "photo"
|
1112
1106
|
},
|
1113
1107
|
{
|
1114
|
-
"description": "The
|
1115
|
-
"name": "
|
1108
|
+
"description": "The presence indicator part of the avatar.",
|
1109
|
+
"name": "presence"
|
1116
1110
|
},
|
1117
1111
|
{
|
1118
|
-
"description": "The
|
1119
|
-
"name": "
|
1112
|
+
"description": "The wrapper for the loading indicator of the avatar.",
|
1113
|
+
"name": "loading-wrapper"
|
1120
1114
|
},
|
1121
1115
|
{
|
1122
|
-
"description": "The
|
1123
|
-
"name": "
|
1116
|
+
"description": "The loading indicator part of the avatar.",
|
1117
|
+
"name": "loader"
|
1124
1118
|
}
|
1125
1119
|
],
|
1126
1120
|
"members": [
|
1127
1121
|
{
|
1128
1122
|
"kind": "field",
|
1129
|
-
"name": "
|
1123
|
+
"name": "ariaLabel",
|
1130
1124
|
"type": {
|
1131
|
-
"text": "
|
1125
|
+
"text": "string | null"
|
1132
1126
|
},
|
1133
|
-
"
|
1134
|
-
"
|
1135
|
-
"
|
1127
|
+
"default": "null",
|
1128
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1129
|
+
"attribute": "aria-label"
|
1130
|
+
},
|
1131
|
+
{
|
1132
|
+
"kind": "method",
|
1133
|
+
"name": "setSize",
|
1134
|
+
"privacy": "private",
|
1135
|
+
"parameters": [
|
1136
|
+
{
|
1137
|
+
"name": "size",
|
1138
|
+
"type": {
|
1139
|
+
"text": "AvatarSize"
|
1140
|
+
}
|
1141
|
+
}
|
1142
|
+
]
|
1136
1143
|
},
|
1137
1144
|
{
|
1138
1145
|
"kind": "field",
|
1139
|
-
"name": "
|
1146
|
+
"name": "src",
|
1140
1147
|
"type": {
|
1141
|
-
"text": "
|
1148
|
+
"text": "string | undefined"
|
1142
1149
|
},
|
1143
|
-
"description": "
|
1144
|
-
"
|
1145
|
-
"
|
1146
|
-
|
1150
|
+
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
1151
|
+
"attribute": "src",
|
1152
|
+
"inheritedFrom": {
|
1153
|
+
"name": "AvatarComponentMixin",
|
1154
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1155
|
+
}
|
1147
1156
|
},
|
1148
1157
|
{
|
1149
1158
|
"kind": "field",
|
1150
|
-
"name": "
|
1159
|
+
"name": "initials",
|
1151
1160
|
"type": {
|
1152
|
-
"text": "
|
1161
|
+
"text": "string | undefined"
|
1153
1162
|
},
|
1154
|
-
"description": "
|
1155
|
-
"attribute": "
|
1163
|
+
"description": "The initials to be displayed for the avatar.",
|
1164
|
+
"attribute": "initials",
|
1165
|
+
"inheritedFrom": {
|
1166
|
+
"name": "AvatarComponentMixin",
|
1167
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1168
|
+
}
|
1156
1169
|
},
|
1157
1170
|
{
|
1158
1171
|
"kind": "field",
|
1159
|
-
"name": "
|
1172
|
+
"name": "presence",
|
1160
1173
|
"type": {
|
1161
|
-
"text": "
|
1174
|
+
"text": "PresenceType | undefined"
|
1162
1175
|
},
|
1163
|
-
"description": "The
|
1164
|
-
"
|
1165
|
-
"
|
1166
|
-
|
1176
|
+
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
1177
|
+
"attribute": "presence",
|
1178
|
+
"inheritedFrom": {
|
1179
|
+
"name": "AvatarComponentMixin",
|
1180
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1181
|
+
}
|
1167
1182
|
},
|
1168
1183
|
{
|
1169
1184
|
"kind": "field",
|
1170
|
-
"name": "
|
1185
|
+
"name": "size",
|
1171
1186
|
"type": {
|
1172
|
-
"text": "
|
1187
|
+
"text": "ButtonSize"
|
1173
1188
|
},
|
1174
|
-
"
|
1175
|
-
"
|
1176
|
-
"attribute": "
|
1189
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1190
|
+
"default": "32",
|
1191
|
+
"attribute": "size",
|
1192
|
+
"reflects": true,
|
1193
|
+
"inheritedFrom": {
|
1194
|
+
"name": "Buttonsimple",
|
1195
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1196
|
+
}
|
1177
1197
|
},
|
1178
1198
|
{
|
1179
1199
|
"kind": "field",
|
1180
|
-
"name": "
|
1200
|
+
"name": "counter",
|
1181
1201
|
"type": {
|
1182
|
-
"text": "
|
1202
|
+
"text": "number | undefined"
|
1183
1203
|
},
|
1184
|
-
"
|
1185
|
-
"
|
1186
|
-
"
|
1204
|
+
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
1205
|
+
"attribute": "counter",
|
1206
|
+
"inheritedFrom": {
|
1207
|
+
"name": "AvatarComponentMixin",
|
1208
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1209
|
+
}
|
1187
1210
|
},
|
1188
1211
|
{
|
1189
|
-
"kind": "
|
1190
|
-
"name": "
|
1191
|
-
"
|
1192
|
-
|
1193
|
-
"type": {
|
1194
|
-
"text": ""
|
1195
|
-
}
|
1212
|
+
"kind": "field",
|
1213
|
+
"name": "isTyping",
|
1214
|
+
"type": {
|
1215
|
+
"text": "boolean"
|
1196
1216
|
},
|
1197
|
-
"
|
1198
|
-
|
1199
|
-
|
1200
|
-
|
1201
|
-
|
1202
|
-
|
1203
|
-
|
1204
|
-
},
|
1205
|
-
{
|
1206
|
-
"name": "counter",
|
1207
|
-
"optional": true,
|
1208
|
-
"type": {
|
1209
|
-
"text": "number"
|
1210
|
-
},
|
1211
|
-
"description": "the number to be displayed on the badge"
|
1212
|
-
}
|
1213
|
-
],
|
1214
|
-
"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."
|
1217
|
+
"default": "false",
|
1218
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1219
|
+
"attribute": "is-typing",
|
1220
|
+
"inheritedFrom": {
|
1221
|
+
"name": "AvatarComponentMixin",
|
1222
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1223
|
+
}
|
1215
1224
|
},
|
1216
1225
|
{
|
1217
|
-
"kind": "
|
1218
|
-
"name": "
|
1219
|
-
"
|
1220
|
-
|
1221
|
-
"type": {
|
1222
|
-
"text": ""
|
1223
|
-
}
|
1226
|
+
"kind": "field",
|
1227
|
+
"name": "iconName",
|
1228
|
+
"type": {
|
1229
|
+
"text": "IconNames | undefined"
|
1224
1230
|
},
|
1225
|
-
"
|
1226
|
-
|
1227
|
-
|
1228
|
-
|
1229
|
-
|
1230
|
-
|
1231
|
-
"description": "the name of the icon from the icon set"
|
1232
|
-
},
|
1233
|
-
{
|
1234
|
-
"name": "backgroundClassPostfix",
|
1235
|
-
"type": {
|
1236
|
-
"text": "string"
|
1237
|
-
},
|
1238
|
-
"description": "postfix for the class to style the badge icon."
|
1239
|
-
}
|
1240
|
-
],
|
1241
|
-
"description": "Method to generate the badge icon."
|
1231
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1232
|
+
"attribute": "icon-name",
|
1233
|
+
"inheritedFrom": {
|
1234
|
+
"name": "IconNameMixin",
|
1235
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1236
|
+
}
|
1242
1237
|
},
|
1243
1238
|
{
|
1244
|
-
"kind": "
|
1245
|
-
"name": "
|
1246
|
-
"
|
1247
|
-
|
1248
|
-
"type": {
|
1249
|
-
"text": ""
|
1250
|
-
}
|
1239
|
+
"kind": "field",
|
1240
|
+
"name": "autofocus",
|
1241
|
+
"type": {
|
1242
|
+
"text": "boolean"
|
1251
1243
|
},
|
1252
|
-
"
|
1244
|
+
"default": "false",
|
1245
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
1246
|
+
"attribute": "autofocus",
|
1247
|
+
"reflects": true,
|
1248
|
+
"inheritedFrom": {
|
1249
|
+
"name": "AutoFocusMixin",
|
1250
|
+
"module": "utils/mixins/AutoFocusMixin.js"
|
1251
|
+
}
|
1253
1252
|
},
|
1254
1253
|
{
|
1255
|
-
"kind": "
|
1256
|
-
"name": "
|
1257
|
-
"
|
1258
|
-
|
1259
|
-
"type": {
|
1260
|
-
"text": ""
|
1261
|
-
}
|
1254
|
+
"kind": "field",
|
1255
|
+
"name": "tabIndex",
|
1256
|
+
"type": {
|
1257
|
+
"text": "number"
|
1262
1258
|
},
|
1263
|
-
"
|
1259
|
+
"default": "0",
|
1260
|
+
"description": "This property specifies the tab order of the element.",
|
1261
|
+
"attribute": "tabIndex",
|
1262
|
+
"reflects": true,
|
1263
|
+
"inheritedFrom": {
|
1264
|
+
"name": "TabIndexMixin",
|
1265
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1266
|
+
}
|
1264
1267
|
},
|
1265
1268
|
{
|
1266
|
-
"kind": "
|
1267
|
-
"name": "
|
1268
|
-
"
|
1269
|
-
|
1270
|
-
"type": {
|
1271
|
-
"text": "void"
|
1272
|
-
}
|
1269
|
+
"kind": "field",
|
1270
|
+
"name": "disabled",
|
1271
|
+
"type": {
|
1272
|
+
"text": "boolean | undefined"
|
1273
1273
|
},
|
1274
|
-
"description": "
|
1274
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1275
|
+
"default": "undefined",
|
1276
|
+
"attribute": "disabled",
|
1277
|
+
"reflects": true,
|
1278
|
+
"inheritedFrom": {
|
1279
|
+
"name": "DisabledMixin",
|
1280
|
+
"module": "utils/mixins/DisabledMixin.js"
|
1281
|
+
}
|
1275
1282
|
},
|
1276
1283
|
{
|
1277
|
-
"kind": "
|
1278
|
-
"name": "
|
1279
|
-
"
|
1280
|
-
|
1281
|
-
"type": {
|
1282
|
-
"text": ""
|
1283
|
-
}
|
1284
|
+
"kind": "field",
|
1285
|
+
"name": "active",
|
1286
|
+
"type": {
|
1287
|
+
"text": "boolean | undefined"
|
1284
1288
|
},
|
1285
|
-
"description": "
|
1289
|
+
"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.",
|
1290
|
+
"default": "undefined",
|
1291
|
+
"attribute": "active",
|
1292
|
+
"reflects": true,
|
1293
|
+
"inheritedFrom": {
|
1294
|
+
"name": "Buttonsimple",
|
1295
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1296
|
+
}
|
1286
1297
|
},
|
1287
1298
|
{
|
1288
1299
|
"kind": "field",
|
1289
|
-
"name": "
|
1300
|
+
"name": "softDisabled",
|
1290
1301
|
"type": {
|
1291
|
-
"text": "
|
1302
|
+
"text": "boolean | undefined"
|
1292
1303
|
},
|
1293
|
-
"description": "
|
1294
|
-
"
|
1304
|
+
"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.",
|
1305
|
+
"default": "undefined",
|
1306
|
+
"attribute": "soft-disabled",
|
1307
|
+
"reflects": true,
|
1295
1308
|
"inheritedFrom": {
|
1296
|
-
"name": "
|
1297
|
-
"module": "
|
1309
|
+
"name": "Buttonsimple",
|
1310
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1298
1311
|
}
|
1299
|
-
}
|
1300
|
-
],
|
1301
|
-
"attributes": [
|
1312
|
+
},
|
1302
1313
|
{
|
1303
|
-
"
|
1304
|
-
"
|
1305
|
-
|
1306
|
-
|
1307
|
-
"
|
1308
|
-
"
|
1314
|
+
"kind": "field",
|
1315
|
+
"name": "role",
|
1316
|
+
"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.",
|
1317
|
+
"default": "button",
|
1318
|
+
"attribute": "role",
|
1319
|
+
"reflects": true,
|
1320
|
+
"inheritedFrom": {
|
1321
|
+
"name": "Buttonsimple",
|
1322
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1323
|
+
}
|
1309
1324
|
},
|
1310
1325
|
{
|
1311
|
-
"
|
1326
|
+
"kind": "field",
|
1327
|
+
"name": "ariaStateKey",
|
1312
1328
|
"type": {
|
1313
|
-
"text": "
|
1329
|
+
"text": "string | undefined"
|
1314
1330
|
},
|
1315
|
-
"description": "
|
1316
|
-
"default": "
|
1317
|
-
"
|
1331
|
+
"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`",
|
1332
|
+
"default": "'aria-pressed' (when)",
|
1333
|
+
"attribute": "ariaStateKey",
|
1334
|
+
"reflects": true,
|
1335
|
+
"inheritedFrom": {
|
1336
|
+
"name": "Buttonsimple",
|
1337
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1338
|
+
}
|
1318
1339
|
},
|
1319
1340
|
{
|
1320
|
-
"
|
1341
|
+
"kind": "field",
|
1342
|
+
"name": "type",
|
1321
1343
|
"type": {
|
1322
|
-
"text": "
|
1344
|
+
"text": "ButtonType"
|
1323
1345
|
},
|
1324
|
-
"description": "
|
1325
|
-
"
|
1346
|
+
"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.",
|
1347
|
+
"default": "button",
|
1348
|
+
"attribute": "type",
|
1349
|
+
"reflects": true,
|
1350
|
+
"inheritedFrom": {
|
1351
|
+
"name": "Buttonsimple",
|
1352
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1353
|
+
}
|
1326
1354
|
},
|
1327
1355
|
{
|
1328
|
-
"
|
1329
|
-
"
|
1330
|
-
|
1331
|
-
|
1332
|
-
|
1333
|
-
|
1334
|
-
|
1356
|
+
"kind": "method",
|
1357
|
+
"name": "executeAction",
|
1358
|
+
"privacy": "protected",
|
1359
|
+
"inheritedFrom": {
|
1360
|
+
"name": "Buttonsimple",
|
1361
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1362
|
+
}
|
1335
1363
|
},
|
1336
1364
|
{
|
1337
|
-
"
|
1338
|
-
"
|
1339
|
-
|
1340
|
-
|
1341
|
-
|
1342
|
-
|
1343
|
-
|
1365
|
+
"kind": "method",
|
1366
|
+
"name": "setActive",
|
1367
|
+
"privacy": "protected",
|
1368
|
+
"parameters": [
|
1369
|
+
{
|
1370
|
+
"name": "element",
|
1371
|
+
"type": {
|
1372
|
+
"text": "HTMLElement"
|
1373
|
+
},
|
1374
|
+
"description": "The button element"
|
1375
|
+
},
|
1376
|
+
{
|
1377
|
+
"name": "active",
|
1378
|
+
"optional": true,
|
1379
|
+
"type": {
|
1380
|
+
"text": "boolean"
|
1381
|
+
},
|
1382
|
+
"description": "The active state of the element"
|
1383
|
+
}
|
1384
|
+
],
|
1385
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
1386
|
+
"inheritedFrom": {
|
1387
|
+
"name": "Buttonsimple",
|
1388
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1389
|
+
}
|
1390
|
+
},
|
1391
|
+
{
|
1392
|
+
"kind": "method",
|
1393
|
+
"name": "setSoftDisabled",
|
1394
|
+
"privacy": "private",
|
1395
|
+
"parameters": [
|
1396
|
+
{
|
1397
|
+
"name": "element",
|
1398
|
+
"type": {
|
1399
|
+
"text": "HTMLElement"
|
1400
|
+
},
|
1401
|
+
"description": "The button element."
|
1402
|
+
},
|
1403
|
+
{
|
1404
|
+
"name": "softDisabled",
|
1405
|
+
"optional": true,
|
1406
|
+
"type": {
|
1407
|
+
"text": "boolean"
|
1408
|
+
},
|
1409
|
+
"description": "The soft-disabled state."
|
1410
|
+
}
|
1411
|
+
],
|
1412
|
+
"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.",
|
1413
|
+
"inheritedFrom": {
|
1414
|
+
"name": "Buttonsimple",
|
1415
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1416
|
+
}
|
1344
1417
|
},
|
1345
1418
|
{
|
1346
|
-
"
|
1347
|
-
"
|
1348
|
-
|
1349
|
-
|
1350
|
-
|
1351
|
-
|
1352
|
-
|
1419
|
+
"kind": "method",
|
1420
|
+
"name": "setDisabled",
|
1421
|
+
"privacy": "private",
|
1422
|
+
"parameters": [
|
1423
|
+
{
|
1424
|
+
"name": "element",
|
1425
|
+
"type": {
|
1426
|
+
"text": "HTMLElement"
|
1427
|
+
},
|
1428
|
+
"description": "The button element."
|
1429
|
+
},
|
1430
|
+
{
|
1431
|
+
"name": "disabled",
|
1432
|
+
"type": {
|
1433
|
+
"text": "boolean"
|
1434
|
+
},
|
1435
|
+
"description": "The disabled state."
|
1436
|
+
}
|
1437
|
+
],
|
1438
|
+
"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.",
|
1439
|
+
"inheritedFrom": {
|
1440
|
+
"name": "Buttonsimple",
|
1441
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1442
|
+
}
|
1353
1443
|
},
|
1354
1444
|
{
|
1355
|
-
"
|
1356
|
-
"
|
1357
|
-
|
1358
|
-
},
|
1359
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1360
|
-
"fieldName": "iconName",
|
1445
|
+
"kind": "method",
|
1446
|
+
"name": "triggerClickEvent",
|
1447
|
+
"privacy": "private",
|
1361
1448
|
"inheritedFrom": {
|
1362
|
-
"name": "
|
1363
|
-
"module": "
|
1449
|
+
"name": "Buttonsimple",
|
1450
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1364
1451
|
}
|
1365
|
-
}
|
1366
|
-
],
|
1367
|
-
"mixins": [
|
1368
|
-
{
|
1369
|
-
"name": "IconNameMixin",
|
1370
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
1371
|
-
}
|
1372
|
-
],
|
1373
|
-
"superclass": {
|
1374
|
-
"name": "Component",
|
1375
|
-
"module": "/src/models"
|
1376
|
-
},
|
1377
|
-
"tagName": "mdc-badge",
|
1378
|
-
"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 */",
|
1379
|
-
"customElement": true
|
1380
|
-
}
|
1381
|
-
],
|
1382
|
-
"exports": [
|
1383
|
-
{
|
1384
|
-
"kind": "js",
|
1385
|
-
"name": "default",
|
1386
|
-
"declaration": {
|
1387
|
-
"name": "Badge",
|
1388
|
-
"module": "components/badge/badge.component.js"
|
1389
|
-
}
|
1390
|
-
}
|
1391
|
-
]
|
1392
|
-
},
|
1393
|
-
{
|
1394
|
-
"kind": "javascript-module",
|
1395
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
1396
|
-
"declarations": [
|
1397
|
-
{
|
1398
|
-
"kind": "class",
|
1399
|
-
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
1400
|
-
"name": "AvatarButton",
|
1401
|
-
"cssProperties": [
|
1452
|
+
},
|
1402
1453
|
{
|
1403
|
-
"
|
1404
|
-
"name": "
|
1454
|
+
"kind": "method",
|
1455
|
+
"name": "handleBlur",
|
1456
|
+
"privacy": "private",
|
1457
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
1458
|
+
"inheritedFrom": {
|
1459
|
+
"name": "Buttonsimple",
|
1460
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1461
|
+
}
|
1405
1462
|
},
|
1406
1463
|
{
|
1407
|
-
"
|
1408
|
-
"name": "
|
1464
|
+
"kind": "method",
|
1465
|
+
"name": "handleKeyDown",
|
1466
|
+
"privacy": "private",
|
1467
|
+
"parameters": [
|
1468
|
+
{
|
1469
|
+
"name": "event",
|
1470
|
+
"type": {
|
1471
|
+
"text": "KeyboardEvent"
|
1472
|
+
},
|
1473
|
+
"description": "The keyboard event."
|
1474
|
+
}
|
1475
|
+
],
|
1476
|
+
"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.",
|
1477
|
+
"inheritedFrom": {
|
1478
|
+
"name": "Buttonsimple",
|
1479
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1480
|
+
}
|
1409
1481
|
},
|
1410
1482
|
{
|
1411
|
-
"
|
1412
|
-
"name": "
|
1483
|
+
"kind": "method",
|
1484
|
+
"name": "handleKeyUp",
|
1485
|
+
"privacy": "private",
|
1486
|
+
"parameters": [
|
1487
|
+
{
|
1488
|
+
"name": "event",
|
1489
|
+
"type": {
|
1490
|
+
"text": "KeyboardEvent"
|
1491
|
+
},
|
1492
|
+
"description": "The keyboard event."
|
1493
|
+
}
|
1494
|
+
],
|
1495
|
+
"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.",
|
1496
|
+
"inheritedFrom": {
|
1497
|
+
"name": "Buttonsimple",
|
1498
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1499
|
+
}
|
1413
1500
|
}
|
1414
1501
|
],
|
1415
|
-
"
|
1416
|
-
{
|
1417
|
-
"description": "The overlay part of the avatar button.",
|
1418
|
-
"name": "overlay"
|
1419
|
-
},
|
1420
|
-
{
|
1421
|
-
"description": "The main content of the avatar.",
|
1422
|
-
"name": "content"
|
1423
|
-
},
|
1502
|
+
"events": [
|
1424
1503
|
{
|
1425
|
-
"description": "
|
1426
|
-
"name": "
|
1504
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
1505
|
+
"name": "click",
|
1506
|
+
"reactName": "onClick",
|
1507
|
+
"inheritedFrom": {
|
1508
|
+
"name": "Buttonsimple",
|
1509
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1510
|
+
}
|
1427
1511
|
},
|
1428
1512
|
{
|
1429
|
-
"description": "
|
1430
|
-
"name": "
|
1513
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
1514
|
+
"name": "keydown",
|
1515
|
+
"reactName": "onKeyDown",
|
1516
|
+
"inheritedFrom": {
|
1517
|
+
"name": "Buttonsimple",
|
1518
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1519
|
+
}
|
1431
1520
|
},
|
1432
1521
|
{
|
1433
|
-
"description": "
|
1434
|
-
"name": "
|
1522
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
1523
|
+
"name": "keyup",
|
1524
|
+
"reactName": "onKeyUp",
|
1525
|
+
"inheritedFrom": {
|
1526
|
+
"name": "Buttonsimple",
|
1527
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1528
|
+
}
|
1435
1529
|
},
|
1436
1530
|
{
|
1437
|
-
"description": "
|
1438
|
-
"name": "
|
1531
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
1532
|
+
"name": "focus",
|
1533
|
+
"reactName": "onFocus",
|
1534
|
+
"inheritedFrom": {
|
1535
|
+
"name": "Buttonsimple",
|
1536
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1537
|
+
}
|
1439
1538
|
}
|
1440
1539
|
],
|
1441
|
-
"
|
1540
|
+
"attributes": [
|
1442
1541
|
{
|
1443
|
-
"
|
1444
|
-
"name": "ariaLabel",
|
1542
|
+
"name": "aria-label",
|
1445
1543
|
"type": {
|
1446
1544
|
"text": "string | null"
|
1447
1545
|
},
|
1448
1546
|
"default": "null",
|
1449
1547
|
"description": "Aria-label attribute to be set for accessibility",
|
1450
|
-
"
|
1451
|
-
},
|
1452
|
-
{
|
1453
|
-
"kind": "method",
|
1454
|
-
"name": "setSize",
|
1455
|
-
"privacy": "private",
|
1456
|
-
"parameters": [
|
1457
|
-
{
|
1458
|
-
"name": "size",
|
1459
|
-
"type": {
|
1460
|
-
"text": "AvatarSize"
|
1461
|
-
}
|
1462
|
-
}
|
1463
|
-
]
|
1548
|
+
"fieldName": "ariaLabel"
|
1464
1549
|
},
|
1465
1550
|
{
|
1466
|
-
"kind": "field",
|
1467
1551
|
"name": "src",
|
1468
1552
|
"type": {
|
1469
1553
|
"text": "string | undefined"
|
1470
1554
|
},
|
1471
1555
|
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
1472
|
-
"
|
1556
|
+
"fieldName": "src",
|
1473
1557
|
"inheritedFrom": {
|
1474
1558
|
"name": "AvatarComponentMixin",
|
1475
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1559
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1476
1560
|
}
|
1477
1561
|
},
|
1478
1562
|
{
|
1479
|
-
"kind": "field",
|
1480
1563
|
"name": "initials",
|
1481
1564
|
"type": {
|
1482
1565
|
"text": "string | undefined"
|
1483
1566
|
},
|
1484
1567
|
"description": "The initials to be displayed for the avatar.",
|
1485
|
-
"
|
1568
|
+
"fieldName": "initials",
|
1486
1569
|
"inheritedFrom": {
|
1487
1570
|
"name": "AvatarComponentMixin",
|
1488
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1571
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1489
1572
|
}
|
1490
1573
|
},
|
1491
1574
|
{
|
1492
|
-
"kind": "field",
|
1493
1575
|
"name": "presence",
|
1494
1576
|
"type": {
|
1495
1577
|
"text": "PresenceType | undefined"
|
1496
1578
|
},
|
1497
1579
|
"description": "The presence is the status which can be used to display the\nactivity state of a user or a space within an avatar component.\n\nAcceptable values include:\n- `active`\n- `away`\n- `away-calling`\n- `busy`\n- `dnd`\n- `meeting`\n- `on-call`\n- `on-device`\n- `on-mobile`\n- `pause`\n- `pto`\n- `presenting`\n- `quiet`\n- `scheduled`",
|
1498
|
-
"
|
1580
|
+
"fieldName": "presence",
|
1499
1581
|
"inheritedFrom": {
|
1500
1582
|
"name": "AvatarComponentMixin",
|
1501
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1583
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1502
1584
|
}
|
1503
1585
|
},
|
1504
1586
|
{
|
1505
|
-
"kind": "field",
|
1506
1587
|
"name": "size",
|
1507
1588
|
"type": {
|
1508
1589
|
"text": "ButtonSize"
|
1509
1590
|
},
|
1510
1591
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1511
1592
|
"default": "32",
|
1512
|
-
"
|
1513
|
-
"reflects": true,
|
1593
|
+
"fieldName": "size",
|
1514
1594
|
"inheritedFrom": {
|
1515
1595
|
"name": "Buttonsimple",
|
1516
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1596
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1517
1597
|
}
|
1518
1598
|
},
|
1519
1599
|
{
|
1520
|
-
"kind": "field",
|
1521
1600
|
"name": "counter",
|
1522
1601
|
"type": {
|
1523
1602
|
"text": "number | undefined"
|
1524
1603
|
},
|
1525
1604
|
"description": "The counter is the number which can be displayed on the avatar.\nThe maximum number is 99 and if the given number is greater than 99,\nthen the avatar will be displayed as `99+`.\nIf the given number is a negative number,\nthen the avatar will be displayed as `0`.",
|
1526
|
-
"
|
1605
|
+
"fieldName": "counter",
|
1527
1606
|
"inheritedFrom": {
|
1528
1607
|
"name": "AvatarComponentMixin",
|
1529
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1608
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1530
1609
|
}
|
1531
1610
|
},
|
1532
1611
|
{
|
1533
|
-
"
|
1534
|
-
"name": "isTyping",
|
1612
|
+
"name": "is-typing",
|
1535
1613
|
"type": {
|
1536
1614
|
"text": "boolean"
|
1537
1615
|
},
|
1538
1616
|
"default": "false",
|
1539
1617
|
"description": "Represents the typing indicator when the user is typing.",
|
1540
|
-
"
|
1618
|
+
"fieldName": "isTyping",
|
1541
1619
|
"inheritedFrom": {
|
1542
1620
|
"name": "AvatarComponentMixin",
|
1543
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1621
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1544
1622
|
}
|
1545
1623
|
},
|
1546
1624
|
{
|
1547
|
-
"
|
1548
|
-
"name": "iconName",
|
1625
|
+
"name": "icon-name",
|
1549
1626
|
"type": {
|
1550
1627
|
"text": "IconNames | undefined"
|
1551
1628
|
},
|
1552
1629
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1553
|
-
"
|
1630
|
+
"fieldName": "iconName",
|
1554
1631
|
"inheritedFrom": {
|
1555
1632
|
"name": "IconNameMixin",
|
1556
|
-
"module": "utils/mixins/IconNameMixin.
|
1633
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1557
1634
|
}
|
1558
1635
|
},
|
1559
1636
|
{
|
1560
|
-
"kind": "field",
|
1561
1637
|
"name": "autofocus",
|
1562
1638
|
"type": {
|
1563
1639
|
"text": "boolean"
|
1564
1640
|
},
|
1565
1641
|
"default": "false",
|
1566
1642
|
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
1567
|
-
"
|
1568
|
-
"reflects": true,
|
1643
|
+
"fieldName": "autofocus",
|
1569
1644
|
"inheritedFrom": {
|
1570
1645
|
"name": "AutoFocusMixin",
|
1571
|
-
"module": "utils/mixins/AutoFocusMixin.
|
1646
|
+
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
1572
1647
|
}
|
1573
1648
|
},
|
1574
1649
|
{
|
1575
|
-
"kind": "field",
|
1576
1650
|
"name": "tabIndex",
|
1577
1651
|
"type": {
|
1578
1652
|
"text": "number"
|
1579
1653
|
},
|
1580
1654
|
"default": "0",
|
1581
1655
|
"description": "This property specifies the tab order of the element.",
|
1582
|
-
"
|
1583
|
-
"reflects": true,
|
1656
|
+
"fieldName": "tabIndex",
|
1584
1657
|
"inheritedFrom": {
|
1585
1658
|
"name": "TabIndexMixin",
|
1586
|
-
"module": "utils/mixins/TabIndexMixin.
|
1659
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1587
1660
|
}
|
1588
1661
|
},
|
1589
1662
|
{
|
1590
|
-
"kind": "field",
|
1591
1663
|
"name": "disabled",
|
1592
1664
|
"type": {
|
1593
1665
|
"text": "boolean | undefined"
|
1594
1666
|
},
|
1595
1667
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1596
1668
|
"default": "undefined",
|
1597
|
-
"
|
1598
|
-
"reflects": true,
|
1669
|
+
"fieldName": "disabled",
|
1599
1670
|
"inheritedFrom": {
|
1600
1671
|
"name": "DisabledMixin",
|
1601
|
-
"module": "utils/mixins/DisabledMixin.
|
1672
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1602
1673
|
}
|
1603
1674
|
},
|
1604
1675
|
{
|
1605
|
-
"kind": "field",
|
1606
1676
|
"name": "active",
|
1607
1677
|
"type": {
|
1608
1678
|
"text": "boolean | undefined"
|
1609
1679
|
},
|
1610
1680
|
"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.",
|
1611
1681
|
"default": "undefined",
|
1612
|
-
"
|
1613
|
-
"reflects": true,
|
1682
|
+
"fieldName": "active",
|
1614
1683
|
"inheritedFrom": {
|
1615
1684
|
"name": "Buttonsimple",
|
1616
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1685
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1617
1686
|
}
|
1618
1687
|
},
|
1619
1688
|
{
|
1620
|
-
"
|
1621
|
-
"name": "softDisabled",
|
1689
|
+
"name": "soft-disabled",
|
1622
1690
|
"type": {
|
1623
1691
|
"text": "boolean | undefined"
|
1624
1692
|
},
|
1625
1693
|
"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.",
|
1626
1694
|
"default": "undefined",
|
1627
|
-
"
|
1628
|
-
"reflects": true,
|
1695
|
+
"fieldName": "softDisabled",
|
1629
1696
|
"inheritedFrom": {
|
1630
1697
|
"name": "Buttonsimple",
|
1631
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1698
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1632
1699
|
}
|
1633
1700
|
},
|
1634
1701
|
{
|
1635
|
-
"kind": "field",
|
1636
1702
|
"name": "role",
|
1637
1703
|
"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.",
|
1638
1704
|
"default": "button",
|
1639
|
-
"
|
1640
|
-
"reflects": true,
|
1705
|
+
"fieldName": "role",
|
1641
1706
|
"inheritedFrom": {
|
1642
1707
|
"name": "Buttonsimple",
|
1643
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1708
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1644
1709
|
}
|
1645
1710
|
},
|
1646
1711
|
{
|
1647
|
-
"kind": "field",
|
1648
1712
|
"name": "ariaStateKey",
|
1649
1713
|
"type": {
|
1650
1714
|
"text": "string | undefined"
|
1651
1715
|
},
|
1652
1716
|
"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`",
|
1653
1717
|
"default": "'aria-pressed' (when)",
|
1654
|
-
"
|
1655
|
-
"reflects": true,
|
1718
|
+
"fieldName": "ariaStateKey",
|
1656
1719
|
"inheritedFrom": {
|
1657
1720
|
"name": "Buttonsimple",
|
1658
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1721
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1659
1722
|
}
|
1660
1723
|
},
|
1661
1724
|
{
|
1662
|
-
"kind": "field",
|
1663
1725
|
"name": "type",
|
1664
1726
|
"type": {
|
1665
1727
|
"text": "ButtonType"
|
1666
1728
|
},
|
1667
1729
|
"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.",
|
1668
1730
|
"default": "button",
|
1669
|
-
"
|
1670
|
-
"reflects": true,
|
1731
|
+
"fieldName": "type",
|
1671
1732
|
"inheritedFrom": {
|
1672
1733
|
"name": "Buttonsimple",
|
1673
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1734
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1674
1735
|
}
|
1736
|
+
}
|
1737
|
+
],
|
1738
|
+
"mixins": [
|
1739
|
+
{
|
1740
|
+
"name": "AvatarComponentMixin",
|
1741
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1675
1742
|
},
|
1676
1743
|
{
|
1677
|
-
"
|
1678
|
-
"
|
1679
|
-
|
1680
|
-
|
1681
|
-
|
1682
|
-
|
1683
|
-
|
1744
|
+
"name": "IconNameMixin",
|
1745
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1746
|
+
}
|
1747
|
+
],
|
1748
|
+
"superclass": {
|
1749
|
+
"name": "Buttonsimple",
|
1750
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1751
|
+
},
|
1752
|
+
"tagName": "mdc-avatarbutton",
|
1753
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * To override styles of the avatar inside, use the specified css parts.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
|
1754
|
+
"customElement": true
|
1755
|
+
}
|
1756
|
+
],
|
1757
|
+
"exports": [
|
1758
|
+
{
|
1759
|
+
"kind": "js",
|
1760
|
+
"name": "default",
|
1761
|
+
"declaration": {
|
1762
|
+
"name": "AvatarButton",
|
1763
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1764
|
+
}
|
1765
|
+
}
|
1766
|
+
]
|
1767
|
+
},
|
1768
|
+
{
|
1769
|
+
"kind": "javascript-module",
|
1770
|
+
"path": "components/badge/badge.component.js",
|
1771
|
+
"declarations": [
|
1772
|
+
{
|
1773
|
+
"kind": "class",
|
1774
|
+
"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.",
|
1775
|
+
"name": "Badge",
|
1776
|
+
"cssProperties": [
|
1777
|
+
{
|
1778
|
+
"description": "The foreground color of the primary badge.",
|
1779
|
+
"name": "--mdc-badge-primary-foreground-color"
|
1684
1780
|
},
|
1685
1781
|
{
|
1686
|
-
"
|
1687
|
-
"name": "
|
1688
|
-
"privacy": "protected",
|
1689
|
-
"parameters": [
|
1690
|
-
{
|
1691
|
-
"name": "element",
|
1692
|
-
"type": {
|
1693
|
-
"text": "HTMLElement"
|
1694
|
-
},
|
1695
|
-
"description": "The button element"
|
1696
|
-
},
|
1697
|
-
{
|
1698
|
-
"name": "active",
|
1699
|
-
"optional": true,
|
1700
|
-
"type": {
|
1701
|
-
"text": "boolean"
|
1702
|
-
},
|
1703
|
-
"description": "The active state of the element"
|
1704
|
-
}
|
1705
|
-
],
|
1706
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
1707
|
-
"inheritedFrom": {
|
1708
|
-
"name": "Buttonsimple",
|
1709
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1710
|
-
}
|
1782
|
+
"description": "The background color of the primary badge.",
|
1783
|
+
"name": "--mdc-badge-primary-background-color"
|
1711
1784
|
},
|
1712
1785
|
{
|
1713
|
-
"
|
1714
|
-
"name": "
|
1715
|
-
"privacy": "private",
|
1716
|
-
"parameters": [
|
1717
|
-
{
|
1718
|
-
"name": "element",
|
1719
|
-
"type": {
|
1720
|
-
"text": "HTMLElement"
|
1721
|
-
},
|
1722
|
-
"description": "The button element."
|
1723
|
-
},
|
1724
|
-
{
|
1725
|
-
"name": "softDisabled",
|
1726
|
-
"optional": true,
|
1727
|
-
"type": {
|
1728
|
-
"text": "boolean"
|
1729
|
-
},
|
1730
|
-
"description": "The soft-disabled state."
|
1731
|
-
}
|
1732
|
-
],
|
1733
|
-
"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.",
|
1734
|
-
"inheritedFrom": {
|
1735
|
-
"name": "Buttonsimple",
|
1736
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1737
|
-
}
|
1786
|
+
"description": "The foreground color of the secondary badge.",
|
1787
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
1738
1788
|
},
|
1739
1789
|
{
|
1740
|
-
"
|
1741
|
-
"name": "
|
1742
|
-
"privacy": "private",
|
1743
|
-
"parameters": [
|
1744
|
-
{
|
1745
|
-
"name": "element",
|
1746
|
-
"type": {
|
1747
|
-
"text": "HTMLElement"
|
1748
|
-
},
|
1749
|
-
"description": "The button element."
|
1750
|
-
},
|
1751
|
-
{
|
1752
|
-
"name": "disabled",
|
1753
|
-
"type": {
|
1754
|
-
"text": "boolean"
|
1755
|
-
},
|
1756
|
-
"description": "The disabled state."
|
1757
|
-
}
|
1758
|
-
],
|
1759
|
-
"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.",
|
1760
|
-
"inheritedFrom": {
|
1761
|
-
"name": "Buttonsimple",
|
1762
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1763
|
-
}
|
1790
|
+
"description": "The background color of the secondary badge.",
|
1791
|
+
"name": "--mdc-badge-secondary-background-color"
|
1764
1792
|
},
|
1765
1793
|
{
|
1766
|
-
"
|
1767
|
-
"name": "
|
1768
|
-
"privacy": "private",
|
1769
|
-
"inheritedFrom": {
|
1770
|
-
"name": "Buttonsimple",
|
1771
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1772
|
-
}
|
1794
|
+
"description": "The foreground color of the success badge.",
|
1795
|
+
"name": "--mdc-badge-success-foreground-color"
|
1773
1796
|
},
|
1774
1797
|
{
|
1775
|
-
"
|
1776
|
-
"name": "
|
1777
|
-
|
1778
|
-
|
1779
|
-
"
|
1780
|
-
|
1781
|
-
|
1782
|
-
|
1798
|
+
"description": "The background color of the success badge.",
|
1799
|
+
"name": "--mdc-badge-success-background-color"
|
1800
|
+
},
|
1801
|
+
{
|
1802
|
+
"description": "The foreground color of the warning badge.",
|
1803
|
+
"name": "--mdc-badge-warning-foreground-color"
|
1804
|
+
},
|
1805
|
+
{
|
1806
|
+
"description": "The background color of the warning badge.",
|
1807
|
+
"name": "--mdc-badge-warning-background-color"
|
1808
|
+
},
|
1809
|
+
{
|
1810
|
+
"description": "The foreground color of the error badge.",
|
1811
|
+
"name": "--mdc-badge-error-foreground-color"
|
1812
|
+
},
|
1813
|
+
{
|
1814
|
+
"description": "The background color of the error badge.",
|
1815
|
+
"name": "--mdc-badge-error-background-color"
|
1816
|
+
},
|
1817
|
+
{
|
1818
|
+
"description": "The background color of the badge overlay.",
|
1819
|
+
"name": "--mdc-badge-overlay-background-color"
|
1820
|
+
}
|
1821
|
+
],
|
1822
|
+
"members": [
|
1823
|
+
{
|
1824
|
+
"kind": "field",
|
1825
|
+
"name": "type",
|
1826
|
+
"type": {
|
1827
|
+
"text": "BadgeType | undefined"
|
1828
|
+
},
|
1829
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1830
|
+
"attribute": "type",
|
1831
|
+
"reflects": true
|
1832
|
+
},
|
1833
|
+
{
|
1834
|
+
"kind": "field",
|
1835
|
+
"name": "variant",
|
1836
|
+
"type": {
|
1837
|
+
"text": "IconVariant"
|
1838
|
+
},
|
1839
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1840
|
+
"default": "primary",
|
1841
|
+
"attribute": "variant",
|
1842
|
+
"reflects": true
|
1843
|
+
},
|
1844
|
+
{
|
1845
|
+
"kind": "field",
|
1846
|
+
"name": "counter",
|
1847
|
+
"type": {
|
1848
|
+
"text": "number | undefined"
|
1849
|
+
},
|
1850
|
+
"description": "Counter is the number which can be provided in the badge.",
|
1851
|
+
"attribute": "counter"
|
1852
|
+
},
|
1853
|
+
{
|
1854
|
+
"kind": "field",
|
1855
|
+
"name": "maxCounter",
|
1856
|
+
"type": {
|
1857
|
+
"text": "number"
|
1858
|
+
},
|
1859
|
+
"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`.",
|
1860
|
+
"default": "99",
|
1861
|
+
"attribute": "max-counter",
|
1862
|
+
"reflects": true
|
1863
|
+
},
|
1864
|
+
{
|
1865
|
+
"kind": "field",
|
1866
|
+
"name": "overlay",
|
1867
|
+
"type": {
|
1868
|
+
"text": "boolean"
|
1869
|
+
},
|
1870
|
+
"default": "false",
|
1871
|
+
"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.",
|
1872
|
+
"attribute": "overlay"
|
1873
|
+
},
|
1874
|
+
{
|
1875
|
+
"kind": "field",
|
1876
|
+
"name": "ariaLabel",
|
1877
|
+
"type": {
|
1878
|
+
"text": "string | null"
|
1879
|
+
},
|
1880
|
+
"default": "null",
|
1881
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1882
|
+
"attribute": "aria-label"
|
1783
1883
|
},
|
1784
1884
|
{
|
1785
1885
|
"kind": "method",
|
1786
|
-
"name": "
|
1886
|
+
"name": "getCounterText",
|
1787
1887
|
"privacy": "private",
|
1888
|
+
"return": {
|
1889
|
+
"type": {
|
1890
|
+
"text": ""
|
1891
|
+
}
|
1892
|
+
},
|
1788
1893
|
"parameters": [
|
1789
1894
|
{
|
1790
|
-
"name": "
|
1895
|
+
"name": "maxCounter",
|
1791
1896
|
"type": {
|
1792
|
-
"text": "
|
1897
|
+
"text": "number"
|
1793
1898
|
},
|
1794
|
-
"description": "
|
1899
|
+
"description": "the maximum limit which can be displayed on the badge"
|
1900
|
+
},
|
1901
|
+
{
|
1902
|
+
"name": "counter",
|
1903
|
+
"optional": true,
|
1904
|
+
"type": {
|
1905
|
+
"text": "number"
|
1906
|
+
},
|
1907
|
+
"description": "the number to be displayed on the badge"
|
1795
1908
|
}
|
1796
1909
|
],
|
1797
|
-
"description": "
|
1798
|
-
"inheritedFrom": {
|
1799
|
-
"name": "Buttonsimple",
|
1800
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1801
|
-
}
|
1910
|
+
"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."
|
1802
1911
|
},
|
1803
1912
|
{
|
1804
1913
|
"kind": "method",
|
1805
|
-
"name": "
|
1914
|
+
"name": "getBadgeIcon",
|
1806
1915
|
"privacy": "private",
|
1916
|
+
"return": {
|
1917
|
+
"type": {
|
1918
|
+
"text": ""
|
1919
|
+
}
|
1920
|
+
},
|
1807
1921
|
"parameters": [
|
1808
1922
|
{
|
1809
|
-
"name": "
|
1923
|
+
"name": "iconName",
|
1810
1924
|
"type": {
|
1811
|
-
"text": "
|
1925
|
+
"text": "string"
|
1812
1926
|
},
|
1813
|
-
"description": "
|
1927
|
+
"description": "the name of the icon from the icon set"
|
1928
|
+
},
|
1929
|
+
{
|
1930
|
+
"name": "backgroundClassPostfix",
|
1931
|
+
"type": {
|
1932
|
+
"text": "string"
|
1933
|
+
},
|
1934
|
+
"description": "postfix for the class to style the badge icon."
|
1814
1935
|
}
|
1815
1936
|
],
|
1816
|
-
"description": "
|
1817
|
-
"inheritedFrom": {
|
1818
|
-
"name": "Buttonsimple",
|
1819
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1820
|
-
}
|
1821
|
-
}
|
1822
|
-
],
|
1823
|
-
"events": [
|
1824
|
-
{
|
1825
|
-
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
1826
|
-
"name": "click",
|
1827
|
-
"reactName": "onClick",
|
1828
|
-
"inheritedFrom": {
|
1829
|
-
"name": "Buttonsimple",
|
1830
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1831
|
-
}
|
1832
|
-
},
|
1833
|
-
{
|
1834
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
1835
|
-
"name": "keydown",
|
1836
|
-
"reactName": "onKeyDown",
|
1837
|
-
"inheritedFrom": {
|
1838
|
-
"name": "Buttonsimple",
|
1839
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1840
|
-
}
|
1841
|
-
},
|
1842
|
-
{
|
1843
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
1844
|
-
"name": "keyup",
|
1845
|
-
"reactName": "onKeyUp",
|
1846
|
-
"inheritedFrom": {
|
1847
|
-
"name": "Buttonsimple",
|
1848
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1849
|
-
}
|
1850
|
-
},
|
1851
|
-
{
|
1852
|
-
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
1853
|
-
"name": "focus",
|
1854
|
-
"reactName": "onFocus",
|
1855
|
-
"inheritedFrom": {
|
1856
|
-
"name": "Buttonsimple",
|
1857
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1858
|
-
}
|
1859
|
-
}
|
1860
|
-
],
|
1861
|
-
"attributes": [
|
1862
|
-
{
|
1863
|
-
"name": "aria-label",
|
1864
|
-
"type": {
|
1865
|
-
"text": "string | null"
|
1866
|
-
},
|
1867
|
-
"default": "null",
|
1868
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1869
|
-
"fieldName": "ariaLabel"
|
1870
|
-
},
|
1871
|
-
{
|
1872
|
-
"name": "src",
|
1873
|
-
"type": {
|
1874
|
-
"text": "string | undefined"
|
1875
|
-
},
|
1876
|
-
"description": "The src is the url which will be used to display the avatar.\nWhen the src is loading, we will display the initials as a placeholder.",
|
1877
|
-
"fieldName": "src",
|
1878
|
-
"inheritedFrom": {
|
1879
|
-
"name": "AvatarComponentMixin",
|
1880
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1881
|
-
}
|
1882
|
-
},
|
1883
|
-
{
|
1884
|
-
"name": "initials",
|
1885
|
-
"type": {
|
1886
|
-
"text": "string | undefined"
|
1887
|
-
},
|
1888
|
-
"description": "The initials to be displayed for the avatar.",
|
1889
|
-
"fieldName": "initials",
|
1890
|
-
"inheritedFrom": {
|
1891
|
-
"name": "AvatarComponentMixin",
|
1892
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1893
|
-
}
|
1937
|
+
"description": "Method to generate the badge icon."
|
1894
1938
|
},
|
1895
1939
|
{
|
1896
|
-
"
|
1897
|
-
"
|
1898
|
-
|
1940
|
+
"kind": "method",
|
1941
|
+
"name": "getBadgeDot",
|
1942
|
+
"privacy": "private",
|
1943
|
+
"return": {
|
1944
|
+
"type": {
|
1945
|
+
"text": ""
|
1946
|
+
}
|
1899
1947
|
},
|
1900
|
-
"description": "
|
1901
|
-
"fieldName": "presence",
|
1902
|
-
"inheritedFrom": {
|
1903
|
-
"name": "AvatarComponentMixin",
|
1904
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1905
|
-
}
|
1948
|
+
"description": "Method to generate the badge dot template."
|
1906
1949
|
},
|
1907
1950
|
{
|
1908
|
-
"
|
1909
|
-
"
|
1910
|
-
|
1951
|
+
"kind": "method",
|
1952
|
+
"name": "getBadgeCounterText",
|
1953
|
+
"privacy": "private",
|
1954
|
+
"return": {
|
1955
|
+
"type": {
|
1956
|
+
"text": ""
|
1957
|
+
}
|
1911
1958
|
},
|
1912
|
-
"description": "
|
1913
|
-
"default": "32",
|
1914
|
-
"fieldName": "size",
|
1915
|
-
"inheritedFrom": {
|
1916
|
-
"name": "Buttonsimple",
|
1917
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1918
|
-
}
|
1959
|
+
"description": "Method to generate the badge text and counter template."
|
1919
1960
|
},
|
1920
1961
|
{
|
1921
|
-
"
|
1922
|
-
"
|
1923
|
-
|
1962
|
+
"kind": "method",
|
1963
|
+
"name": "setRoleByAriaLabel",
|
1964
|
+
"privacy": "private",
|
1965
|
+
"return": {
|
1966
|
+
"type": {
|
1967
|
+
"text": "void"
|
1968
|
+
}
|
1924
1969
|
},
|
1925
|
-
"description": "
|
1926
|
-
"fieldName": "counter",
|
1927
|
-
"inheritedFrom": {
|
1928
|
-
"name": "AvatarComponentMixin",
|
1929
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1930
|
-
}
|
1970
|
+
"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."
|
1931
1971
|
},
|
1932
1972
|
{
|
1933
|
-
"
|
1934
|
-
"
|
1935
|
-
|
1973
|
+
"kind": "method",
|
1974
|
+
"name": "getBadgeContentBasedOnType",
|
1975
|
+
"privacy": "private",
|
1976
|
+
"return": {
|
1977
|
+
"type": {
|
1978
|
+
"text": ""
|
1979
|
+
}
|
1936
1980
|
},
|
1937
|
-
"
|
1938
|
-
"description": "Represents the typing indicator when the user is typing.",
|
1939
|
-
"fieldName": "isTyping",
|
1940
|
-
"inheritedFrom": {
|
1941
|
-
"name": "AvatarComponentMixin",
|
1942
|
-
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1943
|
-
}
|
1981
|
+
"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."
|
1944
1982
|
},
|
1945
1983
|
{
|
1946
|
-
"
|
1984
|
+
"kind": "field",
|
1985
|
+
"name": "iconName",
|
1947
1986
|
"type": {
|
1948
1987
|
"text": "IconNames | undefined"
|
1949
1988
|
},
|
1950
1989
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1951
|
-
"
|
1990
|
+
"attribute": "icon-name",
|
1952
1991
|
"inheritedFrom": {
|
1953
1992
|
"name": "IconNameMixin",
|
1954
|
-
"module": "
|
1955
|
-
}
|
1956
|
-
},
|
1957
|
-
{
|
1958
|
-
"name": "autofocus",
|
1959
|
-
"type": {
|
1960
|
-
"text": "boolean"
|
1961
|
-
},
|
1962
|
-
"default": "false",
|
1963
|
-
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
1964
|
-
"fieldName": "autofocus",
|
1965
|
-
"inheritedFrom": {
|
1966
|
-
"name": "AutoFocusMixin",
|
1967
|
-
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
1993
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1968
1994
|
}
|
1969
|
-
}
|
1995
|
+
}
|
1996
|
+
],
|
1997
|
+
"attributes": [
|
1970
1998
|
{
|
1971
|
-
"name": "
|
1999
|
+
"name": "type",
|
1972
2000
|
"type": {
|
1973
|
-
"text": "
|
2001
|
+
"text": "BadgeType | undefined"
|
1974
2002
|
},
|
1975
|
-
"
|
1976
|
-
"
|
1977
|
-
"fieldName": "tabIndex",
|
1978
|
-
"inheritedFrom": {
|
1979
|
-
"name": "TabIndexMixin",
|
1980
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1981
|
-
}
|
2003
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
2004
|
+
"fieldName": "type"
|
1982
2005
|
},
|
1983
2006
|
{
|
1984
|
-
"name": "
|
2007
|
+
"name": "variant",
|
1985
2008
|
"type": {
|
1986
|
-
"text": "
|
2009
|
+
"text": "IconVariant"
|
1987
2010
|
},
|
1988
|
-
"description": "
|
1989
|
-
"default": "
|
1990
|
-
"fieldName": "
|
1991
|
-
"inheritedFrom": {
|
1992
|
-
"name": "DisabledMixin",
|
1993
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
1994
|
-
}
|
2011
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
2012
|
+
"default": "primary",
|
2013
|
+
"fieldName": "variant"
|
1995
2014
|
},
|
1996
2015
|
{
|
1997
|
-
"name": "
|
2016
|
+
"name": "counter",
|
1998
2017
|
"type": {
|
1999
|
-
"text": "
|
2018
|
+
"text": "number | undefined"
|
2000
2019
|
},
|
2001
|
-
"description": "
|
2002
|
-
"
|
2003
|
-
"fieldName": "active",
|
2004
|
-
"inheritedFrom": {
|
2005
|
-
"name": "Buttonsimple",
|
2006
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2007
|
-
}
|
2020
|
+
"description": "Counter is the number which can be provided in the badge.",
|
2021
|
+
"fieldName": "counter"
|
2008
2022
|
},
|
2009
2023
|
{
|
2010
|
-
"name": "
|
2024
|
+
"name": "max-counter",
|
2011
2025
|
"type": {
|
2012
|
-
"text": "
|
2026
|
+
"text": "number"
|
2013
2027
|
},
|
2014
|
-
"description": "
|
2015
|
-
"default": "
|
2016
|
-
"fieldName": "
|
2017
|
-
"inheritedFrom": {
|
2018
|
-
"name": "Buttonsimple",
|
2019
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2020
|
-
}
|
2028
|
+
"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`.",
|
2029
|
+
"default": "99",
|
2030
|
+
"fieldName": "maxCounter"
|
2021
2031
|
},
|
2022
2032
|
{
|
2023
|
-
"name": "
|
2024
|
-
"
|
2025
|
-
|
2026
|
-
|
2027
|
-
"
|
2028
|
-
|
2029
|
-
|
2030
|
-
}
|
2033
|
+
"name": "overlay",
|
2034
|
+
"type": {
|
2035
|
+
"text": "boolean"
|
2036
|
+
},
|
2037
|
+
"default": "false",
|
2038
|
+
"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.",
|
2039
|
+
"fieldName": "overlay"
|
2031
2040
|
},
|
2032
2041
|
{
|
2033
|
-
"name": "
|
2042
|
+
"name": "aria-label",
|
2034
2043
|
"type": {
|
2035
|
-
"text": "string |
|
2044
|
+
"text": "string | null"
|
2036
2045
|
},
|
2037
|
-
"
|
2038
|
-
"
|
2039
|
-
"fieldName": "
|
2040
|
-
"inheritedFrom": {
|
2041
|
-
"name": "Buttonsimple",
|
2042
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2043
|
-
}
|
2046
|
+
"default": "null",
|
2047
|
+
"description": "Aria-label attribute to be set for accessibility",
|
2048
|
+
"fieldName": "ariaLabel"
|
2044
2049
|
},
|
2045
2050
|
{
|
2046
|
-
"name": "
|
2051
|
+
"name": "icon-name",
|
2047
2052
|
"type": {
|
2048
|
-
"text": "
|
2053
|
+
"text": "IconNames | undefined"
|
2049
2054
|
},
|
2050
|
-
"description": "
|
2051
|
-
"
|
2052
|
-
"fieldName": "type",
|
2055
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2056
|
+
"fieldName": "iconName",
|
2053
2057
|
"inheritedFrom": {
|
2054
|
-
"name": "
|
2055
|
-
"module": "src/
|
2058
|
+
"name": "IconNameMixin",
|
2059
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
2056
2060
|
}
|
2057
2061
|
}
|
2058
2062
|
],
|
2059
2063
|
"mixins": [
|
2060
|
-
{
|
2061
|
-
"name": "AvatarComponentMixin",
|
2062
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
2063
|
-
},
|
2064
2064
|
{
|
2065
2065
|
"name": "IconNameMixin",
|
2066
2066
|
"module": "/src/utils/mixins/IconNameMixin"
|
2067
2067
|
}
|
2068
2068
|
],
|
2069
2069
|
"superclass": {
|
2070
|
-
"name": "
|
2071
|
-
"module": "/src/
|
2070
|
+
"name": "Component",
|
2071
|
+
"module": "/src/models"
|
2072
2072
|
},
|
2073
|
-
"tagName": "mdc-
|
2074
|
-
"jsDoc": "/**\n * The `mdc-
|
2073
|
+
"tagName": "mdc-badge",
|
2074
|
+
"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 */",
|
2075
2075
|
"customElement": true
|
2076
2076
|
}
|
2077
2077
|
],
|
@@ -2080,8 +2080,8 @@
|
|
2080
2080
|
"kind": "js",
|
2081
2081
|
"name": "default",
|
2082
2082
|
"declaration": {
|
2083
|
-
"name": "
|
2084
|
-
"module": "components/
|
2083
|
+
"name": "Badge",
|
2084
|
+
"module": "components/badge/badge.component.js"
|
2085
2085
|
}
|
2086
2086
|
}
|
2087
2087
|
]
|
@@ -2190,6 +2190,77 @@
|
|
2190
2190
|
}
|
2191
2191
|
]
|
2192
2192
|
},
|
2193
|
+
{
|
2194
|
+
"kind": "javascript-module",
|
2195
|
+
"path": "components/bullet/bullet.component.js",
|
2196
|
+
"declarations": [
|
2197
|
+
{
|
2198
|
+
"kind": "class",
|
2199
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2200
|
+
"name": "Bullet",
|
2201
|
+
"cssProperties": [
|
2202
|
+
{
|
2203
|
+
"description": "background color of the bullet",
|
2204
|
+
"name": "--mdc-bullet-background-color"
|
2205
|
+
},
|
2206
|
+
{
|
2207
|
+
"description": "small size value of the bullet",
|
2208
|
+
"name": "--mdc-bullet-size-small"
|
2209
|
+
},
|
2210
|
+
{
|
2211
|
+
"description": "medium size value of the bullet",
|
2212
|
+
"name": "--mdc-bullet-size-medium"
|
2213
|
+
},
|
2214
|
+
{
|
2215
|
+
"description": "large size value of the bullet",
|
2216
|
+
"name": "--mdc-bullet-size-large"
|
2217
|
+
}
|
2218
|
+
],
|
2219
|
+
"members": [
|
2220
|
+
{
|
2221
|
+
"kind": "field",
|
2222
|
+
"name": "size",
|
2223
|
+
"type": {
|
2224
|
+
"text": "Size"
|
2225
|
+
},
|
2226
|
+
"privacy": "public",
|
2227
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2228
|
+
"default": "small",
|
2229
|
+
"attribute": "size",
|
2230
|
+
"reflects": true
|
2231
|
+
}
|
2232
|
+
],
|
2233
|
+
"attributes": [
|
2234
|
+
{
|
2235
|
+
"name": "size",
|
2236
|
+
"type": {
|
2237
|
+
"text": "Size"
|
2238
|
+
},
|
2239
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2240
|
+
"default": "small",
|
2241
|
+
"fieldName": "size"
|
2242
|
+
}
|
2243
|
+
],
|
2244
|
+
"superclass": {
|
2245
|
+
"name": "Component",
|
2246
|
+
"module": "/src/models"
|
2247
|
+
},
|
2248
|
+
"tagName": "mdc-bullet",
|
2249
|
+
"jsDoc": "/**\n * Bullet component, which is a visual marker\n * and be used to organize and present items in a list format.\n *\n * @tagname mdc-bullet\n *\n * @cssproperty --mdc-bullet-background-color - background color of the bullet\n * @cssproperty --mdc-bullet-size-small - small size value of the bullet\n * @cssproperty --mdc-bullet-size-medium - medium size value of the bullet\n * @cssproperty --mdc-bullet-size-large - large size value of the bullet\n */",
|
2250
|
+
"customElement": true
|
2251
|
+
}
|
2252
|
+
],
|
2253
|
+
"exports": [
|
2254
|
+
{
|
2255
|
+
"kind": "js",
|
2256
|
+
"name": "default",
|
2257
|
+
"declaration": {
|
2258
|
+
"name": "Bullet",
|
2259
|
+
"module": "components/bullet/bullet.component.js"
|
2260
|
+
}
|
2261
|
+
}
|
2262
|
+
]
|
2263
|
+
},
|
2193
2264
|
{
|
2194
2265
|
"kind": "javascript-module",
|
2195
2266
|
"path": "components/button/button.component.js",
|
@@ -2887,61 +2958,122 @@
|
|
2887
2958
|
},
|
2888
2959
|
{
|
2889
2960
|
"kind": "javascript-module",
|
2890
|
-
"path": "components/
|
2961
|
+
"path": "components/buttongroup/buttongroup.component.js",
|
2891
2962
|
"declarations": [
|
2892
2963
|
{
|
2893
2964
|
"kind": "class",
|
2894
|
-
"description": "
|
2895
|
-
"name": "
|
2965
|
+
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
2966
|
+
"name": "ButtonGroup",
|
2896
2967
|
"cssProperties": [
|
2897
2968
|
{
|
2898
|
-
"description": "
|
2899
|
-
"name": "--mdc-
|
2969
|
+
"description": "The border radius of the buttongroup",
|
2970
|
+
"name": "--mdc-buttongroup-border-radius"
|
2900
2971
|
},
|
2901
2972
|
{
|
2902
|
-
"description": "
|
2903
|
-
"name": "--mdc-
|
2973
|
+
"description": "The border color of the buttongroup",
|
2974
|
+
"name": "--mdc-buttongroup-border-color"
|
2904
2975
|
},
|
2905
2976
|
{
|
2906
|
-
"description": "
|
2907
|
-
"name": "--mdc-
|
2908
|
-
}
|
2977
|
+
"description": "The color of the divider between buttons within the buttongroup",
|
2978
|
+
"name": "--mdc-buttongroup-divider-color"
|
2979
|
+
}
|
2980
|
+
],
|
2981
|
+
"slots": [
|
2909
2982
|
{
|
2910
|
-
"description": "
|
2911
|
-
"name": "
|
2983
|
+
"description": "This is a default/unnamed slot, which contains the buttons",
|
2984
|
+
"name": "default"
|
2912
2985
|
}
|
2913
2986
|
],
|
2914
2987
|
"members": [
|
2988
|
+
{
|
2989
|
+
"kind": "field",
|
2990
|
+
"name": "orientation",
|
2991
|
+
"type": {
|
2992
|
+
"text": "ButtonGroupOrientation"
|
2993
|
+
},
|
2994
|
+
"description": "Orientation of the buttongroup.",
|
2995
|
+
"default": "'horizontal'",
|
2996
|
+
"attribute": "orientation",
|
2997
|
+
"reflects": true
|
2998
|
+
},
|
2999
|
+
{
|
3000
|
+
"kind": "field",
|
3001
|
+
"name": "variant",
|
3002
|
+
"type": {
|
3003
|
+
"text": "ButtonGroupVariant"
|
3004
|
+
},
|
3005
|
+
"description": "Variant of the buttons within the buttongroup.",
|
3006
|
+
"default": "'primary'",
|
3007
|
+
"attribute": "variant",
|
3008
|
+
"reflects": true
|
3009
|
+
},
|
2915
3010
|
{
|
2916
3011
|
"kind": "field",
|
2917
3012
|
"name": "size",
|
2918
3013
|
"type": {
|
2919
|
-
"text": "
|
3014
|
+
"text": "ButtonGroupSize"
|
2920
3015
|
},
|
2921
|
-
"
|
2922
|
-
"
|
2923
|
-
"default": "small",
|
3016
|
+
"description": "Size of the buttons within the buttongroup.",
|
3017
|
+
"default": "'28'",
|
2924
3018
|
"attribute": "size",
|
2925
3019
|
"reflects": true
|
3020
|
+
},
|
3021
|
+
{
|
3022
|
+
"kind": "field",
|
3023
|
+
"name": "compact",
|
3024
|
+
"type": {
|
3025
|
+
"text": "boolean"
|
3026
|
+
},
|
3027
|
+
"default": "false",
|
3028
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3029
|
+
"attribute": "compact",
|
3030
|
+
"reflects": true
|
2926
3031
|
}
|
2927
3032
|
],
|
2928
3033
|
"attributes": [
|
3034
|
+
{
|
3035
|
+
"name": "orientation",
|
3036
|
+
"type": {
|
3037
|
+
"text": "ButtonGroupOrientation"
|
3038
|
+
},
|
3039
|
+
"description": "Orientation of the buttongroup.",
|
3040
|
+
"default": "'horizontal'",
|
3041
|
+
"fieldName": "orientation"
|
3042
|
+
},
|
3043
|
+
{
|
3044
|
+
"name": "variant",
|
3045
|
+
"type": {
|
3046
|
+
"text": "ButtonGroupVariant"
|
3047
|
+
},
|
3048
|
+
"description": "Variant of the buttons within the buttongroup.",
|
3049
|
+
"default": "'primary'",
|
3050
|
+
"fieldName": "variant"
|
3051
|
+
},
|
2929
3052
|
{
|
2930
3053
|
"name": "size",
|
2931
3054
|
"type": {
|
2932
|
-
"text": "
|
3055
|
+
"text": "ButtonGroupSize"
|
2933
3056
|
},
|
2934
|
-
"description": "Size of the
|
2935
|
-
"default": "
|
3057
|
+
"description": "Size of the buttons within the buttongroup.",
|
3058
|
+
"default": "'28'",
|
2936
3059
|
"fieldName": "size"
|
3060
|
+
},
|
3061
|
+
{
|
3062
|
+
"name": "compact",
|
3063
|
+
"type": {
|
3064
|
+
"text": "boolean"
|
3065
|
+
},
|
3066
|
+
"default": "false",
|
3067
|
+
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3068
|
+
"fieldName": "compact"
|
2937
3069
|
}
|
2938
3070
|
],
|
2939
3071
|
"superclass": {
|
2940
3072
|
"name": "Component",
|
2941
3073
|
"module": "/src/models"
|
2942
3074
|
},
|
2943
|
-
"tagName": "mdc-
|
2944
|
-
"jsDoc": "/**\n *
|
3075
|
+
"tagName": "mdc-buttongroup",
|
3076
|
+
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
2945
3077
|
"customElement": true
|
2946
3078
|
}
|
2947
3079
|
],
|
@@ -2950,8 +3082,8 @@
|
|
2950
3082
|
"kind": "js",
|
2951
3083
|
"name": "default",
|
2952
3084
|
"declaration": {
|
2953
|
-
"name": "
|
2954
|
-
"module": "components/
|
3085
|
+
"name": "ButtonGroup",
|
3086
|
+
"module": "components/buttongroup/buttongroup.component.js"
|
2955
3087
|
}
|
2956
3088
|
}
|
2957
3089
|
]
|
@@ -3570,138 +3702,6 @@
|
|
3570
3702
|
}
|
3571
3703
|
]
|
3572
3704
|
},
|
3573
|
-
{
|
3574
|
-
"kind": "javascript-module",
|
3575
|
-
"path": "components/buttongroup/buttongroup.component.js",
|
3576
|
-
"declarations": [
|
3577
|
-
{
|
3578
|
-
"kind": "class",
|
3579
|
-
"description": "buttongroup component, is a styled wrapper for multiple buttons.\nIt can support icon buttons, combination of icon and pill buttons, and text buttons.\nThey are available in horizontal and vertical orientation.",
|
3580
|
-
"name": "ButtonGroup",
|
3581
|
-
"cssProperties": [
|
3582
|
-
{
|
3583
|
-
"description": "The border radius of the buttongroup",
|
3584
|
-
"name": "--mdc-buttongroup-border-radius"
|
3585
|
-
},
|
3586
|
-
{
|
3587
|
-
"description": "The border color of the buttongroup",
|
3588
|
-
"name": "--mdc-buttongroup-border-color"
|
3589
|
-
},
|
3590
|
-
{
|
3591
|
-
"description": "The color of the divider between buttons within the buttongroup",
|
3592
|
-
"name": "--mdc-buttongroup-divider-color"
|
3593
|
-
}
|
3594
|
-
],
|
3595
|
-
"slots": [
|
3596
|
-
{
|
3597
|
-
"description": "This is a default/unnamed slot, which contains the buttons",
|
3598
|
-
"name": "default"
|
3599
|
-
}
|
3600
|
-
],
|
3601
|
-
"members": [
|
3602
|
-
{
|
3603
|
-
"kind": "field",
|
3604
|
-
"name": "orientation",
|
3605
|
-
"type": {
|
3606
|
-
"text": "ButtonGroupOrientation"
|
3607
|
-
},
|
3608
|
-
"description": "Orientation of the buttongroup.",
|
3609
|
-
"default": "'horizontal'",
|
3610
|
-
"attribute": "orientation",
|
3611
|
-
"reflects": true
|
3612
|
-
},
|
3613
|
-
{
|
3614
|
-
"kind": "field",
|
3615
|
-
"name": "variant",
|
3616
|
-
"type": {
|
3617
|
-
"text": "ButtonGroupVariant"
|
3618
|
-
},
|
3619
|
-
"description": "Variant of the buttons within the buttongroup.",
|
3620
|
-
"default": "'primary'",
|
3621
|
-
"attribute": "variant",
|
3622
|
-
"reflects": true
|
3623
|
-
},
|
3624
|
-
{
|
3625
|
-
"kind": "field",
|
3626
|
-
"name": "size",
|
3627
|
-
"type": {
|
3628
|
-
"text": "ButtonGroupSize"
|
3629
|
-
},
|
3630
|
-
"description": "Size of the buttons within the buttongroup.",
|
3631
|
-
"default": "'28'",
|
3632
|
-
"attribute": "size",
|
3633
|
-
"reflects": true
|
3634
|
-
},
|
3635
|
-
{
|
3636
|
-
"kind": "field",
|
3637
|
-
"name": "compact",
|
3638
|
-
"type": {
|
3639
|
-
"text": "boolean"
|
3640
|
-
},
|
3641
|
-
"default": "false",
|
3642
|
-
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3643
|
-
"attribute": "compact",
|
3644
|
-
"reflects": true
|
3645
|
-
}
|
3646
|
-
],
|
3647
|
-
"attributes": [
|
3648
|
-
{
|
3649
|
-
"name": "orientation",
|
3650
|
-
"type": {
|
3651
|
-
"text": "ButtonGroupOrientation"
|
3652
|
-
},
|
3653
|
-
"description": "Orientation of the buttongroup.",
|
3654
|
-
"default": "'horizontal'",
|
3655
|
-
"fieldName": "orientation"
|
3656
|
-
},
|
3657
|
-
{
|
3658
|
-
"name": "variant",
|
3659
|
-
"type": {
|
3660
|
-
"text": "ButtonGroupVariant"
|
3661
|
-
},
|
3662
|
-
"description": "Variant of the buttons within the buttongroup.",
|
3663
|
-
"default": "'primary'",
|
3664
|
-
"fieldName": "variant"
|
3665
|
-
},
|
3666
|
-
{
|
3667
|
-
"name": "size",
|
3668
|
-
"type": {
|
3669
|
-
"text": "ButtonGroupSize"
|
3670
|
-
},
|
3671
|
-
"description": "Size of the buttons within the buttongroup.",
|
3672
|
-
"default": "'28'",
|
3673
|
-
"fieldName": "size"
|
3674
|
-
},
|
3675
|
-
{
|
3676
|
-
"name": "compact",
|
3677
|
-
"type": {
|
3678
|
-
"text": "boolean"
|
3679
|
-
},
|
3680
|
-
"default": "false",
|
3681
|
-
"description": "When this is true, the buttons within the buttongroup will be compact.\ni.e. Irrespective of the size of the buttons, they will have a height of 24px.",
|
3682
|
-
"fieldName": "compact"
|
3683
|
-
}
|
3684
|
-
],
|
3685
|
-
"superclass": {
|
3686
|
-
"name": "Component",
|
3687
|
-
"module": "/src/models"
|
3688
|
-
},
|
3689
|
-
"tagName": "mdc-buttongroup",
|
3690
|
-
"jsDoc": "/**\n * buttongroup component, is a styled wrapper for multiple buttons.\n * It can support icon buttons, combination of icon and pill buttons, and text buttons.\n * They are available in horizontal and vertical orientation.\n *\n * @tagname mdc-buttongroup\n *\n * @slot default - This is a default/unnamed slot, which contains the buttons\n *\n * @cssproperty --mdc-buttongroup-border-radius - The border radius of the buttongroup\n * @cssproperty --mdc-buttongroup-border-color - The border color of the buttongroup\n * @cssproperty --mdc-buttongroup-divider-color - The color of the divider between buttons within the buttongroup\n */",
|
3691
|
-
"customElement": true
|
3692
|
-
}
|
3693
|
-
],
|
3694
|
-
"exports": [
|
3695
|
-
{
|
3696
|
-
"kind": "js",
|
3697
|
-
"name": "default",
|
3698
|
-
"declaration": {
|
3699
|
-
"name": "ButtonGroup",
|
3700
|
-
"module": "components/buttongroup/buttongroup.component.js"
|
3701
|
-
}
|
3702
|
-
}
|
3703
|
-
]
|
3704
|
-
},
|
3705
3705
|
{
|
3706
3706
|
"kind": "javascript-module",
|
3707
3707
|
"path": "components/buttonsimple/buttonsimple.component.js",
|
@@ -14642,6 +14642,129 @@
|
|
14642
14642
|
}
|
14643
14643
|
]
|
14644
14644
|
},
|
14645
|
+
{
|
14646
|
+
"kind": "javascript-module",
|
14647
|
+
"path": "components/listheader/listheader.component.js",
|
14648
|
+
"declarations": [
|
14649
|
+
{
|
14650
|
+
"kind": "class",
|
14651
|
+
"description": "Listheader component is used to display a header in a list.\nIt can include icons before and after the header text, and allows for additional content via slots.",
|
14652
|
+
"name": "Listheader",
|
14653
|
+
"cssProperties": [
|
14654
|
+
{
|
14655
|
+
"description": "height of the header",
|
14656
|
+
"name": "--mdc-listheader-height"
|
14657
|
+
},
|
14658
|
+
{
|
14659
|
+
"description": "padding around the header content",
|
14660
|
+
"name": "--mdc-listheader-padding"
|
14661
|
+
},
|
14662
|
+
{
|
14663
|
+
"description": "gap between content",
|
14664
|
+
"name": "--mdc-listheader-gap"
|
14665
|
+
}
|
14666
|
+
],
|
14667
|
+
"slots": [
|
14668
|
+
{
|
14669
|
+
"description": "to pass in actionable content like buttons or links",
|
14670
|
+
"name": "default"
|
14671
|
+
}
|
14672
|
+
],
|
14673
|
+
"members": [
|
14674
|
+
{
|
14675
|
+
"kind": "field",
|
14676
|
+
"name": "prefixIcon",
|
14677
|
+
"type": {
|
14678
|
+
"text": "IconNames | undefined"
|
14679
|
+
},
|
14680
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
14681
|
+
"attribute": "prefix-icon"
|
14682
|
+
},
|
14683
|
+
{
|
14684
|
+
"kind": "field",
|
14685
|
+
"name": "postfixIcon",
|
14686
|
+
"type": {
|
14687
|
+
"text": "IconNames | undefined"
|
14688
|
+
},
|
14689
|
+
"description": "Name of the icon rendered after the slot & text\n\nIf not provided, no icon will be rendered and content will be aligned to the end.",
|
14690
|
+
"attribute": "postfix-icon"
|
14691
|
+
},
|
14692
|
+
{
|
14693
|
+
"kind": "field",
|
14694
|
+
"name": "headerText",
|
14695
|
+
"type": {
|
14696
|
+
"text": "string | undefined"
|
14697
|
+
},
|
14698
|
+
"description": "Text to be rendered in the header",
|
14699
|
+
"attribute": "header-text"
|
14700
|
+
},
|
14701
|
+
{
|
14702
|
+
"kind": "field",
|
14703
|
+
"name": "disabled",
|
14704
|
+
"type": {
|
14705
|
+
"text": "boolean"
|
14706
|
+
},
|
14707
|
+
"default": "false",
|
14708
|
+
"description": "Disables the header, making it visually styled as disabled.\n\nNOTE: slot content will still be interactive unless individually disabled.\nMake sure to handle the disabled state of any actionable elements inside the slot.",
|
14709
|
+
"attribute": "disabled",
|
14710
|
+
"reflects": true
|
14711
|
+
}
|
14712
|
+
],
|
14713
|
+
"attributes": [
|
14714
|
+
{
|
14715
|
+
"name": "prefix-icon",
|
14716
|
+
"type": {
|
14717
|
+
"text": "IconNames | undefined"
|
14718
|
+
},
|
14719
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
14720
|
+
"fieldName": "prefixIcon"
|
14721
|
+
},
|
14722
|
+
{
|
14723
|
+
"name": "postfix-icon",
|
14724
|
+
"type": {
|
14725
|
+
"text": "IconNames | undefined"
|
14726
|
+
},
|
14727
|
+
"description": "Name of the icon rendered after the slot & text\n\nIf not provided, no icon will be rendered and content will be aligned to the end.",
|
14728
|
+
"fieldName": "postfixIcon"
|
14729
|
+
},
|
14730
|
+
{
|
14731
|
+
"name": "header-text",
|
14732
|
+
"type": {
|
14733
|
+
"text": "string | undefined"
|
14734
|
+
},
|
14735
|
+
"description": "Text to be rendered in the header",
|
14736
|
+
"fieldName": "headerText"
|
14737
|
+
},
|
14738
|
+
{
|
14739
|
+
"name": "disabled",
|
14740
|
+
"type": {
|
14741
|
+
"text": "boolean"
|
14742
|
+
},
|
14743
|
+
"default": "false",
|
14744
|
+
"description": "Disables the header, making it visually styled as disabled.\n\nNOTE: slot content will still be interactive unless individually disabled.\nMake sure to handle the disabled state of any actionable elements inside the slot.",
|
14745
|
+
"fieldName": "disabled"
|
14746
|
+
}
|
14747
|
+
],
|
14748
|
+
"superclass": {
|
14749
|
+
"name": "Component",
|
14750
|
+
"module": "/src/models"
|
14751
|
+
},
|
14752
|
+
"tagName": "mdc-listheader",
|
14753
|
+
"jsDoc": "/**\n * Listheader component is used to display a header in a list.\n * It can include icons before and after the header text, and allows for additional content via slots.\n *\n * @tagname mdc-listheader\n *\n * @slot default - to pass in actionable content like buttons or links\n *\n * @cssproperty --mdc-listheader-height - height of the header\n * @cssproperty --mdc-listheader-padding - padding around the header content\n * @cssproperty --mdc-listheader-gap - gap between content\n */",
|
14754
|
+
"customElement": true
|
14755
|
+
}
|
14756
|
+
],
|
14757
|
+
"exports": [
|
14758
|
+
{
|
14759
|
+
"kind": "js",
|
14760
|
+
"name": "default",
|
14761
|
+
"declaration": {
|
14762
|
+
"name": "Listheader",
|
14763
|
+
"module": "components/listheader/listheader.component.js"
|
14764
|
+
}
|
14765
|
+
}
|
14766
|
+
]
|
14767
|
+
},
|
14645
14768
|
{
|
14646
14769
|
"kind": "javascript-module",
|
14647
14770
|
"path": "components/listitem/listitem.component.js",
|
@@ -20079,7 +20202,7 @@
|
|
20079
20202
|
"text": "string | null"
|
20080
20203
|
},
|
20081
20204
|
"default": "null",
|
20082
|
-
"description": "The
|
20205
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20083
20206
|
"attribute": "aria-label",
|
20084
20207
|
"reflects": true
|
20085
20208
|
},
|
@@ -20094,9 +20217,18 @@
|
|
20094
20217
|
"attribute": "header-text",
|
20095
20218
|
"reflects": true
|
20096
20219
|
},
|
20220
|
+
{
|
20221
|
+
"kind": "field",
|
20222
|
+
"name": "prefixIcon",
|
20223
|
+
"type": {
|
20224
|
+
"text": "IconNames | undefined"
|
20225
|
+
},
|
20226
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20227
|
+
"attribute": "prefix-icon"
|
20228
|
+
},
|
20097
20229
|
{
|
20098
20230
|
"kind": "method",
|
20099
|
-
"name": "
|
20231
|
+
"name": "renderHeader",
|
20100
20232
|
"privacy": "private"
|
20101
20233
|
}
|
20102
20234
|
],
|
@@ -20114,7 +20246,7 @@
|
|
20114
20246
|
"text": "string | null"
|
20115
20247
|
},
|
20116
20248
|
"default": "null",
|
20117
|
-
"description": "The
|
20249
|
+
"description": "The aria-label for the section.\nThis is used for accessibility purposes to describe the section.\nIf not provided, it defaults to the `headerText`.",
|
20118
20250
|
"fieldName": "ariaLabel"
|
20119
20251
|
},
|
20120
20252
|
{
|
@@ -20125,6 +20257,14 @@
|
|
20125
20257
|
"default": "null",
|
20126
20258
|
"description": "The primary headerText of the list item.\nThis appears on the leading side of the list item.",
|
20127
20259
|
"fieldName": "headerText"
|
20260
|
+
},
|
20261
|
+
{
|
20262
|
+
"name": "prefix-icon",
|
20263
|
+
"type": {
|
20264
|
+
"text": "IconNames | undefined"
|
20265
|
+
},
|
20266
|
+
"description": "Name of the icon rendered before the text\n\nIf not provided, no icon will be rendered and text will be aligned to the start.",
|
20267
|
+
"fieldName": "prefixIcon"
|
20128
20268
|
}
|
20129
20269
|
],
|
20130
20270
|
"superclass": {
|