@momentum-design/components 0.127.2 → 0.127.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -513,157 +513,6 @@
|
|
|
513
513
|
}
|
|
514
514
|
]
|
|
515
515
|
},
|
|
516
|
-
{
|
|
517
|
-
"kind": "javascript-module",
|
|
518
|
-
"path": "components/accordiongroup/accordiongroup.component.js",
|
|
519
|
-
"declarations": [
|
|
520
|
-
{
|
|
521
|
-
"kind": "class",
|
|
522
|
-
"description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
|
|
523
|
-
"name": "AccordionGroup",
|
|
524
|
-
"cssProperties": [
|
|
525
|
-
{
|
|
526
|
-
"description": "The border color of the entire accordiongroup",
|
|
527
|
-
"name": "--mdc-accordiongroup-border-color"
|
|
528
|
-
}
|
|
529
|
-
],
|
|
530
|
-
"slots": [
|
|
531
|
-
{
|
|
532
|
-
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
|
533
|
-
"name": "default"
|
|
534
|
-
}
|
|
535
|
-
],
|
|
536
|
-
"members": [
|
|
537
|
-
{
|
|
538
|
-
"kind": "field",
|
|
539
|
-
"name": "size",
|
|
540
|
-
"type": {
|
|
541
|
-
"text": "Size"
|
|
542
|
-
},
|
|
543
|
-
"description": "The size of the accordion item.",
|
|
544
|
-
"default": "'small'",
|
|
545
|
-
"attribute": "size",
|
|
546
|
-
"reflects": true
|
|
547
|
-
},
|
|
548
|
-
{
|
|
549
|
-
"kind": "field",
|
|
550
|
-
"name": "variant",
|
|
551
|
-
"type": {
|
|
552
|
-
"text": "Variant"
|
|
553
|
-
},
|
|
554
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
555
|
-
"default": "'stacked'",
|
|
556
|
-
"attribute": "variant",
|
|
557
|
-
"reflects": true
|
|
558
|
-
},
|
|
559
|
-
{
|
|
560
|
-
"kind": "field",
|
|
561
|
-
"name": "allowMultiple",
|
|
562
|
-
"type": {
|
|
563
|
-
"text": "boolean"
|
|
564
|
-
},
|
|
565
|
-
"default": "false",
|
|
566
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
567
|
-
"attribute": "allow-multiple",
|
|
568
|
-
"reflects": true
|
|
569
|
-
},
|
|
570
|
-
{
|
|
571
|
-
"kind": "method",
|
|
572
|
-
"name": "handleAccordionExpanded",
|
|
573
|
-
"privacy": "private",
|
|
574
|
-
"return": {
|
|
575
|
-
"type": {
|
|
576
|
-
"text": "void"
|
|
577
|
-
}
|
|
578
|
-
},
|
|
579
|
-
"parameters": [
|
|
580
|
-
{
|
|
581
|
-
"name": "event",
|
|
582
|
-
"type": {
|
|
583
|
-
"text": "Event"
|
|
584
|
-
},
|
|
585
|
-
"description": "The event object from the 'shown' event."
|
|
586
|
-
}
|
|
587
|
-
],
|
|
588
|
-
"description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
|
|
589
|
-
},
|
|
590
|
-
{
|
|
591
|
-
"kind": "method",
|
|
592
|
-
"name": "setChildrenAccordionAttributes",
|
|
593
|
-
"privacy": "private",
|
|
594
|
-
"return": {
|
|
595
|
-
"type": {
|
|
596
|
-
"text": "void"
|
|
597
|
-
}
|
|
598
|
-
},
|
|
599
|
-
"parameters": [
|
|
600
|
-
{
|
|
601
|
-
"name": "attributeName",
|
|
602
|
-
"type": {
|
|
603
|
-
"text": "string"
|
|
604
|
-
},
|
|
605
|
-
"description": "The name of the attribute to set."
|
|
606
|
-
},
|
|
607
|
-
{
|
|
608
|
-
"name": "attributeValue",
|
|
609
|
-
"type": {
|
|
610
|
-
"text": "string"
|
|
611
|
-
},
|
|
612
|
-
"description": "The value to set the attribute to."
|
|
613
|
-
}
|
|
614
|
-
],
|
|
615
|
-
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
|
616
|
-
}
|
|
617
|
-
],
|
|
618
|
-
"attributes": [
|
|
619
|
-
{
|
|
620
|
-
"name": "size",
|
|
621
|
-
"type": {
|
|
622
|
-
"text": "Size"
|
|
623
|
-
},
|
|
624
|
-
"description": "The size of the accordion item.",
|
|
625
|
-
"default": "'small'",
|
|
626
|
-
"fieldName": "size"
|
|
627
|
-
},
|
|
628
|
-
{
|
|
629
|
-
"name": "variant",
|
|
630
|
-
"type": {
|
|
631
|
-
"text": "Variant"
|
|
632
|
-
},
|
|
633
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
634
|
-
"default": "'stacked'",
|
|
635
|
-
"fieldName": "variant"
|
|
636
|
-
},
|
|
637
|
-
{
|
|
638
|
-
"name": "allow-multiple",
|
|
639
|
-
"type": {
|
|
640
|
-
"text": "boolean"
|
|
641
|
-
},
|
|
642
|
-
"default": "false",
|
|
643
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
644
|
-
"fieldName": "allowMultiple"
|
|
645
|
-
}
|
|
646
|
-
],
|
|
647
|
-
"superclass": {
|
|
648
|
-
"name": "Component",
|
|
649
|
-
"module": "/src/models"
|
|
650
|
-
},
|
|
651
|
-
"tagName": "mdc-accordiongroup",
|
|
652
|
-
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
|
653
|
-
"customElement": true
|
|
654
|
-
}
|
|
655
|
-
],
|
|
656
|
-
"exports": [
|
|
657
|
-
{
|
|
658
|
-
"kind": "js",
|
|
659
|
-
"name": "default",
|
|
660
|
-
"declaration": {
|
|
661
|
-
"name": "AccordionGroup",
|
|
662
|
-
"module": "components/accordiongroup/accordiongroup.component.js"
|
|
663
|
-
}
|
|
664
|
-
}
|
|
665
|
-
]
|
|
666
|
-
},
|
|
667
516
|
{
|
|
668
517
|
"kind": "javascript-module",
|
|
669
518
|
"path": "components/accordionbutton/accordionbutton.component.js",
|
|
@@ -1006,119 +855,270 @@
|
|
|
1006
855
|
},
|
|
1007
856
|
{
|
|
1008
857
|
"kind": "javascript-module",
|
|
1009
|
-
"path": "components/
|
|
858
|
+
"path": "components/accordiongroup/accordiongroup.component.js",
|
|
1010
859
|
"declarations": [
|
|
1011
860
|
{
|
|
1012
861
|
"kind": "class",
|
|
1013
|
-
"description": "
|
|
1014
|
-
"name": "
|
|
862
|
+
"description": "An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\nEach heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\nAccordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n\n- Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n\nThere are three types of variants:\n- Stacked - Each accordion will have a gap of 1.5rem (24px).\n- Borderless - Each accordion will not have any border and the group will also not have any border.\n- Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n\nThere are two types of sizes:\n- Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n- Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n\nThe variant and size will be applied to all accordions inside this accordion group.\nTo show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n\nIf you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n\nIf the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.",
|
|
863
|
+
"name": "AccordionGroup",
|
|
1015
864
|
"cssProperties": [
|
|
1016
865
|
{
|
|
1017
|
-
"description": "The color of the
|
|
1018
|
-
"name": "--mdc-
|
|
1019
|
-
},
|
|
1020
|
-
{
|
|
1021
|
-
"description": "The color of the icon",
|
|
1022
|
-
"name": "--mdc-chip-icon-color"
|
|
1023
|
-
},
|
|
1024
|
-
{
|
|
1025
|
-
"description": "The border color of the alertchip",
|
|
1026
|
-
"name": "--mdc-chip-border-color"
|
|
1027
|
-
},
|
|
1028
|
-
{
|
|
1029
|
-
"description": "The background color of the alertchip",
|
|
1030
|
-
"name": "--mdc-chip-background-color"
|
|
1031
|
-
},
|
|
1032
|
-
{
|
|
1033
|
-
"description": "Height for button size",
|
|
1034
|
-
"name": "--mdc-button-height",
|
|
1035
|
-
"inheritedFrom": {
|
|
1036
|
-
"name": "Buttonsimple",
|
|
1037
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1038
|
-
}
|
|
1039
|
-
},
|
|
1040
|
-
{
|
|
1041
|
-
"description": "Background color of the button",
|
|
1042
|
-
"name": "--mdc-button-background",
|
|
1043
|
-
"inheritedFrom": {
|
|
1044
|
-
"name": "Buttonsimple",
|
|
1045
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1046
|
-
}
|
|
1047
|
-
},
|
|
1048
|
-
{
|
|
1049
|
-
"description": "Borer color of the button",
|
|
1050
|
-
"name": "--mdc-button-border-color",
|
|
1051
|
-
"inheritedFrom": {
|
|
1052
|
-
"name": "Buttonsimple",
|
|
1053
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1054
|
-
}
|
|
1055
|
-
},
|
|
1056
|
-
{
|
|
1057
|
-
"description": "Text color of the button",
|
|
1058
|
-
"name": "--mdc-button-text-color",
|
|
1059
|
-
"inheritedFrom": {
|
|
1060
|
-
"name": "Buttonsimple",
|
|
1061
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1062
|
-
}
|
|
866
|
+
"description": "The border color of the entire accordiongroup",
|
|
867
|
+
"name": "--mdc-accordiongroup-border-color"
|
|
1063
868
|
}
|
|
1064
869
|
],
|
|
1065
|
-
"
|
|
1066
|
-
{
|
|
1067
|
-
"description": "The alert icon",
|
|
1068
|
-
"name": "icon"
|
|
1069
|
-
},
|
|
870
|
+
"slots": [
|
|
1070
871
|
{
|
|
1071
|
-
"description": "The
|
|
1072
|
-
"name": "
|
|
872
|
+
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
|
873
|
+
"name": "default"
|
|
1073
874
|
}
|
|
1074
875
|
],
|
|
1075
876
|
"members": [
|
|
1076
877
|
{
|
|
1077
878
|
"kind": "field",
|
|
1078
|
-
"name": "
|
|
879
|
+
"name": "size",
|
|
1079
880
|
"type": {
|
|
1080
|
-
"text": "
|
|
881
|
+
"text": "Size"
|
|
1081
882
|
},
|
|
1082
|
-
"description": "The
|
|
1083
|
-
"default": "
|
|
1084
|
-
"attribute": "
|
|
883
|
+
"description": "The size of the accordion item.",
|
|
884
|
+
"default": "'small'",
|
|
885
|
+
"attribute": "size",
|
|
1085
886
|
"reflects": true
|
|
1086
887
|
},
|
|
1087
888
|
{
|
|
1088
889
|
"kind": "field",
|
|
1089
|
-
"name": "
|
|
1090
|
-
"type": {
|
|
1091
|
-
"text": "string"
|
|
1092
|
-
},
|
|
1093
|
-
"default": "''",
|
|
1094
|
-
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
|
1095
|
-
"attribute": "label"
|
|
1096
|
-
},
|
|
1097
|
-
{
|
|
1098
|
-
"kind": "field",
|
|
1099
|
-
"name": "iconName",
|
|
890
|
+
"name": "variant",
|
|
1100
891
|
"type": {
|
|
1101
|
-
"text": "
|
|
892
|
+
"text": "Variant"
|
|
1102
893
|
},
|
|
1103
|
-
"description": "
|
|
1104
|
-
"
|
|
1105
|
-
"
|
|
1106
|
-
|
|
1107
|
-
"module": "utils/mixins/IconNameMixin.js"
|
|
1108
|
-
}
|
|
894
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
895
|
+
"default": "'stacked'",
|
|
896
|
+
"attribute": "variant",
|
|
897
|
+
"reflects": true
|
|
1109
898
|
},
|
|
1110
899
|
{
|
|
1111
900
|
"kind": "field",
|
|
1112
|
-
"name": "
|
|
901
|
+
"name": "allowMultiple",
|
|
1113
902
|
"type": {
|
|
1114
903
|
"text": "boolean"
|
|
1115
904
|
},
|
|
1116
905
|
"default": "false",
|
|
1117
|
-
"description": "
|
|
1118
|
-
"attribute": "
|
|
1119
|
-
"reflects": true
|
|
1120
|
-
|
|
1121
|
-
|
|
906
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
907
|
+
"attribute": "allow-multiple",
|
|
908
|
+
"reflects": true
|
|
909
|
+
},
|
|
910
|
+
{
|
|
911
|
+
"kind": "method",
|
|
912
|
+
"name": "handleAccordionExpanded",
|
|
913
|
+
"privacy": "private",
|
|
914
|
+
"return": {
|
|
915
|
+
"type": {
|
|
916
|
+
"text": "void"
|
|
917
|
+
}
|
|
918
|
+
},
|
|
919
|
+
"parameters": [
|
|
920
|
+
{
|
|
921
|
+
"name": "event",
|
|
922
|
+
"type": {
|
|
923
|
+
"text": "Event"
|
|
924
|
+
},
|
|
925
|
+
"description": "The event object from the 'shown' event."
|
|
926
|
+
}
|
|
927
|
+
],
|
|
928
|
+
"description": "Handles the 'shown' event for accordion items.\nIf `allowMultiple` is false, ensures that only one accordion item\nremains expanded by collapsing all other expanded items when a new item is expanded."
|
|
929
|
+
},
|
|
930
|
+
{
|
|
931
|
+
"kind": "method",
|
|
932
|
+
"name": "setChildrenAccordionAttributes",
|
|
933
|
+
"privacy": "private",
|
|
934
|
+
"return": {
|
|
935
|
+
"type": {
|
|
936
|
+
"text": "void"
|
|
937
|
+
}
|
|
938
|
+
},
|
|
939
|
+
"parameters": [
|
|
940
|
+
{
|
|
941
|
+
"name": "attributeName",
|
|
942
|
+
"type": {
|
|
943
|
+
"text": "string"
|
|
944
|
+
},
|
|
945
|
+
"description": "The name of the attribute to set."
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
"name": "attributeValue",
|
|
949
|
+
"type": {
|
|
950
|
+
"text": "string"
|
|
951
|
+
},
|
|
952
|
+
"description": "The value to set the attribute to."
|
|
953
|
+
}
|
|
954
|
+
],
|
|
955
|
+
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
|
956
|
+
}
|
|
957
|
+
],
|
|
958
|
+
"attributes": [
|
|
959
|
+
{
|
|
960
|
+
"name": "size",
|
|
961
|
+
"type": {
|
|
962
|
+
"text": "Size"
|
|
963
|
+
},
|
|
964
|
+
"description": "The size of the accordion item.",
|
|
965
|
+
"default": "'small'",
|
|
966
|
+
"fieldName": "size"
|
|
967
|
+
},
|
|
968
|
+
{
|
|
969
|
+
"name": "variant",
|
|
970
|
+
"type": {
|
|
971
|
+
"text": "Variant"
|
|
972
|
+
},
|
|
973
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
|
974
|
+
"default": "'stacked'",
|
|
975
|
+
"fieldName": "variant"
|
|
976
|
+
},
|
|
977
|
+
{
|
|
978
|
+
"name": "allow-multiple",
|
|
979
|
+
"type": {
|
|
980
|
+
"text": "boolean"
|
|
981
|
+
},
|
|
982
|
+
"default": "false",
|
|
983
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
|
984
|
+
"fieldName": "allowMultiple"
|
|
985
|
+
}
|
|
986
|
+
],
|
|
987
|
+
"superclass": {
|
|
988
|
+
"name": "Component",
|
|
989
|
+
"module": "/src/models"
|
|
990
|
+
},
|
|
991
|
+
"tagName": "mdc-accordiongroup",
|
|
992
|
+
"jsDoc": "/**\n * An accordion group is a vertically stacked set of interactive headings that each contain a header and body content.\n * Each heading of the accordion acts as a control that enable users to expand or hide their associated body sections of content.\n * Accordions are commonly used to reduce the need to scroll when presenting multiple sections of content on a single page.\n *\n * - Default Slot: The accordion group component only accepts, `accordion` and `accordionbutton` components as the children, rest are ignored.\n *\n * There are three types of variants:\n * - Stacked - Each accordion will have a gap of 1.5rem (24px).\n * - Borderless - Each accordion will not have any border and the group will also not have any border.\n * - Contained - Each accordion will have no gap in between them and the border of the entire accordiongroup will be continuous.\n *\n * There are two types of sizes:\n * - Small: Small size has a padding of 1rem (16px) for both heading and body sections.\n * - Large: Large size has a padding of 1.5rem (24px) for both heading and body sections.\n *\n * The variant and size will be applied to all accordions inside this accordion group.\n * To show/expand more than one accordion at any given time, then set `allow-multiple` to `true`. By default, it's `false`.\n *\n * If you don't need any controls on your accordion heading, then it's advised to use `accordionbutton` component.\n *\n * If the first accordion of the accordion group is expanded by default, then the screen reader might loose focus when toggling the visibilty of the first accordion.\n *\n * @tagname mdc-accordiongroup\n *\n * @slot default - The default slot can contain the `accordion` or `accordionbutton` components.\n *\n * @cssproperty --mdc-accordiongroup-border-color - The border color of the entire accordiongroup\n */",
|
|
993
|
+
"customElement": true
|
|
994
|
+
}
|
|
995
|
+
],
|
|
996
|
+
"exports": [
|
|
997
|
+
{
|
|
998
|
+
"kind": "js",
|
|
999
|
+
"name": "default",
|
|
1000
|
+
"declaration": {
|
|
1001
|
+
"name": "AccordionGroup",
|
|
1002
|
+
"module": "components/accordiongroup/accordiongroup.component.js"
|
|
1003
|
+
}
|
|
1004
|
+
}
|
|
1005
|
+
]
|
|
1006
|
+
},
|
|
1007
|
+
{
|
|
1008
|
+
"kind": "javascript-module",
|
|
1009
|
+
"path": "components/alertchip/alertchip.component.js",
|
|
1010
|
+
"declarations": [
|
|
1011
|
+
{
|
|
1012
|
+
"kind": "class",
|
|
1013
|
+
"description": "mdc-alertchip component is an interactive chip that consumers can use to represent an alert.\n\n- It supports a leading icon along with label.\n- It supports 5 variants of alerts - neutral, warning, error, success, and informational\n\nThis component is built by extending Buttonsimple.",
|
|
1014
|
+
"name": "AlertChip",
|
|
1015
|
+
"cssProperties": [
|
|
1016
|
+
{
|
|
1017
|
+
"description": "The color of the label text",
|
|
1018
|
+
"name": "--mdc-chip-color"
|
|
1019
|
+
},
|
|
1020
|
+
{
|
|
1021
|
+
"description": "The color of the icon",
|
|
1022
|
+
"name": "--mdc-chip-icon-color"
|
|
1023
|
+
},
|
|
1024
|
+
{
|
|
1025
|
+
"description": "The border color of the alertchip",
|
|
1026
|
+
"name": "--mdc-chip-border-color"
|
|
1027
|
+
},
|
|
1028
|
+
{
|
|
1029
|
+
"description": "The background color of the alertchip",
|
|
1030
|
+
"name": "--mdc-chip-background-color"
|
|
1031
|
+
},
|
|
1032
|
+
{
|
|
1033
|
+
"description": "Height for button size",
|
|
1034
|
+
"name": "--mdc-button-height",
|
|
1035
|
+
"inheritedFrom": {
|
|
1036
|
+
"name": "Buttonsimple",
|
|
1037
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1038
|
+
}
|
|
1039
|
+
},
|
|
1040
|
+
{
|
|
1041
|
+
"description": "Background color of the button",
|
|
1042
|
+
"name": "--mdc-button-background",
|
|
1043
|
+
"inheritedFrom": {
|
|
1044
|
+
"name": "Buttonsimple",
|
|
1045
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1046
|
+
}
|
|
1047
|
+
},
|
|
1048
|
+
{
|
|
1049
|
+
"description": "Borer color of the button",
|
|
1050
|
+
"name": "--mdc-button-border-color",
|
|
1051
|
+
"inheritedFrom": {
|
|
1052
|
+
"name": "Buttonsimple",
|
|
1053
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1054
|
+
}
|
|
1055
|
+
},
|
|
1056
|
+
{
|
|
1057
|
+
"description": "Text color of the button",
|
|
1058
|
+
"name": "--mdc-button-text-color",
|
|
1059
|
+
"inheritedFrom": {
|
|
1060
|
+
"name": "Buttonsimple",
|
|
1061
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
1062
|
+
}
|
|
1063
|
+
}
|
|
1064
|
+
],
|
|
1065
|
+
"cssParts": [
|
|
1066
|
+
{
|
|
1067
|
+
"description": "The alert icon",
|
|
1068
|
+
"name": "icon"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"description": "The text label of the alertchip",
|
|
1072
|
+
"name": "label"
|
|
1073
|
+
}
|
|
1074
|
+
],
|
|
1075
|
+
"members": [
|
|
1076
|
+
{
|
|
1077
|
+
"kind": "field",
|
|
1078
|
+
"name": "variant",
|
|
1079
|
+
"type": {
|
|
1080
|
+
"text": "VariantType"
|
|
1081
|
+
},
|
|
1082
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
|
1083
|
+
"default": "neutral",
|
|
1084
|
+
"attribute": "variant",
|
|
1085
|
+
"reflects": true
|
|
1086
|
+
},
|
|
1087
|
+
{
|
|
1088
|
+
"kind": "field",
|
|
1089
|
+
"name": "label",
|
|
1090
|
+
"type": {
|
|
1091
|
+
"text": "string"
|
|
1092
|
+
},
|
|
1093
|
+
"default": "''",
|
|
1094
|
+
"description": "The visible label text of the alertchip.\n\nWe recommend limiting the <b>maximum length of the label text to 20 characters</b>,\nincluding empty spaces to split words.",
|
|
1095
|
+
"attribute": "label"
|
|
1096
|
+
},
|
|
1097
|
+
{
|
|
1098
|
+
"kind": "field",
|
|
1099
|
+
"name": "iconName",
|
|
1100
|
+
"type": {
|
|
1101
|
+
"text": "IconNames | undefined"
|
|
1102
|
+
},
|
|
1103
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
1104
|
+
"attribute": "icon-name",
|
|
1105
|
+
"inheritedFrom": {
|
|
1106
|
+
"name": "IconNameMixin",
|
|
1107
|
+
"module": "utils/mixins/IconNameMixin.js"
|
|
1108
|
+
}
|
|
1109
|
+
},
|
|
1110
|
+
{
|
|
1111
|
+
"kind": "field",
|
|
1112
|
+
"name": "autoFocusOnMount",
|
|
1113
|
+
"type": {
|
|
1114
|
+
"text": "boolean"
|
|
1115
|
+
},
|
|
1116
|
+
"default": "false",
|
|
1117
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
1118
|
+
"attribute": "auto-focus-on-mount",
|
|
1119
|
+
"reflects": true,
|
|
1120
|
+
"inheritedFrom": {
|
|
1121
|
+
"name": "AutoFocusOnMountMixin",
|
|
1122
1122
|
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
1123
1123
|
}
|
|
1124
1124
|
},
|
|
@@ -3292,53 +3292,108 @@
|
|
|
3292
3292
|
},
|
|
3293
3293
|
{
|
|
3294
3294
|
"kind": "javascript-module",
|
|
3295
|
-
"path": "components/
|
|
3295
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
|
3296
3296
|
"declarations": [
|
|
3297
3297
|
{
|
|
3298
3298
|
"kind": "class",
|
|
3299
|
-
"description": "The `mdc-
|
|
3300
|
-
"name": "
|
|
3299
|
+
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
|
3300
|
+
"name": "AvatarButton",
|
|
3301
3301
|
"cssProperties": [
|
|
3302
3302
|
{
|
|
3303
|
-
"description": "
|
|
3304
|
-
"name": "--mdc-
|
|
3303
|
+
"description": "Background color of the overlay in rest state",
|
|
3304
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
|
3305
3305
|
},
|
|
3306
3306
|
{
|
|
3307
|
-
"description": "
|
|
3308
|
-
"name": "--mdc-
|
|
3307
|
+
"description": "Background color of the overlay in hover state",
|
|
3308
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
|
3309
3309
|
},
|
|
3310
3310
|
{
|
|
3311
|
-
"description": "
|
|
3312
|
-
"name": "--mdc-
|
|
3311
|
+
"description": "Background color of the overlay in active state",
|
|
3312
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
|
3313
3313
|
},
|
|
3314
3314
|
{
|
|
3315
|
-
"description": "
|
|
3316
|
-
"name": "--mdc-
|
|
3315
|
+
"description": "Height for button size",
|
|
3316
|
+
"name": "--mdc-button-height",
|
|
3317
|
+
"inheritedFrom": {
|
|
3318
|
+
"name": "Buttonsimple",
|
|
3319
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3320
|
+
}
|
|
3317
3321
|
},
|
|
3318
3322
|
{
|
|
3319
|
-
"description": "
|
|
3320
|
-
"name": "--mdc-
|
|
3321
|
-
|
|
3322
|
-
|
|
3323
|
-
|
|
3324
|
-
|
|
3325
|
-
"description": "The photo of the avatar.",
|
|
3326
|
-
"name": "photo"
|
|
3323
|
+
"description": "Background color of the button",
|
|
3324
|
+
"name": "--mdc-button-background",
|
|
3325
|
+
"inheritedFrom": {
|
|
3326
|
+
"name": "Buttonsimple",
|
|
3327
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3328
|
+
}
|
|
3327
3329
|
},
|
|
3328
3330
|
{
|
|
3329
|
-
"description": "
|
|
3331
|
+
"description": "Borer color of the button",
|
|
3332
|
+
"name": "--mdc-button-border-color",
|
|
3333
|
+
"inheritedFrom": {
|
|
3334
|
+
"name": "Buttonsimple",
|
|
3335
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3336
|
+
}
|
|
3337
|
+
},
|
|
3338
|
+
{
|
|
3339
|
+
"description": "Text color of the button",
|
|
3340
|
+
"name": "--mdc-button-text-color",
|
|
3341
|
+
"inheritedFrom": {
|
|
3342
|
+
"name": "Buttonsimple",
|
|
3343
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3344
|
+
}
|
|
3345
|
+
}
|
|
3346
|
+
],
|
|
3347
|
+
"cssParts": [
|
|
3348
|
+
{
|
|
3349
|
+
"description": "The overlay part of the avatar button.",
|
|
3350
|
+
"name": "overlay"
|
|
3351
|
+
},
|
|
3352
|
+
{
|
|
3353
|
+
"description": "The main content of the avatar.",
|
|
3354
|
+
"name": "content"
|
|
3355
|
+
},
|
|
3356
|
+
{
|
|
3357
|
+
"description": "The photo part of the avatar.",
|
|
3358
|
+
"name": "photo"
|
|
3359
|
+
},
|
|
3360
|
+
{
|
|
3361
|
+
"description": "The presence indicator part of the avatar.",
|
|
3330
3362
|
"name": "presence"
|
|
3331
3363
|
},
|
|
3332
3364
|
{
|
|
3333
|
-
"description": "The wrapper for the loading indicator.",
|
|
3365
|
+
"description": "The wrapper for the loading indicator of the avatar.",
|
|
3334
3366
|
"name": "loading-wrapper"
|
|
3335
3367
|
},
|
|
3336
3368
|
{
|
|
3337
|
-
"description": "The loading indicator of the avatar.",
|
|
3369
|
+
"description": "The loading indicator part of the avatar.",
|
|
3338
3370
|
"name": "loader"
|
|
3339
3371
|
}
|
|
3340
3372
|
],
|
|
3341
3373
|
"members": [
|
|
3374
|
+
{
|
|
3375
|
+
"kind": "field",
|
|
3376
|
+
"name": "ariaLabel",
|
|
3377
|
+
"type": {
|
|
3378
|
+
"text": "string | null"
|
|
3379
|
+
},
|
|
3380
|
+
"default": "null",
|
|
3381
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
3382
|
+
"attribute": "aria-label"
|
|
3383
|
+
},
|
|
3384
|
+
{
|
|
3385
|
+
"kind": "method",
|
|
3386
|
+
"name": "setSize",
|
|
3387
|
+
"privacy": "private",
|
|
3388
|
+
"parameters": [
|
|
3389
|
+
{
|
|
3390
|
+
"name": "size",
|
|
3391
|
+
"type": {
|
|
3392
|
+
"text": "AvatarSize"
|
|
3393
|
+
}
|
|
3394
|
+
}
|
|
3395
|
+
]
|
|
3396
|
+
},
|
|
3342
3397
|
{
|
|
3343
3398
|
"kind": "field",
|
|
3344
3399
|
"name": "src",
|
|
@@ -3382,15 +3437,15 @@
|
|
|
3382
3437
|
"kind": "field",
|
|
3383
3438
|
"name": "size",
|
|
3384
3439
|
"type": {
|
|
3385
|
-
"text": "
|
|
3440
|
+
"text": "ButtonSize"
|
|
3386
3441
|
},
|
|
3387
3442
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3388
3443
|
"default": "32",
|
|
3389
3444
|
"attribute": "size",
|
|
3390
3445
|
"reflects": true,
|
|
3391
3446
|
"inheritedFrom": {
|
|
3392
|
-
"name": "
|
|
3393
|
-
"module": "
|
|
3447
|
+
"name": "Buttonsimple",
|
|
3448
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3394
3449
|
}
|
|
3395
3450
|
},
|
|
3396
3451
|
{
|
|
@@ -3432,899 +3487,844 @@
|
|
|
3432
3487
|
"name": "IconNameMixin",
|
|
3433
3488
|
"module": "utils/mixins/IconNameMixin.js"
|
|
3434
3489
|
}
|
|
3435
|
-
}
|
|
3436
|
-
],
|
|
3437
|
-
"mixins": [
|
|
3438
|
-
{
|
|
3439
|
-
"name": "AvatarComponentMixin",
|
|
3440
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
3441
3490
|
},
|
|
3442
3491
|
{
|
|
3443
|
-
"
|
|
3444
|
-
"
|
|
3445
|
-
}
|
|
3446
|
-
],
|
|
3447
|
-
"superclass": {
|
|
3448
|
-
"name": "Component",
|
|
3449
|
-
"module": "/src/models"
|
|
3450
|
-
},
|
|
3451
|
-
"tagName": "mdc-avatar",
|
|
3452
|
-
"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 *\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
|
3453
|
-
"customElement": true,
|
|
3454
|
-
"attributes": [
|
|
3455
|
-
{
|
|
3456
|
-
"name": "src",
|
|
3492
|
+
"kind": "field",
|
|
3493
|
+
"name": "autoFocusOnMount",
|
|
3457
3494
|
"type": {
|
|
3458
|
-
"text": "
|
|
3495
|
+
"text": "boolean"
|
|
3459
3496
|
},
|
|
3460
|
-
"
|
|
3461
|
-
"
|
|
3497
|
+
"default": "false",
|
|
3498
|
+
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
3499
|
+
"attribute": "auto-focus-on-mount",
|
|
3500
|
+
"reflects": true,
|
|
3462
3501
|
"inheritedFrom": {
|
|
3463
|
-
"name": "
|
|
3464
|
-
"module": "
|
|
3502
|
+
"name": "AutoFocusOnMountMixin",
|
|
3503
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
3465
3504
|
}
|
|
3466
3505
|
},
|
|
3467
3506
|
{
|
|
3468
|
-
"
|
|
3507
|
+
"kind": "field",
|
|
3508
|
+
"name": "tabIndex",
|
|
3469
3509
|
"type": {
|
|
3470
|
-
"text": "
|
|
3510
|
+
"text": "number"
|
|
3471
3511
|
},
|
|
3472
|
-
"
|
|
3473
|
-
"
|
|
3512
|
+
"default": "0",
|
|
3513
|
+
"description": "This property specifies the tab order of the element.",
|
|
3514
|
+
"attribute": "tabIndex",
|
|
3515
|
+
"reflects": true,
|
|
3474
3516
|
"inheritedFrom": {
|
|
3475
|
-
"name": "
|
|
3476
|
-
"module": "
|
|
3517
|
+
"name": "TabIndexMixin",
|
|
3518
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
3477
3519
|
}
|
|
3478
3520
|
},
|
|
3479
3521
|
{
|
|
3480
|
-
"
|
|
3522
|
+
"kind": "field",
|
|
3523
|
+
"name": "disabled",
|
|
3481
3524
|
"type": {
|
|
3482
|
-
"text": "
|
|
3525
|
+
"text": "boolean | undefined"
|
|
3483
3526
|
},
|
|
3484
|
-
"description": "
|
|
3485
|
-
"
|
|
3527
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
3528
|
+
"default": "undefined",
|
|
3529
|
+
"attribute": "disabled",
|
|
3530
|
+
"reflects": true,
|
|
3486
3531
|
"inheritedFrom": {
|
|
3487
|
-
"name": "
|
|
3488
|
-
"module": "
|
|
3532
|
+
"name": "DisabledMixin",
|
|
3533
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
3489
3534
|
}
|
|
3490
3535
|
},
|
|
3491
3536
|
{
|
|
3492
|
-
"
|
|
3537
|
+
"kind": "field",
|
|
3538
|
+
"name": "active",
|
|
3493
3539
|
"type": {
|
|
3494
|
-
"text": "
|
|
3540
|
+
"text": "boolean | undefined"
|
|
3495
3541
|
},
|
|
3496
|
-
"description": "
|
|
3497
|
-
"default": "
|
|
3498
|
-
"
|
|
3542
|
+
"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.",
|
|
3543
|
+
"default": "undefined",
|
|
3544
|
+
"attribute": "active",
|
|
3545
|
+
"reflects": true,
|
|
3499
3546
|
"inheritedFrom": {
|
|
3500
|
-
"name": "
|
|
3501
|
-
"module": "
|
|
3547
|
+
"name": "Buttonsimple",
|
|
3548
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3502
3549
|
}
|
|
3503
3550
|
},
|
|
3504
3551
|
{
|
|
3505
|
-
"
|
|
3552
|
+
"kind": "field",
|
|
3553
|
+
"name": "softDisabled",
|
|
3506
3554
|
"type": {
|
|
3507
|
-
"text": "
|
|
3555
|
+
"text": "boolean | undefined"
|
|
3508
3556
|
},
|
|
3509
|
-
"description": "
|
|
3510
|
-
"
|
|
3557
|
+
"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.",
|
|
3558
|
+
"default": "undefined",
|
|
3559
|
+
"attribute": "soft-disabled",
|
|
3560
|
+
"reflects": true,
|
|
3511
3561
|
"inheritedFrom": {
|
|
3512
|
-
"name": "
|
|
3513
|
-
"module": "
|
|
3562
|
+
"name": "Buttonsimple",
|
|
3563
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3514
3564
|
}
|
|
3515
3565
|
},
|
|
3516
3566
|
{
|
|
3517
|
-
"
|
|
3567
|
+
"kind": "field",
|
|
3568
|
+
"name": "role",
|
|
3518
3569
|
"type": {
|
|
3519
|
-
"text": "
|
|
3570
|
+
"text": "RoleType"
|
|
3520
3571
|
},
|
|
3521
|
-
"
|
|
3522
|
-
"
|
|
3523
|
-
"
|
|
3572
|
+
"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.",
|
|
3573
|
+
"default": "button",
|
|
3574
|
+
"attribute": "role",
|
|
3575
|
+
"reflects": true,
|
|
3524
3576
|
"inheritedFrom": {
|
|
3525
|
-
"name": "
|
|
3526
|
-
"module": "
|
|
3577
|
+
"name": "Buttonsimple",
|
|
3578
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3527
3579
|
}
|
|
3528
3580
|
},
|
|
3529
3581
|
{
|
|
3530
|
-
"
|
|
3582
|
+
"kind": "field",
|
|
3583
|
+
"name": "ariaStateKey",
|
|
3531
3584
|
"type": {
|
|
3532
|
-
"text": "
|
|
3585
|
+
"text": "string | undefined"
|
|
3533
3586
|
},
|
|
3534
|
-
"description": "
|
|
3535
|
-
"
|
|
3587
|
+
"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`",
|
|
3588
|
+
"default": "'aria-pressed' (when)",
|
|
3589
|
+
"attribute": "ariaStateKey",
|
|
3590
|
+
"reflects": true,
|
|
3536
3591
|
"inheritedFrom": {
|
|
3537
|
-
"name": "
|
|
3538
|
-
"module": "
|
|
3592
|
+
"name": "Buttonsimple",
|
|
3593
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3539
3594
|
}
|
|
3540
|
-
}
|
|
3541
|
-
]
|
|
3542
|
-
}
|
|
3543
|
-
],
|
|
3544
|
-
"exports": [
|
|
3545
|
-
{
|
|
3546
|
-
"kind": "js",
|
|
3547
|
-
"name": "default",
|
|
3548
|
-
"declaration": {
|
|
3549
|
-
"name": "Avatar",
|
|
3550
|
-
"module": "components/avatar/avatar.component.js"
|
|
3551
|
-
}
|
|
3552
|
-
}
|
|
3553
|
-
]
|
|
3554
|
-
},
|
|
3555
|
-
{
|
|
3556
|
-
"kind": "javascript-module",
|
|
3557
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
|
3558
|
-
"declarations": [
|
|
3559
|
-
{
|
|
3560
|
-
"kind": "class",
|
|
3561
|
-
"description": "The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n\nThis component is made by extending `buttonsimple` class.\nThe button component acts as a wrapper for the avatar component.\n\nTo override styles of the avatar inside, use the specified css parts.",
|
|
3562
|
-
"name": "AvatarButton",
|
|
3563
|
-
"cssProperties": [
|
|
3564
|
-
{
|
|
3565
|
-
"description": "Background color of the overlay in rest state",
|
|
3566
|
-
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
|
3567
|
-
},
|
|
3568
|
-
{
|
|
3569
|
-
"description": "Background color of the overlay in hover state",
|
|
3570
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
|
3571
|
-
},
|
|
3572
|
-
{
|
|
3573
|
-
"description": "Background color of the overlay in active state",
|
|
3574
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
|
3575
3595
|
},
|
|
3576
3596
|
{
|
|
3577
|
-
"
|
|
3578
|
-
"name": "
|
|
3597
|
+
"kind": "field",
|
|
3598
|
+
"name": "type",
|
|
3599
|
+
"type": {
|
|
3600
|
+
"text": "ButtonType"
|
|
3601
|
+
},
|
|
3602
|
+
"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.",
|
|
3603
|
+
"default": "button",
|
|
3604
|
+
"attribute": "type",
|
|
3605
|
+
"reflects": true,
|
|
3579
3606
|
"inheritedFrom": {
|
|
3580
3607
|
"name": "Buttonsimple",
|
|
3581
|
-
"module": "
|
|
3608
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3582
3609
|
}
|
|
3583
3610
|
},
|
|
3584
3611
|
{
|
|
3585
|
-
"
|
|
3586
|
-
"name": "
|
|
3612
|
+
"kind": "field",
|
|
3613
|
+
"name": "name",
|
|
3614
|
+
"type": {
|
|
3615
|
+
"text": "string | undefined"
|
|
3616
|
+
},
|
|
3617
|
+
"description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
|
|
3618
|
+
"attribute": "name",
|
|
3619
|
+
"reflects": true,
|
|
3587
3620
|
"inheritedFrom": {
|
|
3588
3621
|
"name": "Buttonsimple",
|
|
3589
|
-
"module": "
|
|
3622
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3590
3623
|
}
|
|
3591
3624
|
},
|
|
3592
3625
|
{
|
|
3593
|
-
"
|
|
3594
|
-
"name": "
|
|
3595
|
-
"
|
|
3596
|
-
"
|
|
3597
|
-
|
|
3626
|
+
"kind": "field",
|
|
3627
|
+
"name": "value",
|
|
3628
|
+
"type": {
|
|
3629
|
+
"text": "string | undefined"
|
|
3630
|
+
},
|
|
3631
|
+
"description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
|
|
3632
|
+
"attribute": "value",
|
|
3633
|
+
"reflects": true,
|
|
3634
|
+
"inheritedFrom": {
|
|
3635
|
+
"name": "Buttonsimple",
|
|
3636
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3598
3637
|
}
|
|
3599
3638
|
},
|
|
3600
3639
|
{
|
|
3601
|
-
"
|
|
3602
|
-
"name": "
|
|
3640
|
+
"kind": "method",
|
|
3641
|
+
"name": "executeAction",
|
|
3642
|
+
"privacy": "protected",
|
|
3603
3643
|
"inheritedFrom": {
|
|
3604
3644
|
"name": "Buttonsimple",
|
|
3605
|
-
"module": "
|
|
3645
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3606
3646
|
}
|
|
3607
|
-
}
|
|
3608
|
-
],
|
|
3609
|
-
"cssParts": [
|
|
3610
|
-
{
|
|
3611
|
-
"description": "The overlay part of the avatar button.",
|
|
3612
|
-
"name": "overlay"
|
|
3613
3647
|
},
|
|
3614
3648
|
{
|
|
3615
|
-
"
|
|
3616
|
-
"name": "
|
|
3649
|
+
"kind": "method",
|
|
3650
|
+
"name": "setActive",
|
|
3651
|
+
"privacy": "protected",
|
|
3652
|
+
"parameters": [
|
|
3653
|
+
{
|
|
3654
|
+
"name": "element",
|
|
3655
|
+
"type": {
|
|
3656
|
+
"text": "HTMLElement"
|
|
3657
|
+
},
|
|
3658
|
+
"description": "The button element"
|
|
3659
|
+
},
|
|
3660
|
+
{
|
|
3661
|
+
"name": "active",
|
|
3662
|
+
"optional": true,
|
|
3663
|
+
"type": {
|
|
3664
|
+
"text": "boolean"
|
|
3665
|
+
},
|
|
3666
|
+
"description": "The active state of the element"
|
|
3667
|
+
}
|
|
3668
|
+
],
|
|
3669
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
|
3670
|
+
"inheritedFrom": {
|
|
3671
|
+
"name": "Buttonsimple",
|
|
3672
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3673
|
+
}
|
|
3617
3674
|
},
|
|
3618
3675
|
{
|
|
3619
|
-
"
|
|
3620
|
-
"name": "
|
|
3676
|
+
"kind": "method",
|
|
3677
|
+
"name": "setSoftDisabled",
|
|
3678
|
+
"privacy": "private",
|
|
3679
|
+
"parameters": [
|
|
3680
|
+
{
|
|
3681
|
+
"name": "element",
|
|
3682
|
+
"type": {
|
|
3683
|
+
"text": "HTMLElement"
|
|
3684
|
+
},
|
|
3685
|
+
"description": "The button element."
|
|
3686
|
+
},
|
|
3687
|
+
{
|
|
3688
|
+
"name": "softDisabled",
|
|
3689
|
+
"optional": true,
|
|
3690
|
+
"type": {
|
|
3691
|
+
"text": "boolean"
|
|
3692
|
+
},
|
|
3693
|
+
"description": "The soft-disabled state."
|
|
3694
|
+
}
|
|
3695
|
+
],
|
|
3696
|
+
"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.",
|
|
3697
|
+
"inheritedFrom": {
|
|
3698
|
+
"name": "Buttonsimple",
|
|
3699
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3700
|
+
}
|
|
3621
3701
|
},
|
|
3622
3702
|
{
|
|
3623
|
-
"
|
|
3624
|
-
"name": "
|
|
3703
|
+
"kind": "method",
|
|
3704
|
+
"name": "setDisabled",
|
|
3705
|
+
"privacy": "private",
|
|
3706
|
+
"parameters": [
|
|
3707
|
+
{
|
|
3708
|
+
"name": "element",
|
|
3709
|
+
"type": {
|
|
3710
|
+
"text": "HTMLElement"
|
|
3711
|
+
},
|
|
3712
|
+
"description": "The button element."
|
|
3713
|
+
},
|
|
3714
|
+
{
|
|
3715
|
+
"name": "disabled",
|
|
3716
|
+
"type": {
|
|
3717
|
+
"text": "boolean"
|
|
3718
|
+
},
|
|
3719
|
+
"description": "The disabled state."
|
|
3720
|
+
}
|
|
3721
|
+
],
|
|
3722
|
+
"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.",
|
|
3723
|
+
"inheritedFrom": {
|
|
3724
|
+
"name": "Buttonsimple",
|
|
3725
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3726
|
+
}
|
|
3625
3727
|
},
|
|
3626
3728
|
{
|
|
3627
|
-
"
|
|
3628
|
-
"name": "
|
|
3729
|
+
"kind": "method",
|
|
3730
|
+
"name": "triggerClickEvent",
|
|
3731
|
+
"privacy": "private",
|
|
3732
|
+
"inheritedFrom": {
|
|
3733
|
+
"name": "Buttonsimple",
|
|
3734
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3735
|
+
}
|
|
3629
3736
|
},
|
|
3630
3737
|
{
|
|
3631
|
-
"
|
|
3632
|
-
"name": "
|
|
3633
|
-
|
|
3634
|
-
|
|
3635
|
-
|
|
3738
|
+
"kind": "method",
|
|
3739
|
+
"name": "handleBlur",
|
|
3740
|
+
"privacy": "private",
|
|
3741
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
|
3742
|
+
"inheritedFrom": {
|
|
3743
|
+
"name": "Buttonsimple",
|
|
3744
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3745
|
+
}
|
|
3746
|
+
},
|
|
3636
3747
|
{
|
|
3637
|
-
"kind": "
|
|
3638
|
-
"name": "
|
|
3639
|
-
"
|
|
3640
|
-
|
|
3641
|
-
|
|
3642
|
-
|
|
3643
|
-
|
|
3644
|
-
|
|
3748
|
+
"kind": "method",
|
|
3749
|
+
"name": "handleKeyDown",
|
|
3750
|
+
"privacy": "private",
|
|
3751
|
+
"parameters": [
|
|
3752
|
+
{
|
|
3753
|
+
"name": "event",
|
|
3754
|
+
"type": {
|
|
3755
|
+
"text": "KeyboardEvent"
|
|
3756
|
+
},
|
|
3757
|
+
"description": "The keyboard event."
|
|
3758
|
+
}
|
|
3759
|
+
],
|
|
3760
|
+
"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.",
|
|
3761
|
+
"inheritedFrom": {
|
|
3762
|
+
"name": "Buttonsimple",
|
|
3763
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3764
|
+
}
|
|
3645
3765
|
},
|
|
3646
3766
|
{
|
|
3647
3767
|
"kind": "method",
|
|
3648
|
-
"name": "
|
|
3768
|
+
"name": "handleKeyUp",
|
|
3649
3769
|
"privacy": "private",
|
|
3650
3770
|
"parameters": [
|
|
3651
3771
|
{
|
|
3652
|
-
"name": "
|
|
3772
|
+
"name": "event",
|
|
3653
3773
|
"type": {
|
|
3654
|
-
"text": "
|
|
3655
|
-
}
|
|
3774
|
+
"text": "KeyboardEvent"
|
|
3775
|
+
},
|
|
3776
|
+
"description": "The keyboard event."
|
|
3656
3777
|
}
|
|
3657
|
-
]
|
|
3778
|
+
],
|
|
3779
|
+
"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.",
|
|
3780
|
+
"inheritedFrom": {
|
|
3781
|
+
"name": "Buttonsimple",
|
|
3782
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3783
|
+
}
|
|
3784
|
+
}
|
|
3785
|
+
],
|
|
3786
|
+
"events": [
|
|
3787
|
+
{
|
|
3788
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
|
3789
|
+
"name": "click",
|
|
3790
|
+
"reactName": "onClick",
|
|
3791
|
+
"inheritedFrom": {
|
|
3792
|
+
"name": "Buttonsimple",
|
|
3793
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3794
|
+
}
|
|
3795
|
+
},
|
|
3796
|
+
{
|
|
3797
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
|
3798
|
+
"name": "keydown",
|
|
3799
|
+
"reactName": "onKeyDown",
|
|
3800
|
+
"inheritedFrom": {
|
|
3801
|
+
"name": "Buttonsimple",
|
|
3802
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3803
|
+
}
|
|
3804
|
+
},
|
|
3805
|
+
{
|
|
3806
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
|
3807
|
+
"name": "keyup",
|
|
3808
|
+
"reactName": "onKeyUp",
|
|
3809
|
+
"inheritedFrom": {
|
|
3810
|
+
"name": "Buttonsimple",
|
|
3811
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3812
|
+
}
|
|
3813
|
+
},
|
|
3814
|
+
{
|
|
3815
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
|
3816
|
+
"name": "focus",
|
|
3817
|
+
"reactName": "onFocus",
|
|
3818
|
+
"inheritedFrom": {
|
|
3819
|
+
"name": "Buttonsimple",
|
|
3820
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3821
|
+
}
|
|
3822
|
+
}
|
|
3823
|
+
],
|
|
3824
|
+
"attributes": [
|
|
3825
|
+
{
|
|
3826
|
+
"name": "aria-label",
|
|
3827
|
+
"type": {
|
|
3828
|
+
"text": "string | null"
|
|
3829
|
+
},
|
|
3830
|
+
"default": "null",
|
|
3831
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
3832
|
+
"fieldName": "ariaLabel"
|
|
3658
3833
|
},
|
|
3659
3834
|
{
|
|
3660
|
-
"kind": "field",
|
|
3661
3835
|
"name": "src",
|
|
3662
3836
|
"type": {
|
|
3663
3837
|
"text": "string | undefined"
|
|
3664
3838
|
},
|
|
3665
3839
|
"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.",
|
|
3666
|
-
"
|
|
3840
|
+
"fieldName": "src",
|
|
3667
3841
|
"inheritedFrom": {
|
|
3668
3842
|
"name": "AvatarComponentMixin",
|
|
3669
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
3843
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3670
3844
|
}
|
|
3671
3845
|
},
|
|
3672
3846
|
{
|
|
3673
|
-
"kind": "field",
|
|
3674
3847
|
"name": "initials",
|
|
3675
3848
|
"type": {
|
|
3676
3849
|
"text": "string | undefined"
|
|
3677
3850
|
},
|
|
3678
3851
|
"description": "The initials to be displayed for the avatar.",
|
|
3679
|
-
"
|
|
3852
|
+
"fieldName": "initials",
|
|
3680
3853
|
"inheritedFrom": {
|
|
3681
3854
|
"name": "AvatarComponentMixin",
|
|
3682
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
3855
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3683
3856
|
}
|
|
3684
3857
|
},
|
|
3685
3858
|
{
|
|
3686
|
-
"kind": "field",
|
|
3687
3859
|
"name": "presence",
|
|
3688
3860
|
"type": {
|
|
3689
3861
|
"text": "PresenceType | undefined"
|
|
3690
3862
|
},
|
|
3691
3863
|
"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`",
|
|
3692
|
-
"
|
|
3864
|
+
"fieldName": "presence",
|
|
3693
3865
|
"inheritedFrom": {
|
|
3694
3866
|
"name": "AvatarComponentMixin",
|
|
3695
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
3867
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3696
3868
|
}
|
|
3697
3869
|
},
|
|
3698
3870
|
{
|
|
3699
|
-
"kind": "field",
|
|
3700
3871
|
"name": "size",
|
|
3701
3872
|
"type": {
|
|
3702
3873
|
"text": "ButtonSize"
|
|
3703
3874
|
},
|
|
3704
3875
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3705
3876
|
"default": "32",
|
|
3706
|
-
"
|
|
3707
|
-
"reflects": true,
|
|
3877
|
+
"fieldName": "size",
|
|
3708
3878
|
"inheritedFrom": {
|
|
3709
3879
|
"name": "Buttonsimple",
|
|
3710
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3880
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3711
3881
|
}
|
|
3712
3882
|
},
|
|
3713
3883
|
{
|
|
3714
|
-
"kind": "field",
|
|
3715
3884
|
"name": "counter",
|
|
3716
3885
|
"type": {
|
|
3717
3886
|
"text": "number | undefined"
|
|
3718
3887
|
},
|
|
3719
3888
|
"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`.",
|
|
3720
|
-
"
|
|
3889
|
+
"fieldName": "counter",
|
|
3721
3890
|
"inheritedFrom": {
|
|
3722
3891
|
"name": "AvatarComponentMixin",
|
|
3723
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
3892
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3724
3893
|
}
|
|
3725
3894
|
},
|
|
3726
3895
|
{
|
|
3727
|
-
"
|
|
3728
|
-
"name": "isTyping",
|
|
3896
|
+
"name": "is-typing",
|
|
3729
3897
|
"type": {
|
|
3730
3898
|
"text": "boolean"
|
|
3731
3899
|
},
|
|
3732
3900
|
"default": "false",
|
|
3733
3901
|
"description": "Represents the typing indicator when the user is typing.",
|
|
3734
|
-
"
|
|
3902
|
+
"fieldName": "isTyping",
|
|
3735
3903
|
"inheritedFrom": {
|
|
3736
3904
|
"name": "AvatarComponentMixin",
|
|
3737
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
3905
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3738
3906
|
}
|
|
3739
3907
|
},
|
|
3740
3908
|
{
|
|
3741
|
-
"
|
|
3742
|
-
"name": "iconName",
|
|
3909
|
+
"name": "icon-name",
|
|
3743
3910
|
"type": {
|
|
3744
3911
|
"text": "IconNames | undefined"
|
|
3745
3912
|
},
|
|
3746
3913
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
3747
|
-
"
|
|
3914
|
+
"fieldName": "iconName",
|
|
3748
3915
|
"inheritedFrom": {
|
|
3749
3916
|
"name": "IconNameMixin",
|
|
3750
|
-
"module": "utils/mixins/IconNameMixin.
|
|
3917
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
3751
3918
|
}
|
|
3752
3919
|
},
|
|
3753
3920
|
{
|
|
3754
|
-
"
|
|
3755
|
-
"name": "autoFocusOnMount",
|
|
3921
|
+
"name": "auto-focus-on-mount",
|
|
3756
3922
|
"type": {
|
|
3757
3923
|
"text": "boolean"
|
|
3758
3924
|
},
|
|
3759
3925
|
"default": "false",
|
|
3760
3926
|
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
3761
|
-
"
|
|
3762
|
-
"reflects": true,
|
|
3927
|
+
"fieldName": "autoFocusOnMount",
|
|
3763
3928
|
"inheritedFrom": {
|
|
3764
3929
|
"name": "AutoFocusOnMountMixin",
|
|
3765
|
-
"module": "utils/mixins/AutoFocusOnMountMixin.
|
|
3930
|
+
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
|
3766
3931
|
}
|
|
3767
3932
|
},
|
|
3768
3933
|
{
|
|
3769
|
-
"kind": "field",
|
|
3770
3934
|
"name": "tabIndex",
|
|
3771
3935
|
"type": {
|
|
3772
3936
|
"text": "number"
|
|
3773
3937
|
},
|
|
3774
3938
|
"default": "0",
|
|
3775
3939
|
"description": "This property specifies the tab order of the element.",
|
|
3776
|
-
"
|
|
3777
|
-
"reflects": true,
|
|
3940
|
+
"fieldName": "tabIndex",
|
|
3778
3941
|
"inheritedFrom": {
|
|
3779
3942
|
"name": "TabIndexMixin",
|
|
3780
|
-
"module": "utils/mixins/TabIndexMixin.
|
|
3943
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
3781
3944
|
}
|
|
3782
3945
|
},
|
|
3783
3946
|
{
|
|
3784
|
-
"kind": "field",
|
|
3785
3947
|
"name": "disabled",
|
|
3786
3948
|
"type": {
|
|
3787
3949
|
"text": "boolean | undefined"
|
|
3788
3950
|
},
|
|
3789
3951
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
3790
3952
|
"default": "undefined",
|
|
3791
|
-
"
|
|
3792
|
-
"reflects": true,
|
|
3953
|
+
"fieldName": "disabled",
|
|
3793
3954
|
"inheritedFrom": {
|
|
3794
3955
|
"name": "DisabledMixin",
|
|
3795
|
-
"module": "utils/mixins/DisabledMixin.
|
|
3956
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
3796
3957
|
}
|
|
3797
3958
|
},
|
|
3798
3959
|
{
|
|
3799
|
-
"kind": "field",
|
|
3800
3960
|
"name": "active",
|
|
3801
3961
|
"type": {
|
|
3802
3962
|
"text": "boolean | undefined"
|
|
3803
3963
|
},
|
|
3804
3964
|
"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.",
|
|
3805
3965
|
"default": "undefined",
|
|
3806
|
-
"
|
|
3807
|
-
"reflects": true,
|
|
3966
|
+
"fieldName": "active",
|
|
3808
3967
|
"inheritedFrom": {
|
|
3809
3968
|
"name": "Buttonsimple",
|
|
3810
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3969
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3811
3970
|
}
|
|
3812
3971
|
},
|
|
3813
3972
|
{
|
|
3814
|
-
"
|
|
3815
|
-
"name": "softDisabled",
|
|
3973
|
+
"name": "soft-disabled",
|
|
3816
3974
|
"type": {
|
|
3817
3975
|
"text": "boolean | undefined"
|
|
3818
3976
|
},
|
|
3819
3977
|
"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.",
|
|
3820
3978
|
"default": "undefined",
|
|
3821
|
-
"
|
|
3822
|
-
"reflects": true,
|
|
3979
|
+
"fieldName": "softDisabled",
|
|
3823
3980
|
"inheritedFrom": {
|
|
3824
3981
|
"name": "Buttonsimple",
|
|
3825
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3982
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3826
3983
|
}
|
|
3827
3984
|
},
|
|
3828
3985
|
{
|
|
3829
|
-
"kind": "field",
|
|
3830
3986
|
"name": "role",
|
|
3831
3987
|
"type": {
|
|
3832
3988
|
"text": "RoleType"
|
|
3833
3989
|
},
|
|
3834
3990
|
"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.",
|
|
3835
3991
|
"default": "button",
|
|
3836
|
-
"
|
|
3837
|
-
"reflects": true,
|
|
3992
|
+
"fieldName": "role",
|
|
3838
3993
|
"inheritedFrom": {
|
|
3839
3994
|
"name": "Buttonsimple",
|
|
3840
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3995
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3841
3996
|
}
|
|
3842
3997
|
},
|
|
3843
3998
|
{
|
|
3844
|
-
"kind": "field",
|
|
3845
3999
|
"name": "ariaStateKey",
|
|
3846
4000
|
"type": {
|
|
3847
4001
|
"text": "string | undefined"
|
|
3848
4002
|
},
|
|
3849
4003
|
"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`",
|
|
3850
4004
|
"default": "'aria-pressed' (when)",
|
|
3851
|
-
"
|
|
3852
|
-
"reflects": true,
|
|
4005
|
+
"fieldName": "ariaStateKey",
|
|
3853
4006
|
"inheritedFrom": {
|
|
3854
4007
|
"name": "Buttonsimple",
|
|
3855
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
4008
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3856
4009
|
}
|
|
3857
4010
|
},
|
|
3858
4011
|
{
|
|
3859
|
-
"kind": "field",
|
|
3860
4012
|
"name": "type",
|
|
3861
4013
|
"type": {
|
|
3862
4014
|
"text": "ButtonType"
|
|
3863
4015
|
},
|
|
3864
4016
|
"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.",
|
|
3865
4017
|
"default": "button",
|
|
3866
|
-
"
|
|
3867
|
-
"reflects": true,
|
|
4018
|
+
"fieldName": "type",
|
|
3868
4019
|
"inheritedFrom": {
|
|
3869
4020
|
"name": "Buttonsimple",
|
|
3870
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
4021
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3871
4022
|
}
|
|
3872
4023
|
},
|
|
3873
4024
|
{
|
|
3874
|
-
"kind": "field",
|
|
3875
4025
|
"name": "name",
|
|
3876
4026
|
"type": {
|
|
3877
4027
|
"text": "string | undefined"
|
|
3878
4028
|
},
|
|
3879
4029
|
"description": "The name of the button, submitted as a pair with the button's value as part of the form data,\nwhen that button is used to submit the form.",
|
|
3880
|
-
"
|
|
3881
|
-
"reflects": true,
|
|
4030
|
+
"fieldName": "name",
|
|
3882
4031
|
"inheritedFrom": {
|
|
3883
4032
|
"name": "Buttonsimple",
|
|
3884
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
4033
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3885
4034
|
}
|
|
3886
4035
|
},
|
|
3887
4036
|
{
|
|
3888
|
-
"kind": "field",
|
|
3889
4037
|
"name": "value",
|
|
3890
4038
|
"type": {
|
|
3891
4039
|
"text": "string | undefined"
|
|
3892
4040
|
},
|
|
3893
4041
|
"description": "Defines the value associated with the button's name when it's submitted with the form data.\nThis value is passed to the server in params when the form is submitted using this button.",
|
|
3894
|
-
"
|
|
3895
|
-
"reflects": true,
|
|
3896
|
-
"inheritedFrom": {
|
|
3897
|
-
"name": "Buttonsimple",
|
|
3898
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3899
|
-
}
|
|
3900
|
-
},
|
|
3901
|
-
{
|
|
3902
|
-
"kind": "method",
|
|
3903
|
-
"name": "executeAction",
|
|
3904
|
-
"privacy": "protected",
|
|
3905
|
-
"inheritedFrom": {
|
|
3906
|
-
"name": "Buttonsimple",
|
|
3907
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3908
|
-
}
|
|
3909
|
-
},
|
|
3910
|
-
{
|
|
3911
|
-
"kind": "method",
|
|
3912
|
-
"name": "setActive",
|
|
3913
|
-
"privacy": "protected",
|
|
3914
|
-
"parameters": [
|
|
3915
|
-
{
|
|
3916
|
-
"name": "element",
|
|
3917
|
-
"type": {
|
|
3918
|
-
"text": "HTMLElement"
|
|
3919
|
-
},
|
|
3920
|
-
"description": "The button element"
|
|
3921
|
-
},
|
|
3922
|
-
{
|
|
3923
|
-
"name": "active",
|
|
3924
|
-
"optional": true,
|
|
3925
|
-
"type": {
|
|
3926
|
-
"text": "boolean"
|
|
3927
|
-
},
|
|
3928
|
-
"description": "The active state of the element"
|
|
3929
|
-
}
|
|
3930
|
-
],
|
|
3931
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
|
3932
|
-
"inheritedFrom": {
|
|
3933
|
-
"name": "Buttonsimple",
|
|
3934
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3935
|
-
}
|
|
3936
|
-
},
|
|
3937
|
-
{
|
|
3938
|
-
"kind": "method",
|
|
3939
|
-
"name": "setSoftDisabled",
|
|
3940
|
-
"privacy": "private",
|
|
3941
|
-
"parameters": [
|
|
3942
|
-
{
|
|
3943
|
-
"name": "element",
|
|
3944
|
-
"type": {
|
|
3945
|
-
"text": "HTMLElement"
|
|
3946
|
-
},
|
|
3947
|
-
"description": "The button element."
|
|
3948
|
-
},
|
|
3949
|
-
{
|
|
3950
|
-
"name": "softDisabled",
|
|
3951
|
-
"optional": true,
|
|
3952
|
-
"type": {
|
|
3953
|
-
"text": "boolean"
|
|
3954
|
-
},
|
|
3955
|
-
"description": "The soft-disabled state."
|
|
3956
|
-
}
|
|
3957
|
-
],
|
|
3958
|
-
"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.",
|
|
3959
|
-
"inheritedFrom": {
|
|
3960
|
-
"name": "Buttonsimple",
|
|
3961
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3962
|
-
}
|
|
3963
|
-
},
|
|
3964
|
-
{
|
|
3965
|
-
"kind": "method",
|
|
3966
|
-
"name": "setDisabled",
|
|
3967
|
-
"privacy": "private",
|
|
3968
|
-
"parameters": [
|
|
3969
|
-
{
|
|
3970
|
-
"name": "element",
|
|
3971
|
-
"type": {
|
|
3972
|
-
"text": "HTMLElement"
|
|
3973
|
-
},
|
|
3974
|
-
"description": "The button element."
|
|
3975
|
-
},
|
|
3976
|
-
{
|
|
3977
|
-
"name": "disabled",
|
|
3978
|
-
"type": {
|
|
3979
|
-
"text": "boolean"
|
|
3980
|
-
},
|
|
3981
|
-
"description": "The disabled state."
|
|
3982
|
-
}
|
|
3983
|
-
],
|
|
3984
|
-
"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.",
|
|
3985
|
-
"inheritedFrom": {
|
|
3986
|
-
"name": "Buttonsimple",
|
|
3987
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3988
|
-
}
|
|
3989
|
-
},
|
|
3990
|
-
{
|
|
3991
|
-
"kind": "method",
|
|
3992
|
-
"name": "triggerClickEvent",
|
|
3993
|
-
"privacy": "private",
|
|
3994
|
-
"inheritedFrom": {
|
|
3995
|
-
"name": "Buttonsimple",
|
|
3996
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3997
|
-
}
|
|
3998
|
-
},
|
|
3999
|
-
{
|
|
4000
|
-
"kind": "method",
|
|
4001
|
-
"name": "handleBlur",
|
|
4002
|
-
"privacy": "private",
|
|
4003
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
|
4042
|
+
"fieldName": "value",
|
|
4004
4043
|
"inheritedFrom": {
|
|
4005
4044
|
"name": "Buttonsimple",
|
|
4006
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
4045
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4007
4046
|
}
|
|
4008
|
-
}
|
|
4047
|
+
}
|
|
4048
|
+
],
|
|
4049
|
+
"mixins": [
|
|
4009
4050
|
{
|
|
4010
|
-
"
|
|
4011
|
-
"
|
|
4012
|
-
"privacy": "private",
|
|
4013
|
-
"parameters": [
|
|
4014
|
-
{
|
|
4015
|
-
"name": "event",
|
|
4016
|
-
"type": {
|
|
4017
|
-
"text": "KeyboardEvent"
|
|
4018
|
-
},
|
|
4019
|
-
"description": "The keyboard event."
|
|
4020
|
-
}
|
|
4021
|
-
],
|
|
4022
|
-
"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.",
|
|
4023
|
-
"inheritedFrom": {
|
|
4024
|
-
"name": "Buttonsimple",
|
|
4025
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4026
|
-
}
|
|
4051
|
+
"name": "AvatarComponentMixin",
|
|
4052
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
4027
4053
|
},
|
|
4028
4054
|
{
|
|
4029
|
-
"
|
|
4030
|
-
"
|
|
4031
|
-
"privacy": "private",
|
|
4032
|
-
"parameters": [
|
|
4033
|
-
{
|
|
4034
|
-
"name": "event",
|
|
4035
|
-
"type": {
|
|
4036
|
-
"text": "KeyboardEvent"
|
|
4037
|
-
},
|
|
4038
|
-
"description": "The keyboard event."
|
|
4039
|
-
}
|
|
4040
|
-
],
|
|
4041
|
-
"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.",
|
|
4042
|
-
"inheritedFrom": {
|
|
4043
|
-
"name": "Buttonsimple",
|
|
4044
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4045
|
-
}
|
|
4055
|
+
"name": "IconNameMixin",
|
|
4056
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
|
4046
4057
|
}
|
|
4047
4058
|
],
|
|
4048
|
-
"
|
|
4059
|
+
"superclass": {
|
|
4060
|
+
"name": "Buttonsimple",
|
|
4061
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
|
4062
|
+
},
|
|
4063
|
+
"tagName": "mdc-avatarbutton",
|
|
4064
|
+
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * To override styles of the avatar inside, use the specified css parts.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
|
|
4065
|
+
"customElement": true
|
|
4066
|
+
}
|
|
4067
|
+
],
|
|
4068
|
+
"exports": [
|
|
4069
|
+
{
|
|
4070
|
+
"kind": "js",
|
|
4071
|
+
"name": "default",
|
|
4072
|
+
"declaration": {
|
|
4073
|
+
"name": "AvatarButton",
|
|
4074
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
|
4075
|
+
}
|
|
4076
|
+
}
|
|
4077
|
+
]
|
|
4078
|
+
},
|
|
4079
|
+
{
|
|
4080
|
+
"kind": "javascript-module",
|
|
4081
|
+
"path": "components/avatar/avatar.component.js",
|
|
4082
|
+
"declarations": [
|
|
4083
|
+
{
|
|
4084
|
+
"kind": "class",
|
|
4085
|
+
"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.",
|
|
4086
|
+
"name": "Avatar",
|
|
4087
|
+
"cssProperties": [
|
|
4049
4088
|
{
|
|
4050
|
-
"description": "
|
|
4051
|
-
"name": "
|
|
4052
|
-
"reactName": "onClick",
|
|
4053
|
-
"inheritedFrom": {
|
|
4054
|
-
"name": "Buttonsimple",
|
|
4055
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4056
|
-
}
|
|
4089
|
+
"description": "Allows customization of the default background color.",
|
|
4090
|
+
"name": "--mdc-avatar-default-background-color"
|
|
4057
4091
|
},
|
|
4058
4092
|
{
|
|
4059
|
-
"description": "
|
|
4060
|
-
"name": "
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
}
|
|
4093
|
+
"description": "Allows customization of the default foreground color.",
|
|
4094
|
+
"name": "--mdc-avatar-default-foreground-color"
|
|
4095
|
+
},
|
|
4096
|
+
{
|
|
4097
|
+
"description": "Allows customization of the loading indicator background color.",
|
|
4098
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
|
4066
4099
|
},
|
|
4067
4100
|
{
|
|
4068
|
-
"description": "
|
|
4069
|
-
"name": "
|
|
4070
|
-
"reactName": "onKeyUp",
|
|
4071
|
-
"inheritedFrom": {
|
|
4072
|
-
"name": "Buttonsimple",
|
|
4073
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4074
|
-
}
|
|
4101
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
|
4102
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
|
4075
4103
|
},
|
|
4076
4104
|
{
|
|
4077
|
-
"description": "
|
|
4078
|
-
"name": "
|
|
4079
|
-
"reactName": "onFocus",
|
|
4080
|
-
"inheritedFrom": {
|
|
4081
|
-
"name": "Buttonsimple",
|
|
4082
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4083
|
-
}
|
|
4105
|
+
"description": "Allows customization of the loading overlay background color.",
|
|
4106
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
|
4084
4107
|
}
|
|
4085
4108
|
],
|
|
4086
|
-
"
|
|
4109
|
+
"cssParts": [
|
|
4087
4110
|
{
|
|
4088
|
-
"
|
|
4089
|
-
"
|
|
4090
|
-
|
|
4091
|
-
|
|
4092
|
-
"
|
|
4093
|
-
"
|
|
4094
|
-
|
|
4111
|
+
"description": "The photo of the avatar.",
|
|
4112
|
+
"name": "photo"
|
|
4113
|
+
},
|
|
4114
|
+
{
|
|
4115
|
+
"description": "The presence indicator of the avatar.",
|
|
4116
|
+
"name": "presence"
|
|
4117
|
+
},
|
|
4118
|
+
{
|
|
4119
|
+
"description": "The wrapper for the loading indicator.",
|
|
4120
|
+
"name": "loading-wrapper"
|
|
4095
4121
|
},
|
|
4096
4122
|
{
|
|
4123
|
+
"description": "The loading indicator of the avatar.",
|
|
4124
|
+
"name": "loader"
|
|
4125
|
+
}
|
|
4126
|
+
],
|
|
4127
|
+
"members": [
|
|
4128
|
+
{
|
|
4129
|
+
"kind": "field",
|
|
4097
4130
|
"name": "src",
|
|
4098
4131
|
"type": {
|
|
4099
4132
|
"text": "string | undefined"
|
|
4100
4133
|
},
|
|
4101
4134
|
"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.",
|
|
4102
|
-
"
|
|
4135
|
+
"attribute": "src",
|
|
4103
4136
|
"inheritedFrom": {
|
|
4104
4137
|
"name": "AvatarComponentMixin",
|
|
4105
|
-
"module": "
|
|
4138
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
4106
4139
|
}
|
|
4107
4140
|
},
|
|
4108
4141
|
{
|
|
4142
|
+
"kind": "field",
|
|
4109
4143
|
"name": "initials",
|
|
4110
4144
|
"type": {
|
|
4111
4145
|
"text": "string | undefined"
|
|
4112
4146
|
},
|
|
4113
4147
|
"description": "The initials to be displayed for the avatar.",
|
|
4114
|
-
"
|
|
4148
|
+
"attribute": "initials",
|
|
4115
4149
|
"inheritedFrom": {
|
|
4116
4150
|
"name": "AvatarComponentMixin",
|
|
4117
|
-
"module": "
|
|
4151
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
4118
4152
|
}
|
|
4119
4153
|
},
|
|
4120
4154
|
{
|
|
4155
|
+
"kind": "field",
|
|
4121
4156
|
"name": "presence",
|
|
4122
4157
|
"type": {
|
|
4123
4158
|
"text": "PresenceType | undefined"
|
|
4124
4159
|
},
|
|
4125
4160
|
"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`",
|
|
4126
|
-
"
|
|
4161
|
+
"attribute": "presence",
|
|
4127
4162
|
"inheritedFrom": {
|
|
4128
4163
|
"name": "AvatarComponentMixin",
|
|
4129
|
-
"module": "
|
|
4164
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
4130
4165
|
}
|
|
4131
4166
|
},
|
|
4132
4167
|
{
|
|
4168
|
+
"kind": "field",
|
|
4133
4169
|
"name": "size",
|
|
4134
4170
|
"type": {
|
|
4135
|
-
"text": "
|
|
4171
|
+
"text": "AvatarSize"
|
|
4136
4172
|
},
|
|
4137
4173
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
4138
4174
|
"default": "32",
|
|
4139
|
-
"
|
|
4175
|
+
"attribute": "size",
|
|
4176
|
+
"reflects": true,
|
|
4140
4177
|
"inheritedFrom": {
|
|
4141
|
-
"name": "
|
|
4142
|
-
"module": "
|
|
4178
|
+
"name": "AvatarComponentMixin",
|
|
4179
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
4143
4180
|
}
|
|
4144
4181
|
},
|
|
4145
4182
|
{
|
|
4183
|
+
"kind": "field",
|
|
4146
4184
|
"name": "counter",
|
|
4147
4185
|
"type": {
|
|
4148
4186
|
"text": "number | undefined"
|
|
4149
4187
|
},
|
|
4150
4188
|
"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`.",
|
|
4151
|
-
"
|
|
4189
|
+
"attribute": "counter",
|
|
4152
4190
|
"inheritedFrom": {
|
|
4153
4191
|
"name": "AvatarComponentMixin",
|
|
4154
|
-
"module": "
|
|
4192
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
4155
4193
|
}
|
|
4156
4194
|
},
|
|
4157
4195
|
{
|
|
4158
|
-
"
|
|
4196
|
+
"kind": "field",
|
|
4197
|
+
"name": "isTyping",
|
|
4159
4198
|
"type": {
|
|
4160
4199
|
"text": "boolean"
|
|
4161
4200
|
},
|
|
4162
4201
|
"default": "false",
|
|
4163
4202
|
"description": "Represents the typing indicator when the user is typing.",
|
|
4164
|
-
"
|
|
4203
|
+
"attribute": "is-typing",
|
|
4165
4204
|
"inheritedFrom": {
|
|
4166
4205
|
"name": "AvatarComponentMixin",
|
|
4167
|
-
"module": "
|
|
4206
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
4168
4207
|
}
|
|
4169
4208
|
},
|
|
4170
4209
|
{
|
|
4171
|
-
"
|
|
4210
|
+
"kind": "field",
|
|
4211
|
+
"name": "iconName",
|
|
4172
4212
|
"type": {
|
|
4173
4213
|
"text": "IconNames | undefined"
|
|
4174
4214
|
},
|
|
4175
4215
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
4176
|
-
"
|
|
4216
|
+
"attribute": "icon-name",
|
|
4177
4217
|
"inheritedFrom": {
|
|
4178
4218
|
"name": "IconNameMixin",
|
|
4179
|
-
"module": "
|
|
4180
|
-
}
|
|
4181
|
-
},
|
|
4182
|
-
{
|
|
4183
|
-
"name": "auto-focus-on-mount",
|
|
4184
|
-
"type": {
|
|
4185
|
-
"text": "boolean"
|
|
4186
|
-
},
|
|
4187
|
-
"default": "false",
|
|
4188
|
-
"description": "This property indicates whether the element should receive focus automatically when it is mounted.\n\nIt will not focus if the element is re-attached to the DOM after being removed.",
|
|
4189
|
-
"fieldName": "autoFocusOnMount",
|
|
4190
|
-
"inheritedFrom": {
|
|
4191
|
-
"name": "AutoFocusOnMountMixin",
|
|
4192
|
-
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
|
4219
|
+
"module": "utils/mixins/IconNameMixin.js"
|
|
4193
4220
|
}
|
|
4194
|
-
}
|
|
4221
|
+
}
|
|
4222
|
+
],
|
|
4223
|
+
"mixins": [
|
|
4195
4224
|
{
|
|
4196
|
-
"name": "
|
|
4197
|
-
"
|
|
4198
|
-
"text": "number"
|
|
4199
|
-
},
|
|
4200
|
-
"default": "0",
|
|
4201
|
-
"description": "This property specifies the tab order of the element.",
|
|
4202
|
-
"fieldName": "tabIndex",
|
|
4203
|
-
"inheritedFrom": {
|
|
4204
|
-
"name": "TabIndexMixin",
|
|
4205
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
|
4206
|
-
}
|
|
4225
|
+
"name": "AvatarComponentMixin",
|
|
4226
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
4207
4227
|
},
|
|
4208
4228
|
{
|
|
4209
|
-
"name": "
|
|
4210
|
-
"
|
|
4211
|
-
|
|
4212
|
-
|
|
4213
|
-
|
|
4214
|
-
|
|
4215
|
-
|
|
4216
|
-
|
|
4217
|
-
|
|
4218
|
-
|
|
4219
|
-
|
|
4220
|
-
|
|
4229
|
+
"name": "IconNameMixin",
|
|
4230
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
|
4231
|
+
}
|
|
4232
|
+
],
|
|
4233
|
+
"superclass": {
|
|
4234
|
+
"name": "Component",
|
|
4235
|
+
"module": "/src/models"
|
|
4236
|
+
},
|
|
4237
|
+
"tagName": "mdc-avatar",
|
|
4238
|
+
"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 *\n * @csspart photo - The photo of the avatar.\n * @csspart presence - The presence indicator of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator.\n * @csspart loader - The loading indicator of the avatar.\n */",
|
|
4239
|
+
"customElement": true,
|
|
4240
|
+
"attributes": [
|
|
4221
4241
|
{
|
|
4222
|
-
"name": "
|
|
4242
|
+
"name": "src",
|
|
4223
4243
|
"type": {
|
|
4224
|
-
"text": "
|
|
4244
|
+
"text": "string | undefined"
|
|
4225
4245
|
},
|
|
4226
|
-
"description": "The
|
|
4227
|
-
"
|
|
4228
|
-
"fieldName": "active",
|
|
4246
|
+
"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.",
|
|
4247
|
+
"fieldName": "src",
|
|
4229
4248
|
"inheritedFrom": {
|
|
4230
|
-
"name": "
|
|
4231
|
-
"module": "src/
|
|
4249
|
+
"name": "AvatarComponentMixin",
|
|
4250
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4232
4251
|
}
|
|
4233
4252
|
},
|
|
4234
4253
|
{
|
|
4235
|
-
"name": "
|
|
4254
|
+
"name": "initials",
|
|
4236
4255
|
"type": {
|
|
4237
|
-
"text": "
|
|
4256
|
+
"text": "string | undefined"
|
|
4238
4257
|
},
|
|
4239
|
-
"description": "
|
|
4240
|
-
"
|
|
4241
|
-
"fieldName": "softDisabled",
|
|
4258
|
+
"description": "The initials to be displayed for the avatar.",
|
|
4259
|
+
"fieldName": "initials",
|
|
4242
4260
|
"inheritedFrom": {
|
|
4243
|
-
"name": "
|
|
4244
|
-
"module": "src/
|
|
4261
|
+
"name": "AvatarComponentMixin",
|
|
4262
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4245
4263
|
}
|
|
4246
4264
|
},
|
|
4247
4265
|
{
|
|
4248
|
-
"name": "
|
|
4266
|
+
"name": "presence",
|
|
4249
4267
|
"type": {
|
|
4250
|
-
"text": "
|
|
4268
|
+
"text": "PresenceType | undefined"
|
|
4251
4269
|
},
|
|
4252
|
-
"description": "
|
|
4253
|
-
"
|
|
4254
|
-
"fieldName": "role",
|
|
4270
|
+
"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`",
|
|
4271
|
+
"fieldName": "presence",
|
|
4255
4272
|
"inheritedFrom": {
|
|
4256
|
-
"name": "
|
|
4257
|
-
"module": "src/
|
|
4273
|
+
"name": "AvatarComponentMixin",
|
|
4274
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4258
4275
|
}
|
|
4259
4276
|
},
|
|
4260
4277
|
{
|
|
4261
|
-
"name": "
|
|
4278
|
+
"name": "size",
|
|
4262
4279
|
"type": {
|
|
4263
|
-
"text": "
|
|
4280
|
+
"text": "AvatarSize"
|
|
4264
4281
|
},
|
|
4265
|
-
"description": "
|
|
4266
|
-
"default": "
|
|
4267
|
-
"fieldName": "
|
|
4282
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
4283
|
+
"default": "32",
|
|
4284
|
+
"fieldName": "size",
|
|
4268
4285
|
"inheritedFrom": {
|
|
4269
|
-
"name": "
|
|
4270
|
-
"module": "src/
|
|
4286
|
+
"name": "AvatarComponentMixin",
|
|
4287
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4271
4288
|
}
|
|
4272
4289
|
},
|
|
4273
4290
|
{
|
|
4274
|
-
"name": "
|
|
4291
|
+
"name": "counter",
|
|
4275
4292
|
"type": {
|
|
4276
|
-
"text": "
|
|
4293
|
+
"text": "number | undefined"
|
|
4277
4294
|
},
|
|
4278
|
-
"description": "
|
|
4279
|
-
"
|
|
4280
|
-
"fieldName": "type",
|
|
4295
|
+
"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`.",
|
|
4296
|
+
"fieldName": "counter",
|
|
4281
4297
|
"inheritedFrom": {
|
|
4282
|
-
"name": "
|
|
4283
|
-
"module": "src/
|
|
4298
|
+
"name": "AvatarComponentMixin",
|
|
4299
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4284
4300
|
}
|
|
4285
4301
|
},
|
|
4286
4302
|
{
|
|
4287
|
-
"name": "
|
|
4303
|
+
"name": "is-typing",
|
|
4288
4304
|
"type": {
|
|
4289
|
-
"text": "
|
|
4305
|
+
"text": "boolean"
|
|
4290
4306
|
},
|
|
4291
|
-
"
|
|
4292
|
-
"
|
|
4307
|
+
"default": "false",
|
|
4308
|
+
"description": "Represents the typing indicator when the user is typing.",
|
|
4309
|
+
"fieldName": "isTyping",
|
|
4293
4310
|
"inheritedFrom": {
|
|
4294
|
-
"name": "
|
|
4295
|
-
"module": "src/
|
|
4311
|
+
"name": "AvatarComponentMixin",
|
|
4312
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4296
4313
|
}
|
|
4297
4314
|
},
|
|
4298
4315
|
{
|
|
4299
|
-
"name": "
|
|
4316
|
+
"name": "icon-name",
|
|
4300
4317
|
"type": {
|
|
4301
|
-
"text": "
|
|
4318
|
+
"text": "IconNames | undefined"
|
|
4302
4319
|
},
|
|
4303
|
-
"description": "
|
|
4304
|
-
"fieldName": "
|
|
4320
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
4321
|
+
"fieldName": "iconName",
|
|
4305
4322
|
"inheritedFrom": {
|
|
4306
|
-
"name": "
|
|
4307
|
-
"module": "src/
|
|
4323
|
+
"name": "IconNameMixin",
|
|
4324
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
4308
4325
|
}
|
|
4309
4326
|
}
|
|
4310
|
-
]
|
|
4311
|
-
"mixins": [
|
|
4312
|
-
{
|
|
4313
|
-
"name": "AvatarComponentMixin",
|
|
4314
|
-
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
4315
|
-
},
|
|
4316
|
-
{
|
|
4317
|
-
"name": "IconNameMixin",
|
|
4318
|
-
"module": "/src/utils/mixins/IconNameMixin"
|
|
4319
|
-
}
|
|
4320
|
-
],
|
|
4321
|
-
"superclass": {
|
|
4322
|
-
"name": "Buttonsimple",
|
|
4323
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
|
4324
|
-
},
|
|
4325
|
-
"tagName": "mdc-avatarbutton",
|
|
4326
|
-
"jsDoc": "/**\n * The `mdc-avatarbutton` component is an interactable version of the `mdc-avatar` component.\n *\n * This component is made by extending `buttonsimple` class.\n * The button component acts as a wrapper for the avatar component.\n *\n * To override styles of the avatar inside, use the specified css parts.\n *\n * @dependency mdc-avatar\n *\n * @event click - (React: onClick) This event is dispatched when the avatarbutton is clicked.\n * @event keydown - (React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.\n * @event keyup - (React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.\n * @event focus - (React: onFocus) This event is dispatched when the avatarbutton receives focus.\n *\n * @tagname mdc-avatarbutton\n *\n * @cssproperty --mdc-avatarbutton-overlay-background-color-rest - Background color of the overlay in rest state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-hover - Background color of the overlay in hover state\n * @cssproperty --mdc-avatarbutton-overlay-background-color-active - Background color of the overlay in active state\n *\n * @csspart overlay - The overlay part of the avatar button.\n * @csspart content - The main content of the avatar.\n * @csspart photo - The photo part of the avatar.\n * @csspart presence - The presence indicator part of the avatar.\n * @csspart loading-wrapper - The wrapper for the loading indicator of the avatar.\n * @csspart loader - The loading indicator part of the avatar.\n */",
|
|
4327
|
-
"customElement": true
|
|
4327
|
+
]
|
|
4328
4328
|
}
|
|
4329
4329
|
],
|
|
4330
4330
|
"exports": [
|
|
@@ -4332,8 +4332,8 @@
|
|
|
4332
4332
|
"kind": "js",
|
|
4333
4333
|
"name": "default",
|
|
4334
4334
|
"declaration": {
|
|
4335
|
-
"name": "
|
|
4336
|
-
"module": "components/
|
|
4335
|
+
"name": "Avatar",
|
|
4336
|
+
"module": "components/avatar/avatar.component.js"
|
|
4337
4337
|
}
|
|
4338
4338
|
}
|
|
4339
4339
|
]
|