@momentum-design/components 0.127.3 → 0.127.4
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 +748 -748
- package/dist/react/index.d.ts +2 -2
- package/dist/react/index.js +2 -2
- package/package.json +1 -1
|
@@ -513,6 +513,157 @@
|
|
|
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
|
+
},
|
|
516
667
|
{
|
|
517
668
|
"kind": "javascript-module",
|
|
518
669
|
"path": "components/accordionbutton/accordionbutton.component.js",
|
|
@@ -855,257 +1006,106 @@
|
|
|
855
1006
|
},
|
|
856
1007
|
{
|
|
857
1008
|
"kind": "javascript-module",
|
|
858
|
-
"path": "components/
|
|
1009
|
+
"path": "components/alertchip/alertchip.component.js",
|
|
859
1010
|
"declarations": [
|
|
860
1011
|
{
|
|
861
1012
|
"kind": "class",
|
|
862
|
-
"description": "
|
|
863
|
-
"name": "
|
|
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",
|
|
864
1015
|
"cssProperties": [
|
|
865
1016
|
{
|
|
866
|
-
"description": "The
|
|
867
|
-
"name": "--mdc-
|
|
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
|
+
}
|
|
868
1063
|
}
|
|
869
1064
|
],
|
|
870
|
-
"
|
|
1065
|
+
"cssParts": [
|
|
871
1066
|
{
|
|
872
|
-
"description": "The
|
|
873
|
-
"name": "
|
|
1067
|
+
"description": "The alert icon",
|
|
1068
|
+
"name": "icon"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
"description": "The text label of the alertchip",
|
|
1072
|
+
"name": "label"
|
|
874
1073
|
}
|
|
875
1074
|
],
|
|
876
1075
|
"members": [
|
|
877
1076
|
{
|
|
878
1077
|
"kind": "field",
|
|
879
|
-
"name": "
|
|
1078
|
+
"name": "variant",
|
|
880
1079
|
"type": {
|
|
881
|
-
"text": "
|
|
1080
|
+
"text": "VariantType"
|
|
882
1081
|
},
|
|
883
|
-
"description": "The
|
|
884
|
-
"default": "
|
|
885
|
-
"attribute": "
|
|
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",
|
|
886
1085
|
"reflects": true
|
|
887
1086
|
},
|
|
888
1087
|
{
|
|
889
1088
|
"kind": "field",
|
|
890
|
-
"name": "
|
|
1089
|
+
"name": "label",
|
|
891
1090
|
"type": {
|
|
892
|
-
"text": "
|
|
1091
|
+
"text": "string"
|
|
893
1092
|
},
|
|
894
|
-
"
|
|
895
|
-
"
|
|
896
|
-
"attribute": "
|
|
897
|
-
"reflects": true
|
|
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"
|
|
898
1096
|
},
|
|
899
1097
|
{
|
|
900
1098
|
"kind": "field",
|
|
901
|
-
"name": "
|
|
1099
|
+
"name": "iconName",
|
|
902
1100
|
"type": {
|
|
903
|
-
"text": "
|
|
1101
|
+
"text": "IconNames | undefined"
|
|
904
1102
|
},
|
|
905
|
-
"
|
|
906
|
-
"
|
|
907
|
-
"
|
|
908
|
-
|
|
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
|
-
}
|
|
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
1109
|
},
|
|
1110
1110
|
{
|
|
1111
1111
|
"kind": "field",
|
|
@@ -3292,108 +3292,53 @@
|
|
|
3292
3292
|
},
|
|
3293
3293
|
{
|
|
3294
3294
|
"kind": "javascript-module",
|
|
3295
|
-
"path": "components/
|
|
3295
|
+
"path": "components/avatar/avatar.component.js",
|
|
3296
3296
|
"declarations": [
|
|
3297
3297
|
{
|
|
3298
3298
|
"kind": "class",
|
|
3299
|
-
"description": "The `mdc-
|
|
3300
|
-
"name": "
|
|
3299
|
+
"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.",
|
|
3300
|
+
"name": "Avatar",
|
|
3301
3301
|
"cssProperties": [
|
|
3302
3302
|
{
|
|
3303
|
-
"description": "
|
|
3304
|
-
"name": "--mdc-
|
|
3305
|
-
},
|
|
3306
|
-
{
|
|
3307
|
-
"description": "Background color of the overlay in hover state",
|
|
3308
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
|
3309
|
-
},
|
|
3310
|
-
{
|
|
3311
|
-
"description": "Background color of the overlay in active state",
|
|
3312
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
|
3303
|
+
"description": "Allows customization of the default background color.",
|
|
3304
|
+
"name": "--mdc-avatar-default-background-color"
|
|
3313
3305
|
},
|
|
3314
3306
|
{
|
|
3315
|
-
"description": "
|
|
3316
|
-
"name": "--mdc-
|
|
3317
|
-
"inheritedFrom": {
|
|
3318
|
-
"name": "Buttonsimple",
|
|
3319
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3320
|
-
}
|
|
3307
|
+
"description": "Allows customization of the default foreground color.",
|
|
3308
|
+
"name": "--mdc-avatar-default-foreground-color"
|
|
3321
3309
|
},
|
|
3322
3310
|
{
|
|
3323
|
-
"description": "
|
|
3324
|
-
"name": "--mdc-
|
|
3325
|
-
"inheritedFrom": {
|
|
3326
|
-
"name": "Buttonsimple",
|
|
3327
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3328
|
-
}
|
|
3311
|
+
"description": "Allows customization of the loading indicator background color.",
|
|
3312
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
|
3329
3313
|
},
|
|
3330
3314
|
{
|
|
3331
|
-
"description": "
|
|
3332
|
-
"name": "--mdc-
|
|
3333
|
-
"inheritedFrom": {
|
|
3334
|
-
"name": "Buttonsimple",
|
|
3335
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3336
|
-
}
|
|
3315
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
|
3316
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
|
3337
3317
|
},
|
|
3338
3318
|
{
|
|
3339
|
-
"description": "
|
|
3340
|
-
"name": "--mdc-
|
|
3341
|
-
"inheritedFrom": {
|
|
3342
|
-
"name": "Buttonsimple",
|
|
3343
|
-
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3344
|
-
}
|
|
3319
|
+
"description": "Allows customization of the loading overlay background color.",
|
|
3320
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
|
3345
3321
|
}
|
|
3346
3322
|
],
|
|
3347
3323
|
"cssParts": [
|
|
3348
3324
|
{
|
|
3349
|
-
"description": "The
|
|
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.",
|
|
3325
|
+
"description": "The photo of the avatar.",
|
|
3358
3326
|
"name": "photo"
|
|
3359
3327
|
},
|
|
3360
3328
|
{
|
|
3361
|
-
"description": "The presence indicator
|
|
3329
|
+
"description": "The presence indicator of the avatar.",
|
|
3362
3330
|
"name": "presence"
|
|
3363
3331
|
},
|
|
3364
3332
|
{
|
|
3365
|
-
"description": "The wrapper for the loading indicator
|
|
3333
|
+
"description": "The wrapper for the loading indicator.",
|
|
3366
3334
|
"name": "loading-wrapper"
|
|
3367
3335
|
},
|
|
3368
3336
|
{
|
|
3369
|
-
"description": "The loading indicator
|
|
3337
|
+
"description": "The loading indicator of the avatar.",
|
|
3370
3338
|
"name": "loader"
|
|
3371
3339
|
}
|
|
3372
3340
|
],
|
|
3373
3341
|
"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
|
-
},
|
|
3397
3342
|
{
|
|
3398
3343
|
"kind": "field",
|
|
3399
3344
|
"name": "src",
|
|
@@ -3437,15 +3382,15 @@
|
|
|
3437
3382
|
"kind": "field",
|
|
3438
3383
|
"name": "size",
|
|
3439
3384
|
"type": {
|
|
3440
|
-
"text": "
|
|
3385
|
+
"text": "AvatarSize"
|
|
3441
3386
|
},
|
|
3442
3387
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3443
3388
|
"default": "32",
|
|
3444
3389
|
"attribute": "size",
|
|
3445
3390
|
"reflects": true,
|
|
3446
3391
|
"inheritedFrom": {
|
|
3447
|
-
"name": "
|
|
3448
|
-
"module": "
|
|
3392
|
+
"name": "AvatarComponentMixin",
|
|
3393
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3449
3394
|
}
|
|
3450
3395
|
},
|
|
3451
3396
|
{
|
|
@@ -3487,844 +3432,899 @@
|
|
|
3487
3432
|
"name": "IconNameMixin",
|
|
3488
3433
|
"module": "utils/mixins/IconNameMixin.js"
|
|
3489
3434
|
}
|
|
3435
|
+
}
|
|
3436
|
+
],
|
|
3437
|
+
"mixins": [
|
|
3438
|
+
{
|
|
3439
|
+
"name": "AvatarComponentMixin",
|
|
3440
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
|
3490
3441
|
},
|
|
3491
3442
|
{
|
|
3492
|
-
"
|
|
3493
|
-
"
|
|
3443
|
+
"name": "IconNameMixin",
|
|
3444
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
|
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",
|
|
3494
3457
|
"type": {
|
|
3495
|
-
"text": "
|
|
3458
|
+
"text": "string | undefined"
|
|
3496
3459
|
},
|
|
3497
|
-
"
|
|
3498
|
-
"
|
|
3499
|
-
"attribute": "auto-focus-on-mount",
|
|
3500
|
-
"reflects": true,
|
|
3460
|
+
"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.",
|
|
3461
|
+
"fieldName": "src",
|
|
3501
3462
|
"inheritedFrom": {
|
|
3502
|
-
"name": "
|
|
3503
|
-
"module": "utils/mixins/
|
|
3463
|
+
"name": "AvatarComponentMixin",
|
|
3464
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3504
3465
|
}
|
|
3505
3466
|
},
|
|
3506
3467
|
{
|
|
3507
|
-
"
|
|
3508
|
-
"name": "tabIndex",
|
|
3468
|
+
"name": "initials",
|
|
3509
3469
|
"type": {
|
|
3510
|
-
"text": "
|
|
3470
|
+
"text": "string | undefined"
|
|
3511
3471
|
},
|
|
3512
|
-
"
|
|
3513
|
-
"
|
|
3514
|
-
"attribute": "tabIndex",
|
|
3515
|
-
"reflects": true,
|
|
3472
|
+
"description": "The initials to be displayed for the avatar.",
|
|
3473
|
+
"fieldName": "initials",
|
|
3516
3474
|
"inheritedFrom": {
|
|
3517
|
-
"name": "
|
|
3518
|
-
"module": "utils/mixins/
|
|
3475
|
+
"name": "AvatarComponentMixin",
|
|
3476
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3519
3477
|
}
|
|
3520
3478
|
},
|
|
3521
3479
|
{
|
|
3522
|
-
"
|
|
3523
|
-
"name": "disabled",
|
|
3480
|
+
"name": "presence",
|
|
3524
3481
|
"type": {
|
|
3525
|
-
"text": "
|
|
3482
|
+
"text": "PresenceType | undefined"
|
|
3526
3483
|
},
|
|
3527
|
-
"description": "
|
|
3528
|
-
"
|
|
3529
|
-
"attribute": "disabled",
|
|
3530
|
-
"reflects": true,
|
|
3484
|
+
"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`",
|
|
3485
|
+
"fieldName": "presence",
|
|
3531
3486
|
"inheritedFrom": {
|
|
3532
|
-
"name": "
|
|
3533
|
-
"module": "utils/mixins/
|
|
3487
|
+
"name": "AvatarComponentMixin",
|
|
3488
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3534
3489
|
}
|
|
3535
3490
|
},
|
|
3536
3491
|
{
|
|
3537
|
-
"
|
|
3538
|
-
"name": "active",
|
|
3492
|
+
"name": "size",
|
|
3539
3493
|
"type": {
|
|
3540
|
-
"text": "
|
|
3494
|
+
"text": "AvatarSize"
|
|
3541
3495
|
},
|
|
3542
|
-
"description": "
|
|
3543
|
-
"default": "
|
|
3544
|
-
"
|
|
3545
|
-
"reflects": true,
|
|
3496
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3497
|
+
"default": "32",
|
|
3498
|
+
"fieldName": "size",
|
|
3546
3499
|
"inheritedFrom": {
|
|
3547
|
-
"name": "
|
|
3548
|
-
"module": "
|
|
3500
|
+
"name": "AvatarComponentMixin",
|
|
3501
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3549
3502
|
}
|
|
3550
3503
|
},
|
|
3551
3504
|
{
|
|
3552
|
-
"
|
|
3553
|
-
"name": "softDisabled",
|
|
3505
|
+
"name": "counter",
|
|
3554
3506
|
"type": {
|
|
3555
|
-
"text": "
|
|
3507
|
+
"text": "number | undefined"
|
|
3556
3508
|
},
|
|
3557
|
-
"description": "
|
|
3558
|
-
"
|
|
3559
|
-
"attribute": "soft-disabled",
|
|
3560
|
-
"reflects": true,
|
|
3509
|
+
"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`.",
|
|
3510
|
+
"fieldName": "counter",
|
|
3561
3511
|
"inheritedFrom": {
|
|
3562
|
-
"name": "
|
|
3563
|
-
"module": "
|
|
3512
|
+
"name": "AvatarComponentMixin",
|
|
3513
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3564
3514
|
}
|
|
3565
3515
|
},
|
|
3566
3516
|
{
|
|
3567
|
-
"
|
|
3568
|
-
"name": "role",
|
|
3517
|
+
"name": "is-typing",
|
|
3569
3518
|
"type": {
|
|
3570
|
-
"text": "
|
|
3519
|
+
"text": "boolean"
|
|
3571
3520
|
},
|
|
3572
|
-
"
|
|
3573
|
-
"
|
|
3574
|
-
"
|
|
3575
|
-
"reflects": true,
|
|
3521
|
+
"default": "false",
|
|
3522
|
+
"description": "Represents the typing indicator when the user is typing.",
|
|
3523
|
+
"fieldName": "isTyping",
|
|
3576
3524
|
"inheritedFrom": {
|
|
3577
|
-
"name": "
|
|
3578
|
-
"module": "
|
|
3525
|
+
"name": "AvatarComponentMixin",
|
|
3526
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
3579
3527
|
}
|
|
3580
3528
|
},
|
|
3581
3529
|
{
|
|
3582
|
-
"
|
|
3583
|
-
"name": "ariaStateKey",
|
|
3530
|
+
"name": "icon-name",
|
|
3584
3531
|
"type": {
|
|
3585
|
-
"text": "
|
|
3532
|
+
"text": "IconNames | undefined"
|
|
3586
3533
|
},
|
|
3587
|
-
"description": "
|
|
3588
|
-
"
|
|
3589
|
-
"attribute": "ariaStateKey",
|
|
3590
|
-
"reflects": true,
|
|
3534
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
3535
|
+
"fieldName": "iconName",
|
|
3591
3536
|
"inheritedFrom": {
|
|
3592
|
-
"name": "
|
|
3593
|
-
"module": "
|
|
3537
|
+
"name": "IconNameMixin",
|
|
3538
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
3594
3539
|
}
|
|
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"
|
|
3595
3567
|
},
|
|
3596
3568
|
{
|
|
3597
|
-
"
|
|
3598
|
-
"name": "
|
|
3599
|
-
|
|
3600
|
-
|
|
3601
|
-
|
|
3602
|
-
"
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
|
-
"
|
|
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
|
+
},
|
|
3576
|
+
{
|
|
3577
|
+
"description": "Height for button size",
|
|
3578
|
+
"name": "--mdc-button-height",
|
|
3606
3579
|
"inheritedFrom": {
|
|
3607
3580
|
"name": "Buttonsimple",
|
|
3608
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3581
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3609
3582
|
}
|
|
3610
3583
|
},
|
|
3611
3584
|
{
|
|
3612
|
-
"
|
|
3613
|
-
"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,
|
|
3585
|
+
"description": "Background color of the button",
|
|
3586
|
+
"name": "--mdc-button-background",
|
|
3620
3587
|
"inheritedFrom": {
|
|
3621
3588
|
"name": "Buttonsimple",
|
|
3622
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3589
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3623
3590
|
}
|
|
3624
3591
|
},
|
|
3625
3592
|
{
|
|
3626
|
-
"
|
|
3627
|
-
"name": "
|
|
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,
|
|
3593
|
+
"description": "Borer color of the button",
|
|
3594
|
+
"name": "--mdc-button-border-color",
|
|
3634
3595
|
"inheritedFrom": {
|
|
3635
3596
|
"name": "Buttonsimple",
|
|
3636
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3597
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3637
3598
|
}
|
|
3638
3599
|
},
|
|
3639
3600
|
{
|
|
3640
|
-
"
|
|
3641
|
-
"name": "
|
|
3642
|
-
"privacy": "protected",
|
|
3601
|
+
"description": "Text color of the button",
|
|
3602
|
+
"name": "--mdc-button-text-color",
|
|
3643
3603
|
"inheritedFrom": {
|
|
3644
3604
|
"name": "Buttonsimple",
|
|
3645
|
-
"module": "components/buttonsimple/buttonsimple.component.
|
|
3605
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
3646
3606
|
}
|
|
3607
|
+
}
|
|
3608
|
+
],
|
|
3609
|
+
"cssParts": [
|
|
3610
|
+
{
|
|
3611
|
+
"description": "The overlay part of the avatar button.",
|
|
3612
|
+
"name": "overlay"
|
|
3647
3613
|
},
|
|
3648
3614
|
{
|
|
3649
|
-
"
|
|
3650
|
-
"name": "
|
|
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
|
-
}
|
|
3615
|
+
"description": "The main content of the avatar.",
|
|
3616
|
+
"name": "content"
|
|
3674
3617
|
},
|
|
3675
3618
|
{
|
|
3676
|
-
"
|
|
3677
|
-
"name": "
|
|
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
|
-
}
|
|
3619
|
+
"description": "The photo part of the avatar.",
|
|
3620
|
+
"name": "photo"
|
|
3701
3621
|
},
|
|
3702
3622
|
{
|
|
3703
|
-
"
|
|
3704
|
-
"name": "
|
|
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
|
-
}
|
|
3623
|
+
"description": "The presence indicator part of the avatar.",
|
|
3624
|
+
"name": "presence"
|
|
3727
3625
|
},
|
|
3728
3626
|
{
|
|
3729
|
-
"
|
|
3730
|
-
"name": "
|
|
3731
|
-
"privacy": "private",
|
|
3732
|
-
"inheritedFrom": {
|
|
3733
|
-
"name": "Buttonsimple",
|
|
3734
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3735
|
-
}
|
|
3627
|
+
"description": "The wrapper for the loading indicator of the avatar.",
|
|
3628
|
+
"name": "loading-wrapper"
|
|
3736
3629
|
},
|
|
3737
3630
|
{
|
|
3738
|
-
"
|
|
3739
|
-
"name": "
|
|
3740
|
-
|
|
3741
|
-
|
|
3742
|
-
|
|
3743
|
-
"name": "Buttonsimple",
|
|
3744
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3745
|
-
}
|
|
3746
|
-
},
|
|
3631
|
+
"description": "The loading indicator part of the avatar.",
|
|
3632
|
+
"name": "loader"
|
|
3633
|
+
}
|
|
3634
|
+
],
|
|
3635
|
+
"members": [
|
|
3747
3636
|
{
|
|
3748
|
-
"kind": "
|
|
3749
|
-
"name": "
|
|
3750
|
-
"
|
|
3751
|
-
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
|
|
3755
|
-
|
|
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
|
-
}
|
|
3637
|
+
"kind": "field",
|
|
3638
|
+
"name": "ariaLabel",
|
|
3639
|
+
"type": {
|
|
3640
|
+
"text": "string | null"
|
|
3641
|
+
},
|
|
3642
|
+
"default": "null",
|
|
3643
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
3644
|
+
"attribute": "aria-label"
|
|
3765
3645
|
},
|
|
3766
3646
|
{
|
|
3767
3647
|
"kind": "method",
|
|
3768
|
-
"name": "
|
|
3648
|
+
"name": "setSize",
|
|
3769
3649
|
"privacy": "private",
|
|
3770
3650
|
"parameters": [
|
|
3771
3651
|
{
|
|
3772
|
-
"name": "
|
|
3652
|
+
"name": "size",
|
|
3773
3653
|
"type": {
|
|
3774
|
-
"text": "
|
|
3775
|
-
}
|
|
3776
|
-
"description": "The keyboard event."
|
|
3654
|
+
"text": "AvatarSize"
|
|
3655
|
+
}
|
|
3777
3656
|
}
|
|
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"
|
|
3657
|
+
]
|
|
3833
3658
|
},
|
|
3834
3659
|
{
|
|
3660
|
+
"kind": "field",
|
|
3835
3661
|
"name": "src",
|
|
3836
3662
|
"type": {
|
|
3837
3663
|
"text": "string | undefined"
|
|
3838
3664
|
},
|
|
3839
3665
|
"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.",
|
|
3840
|
-
"
|
|
3666
|
+
"attribute": "src",
|
|
3841
3667
|
"inheritedFrom": {
|
|
3842
3668
|
"name": "AvatarComponentMixin",
|
|
3843
|
-
"module": "
|
|
3669
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3844
3670
|
}
|
|
3845
3671
|
},
|
|
3846
3672
|
{
|
|
3673
|
+
"kind": "field",
|
|
3847
3674
|
"name": "initials",
|
|
3848
3675
|
"type": {
|
|
3849
3676
|
"text": "string | undefined"
|
|
3850
3677
|
},
|
|
3851
3678
|
"description": "The initials to be displayed for the avatar.",
|
|
3852
|
-
"
|
|
3679
|
+
"attribute": "initials",
|
|
3853
3680
|
"inheritedFrom": {
|
|
3854
3681
|
"name": "AvatarComponentMixin",
|
|
3855
|
-
"module": "
|
|
3682
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3856
3683
|
}
|
|
3857
3684
|
},
|
|
3858
3685
|
{
|
|
3686
|
+
"kind": "field",
|
|
3859
3687
|
"name": "presence",
|
|
3860
3688
|
"type": {
|
|
3861
3689
|
"text": "PresenceType | undefined"
|
|
3862
3690
|
},
|
|
3863
3691
|
"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`",
|
|
3864
|
-
"
|
|
3692
|
+
"attribute": "presence",
|
|
3865
3693
|
"inheritedFrom": {
|
|
3866
3694
|
"name": "AvatarComponentMixin",
|
|
3867
|
-
"module": "
|
|
3695
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3868
3696
|
}
|
|
3869
3697
|
},
|
|
3870
3698
|
{
|
|
3699
|
+
"kind": "field",
|
|
3871
3700
|
"name": "size",
|
|
3872
3701
|
"type": {
|
|
3873
3702
|
"text": "ButtonSize"
|
|
3874
3703
|
},
|
|
3875
3704
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
3876
3705
|
"default": "32",
|
|
3877
|
-
"
|
|
3706
|
+
"attribute": "size",
|
|
3707
|
+
"reflects": true,
|
|
3878
3708
|
"inheritedFrom": {
|
|
3879
3709
|
"name": "Buttonsimple",
|
|
3880
|
-
"module": "
|
|
3710
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3881
3711
|
}
|
|
3882
3712
|
},
|
|
3883
3713
|
{
|
|
3714
|
+
"kind": "field",
|
|
3884
3715
|
"name": "counter",
|
|
3885
3716
|
"type": {
|
|
3886
3717
|
"text": "number | undefined"
|
|
3887
3718
|
},
|
|
3888
3719
|
"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`.",
|
|
3889
|
-
"
|
|
3720
|
+
"attribute": "counter",
|
|
3890
3721
|
"inheritedFrom": {
|
|
3891
3722
|
"name": "AvatarComponentMixin",
|
|
3892
|
-
"module": "
|
|
3723
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3893
3724
|
}
|
|
3894
3725
|
},
|
|
3895
3726
|
{
|
|
3896
|
-
"
|
|
3727
|
+
"kind": "field",
|
|
3728
|
+
"name": "isTyping",
|
|
3897
3729
|
"type": {
|
|
3898
3730
|
"text": "boolean"
|
|
3899
3731
|
},
|
|
3900
3732
|
"default": "false",
|
|
3901
3733
|
"description": "Represents the typing indicator when the user is typing.",
|
|
3902
|
-
"
|
|
3734
|
+
"attribute": "is-typing",
|
|
3903
3735
|
"inheritedFrom": {
|
|
3904
3736
|
"name": "AvatarComponentMixin",
|
|
3905
|
-
"module": "
|
|
3737
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
|
3906
3738
|
}
|
|
3907
3739
|
},
|
|
3908
3740
|
{
|
|
3909
|
-
"
|
|
3741
|
+
"kind": "field",
|
|
3742
|
+
"name": "iconName",
|
|
3910
3743
|
"type": {
|
|
3911
3744
|
"text": "IconNames | undefined"
|
|
3912
3745
|
},
|
|
3913
3746
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
3914
|
-
"
|
|
3747
|
+
"attribute": "icon-name",
|
|
3915
3748
|
"inheritedFrom": {
|
|
3916
3749
|
"name": "IconNameMixin",
|
|
3917
|
-
"module": "
|
|
3750
|
+
"module": "utils/mixins/IconNameMixin.js"
|
|
3918
3751
|
}
|
|
3919
3752
|
},
|
|
3920
3753
|
{
|
|
3921
|
-
"
|
|
3754
|
+
"kind": "field",
|
|
3755
|
+
"name": "autoFocusOnMount",
|
|
3922
3756
|
"type": {
|
|
3923
3757
|
"text": "boolean"
|
|
3924
3758
|
},
|
|
3925
3759
|
"default": "false",
|
|
3926
3760
|
"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.",
|
|
3927
|
-
"
|
|
3761
|
+
"attribute": "auto-focus-on-mount",
|
|
3762
|
+
"reflects": true,
|
|
3928
3763
|
"inheritedFrom": {
|
|
3929
3764
|
"name": "AutoFocusOnMountMixin",
|
|
3930
|
-
"module": "
|
|
3765
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
|
3931
3766
|
}
|
|
3932
3767
|
},
|
|
3933
3768
|
{
|
|
3769
|
+
"kind": "field",
|
|
3934
3770
|
"name": "tabIndex",
|
|
3935
3771
|
"type": {
|
|
3936
3772
|
"text": "number"
|
|
3937
3773
|
},
|
|
3938
3774
|
"default": "0",
|
|
3939
3775
|
"description": "This property specifies the tab order of the element.",
|
|
3940
|
-
"
|
|
3776
|
+
"attribute": "tabIndex",
|
|
3777
|
+
"reflects": true,
|
|
3941
3778
|
"inheritedFrom": {
|
|
3942
3779
|
"name": "TabIndexMixin",
|
|
3943
|
-
"module": "
|
|
3780
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
|
3944
3781
|
}
|
|
3945
3782
|
},
|
|
3946
3783
|
{
|
|
3784
|
+
"kind": "field",
|
|
3947
3785
|
"name": "disabled",
|
|
3948
3786
|
"type": {
|
|
3949
3787
|
"text": "boolean | undefined"
|
|
3950
3788
|
},
|
|
3951
3789
|
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
3952
3790
|
"default": "undefined",
|
|
3953
|
-
"
|
|
3791
|
+
"attribute": "disabled",
|
|
3792
|
+
"reflects": true,
|
|
3954
3793
|
"inheritedFrom": {
|
|
3955
3794
|
"name": "DisabledMixin",
|
|
3956
|
-
"module": "
|
|
3795
|
+
"module": "utils/mixins/DisabledMixin.js"
|
|
3957
3796
|
}
|
|
3958
3797
|
},
|
|
3959
3798
|
{
|
|
3799
|
+
"kind": "field",
|
|
3960
3800
|
"name": "active",
|
|
3961
3801
|
"type": {
|
|
3962
3802
|
"text": "boolean | undefined"
|
|
3963
3803
|
},
|
|
3964
3804
|
"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.",
|
|
3965
3805
|
"default": "undefined",
|
|
3966
|
-
"
|
|
3806
|
+
"attribute": "active",
|
|
3807
|
+
"reflects": true,
|
|
3967
3808
|
"inheritedFrom": {
|
|
3968
3809
|
"name": "Buttonsimple",
|
|
3969
|
-
"module": "
|
|
3810
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3970
3811
|
}
|
|
3971
3812
|
},
|
|
3972
3813
|
{
|
|
3973
|
-
"
|
|
3814
|
+
"kind": "field",
|
|
3815
|
+
"name": "softDisabled",
|
|
3974
3816
|
"type": {
|
|
3975
3817
|
"text": "boolean | undefined"
|
|
3976
3818
|
},
|
|
3977
3819
|
"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.",
|
|
3978
3820
|
"default": "undefined",
|
|
3979
|
-
"
|
|
3821
|
+
"attribute": "soft-disabled",
|
|
3822
|
+
"reflects": true,
|
|
3980
3823
|
"inheritedFrom": {
|
|
3981
3824
|
"name": "Buttonsimple",
|
|
3982
|
-
"module": "
|
|
3825
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3983
3826
|
}
|
|
3984
3827
|
},
|
|
3985
3828
|
{
|
|
3829
|
+
"kind": "field",
|
|
3986
3830
|
"name": "role",
|
|
3987
3831
|
"type": {
|
|
3988
3832
|
"text": "RoleType"
|
|
3989
3833
|
},
|
|
3990
3834
|
"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.",
|
|
3991
3835
|
"default": "button",
|
|
3992
|
-
"
|
|
3836
|
+
"attribute": "role",
|
|
3837
|
+
"reflects": true,
|
|
3993
3838
|
"inheritedFrom": {
|
|
3994
3839
|
"name": "Buttonsimple",
|
|
3995
|
-
"module": "
|
|
3840
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3996
3841
|
}
|
|
3997
3842
|
},
|
|
3998
3843
|
{
|
|
3844
|
+
"kind": "field",
|
|
3999
3845
|
"name": "ariaStateKey",
|
|
4000
3846
|
"type": {
|
|
4001
3847
|
"text": "string | undefined"
|
|
4002
3848
|
},
|
|
4003
3849
|
"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`",
|
|
4004
3850
|
"default": "'aria-pressed' (when)",
|
|
4005
|
-
"
|
|
3851
|
+
"attribute": "ariaStateKey",
|
|
3852
|
+
"reflects": true,
|
|
4006
3853
|
"inheritedFrom": {
|
|
4007
3854
|
"name": "Buttonsimple",
|
|
4008
|
-
"module": "
|
|
3855
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4009
3856
|
}
|
|
4010
3857
|
},
|
|
4011
3858
|
{
|
|
3859
|
+
"kind": "field",
|
|
4012
3860
|
"name": "type",
|
|
4013
3861
|
"type": {
|
|
4014
3862
|
"text": "ButtonType"
|
|
4015
3863
|
},
|
|
4016
3864
|
"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.",
|
|
4017
3865
|
"default": "button",
|
|
4018
|
-
"
|
|
3866
|
+
"attribute": "type",
|
|
3867
|
+
"reflects": true,
|
|
4019
3868
|
"inheritedFrom": {
|
|
4020
3869
|
"name": "Buttonsimple",
|
|
4021
|
-
"module": "
|
|
3870
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4022
3871
|
}
|
|
4023
3872
|
},
|
|
4024
3873
|
{
|
|
3874
|
+
"kind": "field",
|
|
4025
3875
|
"name": "name",
|
|
4026
3876
|
"type": {
|
|
4027
3877
|
"text": "string | undefined"
|
|
4028
3878
|
},
|
|
4029
3879
|
"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.",
|
|
4030
|
-
"
|
|
3880
|
+
"attribute": "name",
|
|
3881
|
+
"reflects": true,
|
|
4031
3882
|
"inheritedFrom": {
|
|
4032
3883
|
"name": "Buttonsimple",
|
|
4033
|
-
"module": "
|
|
3884
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4034
3885
|
}
|
|
4035
3886
|
},
|
|
4036
3887
|
{
|
|
3888
|
+
"kind": "field",
|
|
4037
3889
|
"name": "value",
|
|
4038
3890
|
"type": {
|
|
4039
3891
|
"text": "string | undefined"
|
|
4040
3892
|
},
|
|
4041
3893
|
"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.",
|
|
4042
|
-
"
|
|
3894
|
+
"attribute": "value",
|
|
3895
|
+
"reflects": true,
|
|
4043
3896
|
"inheritedFrom": {
|
|
4044
3897
|
"name": "Buttonsimple",
|
|
4045
|
-
"module": "
|
|
3898
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4046
3899
|
}
|
|
4047
|
-
}
|
|
4048
|
-
],
|
|
4049
|
-
"mixins": [
|
|
3900
|
+
},
|
|
4050
3901
|
{
|
|
4051
|
-
"
|
|
4052
|
-
"
|
|
3902
|
+
"kind": "method",
|
|
3903
|
+
"name": "executeAction",
|
|
3904
|
+
"privacy": "protected",
|
|
3905
|
+
"inheritedFrom": {
|
|
3906
|
+
"name": "Buttonsimple",
|
|
3907
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3908
|
+
}
|
|
4053
3909
|
},
|
|
4054
3910
|
{
|
|
4055
|
-
"
|
|
4056
|
-
"
|
|
4057
|
-
|
|
4058
|
-
|
|
4059
|
-
|
|
4060
|
-
|
|
4061
|
-
|
|
4062
|
-
|
|
4063
|
-
|
|
4064
|
-
|
|
4065
|
-
|
|
4066
|
-
|
|
4067
|
-
|
|
4068
|
-
|
|
4069
|
-
|
|
4070
|
-
|
|
4071
|
-
|
|
4072
|
-
|
|
4073
|
-
|
|
4074
|
-
|
|
4075
|
-
|
|
4076
|
-
|
|
4077
|
-
|
|
4078
|
-
|
|
4079
|
-
|
|
4080
|
-
|
|
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": [
|
|
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
|
+
},
|
|
4088
3937
|
{
|
|
4089
|
-
"
|
|
4090
|
-
"name": "
|
|
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
|
+
}
|
|
4091
3963
|
},
|
|
4092
3964
|
{
|
|
4093
|
-
"
|
|
4094
|
-
"name": "
|
|
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
|
+
}
|
|
4095
3989
|
},
|
|
4096
3990
|
{
|
|
4097
|
-
"
|
|
4098
|
-
"name": "
|
|
3991
|
+
"kind": "method",
|
|
3992
|
+
"name": "triggerClickEvent",
|
|
3993
|
+
"privacy": "private",
|
|
3994
|
+
"inheritedFrom": {
|
|
3995
|
+
"name": "Buttonsimple",
|
|
3996
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
3997
|
+
}
|
|
4099
3998
|
},
|
|
4100
3999
|
{
|
|
4101
|
-
"
|
|
4102
|
-
"name": "
|
|
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.",
|
|
4004
|
+
"inheritedFrom": {
|
|
4005
|
+
"name": "Buttonsimple",
|
|
4006
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
|
4007
|
+
}
|
|
4103
4008
|
},
|
|
4104
4009
|
{
|
|
4105
|
-
"
|
|
4106
|
-
"name": "
|
|
4010
|
+
"kind": "method",
|
|
4011
|
+
"name": "handleKeyDown",
|
|
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
|
+
}
|
|
4027
|
+
},
|
|
4028
|
+
{
|
|
4029
|
+
"kind": "method",
|
|
4030
|
+
"name": "handleKeyUp",
|
|
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
|
+
}
|
|
4107
4046
|
}
|
|
4108
4047
|
],
|
|
4109
|
-
"
|
|
4048
|
+
"events": [
|
|
4110
4049
|
{
|
|
4111
|
-
"description": "
|
|
4112
|
-
"name": "
|
|
4050
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
|
4051
|
+
"name": "click",
|
|
4052
|
+
"reactName": "onClick",
|
|
4053
|
+
"inheritedFrom": {
|
|
4054
|
+
"name": "Buttonsimple",
|
|
4055
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4056
|
+
}
|
|
4113
4057
|
},
|
|
4114
4058
|
{
|
|
4115
|
-
"description": "
|
|
4116
|
-
"name": "
|
|
4059
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
|
4060
|
+
"name": "keydown",
|
|
4061
|
+
"reactName": "onKeyDown",
|
|
4062
|
+
"inheritedFrom": {
|
|
4063
|
+
"name": "Buttonsimple",
|
|
4064
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4065
|
+
}
|
|
4117
4066
|
},
|
|
4118
4067
|
{
|
|
4119
|
-
"description": "
|
|
4120
|
-
"name": "
|
|
4068
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
|
4069
|
+
"name": "keyup",
|
|
4070
|
+
"reactName": "onKeyUp",
|
|
4071
|
+
"inheritedFrom": {
|
|
4072
|
+
"name": "Buttonsimple",
|
|
4073
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4074
|
+
}
|
|
4121
4075
|
},
|
|
4122
4076
|
{
|
|
4123
|
-
"description": "
|
|
4124
|
-
"name": "
|
|
4077
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
|
4078
|
+
"name": "focus",
|
|
4079
|
+
"reactName": "onFocus",
|
|
4080
|
+
"inheritedFrom": {
|
|
4081
|
+
"name": "Buttonsimple",
|
|
4082
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4083
|
+
}
|
|
4125
4084
|
}
|
|
4126
4085
|
],
|
|
4127
|
-
"
|
|
4086
|
+
"attributes": [
|
|
4087
|
+
{
|
|
4088
|
+
"name": "aria-label",
|
|
4089
|
+
"type": {
|
|
4090
|
+
"text": "string | null"
|
|
4091
|
+
},
|
|
4092
|
+
"default": "null",
|
|
4093
|
+
"description": "Aria-label attribute to be set for accessibility",
|
|
4094
|
+
"fieldName": "ariaLabel"
|
|
4095
|
+
},
|
|
4128
4096
|
{
|
|
4129
|
-
"kind": "field",
|
|
4130
4097
|
"name": "src",
|
|
4131
4098
|
"type": {
|
|
4132
4099
|
"text": "string | undefined"
|
|
4133
4100
|
},
|
|
4134
4101
|
"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.",
|
|
4135
|
-
"
|
|
4102
|
+
"fieldName": "src",
|
|
4136
4103
|
"inheritedFrom": {
|
|
4137
4104
|
"name": "AvatarComponentMixin",
|
|
4138
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
4105
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4139
4106
|
}
|
|
4140
4107
|
},
|
|
4141
4108
|
{
|
|
4142
|
-
"kind": "field",
|
|
4143
4109
|
"name": "initials",
|
|
4144
4110
|
"type": {
|
|
4145
4111
|
"text": "string | undefined"
|
|
4146
4112
|
},
|
|
4147
4113
|
"description": "The initials to be displayed for the avatar.",
|
|
4148
|
-
"
|
|
4114
|
+
"fieldName": "initials",
|
|
4149
4115
|
"inheritedFrom": {
|
|
4150
4116
|
"name": "AvatarComponentMixin",
|
|
4151
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
4117
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4152
4118
|
}
|
|
4153
4119
|
},
|
|
4154
4120
|
{
|
|
4155
|
-
"kind": "field",
|
|
4156
4121
|
"name": "presence",
|
|
4157
4122
|
"type": {
|
|
4158
4123
|
"text": "PresenceType | undefined"
|
|
4159
4124
|
},
|
|
4160
4125
|
"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`",
|
|
4161
|
-
"
|
|
4126
|
+
"fieldName": "presence",
|
|
4162
4127
|
"inheritedFrom": {
|
|
4163
4128
|
"name": "AvatarComponentMixin",
|
|
4164
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
4129
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4165
4130
|
}
|
|
4166
4131
|
},
|
|
4167
4132
|
{
|
|
4168
|
-
"kind": "field",
|
|
4169
4133
|
"name": "size",
|
|
4170
4134
|
"type": {
|
|
4171
|
-
"text": "
|
|
4135
|
+
"text": "ButtonSize"
|
|
4172
4136
|
},
|
|
4173
4137
|
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
|
4174
4138
|
"default": "32",
|
|
4175
|
-
"
|
|
4176
|
-
"reflects": true,
|
|
4139
|
+
"fieldName": "size",
|
|
4177
4140
|
"inheritedFrom": {
|
|
4178
|
-
"name": "
|
|
4179
|
-
"module": "
|
|
4141
|
+
"name": "Buttonsimple",
|
|
4142
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4180
4143
|
}
|
|
4181
4144
|
},
|
|
4182
4145
|
{
|
|
4183
|
-
"kind": "field",
|
|
4184
4146
|
"name": "counter",
|
|
4185
4147
|
"type": {
|
|
4186
4148
|
"text": "number | undefined"
|
|
4187
4149
|
},
|
|
4188
4150
|
"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`.",
|
|
4189
|
-
"
|
|
4151
|
+
"fieldName": "counter",
|
|
4190
4152
|
"inheritedFrom": {
|
|
4191
4153
|
"name": "AvatarComponentMixin",
|
|
4192
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
4154
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4193
4155
|
}
|
|
4194
4156
|
},
|
|
4195
4157
|
{
|
|
4196
|
-
"
|
|
4197
|
-
"name": "isTyping",
|
|
4158
|
+
"name": "is-typing",
|
|
4198
4159
|
"type": {
|
|
4199
4160
|
"text": "boolean"
|
|
4200
4161
|
},
|
|
4201
4162
|
"default": "false",
|
|
4202
4163
|
"description": "Represents the typing indicator when the user is typing.",
|
|
4203
|
-
"
|
|
4164
|
+
"fieldName": "isTyping",
|
|
4204
4165
|
"inheritedFrom": {
|
|
4205
4166
|
"name": "AvatarComponentMixin",
|
|
4206
|
-
"module": "utils/mixins/AvatarComponentMixin.
|
|
4167
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
|
4207
4168
|
}
|
|
4208
4169
|
},
|
|
4209
4170
|
{
|
|
4210
|
-
"
|
|
4211
|
-
"name": "iconName",
|
|
4171
|
+
"name": "icon-name",
|
|
4212
4172
|
"type": {
|
|
4213
4173
|
"text": "IconNames | undefined"
|
|
4214
4174
|
},
|
|
4215
4175
|
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
|
4216
|
-
"
|
|
4176
|
+
"fieldName": "iconName",
|
|
4217
4177
|
"inheritedFrom": {
|
|
4218
4178
|
"name": "IconNameMixin",
|
|
4219
|
-
"module": "utils/mixins/IconNameMixin.
|
|
4179
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
|
4220
4180
|
}
|
|
4221
|
-
}
|
|
4222
|
-
],
|
|
4223
|
-
"mixins": [
|
|
4181
|
+
},
|
|
4224
4182
|
{
|
|
4225
|
-
"name": "
|
|
4226
|
-
"
|
|
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"
|
|
4193
|
+
}
|
|
4227
4194
|
},
|
|
4228
4195
|
{
|
|
4229
|
-
"name": "
|
|
4230
|
-
"
|
|
4231
|
-
|
|
4232
|
-
|
|
4233
|
-
|
|
4234
|
-
|
|
4235
|
-
|
|
4236
|
-
|
|
4237
|
-
|
|
4238
|
-
|
|
4239
|
-
|
|
4240
|
-
|
|
4196
|
+
"name": "tabIndex",
|
|
4197
|
+
"type": {
|
|
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
|
+
}
|
|
4207
|
+
},
|
|
4241
4208
|
{
|
|
4242
|
-
"name": "
|
|
4209
|
+
"name": "disabled",
|
|
4243
4210
|
"type": {
|
|
4244
|
-
"text": "
|
|
4211
|
+
"text": "boolean | undefined"
|
|
4245
4212
|
},
|
|
4246
|
-
"description": "
|
|
4247
|
-
"
|
|
4213
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
|
4214
|
+
"default": "undefined",
|
|
4215
|
+
"fieldName": "disabled",
|
|
4248
4216
|
"inheritedFrom": {
|
|
4249
|
-
"name": "
|
|
4250
|
-
"module": "src/utils/mixins/
|
|
4217
|
+
"name": "DisabledMixin",
|
|
4218
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
|
4251
4219
|
}
|
|
4252
4220
|
},
|
|
4253
4221
|
{
|
|
4254
|
-
"name": "
|
|
4222
|
+
"name": "active",
|
|
4255
4223
|
"type": {
|
|
4256
|
-
"text": "
|
|
4224
|
+
"text": "boolean | undefined"
|
|
4257
4225
|
},
|
|
4258
|
-
"description": "The
|
|
4259
|
-
"
|
|
4226
|
+
"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.",
|
|
4227
|
+
"default": "undefined",
|
|
4228
|
+
"fieldName": "active",
|
|
4260
4229
|
"inheritedFrom": {
|
|
4261
|
-
"name": "
|
|
4262
|
-
"module": "src/
|
|
4230
|
+
"name": "Buttonsimple",
|
|
4231
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4263
4232
|
}
|
|
4264
4233
|
},
|
|
4265
4234
|
{
|
|
4266
|
-
"name": "
|
|
4235
|
+
"name": "soft-disabled",
|
|
4267
4236
|
"type": {
|
|
4268
|
-
"text": "
|
|
4237
|
+
"text": "boolean | undefined"
|
|
4269
4238
|
},
|
|
4270
|
-
"description": "
|
|
4271
|
-
"
|
|
4239
|
+
"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.",
|
|
4240
|
+
"default": "undefined",
|
|
4241
|
+
"fieldName": "softDisabled",
|
|
4272
4242
|
"inheritedFrom": {
|
|
4273
|
-
"name": "
|
|
4274
|
-
"module": "src/
|
|
4243
|
+
"name": "Buttonsimple",
|
|
4244
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4275
4245
|
}
|
|
4276
4246
|
},
|
|
4277
4247
|
{
|
|
4278
|
-
"name": "
|
|
4248
|
+
"name": "role",
|
|
4279
4249
|
"type": {
|
|
4280
|
-
"text": "
|
|
4250
|
+
"text": "RoleType"
|
|
4281
4251
|
},
|
|
4282
|
-
"description": "
|
|
4283
|
-
"default": "
|
|
4284
|
-
"fieldName": "
|
|
4252
|
+
"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.",
|
|
4253
|
+
"default": "button",
|
|
4254
|
+
"fieldName": "role",
|
|
4285
4255
|
"inheritedFrom": {
|
|
4286
|
-
"name": "
|
|
4287
|
-
"module": "src/
|
|
4256
|
+
"name": "Buttonsimple",
|
|
4257
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4288
4258
|
}
|
|
4289
4259
|
},
|
|
4290
4260
|
{
|
|
4291
|
-
"name": "
|
|
4261
|
+
"name": "ariaStateKey",
|
|
4292
4262
|
"type": {
|
|
4293
|
-
"text": "
|
|
4263
|
+
"text": "string | undefined"
|
|
4294
4264
|
},
|
|
4295
|
-
"description": "
|
|
4296
|
-
"
|
|
4265
|
+
"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`",
|
|
4266
|
+
"default": "'aria-pressed' (when)",
|
|
4267
|
+
"fieldName": "ariaStateKey",
|
|
4297
4268
|
"inheritedFrom": {
|
|
4298
|
-
"name": "
|
|
4299
|
-
"module": "src/
|
|
4269
|
+
"name": "Buttonsimple",
|
|
4270
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4300
4271
|
}
|
|
4301
4272
|
},
|
|
4302
4273
|
{
|
|
4303
|
-
"name": "
|
|
4274
|
+
"name": "type",
|
|
4304
4275
|
"type": {
|
|
4305
|
-
"text": "
|
|
4276
|
+
"text": "ButtonType"
|
|
4306
4277
|
},
|
|
4307
|
-
"
|
|
4308
|
-
"
|
|
4309
|
-
"fieldName": "
|
|
4278
|
+
"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.",
|
|
4279
|
+
"default": "button",
|
|
4280
|
+
"fieldName": "type",
|
|
4310
4281
|
"inheritedFrom": {
|
|
4311
|
-
"name": "
|
|
4312
|
-
"module": "src/
|
|
4282
|
+
"name": "Buttonsimple",
|
|
4283
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4313
4284
|
}
|
|
4314
4285
|
},
|
|
4315
4286
|
{
|
|
4316
|
-
"name": "
|
|
4287
|
+
"name": "name",
|
|
4317
4288
|
"type": {
|
|
4318
|
-
"text": "
|
|
4289
|
+
"text": "string | undefined"
|
|
4319
4290
|
},
|
|
4320
|
-
"description": "
|
|
4321
|
-
"fieldName": "
|
|
4291
|
+
"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.",
|
|
4292
|
+
"fieldName": "name",
|
|
4322
4293
|
"inheritedFrom": {
|
|
4323
|
-
"name": "
|
|
4324
|
-
"module": "src/
|
|
4294
|
+
"name": "Buttonsimple",
|
|
4295
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4296
|
+
}
|
|
4297
|
+
},
|
|
4298
|
+
{
|
|
4299
|
+
"name": "value",
|
|
4300
|
+
"type": {
|
|
4301
|
+
"text": "string | undefined"
|
|
4302
|
+
},
|
|
4303
|
+
"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.",
|
|
4304
|
+
"fieldName": "value",
|
|
4305
|
+
"inheritedFrom": {
|
|
4306
|
+
"name": "Buttonsimple",
|
|
4307
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
|
4325
4308
|
}
|
|
4326
4309
|
}
|
|
4327
|
-
]
|
|
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
|
|
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": "AvatarButton",
|
|
4336
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
|
4337
4337
|
}
|
|
4338
4338
|
}
|
|
4339
4339
|
]
|