@momentum-design/components 0.73.7 → 0.74.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/custom-elements.json +1488 -1488
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/package.json +1 -1
@@ -2,218 +2,6 @@
|
|
2
2
|
"schemaVersion": "1.0.0",
|
3
3
|
"readme": "",
|
4
4
|
"modules": [
|
5
|
-
{
|
6
|
-
"kind": "javascript-module",
|
7
|
-
"path": "components/animation/animation.component.js",
|
8
|
-
"declarations": [
|
9
|
-
{
|
10
|
-
"kind": "class",
|
11
|
-
"description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
|
12
|
-
"name": "Animation",
|
13
|
-
"members": [
|
14
|
-
{
|
15
|
-
"kind": "field",
|
16
|
-
"name": "name",
|
17
|
-
"type": {
|
18
|
-
"text": "AnimationNames | undefined"
|
19
|
-
},
|
20
|
-
"description": "Name of the animation (= filename)",
|
21
|
-
"attribute": "name",
|
22
|
-
"reflects": true
|
23
|
-
},
|
24
|
-
{
|
25
|
-
"kind": "field",
|
26
|
-
"name": "loop",
|
27
|
-
"type": {
|
28
|
-
"text": "LoopType | undefined"
|
29
|
-
},
|
30
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
31
|
-
"attribute": "loop",
|
32
|
-
"reflects": true
|
33
|
-
},
|
34
|
-
{
|
35
|
-
"kind": "field",
|
36
|
-
"name": "autoplay",
|
37
|
-
"type": {
|
38
|
-
"text": "boolean | undefined"
|
39
|
-
},
|
40
|
-
"description": "Weather start the animation automatically",
|
41
|
-
"attribute": "autoplay",
|
42
|
-
"reflects": true
|
43
|
-
},
|
44
|
-
{
|
45
|
-
"kind": "field",
|
46
|
-
"name": "ariaLabel",
|
47
|
-
"type": {
|
48
|
-
"text": "string | null"
|
49
|
-
},
|
50
|
-
"default": "null",
|
51
|
-
"description": "Aria-label attribute to be set for accessibility",
|
52
|
-
"attribute": "aria-label"
|
53
|
-
},
|
54
|
-
{
|
55
|
-
"kind": "field",
|
56
|
-
"name": "ariaLabelledBy",
|
57
|
-
"type": {
|
58
|
-
"text": "string | null"
|
59
|
-
},
|
60
|
-
"default": "null",
|
61
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
62
|
-
"attribute": "aria-labelledby"
|
63
|
-
},
|
64
|
-
{
|
65
|
-
"kind": "field",
|
66
|
-
"name": "lottieInstance",
|
67
|
-
"type": {
|
68
|
-
"text": "AnimationItem | undefined"
|
69
|
-
},
|
70
|
-
"privacy": "private",
|
71
|
-
"description": "Lottie animation instance"
|
72
|
-
},
|
73
|
-
{
|
74
|
-
"kind": "field",
|
75
|
-
"name": "containerRef",
|
76
|
-
"type": {
|
77
|
-
"text": "Ref<HTMLDivElement>"
|
78
|
-
},
|
79
|
-
"privacy": "private",
|
80
|
-
"description": "Container for the animation"
|
81
|
-
},
|
82
|
-
{
|
83
|
-
"kind": "field",
|
84
|
-
"name": "animation",
|
85
|
-
"description": "Exposed API of the animation library (lottie)",
|
86
|
-
"readonly": true
|
87
|
-
},
|
88
|
-
{
|
89
|
-
"kind": "method",
|
90
|
-
"name": "getLoopValue",
|
91
|
-
"privacy": "private"
|
92
|
-
},
|
93
|
-
{
|
94
|
-
"kind": "method",
|
95
|
-
"name": "onLoadSuccessHandler",
|
96
|
-
"privacy": "private",
|
97
|
-
"parameters": [
|
98
|
-
{
|
99
|
-
"name": "animationData",
|
100
|
-
"type": {
|
101
|
-
"text": "any"
|
102
|
-
}
|
103
|
-
}
|
104
|
-
],
|
105
|
-
"description": "Create new lotty instance for the loaded data"
|
106
|
-
},
|
107
|
-
{
|
108
|
-
"kind": "method",
|
109
|
-
"name": "onLoadFailHandler",
|
110
|
-
"privacy": "private",
|
111
|
-
"parameters": [
|
112
|
-
{
|
113
|
-
"name": "error",
|
114
|
-
"type": {
|
115
|
-
"text": "Error"
|
116
|
-
}
|
117
|
-
}
|
118
|
-
],
|
119
|
-
"description": "Error handler for animation loading"
|
120
|
-
},
|
121
|
-
{
|
122
|
-
"kind": "method",
|
123
|
-
"name": "getAnimationData",
|
124
|
-
"privacy": "private",
|
125
|
-
"description": "Import animation data dynamically"
|
126
|
-
},
|
127
|
-
{
|
128
|
-
"kind": "field",
|
129
|
-
"name": "onCompleteHandler",
|
130
|
-
"description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
|
131
|
-
}
|
132
|
-
],
|
133
|
-
"events": [
|
134
|
-
{
|
135
|
-
"name": "load",
|
136
|
-
"type": {
|
137
|
-
"text": "CustomEvent"
|
138
|
-
},
|
139
|
-
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
140
|
-
"reactName": "onLoad"
|
141
|
-
},
|
142
|
-
{
|
143
|
-
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
144
|
-
"name": "complete",
|
145
|
-
"reactName": "onComplete"
|
146
|
-
},
|
147
|
-
{
|
148
|
-
"description": "(React: onError) This event is dispatched when animation loading failed",
|
149
|
-
"name": "error",
|
150
|
-
"reactName": "onError"
|
151
|
-
}
|
152
|
-
],
|
153
|
-
"attributes": [
|
154
|
-
{
|
155
|
-
"name": "name",
|
156
|
-
"type": {
|
157
|
-
"text": "AnimationNames | undefined"
|
158
|
-
},
|
159
|
-
"description": "Name of the animation (= filename)",
|
160
|
-
"fieldName": "name"
|
161
|
-
},
|
162
|
-
{
|
163
|
-
"name": "loop",
|
164
|
-
"type": {
|
165
|
-
"text": "LoopType | undefined"
|
166
|
-
},
|
167
|
-
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
168
|
-
"fieldName": "loop"
|
169
|
-
},
|
170
|
-
{
|
171
|
-
"name": "autoplay",
|
172
|
-
"type": {
|
173
|
-
"text": "boolean | undefined"
|
174
|
-
},
|
175
|
-
"description": "Weather start the animation automatically",
|
176
|
-
"fieldName": "autoplay"
|
177
|
-
},
|
178
|
-
{
|
179
|
-
"name": "aria-label",
|
180
|
-
"type": {
|
181
|
-
"text": "string | null"
|
182
|
-
},
|
183
|
-
"default": "null",
|
184
|
-
"description": "Aria-label attribute to be set for accessibility",
|
185
|
-
"fieldName": "ariaLabel"
|
186
|
-
},
|
187
|
-
{
|
188
|
-
"name": "aria-labelledby",
|
189
|
-
"type": {
|
190
|
-
"text": "string | null"
|
191
|
-
},
|
192
|
-
"default": "null",
|
193
|
-
"description": "Aria-labelledby attribute to be set for accessibility",
|
194
|
-
"fieldName": "ariaLabelledBy"
|
195
|
-
}
|
196
|
-
],
|
197
|
-
"superclass": {
|
198
|
-
"name": "Component",
|
199
|
-
"module": "/src/models"
|
200
|
-
},
|
201
|
-
"tagName": "mdc-animation",
|
202
|
-
"jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
|
203
|
-
"customElement": true
|
204
|
-
}
|
205
|
-
],
|
206
|
-
"exports": [
|
207
|
-
{
|
208
|
-
"kind": "js",
|
209
|
-
"name": "default",
|
210
|
-
"declaration": {
|
211
|
-
"name": "Animation",
|
212
|
-
"module": "components/animation/animation.component.js"
|
213
|
-
}
|
214
|
-
}
|
215
|
-
]
|
216
|
-
},
|
217
5
|
{
|
218
6
|
"kind": "javascript-module",
|
219
7
|
"path": "components/alertchip/alertchip.component.js",
|
@@ -706,32 +494,244 @@
|
|
706
494
|
},
|
707
495
|
{
|
708
496
|
"kind": "javascript-module",
|
709
|
-
"path": "components/
|
497
|
+
"path": "components/animation/animation.component.js",
|
710
498
|
"declarations": [
|
711
499
|
{
|
712
500
|
"kind": "class",
|
713
|
-
"description": "The `mdc-
|
714
|
-
"name": "
|
715
|
-
"
|
501
|
+
"description": "The `mdc-animation` component is a wrapper around the Lottie animation library.\nIt fetches the animation data dynamically based on the provided name and renders it.\nThis is a display only component that does not have any interactive functionality.\nFrom accessibility perspective, (by default) it is a decorative image component.",
|
502
|
+
"name": "Animation",
|
503
|
+
"members": [
|
716
504
|
{
|
717
|
-
"
|
718
|
-
"name": "
|
505
|
+
"kind": "field",
|
506
|
+
"name": "name",
|
507
|
+
"type": {
|
508
|
+
"text": "AnimationNames | undefined"
|
509
|
+
},
|
510
|
+
"description": "Name of the animation (= filename)",
|
511
|
+
"attribute": "name",
|
512
|
+
"reflects": true
|
719
513
|
},
|
720
514
|
{
|
721
|
-
"
|
722
|
-
"name": "
|
515
|
+
"kind": "field",
|
516
|
+
"name": "loop",
|
517
|
+
"type": {
|
518
|
+
"text": "LoopType | undefined"
|
519
|
+
},
|
520
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
521
|
+
"attribute": "loop",
|
522
|
+
"reflects": true
|
723
523
|
},
|
724
524
|
{
|
725
|
-
"
|
726
|
-
"name": "
|
525
|
+
"kind": "field",
|
526
|
+
"name": "autoplay",
|
527
|
+
"type": {
|
528
|
+
"text": "boolean | undefined"
|
529
|
+
},
|
530
|
+
"description": "Weather start the animation automatically",
|
531
|
+
"attribute": "autoplay",
|
532
|
+
"reflects": true
|
727
533
|
},
|
728
534
|
{
|
729
|
-
"
|
730
|
-
"name": "
|
731
|
-
|
732
|
-
|
733
|
-
|
734
|
-
|
535
|
+
"kind": "field",
|
536
|
+
"name": "ariaLabel",
|
537
|
+
"type": {
|
538
|
+
"text": "string | null"
|
539
|
+
},
|
540
|
+
"default": "null",
|
541
|
+
"description": "Aria-label attribute to be set for accessibility",
|
542
|
+
"attribute": "aria-label"
|
543
|
+
},
|
544
|
+
{
|
545
|
+
"kind": "field",
|
546
|
+
"name": "ariaLabelledBy",
|
547
|
+
"type": {
|
548
|
+
"text": "string | null"
|
549
|
+
},
|
550
|
+
"default": "null",
|
551
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
552
|
+
"attribute": "aria-labelledby"
|
553
|
+
},
|
554
|
+
{
|
555
|
+
"kind": "field",
|
556
|
+
"name": "lottieInstance",
|
557
|
+
"type": {
|
558
|
+
"text": "AnimationItem | undefined"
|
559
|
+
},
|
560
|
+
"privacy": "private",
|
561
|
+
"description": "Lottie animation instance"
|
562
|
+
},
|
563
|
+
{
|
564
|
+
"kind": "field",
|
565
|
+
"name": "containerRef",
|
566
|
+
"type": {
|
567
|
+
"text": "Ref<HTMLDivElement>"
|
568
|
+
},
|
569
|
+
"privacy": "private",
|
570
|
+
"description": "Container for the animation"
|
571
|
+
},
|
572
|
+
{
|
573
|
+
"kind": "field",
|
574
|
+
"name": "animation",
|
575
|
+
"description": "Exposed API of the animation library (lottie)",
|
576
|
+
"readonly": true
|
577
|
+
},
|
578
|
+
{
|
579
|
+
"kind": "method",
|
580
|
+
"name": "getLoopValue",
|
581
|
+
"privacy": "private"
|
582
|
+
},
|
583
|
+
{
|
584
|
+
"kind": "method",
|
585
|
+
"name": "onLoadSuccessHandler",
|
586
|
+
"privacy": "private",
|
587
|
+
"parameters": [
|
588
|
+
{
|
589
|
+
"name": "animationData",
|
590
|
+
"type": {
|
591
|
+
"text": "any"
|
592
|
+
}
|
593
|
+
}
|
594
|
+
],
|
595
|
+
"description": "Create new lotty instance for the loaded data"
|
596
|
+
},
|
597
|
+
{
|
598
|
+
"kind": "method",
|
599
|
+
"name": "onLoadFailHandler",
|
600
|
+
"privacy": "private",
|
601
|
+
"parameters": [
|
602
|
+
{
|
603
|
+
"name": "error",
|
604
|
+
"type": {
|
605
|
+
"text": "Error"
|
606
|
+
}
|
607
|
+
}
|
608
|
+
],
|
609
|
+
"description": "Error handler for animation loading"
|
610
|
+
},
|
611
|
+
{
|
612
|
+
"kind": "method",
|
613
|
+
"name": "getAnimationData",
|
614
|
+
"privacy": "private",
|
615
|
+
"description": "Import animation data dynamically"
|
616
|
+
},
|
617
|
+
{
|
618
|
+
"kind": "field",
|
619
|
+
"name": "onCompleteHandler",
|
620
|
+
"description": "Re-dispatch the complete event from the animation library\n\nThis handler called with the animation instance instead of the component instance\nso we need to bind it to the component instance. The arrow function just does that."
|
621
|
+
}
|
622
|
+
],
|
623
|
+
"events": [
|
624
|
+
{
|
625
|
+
"name": "load",
|
626
|
+
"type": {
|
627
|
+
"text": "CustomEvent"
|
628
|
+
},
|
629
|
+
"description": "(React: onLoad) This event is dispatched when the animation is loaded",
|
630
|
+
"reactName": "onLoad"
|
631
|
+
},
|
632
|
+
{
|
633
|
+
"description": "(React: onComplete) This event is dispatched when all animation loops completed",
|
634
|
+
"name": "complete",
|
635
|
+
"reactName": "onComplete"
|
636
|
+
},
|
637
|
+
{
|
638
|
+
"description": "(React: onError) This event is dispatched when animation loading failed",
|
639
|
+
"name": "error",
|
640
|
+
"reactName": "onError"
|
641
|
+
}
|
642
|
+
],
|
643
|
+
"attributes": [
|
644
|
+
{
|
645
|
+
"name": "name",
|
646
|
+
"type": {
|
647
|
+
"text": "AnimationNames | undefined"
|
648
|
+
},
|
649
|
+
"description": "Name of the animation (= filename)",
|
650
|
+
"fieldName": "name"
|
651
|
+
},
|
652
|
+
{
|
653
|
+
"name": "loop",
|
654
|
+
"type": {
|
655
|
+
"text": "LoopType | undefined"
|
656
|
+
},
|
657
|
+
"description": "How many times to loop the animation\n- \"true\" - infinite\n- \"false\" - no loop\n- number - number of times to loop",
|
658
|
+
"fieldName": "loop"
|
659
|
+
},
|
660
|
+
{
|
661
|
+
"name": "autoplay",
|
662
|
+
"type": {
|
663
|
+
"text": "boolean | undefined"
|
664
|
+
},
|
665
|
+
"description": "Weather start the animation automatically",
|
666
|
+
"fieldName": "autoplay"
|
667
|
+
},
|
668
|
+
{
|
669
|
+
"name": "aria-label",
|
670
|
+
"type": {
|
671
|
+
"text": "string | null"
|
672
|
+
},
|
673
|
+
"default": "null",
|
674
|
+
"description": "Aria-label attribute to be set for accessibility",
|
675
|
+
"fieldName": "ariaLabel"
|
676
|
+
},
|
677
|
+
{
|
678
|
+
"name": "aria-labelledby",
|
679
|
+
"type": {
|
680
|
+
"text": "string | null"
|
681
|
+
},
|
682
|
+
"default": "null",
|
683
|
+
"description": "Aria-labelledby attribute to be set for accessibility",
|
684
|
+
"fieldName": "ariaLabelledBy"
|
685
|
+
}
|
686
|
+
],
|
687
|
+
"superclass": {
|
688
|
+
"name": "Component",
|
689
|
+
"module": "/src/models"
|
690
|
+
},
|
691
|
+
"tagName": "mdc-animation",
|
692
|
+
"jsDoc": "/**\n * The `mdc-animation` component is a wrapper around the Lottie animation library.\n * It fetches the animation data dynamically based on the provided name and renders it.\n * This is a display only component that does not have any interactive functionality.\n * From accessibility perspective, (by default) it is a decorative image component.\n *\n * @tagname mdc-animation\n *\n * @event load - (React: onLoad) This event is dispatched when the animation is loaded\n * @event complete - (React: onComplete) This event is dispatched when all animation loops completed\n * @event error - (React: onError) This event is dispatched when animation loading failed\n */",
|
693
|
+
"customElement": true
|
694
|
+
}
|
695
|
+
],
|
696
|
+
"exports": [
|
697
|
+
{
|
698
|
+
"kind": "js",
|
699
|
+
"name": "default",
|
700
|
+
"declaration": {
|
701
|
+
"name": "Animation",
|
702
|
+
"module": "components/animation/animation.component.js"
|
703
|
+
}
|
704
|
+
}
|
705
|
+
]
|
706
|
+
},
|
707
|
+
{
|
708
|
+
"kind": "javascript-module",
|
709
|
+
"path": "components/appheader/appheader.component.js",
|
710
|
+
"declarations": [
|
711
|
+
{
|
712
|
+
"kind": "class",
|
713
|
+
"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**.",
|
714
|
+
"name": "Appheader",
|
715
|
+
"cssParts": [
|
716
|
+
{
|
717
|
+
"description": "The main container for styling the header.",
|
718
|
+
"name": "container"
|
719
|
+
},
|
720
|
+
{
|
721
|
+
"description": "The leading section of the header.",
|
722
|
+
"name": "leading-section"
|
723
|
+
},
|
724
|
+
{
|
725
|
+
"description": "The center section of the header.",
|
726
|
+
"name": "center-section"
|
727
|
+
},
|
728
|
+
{
|
729
|
+
"description": "The trailing section of the header.",
|
730
|
+
"name": "trailing-section"
|
731
|
+
}
|
732
|
+
],
|
733
|
+
"slots": [
|
734
|
+
{
|
735
735
|
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
736
736
|
"name": "leading"
|
737
737
|
},
|
@@ -767,35 +767,50 @@
|
|
767
767
|
},
|
768
768
|
{
|
769
769
|
"kind": "javascript-module",
|
770
|
-
"path": "components/
|
770
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
771
771
|
"declarations": [
|
772
772
|
{
|
773
773
|
"kind": "class",
|
774
|
-
"description": "The `mdc-
|
775
|
-
"name": "
|
774
|
+
"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.",
|
775
|
+
"name": "AvatarButton",
|
776
776
|
"cssProperties": [
|
777
777
|
{
|
778
|
-
"description": "
|
779
|
-
"name": "--mdc-
|
780
|
-
},
|
781
|
-
{
|
782
|
-
"description": "Allows customization of the default foreground color.",
|
783
|
-
"name": "--mdc-avatar-default-foreground-color"
|
784
|
-
},
|
785
|
-
{
|
786
|
-
"description": "Allows customization of the loading indicator background color.",
|
787
|
-
"name": "--mdc-avatar-loading-indicator-background-color"
|
778
|
+
"description": "Background color of the overlay in rest state",
|
779
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
788
780
|
},
|
789
781
|
{
|
790
|
-
"description": "
|
791
|
-
"name": "--mdc-
|
782
|
+
"description": "Background color of the overlay in hover state",
|
783
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
792
784
|
},
|
793
785
|
{
|
794
|
-
"description": "
|
795
|
-
"name": "--mdc-
|
786
|
+
"description": "Background color of the overlay in active state",
|
787
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
796
788
|
}
|
797
789
|
],
|
798
790
|
"members": [
|
791
|
+
{
|
792
|
+
"kind": "field",
|
793
|
+
"name": "ariaLabel",
|
794
|
+
"type": {
|
795
|
+
"text": "string | null"
|
796
|
+
},
|
797
|
+
"default": "null",
|
798
|
+
"description": "Aria-label attribute to be set for accessibility",
|
799
|
+
"attribute": "aria-label"
|
800
|
+
},
|
801
|
+
{
|
802
|
+
"kind": "method",
|
803
|
+
"name": "setSize",
|
804
|
+
"privacy": "private",
|
805
|
+
"parameters": [
|
806
|
+
{
|
807
|
+
"name": "size",
|
808
|
+
"type": {
|
809
|
+
"text": "AvatarSize"
|
810
|
+
}
|
811
|
+
}
|
812
|
+
]
|
813
|
+
},
|
799
814
|
{
|
800
815
|
"kind": "field",
|
801
816
|
"name": "src",
|
@@ -839,15 +854,15 @@
|
|
839
854
|
"kind": "field",
|
840
855
|
"name": "size",
|
841
856
|
"type": {
|
842
|
-
"text": "
|
857
|
+
"text": "ButtonSize"
|
843
858
|
},
|
844
859
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
845
860
|
"default": "32",
|
846
861
|
"attribute": "size",
|
847
862
|
"reflects": true,
|
848
863
|
"inheritedFrom": {
|
849
|
-
"name": "
|
850
|
-
"module": "
|
864
|
+
"name": "Buttonsimple",
|
865
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
851
866
|
}
|
852
867
|
},
|
853
868
|
{
|
@@ -889,563 +904,653 @@
|
|
889
904
|
"name": "IconNameMixin",
|
890
905
|
"module": "utils/mixins/IconNameMixin.js"
|
891
906
|
}
|
892
|
-
}
|
893
|
-
],
|
894
|
-
"mixins": [
|
895
|
-
{
|
896
|
-
"name": "AvatarComponentMixin",
|
897
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
898
907
|
},
|
899
908
|
{
|
900
|
-
"
|
901
|
-
"
|
902
|
-
}
|
903
|
-
],
|
904
|
-
"superclass": {
|
905
|
-
"name": "Component",
|
906
|
-
"module": "/src/models"
|
907
|
-
},
|
908
|
-
"tagName": "mdc-avatar",
|
909
|
-
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
|
910
|
-
"customElement": true,
|
911
|
-
"attributes": [
|
912
|
-
{
|
913
|
-
"name": "src",
|
909
|
+
"kind": "field",
|
910
|
+
"name": "tabIndex",
|
914
911
|
"type": {
|
915
|
-
"text": "
|
912
|
+
"text": "number"
|
916
913
|
},
|
917
|
-
"
|
918
|
-
"
|
914
|
+
"default": "0",
|
915
|
+
"description": "This property specifies the tab order of the element.",
|
916
|
+
"attribute": "tabIndex",
|
917
|
+
"reflects": true,
|
919
918
|
"inheritedFrom": {
|
920
|
-
"name": "
|
921
|
-
"module": "
|
919
|
+
"name": "TabIndexMixin",
|
920
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
922
921
|
}
|
923
922
|
},
|
924
923
|
{
|
925
|
-
"
|
924
|
+
"kind": "field",
|
925
|
+
"name": "disabled",
|
926
926
|
"type": {
|
927
|
-
"text": "
|
927
|
+
"text": "boolean | undefined"
|
928
928
|
},
|
929
|
-
"description": "
|
930
|
-
"
|
929
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
930
|
+
"default": "undefined",
|
931
|
+
"attribute": "disabled",
|
932
|
+
"reflects": true,
|
931
933
|
"inheritedFrom": {
|
932
|
-
"name": "
|
933
|
-
"module": "
|
934
|
+
"name": "DisabledMixin",
|
935
|
+
"module": "utils/mixins/DisabledMixin.js"
|
934
936
|
}
|
935
937
|
},
|
936
938
|
{
|
937
|
-
"
|
939
|
+
"kind": "field",
|
940
|
+
"name": "active",
|
938
941
|
"type": {
|
939
|
-
"text": "
|
942
|
+
"text": "boolean | undefined"
|
940
943
|
},
|
941
|
-
"description": "The
|
942
|
-
"
|
944
|
+
"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.",
|
945
|
+
"default": "undefined",
|
946
|
+
"attribute": "active",
|
947
|
+
"reflects": true,
|
943
948
|
"inheritedFrom": {
|
944
|
-
"name": "
|
945
|
-
"module": "
|
949
|
+
"name": "Buttonsimple",
|
950
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
946
951
|
}
|
947
952
|
},
|
948
953
|
{
|
949
|
-
"
|
954
|
+
"kind": "field",
|
955
|
+
"name": "softDisabled",
|
950
956
|
"type": {
|
951
|
-
"text": "
|
957
|
+
"text": "boolean | undefined"
|
952
958
|
},
|
953
|
-
"description": "
|
954
|
-
"default": "
|
955
|
-
"
|
959
|
+
"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.",
|
960
|
+
"default": "undefined",
|
961
|
+
"attribute": "soft-disabled",
|
962
|
+
"reflects": true,
|
956
963
|
"inheritedFrom": {
|
957
|
-
"name": "
|
958
|
-
"module": "
|
964
|
+
"name": "Buttonsimple",
|
965
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
959
966
|
}
|
960
967
|
},
|
961
968
|
{
|
962
|
-
"
|
963
|
-
"
|
964
|
-
|
965
|
-
|
966
|
-
"
|
967
|
-
"
|
969
|
+
"kind": "field",
|
970
|
+
"name": "role",
|
971
|
+
"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.",
|
972
|
+
"default": "button",
|
973
|
+
"attribute": "role",
|
974
|
+
"reflects": true,
|
968
975
|
"inheritedFrom": {
|
969
|
-
"name": "
|
970
|
-
"module": "
|
976
|
+
"name": "Buttonsimple",
|
977
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
971
978
|
}
|
972
979
|
},
|
973
980
|
{
|
974
|
-
"
|
981
|
+
"kind": "field",
|
982
|
+
"name": "ariaStateKey",
|
975
983
|
"type": {
|
976
|
-
"text": "
|
984
|
+
"text": "string | undefined"
|
977
985
|
},
|
978
|
-
"
|
979
|
-
"
|
980
|
-
"
|
986
|
+
"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`",
|
987
|
+
"default": "'aria-pressed' (when)",
|
988
|
+
"attribute": "ariaStateKey",
|
989
|
+
"reflects": true,
|
981
990
|
"inheritedFrom": {
|
982
|
-
"name": "
|
983
|
-
"module": "
|
991
|
+
"name": "Buttonsimple",
|
992
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
984
993
|
}
|
985
994
|
},
|
986
995
|
{
|
987
|
-
"
|
996
|
+
"kind": "field",
|
997
|
+
"name": "type",
|
988
998
|
"type": {
|
989
|
-
"text": "
|
999
|
+
"text": "ButtonType"
|
990
1000
|
},
|
991
|
-
"description": "
|
992
|
-
"
|
1001
|
+
"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.",
|
1002
|
+
"default": "button",
|
1003
|
+
"attribute": "type",
|
1004
|
+
"reflects": true,
|
993
1005
|
"inheritedFrom": {
|
994
|
-
"name": "
|
995
|
-
"module": "
|
1006
|
+
"name": "Buttonsimple",
|
1007
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
996
1008
|
}
|
997
|
-
}
|
998
|
-
]
|
999
|
-
}
|
1000
|
-
],
|
1001
|
-
"exports": [
|
1002
|
-
{
|
1003
|
-
"kind": "js",
|
1004
|
-
"name": "default",
|
1005
|
-
"declaration": {
|
1006
|
-
"name": "Avatar",
|
1007
|
-
"module": "components/avatar/avatar.component.js"
|
1008
|
-
}
|
1009
|
-
}
|
1010
|
-
]
|
1011
|
-
},
|
1012
|
-
{
|
1013
|
-
"kind": "javascript-module",
|
1014
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
1015
|
-
"declarations": [
|
1016
|
-
{
|
1017
|
-
"kind": "class",
|
1018
|
-
"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.",
|
1019
|
-
"name": "AvatarButton",
|
1020
|
-
"cssProperties": [
|
1021
|
-
{
|
1022
|
-
"description": "Background color of the overlay in rest state",
|
1023
|
-
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
1024
1009
|
},
|
1025
1010
|
{
|
1026
|
-
"
|
1027
|
-
"name": "
|
1011
|
+
"kind": "method",
|
1012
|
+
"name": "executeAction",
|
1013
|
+
"privacy": "protected",
|
1014
|
+
"inheritedFrom": {
|
1015
|
+
"name": "Buttonsimple",
|
1016
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1017
|
+
}
|
1028
1018
|
},
|
1029
1019
|
{
|
1030
|
-
"
|
1031
|
-
"name": "
|
1032
|
-
|
1033
|
-
|
1034
|
-
|
1035
|
-
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1039
|
-
|
1040
|
-
|
1041
|
-
|
1042
|
-
|
1043
|
-
|
1020
|
+
"kind": "method",
|
1021
|
+
"name": "setActive",
|
1022
|
+
"privacy": "protected",
|
1023
|
+
"parameters": [
|
1024
|
+
{
|
1025
|
+
"name": "element",
|
1026
|
+
"type": {
|
1027
|
+
"text": "HTMLElement"
|
1028
|
+
},
|
1029
|
+
"description": "The button element"
|
1030
|
+
},
|
1031
|
+
{
|
1032
|
+
"name": "active",
|
1033
|
+
"optional": true,
|
1034
|
+
"type": {
|
1035
|
+
"text": "boolean"
|
1036
|
+
},
|
1037
|
+
"description": "The active state of the element"
|
1038
|
+
}
|
1039
|
+
],
|
1040
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
1041
|
+
"inheritedFrom": {
|
1042
|
+
"name": "Buttonsimple",
|
1043
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1044
|
+
}
|
1044
1045
|
},
|
1045
1046
|
{
|
1046
1047
|
"kind": "method",
|
1047
|
-
"name": "
|
1048
|
+
"name": "setSoftDisabled",
|
1048
1049
|
"privacy": "private",
|
1049
1050
|
"parameters": [
|
1050
1051
|
{
|
1051
|
-
"name": "
|
1052
|
+
"name": "element",
|
1052
1053
|
"type": {
|
1053
|
-
"text": "
|
1054
|
-
}
|
1054
|
+
"text": "HTMLElement"
|
1055
|
+
},
|
1056
|
+
"description": "The button element."
|
1057
|
+
},
|
1058
|
+
{
|
1059
|
+
"name": "softDisabled",
|
1060
|
+
"optional": true,
|
1061
|
+
"type": {
|
1062
|
+
"text": "boolean"
|
1063
|
+
},
|
1064
|
+
"description": "The soft-disabled state."
|
1055
1065
|
}
|
1056
|
-
]
|
1066
|
+
],
|
1067
|
+
"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.",
|
1068
|
+
"inheritedFrom": {
|
1069
|
+
"name": "Buttonsimple",
|
1070
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1071
|
+
}
|
1057
1072
|
},
|
1058
1073
|
{
|
1059
|
-
"kind": "
|
1060
|
-
"name": "
|
1061
|
-
"
|
1062
|
-
|
1063
|
-
|
1064
|
-
|
1065
|
-
|
1074
|
+
"kind": "method",
|
1075
|
+
"name": "setDisabled",
|
1076
|
+
"privacy": "private",
|
1077
|
+
"parameters": [
|
1078
|
+
{
|
1079
|
+
"name": "element",
|
1080
|
+
"type": {
|
1081
|
+
"text": "HTMLElement"
|
1082
|
+
},
|
1083
|
+
"description": "The button element."
|
1084
|
+
},
|
1085
|
+
{
|
1086
|
+
"name": "disabled",
|
1087
|
+
"type": {
|
1088
|
+
"text": "boolean"
|
1089
|
+
},
|
1090
|
+
"description": "The disabled state."
|
1091
|
+
}
|
1092
|
+
],
|
1093
|
+
"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.",
|
1066
1094
|
"inheritedFrom": {
|
1067
|
-
"name": "
|
1068
|
-
"module": "
|
1095
|
+
"name": "Buttonsimple",
|
1096
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1097
|
+
}
|
1098
|
+
},
|
1099
|
+
{
|
1100
|
+
"kind": "method",
|
1101
|
+
"name": "triggerClickEvent",
|
1102
|
+
"privacy": "private",
|
1103
|
+
"inheritedFrom": {
|
1104
|
+
"name": "Buttonsimple",
|
1105
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1106
|
+
}
|
1107
|
+
},
|
1108
|
+
{
|
1109
|
+
"kind": "method",
|
1110
|
+
"name": "handleBlur",
|
1111
|
+
"privacy": "private",
|
1112
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
1113
|
+
"inheritedFrom": {
|
1114
|
+
"name": "Buttonsimple",
|
1115
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1116
|
+
}
|
1117
|
+
},
|
1118
|
+
{
|
1119
|
+
"kind": "method",
|
1120
|
+
"name": "handleKeyDown",
|
1121
|
+
"privacy": "private",
|
1122
|
+
"parameters": [
|
1123
|
+
{
|
1124
|
+
"name": "event",
|
1125
|
+
"type": {
|
1126
|
+
"text": "KeyboardEvent"
|
1127
|
+
},
|
1128
|
+
"description": "The keyboard event."
|
1129
|
+
}
|
1130
|
+
],
|
1131
|
+
"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.",
|
1132
|
+
"inheritedFrom": {
|
1133
|
+
"name": "Buttonsimple",
|
1134
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1135
|
+
}
|
1136
|
+
},
|
1137
|
+
{
|
1138
|
+
"kind": "method",
|
1139
|
+
"name": "handleKeyUp",
|
1140
|
+
"privacy": "private",
|
1141
|
+
"parameters": [
|
1142
|
+
{
|
1143
|
+
"name": "event",
|
1144
|
+
"type": {
|
1145
|
+
"text": "KeyboardEvent"
|
1146
|
+
},
|
1147
|
+
"description": "The keyboard event."
|
1148
|
+
}
|
1149
|
+
],
|
1150
|
+
"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.",
|
1151
|
+
"inheritedFrom": {
|
1152
|
+
"name": "Buttonsimple",
|
1153
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1154
|
+
}
|
1155
|
+
}
|
1156
|
+
],
|
1157
|
+
"events": [
|
1158
|
+
{
|
1159
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
1160
|
+
"name": "click",
|
1161
|
+
"reactName": "onClick",
|
1162
|
+
"inheritedFrom": {
|
1163
|
+
"name": "Buttonsimple",
|
1164
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1165
|
+
}
|
1166
|
+
},
|
1167
|
+
{
|
1168
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
1169
|
+
"name": "keydown",
|
1170
|
+
"reactName": "onKeyDown",
|
1171
|
+
"inheritedFrom": {
|
1172
|
+
"name": "Buttonsimple",
|
1173
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1174
|
+
}
|
1175
|
+
},
|
1176
|
+
{
|
1177
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
1178
|
+
"name": "keyup",
|
1179
|
+
"reactName": "onKeyUp",
|
1180
|
+
"inheritedFrom": {
|
1181
|
+
"name": "Buttonsimple",
|
1182
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1183
|
+
}
|
1184
|
+
},
|
1185
|
+
{
|
1186
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
1187
|
+
"name": "focus",
|
1188
|
+
"reactName": "onFocus",
|
1189
|
+
"inheritedFrom": {
|
1190
|
+
"name": "Buttonsimple",
|
1191
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1192
|
+
}
|
1193
|
+
}
|
1194
|
+
],
|
1195
|
+
"attributes": [
|
1196
|
+
{
|
1197
|
+
"name": "aria-label",
|
1198
|
+
"type": {
|
1199
|
+
"text": "string | null"
|
1200
|
+
},
|
1201
|
+
"default": "null",
|
1202
|
+
"description": "Aria-label attribute to be set for accessibility",
|
1203
|
+
"fieldName": "ariaLabel"
|
1204
|
+
},
|
1205
|
+
{
|
1206
|
+
"name": "src",
|
1207
|
+
"type": {
|
1208
|
+
"text": "string | undefined"
|
1209
|
+
},
|
1210
|
+
"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.",
|
1211
|
+
"fieldName": "src",
|
1212
|
+
"inheritedFrom": {
|
1213
|
+
"name": "AvatarComponentMixin",
|
1214
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1069
1215
|
}
|
1070
1216
|
},
|
1071
1217
|
{
|
1072
|
-
"kind": "field",
|
1073
1218
|
"name": "initials",
|
1074
1219
|
"type": {
|
1075
1220
|
"text": "string | undefined"
|
1076
1221
|
},
|
1077
1222
|
"description": "The initials to be displayed for the avatar.",
|
1078
|
-
"
|
1223
|
+
"fieldName": "initials",
|
1079
1224
|
"inheritedFrom": {
|
1080
1225
|
"name": "AvatarComponentMixin",
|
1081
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1226
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1082
1227
|
}
|
1083
1228
|
},
|
1084
1229
|
{
|
1085
|
-
"kind": "field",
|
1086
1230
|
"name": "presence",
|
1087
1231
|
"type": {
|
1088
1232
|
"text": "PresenceType | undefined"
|
1089
1233
|
},
|
1090
1234
|
"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`",
|
1091
|
-
"
|
1235
|
+
"fieldName": "presence",
|
1092
1236
|
"inheritedFrom": {
|
1093
1237
|
"name": "AvatarComponentMixin",
|
1094
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1238
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1095
1239
|
}
|
1096
1240
|
},
|
1097
1241
|
{
|
1098
|
-
"kind": "field",
|
1099
1242
|
"name": "size",
|
1100
1243
|
"type": {
|
1101
1244
|
"text": "ButtonSize"
|
1102
1245
|
},
|
1103
1246
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1104
1247
|
"default": "32",
|
1105
|
-
"
|
1106
|
-
"reflects": true,
|
1248
|
+
"fieldName": "size",
|
1107
1249
|
"inheritedFrom": {
|
1108
1250
|
"name": "Buttonsimple",
|
1109
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1251
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1110
1252
|
}
|
1111
1253
|
},
|
1112
1254
|
{
|
1113
|
-
"kind": "field",
|
1114
1255
|
"name": "counter",
|
1115
1256
|
"type": {
|
1116
1257
|
"text": "number | undefined"
|
1117
1258
|
},
|
1118
1259
|
"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`.",
|
1119
|
-
"
|
1260
|
+
"fieldName": "counter",
|
1120
1261
|
"inheritedFrom": {
|
1121
1262
|
"name": "AvatarComponentMixin",
|
1122
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1263
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1123
1264
|
}
|
1124
1265
|
},
|
1125
1266
|
{
|
1126
|
-
"
|
1127
|
-
"name": "isTyping",
|
1267
|
+
"name": "is-typing",
|
1128
1268
|
"type": {
|
1129
1269
|
"text": "boolean"
|
1130
1270
|
},
|
1131
1271
|
"default": "false",
|
1132
1272
|
"description": "Represents the typing indicator when the user is typing.",
|
1133
|
-
"
|
1273
|
+
"fieldName": "isTyping",
|
1134
1274
|
"inheritedFrom": {
|
1135
1275
|
"name": "AvatarComponentMixin",
|
1136
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
1276
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1137
1277
|
}
|
1138
1278
|
},
|
1139
1279
|
{
|
1140
|
-
"
|
1141
|
-
"name": "iconName",
|
1280
|
+
"name": "icon-name",
|
1142
1281
|
"type": {
|
1143
1282
|
"text": "IconNames | undefined"
|
1144
1283
|
},
|
1145
1284
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1146
|
-
"
|
1285
|
+
"fieldName": "iconName",
|
1147
1286
|
"inheritedFrom": {
|
1148
1287
|
"name": "IconNameMixin",
|
1149
|
-
"module": "utils/mixins/IconNameMixin.
|
1288
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
1150
1289
|
}
|
1151
1290
|
},
|
1152
1291
|
{
|
1153
|
-
"kind": "field",
|
1154
1292
|
"name": "tabIndex",
|
1155
1293
|
"type": {
|
1156
1294
|
"text": "number"
|
1157
1295
|
},
|
1158
1296
|
"default": "0",
|
1159
1297
|
"description": "This property specifies the tab order of the element.",
|
1160
|
-
"
|
1161
|
-
"reflects": true,
|
1298
|
+
"fieldName": "tabIndex",
|
1162
1299
|
"inheritedFrom": {
|
1163
1300
|
"name": "TabIndexMixin",
|
1164
|
-
"module": "utils/mixins/TabIndexMixin.
|
1301
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
1165
1302
|
}
|
1166
1303
|
},
|
1167
1304
|
{
|
1168
|
-
"kind": "field",
|
1169
1305
|
"name": "disabled",
|
1170
1306
|
"type": {
|
1171
1307
|
"text": "boolean | undefined"
|
1172
1308
|
},
|
1173
1309
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1174
1310
|
"default": "undefined",
|
1175
|
-
"
|
1176
|
-
"reflects": true,
|
1311
|
+
"fieldName": "disabled",
|
1177
1312
|
"inheritedFrom": {
|
1178
1313
|
"name": "DisabledMixin",
|
1179
|
-
"module": "utils/mixins/DisabledMixin.
|
1314
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
1180
1315
|
}
|
1181
1316
|
},
|
1182
1317
|
{
|
1183
|
-
"kind": "field",
|
1184
1318
|
"name": "active",
|
1185
1319
|
"type": {
|
1186
1320
|
"text": "boolean | undefined"
|
1187
1321
|
},
|
1188
1322
|
"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.",
|
1189
1323
|
"default": "undefined",
|
1190
|
-
"
|
1191
|
-
"reflects": true,
|
1324
|
+
"fieldName": "active",
|
1192
1325
|
"inheritedFrom": {
|
1193
1326
|
"name": "Buttonsimple",
|
1194
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1327
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1195
1328
|
}
|
1196
1329
|
},
|
1197
1330
|
{
|
1198
|
-
"
|
1199
|
-
"name": "softDisabled",
|
1331
|
+
"name": "soft-disabled",
|
1200
1332
|
"type": {
|
1201
1333
|
"text": "boolean | undefined"
|
1202
1334
|
},
|
1203
1335
|
"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.",
|
1204
1336
|
"default": "undefined",
|
1205
|
-
"
|
1206
|
-
"reflects": true,
|
1337
|
+
"fieldName": "softDisabled",
|
1207
1338
|
"inheritedFrom": {
|
1208
1339
|
"name": "Buttonsimple",
|
1209
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1340
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1210
1341
|
}
|
1211
1342
|
},
|
1212
1343
|
{
|
1213
|
-
"kind": "field",
|
1214
1344
|
"name": "role",
|
1215
1345
|
"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.",
|
1216
1346
|
"default": "button",
|
1217
|
-
"
|
1218
|
-
"reflects": true,
|
1347
|
+
"fieldName": "role",
|
1219
1348
|
"inheritedFrom": {
|
1220
1349
|
"name": "Buttonsimple",
|
1221
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1350
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1222
1351
|
}
|
1223
1352
|
},
|
1224
1353
|
{
|
1225
|
-
"kind": "field",
|
1226
1354
|
"name": "ariaStateKey",
|
1227
1355
|
"type": {
|
1228
1356
|
"text": "string | undefined"
|
1229
1357
|
},
|
1230
1358
|
"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`",
|
1231
1359
|
"default": "'aria-pressed' (when)",
|
1232
|
-
"
|
1233
|
-
"reflects": true,
|
1360
|
+
"fieldName": "ariaStateKey",
|
1234
1361
|
"inheritedFrom": {
|
1235
1362
|
"name": "Buttonsimple",
|
1236
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1363
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1237
1364
|
}
|
1238
1365
|
},
|
1239
1366
|
{
|
1240
|
-
"kind": "field",
|
1241
1367
|
"name": "type",
|
1242
1368
|
"type": {
|
1243
1369
|
"text": "ButtonType"
|
1244
1370
|
},
|
1245
1371
|
"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.",
|
1246
1372
|
"default": "button",
|
1247
|
-
"
|
1248
|
-
"reflects": true,
|
1373
|
+
"fieldName": "type",
|
1249
1374
|
"inheritedFrom": {
|
1250
1375
|
"name": "Buttonsimple",
|
1251
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
1376
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1252
1377
|
}
|
1378
|
+
}
|
1379
|
+
],
|
1380
|
+
"mixins": [
|
1381
|
+
{
|
1382
|
+
"name": "AvatarComponentMixin",
|
1383
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1253
1384
|
},
|
1254
1385
|
{
|
1255
|
-
"
|
1256
|
-
"
|
1257
|
-
|
1258
|
-
|
1259
|
-
|
1260
|
-
|
1261
|
-
|
1386
|
+
"name": "IconNameMixin",
|
1387
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1388
|
+
}
|
1389
|
+
],
|
1390
|
+
"superclass": {
|
1391
|
+
"name": "Buttonsimple",
|
1392
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
1393
|
+
},
|
1394
|
+
"tagName": "mdc-avatarbutton",
|
1395
|
+
"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 * @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 */",
|
1396
|
+
"customElement": true
|
1397
|
+
}
|
1398
|
+
],
|
1399
|
+
"exports": [
|
1400
|
+
{
|
1401
|
+
"kind": "js",
|
1402
|
+
"name": "default",
|
1403
|
+
"declaration": {
|
1404
|
+
"name": "AvatarButton",
|
1405
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
1406
|
+
}
|
1407
|
+
}
|
1408
|
+
]
|
1409
|
+
},
|
1410
|
+
{
|
1411
|
+
"kind": "javascript-module",
|
1412
|
+
"path": "components/avatar/avatar.component.js",
|
1413
|
+
"declarations": [
|
1414
|
+
{
|
1415
|
+
"kind": "class",
|
1416
|
+
"description": "The `mdc-avatar` component is used to represent a person or a space.\nAn avatar can be an icon, initials, counter and photo.\n\nTo set the photo of an avatar,\nyou need to set \"src\" attribute.\n\nWhile the avatar image is loading, as a placeholder,\nwe will show the initials text.\nIf the initials are not specified then,\nwe will show `user-regular` icon as a placeholder.\n\nBy default, if there are no attributes specified,\nthen the default avatar will be an icon with `user-regular` name.\n\nThe avatar component is non clickable and non interactive/focusable component.\nIf the avatar is typing, then the loading indicator will be displayed.\nIf the counter type avatar is set to a negative number, then we will display 0.\nThe presence indicator will be hidden when the counter property is set.",
|
1417
|
+
"name": "Avatar",
|
1418
|
+
"cssProperties": [
|
1419
|
+
{
|
1420
|
+
"description": "Allows customization of the default background color.",
|
1421
|
+
"name": "--mdc-avatar-default-background-color"
|
1262
1422
|
},
|
1263
1423
|
{
|
1264
|
-
"
|
1265
|
-
"name": "
|
1266
|
-
"privacy": "protected",
|
1267
|
-
"parameters": [
|
1268
|
-
{
|
1269
|
-
"name": "element",
|
1270
|
-
"type": {
|
1271
|
-
"text": "HTMLElement"
|
1272
|
-
},
|
1273
|
-
"description": "The button element"
|
1274
|
-
},
|
1275
|
-
{
|
1276
|
-
"name": "active",
|
1277
|
-
"optional": true,
|
1278
|
-
"type": {
|
1279
|
-
"text": "boolean"
|
1280
|
-
},
|
1281
|
-
"description": "The active state of the element"
|
1282
|
-
}
|
1283
|
-
],
|
1284
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
1285
|
-
"inheritedFrom": {
|
1286
|
-
"name": "Buttonsimple",
|
1287
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1288
|
-
}
|
1424
|
+
"description": "Allows customization of the default foreground color.",
|
1425
|
+
"name": "--mdc-avatar-default-foreground-color"
|
1289
1426
|
},
|
1290
1427
|
{
|
1291
|
-
"
|
1292
|
-
"name": "
|
1293
|
-
"privacy": "private",
|
1294
|
-
"parameters": [
|
1295
|
-
{
|
1296
|
-
"name": "element",
|
1297
|
-
"type": {
|
1298
|
-
"text": "HTMLElement"
|
1299
|
-
},
|
1300
|
-
"description": "The button element."
|
1301
|
-
},
|
1302
|
-
{
|
1303
|
-
"name": "softDisabled",
|
1304
|
-
"optional": true,
|
1305
|
-
"type": {
|
1306
|
-
"text": "boolean"
|
1307
|
-
},
|
1308
|
-
"description": "The soft-disabled state."
|
1309
|
-
}
|
1310
|
-
],
|
1311
|
-
"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.",
|
1312
|
-
"inheritedFrom": {
|
1313
|
-
"name": "Buttonsimple",
|
1314
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1315
|
-
}
|
1428
|
+
"description": "Allows customization of the loading indicator background color.",
|
1429
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
1316
1430
|
},
|
1317
1431
|
{
|
1318
|
-
"
|
1319
|
-
"name": "
|
1320
|
-
"privacy": "private",
|
1321
|
-
"parameters": [
|
1322
|
-
{
|
1323
|
-
"name": "element",
|
1324
|
-
"type": {
|
1325
|
-
"text": "HTMLElement"
|
1326
|
-
},
|
1327
|
-
"description": "The button element."
|
1328
|
-
},
|
1329
|
-
{
|
1330
|
-
"name": "disabled",
|
1331
|
-
"type": {
|
1332
|
-
"text": "boolean"
|
1333
|
-
},
|
1334
|
-
"description": "The disabled state."
|
1335
|
-
}
|
1336
|
-
],
|
1337
|
-
"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.",
|
1338
|
-
"inheritedFrom": {
|
1339
|
-
"name": "Buttonsimple",
|
1340
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1341
|
-
}
|
1432
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
1433
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
1342
1434
|
},
|
1343
1435
|
{
|
1344
|
-
"
|
1345
|
-
"name": "
|
1346
|
-
|
1347
|
-
|
1348
|
-
|
1349
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
1350
|
-
}
|
1351
|
-
},
|
1436
|
+
"description": "Allows customization of the loading overlay background color.",
|
1437
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
1438
|
+
}
|
1439
|
+
],
|
1440
|
+
"members": [
|
1352
1441
|
{
|
1353
|
-
"kind": "
|
1354
|
-
"name": "
|
1355
|
-
"
|
1356
|
-
|
1442
|
+
"kind": "field",
|
1443
|
+
"name": "src",
|
1444
|
+
"type": {
|
1445
|
+
"text": "string | undefined"
|
1446
|
+
},
|
1447
|
+
"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.",
|
1448
|
+
"attribute": "src",
|
1357
1449
|
"inheritedFrom": {
|
1358
|
-
"name": "
|
1359
|
-
"module": "
|
1450
|
+
"name": "AvatarComponentMixin",
|
1451
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1360
1452
|
}
|
1361
1453
|
},
|
1362
1454
|
{
|
1363
|
-
"kind": "
|
1364
|
-
"name": "
|
1365
|
-
"
|
1366
|
-
|
1367
|
-
|
1368
|
-
|
1369
|
-
|
1370
|
-
"text": "KeyboardEvent"
|
1371
|
-
},
|
1372
|
-
"description": "The keyboard event."
|
1373
|
-
}
|
1374
|
-
],
|
1375
|
-
"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.",
|
1455
|
+
"kind": "field",
|
1456
|
+
"name": "initials",
|
1457
|
+
"type": {
|
1458
|
+
"text": "string | undefined"
|
1459
|
+
},
|
1460
|
+
"description": "The initials to be displayed for the avatar.",
|
1461
|
+
"attribute": "initials",
|
1376
1462
|
"inheritedFrom": {
|
1377
|
-
"name": "
|
1378
|
-
"module": "
|
1463
|
+
"name": "AvatarComponentMixin",
|
1464
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1379
1465
|
}
|
1380
1466
|
},
|
1381
1467
|
{
|
1382
|
-
"kind": "
|
1383
|
-
"name": "
|
1384
|
-
"
|
1385
|
-
|
1386
|
-
|
1387
|
-
|
1388
|
-
|
1389
|
-
"text": "KeyboardEvent"
|
1390
|
-
},
|
1391
|
-
"description": "The keyboard event."
|
1392
|
-
}
|
1393
|
-
],
|
1394
|
-
"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.",
|
1468
|
+
"kind": "field",
|
1469
|
+
"name": "presence",
|
1470
|
+
"type": {
|
1471
|
+
"text": "PresenceType | undefined"
|
1472
|
+
},
|
1473
|
+
"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`",
|
1474
|
+
"attribute": "presence",
|
1395
1475
|
"inheritedFrom": {
|
1396
|
-
"name": "
|
1397
|
-
"module": "
|
1476
|
+
"name": "AvatarComponentMixin",
|
1477
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1398
1478
|
}
|
1399
|
-
}
|
1400
|
-
],
|
1401
|
-
"events": [
|
1479
|
+
},
|
1402
1480
|
{
|
1403
|
-
"
|
1404
|
-
"name": "
|
1405
|
-
"
|
1481
|
+
"kind": "field",
|
1482
|
+
"name": "size",
|
1483
|
+
"type": {
|
1484
|
+
"text": "AvatarSize"
|
1485
|
+
},
|
1486
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1487
|
+
"default": "32",
|
1488
|
+
"attribute": "size",
|
1489
|
+
"reflects": true,
|
1406
1490
|
"inheritedFrom": {
|
1407
|
-
"name": "
|
1408
|
-
"module": "
|
1491
|
+
"name": "AvatarComponentMixin",
|
1492
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1409
1493
|
}
|
1410
1494
|
},
|
1411
1495
|
{
|
1412
|
-
"
|
1413
|
-
"name": "
|
1414
|
-
"
|
1496
|
+
"kind": "field",
|
1497
|
+
"name": "counter",
|
1498
|
+
"type": {
|
1499
|
+
"text": "number | undefined"
|
1500
|
+
},
|
1501
|
+
"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`.",
|
1502
|
+
"attribute": "counter",
|
1415
1503
|
"inheritedFrom": {
|
1416
|
-
"name": "
|
1417
|
-
"module": "
|
1504
|
+
"name": "AvatarComponentMixin",
|
1505
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1418
1506
|
}
|
1419
1507
|
},
|
1420
1508
|
{
|
1421
|
-
"
|
1422
|
-
"name": "
|
1423
|
-
"
|
1509
|
+
"kind": "field",
|
1510
|
+
"name": "isTyping",
|
1511
|
+
"type": {
|
1512
|
+
"text": "boolean"
|
1513
|
+
},
|
1514
|
+
"default": "false",
|
1515
|
+
"description": "Represents the typing indicator when the user is typing.",
|
1516
|
+
"attribute": "is-typing",
|
1424
1517
|
"inheritedFrom": {
|
1425
|
-
"name": "
|
1426
|
-
"module": "
|
1518
|
+
"name": "AvatarComponentMixin",
|
1519
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
1427
1520
|
}
|
1428
1521
|
},
|
1429
1522
|
{
|
1430
|
-
"
|
1431
|
-
"name": "
|
1432
|
-
"
|
1523
|
+
"kind": "field",
|
1524
|
+
"name": "iconName",
|
1525
|
+
"type": {
|
1526
|
+
"text": "IconNames | undefined"
|
1527
|
+
},
|
1528
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
1529
|
+
"attribute": "icon-name",
|
1433
1530
|
"inheritedFrom": {
|
1434
|
-
"name": "
|
1435
|
-
"module": "
|
1531
|
+
"name": "IconNameMixin",
|
1532
|
+
"module": "utils/mixins/IconNameMixin.js"
|
1436
1533
|
}
|
1437
1534
|
}
|
1438
1535
|
],
|
1439
|
-
"
|
1536
|
+
"mixins": [
|
1440
1537
|
{
|
1441
|
-
"name": "
|
1442
|
-
"
|
1443
|
-
"text": "string | null"
|
1444
|
-
},
|
1445
|
-
"default": "null",
|
1446
|
-
"description": "Aria-label attribute to be set for accessibility",
|
1447
|
-
"fieldName": "ariaLabel"
|
1538
|
+
"name": "AvatarComponentMixin",
|
1539
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
1448
1540
|
},
|
1541
|
+
{
|
1542
|
+
"name": "IconNameMixin",
|
1543
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
1544
|
+
}
|
1545
|
+
],
|
1546
|
+
"superclass": {
|
1547
|
+
"name": "Component",
|
1548
|
+
"module": "/src/models"
|
1549
|
+
},
|
1550
|
+
"tagName": "mdc-avatar",
|
1551
|
+
"jsDoc": "/**\n * The `mdc-avatar` component is used to represent a person or a space.\n * An avatar can be an icon, initials, counter and photo.\n *\n * To set the photo of an avatar,\n * you need to set \"src\" attribute.\n *\n * While the avatar image is loading, as a placeholder,\n * we will show the initials text.\n * If the initials are not specified then,\n * we will show `user-regular` icon as a placeholder.\n *\n * By default, if there are no attributes specified,\n * then the default avatar will be an icon with `user-regular` name.\n *\n * The avatar component is non clickable and non interactive/focusable component.\n * If the avatar is typing, then the loading indicator will be displayed.\n * If the counter type avatar is set to a negative number, then we will display 0.\n * The presence indicator will be hidden when the counter property is set.\n *\n * @dependency mdc-icon\n * @dependency mdc-presence\n * @dependency mdc-text\n *\n * @tagname mdc-avatar\n *\n * @cssproperty --mdc-avatar-default-background-color - Allows customization of the default background color.\n * @cssproperty --mdc-avatar-default-foreground-color - Allows customization of the default foreground color.\n * @cssproperty --mdc-avatar-loading-indicator-background-color -\n * Allows customization of the loading indicator background color.\n * @cssproperty --mdc-avatar-loading-indicator-foreground-color -\n * Allows customization of the loading indicator foreground color.\n * @cssproperty --mdc-avatar-loading-overlay-background-color -\n * Allows customization of the loading overlay background color.\n */",
|
1552
|
+
"customElement": true,
|
1553
|
+
"attributes": [
|
1449
1554
|
{
|
1450
1555
|
"name": "src",
|
1451
1556
|
"type": {
|
@@ -1485,14 +1590,14 @@
|
|
1485
1590
|
{
|
1486
1591
|
"name": "size",
|
1487
1592
|
"type": {
|
1488
|
-
"text": "
|
1593
|
+
"text": "AvatarSize"
|
1489
1594
|
},
|
1490
1595
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1491
1596
|
"default": "32",
|
1492
1597
|
"fieldName": "size",
|
1493
1598
|
"inheritedFrom": {
|
1494
|
-
"name": "
|
1495
|
-
"module": "src/
|
1599
|
+
"name": "AvatarComponentMixin",
|
1600
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
1496
1601
|
}
|
1497
1602
|
},
|
1498
1603
|
{
|
@@ -1531,112 +1636,111 @@
|
|
1531
1636
|
"name": "IconNameMixin",
|
1532
1637
|
"module": "src/utils/mixins/IconNameMixin.ts"
|
1533
1638
|
}
|
1534
|
-
}
|
1535
|
-
|
1536
|
-
|
1537
|
-
|
1538
|
-
|
1539
|
-
|
1540
|
-
|
1541
|
-
|
1542
|
-
|
1543
|
-
|
1544
|
-
|
1545
|
-
|
1546
|
-
|
1547
|
-
|
1548
|
-
|
1549
|
-
|
1550
|
-
|
1551
|
-
|
1552
|
-
|
1553
|
-
|
1554
|
-
|
1555
|
-
|
1556
|
-
|
1557
|
-
|
1558
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
1559
|
-
}
|
1560
|
-
},
|
1639
|
+
}
|
1640
|
+
]
|
1641
|
+
}
|
1642
|
+
],
|
1643
|
+
"exports": [
|
1644
|
+
{
|
1645
|
+
"kind": "js",
|
1646
|
+
"name": "default",
|
1647
|
+
"declaration": {
|
1648
|
+
"name": "Avatar",
|
1649
|
+
"module": "components/avatar/avatar.component.js"
|
1650
|
+
}
|
1651
|
+
}
|
1652
|
+
]
|
1653
|
+
},
|
1654
|
+
{
|
1655
|
+
"kind": "javascript-module",
|
1656
|
+
"path": "components/brandvisual/brandvisual.component.js",
|
1657
|
+
"declarations": [
|
1658
|
+
{
|
1659
|
+
"kind": "class",
|
1660
|
+
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
1661
|
+
"name": "Brandvisual",
|
1662
|
+
"members": [
|
1561
1663
|
{
|
1562
|
-
"
|
1664
|
+
"kind": "field",
|
1665
|
+
"name": "brandVisualData",
|
1563
1666
|
"type": {
|
1564
|
-
"text": "
|
1667
|
+
"text": "HTMLElement | undefined"
|
1565
1668
|
},
|
1566
|
-
"
|
1567
|
-
"default": "undefined",
|
1568
|
-
"fieldName": "active",
|
1569
|
-
"inheritedFrom": {
|
1570
|
-
"name": "Buttonsimple",
|
1571
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1572
|
-
}
|
1669
|
+
"privacy": "private"
|
1573
1670
|
},
|
1574
1671
|
{
|
1575
|
-
"
|
1672
|
+
"kind": "field",
|
1673
|
+
"name": "name",
|
1576
1674
|
"type": {
|
1577
|
-
"text": "
|
1675
|
+
"text": "BrandVisualNames | undefined"
|
1578
1676
|
},
|
1579
|
-
"description": "
|
1580
|
-
"
|
1581
|
-
"
|
1582
|
-
"inheritedFrom": {
|
1583
|
-
"name": "Buttonsimple",
|
1584
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1585
|
-
}
|
1677
|
+
"description": "Name of the brandVisual (= filename)",
|
1678
|
+
"attribute": "name",
|
1679
|
+
"reflects": true
|
1586
1680
|
},
|
1587
1681
|
{
|
1588
|
-
"
|
1589
|
-
"
|
1590
|
-
"
|
1591
|
-
"fieldName": "role",
|
1592
|
-
"inheritedFrom": {
|
1593
|
-
"name": "Buttonsimple",
|
1594
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
1595
|
-
}
|
1682
|
+
"kind": "method",
|
1683
|
+
"name": "getBrandVisualData",
|
1684
|
+
"privacy": "private"
|
1596
1685
|
},
|
1597
1686
|
{
|
1598
|
-
"
|
1599
|
-
"
|
1600
|
-
|
1601
|
-
|
1602
|
-
|
1603
|
-
|
1604
|
-
|
1605
|
-
|
1606
|
-
|
1607
|
-
|
1608
|
-
|
1687
|
+
"kind": "method",
|
1688
|
+
"name": "handleBrandVisualLoadedSuccess",
|
1689
|
+
"privacy": "private",
|
1690
|
+
"parameters": [
|
1691
|
+
{
|
1692
|
+
"name": "brandVisualHtml",
|
1693
|
+
"type": {
|
1694
|
+
"text": "HTMLElement"
|
1695
|
+
},
|
1696
|
+
"description": "The brandvisual html element which has been fetched from the brandvisual provider."
|
1697
|
+
}
|
1698
|
+
],
|
1699
|
+
"description": "Sets the brandVisualData state to the fetched brandvisual.\nDispatches a 'load' event on the component once the brandvisual has been successfully loaded."
|
1609
1700
|
},
|
1610
1701
|
{
|
1611
|
-
"
|
1612
|
-
"
|
1613
|
-
|
1614
|
-
|
1615
|
-
|
1616
|
-
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1620
|
-
|
1621
|
-
|
1702
|
+
"kind": "method",
|
1703
|
+
"name": "handleBrandVisualLoadedFailure",
|
1704
|
+
"privacy": "private",
|
1705
|
+
"parameters": [
|
1706
|
+
{
|
1707
|
+
"name": "error",
|
1708
|
+
"type": {
|
1709
|
+
"text": "unknown"
|
1710
|
+
}
|
1711
|
+
}
|
1712
|
+
],
|
1713
|
+
"description": "Dispatches an 'error' event on the component when the brandvisual import has failed.\nThis event bubbles and is cancelable.\nThe error detail is set to the error object."
|
1622
1714
|
}
|
1623
1715
|
],
|
1624
|
-
"
|
1716
|
+
"events": [
|
1625
1717
|
{
|
1626
|
-
"
|
1627
|
-
"
|
1718
|
+
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
1719
|
+
"name": "load",
|
1720
|
+
"reactName": "onLoad"
|
1628
1721
|
},
|
1629
1722
|
{
|
1630
|
-
"
|
1631
|
-
"
|
1723
|
+
"description": "(React: onError) This event is dispatched when the brandvisual fetching has failed.",
|
1724
|
+
"name": "error",
|
1725
|
+
"reactName": "onError"
|
1726
|
+
}
|
1727
|
+
],
|
1728
|
+
"attributes": [
|
1729
|
+
{
|
1730
|
+
"name": "name",
|
1731
|
+
"type": {
|
1732
|
+
"text": "BrandVisualNames | undefined"
|
1733
|
+
},
|
1734
|
+
"description": "Name of the brandVisual (= filename)",
|
1735
|
+
"fieldName": "name"
|
1632
1736
|
}
|
1633
1737
|
],
|
1634
1738
|
"superclass": {
|
1635
|
-
"name": "
|
1636
|
-
"module": "/src/
|
1739
|
+
"name": "Component",
|
1740
|
+
"module": "/src/models"
|
1637
1741
|
},
|
1638
|
-
"tagName": "mdc-
|
1639
|
-
"jsDoc": "/**\n * The `mdc-
|
1742
|
+
"tagName": "mdc-brandvisual",
|
1743
|
+
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
1640
1744
|
"customElement": true
|
1641
1745
|
}
|
1642
1746
|
],
|
@@ -1645,1162 +1749,1058 @@
|
|
1645
1749
|
"kind": "js",
|
1646
1750
|
"name": "default",
|
1647
1751
|
"declaration": {
|
1648
|
-
"name": "
|
1649
|
-
"module": "components/
|
1752
|
+
"name": "Brandvisual",
|
1753
|
+
"module": "components/brandvisual/brandvisual.component.js"
|
1650
1754
|
}
|
1651
1755
|
}
|
1652
1756
|
]
|
1653
1757
|
},
|
1654
1758
|
{
|
1655
1759
|
"kind": "javascript-module",
|
1656
|
-
"path": "components/
|
1760
|
+
"path": "components/bullet/bullet.component.js",
|
1657
1761
|
"declarations": [
|
1658
1762
|
{
|
1659
1763
|
"kind": "class",
|
1660
|
-
"description": "
|
1661
|
-
"name": "
|
1764
|
+
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
1765
|
+
"name": "Bullet",
|
1662
1766
|
"cssProperties": [
|
1663
1767
|
{
|
1664
|
-
"description": "
|
1665
|
-
"name": "--mdc-
|
1666
|
-
},
|
1667
|
-
{
|
1668
|
-
"description": "The background color of the primary badge.",
|
1669
|
-
"name": "--mdc-badge-primary-background-color"
|
1670
|
-
},
|
1671
|
-
{
|
1672
|
-
"description": "The foreground color of the secondary badge.",
|
1673
|
-
"name": "--mdc-badge-secondary-foreground-color"
|
1674
|
-
},
|
1675
|
-
{
|
1676
|
-
"description": "The background color of the secondary badge.",
|
1677
|
-
"name": "--mdc-badge-secondary-background-color"
|
1678
|
-
},
|
1679
|
-
{
|
1680
|
-
"description": "The foreground color of the success badge.",
|
1681
|
-
"name": "--mdc-badge-success-foreground-color"
|
1682
|
-
},
|
1683
|
-
{
|
1684
|
-
"description": "The background color of the success badge.",
|
1685
|
-
"name": "--mdc-badge-success-background-color"
|
1686
|
-
},
|
1687
|
-
{
|
1688
|
-
"description": "The foreground color of the warning badge.",
|
1689
|
-
"name": "--mdc-badge-warning-foreground-color"
|
1690
|
-
},
|
1691
|
-
{
|
1692
|
-
"description": "The background color of the warning badge.",
|
1693
|
-
"name": "--mdc-badge-warning-background-color"
|
1768
|
+
"description": "background color of the bullet",
|
1769
|
+
"name": "--mdc-bullet-background-color"
|
1694
1770
|
},
|
1695
1771
|
{
|
1696
|
-
"description": "
|
1697
|
-
"name": "--mdc-
|
1772
|
+
"description": "small size value of the bullet",
|
1773
|
+
"name": "--mdc-bullet-size-small"
|
1698
1774
|
},
|
1699
1775
|
{
|
1700
|
-
"description": "
|
1701
|
-
"name": "--mdc-
|
1776
|
+
"description": "medium size value of the bullet",
|
1777
|
+
"name": "--mdc-bullet-size-medium"
|
1702
1778
|
},
|
1703
1779
|
{
|
1704
|
-
"description": "
|
1705
|
-
"name": "--mdc-
|
1780
|
+
"description": "large size value of the bullet",
|
1781
|
+
"name": "--mdc-bullet-size-large"
|
1706
1782
|
}
|
1707
1783
|
],
|
1708
1784
|
"members": [
|
1709
1785
|
{
|
1710
1786
|
"kind": "field",
|
1711
|
-
"name": "
|
1712
|
-
"type": {
|
1713
|
-
"text": "BadgeType | undefined"
|
1714
|
-
},
|
1715
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1716
|
-
"attribute": "type",
|
1717
|
-
"reflects": true
|
1718
|
-
},
|
1719
|
-
{
|
1720
|
-
"kind": "field",
|
1721
|
-
"name": "variant",
|
1722
|
-
"type": {
|
1723
|
-
"text": "IconVariant"
|
1724
|
-
},
|
1725
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1726
|
-
"default": "primary",
|
1727
|
-
"attribute": "variant",
|
1728
|
-
"reflects": true
|
1729
|
-
},
|
1730
|
-
{
|
1731
|
-
"kind": "field",
|
1732
|
-
"name": "counter",
|
1733
|
-
"type": {
|
1734
|
-
"text": "number | undefined"
|
1735
|
-
},
|
1736
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1737
|
-
"attribute": "counter"
|
1738
|
-
},
|
1739
|
-
{
|
1740
|
-
"kind": "field",
|
1741
|
-
"name": "maxCounter",
|
1787
|
+
"name": "size",
|
1742
1788
|
"type": {
|
1743
|
-
"text": "
|
1789
|
+
"text": "Size"
|
1744
1790
|
},
|
1745
|
-
"
|
1746
|
-
"
|
1747
|
-
"
|
1791
|
+
"privacy": "public",
|
1792
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1793
|
+
"default": "small",
|
1794
|
+
"attribute": "size",
|
1748
1795
|
"reflects": true
|
1749
|
-
}
|
1796
|
+
}
|
1797
|
+
],
|
1798
|
+
"attributes": [
|
1750
1799
|
{
|
1751
|
-
"
|
1752
|
-
"name": "overlay",
|
1800
|
+
"name": "size",
|
1753
1801
|
"type": {
|
1754
|
-
"text": "
|
1802
|
+
"text": "Size"
|
1755
1803
|
},
|
1756
|
-
"
|
1757
|
-
"
|
1758
|
-
"
|
1804
|
+
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
1805
|
+
"default": "small",
|
1806
|
+
"fieldName": "size"
|
1807
|
+
}
|
1808
|
+
],
|
1809
|
+
"superclass": {
|
1810
|
+
"name": "Component",
|
1811
|
+
"module": "/src/models"
|
1812
|
+
},
|
1813
|
+
"tagName": "mdc-bullet",
|
1814
|
+
"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*/",
|
1815
|
+
"customElement": true
|
1816
|
+
}
|
1817
|
+
],
|
1818
|
+
"exports": [
|
1819
|
+
{
|
1820
|
+
"kind": "js",
|
1821
|
+
"name": "default",
|
1822
|
+
"declaration": {
|
1823
|
+
"name": "Bullet",
|
1824
|
+
"module": "components/bullet/bullet.component.js"
|
1825
|
+
}
|
1826
|
+
}
|
1827
|
+
]
|
1828
|
+
},
|
1829
|
+
{
|
1830
|
+
"kind": "javascript-module",
|
1831
|
+
"path": "components/button/button.component.js",
|
1832
|
+
"declarations": [
|
1833
|
+
{
|
1834
|
+
"kind": "class",
|
1835
|
+
"description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
|
1836
|
+
"name": "Button",
|
1837
|
+
"slots": [
|
1838
|
+
{
|
1839
|
+
"description": "Text label of the button.",
|
1840
|
+
"name": ""
|
1841
|
+
}
|
1842
|
+
],
|
1843
|
+
"members": [
|
1844
|
+
{
|
1845
|
+
"kind": "field",
|
1846
|
+
"name": "size",
|
1847
|
+
"type": {
|
1848
|
+
"text": "ButtonSize"
|
1849
|
+
},
|
1850
|
+
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
1851
|
+
"default": "32",
|
1852
|
+
"attribute": "size",
|
1853
|
+
"reflects": true,
|
1854
|
+
"inheritedFrom": {
|
1855
|
+
"name": "Buttonsimple",
|
1856
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1857
|
+
}
|
1759
1858
|
},
|
1760
1859
|
{
|
1761
1860
|
"kind": "field",
|
1762
|
-
"name": "
|
1861
|
+
"name": "inverted",
|
1763
1862
|
"type": {
|
1764
|
-
"text": "
|
1863
|
+
"text": "boolean"
|
1765
1864
|
},
|
1766
|
-
"
|
1767
|
-
"
|
1768
|
-
"attribute": "
|
1865
|
+
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
1866
|
+
"default": "false",
|
1867
|
+
"attribute": "inverted",
|
1868
|
+
"reflects": true
|
1869
|
+
},
|
1870
|
+
{
|
1871
|
+
"kind": "field",
|
1872
|
+
"name": "role",
|
1873
|
+
"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.",
|
1874
|
+
"default": "'button'",
|
1875
|
+
"attribute": "role",
|
1876
|
+
"reflects": true,
|
1877
|
+
"type": {
|
1878
|
+
"text": "string"
|
1879
|
+
},
|
1880
|
+
"inheritedFrom": {
|
1881
|
+
"name": "Buttonsimple",
|
1882
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1883
|
+
}
|
1769
1884
|
},
|
1770
1885
|
{
|
1771
1886
|
"kind": "method",
|
1772
|
-
"name": "
|
1887
|
+
"name": "inferFilledIconName",
|
1773
1888
|
"privacy": "private",
|
1774
|
-
"return": {
|
1775
|
-
"type": {
|
1776
|
-
"text": ""
|
1777
|
-
}
|
1778
|
-
},
|
1779
1889
|
"parameters": [
|
1780
1890
|
{
|
1781
|
-
"name": "
|
1782
|
-
"type": {
|
1783
|
-
"text": "number"
|
1784
|
-
},
|
1785
|
-
"description": "the maximum limit which can be displayed on the badge"
|
1786
|
-
},
|
1787
|
-
{
|
1788
|
-
"name": "counter",
|
1891
|
+
"name": "active",
|
1789
1892
|
"optional": true,
|
1790
1893
|
"type": {
|
1791
|
-
"text": "
|
1894
|
+
"text": "boolean"
|
1792
1895
|
},
|
1793
|
-
"description": "
|
1896
|
+
"description": "The active state."
|
1794
1897
|
}
|
1795
1898
|
],
|
1796
|
-
"description": "
|
1899
|
+
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
1797
1900
|
},
|
1798
1901
|
{
|
1799
|
-
"kind": "
|
1800
|
-
"name": "
|
1801
|
-
"
|
1802
|
-
|
1803
|
-
|
1804
|
-
|
1805
|
-
|
1902
|
+
"kind": "field",
|
1903
|
+
"name": "prefixIcon",
|
1904
|
+
"type": {
|
1905
|
+
"text": "IconNames | undefined"
|
1906
|
+
},
|
1907
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
1908
|
+
"attribute": "prefix-icon",
|
1909
|
+
"reflects": true,
|
1910
|
+
"inheritedFrom": {
|
1911
|
+
"name": "ButtonComponentMixin",
|
1912
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1913
|
+
}
|
1914
|
+
},
|
1915
|
+
{
|
1916
|
+
"kind": "field",
|
1917
|
+
"name": "postfixIcon",
|
1918
|
+
"type": {
|
1919
|
+
"text": "IconNames | undefined"
|
1920
|
+
},
|
1921
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
1922
|
+
"attribute": "postfix-icon",
|
1923
|
+
"reflects": true,
|
1924
|
+
"inheritedFrom": {
|
1925
|
+
"name": "ButtonComponentMixin",
|
1926
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1927
|
+
}
|
1928
|
+
},
|
1929
|
+
{
|
1930
|
+
"kind": "field",
|
1931
|
+
"name": "variant",
|
1932
|
+
"type": {
|
1933
|
+
"text": "ButtonVariant"
|
1934
|
+
},
|
1935
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
1936
|
+
"default": "primary",
|
1937
|
+
"attribute": "variant",
|
1938
|
+
"inheritedFrom": {
|
1939
|
+
"name": "ButtonComponentMixin",
|
1940
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1941
|
+
}
|
1942
|
+
},
|
1943
|
+
{
|
1944
|
+
"kind": "field",
|
1945
|
+
"name": "color",
|
1946
|
+
"type": {
|
1947
|
+
"text": "ButtonColor"
|
1806
1948
|
},
|
1949
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
1950
|
+
"default": "default",
|
1951
|
+
"attribute": "color",
|
1952
|
+
"inheritedFrom": {
|
1953
|
+
"name": "ButtonComponentMixin",
|
1954
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1955
|
+
}
|
1956
|
+
},
|
1957
|
+
{
|
1958
|
+
"kind": "method",
|
1959
|
+
"name": "setVariant",
|
1960
|
+
"privacy": "protected",
|
1807
1961
|
"parameters": [
|
1808
1962
|
{
|
1809
|
-
"name": "
|
1810
|
-
"type": {
|
1811
|
-
"text": "string"
|
1812
|
-
},
|
1813
|
-
"description": "the name of the icon from the icon set"
|
1814
|
-
},
|
1815
|
-
{
|
1816
|
-
"name": "backgroundClassPostfix",
|
1963
|
+
"name": "variant",
|
1817
1964
|
"type": {
|
1818
|
-
"text": "
|
1965
|
+
"text": "ButtonVariant"
|
1819
1966
|
},
|
1820
|
-
"description": "
|
1967
|
+
"description": "The variant to set."
|
1821
1968
|
}
|
1822
1969
|
],
|
1823
|
-
"description": "
|
1824
|
-
|
1825
|
-
|
1826
|
-
|
1827
|
-
|
1828
|
-
"privacy": "private",
|
1829
|
-
"return": {
|
1830
|
-
"type": {
|
1831
|
-
"text": ""
|
1832
|
-
}
|
1833
|
-
},
|
1834
|
-
"description": "Method to generate the badge dot template."
|
1970
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
|
1971
|
+
"inheritedFrom": {
|
1972
|
+
"name": "ButtonComponentMixin",
|
1973
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1974
|
+
}
|
1835
1975
|
},
|
1836
1976
|
{
|
1837
1977
|
"kind": "method",
|
1838
|
-
"name": "
|
1839
|
-
"privacy": "
|
1840
|
-
"
|
1841
|
-
|
1842
|
-
"
|
1978
|
+
"name": "setColor",
|
1979
|
+
"privacy": "protected",
|
1980
|
+
"parameters": [
|
1981
|
+
{
|
1982
|
+
"name": "color",
|
1983
|
+
"type": {
|
1984
|
+
"text": "ButtonColor"
|
1985
|
+
},
|
1986
|
+
"description": "The color to set."
|
1843
1987
|
}
|
1844
|
-
|
1845
|
-
"description": "
|
1988
|
+
],
|
1989
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
1990
|
+
"inheritedFrom": {
|
1991
|
+
"name": "ButtonComponentMixin",
|
1992
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
1993
|
+
}
|
1846
1994
|
},
|
1847
1995
|
{
|
1848
1996
|
"kind": "method",
|
1849
|
-
"name": "
|
1850
|
-
"privacy": "
|
1851
|
-
"
|
1852
|
-
|
1853
|
-
"
|
1997
|
+
"name": "setSize",
|
1998
|
+
"privacy": "protected",
|
1999
|
+
"parameters": [
|
2000
|
+
{
|
2001
|
+
"name": "size",
|
2002
|
+
"type": {
|
2003
|
+
"text": "PillButtonSize | IconButtonSize"
|
2004
|
+
},
|
2005
|
+
"description": "The size to set."
|
1854
2006
|
}
|
1855
|
-
|
1856
|
-
"description": "
|
2007
|
+
],
|
2008
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
|
2009
|
+
"inheritedFrom": {
|
2010
|
+
"name": "ButtonComponentMixin",
|
2011
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2012
|
+
}
|
1857
2013
|
},
|
1858
2014
|
{
|
1859
2015
|
"kind": "method",
|
1860
|
-
"name": "
|
1861
|
-
"privacy": "
|
1862
|
-
"
|
1863
|
-
|
1864
|
-
|
2016
|
+
"name": "inferButtonType",
|
2017
|
+
"privacy": "protected",
|
2018
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2019
|
+
"parameters": [
|
2020
|
+
{
|
2021
|
+
"description": "default slot of button",
|
2022
|
+
"name": "slot"
|
1865
2023
|
}
|
1866
|
-
|
1867
|
-
"
|
2024
|
+
],
|
2025
|
+
"inheritedFrom": {
|
2026
|
+
"name": "ButtonComponentMixin",
|
2027
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
2028
|
+
}
|
1868
2029
|
},
|
1869
2030
|
{
|
1870
2031
|
"kind": "field",
|
1871
|
-
"name": "
|
2032
|
+
"name": "tabIndex",
|
1872
2033
|
"type": {
|
1873
|
-
"text": "
|
2034
|
+
"text": "number"
|
1874
2035
|
},
|
1875
|
-
"
|
1876
|
-
"
|
2036
|
+
"default": "0",
|
2037
|
+
"description": "This property specifies the tab order of the element.",
|
2038
|
+
"attribute": "tabIndex",
|
2039
|
+
"reflects": true,
|
1877
2040
|
"inheritedFrom": {
|
1878
|
-
"name": "
|
1879
|
-
"module": "utils/mixins/
|
2041
|
+
"name": "TabIndexMixin",
|
2042
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1880
2043
|
}
|
1881
|
-
}
|
1882
|
-
],
|
1883
|
-
"attributes": [
|
1884
|
-
{
|
1885
|
-
"name": "type",
|
1886
|
-
"type": {
|
1887
|
-
"text": "BadgeType | undefined"
|
1888
|
-
},
|
1889
|
-
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
1890
|
-
"fieldName": "type"
|
1891
|
-
},
|
1892
|
-
{
|
1893
|
-
"name": "variant",
|
1894
|
-
"type": {
|
1895
|
-
"text": "IconVariant"
|
1896
|
-
},
|
1897
|
-
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
1898
|
-
"default": "primary",
|
1899
|
-
"fieldName": "variant"
|
1900
|
-
},
|
1901
|
-
{
|
1902
|
-
"name": "counter",
|
1903
|
-
"type": {
|
1904
|
-
"text": "number | undefined"
|
1905
|
-
},
|
1906
|
-
"description": "Counter is the number which can be provided in the badge.",
|
1907
|
-
"fieldName": "counter"
|
1908
2044
|
},
|
1909
2045
|
{
|
1910
|
-
"
|
2046
|
+
"kind": "field",
|
2047
|
+
"name": "disabled",
|
1911
2048
|
"type": {
|
1912
|
-
"text": "
|
2049
|
+
"text": "boolean | undefined"
|
1913
2050
|
},
|
1914
|
-
"description": "
|
1915
|
-
"default": "
|
1916
|
-
"
|
2051
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2052
|
+
"default": "undefined",
|
2053
|
+
"attribute": "disabled",
|
2054
|
+
"reflects": true,
|
2055
|
+
"inheritedFrom": {
|
2056
|
+
"name": "DisabledMixin",
|
2057
|
+
"module": "utils/mixins/DisabledMixin.js"
|
2058
|
+
}
|
1917
2059
|
},
|
1918
2060
|
{
|
1919
|
-
"
|
2061
|
+
"kind": "field",
|
2062
|
+
"name": "active",
|
1920
2063
|
"type": {
|
1921
|
-
"text": "boolean"
|
2064
|
+
"text": "boolean | undefined"
|
1922
2065
|
},
|
1923
|
-
"
|
1924
|
-
"
|
1925
|
-
"
|
2066
|
+
"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.",
|
2067
|
+
"default": "undefined",
|
2068
|
+
"attribute": "active",
|
2069
|
+
"reflects": true,
|
2070
|
+
"inheritedFrom": {
|
2071
|
+
"name": "Buttonsimple",
|
2072
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2073
|
+
}
|
1926
2074
|
},
|
1927
2075
|
{
|
1928
|
-
"
|
2076
|
+
"kind": "field",
|
2077
|
+
"name": "softDisabled",
|
1929
2078
|
"type": {
|
1930
|
-
"text": "
|
2079
|
+
"text": "boolean | undefined"
|
1931
2080
|
},
|
1932
|
-
"
|
1933
|
-
"
|
1934
|
-
"
|
2081
|
+
"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.",
|
2082
|
+
"default": "undefined",
|
2083
|
+
"attribute": "soft-disabled",
|
2084
|
+
"reflects": true,
|
2085
|
+
"inheritedFrom": {
|
2086
|
+
"name": "Buttonsimple",
|
2087
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2088
|
+
}
|
1935
2089
|
},
|
1936
2090
|
{
|
1937
|
-
"
|
2091
|
+
"kind": "field",
|
2092
|
+
"name": "ariaStateKey",
|
1938
2093
|
"type": {
|
1939
|
-
"text": "
|
2094
|
+
"text": "string | undefined"
|
1940
2095
|
},
|
1941
|
-
"description": "
|
1942
|
-
"
|
2096
|
+
"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`",
|
2097
|
+
"default": "'aria-pressed' (when)",
|
2098
|
+
"attribute": "ariaStateKey",
|
2099
|
+
"reflects": true,
|
1943
2100
|
"inheritedFrom": {
|
1944
|
-
"name": "
|
1945
|
-
"module": "
|
2101
|
+
"name": "Buttonsimple",
|
2102
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
1946
2103
|
}
|
1947
|
-
}
|
1948
|
-
],
|
1949
|
-
"mixins": [
|
1950
|
-
{
|
1951
|
-
"name": "IconNameMixin",
|
1952
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
1953
|
-
}
|
1954
|
-
],
|
1955
|
-
"superclass": {
|
1956
|
-
"name": "Component",
|
1957
|
-
"module": "/src/models"
|
1958
|
-
},
|
1959
|
-
"tagName": "mdc-badge",
|
1960
|
-
"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 */",
|
1961
|
-
"customElement": true
|
1962
|
-
}
|
1963
|
-
],
|
1964
|
-
"exports": [
|
1965
|
-
{
|
1966
|
-
"kind": "js",
|
1967
|
-
"name": "default",
|
1968
|
-
"declaration": {
|
1969
|
-
"name": "Badge",
|
1970
|
-
"module": "components/badge/badge.component.js"
|
1971
|
-
}
|
1972
|
-
}
|
1973
|
-
]
|
1974
|
-
},
|
1975
|
-
{
|
1976
|
-
"kind": "javascript-module",
|
1977
|
-
"path": "components/brandvisual/brandvisual.component.js",
|
1978
|
-
"declarations": [
|
1979
|
-
{
|
1980
|
-
"kind": "class",
|
1981
|
-
"description": "The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\ndisplayed correctly within applications.\n\nFeatures:\n- Dynamically loads brandvisuals based on the `name` attribute.\n- Emits a `load` event when the brandvisual is successfully fetched.\n- Emits an `error` event when the brandvisual import fails.\n- Supports accessibility best practices.\n- Used for brand representation within the design system.",
|
1982
|
-
"name": "Brandvisual",
|
1983
|
-
"members": [
|
2104
|
+
},
|
1984
2105
|
{
|
1985
2106
|
"kind": "field",
|
1986
|
-
"name": "
|
2107
|
+
"name": "type",
|
1987
2108
|
"type": {
|
1988
|
-
"text": "
|
2109
|
+
"text": "ButtonType"
|
1989
2110
|
},
|
1990
|
-
"
|
2111
|
+
"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.",
|
2112
|
+
"default": "button",
|
2113
|
+
"attribute": "type",
|
2114
|
+
"reflects": true,
|
2115
|
+
"inheritedFrom": {
|
2116
|
+
"name": "Buttonsimple",
|
2117
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2118
|
+
}
|
1991
2119
|
},
|
1992
2120
|
{
|
1993
|
-
"kind": "
|
1994
|
-
"name": "
|
1995
|
-
"
|
1996
|
-
|
1997
|
-
|
1998
|
-
|
1999
|
-
|
2000
|
-
"reflects": true
|
2121
|
+
"kind": "method",
|
2122
|
+
"name": "executeAction",
|
2123
|
+
"privacy": "protected",
|
2124
|
+
"inheritedFrom": {
|
2125
|
+
"name": "Buttonsimple",
|
2126
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2127
|
+
}
|
2001
2128
|
},
|
2002
2129
|
{
|
2003
2130
|
"kind": "method",
|
2004
|
-
"name": "
|
2005
|
-
"privacy": "
|
2131
|
+
"name": "setActive",
|
2132
|
+
"privacy": "protected",
|
2133
|
+
"parameters": [
|
2134
|
+
{
|
2135
|
+
"name": "element",
|
2136
|
+
"type": {
|
2137
|
+
"text": "HTMLElement"
|
2138
|
+
},
|
2139
|
+
"description": "The button element"
|
2140
|
+
},
|
2141
|
+
{
|
2142
|
+
"name": "active",
|
2143
|
+
"optional": true,
|
2144
|
+
"type": {
|
2145
|
+
"text": "boolean"
|
2146
|
+
},
|
2147
|
+
"description": "The active state of the element"
|
2148
|
+
}
|
2149
|
+
],
|
2150
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2151
|
+
"inheritedFrom": {
|
2152
|
+
"name": "Buttonsimple",
|
2153
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2154
|
+
}
|
2006
2155
|
},
|
2007
2156
|
{
|
2008
2157
|
"kind": "method",
|
2009
|
-
"name": "
|
2158
|
+
"name": "setSoftDisabled",
|
2010
2159
|
"privacy": "private",
|
2011
2160
|
"parameters": [
|
2012
2161
|
{
|
2013
|
-
"name": "
|
2162
|
+
"name": "element",
|
2014
2163
|
"type": {
|
2015
2164
|
"text": "HTMLElement"
|
2016
2165
|
},
|
2017
|
-
"description": "The
|
2166
|
+
"description": "The button element."
|
2167
|
+
},
|
2168
|
+
{
|
2169
|
+
"name": "softDisabled",
|
2170
|
+
"optional": true,
|
2171
|
+
"type": {
|
2172
|
+
"text": "boolean"
|
2173
|
+
},
|
2174
|
+
"description": "The soft-disabled state."
|
2018
2175
|
}
|
2019
2176
|
],
|
2020
|
-
"description": "Sets the
|
2177
|
+
"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.",
|
2178
|
+
"inheritedFrom": {
|
2179
|
+
"name": "Buttonsimple",
|
2180
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2181
|
+
}
|
2021
2182
|
},
|
2022
2183
|
{
|
2023
2184
|
"kind": "method",
|
2024
|
-
"name": "
|
2185
|
+
"name": "setDisabled",
|
2025
2186
|
"privacy": "private",
|
2026
2187
|
"parameters": [
|
2027
2188
|
{
|
2028
|
-
"name": "
|
2189
|
+
"name": "element",
|
2029
2190
|
"type": {
|
2030
|
-
"text": "
|
2031
|
-
}
|
2191
|
+
"text": "HTMLElement"
|
2192
|
+
},
|
2193
|
+
"description": "The button element."
|
2194
|
+
},
|
2195
|
+
{
|
2196
|
+
"name": "disabled",
|
2197
|
+
"type": {
|
2198
|
+
"text": "boolean"
|
2199
|
+
},
|
2200
|
+
"description": "The disabled state."
|
2032
2201
|
}
|
2033
2202
|
],
|
2034
|
-
"description": "
|
2035
|
-
|
2036
|
-
|
2037
|
-
|
2038
|
-
|
2039
|
-
"description": "(React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.",
|
2040
|
-
"name": "load",
|
2041
|
-
"reactName": "onLoad"
|
2203
|
+
"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.",
|
2204
|
+
"inheritedFrom": {
|
2205
|
+
"name": "Buttonsimple",
|
2206
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2207
|
+
}
|
2042
2208
|
},
|
2043
2209
|
{
|
2044
|
-
"
|
2045
|
-
"name": "
|
2046
|
-
"
|
2047
|
-
|
2048
|
-
|
2049
|
-
|
2050
|
-
|
2051
|
-
"name": "name",
|
2052
|
-
"type": {
|
2053
|
-
"text": "BrandVisualNames | undefined"
|
2054
|
-
},
|
2055
|
-
"description": "Name of the brandVisual (= filename)",
|
2056
|
-
"fieldName": "name"
|
2057
|
-
}
|
2058
|
-
],
|
2059
|
-
"superclass": {
|
2060
|
-
"name": "Component",
|
2061
|
-
"module": "/src/models"
|
2062
|
-
},
|
2063
|
-
"tagName": "mdc-brandvisual",
|
2064
|
-
"jsDoc": "/**\n * The `mdc-brandvisual` component is responsible for rendering logos dynamically & ensures they are\n * displayed correctly within applications.\n *\n * Features:\n * - Dynamically loads brandvisuals based on the `name` attribute.\n * - Emits a `load` event when the brandvisual is successfully fetched.\n * - Emits an `error` event when the brandvisual import fails.\n * - Supports accessibility best practices.\n * - Used for brand representation within the design system.\n *\n * @tagname mdc-brandvisual\n *\n * @event load - (React: onLoad) This event is dispatched when the brandvisual has been successfully loaded.\n * @event error - (React: onError) This event is dispatched when the brandvisual fetching has failed.\n *\n */",
|
2065
|
-
"customElement": true
|
2066
|
-
}
|
2067
|
-
],
|
2068
|
-
"exports": [
|
2069
|
-
{
|
2070
|
-
"kind": "js",
|
2071
|
-
"name": "default",
|
2072
|
-
"declaration": {
|
2073
|
-
"name": "Brandvisual",
|
2074
|
-
"module": "components/brandvisual/brandvisual.component.js"
|
2075
|
-
}
|
2076
|
-
}
|
2077
|
-
]
|
2078
|
-
},
|
2079
|
-
{
|
2080
|
-
"kind": "javascript-module",
|
2081
|
-
"path": "components/bullet/bullet.component.js",
|
2082
|
-
"declarations": [
|
2083
|
-
{
|
2084
|
-
"kind": "class",
|
2085
|
-
"description": "Bullet component, which is a visual marker\nand be used to organize and present items in a list format.",
|
2086
|
-
"name": "Bullet",
|
2087
|
-
"cssProperties": [
|
2088
|
-
{
|
2089
|
-
"description": "background color of the bullet",
|
2090
|
-
"name": "--mdc-bullet-background-color"
|
2210
|
+
"kind": "method",
|
2211
|
+
"name": "triggerClickEvent",
|
2212
|
+
"privacy": "private",
|
2213
|
+
"inheritedFrom": {
|
2214
|
+
"name": "Buttonsimple",
|
2215
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2216
|
+
}
|
2091
2217
|
},
|
2092
2218
|
{
|
2093
|
-
"
|
2094
|
-
"name": "
|
2219
|
+
"kind": "method",
|
2220
|
+
"name": "handleBlur",
|
2221
|
+
"privacy": "private",
|
2222
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
2223
|
+
"inheritedFrom": {
|
2224
|
+
"name": "Buttonsimple",
|
2225
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2226
|
+
}
|
2095
2227
|
},
|
2096
2228
|
{
|
2097
|
-
"
|
2098
|
-
"name": "
|
2229
|
+
"kind": "method",
|
2230
|
+
"name": "handleKeyDown",
|
2231
|
+
"privacy": "private",
|
2232
|
+
"parameters": [
|
2233
|
+
{
|
2234
|
+
"name": "event",
|
2235
|
+
"type": {
|
2236
|
+
"text": "KeyboardEvent"
|
2237
|
+
},
|
2238
|
+
"description": "The keyboard event."
|
2239
|
+
}
|
2240
|
+
],
|
2241
|
+
"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.",
|
2242
|
+
"inheritedFrom": {
|
2243
|
+
"name": "Buttonsimple",
|
2244
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2245
|
+
}
|
2099
2246
|
},
|
2100
2247
|
{
|
2101
|
-
"
|
2102
|
-
"name": "
|
2103
|
-
|
2104
|
-
|
2105
|
-
|
2106
|
-
|
2107
|
-
|
2108
|
-
|
2109
|
-
|
2110
|
-
|
2111
|
-
|
2112
|
-
|
2113
|
-
"description": "
|
2114
|
-
"
|
2115
|
-
|
2116
|
-
|
2248
|
+
"kind": "method",
|
2249
|
+
"name": "handleKeyUp",
|
2250
|
+
"privacy": "private",
|
2251
|
+
"parameters": [
|
2252
|
+
{
|
2253
|
+
"name": "event",
|
2254
|
+
"type": {
|
2255
|
+
"text": "KeyboardEvent"
|
2256
|
+
},
|
2257
|
+
"description": "The keyboard event."
|
2258
|
+
}
|
2259
|
+
],
|
2260
|
+
"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.",
|
2261
|
+
"inheritedFrom": {
|
2262
|
+
"name": "Buttonsimple",
|
2263
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
2264
|
+
}
|
2117
2265
|
}
|
2118
2266
|
],
|
2119
2267
|
"attributes": [
|
2120
2268
|
{
|
2121
|
-
"name": "size",
|
2122
|
-
"type": {
|
2123
|
-
"text": "Size"
|
2124
|
-
},
|
2125
|
-
"description": "Size of the bullet\n\nPossible values: 'small', 'medium', 'large'",
|
2126
|
-
"default": "small",
|
2127
|
-
"fieldName": "size"
|
2128
|
-
}
|
2129
|
-
],
|
2130
|
-
"superclass": {
|
2131
|
-
"name": "Component",
|
2132
|
-
"module": "/src/models"
|
2133
|
-
},
|
2134
|
-
"tagName": "mdc-bullet",
|
2135
|
-
"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*/",
|
2136
|
-
"customElement": true
|
2137
|
-
}
|
2138
|
-
],
|
2139
|
-
"exports": [
|
2140
|
-
{
|
2141
|
-
"kind": "js",
|
2142
|
-
"name": "default",
|
2143
|
-
"declaration": {
|
2144
|
-
"name": "Bullet",
|
2145
|
-
"module": "components/bullet/bullet.component.js"
|
2146
|
-
}
|
2147
|
-
}
|
2148
|
-
]
|
2149
|
-
},
|
2150
|
-
{
|
2151
|
-
"kind": "javascript-module",
|
2152
|
-
"path": "components/button/button.component.js",
|
2153
|
-
"declarations": [
|
2154
|
-
{
|
2155
|
-
"kind": "class",
|
2156
|
-
"description": "`mdc-button` is a component that can be configured in various ways to suit different use cases.\n\nButton Variants:\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n\nButton Colors:\n- **Positive**: Green color.\n- **Negative**: Red color.\n- **Accent**: Blue color.\n- **Promotional**: Purple color.\n- **Default**: White color.\n\nButton Sizes (in REM units):\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- **Tertiary icon button**: 20.\n\nButton Types:\n- **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n- **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n- **Icon button**: A button represented by just an icon without any text.\nThe type of button is inferred based on the presence of slot and/or prefix and postfix icons.",
|
2157
|
-
"name": "Button",
|
2158
|
-
"slots": [
|
2159
|
-
{
|
2160
|
-
"description": "Text label of the button.",
|
2161
|
-
"name": ""
|
2162
|
-
}
|
2163
|
-
],
|
2164
|
-
"members": [
|
2165
|
-
{
|
2166
|
-
"kind": "field",
|
2167
2269
|
"name": "size",
|
2168
2270
|
"type": {
|
2169
2271
|
"text": "ButtonSize"
|
2170
2272
|
},
|
2171
2273
|
"description": "Button sizing is based on the button type.\n- **Pill button**: 40, 32, 28, 24.\n- **Icon button**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon button can also be 20.",
|
2172
2274
|
"default": "32",
|
2173
|
-
"
|
2174
|
-
"reflects": true,
|
2275
|
+
"fieldName": "size",
|
2175
2276
|
"inheritedFrom": {
|
2176
2277
|
"name": "Buttonsimple",
|
2177
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2278
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2178
2279
|
}
|
2179
2280
|
},
|
2180
2281
|
{
|
2181
|
-
"kind": "field",
|
2182
2282
|
"name": "inverted",
|
2183
2283
|
"type": {
|
2184
2284
|
"text": "boolean"
|
2185
2285
|
},
|
2186
2286
|
"description": "The button color can be inverted by setting the inverted attribute to true.\n\nOnly applies when variant is set to `primary`, color is set to `default`\nand button is not `active`.",
|
2187
2287
|
"default": "false",
|
2188
|
-
"
|
2189
|
-
"reflects": true
|
2288
|
+
"fieldName": "inverted"
|
2190
2289
|
},
|
2191
2290
|
{
|
2192
|
-
"kind": "field",
|
2193
2291
|
"name": "role",
|
2194
2292
|
"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.",
|
2195
2293
|
"default": "'button'",
|
2196
|
-
"
|
2197
|
-
"reflects": true,
|
2294
|
+
"fieldName": "role",
|
2198
2295
|
"type": {
|
2199
2296
|
"text": "string"
|
2200
2297
|
},
|
2201
2298
|
"inheritedFrom": {
|
2202
2299
|
"name": "Buttonsimple",
|
2203
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
2300
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2204
2301
|
}
|
2205
2302
|
},
|
2206
2303
|
{
|
2207
|
-
"
|
2208
|
-
"name": "inferFilledIconName",
|
2209
|
-
"privacy": "private",
|
2210
|
-
"parameters": [
|
2211
|
-
{
|
2212
|
-
"name": "active",
|
2213
|
-
"optional": true,
|
2214
|
-
"type": {
|
2215
|
-
"text": "boolean"
|
2216
|
-
},
|
2217
|
-
"description": "The active state."
|
2218
|
-
}
|
2219
|
-
],
|
2220
|
-
"description": "Modifies the icon name based on the active state.\nIf the button is active, the icon name is suffixed with '-filled'.\nIf the button is inactive, the icon name is restored to its original value.\nIf '-filled' icon is not available, the icon name remains unchanged."
|
2221
|
-
},
|
2222
|
-
{
|
2223
|
-
"kind": "field",
|
2224
|
-
"name": "prefixIcon",
|
2304
|
+
"name": "prefix-icon",
|
2225
2305
|
"type": {
|
2226
2306
|
"text": "IconNames | undefined"
|
2227
2307
|
},
|
2228
2308
|
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
2229
|
-
"
|
2230
|
-
"reflects": true,
|
2309
|
+
"fieldName": "prefixIcon",
|
2231
2310
|
"inheritedFrom": {
|
2232
2311
|
"name": "ButtonComponentMixin",
|
2233
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2312
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2234
2313
|
}
|
2235
2314
|
},
|
2236
2315
|
{
|
2237
|
-
"
|
2238
|
-
"name": "postfixIcon",
|
2316
|
+
"name": "postfix-icon",
|
2239
2317
|
"type": {
|
2240
2318
|
"text": "IconNames | undefined"
|
2241
2319
|
},
|
2242
2320
|
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
2243
|
-
"
|
2244
|
-
"reflects": true,
|
2321
|
+
"fieldName": "postfixIcon",
|
2245
2322
|
"inheritedFrom": {
|
2246
2323
|
"name": "ButtonComponentMixin",
|
2247
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2324
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2248
2325
|
}
|
2249
2326
|
},
|
2250
2327
|
{
|
2251
|
-
"kind": "field",
|
2252
2328
|
"name": "variant",
|
2253
2329
|
"type": {
|
2254
2330
|
"text": "ButtonVariant"
|
2255
2331
|
},
|
2256
2332
|
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
2257
2333
|
"default": "primary",
|
2258
|
-
"
|
2334
|
+
"fieldName": "variant",
|
2259
2335
|
"inheritedFrom": {
|
2260
2336
|
"name": "ButtonComponentMixin",
|
2261
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2337
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2262
2338
|
}
|
2263
2339
|
},
|
2264
2340
|
{
|
2265
|
-
"kind": "field",
|
2266
2341
|
"name": "color",
|
2267
2342
|
"type": {
|
2268
2343
|
"text": "ButtonColor"
|
2269
2344
|
},
|
2270
2345
|
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
2271
2346
|
"default": "default",
|
2272
|
-
"
|
2347
|
+
"fieldName": "color",
|
2273
2348
|
"inheritedFrom": {
|
2274
2349
|
"name": "ButtonComponentMixin",
|
2275
|
-
"module": "utils/mixins/ButtonComponentMixin.
|
2350
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2276
2351
|
}
|
2277
2352
|
},
|
2278
2353
|
{
|
2279
|
-
"
|
2280
|
-
"
|
2281
|
-
|
2282
|
-
|
2283
|
-
|
2284
|
-
|
2285
|
-
|
2286
|
-
"text": "ButtonVariant"
|
2287
|
-
},
|
2288
|
-
"description": "The variant to set."
|
2289
|
-
}
|
2290
|
-
],
|
2291
|
-
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
|
2354
|
+
"name": "tabIndex",
|
2355
|
+
"type": {
|
2356
|
+
"text": "number"
|
2357
|
+
},
|
2358
|
+
"default": "0",
|
2359
|
+
"description": "This property specifies the tab order of the element.",
|
2360
|
+
"fieldName": "tabIndex",
|
2292
2361
|
"inheritedFrom": {
|
2293
|
-
"name": "
|
2294
|
-
"module": "utils/mixins/
|
2362
|
+
"name": "TabIndexMixin",
|
2363
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2295
2364
|
}
|
2296
2365
|
},
|
2297
2366
|
{
|
2298
|
-
"
|
2299
|
-
"
|
2300
|
-
|
2301
|
-
|
2302
|
-
|
2303
|
-
|
2304
|
-
|
2305
|
-
"text": "ButtonColor"
|
2306
|
-
},
|
2307
|
-
"description": "The color to set."
|
2308
|
-
}
|
2309
|
-
],
|
2310
|
-
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
2367
|
+
"name": "disabled",
|
2368
|
+
"type": {
|
2369
|
+
"text": "boolean | undefined"
|
2370
|
+
},
|
2371
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2372
|
+
"default": "undefined",
|
2373
|
+
"fieldName": "disabled",
|
2311
2374
|
"inheritedFrom": {
|
2312
|
-
"name": "
|
2313
|
-
"module": "utils/mixins/
|
2375
|
+
"name": "DisabledMixin",
|
2376
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
2377
|
+
}
|
2378
|
+
},
|
2379
|
+
{
|
2380
|
+
"name": "active",
|
2381
|
+
"type": {
|
2382
|
+
"text": "boolean | undefined"
|
2383
|
+
},
|
2384
|
+
"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.",
|
2385
|
+
"default": "undefined",
|
2386
|
+
"fieldName": "active",
|
2387
|
+
"inheritedFrom": {
|
2388
|
+
"name": "Buttonsimple",
|
2389
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2390
|
+
}
|
2391
|
+
},
|
2392
|
+
{
|
2393
|
+
"name": "soft-disabled",
|
2394
|
+
"type": {
|
2395
|
+
"text": "boolean | undefined"
|
2396
|
+
},
|
2397
|
+
"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.",
|
2398
|
+
"default": "undefined",
|
2399
|
+
"fieldName": "softDisabled",
|
2400
|
+
"inheritedFrom": {
|
2401
|
+
"name": "Buttonsimple",
|
2402
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2403
|
+
}
|
2404
|
+
},
|
2405
|
+
{
|
2406
|
+
"name": "ariaStateKey",
|
2407
|
+
"type": {
|
2408
|
+
"text": "string | undefined"
|
2409
|
+
},
|
2410
|
+
"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`",
|
2411
|
+
"default": "'aria-pressed' (when)",
|
2412
|
+
"fieldName": "ariaStateKey",
|
2413
|
+
"inheritedFrom": {
|
2414
|
+
"name": "Buttonsimple",
|
2415
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2416
|
+
}
|
2417
|
+
},
|
2418
|
+
{
|
2419
|
+
"name": "type",
|
2420
|
+
"type": {
|
2421
|
+
"text": "ButtonType"
|
2422
|
+
},
|
2423
|
+
"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.",
|
2424
|
+
"default": "button",
|
2425
|
+
"fieldName": "type",
|
2426
|
+
"inheritedFrom": {
|
2427
|
+
"name": "Buttonsimple",
|
2428
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2429
|
+
}
|
2430
|
+
}
|
2431
|
+
],
|
2432
|
+
"mixins": [
|
2433
|
+
{
|
2434
|
+
"name": "ButtonComponentMixin",
|
2435
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
2436
|
+
}
|
2437
|
+
],
|
2438
|
+
"superclass": {
|
2439
|
+
"name": "Buttonsimple",
|
2440
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2441
|
+
},
|
2442
|
+
"tagName": "mdc-button",
|
2443
|
+
"jsDoc": "/**\n * `mdc-button` is a component that can be configured in various ways to suit different use cases.\n *\n * Button Variants:\n * - **Primary**: Solid background color.\n * - **Secondary**: Transparent background with a solid border.\n * - **Tertiary**: No background or border, appears as plain text but retains all button functionalities.\n *\n * Button Colors:\n * - **Positive**: Green color.\n * - **Negative**: Red color.\n * - **Accent**: Blue color.\n * - **Promotional**: Purple color.\n * - **Default**: White color.\n *\n * Button Sizes (in REM units):\n * - **Pill button**: 40, 32, 28, 24.\n * - **Icon button**: 64, 52, 40, 32, 28, 24.\n * - **Tertiary icon button**: 20.\n *\n * Button Types:\n * - **Pill button**: A button that contains text value. Commonly used for call to action, tags, or filters.\n * - **Pill button with icons**: A button containing an icon either on the left or right side of the button.\n * - **Icon button**: A button represented by just an icon without any text.\n * The type of button is inferred based on the presence of slot and/or prefix and postfix icons.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-button\n *\n * @slot - Text label of the button.\n */",
|
2444
|
+
"customElement": true,
|
2445
|
+
"events": [
|
2446
|
+
{
|
2447
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2448
|
+
"name": "click",
|
2449
|
+
"reactName": "onClick",
|
2450
|
+
"inheritedFrom": {
|
2451
|
+
"name": "Buttonsimple",
|
2452
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2453
|
+
}
|
2454
|
+
},
|
2455
|
+
{
|
2456
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2457
|
+
"name": "keydown",
|
2458
|
+
"reactName": "onKeyDown",
|
2459
|
+
"inheritedFrom": {
|
2460
|
+
"name": "Buttonsimple",
|
2461
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2462
|
+
}
|
2463
|
+
},
|
2464
|
+
{
|
2465
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2466
|
+
"name": "keyup",
|
2467
|
+
"reactName": "onKeyUp",
|
2468
|
+
"inheritedFrom": {
|
2469
|
+
"name": "Buttonsimple",
|
2470
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2471
|
+
}
|
2472
|
+
},
|
2473
|
+
{
|
2474
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2475
|
+
"name": "focus",
|
2476
|
+
"reactName": "onFocus",
|
2477
|
+
"inheritedFrom": {
|
2478
|
+
"name": "Buttonsimple",
|
2479
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2314
2480
|
}
|
2481
|
+
}
|
2482
|
+
]
|
2483
|
+
}
|
2484
|
+
],
|
2485
|
+
"exports": [
|
2486
|
+
{
|
2487
|
+
"kind": "js",
|
2488
|
+
"name": "default",
|
2489
|
+
"declaration": {
|
2490
|
+
"name": "Button",
|
2491
|
+
"module": "components/button/button.component.js"
|
2492
|
+
}
|
2493
|
+
}
|
2494
|
+
]
|
2495
|
+
},
|
2496
|
+
{
|
2497
|
+
"kind": "javascript-module",
|
2498
|
+
"path": "components/badge/badge.component.js",
|
2499
|
+
"declarations": [
|
2500
|
+
{
|
2501
|
+
"kind": "class",
|
2502
|
+
"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.",
|
2503
|
+
"name": "Badge",
|
2504
|
+
"cssProperties": [
|
2505
|
+
{
|
2506
|
+
"description": "The foreground color of the primary badge.",
|
2507
|
+
"name": "--mdc-badge-primary-foreground-color"
|
2508
|
+
},
|
2509
|
+
{
|
2510
|
+
"description": "The background color of the primary badge.",
|
2511
|
+
"name": "--mdc-badge-primary-background-color"
|
2512
|
+
},
|
2513
|
+
{
|
2514
|
+
"description": "The foreground color of the secondary badge.",
|
2515
|
+
"name": "--mdc-badge-secondary-foreground-color"
|
2516
|
+
},
|
2517
|
+
{
|
2518
|
+
"description": "The background color of the secondary badge.",
|
2519
|
+
"name": "--mdc-badge-secondary-background-color"
|
2520
|
+
},
|
2521
|
+
{
|
2522
|
+
"description": "The foreground color of the success badge.",
|
2523
|
+
"name": "--mdc-badge-success-foreground-color"
|
2524
|
+
},
|
2525
|
+
{
|
2526
|
+
"description": "The background color of the success badge.",
|
2527
|
+
"name": "--mdc-badge-success-background-color"
|
2528
|
+
},
|
2529
|
+
{
|
2530
|
+
"description": "The foreground color of the warning badge.",
|
2531
|
+
"name": "--mdc-badge-warning-foreground-color"
|
2532
|
+
},
|
2533
|
+
{
|
2534
|
+
"description": "The background color of the warning badge.",
|
2535
|
+
"name": "--mdc-badge-warning-background-color"
|
2315
2536
|
},
|
2316
2537
|
{
|
2317
|
-
"
|
2318
|
-
"name": "
|
2319
|
-
"privacy": "protected",
|
2320
|
-
"parameters": [
|
2321
|
-
{
|
2322
|
-
"name": "size",
|
2323
|
-
"type": {
|
2324
|
-
"text": "PillButtonSize | IconButtonSize"
|
2325
|
-
},
|
2326
|
-
"description": "The size to set."
|
2327
|
-
}
|
2328
|
-
],
|
2329
|
-
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
|
2330
|
-
"inheritedFrom": {
|
2331
|
-
"name": "ButtonComponentMixin",
|
2332
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
2333
|
-
}
|
2538
|
+
"description": "The foreground color of the error badge.",
|
2539
|
+
"name": "--mdc-badge-error-foreground-color"
|
2334
2540
|
},
|
2335
2541
|
{
|
2336
|
-
"
|
2337
|
-
"name": "
|
2338
|
-
"privacy": "protected",
|
2339
|
-
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
2340
|
-
"parameters": [
|
2341
|
-
{
|
2342
|
-
"description": "default slot of button",
|
2343
|
-
"name": "slot"
|
2344
|
-
}
|
2345
|
-
],
|
2346
|
-
"inheritedFrom": {
|
2347
|
-
"name": "ButtonComponentMixin",
|
2348
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
2349
|
-
}
|
2542
|
+
"description": "The background color of the error badge.",
|
2543
|
+
"name": "--mdc-badge-error-background-color"
|
2350
2544
|
},
|
2545
|
+
{
|
2546
|
+
"description": "The background color of the badge overlay.",
|
2547
|
+
"name": "--mdc-badge-overlay-background-color"
|
2548
|
+
}
|
2549
|
+
],
|
2550
|
+
"members": [
|
2351
2551
|
{
|
2352
2552
|
"kind": "field",
|
2353
|
-
"name": "
|
2553
|
+
"name": "type",
|
2354
2554
|
"type": {
|
2355
|
-
"text": "
|
2555
|
+
"text": "BadgeType | undefined"
|
2356
2556
|
},
|
2357
|
-
"
|
2358
|
-
"
|
2359
|
-
"
|
2360
|
-
"reflects": true,
|
2361
|
-
"inheritedFrom": {
|
2362
|
-
"name": "TabIndexMixin",
|
2363
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
2364
|
-
}
|
2557
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
2558
|
+
"attribute": "type",
|
2559
|
+
"reflects": true
|
2365
2560
|
},
|
2366
2561
|
{
|
2367
2562
|
"kind": "field",
|
2368
|
-
"name": "
|
2563
|
+
"name": "variant",
|
2369
2564
|
"type": {
|
2370
|
-
"text": "
|
2565
|
+
"text": "IconVariant"
|
2371
2566
|
},
|
2372
|
-
"description": "
|
2373
|
-
"default": "
|
2374
|
-
"attribute": "
|
2375
|
-
"reflects": true
|
2376
|
-
"inheritedFrom": {
|
2377
|
-
"name": "DisabledMixin",
|
2378
|
-
"module": "utils/mixins/DisabledMixin.js"
|
2379
|
-
}
|
2567
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
2568
|
+
"default": "primary",
|
2569
|
+
"attribute": "variant",
|
2570
|
+
"reflects": true
|
2380
2571
|
},
|
2381
2572
|
{
|
2382
2573
|
"kind": "field",
|
2383
|
-
"name": "
|
2574
|
+
"name": "counter",
|
2384
2575
|
"type": {
|
2385
|
-
"text": "
|
2576
|
+
"text": "number | undefined"
|
2386
2577
|
},
|
2387
|
-
"description": "
|
2388
|
-
"
|
2389
|
-
"attribute": "active",
|
2390
|
-
"reflects": true,
|
2391
|
-
"inheritedFrom": {
|
2392
|
-
"name": "Buttonsimple",
|
2393
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2394
|
-
}
|
2578
|
+
"description": "Counter is the number which can be provided in the badge.",
|
2579
|
+
"attribute": "counter"
|
2395
2580
|
},
|
2396
2581
|
{
|
2397
2582
|
"kind": "field",
|
2398
|
-
"name": "
|
2583
|
+
"name": "maxCounter",
|
2399
2584
|
"type": {
|
2400
|
-
"text": "
|
2585
|
+
"text": "number"
|
2401
2586
|
},
|
2402
|
-
"description": "
|
2403
|
-
"default": "
|
2404
|
-
"attribute": "
|
2405
|
-
"reflects": true
|
2406
|
-
"inheritedFrom": {
|
2407
|
-
"name": "Buttonsimple",
|
2408
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2409
|
-
}
|
2587
|
+
"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`.",
|
2588
|
+
"default": "99",
|
2589
|
+
"attribute": "max-counter",
|
2590
|
+
"reflects": true
|
2410
2591
|
},
|
2411
2592
|
{
|
2412
2593
|
"kind": "field",
|
2413
|
-
"name": "
|
2594
|
+
"name": "overlay",
|
2414
2595
|
"type": {
|
2415
|
-
"text": "
|
2596
|
+
"text": "boolean"
|
2416
2597
|
},
|
2417
|
-
"
|
2418
|
-
"
|
2419
|
-
"attribute": "
|
2420
|
-
"reflects": true,
|
2421
|
-
"inheritedFrom": {
|
2422
|
-
"name": "Buttonsimple",
|
2423
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2424
|
-
}
|
2598
|
+
"default": "false",
|
2599
|
+
"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.",
|
2600
|
+
"attribute": "overlay"
|
2425
2601
|
},
|
2426
2602
|
{
|
2427
2603
|
"kind": "field",
|
2428
|
-
"name": "
|
2604
|
+
"name": "ariaLabel",
|
2429
2605
|
"type": {
|
2430
|
-
"text": "
|
2606
|
+
"text": "string | null"
|
2431
2607
|
},
|
2432
|
-
"
|
2433
|
-
"
|
2434
|
-
"attribute": "
|
2435
|
-
"reflects": true,
|
2436
|
-
"inheritedFrom": {
|
2437
|
-
"name": "Buttonsimple",
|
2438
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2439
|
-
}
|
2440
|
-
},
|
2441
|
-
{
|
2442
|
-
"kind": "method",
|
2443
|
-
"name": "executeAction",
|
2444
|
-
"privacy": "protected",
|
2445
|
-
"inheritedFrom": {
|
2446
|
-
"name": "Buttonsimple",
|
2447
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2448
|
-
}
|
2449
|
-
},
|
2450
|
-
{
|
2451
|
-
"kind": "method",
|
2452
|
-
"name": "setActive",
|
2453
|
-
"privacy": "protected",
|
2454
|
-
"parameters": [
|
2455
|
-
{
|
2456
|
-
"name": "element",
|
2457
|
-
"type": {
|
2458
|
-
"text": "HTMLElement"
|
2459
|
-
},
|
2460
|
-
"description": "The button element"
|
2461
|
-
},
|
2462
|
-
{
|
2463
|
-
"name": "active",
|
2464
|
-
"optional": true,
|
2465
|
-
"type": {
|
2466
|
-
"text": "boolean"
|
2467
|
-
},
|
2468
|
-
"description": "The active state of the element"
|
2469
|
-
}
|
2470
|
-
],
|
2471
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
2472
|
-
"inheritedFrom": {
|
2473
|
-
"name": "Buttonsimple",
|
2474
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2475
|
-
}
|
2608
|
+
"default": "null",
|
2609
|
+
"description": "Aria-label attribute to be set for accessibility",
|
2610
|
+
"attribute": "aria-label"
|
2476
2611
|
},
|
2477
2612
|
{
|
2478
2613
|
"kind": "method",
|
2479
|
-
"name": "
|
2614
|
+
"name": "getCounterText",
|
2480
2615
|
"privacy": "private",
|
2616
|
+
"return": {
|
2617
|
+
"type": {
|
2618
|
+
"text": ""
|
2619
|
+
}
|
2620
|
+
},
|
2481
2621
|
"parameters": [
|
2482
2622
|
{
|
2483
|
-
"name": "
|
2623
|
+
"name": "maxCounter",
|
2484
2624
|
"type": {
|
2485
|
-
"text": "
|
2625
|
+
"text": "number"
|
2486
2626
|
},
|
2487
|
-
"description": "
|
2627
|
+
"description": "the maximum limit which can be displayed on the badge"
|
2488
2628
|
},
|
2489
2629
|
{
|
2490
|
-
"name": "
|
2630
|
+
"name": "counter",
|
2491
2631
|
"optional": true,
|
2492
2632
|
"type": {
|
2493
|
-
"text": "
|
2633
|
+
"text": "number"
|
2494
2634
|
},
|
2495
|
-
"description": "
|
2635
|
+
"description": "the number to be displayed on the badge"
|
2496
2636
|
}
|
2497
2637
|
],
|
2498
|
-
"description": "
|
2499
|
-
"inheritedFrom": {
|
2500
|
-
"name": "Buttonsimple",
|
2501
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2502
|
-
}
|
2638
|
+
"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."
|
2503
2639
|
},
|
2504
2640
|
{
|
2505
2641
|
"kind": "method",
|
2506
|
-
"name": "
|
2642
|
+
"name": "getBadgeIcon",
|
2507
2643
|
"privacy": "private",
|
2644
|
+
"return": {
|
2645
|
+
"type": {
|
2646
|
+
"text": ""
|
2647
|
+
}
|
2648
|
+
},
|
2508
2649
|
"parameters": [
|
2509
2650
|
{
|
2510
|
-
"name": "
|
2651
|
+
"name": "iconName",
|
2511
2652
|
"type": {
|
2512
|
-
"text": "
|
2653
|
+
"text": "string"
|
2513
2654
|
},
|
2514
|
-
"description": "
|
2655
|
+
"description": "the name of the icon from the icon set"
|
2515
2656
|
},
|
2516
2657
|
{
|
2517
|
-
"name": "
|
2658
|
+
"name": "backgroundClassPostfix",
|
2518
2659
|
"type": {
|
2519
|
-
"text": "
|
2660
|
+
"text": "string"
|
2520
2661
|
},
|
2521
|
-
"description": "
|
2662
|
+
"description": "postfix for the class to style the badge icon."
|
2522
2663
|
}
|
2523
2664
|
],
|
2524
|
-
"description": "
|
2525
|
-
"inheritedFrom": {
|
2526
|
-
"name": "Buttonsimple",
|
2527
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2528
|
-
}
|
2529
|
-
},
|
2530
|
-
{
|
2531
|
-
"kind": "method",
|
2532
|
-
"name": "triggerClickEvent",
|
2533
|
-
"privacy": "private",
|
2534
|
-
"inheritedFrom": {
|
2535
|
-
"name": "Buttonsimple",
|
2536
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2537
|
-
}
|
2538
|
-
},
|
2539
|
-
{
|
2540
|
-
"kind": "method",
|
2541
|
-
"name": "handleBlur",
|
2542
|
-
"privacy": "private",
|
2543
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
2544
|
-
"inheritedFrom": {
|
2545
|
-
"name": "Buttonsimple",
|
2546
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2547
|
-
}
|
2665
|
+
"description": "Method to generate the badge icon."
|
2548
2666
|
},
|
2549
2667
|
{
|
2550
2668
|
"kind": "method",
|
2551
|
-
"name": "
|
2669
|
+
"name": "getBadgeDot",
|
2552
2670
|
"privacy": "private",
|
2553
|
-
"
|
2554
|
-
{
|
2555
|
-
"
|
2556
|
-
|
2557
|
-
|
2558
|
-
|
2559
|
-
"description": "The keyboard event."
|
2560
|
-
}
|
2561
|
-
],
|
2562
|
-
"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.",
|
2563
|
-
"inheritedFrom": {
|
2564
|
-
"name": "Buttonsimple",
|
2565
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2566
|
-
}
|
2671
|
+
"return": {
|
2672
|
+
"type": {
|
2673
|
+
"text": ""
|
2674
|
+
}
|
2675
|
+
},
|
2676
|
+
"description": "Method to generate the badge dot template."
|
2567
2677
|
},
|
2568
2678
|
{
|
2569
2679
|
"kind": "method",
|
2570
|
-
"name": "
|
2680
|
+
"name": "getBadgeCounterText",
|
2571
2681
|
"privacy": "private",
|
2572
|
-
"
|
2573
|
-
{
|
2574
|
-
"
|
2575
|
-
"type": {
|
2576
|
-
"text": "KeyboardEvent"
|
2577
|
-
},
|
2578
|
-
"description": "The keyboard event."
|
2682
|
+
"return": {
|
2683
|
+
"type": {
|
2684
|
+
"text": ""
|
2579
2685
|
}
|
2580
|
-
],
|
2581
|
-
"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.",
|
2582
|
-
"inheritedFrom": {
|
2583
|
-
"name": "Buttonsimple",
|
2584
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2585
|
-
}
|
2586
|
-
}
|
2587
|
-
],
|
2588
|
-
"attributes": [
|
2589
|
-
{
|
2590
|
-
"name": "size",
|
2591
|
-
"type": {
|
2592
|
-
"text": "ButtonSize"
|
2593
2686
|
},
|
2594
|
-
"description": "
|
2595
|
-
"default": "32",
|
2596
|
-
"fieldName": "size",
|
2597
|
-
"inheritedFrom": {
|
2598
|
-
"name": "Buttonsimple",
|
2599
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2600
|
-
}
|
2687
|
+
"description": "Method to generate the badge text and counter template."
|
2601
2688
|
},
|
2602
2689
|
{
|
2603
|
-
"
|
2604
|
-
"
|
2605
|
-
|
2690
|
+
"kind": "method",
|
2691
|
+
"name": "setRoleByAriaLabel",
|
2692
|
+
"privacy": "private",
|
2693
|
+
"return": {
|
2694
|
+
"type": {
|
2695
|
+
"text": "void"
|
2696
|
+
}
|
2606
2697
|
},
|
2607
|
-
"description": "
|
2608
|
-
"default": "false",
|
2609
|
-
"fieldName": "inverted"
|
2698
|
+
"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."
|
2610
2699
|
},
|
2611
2700
|
{
|
2612
|
-
"
|
2613
|
-
"
|
2614
|
-
"
|
2615
|
-
"
|
2616
|
-
|
2617
|
-
|
2701
|
+
"kind": "method",
|
2702
|
+
"name": "getBadgeContentBasedOnType",
|
2703
|
+
"privacy": "private",
|
2704
|
+
"return": {
|
2705
|
+
"type": {
|
2706
|
+
"text": ""
|
2707
|
+
}
|
2618
2708
|
},
|
2619
|
-
"
|
2620
|
-
"name": "Buttonsimple",
|
2621
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2622
|
-
}
|
2709
|
+
"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."
|
2623
2710
|
},
|
2624
2711
|
{
|
2625
|
-
"
|
2712
|
+
"kind": "field",
|
2713
|
+
"name": "iconName",
|
2626
2714
|
"type": {
|
2627
2715
|
"text": "IconNames | undefined"
|
2628
2716
|
},
|
2629
|
-
"description": "
|
2630
|
-
"
|
2717
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2718
|
+
"attribute": "icon-name",
|
2631
2719
|
"inheritedFrom": {
|
2632
|
-
"name": "
|
2633
|
-
"module": "
|
2720
|
+
"name": "IconNameMixin",
|
2721
|
+
"module": "utils/mixins/IconNameMixin.js"
|
2634
2722
|
}
|
2635
|
-
}
|
2723
|
+
}
|
2724
|
+
],
|
2725
|
+
"attributes": [
|
2636
2726
|
{
|
2637
|
-
"name": "
|
2727
|
+
"name": "type",
|
2638
2728
|
"type": {
|
2639
|
-
"text": "
|
2729
|
+
"text": "BadgeType | undefined"
|
2640
2730
|
},
|
2641
|
-
"description": "
|
2642
|
-
"fieldName": "
|
2643
|
-
"inheritedFrom": {
|
2644
|
-
"name": "ButtonComponentMixin",
|
2645
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2646
|
-
}
|
2731
|
+
"description": "Type of the badge\nCan be `dot` (notification) , `icon`, `counter`, `success`, `warning` or `error`.",
|
2732
|
+
"fieldName": "type"
|
2647
2733
|
},
|
2648
2734
|
{
|
2649
2735
|
"name": "variant",
|
2650
2736
|
"type": {
|
2651
|
-
"text": "
|
2737
|
+
"text": "IconVariant"
|
2652
2738
|
},
|
2653
|
-
"description": "
|
2739
|
+
"description": "Type of the variant can be `primary` or `secondary`.\nIt defines the background and foreground color of the icon.",
|
2654
2740
|
"default": "primary",
|
2655
|
-
"fieldName": "variant"
|
2656
|
-
"inheritedFrom": {
|
2657
|
-
"name": "ButtonComponentMixin",
|
2658
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2659
|
-
}
|
2741
|
+
"fieldName": "variant"
|
2660
2742
|
},
|
2661
2743
|
{
|
2662
|
-
"name": "
|
2744
|
+
"name": "counter",
|
2663
2745
|
"type": {
|
2664
|
-
"text": "
|
2746
|
+
"text": "number | undefined"
|
2665
2747
|
},
|
2666
|
-
"description": "
|
2667
|
-
"
|
2668
|
-
"fieldName": "color",
|
2669
|
-
"inheritedFrom": {
|
2670
|
-
"name": "ButtonComponentMixin",
|
2671
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
2672
|
-
}
|
2748
|
+
"description": "Counter is the number which can be provided in the badge.",
|
2749
|
+
"fieldName": "counter"
|
2673
2750
|
},
|
2674
2751
|
{
|
2675
|
-
"name": "
|
2752
|
+
"name": "max-counter",
|
2676
2753
|
"type": {
|
2677
2754
|
"text": "number"
|
2678
2755
|
},
|
2679
|
-
"
|
2680
|
-
"
|
2681
|
-
"fieldName": "
|
2682
|
-
"inheritedFrom": {
|
2683
|
-
"name": "TabIndexMixin",
|
2684
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
2685
|
-
}
|
2686
|
-
},
|
2687
|
-
{
|
2688
|
-
"name": "disabled",
|
2689
|
-
"type": {
|
2690
|
-
"text": "boolean | undefined"
|
2691
|
-
},
|
2692
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2693
|
-
"default": "undefined",
|
2694
|
-
"fieldName": "disabled",
|
2695
|
-
"inheritedFrom": {
|
2696
|
-
"name": "DisabledMixin",
|
2697
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
2698
|
-
}
|
2699
|
-
},
|
2700
|
-
{
|
2701
|
-
"name": "active",
|
2702
|
-
"type": {
|
2703
|
-
"text": "boolean | undefined"
|
2704
|
-
},
|
2705
|
-
"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.",
|
2706
|
-
"default": "undefined",
|
2707
|
-
"fieldName": "active",
|
2708
|
-
"inheritedFrom": {
|
2709
|
-
"name": "Buttonsimple",
|
2710
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2711
|
-
}
|
2756
|
+
"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`.",
|
2757
|
+
"default": "99",
|
2758
|
+
"fieldName": "maxCounter"
|
2712
2759
|
},
|
2713
2760
|
{
|
2714
|
-
"name": "
|
2761
|
+
"name": "overlay",
|
2715
2762
|
"type": {
|
2716
|
-
"text": "boolean
|
2763
|
+
"text": "boolean"
|
2717
2764
|
},
|
2718
|
-
"
|
2719
|
-
"
|
2720
|
-
"fieldName": "
|
2721
|
-
"inheritedFrom": {
|
2722
|
-
"name": "Buttonsimple",
|
2723
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2724
|
-
}
|
2765
|
+
"default": "false",
|
2766
|
+
"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.",
|
2767
|
+
"fieldName": "overlay"
|
2725
2768
|
},
|
2726
2769
|
{
|
2727
|
-
"name": "
|
2770
|
+
"name": "aria-label",
|
2728
2771
|
"type": {
|
2729
|
-
"text": "string |
|
2772
|
+
"text": "string | null"
|
2730
2773
|
},
|
2731
|
-
"
|
2732
|
-
"
|
2733
|
-
"fieldName": "
|
2734
|
-
"inheritedFrom": {
|
2735
|
-
"name": "Buttonsimple",
|
2736
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2737
|
-
}
|
2774
|
+
"default": "null",
|
2775
|
+
"description": "Aria-label attribute to be set for accessibility",
|
2776
|
+
"fieldName": "ariaLabel"
|
2738
2777
|
},
|
2739
2778
|
{
|
2740
|
-
"name": "
|
2779
|
+
"name": "icon-name",
|
2741
2780
|
"type": {
|
2742
|
-
"text": "
|
2781
|
+
"text": "IconNames | undefined"
|
2743
2782
|
},
|
2744
|
-
"description": "
|
2745
|
-
"
|
2746
|
-
"fieldName": "type",
|
2783
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2784
|
+
"fieldName": "iconName",
|
2747
2785
|
"inheritedFrom": {
|
2748
|
-
"name": "
|
2749
|
-
"module": "src/
|
2786
|
+
"name": "IconNameMixin",
|
2787
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
2750
2788
|
}
|
2751
2789
|
}
|
2752
2790
|
],
|
2753
2791
|
"mixins": [
|
2754
2792
|
{
|
2755
|
-
"name": "
|
2756
|
-
"module": "/src/utils/mixins/
|
2793
|
+
"name": "IconNameMixin",
|
2794
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
2757
2795
|
}
|
2758
2796
|
],
|
2759
2797
|
"superclass": {
|
2760
|
-
"name": "
|
2761
|
-
"module": "/src/
|
2798
|
+
"name": "Component",
|
2799
|
+
"module": "/src/models"
|
2762
2800
|
},
|
2763
|
-
"tagName": "mdc-
|
2764
|
-
"jsDoc": "/**\n * `mdc-
|
2765
|
-
"customElement": true
|
2766
|
-
"events": [
|
2767
|
-
{
|
2768
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
2769
|
-
"name": "click",
|
2770
|
-
"reactName": "onClick",
|
2771
|
-
"inheritedFrom": {
|
2772
|
-
"name": "Buttonsimple",
|
2773
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2774
|
-
}
|
2775
|
-
},
|
2776
|
-
{
|
2777
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
2778
|
-
"name": "keydown",
|
2779
|
-
"reactName": "onKeyDown",
|
2780
|
-
"inheritedFrom": {
|
2781
|
-
"name": "Buttonsimple",
|
2782
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2783
|
-
}
|
2784
|
-
},
|
2785
|
-
{
|
2786
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
2787
|
-
"name": "keyup",
|
2788
|
-
"reactName": "onKeyUp",
|
2789
|
-
"inheritedFrom": {
|
2790
|
-
"name": "Buttonsimple",
|
2791
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2792
|
-
}
|
2793
|
-
},
|
2794
|
-
{
|
2795
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
2796
|
-
"name": "focus",
|
2797
|
-
"reactName": "onFocus",
|
2798
|
-
"inheritedFrom": {
|
2799
|
-
"name": "Buttonsimple",
|
2800
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
2801
|
-
}
|
2802
|
-
}
|
2803
|
-
]
|
2801
|
+
"tagName": "mdc-badge",
|
2802
|
+
"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 */",
|
2803
|
+
"customElement": true
|
2804
2804
|
}
|
2805
2805
|
],
|
2806
2806
|
"exports": [
|
@@ -2808,8 +2808,8 @@
|
|
2808
2808
|
"kind": "js",
|
2809
2809
|
"name": "default",
|
2810
2810
|
"declaration": {
|
2811
|
-
"name": "
|
2812
|
-
"module": "components/
|
2811
|
+
"name": "Badge",
|
2812
|
+
"module": "components/badge/badge.component.js"
|
2813
2813
|
}
|
2814
2814
|
}
|
2815
2815
|
]
|