@momentum-design/components 0.118.1 → 0.118.2
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 +1785 -1785
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/package.json +1 -1
@@ -477,157 +477,6 @@
|
|
477
477
|
}
|
478
478
|
]
|
479
479
|
},
|
480
|
-
{
|
481
|
-
"kind": "javascript-module",
|
482
|
-
"path": "components/accordiongroup/accordiongroup.component.js",
|
483
|
-
"declarations": [
|
484
|
-
{
|
485
|
-
"kind": "class",
|
486
|
-
"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.",
|
487
|
-
"name": "AccordionGroup",
|
488
|
-
"cssProperties": [
|
489
|
-
{
|
490
|
-
"description": "The border color of the entire accordiongroup",
|
491
|
-
"name": "--mdc-accordiongroup-border-color"
|
492
|
-
}
|
493
|
-
],
|
494
|
-
"slots": [
|
495
|
-
{
|
496
|
-
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
497
|
-
"name": "default"
|
498
|
-
}
|
499
|
-
],
|
500
|
-
"members": [
|
501
|
-
{
|
502
|
-
"kind": "field",
|
503
|
-
"name": "size",
|
504
|
-
"type": {
|
505
|
-
"text": "Size"
|
506
|
-
},
|
507
|
-
"description": "The size of the accordion item.",
|
508
|
-
"default": "'small'",
|
509
|
-
"attribute": "size",
|
510
|
-
"reflects": true
|
511
|
-
},
|
512
|
-
{
|
513
|
-
"kind": "field",
|
514
|
-
"name": "variant",
|
515
|
-
"type": {
|
516
|
-
"text": "Variant"
|
517
|
-
},
|
518
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
519
|
-
"default": "'stacked'",
|
520
|
-
"attribute": "variant",
|
521
|
-
"reflects": true
|
522
|
-
},
|
523
|
-
{
|
524
|
-
"kind": "field",
|
525
|
-
"name": "allowMultiple",
|
526
|
-
"type": {
|
527
|
-
"text": "boolean"
|
528
|
-
},
|
529
|
-
"default": "false",
|
530
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
531
|
-
"attribute": "allow-multiple",
|
532
|
-
"reflects": true
|
533
|
-
},
|
534
|
-
{
|
535
|
-
"kind": "method",
|
536
|
-
"name": "handleAccordionExpanded",
|
537
|
-
"privacy": "private",
|
538
|
-
"return": {
|
539
|
-
"type": {
|
540
|
-
"text": "void"
|
541
|
-
}
|
542
|
-
},
|
543
|
-
"parameters": [
|
544
|
-
{
|
545
|
-
"name": "event",
|
546
|
-
"type": {
|
547
|
-
"text": "Event"
|
548
|
-
},
|
549
|
-
"description": "The event object from the 'shown' event."
|
550
|
-
}
|
551
|
-
],
|
552
|
-
"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."
|
553
|
-
},
|
554
|
-
{
|
555
|
-
"kind": "method",
|
556
|
-
"name": "setChildrenAccordionAttributes",
|
557
|
-
"privacy": "private",
|
558
|
-
"return": {
|
559
|
-
"type": {
|
560
|
-
"text": "void"
|
561
|
-
}
|
562
|
-
},
|
563
|
-
"parameters": [
|
564
|
-
{
|
565
|
-
"name": "attributeName",
|
566
|
-
"type": {
|
567
|
-
"text": "string"
|
568
|
-
},
|
569
|
-
"description": "The name of the attribute to set."
|
570
|
-
},
|
571
|
-
{
|
572
|
-
"name": "attributeValue",
|
573
|
-
"type": {
|
574
|
-
"text": "string"
|
575
|
-
},
|
576
|
-
"description": "The value to set the attribute to."
|
577
|
-
}
|
578
|
-
],
|
579
|
-
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
580
|
-
}
|
581
|
-
],
|
582
|
-
"attributes": [
|
583
|
-
{
|
584
|
-
"name": "size",
|
585
|
-
"type": {
|
586
|
-
"text": "Size"
|
587
|
-
},
|
588
|
-
"description": "The size of the accordion item.",
|
589
|
-
"default": "'small'",
|
590
|
-
"fieldName": "size"
|
591
|
-
},
|
592
|
-
{
|
593
|
-
"name": "variant",
|
594
|
-
"type": {
|
595
|
-
"text": "Variant"
|
596
|
-
},
|
597
|
-
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
598
|
-
"default": "'stacked'",
|
599
|
-
"fieldName": "variant"
|
600
|
-
},
|
601
|
-
{
|
602
|
-
"name": "allow-multiple",
|
603
|
-
"type": {
|
604
|
-
"text": "boolean"
|
605
|
-
},
|
606
|
-
"default": "false",
|
607
|
-
"description": "If true, multiple accordion items can be visible at the same time.",
|
608
|
-
"fieldName": "allowMultiple"
|
609
|
-
}
|
610
|
-
],
|
611
|
-
"superclass": {
|
612
|
-
"name": "Component",
|
613
|
-
"module": "/src/models"
|
614
|
-
},
|
615
|
-
"tagName": "mdc-accordiongroup",
|
616
|
-
"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 */",
|
617
|
-
"customElement": true
|
618
|
-
}
|
619
|
-
],
|
620
|
-
"exports": [
|
621
|
-
{
|
622
|
-
"kind": "js",
|
623
|
-
"name": "default",
|
624
|
-
"declaration": {
|
625
|
-
"name": "AccordionGroup",
|
626
|
-
"module": "components/accordiongroup/accordiongroup.component.js"
|
627
|
-
}
|
628
|
-
}
|
629
|
-
]
|
630
|
-
},
|
631
480
|
{
|
632
481
|
"kind": "javascript-module",
|
633
482
|
"path": "components/accordionbutton/accordionbutton.component.js",
|
@@ -970,102 +819,253 @@
|
|
970
819
|
},
|
971
820
|
{
|
972
821
|
"kind": "javascript-module",
|
973
|
-
"path": "components/
|
822
|
+
"path": "components/accordiongroup/accordiongroup.component.js",
|
974
823
|
"declarations": [
|
975
824
|
{
|
976
825
|
"kind": "class",
|
977
|
-
"description": "
|
978
|
-
"name": "
|
826
|
+
"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.",
|
827
|
+
"name": "AccordionGroup",
|
979
828
|
"cssProperties": [
|
980
829
|
{
|
981
|
-
"description": "The color of the
|
982
|
-
"name": "--mdc-
|
983
|
-
},
|
984
|
-
{
|
985
|
-
"description": "The color of the icon",
|
986
|
-
"name": "--mdc-chip-icon-color"
|
987
|
-
},
|
988
|
-
{
|
989
|
-
"description": "The border color of the alertchip",
|
990
|
-
"name": "--mdc-chip-border-color"
|
991
|
-
},
|
992
|
-
{
|
993
|
-
"description": "The background color of the alertchip",
|
994
|
-
"name": "--mdc-chip-background-color"
|
830
|
+
"description": "The border color of the entire accordiongroup",
|
831
|
+
"name": "--mdc-accordiongroup-border-color"
|
995
832
|
}
|
996
833
|
],
|
997
|
-
"
|
998
|
-
{
|
999
|
-
"description": "The alert icon",
|
1000
|
-
"name": "icon"
|
1001
|
-
},
|
834
|
+
"slots": [
|
1002
835
|
{
|
1003
|
-
"description": "The
|
1004
|
-
"name": "
|
836
|
+
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
837
|
+
"name": "default"
|
1005
838
|
}
|
1006
839
|
],
|
1007
840
|
"members": [
|
1008
841
|
{
|
1009
842
|
"kind": "field",
|
1010
|
-
"name": "
|
843
|
+
"name": "size",
|
1011
844
|
"type": {
|
1012
|
-
"text": "
|
845
|
+
"text": "Size"
|
1013
846
|
},
|
1014
|
-
"description": "The
|
1015
|
-
"default": "
|
1016
|
-
"attribute": "
|
847
|
+
"description": "The size of the accordion item.",
|
848
|
+
"default": "'small'",
|
849
|
+
"attribute": "size",
|
850
|
+
"reflects": true
|
1017
851
|
},
|
1018
852
|
{
|
1019
853
|
"kind": "field",
|
1020
|
-
"name": "
|
854
|
+
"name": "variant",
|
1021
855
|
"type": {
|
1022
|
-
"text": "
|
856
|
+
"text": "Variant"
|
1023
857
|
},
|
1024
|
-
"
|
1025
|
-
"
|
1026
|
-
"attribute": "
|
858
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
859
|
+
"default": "'stacked'",
|
860
|
+
"attribute": "variant",
|
861
|
+
"reflects": true
|
1027
862
|
},
|
1028
863
|
{
|
1029
864
|
"kind": "field",
|
1030
|
-
"name": "
|
865
|
+
"name": "allowMultiple",
|
1031
866
|
"type": {
|
1032
867
|
"text": "boolean"
|
1033
868
|
},
|
1034
869
|
"default": "false",
|
1035
|
-
"description": "
|
1036
|
-
"attribute": "
|
1037
|
-
"reflects": true
|
1038
|
-
"inheritedFrom": {
|
1039
|
-
"name": "AutoFocusOnMountMixin",
|
1040
|
-
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
1041
|
-
}
|
870
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
871
|
+
"attribute": "allow-multiple",
|
872
|
+
"reflects": true
|
1042
873
|
},
|
1043
874
|
{
|
1044
|
-
"kind": "
|
1045
|
-
"name": "
|
1046
|
-
"
|
1047
|
-
|
875
|
+
"kind": "method",
|
876
|
+
"name": "handleAccordionExpanded",
|
877
|
+
"privacy": "private",
|
878
|
+
"return": {
|
879
|
+
"type": {
|
880
|
+
"text": "void"
|
881
|
+
}
|
1048
882
|
},
|
1049
|
-
"
|
1050
|
-
|
1051
|
-
|
1052
|
-
|
1053
|
-
|
1054
|
-
|
1055
|
-
|
1056
|
-
|
883
|
+
"parameters": [
|
884
|
+
{
|
885
|
+
"name": "event",
|
886
|
+
"type": {
|
887
|
+
"text": "Event"
|
888
|
+
},
|
889
|
+
"description": "The event object from the 'shown' event."
|
890
|
+
}
|
891
|
+
],
|
892
|
+
"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."
|
1057
893
|
},
|
1058
894
|
{
|
1059
|
-
"kind": "
|
1060
|
-
"name": "
|
1061
|
-
"
|
1062
|
-
|
1063
|
-
|
1064
|
-
|
1065
|
-
|
1066
|
-
|
1067
|
-
"
|
1068
|
-
|
895
|
+
"kind": "method",
|
896
|
+
"name": "setChildrenAccordionAttributes",
|
897
|
+
"privacy": "private",
|
898
|
+
"return": {
|
899
|
+
"type": {
|
900
|
+
"text": "void"
|
901
|
+
}
|
902
|
+
},
|
903
|
+
"parameters": [
|
904
|
+
{
|
905
|
+
"name": "attributeName",
|
906
|
+
"type": {
|
907
|
+
"text": "string"
|
908
|
+
},
|
909
|
+
"description": "The name of the attribute to set."
|
910
|
+
},
|
911
|
+
{
|
912
|
+
"name": "attributeValue",
|
913
|
+
"type": {
|
914
|
+
"text": "string"
|
915
|
+
},
|
916
|
+
"description": "The value to set the attribute to."
|
917
|
+
}
|
918
|
+
],
|
919
|
+
"description": "Sets the given attribute on all child accordion or accordionbutton components."
|
920
|
+
}
|
921
|
+
],
|
922
|
+
"attributes": [
|
923
|
+
{
|
924
|
+
"name": "size",
|
925
|
+
"type": {
|
926
|
+
"text": "Size"
|
927
|
+
},
|
928
|
+
"description": "The size of the accordion item.",
|
929
|
+
"default": "'small'",
|
930
|
+
"fieldName": "size"
|
931
|
+
},
|
932
|
+
{
|
933
|
+
"name": "variant",
|
934
|
+
"type": {
|
935
|
+
"text": "Variant"
|
936
|
+
},
|
937
|
+
"description": "The variant of the accordion item. Based on the variant, the styling of the accordion gets changed.",
|
938
|
+
"default": "'stacked'",
|
939
|
+
"fieldName": "variant"
|
940
|
+
},
|
941
|
+
{
|
942
|
+
"name": "allow-multiple",
|
943
|
+
"type": {
|
944
|
+
"text": "boolean"
|
945
|
+
},
|
946
|
+
"default": "false",
|
947
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
948
|
+
"fieldName": "allowMultiple"
|
949
|
+
}
|
950
|
+
],
|
951
|
+
"superclass": {
|
952
|
+
"name": "Component",
|
953
|
+
"module": "/src/models"
|
954
|
+
},
|
955
|
+
"tagName": "mdc-accordiongroup",
|
956
|
+
"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 */",
|
957
|
+
"customElement": true
|
958
|
+
}
|
959
|
+
],
|
960
|
+
"exports": [
|
961
|
+
{
|
962
|
+
"kind": "js",
|
963
|
+
"name": "default",
|
964
|
+
"declaration": {
|
965
|
+
"name": "AccordionGroup",
|
966
|
+
"module": "components/accordiongroup/accordiongroup.component.js"
|
967
|
+
}
|
968
|
+
}
|
969
|
+
]
|
970
|
+
},
|
971
|
+
{
|
972
|
+
"kind": "javascript-module",
|
973
|
+
"path": "components/alertchip/alertchip.component.js",
|
974
|
+
"declarations": [
|
975
|
+
{
|
976
|
+
"kind": "class",
|
977
|
+
"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.",
|
978
|
+
"name": "AlertChip",
|
979
|
+
"cssProperties": [
|
980
|
+
{
|
981
|
+
"description": "The color of the label text",
|
982
|
+
"name": "--mdc-chip-color"
|
983
|
+
},
|
984
|
+
{
|
985
|
+
"description": "The color of the icon",
|
986
|
+
"name": "--mdc-chip-icon-color"
|
987
|
+
},
|
988
|
+
{
|
989
|
+
"description": "The border color of the alertchip",
|
990
|
+
"name": "--mdc-chip-border-color"
|
991
|
+
},
|
992
|
+
{
|
993
|
+
"description": "The background color of the alertchip",
|
994
|
+
"name": "--mdc-chip-background-color"
|
995
|
+
}
|
996
|
+
],
|
997
|
+
"cssParts": [
|
998
|
+
{
|
999
|
+
"description": "The alert icon",
|
1000
|
+
"name": "icon"
|
1001
|
+
},
|
1002
|
+
{
|
1003
|
+
"description": "The text label of the alertchip",
|
1004
|
+
"name": "label"
|
1005
|
+
}
|
1006
|
+
],
|
1007
|
+
"members": [
|
1008
|
+
{
|
1009
|
+
"kind": "field",
|
1010
|
+
"name": "variant",
|
1011
|
+
"type": {
|
1012
|
+
"text": "VariantType"
|
1013
|
+
},
|
1014
|
+
"description": "The variant of the alertchip. It supports 5 variants\n- neutral\n- warning\n- error\n- success\n- informational",
|
1015
|
+
"default": "neutral",
|
1016
|
+
"attribute": "variant"
|
1017
|
+
},
|
1018
|
+
{
|
1019
|
+
"kind": "field",
|
1020
|
+
"name": "label",
|
1021
|
+
"type": {
|
1022
|
+
"text": "string"
|
1023
|
+
},
|
1024
|
+
"default": "''",
|
1025
|
+
"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.",
|
1026
|
+
"attribute": "label"
|
1027
|
+
},
|
1028
|
+
{
|
1029
|
+
"kind": "field",
|
1030
|
+
"name": "autoFocusOnMount",
|
1031
|
+
"type": {
|
1032
|
+
"text": "boolean"
|
1033
|
+
},
|
1034
|
+
"default": "false",
|
1035
|
+
"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.",
|
1036
|
+
"attribute": "auto-focus-on-mount",
|
1037
|
+
"reflects": true,
|
1038
|
+
"inheritedFrom": {
|
1039
|
+
"name": "AutoFocusOnMountMixin",
|
1040
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
1041
|
+
}
|
1042
|
+
},
|
1043
|
+
{
|
1044
|
+
"kind": "field",
|
1045
|
+
"name": "tabIndex",
|
1046
|
+
"type": {
|
1047
|
+
"text": "number"
|
1048
|
+
},
|
1049
|
+
"default": "0",
|
1050
|
+
"description": "This property specifies the tab order of the element.",
|
1051
|
+
"attribute": "tabIndex",
|
1052
|
+
"reflects": true,
|
1053
|
+
"inheritedFrom": {
|
1054
|
+
"name": "TabIndexMixin",
|
1055
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
1056
|
+
}
|
1057
|
+
},
|
1058
|
+
{
|
1059
|
+
"kind": "field",
|
1060
|
+
"name": "disabled",
|
1061
|
+
"type": {
|
1062
|
+
"text": "boolean | undefined"
|
1063
|
+
},
|
1064
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
1065
|
+
"default": "undefined",
|
1066
|
+
"attribute": "disabled",
|
1067
|
+
"reflects": true,
|
1068
|
+
"inheritedFrom": {
|
1069
1069
|
"name": "DisabledMixin",
|
1070
1070
|
"module": "utils/mixins/DisabledMixin.js"
|
1071
1071
|
}
|
@@ -1768,650 +1768,510 @@
|
|
1768
1768
|
},
|
1769
1769
|
{
|
1770
1770
|
"kind": "javascript-module",
|
1771
|
-
"path": "components/
|
1771
|
+
"path": "components/announcementdialog/announcementdialog.component.js",
|
1772
1772
|
"declarations": [
|
1773
1773
|
{
|
1774
1774
|
"kind": "class",
|
1775
|
-
"description": "
|
1776
|
-
"name": "
|
1775
|
+
"description": "AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\nIt can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\nThe dialog is available in 4 sizes: medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
1776
|
+
"name": "AnnouncementDialog",
|
1777
1777
|
"cssProperties": [
|
1778
1778
|
{
|
1779
|
-
"description": "
|
1780
|
-
"name": "--mdc-
|
1779
|
+
"description": "background color of the illustration section",
|
1780
|
+
"name": "--mdc-announcementdialog-illustration-background-color"
|
1781
1781
|
},
|
1782
1782
|
{
|
1783
|
-
"description": "
|
1784
|
-
"name": "--mdc-
|
1783
|
+
"description": "primary background color of the dialog",
|
1784
|
+
"name": "--mdc-dialog-primary-background-color",
|
1785
|
+
"inheritedFrom": {
|
1786
|
+
"name": "Dialog",
|
1787
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1788
|
+
}
|
1785
1789
|
},
|
1786
1790
|
{
|
1787
|
-
"description": "
|
1788
|
-
"name": "--mdc-
|
1791
|
+
"description": "border color of the dialog",
|
1792
|
+
"name": "--mdc-dialog-border-color",
|
1793
|
+
"inheritedFrom": {
|
1794
|
+
"name": "Dialog",
|
1795
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1796
|
+
}
|
1789
1797
|
},
|
1790
1798
|
{
|
1791
|
-
"description": "
|
1792
|
-
"name": "--mdc-
|
1799
|
+
"description": "text color of the header/title of the dialog",
|
1800
|
+
"name": "--mdc-dialog-header-text-color",
|
1801
|
+
"inheritedFrom": {
|
1802
|
+
"name": "Dialog",
|
1803
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1804
|
+
}
|
1793
1805
|
},
|
1794
1806
|
{
|
1795
|
-
"description": "
|
1796
|
-
"name": "--mdc-
|
1807
|
+
"description": "text color of the below header description of the dialog",
|
1808
|
+
"name": "--mdc-dialog-description-text-color",
|
1809
|
+
"inheritedFrom": {
|
1810
|
+
"name": "Dialog",
|
1811
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1812
|
+
}
|
1813
|
+
},
|
1814
|
+
{
|
1815
|
+
"description": "elevation of the dialog",
|
1816
|
+
"name": "--mdc-dialog-elevation-3",
|
1817
|
+
"inheritedFrom": {
|
1818
|
+
"name": "Dialog",
|
1819
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1820
|
+
}
|
1821
|
+
},
|
1822
|
+
{
|
1823
|
+
"description": "width of the dialog",
|
1824
|
+
"name": "--mdc-dialog-width",
|
1825
|
+
"inheritedFrom": {
|
1826
|
+
"name": "Dialog",
|
1827
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1828
|
+
}
|
1829
|
+
},
|
1830
|
+
{
|
1831
|
+
"description": "height of the dialog",
|
1832
|
+
"name": "--mdc-dialog-height",
|
1833
|
+
"inheritedFrom": {
|
1834
|
+
"name": "Dialog",
|
1835
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1836
|
+
}
|
1797
1837
|
}
|
1798
1838
|
],
|
1799
1839
|
"cssParts": [
|
1800
1840
|
{
|
1801
|
-
"description": "The main
|
1802
|
-
"name": "
|
1803
|
-
},
|
1804
|
-
{
|
1805
|
-
"description": "The photo of the avatar.",
|
1806
|
-
"name": "photo"
|
1841
|
+
"description": "The main body container that holds the illustration and content sections",
|
1842
|
+
"name": "body"
|
1807
1843
|
},
|
1808
1844
|
{
|
1809
|
-
"description": "The
|
1810
|
-
"name": "
|
1845
|
+
"description": "The container for the illustration section",
|
1846
|
+
"name": "illustration-container"
|
1811
1847
|
},
|
1812
1848
|
{
|
1813
|
-
"description": "The
|
1814
|
-
"name": "
|
1849
|
+
"description": "The container for the content section",
|
1850
|
+
"name": "content-container"
|
1815
1851
|
},
|
1816
1852
|
{
|
1817
|
-
"description": "The
|
1818
|
-
"name": "
|
1853
|
+
"description": "The header text",
|
1854
|
+
"name": "header-text"
|
1819
1855
|
}
|
1820
1856
|
],
|
1821
|
-
"
|
1857
|
+
"slots": [
|
1822
1858
|
{
|
1823
|
-
"
|
1824
|
-
"name": "
|
1825
|
-
"type": {
|
1826
|
-
"text": "string | undefined"
|
1827
|
-
},
|
1828
|
-
"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.",
|
1829
|
-
"attribute": "src",
|
1859
|
+
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
1860
|
+
"name": "header-prefix",
|
1830
1861
|
"inheritedFrom": {
|
1831
|
-
"name": "
|
1832
|
-
"module": "
|
1862
|
+
"name": "Dialog",
|
1863
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1833
1864
|
}
|
1834
1865
|
},
|
1835
1866
|
{
|
1836
|
-
"
|
1837
|
-
"name": "
|
1838
|
-
"type": {
|
1839
|
-
"text": "string | undefined"
|
1840
|
-
},
|
1841
|
-
"description": "The initials to be displayed for the avatar.",
|
1842
|
-
"attribute": "initials",
|
1867
|
+
"description": "Slot for the dialog body content",
|
1868
|
+
"name": "dialog-body",
|
1843
1869
|
"inheritedFrom": {
|
1844
|
-
"name": "
|
1845
|
-
"module": "
|
1870
|
+
"name": "Dialog",
|
1871
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1846
1872
|
}
|
1847
1873
|
},
|
1848
1874
|
{
|
1849
|
-
"
|
1850
|
-
"name": "
|
1851
|
-
|
1852
|
-
|
1853
|
-
|
1854
|
-
"
|
1855
|
-
|
1875
|
+
"description": "Slot for the illustration container section",
|
1876
|
+
"name": "illustration-container"
|
1877
|
+
},
|
1878
|
+
{
|
1879
|
+
"description": "Slot for the content (header, description, etc) section",
|
1880
|
+
"name": "content-container"
|
1881
|
+
},
|
1882
|
+
{
|
1883
|
+
"description": "Slot for the description in the content (below header) - pass in Text, Links etc as needed.",
|
1884
|
+
"name": "description-container"
|
1885
|
+
},
|
1886
|
+
{
|
1887
|
+
"description": "This slot is for passing `mdc-link` component within the footer section.",
|
1888
|
+
"name": "footer-link",
|
1856
1889
|
"inheritedFrom": {
|
1857
|
-
"name": "
|
1858
|
-
"module": "
|
1890
|
+
"name": "Dialog",
|
1891
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1859
1892
|
}
|
1860
1893
|
},
|
1861
1894
|
{
|
1862
|
-
"
|
1863
|
-
"name": "
|
1864
|
-
"type": {
|
1865
|
-
"text": "AvatarSize"
|
1866
|
-
},
|
1867
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
1868
|
-
"default": "32",
|
1869
|
-
"attribute": "size",
|
1870
|
-
"reflects": true,
|
1895
|
+
"description": "This slot is for passing secondary variant of `mdc-button` component within the footer section.",
|
1896
|
+
"name": "footer-button-secondary",
|
1871
1897
|
"inheritedFrom": {
|
1872
|
-
"name": "
|
1873
|
-
"module": "
|
1898
|
+
"name": "Dialog",
|
1899
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1874
1900
|
}
|
1875
1901
|
},
|
1876
1902
|
{
|
1877
|
-
"
|
1878
|
-
"name": "
|
1879
|
-
"type": {
|
1880
|
-
"text": "number | undefined"
|
1881
|
-
},
|
1882
|
-
"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`.",
|
1883
|
-
"attribute": "counter",
|
1903
|
+
"description": "This slot is for passing primary variant of `mdc-button` component within the footer section.",
|
1904
|
+
"name": "footer-button-primary",
|
1884
1905
|
"inheritedFrom": {
|
1885
|
-
"name": "
|
1886
|
-
"module": "
|
1906
|
+
"name": "Dialog",
|
1907
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1887
1908
|
}
|
1888
1909
|
},
|
1910
|
+
{
|
1911
|
+
"description": " This slot is for passing custom footer content. Only use this if really needed, using the footer-link and footer-button slots is preferred",
|
1912
|
+
"name": "footer",
|
1913
|
+
"inheritedFrom": {
|
1914
|
+
"name": "Dialog",
|
1915
|
+
"module": "src/components/dialog/dialog.component.ts"
|
1916
|
+
}
|
1917
|
+
}
|
1918
|
+
],
|
1919
|
+
"members": [
|
1889
1920
|
{
|
1890
1921
|
"kind": "field",
|
1891
|
-
"name": "
|
1922
|
+
"name": "illustration",
|
1892
1923
|
"type": {
|
1893
|
-
"text": "
|
1924
|
+
"text": "IllustrationNames | undefined"
|
1894
1925
|
},
|
1895
|
-
"
|
1896
|
-
"
|
1897
|
-
"
|
1898
|
-
"inheritedFrom": {
|
1899
|
-
"name": "AvatarComponentMixin",
|
1900
|
-
"module": "utils/mixins/AvatarComponentMixin.js"
|
1901
|
-
}
|
1926
|
+
"description": "The illustration to display in the announcement dialog.\nThis can be an image URL, icon name, or any other illustration identifier.\n\nMake sure to choose the right illustration respective the size (the filename includes the size information, i.e. threetwozero = 320px)",
|
1927
|
+
"attribute": "illustration",
|
1928
|
+
"reflects": true
|
1902
1929
|
},
|
1903
1930
|
{
|
1904
1931
|
"kind": "field",
|
1905
|
-
"name": "
|
1932
|
+
"name": "size",
|
1906
1933
|
"type": {
|
1907
|
-
"text": "
|
1934
|
+
"text": "DialogSize"
|
1908
1935
|
},
|
1909
|
-
"description": "
|
1910
|
-
"
|
1936
|
+
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
1937
|
+
"default": "medium",
|
1938
|
+
"attribute": "size",
|
1939
|
+
"reflects": true,
|
1911
1940
|
"inheritedFrom": {
|
1912
|
-
"name": "
|
1913
|
-
"module": "
|
1941
|
+
"name": "Dialog",
|
1942
|
+
"module": "components/dialog/dialog.component.js"
|
1914
1943
|
}
|
1915
|
-
}
|
1916
|
-
],
|
1917
|
-
"mixins": [
|
1944
|
+
},
|
1918
1945
|
{
|
1919
|
-
"
|
1920
|
-
"
|
1946
|
+
"kind": "method",
|
1947
|
+
"name": "renderHeader",
|
1948
|
+
"privacy": "protected"
|
1921
1949
|
},
|
1922
1950
|
{
|
1923
|
-
"
|
1924
|
-
"
|
1925
|
-
|
1926
|
-
|
1927
|
-
"superclass": {
|
1928
|
-
"name": "Component",
|
1929
|
-
"module": "/src/models"
|
1930
|
-
},
|
1931
|
-
"tagName": "mdc-avatar",
|
1932
|
-
"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 content - The main content of the avatar.\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 */",
|
1933
|
-
"customElement": true,
|
1934
|
-
"attributes": [
|
1951
|
+
"kind": "method",
|
1952
|
+
"name": "renderBody",
|
1953
|
+
"privacy": "protected"
|
1954
|
+
},
|
1935
1955
|
{
|
1936
|
-
"
|
1956
|
+
"kind": "field",
|
1957
|
+
"name": "zIndex",
|
1937
1958
|
"type": {
|
1938
|
-
"text": "
|
1959
|
+
"text": "number"
|
1939
1960
|
},
|
1940
|
-
"description": "
|
1941
|
-
"
|
1961
|
+
"description": "IMPLEMENT THIS IN YOUR COMPONENT.\n\nThe z-index of the component where the backdrop will be attached to.\nThe backdrop itself will have a z-index of `zIndex - 1`.",
|
1962
|
+
"default": "1000",
|
1963
|
+
"attribute": "z-index",
|
1964
|
+
"reflects": true,
|
1942
1965
|
"inheritedFrom": {
|
1943
|
-
"name": "
|
1944
|
-
"module": "
|
1966
|
+
"name": "Dialog",
|
1967
|
+
"module": "components/dialog/dialog.component.js"
|
1945
1968
|
}
|
1946
1969
|
},
|
1947
1970
|
{
|
1948
|
-
"
|
1949
|
-
"
|
1950
|
-
|
1951
|
-
},
|
1952
|
-
"description": "The initials to be displayed for the avatar.",
|
1953
|
-
"fieldName": "initials",
|
1971
|
+
"kind": "method",
|
1972
|
+
"name": "activatePreventScroll",
|
1973
|
+
"privacy": "protected",
|
1954
1974
|
"inheritedFrom": {
|
1955
|
-
"name": "
|
1956
|
-
"module": "
|
1975
|
+
"name": "PreventScrollMixin",
|
1976
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
1957
1977
|
}
|
1958
1978
|
},
|
1959
1979
|
{
|
1960
|
-
"
|
1961
|
-
"
|
1962
|
-
|
1963
|
-
},
|
1964
|
-
"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`",
|
1965
|
-
"fieldName": "presence",
|
1980
|
+
"kind": "method",
|
1981
|
+
"name": "deactivatePreventScroll",
|
1982
|
+
"privacy": "protected",
|
1966
1983
|
"inheritedFrom": {
|
1967
|
-
"name": "
|
1968
|
-
"module": "
|
1984
|
+
"name": "PreventScrollMixin",
|
1985
|
+
"module": "utils/mixins/PreventScrollMixin.js"
|
1969
1986
|
}
|
1970
1987
|
},
|
1971
1988
|
{
|
1972
|
-
"
|
1989
|
+
"kind": "field",
|
1990
|
+
"name": "focusTrap",
|
1973
1991
|
"type": {
|
1974
|
-
"text": "
|
1992
|
+
"text": "boolean"
|
1975
1993
|
},
|
1976
|
-
"description": "
|
1977
|
-
"default": "
|
1978
|
-
"
|
1994
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nIMPLEMENT THIS IN YOUR COMPONENT.",
|
1995
|
+
"default": "true",
|
1996
|
+
"attribute": "focus-trap",
|
1997
|
+
"reflects": true,
|
1998
|
+
"privacy": "protected",
|
1979
1999
|
"inheritedFrom": {
|
1980
|
-
"name": "
|
1981
|
-
"module": "
|
2000
|
+
"name": "Dialog",
|
2001
|
+
"module": "components/dialog/dialog.component.js"
|
1982
2002
|
}
|
1983
2003
|
},
|
1984
2004
|
{
|
1985
|
-
"
|
2005
|
+
"kind": "field",
|
2006
|
+
"name": "shouldFocusTrapWrap",
|
1986
2007
|
"type": {
|
1987
|
-
"text": "
|
2008
|
+
"text": "boolean"
|
1988
2009
|
},
|
1989
|
-
"
|
1990
|
-
"
|
2010
|
+
"default": "true",
|
2011
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
2012
|
+
"attribute": "should-focus-trap-wrap",
|
2013
|
+
"reflects": true,
|
1991
2014
|
"inheritedFrom": {
|
1992
|
-
"name": "
|
1993
|
-
"module": "
|
2015
|
+
"name": "FocusTrapMixin",
|
2016
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
1994
2017
|
}
|
1995
2018
|
},
|
1996
2019
|
{
|
1997
|
-
"
|
1998
|
-
"
|
1999
|
-
|
2000
|
-
|
2001
|
-
|
2002
|
-
|
2003
|
-
|
2020
|
+
"kind": "method",
|
2021
|
+
"name": "setIsFocusTrapActivated",
|
2022
|
+
"privacy": "private",
|
2023
|
+
"parameters": [
|
2024
|
+
{
|
2025
|
+
"name": "isActivated",
|
2026
|
+
"type": {
|
2027
|
+
"text": "boolean"
|
2028
|
+
}
|
2029
|
+
}
|
2030
|
+
],
|
2004
2031
|
"inheritedFrom": {
|
2005
|
-
"name": "
|
2006
|
-
"module": "
|
2032
|
+
"name": "FocusTrapMixin",
|
2033
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2007
2034
|
}
|
2008
2035
|
},
|
2009
2036
|
{
|
2010
|
-
"
|
2011
|
-
"
|
2012
|
-
|
2013
|
-
|
2014
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2015
|
-
"fieldName": "iconName",
|
2037
|
+
"kind": "method",
|
2038
|
+
"name": "activateFocusTrap",
|
2039
|
+
"privacy": "public",
|
2040
|
+
"description": "Activate the focus trap",
|
2016
2041
|
"inheritedFrom": {
|
2017
|
-
"name": "
|
2018
|
-
"module": "
|
2019
|
-
}
|
2020
|
-
}
|
2021
|
-
]
|
2022
|
-
}
|
2023
|
-
],
|
2024
|
-
"exports": [
|
2025
|
-
{
|
2026
|
-
"kind": "js",
|
2027
|
-
"name": "default",
|
2028
|
-
"declaration": {
|
2029
|
-
"name": "Avatar",
|
2030
|
-
"module": "components/avatar/avatar.component.js"
|
2031
|
-
}
|
2032
|
-
}
|
2033
|
-
]
|
2034
|
-
},
|
2035
|
-
{
|
2036
|
-
"kind": "javascript-module",
|
2037
|
-
"path": "components/avatarbutton/avatarbutton.component.js",
|
2038
|
-
"declarations": [
|
2039
|
-
{
|
2040
|
-
"kind": "class",
|
2041
|
-
"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.",
|
2042
|
-
"name": "AvatarButton",
|
2043
|
-
"cssProperties": [
|
2044
|
-
{
|
2045
|
-
"description": "Background color of the overlay in rest state",
|
2046
|
-
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
2047
|
-
},
|
2048
|
-
{
|
2049
|
-
"description": "Background color of the overlay in hover state",
|
2050
|
-
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
2051
|
-
},
|
2052
|
-
{
|
2053
|
-
"description": "Background color of the overlay in active state",
|
2054
|
-
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
2055
|
-
}
|
2056
|
-
],
|
2057
|
-
"cssParts": [
|
2058
|
-
{
|
2059
|
-
"description": "The overlay part of the avatar button.",
|
2060
|
-
"name": "overlay"
|
2061
|
-
},
|
2062
|
-
{
|
2063
|
-
"description": "The main content of the avatar.",
|
2064
|
-
"name": "content"
|
2065
|
-
},
|
2066
|
-
{
|
2067
|
-
"description": "The photo part of the avatar.",
|
2068
|
-
"name": "photo"
|
2069
|
-
},
|
2070
|
-
{
|
2071
|
-
"description": "The presence indicator part of the avatar.",
|
2072
|
-
"name": "presence"
|
2073
|
-
},
|
2074
|
-
{
|
2075
|
-
"description": "The wrapper for the loading indicator of the avatar.",
|
2076
|
-
"name": "loading-wrapper"
|
2042
|
+
"name": "FocusTrapMixin",
|
2043
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2044
|
+
}
|
2077
2045
|
},
|
2078
2046
|
{
|
2079
|
-
"
|
2080
|
-
"name": "
|
2081
|
-
|
2082
|
-
|
2083
|
-
|
2084
|
-
|
2085
|
-
|
2086
|
-
|
2087
|
-
"type": {
|
2088
|
-
"text": "string | null"
|
2089
|
-
},
|
2090
|
-
"default": "null",
|
2091
|
-
"description": "Aria-label attribute to be set for accessibility",
|
2092
|
-
"attribute": "aria-label"
|
2047
|
+
"kind": "method",
|
2048
|
+
"name": "deactivateFocusTrap",
|
2049
|
+
"privacy": "public",
|
2050
|
+
"description": "Deactivate the focus trap.",
|
2051
|
+
"inheritedFrom": {
|
2052
|
+
"name": "FocusTrapMixin",
|
2053
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2054
|
+
}
|
2093
2055
|
},
|
2094
2056
|
{
|
2095
2057
|
"kind": "method",
|
2096
|
-
"name": "
|
2058
|
+
"name": "hasNoClientRects",
|
2097
2059
|
"privacy": "private",
|
2098
2060
|
"parameters": [
|
2099
2061
|
{
|
2100
|
-
"name": "
|
2062
|
+
"name": "element",
|
2101
2063
|
"type": {
|
2102
|
-
"text": "
|
2103
|
-
}
|
2064
|
+
"text": "HTMLElement"
|
2065
|
+
},
|
2066
|
+
"description": "The element to check."
|
2067
|
+
}
|
2068
|
+
],
|
2069
|
+
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
2070
|
+
"return": {
|
2071
|
+
"type": {
|
2072
|
+
"text": ""
|
2104
2073
|
}
|
2105
|
-
]
|
2106
|
-
},
|
2107
|
-
{
|
2108
|
-
"kind": "field",
|
2109
|
-
"name": "src",
|
2110
|
-
"type": {
|
2111
|
-
"text": "string | undefined"
|
2112
2074
|
},
|
2113
|
-
"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.",
|
2114
|
-
"attribute": "src",
|
2115
2075
|
"inheritedFrom": {
|
2116
|
-
"name": "
|
2117
|
-
"module": "utils/mixins/
|
2076
|
+
"name": "FocusTrapMixin",
|
2077
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2118
2078
|
}
|
2119
2079
|
},
|
2120
2080
|
{
|
2121
|
-
"kind": "
|
2122
|
-
"name": "
|
2123
|
-
"
|
2124
|
-
|
2081
|
+
"kind": "method",
|
2082
|
+
"name": "hasZeroDimensions",
|
2083
|
+
"privacy": "private",
|
2084
|
+
"parameters": [
|
2085
|
+
{
|
2086
|
+
"name": "element",
|
2087
|
+
"type": {
|
2088
|
+
"text": "HTMLElement"
|
2089
|
+
},
|
2090
|
+
"description": "The element to check."
|
2091
|
+
}
|
2092
|
+
],
|
2093
|
+
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
2094
|
+
"return": {
|
2095
|
+
"type": {
|
2096
|
+
"text": ""
|
2097
|
+
}
|
2125
2098
|
},
|
2126
|
-
"description": "The initials to be displayed for the avatar.",
|
2127
|
-
"attribute": "initials",
|
2128
2099
|
"inheritedFrom": {
|
2129
|
-
"name": "
|
2130
|
-
"module": "utils/mixins/
|
2100
|
+
"name": "FocusTrapMixin",
|
2101
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2131
2102
|
}
|
2132
2103
|
},
|
2133
2104
|
{
|
2134
|
-
"kind": "
|
2135
|
-
"name": "
|
2136
|
-
"
|
2137
|
-
|
2105
|
+
"kind": "method",
|
2106
|
+
"name": "isNotVisible",
|
2107
|
+
"privacy": "private",
|
2108
|
+
"parameters": [
|
2109
|
+
{
|
2110
|
+
"name": "element",
|
2111
|
+
"type": {
|
2112
|
+
"text": "HTMLElement"
|
2113
|
+
},
|
2114
|
+
"description": "The element to check."
|
2115
|
+
}
|
2116
|
+
],
|
2117
|
+
"description": "Determines if the element is not visible in the DOM.",
|
2118
|
+
"return": {
|
2119
|
+
"type": {
|
2120
|
+
"text": ""
|
2121
|
+
}
|
2138
2122
|
},
|
2139
|
-
"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`",
|
2140
|
-
"attribute": "presence",
|
2141
2123
|
"inheritedFrom": {
|
2142
|
-
"name": "
|
2143
|
-
"module": "utils/mixins/
|
2124
|
+
"name": "FocusTrapMixin",
|
2125
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2144
2126
|
}
|
2145
2127
|
},
|
2146
2128
|
{
|
2147
|
-
"kind": "
|
2148
|
-
"name": "
|
2149
|
-
"
|
2150
|
-
|
2129
|
+
"kind": "method",
|
2130
|
+
"name": "hasHiddenStyle",
|
2131
|
+
"privacy": "private",
|
2132
|
+
"parameters": [
|
2133
|
+
{
|
2134
|
+
"name": "element",
|
2135
|
+
"type": {
|
2136
|
+
"text": "HTMLElement"
|
2137
|
+
},
|
2138
|
+
"description": "The element to check."
|
2139
|
+
}
|
2140
|
+
],
|
2141
|
+
"description": "Checks if the element has inline styles that make it hidden.",
|
2142
|
+
"return": {
|
2143
|
+
"type": {
|
2144
|
+
"text": ""
|
2145
|
+
}
|
2151
2146
|
},
|
2152
|
-
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
2153
|
-
"default": "32",
|
2154
|
-
"attribute": "size",
|
2155
|
-
"reflects": true,
|
2156
2147
|
"inheritedFrom": {
|
2157
|
-
"name": "
|
2158
|
-
"module": "
|
2148
|
+
"name": "FocusTrapMixin",
|
2149
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2159
2150
|
}
|
2160
2151
|
},
|
2161
2152
|
{
|
2162
|
-
"kind": "
|
2163
|
-
"name": "
|
2164
|
-
"
|
2165
|
-
|
2153
|
+
"kind": "method",
|
2154
|
+
"name": "hasComputedHidden",
|
2155
|
+
"privacy": "private",
|
2156
|
+
"parameters": [
|
2157
|
+
{
|
2158
|
+
"name": "element",
|
2159
|
+
"type": {
|
2160
|
+
"text": "HTMLElement"
|
2161
|
+
},
|
2162
|
+
"description": "The element to check."
|
2163
|
+
}
|
2164
|
+
],
|
2165
|
+
"description": "Checks if the element is hidden by a computed style.",
|
2166
|
+
"return": {
|
2167
|
+
"type": {
|
2168
|
+
"text": ""
|
2169
|
+
}
|
2166
2170
|
},
|
2167
|
-
"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`.",
|
2168
|
-
"attribute": "counter",
|
2169
2171
|
"inheritedFrom": {
|
2170
|
-
"name": "
|
2171
|
-
"module": "utils/mixins/
|
2172
|
+
"name": "FocusTrapMixin",
|
2173
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2172
2174
|
}
|
2173
2175
|
},
|
2174
2176
|
{
|
2175
|
-
"kind": "
|
2176
|
-
"name": "
|
2177
|
-
"
|
2178
|
-
|
2177
|
+
"kind": "method",
|
2178
|
+
"name": "isHidden",
|
2179
|
+
"privacy": "private",
|
2180
|
+
"parameters": [
|
2181
|
+
{
|
2182
|
+
"name": "element",
|
2183
|
+
"type": {
|
2184
|
+
"text": "HTMLElement"
|
2185
|
+
},
|
2186
|
+
"description": "The element to check."
|
2187
|
+
}
|
2188
|
+
],
|
2189
|
+
"description": "Checks if the element is hidden from the user.",
|
2190
|
+
"return": {
|
2191
|
+
"type": {
|
2192
|
+
"text": ""
|
2193
|
+
}
|
2179
2194
|
},
|
2180
|
-
"default": "false",
|
2181
|
-
"description": "Represents the typing indicator when the user is typing.",
|
2182
|
-
"attribute": "is-typing",
|
2183
2195
|
"inheritedFrom": {
|
2184
|
-
"name": "
|
2185
|
-
"module": "utils/mixins/
|
2186
|
-
}
|
2187
|
-
},
|
2188
|
-
{
|
2189
|
-
"kind": "field",
|
2190
|
-
"name": "iconName",
|
2191
|
-
"type": {
|
2192
|
-
"text": "IconNames | undefined"
|
2193
|
-
},
|
2194
|
-
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
2195
|
-
"attribute": "icon-name",
|
2196
|
-
"inheritedFrom": {
|
2197
|
-
"name": "IconNameMixin",
|
2198
|
-
"module": "utils/mixins/IconNameMixin.js"
|
2199
|
-
}
|
2200
|
-
},
|
2201
|
-
{
|
2202
|
-
"kind": "field",
|
2203
|
-
"name": "autoFocusOnMount",
|
2204
|
-
"type": {
|
2205
|
-
"text": "boolean"
|
2206
|
-
},
|
2207
|
-
"default": "false",
|
2208
|
-
"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.",
|
2209
|
-
"attribute": "auto-focus-on-mount",
|
2210
|
-
"reflects": true,
|
2211
|
-
"inheritedFrom": {
|
2212
|
-
"name": "AutoFocusOnMountMixin",
|
2213
|
-
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
2214
|
-
}
|
2215
|
-
},
|
2216
|
-
{
|
2217
|
-
"kind": "field",
|
2218
|
-
"name": "tabIndex",
|
2219
|
-
"type": {
|
2220
|
-
"text": "number"
|
2221
|
-
},
|
2222
|
-
"default": "0",
|
2223
|
-
"description": "This property specifies the tab order of the element.",
|
2224
|
-
"attribute": "tabIndex",
|
2225
|
-
"reflects": true,
|
2226
|
-
"inheritedFrom": {
|
2227
|
-
"name": "TabIndexMixin",
|
2228
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
2229
|
-
}
|
2230
|
-
},
|
2231
|
-
{
|
2232
|
-
"kind": "field",
|
2233
|
-
"name": "disabled",
|
2234
|
-
"type": {
|
2235
|
-
"text": "boolean | undefined"
|
2236
|
-
},
|
2237
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
2238
|
-
"default": "undefined",
|
2239
|
-
"attribute": "disabled",
|
2240
|
-
"reflects": true,
|
2241
|
-
"inheritedFrom": {
|
2242
|
-
"name": "DisabledMixin",
|
2243
|
-
"module": "utils/mixins/DisabledMixin.js"
|
2244
|
-
}
|
2245
|
-
},
|
2246
|
-
{
|
2247
|
-
"kind": "field",
|
2248
|
-
"name": "active",
|
2249
|
-
"type": {
|
2250
|
-
"text": "boolean | undefined"
|
2251
|
-
},
|
2252
|
-
"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.",
|
2253
|
-
"default": "undefined",
|
2254
|
-
"attribute": "active",
|
2255
|
-
"reflects": true,
|
2256
|
-
"inheritedFrom": {
|
2257
|
-
"name": "Buttonsimple",
|
2258
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2259
|
-
}
|
2260
|
-
},
|
2261
|
-
{
|
2262
|
-
"kind": "field",
|
2263
|
-
"name": "softDisabled",
|
2264
|
-
"type": {
|
2265
|
-
"text": "boolean | undefined"
|
2266
|
-
},
|
2267
|
-
"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.",
|
2268
|
-
"default": "undefined",
|
2269
|
-
"attribute": "soft-disabled",
|
2270
|
-
"reflects": true,
|
2271
|
-
"inheritedFrom": {
|
2272
|
-
"name": "Buttonsimple",
|
2273
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2274
|
-
}
|
2275
|
-
},
|
2276
|
-
{
|
2277
|
-
"kind": "field",
|
2278
|
-
"name": "role",
|
2279
|
-
"type": {
|
2280
|
-
"text": "RoleType"
|
2281
|
-
},
|
2282
|
-
"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.",
|
2283
|
-
"default": "button",
|
2284
|
-
"attribute": "role",
|
2285
|
-
"reflects": true,
|
2286
|
-
"inheritedFrom": {
|
2287
|
-
"name": "Buttonsimple",
|
2288
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2289
|
-
}
|
2290
|
-
},
|
2291
|
-
{
|
2292
|
-
"kind": "field",
|
2293
|
-
"name": "ariaStateKey",
|
2294
|
-
"type": {
|
2295
|
-
"text": "string | undefined"
|
2296
|
-
},
|
2297
|
-
"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`",
|
2298
|
-
"default": "'aria-pressed' (when)",
|
2299
|
-
"attribute": "ariaStateKey",
|
2300
|
-
"reflects": true,
|
2301
|
-
"inheritedFrom": {
|
2302
|
-
"name": "Buttonsimple",
|
2303
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2304
|
-
}
|
2305
|
-
},
|
2306
|
-
{
|
2307
|
-
"kind": "field",
|
2308
|
-
"name": "type",
|
2309
|
-
"type": {
|
2310
|
-
"text": "ButtonType"
|
2311
|
-
},
|
2312
|
-
"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.",
|
2313
|
-
"default": "button",
|
2314
|
-
"attribute": "type",
|
2315
|
-
"reflects": true,
|
2316
|
-
"inheritedFrom": {
|
2317
|
-
"name": "Buttonsimple",
|
2318
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2319
|
-
}
|
2320
|
-
},
|
2321
|
-
{
|
2322
|
-
"kind": "field",
|
2323
|
-
"name": "name",
|
2324
|
-
"type": {
|
2325
|
-
"text": "string | undefined"
|
2326
|
-
},
|
2327
|
-
"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.",
|
2328
|
-
"attribute": "name",
|
2329
|
-
"reflects": true,
|
2330
|
-
"inheritedFrom": {
|
2331
|
-
"name": "Buttonsimple",
|
2332
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2333
|
-
}
|
2334
|
-
},
|
2335
|
-
{
|
2336
|
-
"kind": "field",
|
2337
|
-
"name": "value",
|
2338
|
-
"type": {
|
2339
|
-
"text": "string | undefined"
|
2340
|
-
},
|
2341
|
-
"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.",
|
2342
|
-
"attribute": "value",
|
2343
|
-
"reflects": true,
|
2344
|
-
"inheritedFrom": {
|
2345
|
-
"name": "Buttonsimple",
|
2346
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2196
|
+
"name": "FocusTrapMixin",
|
2197
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2347
2198
|
}
|
2348
2199
|
},
|
2349
2200
|
{
|
2350
2201
|
"kind": "method",
|
2351
|
-
"name": "
|
2352
|
-
"privacy": "
|
2202
|
+
"name": "isDisabled",
|
2203
|
+
"privacy": "private",
|
2204
|
+
"parameters": [
|
2205
|
+
{
|
2206
|
+
"name": "element",
|
2207
|
+
"type": {
|
2208
|
+
"text": "any"
|
2209
|
+
},
|
2210
|
+
"description": "The element to check."
|
2211
|
+
}
|
2212
|
+
],
|
2213
|
+
"description": "Checks if the element is disabled.",
|
2214
|
+
"return": {
|
2215
|
+
"type": {
|
2216
|
+
"text": ""
|
2217
|
+
}
|
2218
|
+
},
|
2353
2219
|
"inheritedFrom": {
|
2354
|
-
"name": "
|
2355
|
-
"module": "
|
2220
|
+
"name": "FocusTrapMixin",
|
2221
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2356
2222
|
}
|
2357
2223
|
},
|
2358
2224
|
{
|
2359
2225
|
"kind": "method",
|
2360
|
-
"name": "
|
2361
|
-
"privacy": "
|
2226
|
+
"name": "isNotTabbable",
|
2227
|
+
"privacy": "private",
|
2362
2228
|
"parameters": [
|
2363
2229
|
{
|
2364
2230
|
"name": "element",
|
2365
2231
|
"type": {
|
2366
2232
|
"text": "HTMLElement"
|
2367
2233
|
},
|
2368
|
-
"description": "The
|
2369
|
-
},
|
2370
|
-
{
|
2371
|
-
"name": "active",
|
2372
|
-
"optional": true,
|
2373
|
-
"type": {
|
2374
|
-
"text": "boolean"
|
2375
|
-
},
|
2376
|
-
"description": "The active state of the element"
|
2234
|
+
"description": "The element to check."
|
2377
2235
|
}
|
2378
2236
|
],
|
2379
|
-
"description": "
|
2237
|
+
"description": "Checks if the element is not tabbable.",
|
2238
|
+
"return": {
|
2239
|
+
"type": {
|
2240
|
+
"text": ""
|
2241
|
+
}
|
2242
|
+
},
|
2380
2243
|
"inheritedFrom": {
|
2381
|
-
"name": "
|
2382
|
-
"module": "
|
2244
|
+
"name": "FocusTrapMixin",
|
2245
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2383
2246
|
}
|
2384
2247
|
},
|
2385
2248
|
{
|
2386
2249
|
"kind": "method",
|
2387
|
-
"name": "
|
2250
|
+
"name": "isInteractiveElement",
|
2388
2251
|
"privacy": "private",
|
2252
|
+
"return": {
|
2253
|
+
"type": {
|
2254
|
+
"text": ""
|
2255
|
+
}
|
2256
|
+
},
|
2389
2257
|
"parameters": [
|
2390
2258
|
{
|
2391
2259
|
"name": "element",
|
2392
2260
|
"type": {
|
2393
2261
|
"text": "HTMLElement"
|
2394
2262
|
},
|
2395
|
-
"description": "The
|
2396
|
-
},
|
2397
|
-
{
|
2398
|
-
"name": "softDisabled",
|
2399
|
-
"optional": true,
|
2400
|
-
"type": {
|
2401
|
-
"text": "boolean"
|
2402
|
-
},
|
2403
|
-
"description": "The soft-disabled state."
|
2263
|
+
"description": "The element to check."
|
2404
2264
|
}
|
2405
2265
|
],
|
2406
|
-
"description": "
|
2266
|
+
"description": "Checks if the element is interactive.",
|
2407
2267
|
"inheritedFrom": {
|
2408
|
-
"name": "
|
2409
|
-
"module": "
|
2268
|
+
"name": "FocusTrapMixin",
|
2269
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2410
2270
|
}
|
2411
2271
|
},
|
2412
2272
|
{
|
2413
2273
|
"kind": "method",
|
2414
|
-
"name": "
|
2274
|
+
"name": "isFocusable",
|
2415
2275
|
"privacy": "private",
|
2416
2276
|
"parameters": [
|
2417
2277
|
{
|
@@ -2419,1743 +2279,1883 @@
|
|
2419
2279
|
"type": {
|
2420
2280
|
"text": "HTMLElement"
|
2421
2281
|
},
|
2422
|
-
"description": "The
|
2423
|
-
},
|
2424
|
-
{
|
2425
|
-
"name": "disabled",
|
2426
|
-
"type": {
|
2427
|
-
"text": "boolean"
|
2428
|
-
},
|
2429
|
-
"description": "The disabled state."
|
2282
|
+
"description": "The element to check."
|
2430
2283
|
}
|
2431
2284
|
],
|
2432
|
-
"description": "
|
2285
|
+
"description": "Checks if the element is focusable.",
|
2286
|
+
"return": {
|
2287
|
+
"type": {
|
2288
|
+
"text": ""
|
2289
|
+
}
|
2290
|
+
},
|
2433
2291
|
"inheritedFrom": {
|
2434
|
-
"name": "
|
2435
|
-
"module": "
|
2292
|
+
"name": "FocusTrapMixin",
|
2293
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2436
2294
|
}
|
2437
2295
|
},
|
2438
2296
|
{
|
2439
2297
|
"kind": "method",
|
2440
|
-
"name": "
|
2298
|
+
"name": "findFocusable",
|
2441
2299
|
"privacy": "private",
|
2300
|
+
"return": {
|
2301
|
+
"type": {
|
2302
|
+
"text": ""
|
2303
|
+
}
|
2304
|
+
},
|
2305
|
+
"parameters": [
|
2306
|
+
{
|
2307
|
+
"name": "root",
|
2308
|
+
"type": {
|
2309
|
+
"text": "ShadowRoot | HTMLElement"
|
2310
|
+
},
|
2311
|
+
"description": "The root element to search for focusable elements."
|
2312
|
+
},
|
2313
|
+
{
|
2314
|
+
"name": "matches",
|
2315
|
+
"default": "new Set()",
|
2316
|
+
"type": {
|
2317
|
+
"text": "Set<HTMLElement>"
|
2318
|
+
},
|
2319
|
+
"description": "The set of focusable elements."
|
2320
|
+
}
|
2321
|
+
],
|
2322
|
+
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
2442
2323
|
"inheritedFrom": {
|
2443
|
-
"name": "
|
2444
|
-
"module": "
|
2445
|
-
}
|
2446
|
-
},
|
2447
|
-
{
|
2448
|
-
"kind": "method",
|
2449
|
-
"name": "handleBlur",
|
2450
|
-
"privacy": "private",
|
2451
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
2452
|
-
"inheritedFrom": {
|
2453
|
-
"name": "Buttonsimple",
|
2454
|
-
"module": "components/buttonsimple/buttonsimple.component.js"
|
2324
|
+
"name": "FocusTrapMixin",
|
2325
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2455
2326
|
}
|
2456
2327
|
},
|
2457
2328
|
{
|
2458
2329
|
"kind": "method",
|
2459
|
-
"name": "
|
2330
|
+
"name": "setFocusableElements",
|
2460
2331
|
"privacy": "private",
|
2332
|
+
"description": "Updates the list of focusable elements within the component's shadow root.",
|
2333
|
+
"inheritedFrom": {
|
2334
|
+
"name": "FocusTrapMixin",
|
2335
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2336
|
+
}
|
2337
|
+
},
|
2338
|
+
{
|
2339
|
+
"kind": "method",
|
2340
|
+
"name": "setInitialFocus",
|
2341
|
+
"privacy": "public",
|
2461
2342
|
"parameters": [
|
2462
2343
|
{
|
2463
|
-
"name": "
|
2344
|
+
"name": "elementIndexToReceiveFocus",
|
2345
|
+
"default": "0",
|
2464
2346
|
"type": {
|
2465
|
-
"text": "
|
2347
|
+
"text": "number"
|
2466
2348
|
},
|
2467
|
-
"description": "The
|
2349
|
+
"description": "The index of the preferable element to focus."
|
2468
2350
|
}
|
2469
2351
|
],
|
2470
|
-
"description": "
|
2352
|
+
"description": "Sets the initial focus within the container.",
|
2471
2353
|
"inheritedFrom": {
|
2472
|
-
"name": "
|
2473
|
-
"module": "
|
2354
|
+
"name": "FocusTrapMixin",
|
2355
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2474
2356
|
}
|
2475
2357
|
},
|
2476
2358
|
{
|
2477
2359
|
"kind": "method",
|
2478
|
-
"name": "
|
2360
|
+
"name": "calculateNextIndex",
|
2479
2361
|
"privacy": "private",
|
2480
2362
|
"parameters": [
|
2481
2363
|
{
|
2482
|
-
"name": "
|
2364
|
+
"name": "currentIndex",
|
2483
2365
|
"type": {
|
2484
|
-
"text": "
|
2366
|
+
"text": "number"
|
2485
2367
|
},
|
2486
|
-
"description": "The
|
2368
|
+
"description": "The current index."
|
2369
|
+
},
|
2370
|
+
{
|
2371
|
+
"name": "step",
|
2372
|
+
"type": {
|
2373
|
+
"text": "number"
|
2374
|
+
},
|
2375
|
+
"description": "The step to calculate the next index."
|
2487
2376
|
}
|
2488
2377
|
],
|
2489
|
-
"description": "
|
2378
|
+
"description": "Calculates the next index for the focus trap.",
|
2379
|
+
"return": {
|
2380
|
+
"type": {
|
2381
|
+
"text": ""
|
2382
|
+
}
|
2383
|
+
},
|
2490
2384
|
"inheritedFrom": {
|
2491
|
-
"name": "
|
2492
|
-
"module": "
|
2385
|
+
"name": "FocusTrapMixin",
|
2386
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2493
2387
|
}
|
2494
|
-
}
|
2495
|
-
],
|
2496
|
-
"events": [
|
2388
|
+
},
|
2497
2389
|
{
|
2498
|
-
"
|
2499
|
-
"name": "
|
2500
|
-
"
|
2390
|
+
"kind": "method",
|
2391
|
+
"name": "getDeepActiveElement",
|
2392
|
+
"privacy": "private",
|
2393
|
+
"description": "Returns the deepest active element in the shadow DOM.",
|
2394
|
+
"return": {
|
2395
|
+
"type": {
|
2396
|
+
"text": ""
|
2397
|
+
}
|
2398
|
+
},
|
2501
2399
|
"inheritedFrom": {
|
2502
|
-
"name": "
|
2503
|
-
"module": "
|
2400
|
+
"name": "FocusTrapMixin",
|
2401
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2504
2402
|
}
|
2505
2403
|
},
|
2506
2404
|
{
|
2507
|
-
"
|
2508
|
-
"name": "
|
2509
|
-
"
|
2405
|
+
"kind": "method",
|
2406
|
+
"name": "findElement",
|
2407
|
+
"privacy": "private",
|
2408
|
+
"parameters": [
|
2409
|
+
{
|
2410
|
+
"name": "activeElement",
|
2411
|
+
"type": {
|
2412
|
+
"text": "HTMLElement"
|
2413
|
+
},
|
2414
|
+
"description": "The active element."
|
2415
|
+
}
|
2416
|
+
],
|
2417
|
+
"description": "Finds the index of the active element within the focusable elements.",
|
2418
|
+
"return": {
|
2419
|
+
"type": {
|
2420
|
+
"text": ""
|
2421
|
+
}
|
2422
|
+
},
|
2510
2423
|
"inheritedFrom": {
|
2511
|
-
"name": "
|
2512
|
-
"module": "
|
2424
|
+
"name": "FocusTrapMixin",
|
2425
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2513
2426
|
}
|
2514
2427
|
},
|
2515
2428
|
{
|
2516
|
-
"
|
2517
|
-
"name": "
|
2518
|
-
"
|
2429
|
+
"kind": "method",
|
2430
|
+
"name": "isEqualFocusNode",
|
2431
|
+
"privacy": "private",
|
2432
|
+
"parameters": [
|
2433
|
+
{
|
2434
|
+
"name": "activeElement",
|
2435
|
+
"type": {
|
2436
|
+
"text": "HTMLElement"
|
2437
|
+
},
|
2438
|
+
"description": "The active element."
|
2439
|
+
},
|
2440
|
+
{
|
2441
|
+
"name": "element",
|
2442
|
+
"type": {
|
2443
|
+
"text": "HTMLElement"
|
2444
|
+
},
|
2445
|
+
"description": "The element to compare."
|
2446
|
+
}
|
2447
|
+
],
|
2448
|
+
"description": "Checks if the active element is equal to the given element.",
|
2449
|
+
"return": {
|
2450
|
+
"type": {
|
2451
|
+
"text": ""
|
2452
|
+
}
|
2453
|
+
},
|
2519
2454
|
"inheritedFrom": {
|
2520
|
-
"name": "
|
2521
|
-
"module": "
|
2455
|
+
"name": "FocusTrapMixin",
|
2456
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2522
2457
|
}
|
2523
2458
|
},
|
2524
2459
|
{
|
2525
|
-
"
|
2526
|
-
"name": "
|
2527
|
-
"
|
2460
|
+
"kind": "method",
|
2461
|
+
"name": "trapFocus",
|
2462
|
+
"privacy": "private",
|
2463
|
+
"parameters": [
|
2464
|
+
{
|
2465
|
+
"name": "event",
|
2466
|
+
"type": {
|
2467
|
+
"text": "KeyboardEvent"
|
2468
|
+
}
|
2469
|
+
},
|
2470
|
+
{
|
2471
|
+
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
2472
|
+
"name": "direction"
|
2473
|
+
}
|
2474
|
+
],
|
2475
|
+
"description": "Traps focus within the container.",
|
2528
2476
|
"inheritedFrom": {
|
2529
|
-
"name": "
|
2530
|
-
"module": "
|
2477
|
+
"name": "FocusTrapMixin",
|
2478
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2531
2479
|
}
|
2532
|
-
}
|
2533
|
-
],
|
2534
|
-
"attributes": [
|
2480
|
+
},
|
2535
2481
|
{
|
2536
|
-
"
|
2537
|
-
"
|
2538
|
-
|
2539
|
-
|
2540
|
-
|
2541
|
-
|
2542
|
-
|
2482
|
+
"kind": "method",
|
2483
|
+
"name": "handleTabKeydown",
|
2484
|
+
"privacy": "private",
|
2485
|
+
"parameters": [
|
2486
|
+
{
|
2487
|
+
"name": "event",
|
2488
|
+
"type": {
|
2489
|
+
"text": "KeyboardEvent"
|
2490
|
+
},
|
2491
|
+
"description": "The keyboard event."
|
2492
|
+
}
|
2493
|
+
],
|
2494
|
+
"description": "Traps focus within the container.",
|
2495
|
+
"inheritedFrom": {
|
2496
|
+
"name": "FocusTrapMixin",
|
2497
|
+
"module": "utils/mixins/FocusTrapMixin.js"
|
2498
|
+
}
|
2543
2499
|
},
|
2544
2500
|
{
|
2545
|
-
"
|
2546
|
-
"
|
2547
|
-
|
2501
|
+
"kind": "method",
|
2502
|
+
"name": "renderFooter",
|
2503
|
+
"privacy": "protected",
|
2504
|
+
"description": "Renders the footer of the card if footer-link,\nfooter-button-primary, or footer-button-secondary slots are provided",
|
2505
|
+
"return": {
|
2506
|
+
"type": {
|
2507
|
+
"text": ""
|
2508
|
+
}
|
2548
2509
|
},
|
2549
|
-
"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.",
|
2550
|
-
"fieldName": "src",
|
2551
2510
|
"inheritedFrom": {
|
2552
|
-
"name": "
|
2553
|
-
"module": "
|
2511
|
+
"name": "FooterMixin",
|
2512
|
+
"module": "utils/mixins/FooterMixin.js"
|
2554
2513
|
}
|
2555
2514
|
},
|
2556
2515
|
{
|
2557
|
-
"
|
2516
|
+
"kind": "field",
|
2517
|
+
"name": "id",
|
2558
2518
|
"type": {
|
2559
|
-
"text": "string
|
2519
|
+
"text": "string"
|
2560
2520
|
},
|
2561
|
-
"
|
2562
|
-
"
|
2521
|
+
"default": "''",
|
2522
|
+
"description": "The unique ID of the dialog",
|
2523
|
+
"attribute": "id",
|
2524
|
+
"reflects": true,
|
2563
2525
|
"inheritedFrom": {
|
2564
|
-
"name": "
|
2565
|
-
"module": "
|
2526
|
+
"name": "Dialog",
|
2527
|
+
"module": "components/dialog/dialog.component.js"
|
2566
2528
|
}
|
2567
2529
|
},
|
2568
2530
|
{
|
2569
|
-
"
|
2531
|
+
"kind": "field",
|
2532
|
+
"name": "triggerId",
|
2570
2533
|
"type": {
|
2571
|
-
"text": "
|
2534
|
+
"text": "string | undefined"
|
2572
2535
|
},
|
2573
|
-
"description": "The
|
2574
|
-
"
|
2536
|
+
"description": "The ID of the element that triggers the dialog",
|
2537
|
+
"default": "undefined",
|
2538
|
+
"attribute": "triggerId",
|
2539
|
+
"reflects": true,
|
2575
2540
|
"inheritedFrom": {
|
2576
|
-
"name": "
|
2577
|
-
"module": "
|
2541
|
+
"name": "Dialog",
|
2542
|
+
"module": "components/dialog/dialog.component.js"
|
2578
2543
|
}
|
2579
2544
|
},
|
2580
2545
|
{
|
2581
|
-
"
|
2546
|
+
"kind": "field",
|
2547
|
+
"name": "visible",
|
2582
2548
|
"type": {
|
2583
|
-
"text": "
|
2549
|
+
"text": "boolean"
|
2584
2550
|
},
|
2585
|
-
"description": "
|
2586
|
-
"default": "
|
2587
|
-
"
|
2551
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
2552
|
+
"default": "false",
|
2553
|
+
"attribute": "visible",
|
2554
|
+
"reflects": true,
|
2588
2555
|
"inheritedFrom": {
|
2589
|
-
"name": "
|
2590
|
-
"module": "
|
2556
|
+
"name": "Dialog",
|
2557
|
+
"module": "components/dialog/dialog.component.js"
|
2591
2558
|
}
|
2592
2559
|
},
|
2593
2560
|
{
|
2594
|
-
"
|
2561
|
+
"kind": "field",
|
2562
|
+
"name": "variant",
|
2595
2563
|
"type": {
|
2596
|
-
"text": "
|
2564
|
+
"text": "DialogVariant"
|
2597
2565
|
},
|
2598
|
-
"description": "The
|
2599
|
-
"
|
2566
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
2567
|
+
"default": "default",
|
2568
|
+
"attribute": "variant",
|
2569
|
+
"reflects": true,
|
2600
2570
|
"inheritedFrom": {
|
2601
|
-
"name": "
|
2602
|
-
"module": "
|
2571
|
+
"name": "Dialog",
|
2572
|
+
"module": "components/dialog/dialog.component.js"
|
2603
2573
|
}
|
2604
2574
|
},
|
2605
2575
|
{
|
2606
|
-
"
|
2576
|
+
"kind": "field",
|
2577
|
+
"name": "closeButtonAriaLabel",
|
2607
2578
|
"type": {
|
2608
|
-
"text": "
|
2579
|
+
"text": "string | null"
|
2609
2580
|
},
|
2610
|
-
"default": "
|
2611
|
-
"description": "
|
2612
|
-
"
|
2581
|
+
"default": "null",
|
2582
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
2583
|
+
"attribute": "close-button-aria-label",
|
2613
2584
|
"inheritedFrom": {
|
2614
|
-
"name": "
|
2615
|
-
"module": "
|
2585
|
+
"name": "Dialog",
|
2586
|
+
"module": "components/dialog/dialog.component.js"
|
2616
2587
|
}
|
2617
2588
|
},
|
2618
2589
|
{
|
2619
|
-
"
|
2590
|
+
"kind": "field",
|
2591
|
+
"name": "ariaLabel",
|
2620
2592
|
"type": {
|
2621
|
-
"text": "
|
2593
|
+
"text": "string | null"
|
2622
2594
|
},
|
2623
|
-
"
|
2624
|
-
"
|
2595
|
+
"default": "null",
|
2596
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
2597
|
+
"attribute": "aria-label",
|
2598
|
+
"reflects": true,
|
2625
2599
|
"inheritedFrom": {
|
2626
|
-
"name": "
|
2627
|
-
"module": "
|
2600
|
+
"name": "Dialog",
|
2601
|
+
"module": "components/dialog/dialog.component.js"
|
2628
2602
|
}
|
2629
2603
|
},
|
2630
2604
|
{
|
2631
|
-
"
|
2605
|
+
"kind": "field",
|
2606
|
+
"name": "ariaLabelledby",
|
2632
2607
|
"type": {
|
2633
|
-
"text": "
|
2608
|
+
"text": "string | null"
|
2634
2609
|
},
|
2635
|
-
"default": "
|
2636
|
-
"description": "
|
2637
|
-
"
|
2610
|
+
"default": "null",
|
2611
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
2612
|
+
"attribute": "aria-labelledby",
|
2613
|
+
"reflects": true,
|
2638
2614
|
"inheritedFrom": {
|
2639
|
-
"name": "
|
2640
|
-
"module": "
|
2615
|
+
"name": "Dialog",
|
2616
|
+
"module": "components/dialog/dialog.component.js"
|
2641
2617
|
}
|
2642
2618
|
},
|
2643
2619
|
{
|
2644
|
-
"
|
2620
|
+
"kind": "field",
|
2621
|
+
"name": "ariaDescribedBy",
|
2645
2622
|
"type": {
|
2646
|
-
"text": "
|
2623
|
+
"text": "string | null"
|
2647
2624
|
},
|
2648
|
-
"default": "
|
2649
|
-
"description": "
|
2650
|
-
"
|
2625
|
+
"default": "null",
|
2626
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
2627
|
+
"attribute": "aria-describedby",
|
2628
|
+
"reflects": true,
|
2651
2629
|
"inheritedFrom": {
|
2652
|
-
"name": "
|
2653
|
-
"module": "
|
2630
|
+
"name": "Dialog",
|
2631
|
+
"module": "components/dialog/dialog.component.js"
|
2654
2632
|
}
|
2655
2633
|
},
|
2656
2634
|
{
|
2657
|
-
"
|
2635
|
+
"kind": "field",
|
2636
|
+
"name": "ariaDescription",
|
2658
2637
|
"type": {
|
2659
|
-
"text": "
|
2638
|
+
"text": "string | null"
|
2660
2639
|
},
|
2661
|
-
"
|
2662
|
-
"
|
2663
|
-
"
|
2640
|
+
"default": "null",
|
2641
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
2642
|
+
"attribute": "aria-description",
|
2643
|
+
"reflects": true,
|
2664
2644
|
"inheritedFrom": {
|
2665
|
-
"name": "
|
2666
|
-
"module": "
|
2645
|
+
"name": "Dialog",
|
2646
|
+
"module": "components/dialog/dialog.component.js"
|
2667
2647
|
}
|
2668
2648
|
},
|
2669
2649
|
{
|
2670
|
-
"
|
2650
|
+
"kind": "field",
|
2651
|
+
"name": "headerText",
|
2671
2652
|
"type": {
|
2672
|
-
"text": "
|
2653
|
+
"text": "string | undefined"
|
2673
2654
|
},
|
2674
|
-
"description": "
|
2675
|
-
"
|
2676
|
-
"
|
2655
|
+
"description": "Defines a string value to display as the title of the dialog",
|
2656
|
+
"attribute": "header-text",
|
2657
|
+
"reflects": true,
|
2677
2658
|
"inheritedFrom": {
|
2678
|
-
"name": "
|
2679
|
-
"module": "
|
2659
|
+
"name": "Dialog",
|
2660
|
+
"module": "components/dialog/dialog.component.js"
|
2680
2661
|
}
|
2681
2662
|
},
|
2682
2663
|
{
|
2683
|
-
"
|
2664
|
+
"kind": "field",
|
2665
|
+
"name": "descriptionText",
|
2684
2666
|
"type": {
|
2685
|
-
"text": "
|
2667
|
+
"text": "string | undefined"
|
2686
2668
|
},
|
2687
|
-
"description": "
|
2688
|
-
"
|
2689
|
-
"
|
2669
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
2670
|
+
"attribute": "description-text",
|
2671
|
+
"reflects": true,
|
2690
2672
|
"inheritedFrom": {
|
2691
|
-
"name": "
|
2692
|
-
"module": "
|
2673
|
+
"name": "Dialog",
|
2674
|
+
"module": "components/dialog/dialog.component.js"
|
2693
2675
|
}
|
2694
2676
|
},
|
2695
2677
|
{
|
2696
|
-
"
|
2678
|
+
"kind": "field",
|
2679
|
+
"name": "headerTagName",
|
2697
2680
|
"type": {
|
2698
|
-
"text": "
|
2681
|
+
"text": "string"
|
2699
2682
|
},
|
2700
|
-
"description": "
|
2701
|
-
"
|
2702
|
-
"
|
2683
|
+
"description": "The html tag to be used for the header text",
|
2684
|
+
"attribute": "header-tag-name",
|
2685
|
+
"reflects": true,
|
2703
2686
|
"inheritedFrom": {
|
2704
|
-
"name": "
|
2705
|
-
"module": "
|
2687
|
+
"name": "Dialog",
|
2688
|
+
"module": "components/dialog/dialog.component.js"
|
2706
2689
|
}
|
2707
2690
|
},
|
2708
2691
|
{
|
2709
|
-
"
|
2692
|
+
"kind": "field",
|
2693
|
+
"name": "descriptionTagName",
|
2710
2694
|
"type": {
|
2711
|
-
"text": "string
|
2695
|
+
"text": "string"
|
2712
2696
|
},
|
2713
|
-
"description": "
|
2714
|
-
"
|
2715
|
-
"
|
2697
|
+
"description": "The html tag to be used for the below-header description text",
|
2698
|
+
"attribute": "description-tag-name",
|
2699
|
+
"reflects": true,
|
2716
2700
|
"inheritedFrom": {
|
2717
|
-
"name": "
|
2718
|
-
"module": "
|
2701
|
+
"name": "Dialog",
|
2702
|
+
"module": "components/dialog/dialog.component.js"
|
2719
2703
|
}
|
2720
2704
|
},
|
2721
2705
|
{
|
2722
|
-
"
|
2706
|
+
"kind": "field",
|
2707
|
+
"name": "role",
|
2723
2708
|
"type": {
|
2724
|
-
"text": "
|
2709
|
+
"text": "DialogRole"
|
2725
2710
|
},
|
2726
|
-
"description": "
|
2727
|
-
"default": "
|
2728
|
-
"
|
2711
|
+
"description": "Role of the dialog",
|
2712
|
+
"default": "dialog",
|
2713
|
+
"attribute": "role",
|
2714
|
+
"reflects": true,
|
2729
2715
|
"inheritedFrom": {
|
2730
|
-
"name": "
|
2731
|
-
"module": "
|
2716
|
+
"name": "Dialog",
|
2717
|
+
"module": "components/dialog/dialog.component.js"
|
2732
2718
|
}
|
2733
2719
|
},
|
2734
2720
|
{
|
2735
|
-
"
|
2721
|
+
"kind": "field",
|
2722
|
+
"name": "disableAriaHasPopup",
|
2736
2723
|
"type": {
|
2737
|
-
"text": "
|
2724
|
+
"text": "boolean"
|
2738
2725
|
},
|
2739
|
-
"description": "
|
2740
|
-
"
|
2726
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
2727
|
+
"default": "false",
|
2728
|
+
"attribute": "disable-aria-haspopup",
|
2729
|
+
"reflects": true,
|
2741
2730
|
"inheritedFrom": {
|
2742
|
-
"name": "
|
2743
|
-
"module": "
|
2731
|
+
"name": "Dialog",
|
2732
|
+
"module": "components/dialog/dialog.component.js"
|
2744
2733
|
}
|
2745
2734
|
},
|
2746
2735
|
{
|
2747
|
-
"
|
2748
|
-
"
|
2749
|
-
|
2750
|
-
|
2751
|
-
"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.",
|
2752
|
-
"fieldName": "value",
|
2736
|
+
"kind": "method",
|
2737
|
+
"name": "closeDialog",
|
2738
|
+
"privacy": "private",
|
2739
|
+
"description": "Fired when Close Button is clicked or Escape key is pressed.\nThis method dispatches the close event. Setting visible to false\nhas to be done by the consumer of the component.",
|
2753
2740
|
"inheritedFrom": {
|
2754
|
-
"name": "
|
2755
|
-
"module": "
|
2741
|
+
"name": "Dialog",
|
2742
|
+
"module": "components/dialog/dialog.component.js"
|
2743
|
+
}
|
2744
|
+
},
|
2745
|
+
{
|
2746
|
+
"kind": "method",
|
2747
|
+
"name": "isOpenUpdated",
|
2748
|
+
"privacy": "private",
|
2749
|
+
"parameters": [
|
2750
|
+
{
|
2751
|
+
"name": "oldValue",
|
2752
|
+
"type": {
|
2753
|
+
"text": "boolean | undefined"
|
2754
|
+
},
|
2755
|
+
"description": "The old value of the visible property."
|
2756
|
+
},
|
2757
|
+
{
|
2758
|
+
"name": "newValue",
|
2759
|
+
"type": {
|
2760
|
+
"text": "boolean"
|
2761
|
+
},
|
2762
|
+
"description": "The new value of the visible property."
|
2763
|
+
}
|
2764
|
+
],
|
2765
|
+
"description": "Handles the dialog visibility change.\nHandles the exit event to close the dialog.",
|
2766
|
+
"inheritedFrom": {
|
2767
|
+
"name": "Dialog",
|
2768
|
+
"module": "components/dialog/dialog.component.js"
|
2756
2769
|
}
|
2757
2770
|
}
|
2758
2771
|
],
|
2759
|
-
"
|
2772
|
+
"events": [
|
2760
2773
|
{
|
2761
|
-
"
|
2762
|
-
"
|
2774
|
+
"description": "(React: onShown) Dispatched when the dialog is shown",
|
2775
|
+
"name": "shown",
|
2776
|
+
"reactName": "onShown",
|
2777
|
+
"inheritedFrom": {
|
2778
|
+
"name": "Dialog",
|
2779
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2780
|
+
}
|
2763
2781
|
},
|
2764
2782
|
{
|
2765
|
-
"
|
2766
|
-
"
|
2767
|
-
|
2768
|
-
],
|
2769
|
-
"superclass": {
|
2770
|
-
"name": "Buttonsimple",
|
2771
|
-
"module": "/src/components/buttonsimple/buttonsimple.component"
|
2772
|
-
},
|
2773
|
-
"tagName": "mdc-avatarbutton",
|
2774
|
-
"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 */",
|
2775
|
-
"customElement": true
|
2776
|
-
}
|
2777
|
-
],
|
2778
|
-
"exports": [
|
2779
|
-
{
|
2780
|
-
"kind": "js",
|
2781
|
-
"name": "default",
|
2782
|
-
"declaration": {
|
2783
|
-
"name": "AvatarButton",
|
2784
|
-
"module": "components/avatarbutton/avatarbutton.component.js"
|
2785
|
-
}
|
2786
|
-
}
|
2787
|
-
]
|
2788
|
-
},
|
2789
|
-
{
|
2790
|
-
"kind": "javascript-module",
|
2791
|
-
"path": "components/appheader/appheader.component.js",
|
2792
|
-
"declarations": [
|
2793
|
-
{
|
2794
|
-
"kind": "class",
|
2795
|
-
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
2796
|
-
"name": "Appheader",
|
2797
|
-
"cssParts": [
|
2798
|
-
{
|
2799
|
-
"description": "The main container for styling the header.",
|
2800
|
-
"name": "container"
|
2801
|
-
},
|
2802
|
-
{
|
2803
|
-
"description": "The leading section of the header.",
|
2804
|
-
"name": "leading-section"
|
2805
|
-
},
|
2806
|
-
{
|
2807
|
-
"description": "The center section of the header.",
|
2808
|
-
"name": "center-section"
|
2809
|
-
},
|
2810
|
-
{
|
2811
|
-
"description": "The trailing section of the header.",
|
2812
|
-
"name": "trailing-section"
|
2813
|
-
}
|
2814
|
-
],
|
2815
|
-
"slots": [
|
2816
|
-
{
|
2817
|
-
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
2818
|
-
"name": "leading"
|
2819
|
-
},
|
2820
|
-
{
|
2821
|
-
"description": "Slot for the center section (e.g., search bar, icons).",
|
2822
|
-
"name": "center"
|
2823
|
-
},
|
2824
|
-
{
|
2825
|
-
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
2826
|
-
"name": "trailing"
|
2827
|
-
}
|
2828
|
-
],
|
2829
|
-
"members": [],
|
2830
|
-
"superclass": {
|
2831
|
-
"name": "Component",
|
2832
|
-
"module": "/src/models"
|
2833
|
-
},
|
2834
|
-
"tagName": "mdc-appheader",
|
2835
|
-
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
2836
|
-
"customElement": true
|
2837
|
-
}
|
2838
|
-
],
|
2839
|
-
"exports": [
|
2840
|
-
{
|
2841
|
-
"kind": "js",
|
2842
|
-
"name": "default",
|
2843
|
-
"declaration": {
|
2844
|
-
"name": "Appheader",
|
2845
|
-
"module": "components/appheader/appheader.component.js"
|
2846
|
-
}
|
2847
|
-
}
|
2848
|
-
]
|
2849
|
-
},
|
2850
|
-
{
|
2851
|
-
"kind": "javascript-module",
|
2852
|
-
"path": "components/announcementdialog/announcementdialog.component.js",
|
2853
|
-
"declarations": [
|
2854
|
-
{
|
2855
|
-
"kind": "class",
|
2856
|
-
"description": "AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\nIt can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\nThe dialog is available in 4 sizes: medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\nThe dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n\nThe dialog can be controlled solely through the `visible` property, no trigger element is required.\nIf a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\nremember the previously focused element before the dialog was opened.\n\nThe dialog is a controlled component, meaning it does not have its own state management for visibility.\nUse the `visible` property to control the visibility of the dialog.\nUse the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\nor Escape is pressed).\n\n**Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n\n- The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n- Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n\n**Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n- Use `?visible=true/false` as an attribute instead of `visible=true/false`\n- Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions",
|
2857
|
-
"name": "AnnouncementDialog",
|
2858
|
-
"cssProperties": [
|
2859
|
-
{
|
2860
|
-
"description": "background color of the illustration section",
|
2861
|
-
"name": "--mdc-announcementdialog-illustration-background-color"
|
2862
|
-
},
|
2863
|
-
{
|
2864
|
-
"description": "primary background color of the dialog",
|
2865
|
-
"name": "--mdc-dialog-primary-background-color",
|
2783
|
+
"description": "(React: onHidden) Dispatched when the dialog is hidden",
|
2784
|
+
"name": "hidden",
|
2785
|
+
"reactName": "onHidden",
|
2866
2786
|
"inheritedFrom": {
|
2867
2787
|
"name": "Dialog",
|
2868
2788
|
"module": "src/components/dialog/dialog.component.ts"
|
2869
2789
|
}
|
2870
2790
|
},
|
2871
2791
|
{
|
2872
|
-
"description": "
|
2873
|
-
"name": "
|
2792
|
+
"description": "(React: onCreated) Dispatched when the dialog is created (added to the DOM)",
|
2793
|
+
"name": "created",
|
2794
|
+
"reactName": "onCreated",
|
2874
2795
|
"inheritedFrom": {
|
2875
2796
|
"name": "Dialog",
|
2876
2797
|
"module": "src/components/dialog/dialog.component.ts"
|
2877
2798
|
}
|
2878
2799
|
},
|
2879
2800
|
{
|
2880
|
-
"description": "
|
2881
|
-
"name": "
|
2801
|
+
"description": "(React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)",
|
2802
|
+
"name": "destroyed",
|
2803
|
+
"reactName": "onDestroyed",
|
2882
2804
|
"inheritedFrom": {
|
2883
2805
|
"name": "Dialog",
|
2884
2806
|
"module": "src/components/dialog/dialog.component.ts"
|
2885
2807
|
}
|
2886
2808
|
},
|
2887
2809
|
{
|
2888
|
-
"description": "
|
2889
|
-
"name": "
|
2810
|
+
"description": "(React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed (this does not hide the dialog)",
|
2811
|
+
"name": "close",
|
2812
|
+
"reactName": "onClose",
|
2890
2813
|
"inheritedFrom": {
|
2891
2814
|
"name": "Dialog",
|
2892
2815
|
"module": "src/components/dialog/dialog.component.ts"
|
2893
2816
|
}
|
2817
|
+
}
|
2818
|
+
],
|
2819
|
+
"attributes": [
|
2820
|
+
{
|
2821
|
+
"name": "illustration",
|
2822
|
+
"type": {
|
2823
|
+
"text": "IllustrationNames | undefined"
|
2824
|
+
},
|
2825
|
+
"description": "The illustration to display in the announcement dialog.\nThis can be an image URL, icon name, or any other illustration identifier.\n\nMake sure to choose the right illustration respective the size (the filename includes the size information, i.e. threetwozero = 320px)",
|
2826
|
+
"fieldName": "illustration"
|
2894
2827
|
},
|
2895
2828
|
{
|
2896
|
-
"
|
2897
|
-
"
|
2829
|
+
"name": "size",
|
2830
|
+
"type": {
|
2831
|
+
"text": "DialogSize"
|
2832
|
+
},
|
2833
|
+
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
2834
|
+
"default": "medium",
|
2835
|
+
"fieldName": "size",
|
2898
2836
|
"inheritedFrom": {
|
2899
2837
|
"name": "Dialog",
|
2900
2838
|
"module": "src/components/dialog/dialog.component.ts"
|
2901
2839
|
}
|
2902
2840
|
},
|
2903
2841
|
{
|
2904
|
-
"
|
2905
|
-
"
|
2842
|
+
"name": "should-focus-trap-wrap",
|
2843
|
+
"type": {
|
2844
|
+
"text": "boolean"
|
2845
|
+
},
|
2846
|
+
"default": "true",
|
2847
|
+
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
2848
|
+
"fieldName": "shouldFocusTrapWrap",
|
2906
2849
|
"inheritedFrom": {
|
2907
|
-
"name": "
|
2908
|
-
"module": "src/
|
2850
|
+
"name": "FocusTrapMixin",
|
2851
|
+
"module": "src/utils/mixins/FocusTrapMixin.ts"
|
2909
2852
|
}
|
2910
2853
|
},
|
2911
2854
|
{
|
2912
|
-
"
|
2913
|
-
"
|
2855
|
+
"name": "id",
|
2856
|
+
"type": {
|
2857
|
+
"text": "string"
|
2858
|
+
},
|
2859
|
+
"default": "''",
|
2860
|
+
"description": "The unique ID of the dialog",
|
2861
|
+
"fieldName": "id",
|
2914
2862
|
"inheritedFrom": {
|
2915
2863
|
"name": "Dialog",
|
2916
2864
|
"module": "src/components/dialog/dialog.component.ts"
|
2917
2865
|
}
|
2918
|
-
}
|
2919
|
-
],
|
2920
|
-
"cssParts": [
|
2921
|
-
{
|
2922
|
-
"description": "The main body container that holds the illustration and content sections",
|
2923
|
-
"name": "body"
|
2924
2866
|
},
|
2925
2867
|
{
|
2926
|
-
"
|
2927
|
-
"
|
2928
|
-
|
2929
|
-
|
2930
|
-
"description": "The
|
2931
|
-
"
|
2932
|
-
|
2933
|
-
{
|
2934
|
-
"description": "The header text",
|
2935
|
-
"name": "header-text"
|
2936
|
-
}
|
2937
|
-
],
|
2938
|
-
"slots": [
|
2939
|
-
{
|
2940
|
-
"description": "Slot for the dialog header content. This can be used to pass custom header content.",
|
2941
|
-
"name": "header-prefix",
|
2868
|
+
"name": "triggerId",
|
2869
|
+
"type": {
|
2870
|
+
"text": "string | undefined"
|
2871
|
+
},
|
2872
|
+
"description": "The ID of the element that triggers the dialog",
|
2873
|
+
"default": "undefined",
|
2874
|
+
"fieldName": "triggerId",
|
2942
2875
|
"inheritedFrom": {
|
2943
2876
|
"name": "Dialog",
|
2944
2877
|
"module": "src/components/dialog/dialog.component.ts"
|
2945
2878
|
}
|
2946
2879
|
},
|
2947
2880
|
{
|
2948
|
-
"
|
2949
|
-
"
|
2881
|
+
"name": "visible",
|
2882
|
+
"type": {
|
2883
|
+
"text": "boolean"
|
2884
|
+
},
|
2885
|
+
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
2886
|
+
"default": "false",
|
2887
|
+
"fieldName": "visible",
|
2950
2888
|
"inheritedFrom": {
|
2951
2889
|
"name": "Dialog",
|
2952
2890
|
"module": "src/components/dialog/dialog.component.ts"
|
2953
2891
|
}
|
2954
2892
|
},
|
2955
2893
|
{
|
2956
|
-
"
|
2957
|
-
"
|
2958
|
-
|
2959
|
-
|
2960
|
-
"description": "
|
2961
|
-
"
|
2962
|
-
|
2963
|
-
|
2964
|
-
|
2965
|
-
|
2894
|
+
"name": "z-index",
|
2895
|
+
"type": {
|
2896
|
+
"text": "number"
|
2897
|
+
},
|
2898
|
+
"description": "The z-index of the dialog\n\nThe backdrop will have z-index of `zIndex - 1`",
|
2899
|
+
"default": "1000",
|
2900
|
+
"fieldName": "zIndex",
|
2901
|
+
"inheritedFrom": {
|
2902
|
+
"name": "Dialog",
|
2903
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2904
|
+
}
|
2966
2905
|
},
|
2967
2906
|
{
|
2968
|
-
"
|
2969
|
-
"
|
2907
|
+
"name": "variant",
|
2908
|
+
"type": {
|
2909
|
+
"text": "DialogVariant"
|
2910
|
+
},
|
2911
|
+
"description": "The variant of the dialog, can be 'default' or 'promotional'",
|
2912
|
+
"default": "default",
|
2913
|
+
"fieldName": "variant",
|
2970
2914
|
"inheritedFrom": {
|
2971
2915
|
"name": "Dialog",
|
2972
2916
|
"module": "src/components/dialog/dialog.component.ts"
|
2973
2917
|
}
|
2974
2918
|
},
|
2975
2919
|
{
|
2976
|
-
"
|
2977
|
-
"
|
2920
|
+
"name": "close-button-aria-label",
|
2921
|
+
"type": {
|
2922
|
+
"text": "string | null"
|
2923
|
+
},
|
2924
|
+
"default": "null",
|
2925
|
+
"description": "Defines a string value for the aria-label attribute for close button accessibility",
|
2926
|
+
"fieldName": "closeButtonAriaLabel",
|
2978
2927
|
"inheritedFrom": {
|
2979
2928
|
"name": "Dialog",
|
2980
2929
|
"module": "src/components/dialog/dialog.component.ts"
|
2981
2930
|
}
|
2982
2931
|
},
|
2983
2932
|
{
|
2984
|
-
"
|
2985
|
-
"
|
2933
|
+
"name": "aria-label",
|
2934
|
+
"type": {
|
2935
|
+
"text": "string | null"
|
2936
|
+
},
|
2937
|
+
"default": "null",
|
2938
|
+
"description": "Defines a string value for the aria-label attribute when header is not used",
|
2939
|
+
"fieldName": "ariaLabel",
|
2986
2940
|
"inheritedFrom": {
|
2987
2941
|
"name": "Dialog",
|
2988
2942
|
"module": "src/components/dialog/dialog.component.ts"
|
2989
2943
|
}
|
2990
2944
|
},
|
2991
2945
|
{
|
2992
|
-
"
|
2993
|
-
"
|
2946
|
+
"name": "aria-labelledby",
|
2947
|
+
"type": {
|
2948
|
+
"text": "string | null"
|
2949
|
+
},
|
2950
|
+
"default": "null",
|
2951
|
+
"description": "Defines a string value for the aria-labelledby attribute that refers to the element\nlabeling the dialog for accessibility",
|
2952
|
+
"fieldName": "ariaLabelledby",
|
2994
2953
|
"inheritedFrom": {
|
2995
2954
|
"name": "Dialog",
|
2996
2955
|
"module": "src/components/dialog/dialog.component.ts"
|
2997
2956
|
}
|
2998
|
-
}
|
2999
|
-
],
|
3000
|
-
"members": [
|
2957
|
+
},
|
3001
2958
|
{
|
3002
|
-
"
|
3003
|
-
"name": "illustration",
|
2959
|
+
"name": "aria-describedby",
|
3004
2960
|
"type": {
|
3005
|
-
"text": "
|
2961
|
+
"text": "string | null"
|
3006
2962
|
},
|
3007
|
-
"
|
3008
|
-
"
|
3009
|
-
"
|
2963
|
+
"default": "null",
|
2964
|
+
"description": "Defines a string value for the aria-describedby attribute that refers to the element\ndescribing the dialog for accessibility",
|
2965
|
+
"fieldName": "ariaDescribedBy",
|
2966
|
+
"inheritedFrom": {
|
2967
|
+
"name": "Dialog",
|
2968
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2969
|
+
}
|
3010
2970
|
},
|
3011
2971
|
{
|
3012
|
-
"
|
3013
|
-
"name": "size",
|
2972
|
+
"name": "aria-description",
|
3014
2973
|
"type": {
|
3015
|
-
"text": "
|
2974
|
+
"text": "string | null"
|
3016
2975
|
},
|
3017
|
-
"
|
3018
|
-
"
|
3019
|
-
"
|
3020
|
-
"reflects": true,
|
2976
|
+
"default": "null",
|
2977
|
+
"description": "Defines a string value for the aria-description attribute that refers to the element\ndescribing the dialog for accessibility",
|
2978
|
+
"fieldName": "ariaDescription",
|
3021
2979
|
"inheritedFrom": {
|
3022
2980
|
"name": "Dialog",
|
3023
|
-
"module": "components/dialog/dialog.component.
|
2981
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3024
2982
|
}
|
3025
2983
|
},
|
3026
2984
|
{
|
3027
|
-
"
|
3028
|
-
"
|
3029
|
-
|
2985
|
+
"name": "header-text",
|
2986
|
+
"type": {
|
2987
|
+
"text": "string | undefined"
|
2988
|
+
},
|
2989
|
+
"description": "Defines a string value to display as the title of the dialog",
|
2990
|
+
"fieldName": "headerText",
|
2991
|
+
"inheritedFrom": {
|
2992
|
+
"name": "Dialog",
|
2993
|
+
"module": "src/components/dialog/dialog.component.ts"
|
2994
|
+
}
|
3030
2995
|
},
|
3031
2996
|
{
|
3032
|
-
"
|
3033
|
-
"
|
3034
|
-
|
2997
|
+
"name": "description-text",
|
2998
|
+
"type": {
|
2999
|
+
"text": "string | undefined"
|
3000
|
+
},
|
3001
|
+
"description": "Defines a string value to display as the under-header description of the dialog",
|
3002
|
+
"fieldName": "descriptionText",
|
3003
|
+
"inheritedFrom": {
|
3004
|
+
"name": "Dialog",
|
3005
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3006
|
+
}
|
3035
3007
|
},
|
3036
3008
|
{
|
3037
|
-
"
|
3038
|
-
"name": "zIndex",
|
3009
|
+
"name": "header-tag-name",
|
3039
3010
|
"type": {
|
3040
|
-
"text": "
|
3011
|
+
"text": "string"
|
3041
3012
|
},
|
3042
|
-
"description": "
|
3043
|
-
"
|
3044
|
-
"attribute": "z-index",
|
3045
|
-
"reflects": true,
|
3013
|
+
"description": "The html tag to be used for the header text",
|
3014
|
+
"fieldName": "headerTagName",
|
3046
3015
|
"inheritedFrom": {
|
3047
3016
|
"name": "Dialog",
|
3048
|
-
"module": "components/dialog/dialog.component.
|
3017
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3049
3018
|
}
|
3050
3019
|
},
|
3051
3020
|
{
|
3052
|
-
"
|
3053
|
-
"
|
3054
|
-
|
3021
|
+
"name": "description-tag-name",
|
3022
|
+
"type": {
|
3023
|
+
"text": "string"
|
3024
|
+
},
|
3025
|
+
"description": "The html tag to be used for the below-header description text",
|
3026
|
+
"fieldName": "descriptionTagName",
|
3055
3027
|
"inheritedFrom": {
|
3056
|
-
"name": "
|
3057
|
-
"module": "
|
3028
|
+
"name": "Dialog",
|
3029
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3058
3030
|
}
|
3059
3031
|
},
|
3060
3032
|
{
|
3061
|
-
"
|
3062
|
-
"
|
3063
|
-
|
3033
|
+
"name": "role",
|
3034
|
+
"type": {
|
3035
|
+
"text": "DialogRole"
|
3036
|
+
},
|
3037
|
+
"description": "Role of the dialog",
|
3038
|
+
"default": "dialog",
|
3039
|
+
"fieldName": "role",
|
3064
3040
|
"inheritedFrom": {
|
3065
|
-
"name": "
|
3066
|
-
"module": "
|
3041
|
+
"name": "Dialog",
|
3042
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3067
3043
|
}
|
3068
3044
|
},
|
3069
3045
|
{
|
3070
|
-
"
|
3071
|
-
"name": "focusTrap",
|
3046
|
+
"name": "disable-aria-haspopup",
|
3072
3047
|
"type": {
|
3073
3048
|
"text": "boolean"
|
3074
3049
|
},
|
3075
|
-
"description": "
|
3076
|
-
"default": "
|
3077
|
-
"
|
3078
|
-
"reflects": true,
|
3079
|
-
"privacy": "protected",
|
3050
|
+
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
3051
|
+
"default": "false",
|
3052
|
+
"fieldName": "disableAriaHasPopup",
|
3080
3053
|
"inheritedFrom": {
|
3081
3054
|
"name": "Dialog",
|
3082
|
-
"module": "components/dialog/dialog.component.
|
3055
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3083
3056
|
}
|
3084
3057
|
},
|
3085
3058
|
{
|
3086
|
-
"
|
3087
|
-
"name": "shouldFocusTrapWrap",
|
3059
|
+
"name": "focus-trap",
|
3088
3060
|
"type": {
|
3089
3061
|
"text": "boolean"
|
3090
3062
|
},
|
3063
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.\n\nNOTE: this should only be disabled in rare cases! By default a Modal Dialog\nshould trap focus always.",
|
3091
3064
|
"default": "true",
|
3092
|
-
"
|
3093
|
-
"attribute": "should-focus-trap-wrap",
|
3094
|
-
"reflects": true,
|
3065
|
+
"fieldName": "focusTrap",
|
3095
3066
|
"inheritedFrom": {
|
3096
|
-
"name": "
|
3097
|
-
"module": "
|
3067
|
+
"name": "Dialog",
|
3068
|
+
"module": "src/components/dialog/dialog.component.ts"
|
3098
3069
|
}
|
3099
|
-
}
|
3070
|
+
}
|
3071
|
+
],
|
3072
|
+
"superclass": {
|
3073
|
+
"name": "Dialog",
|
3074
|
+
"module": "/src/components/dialog/dialog.component"
|
3075
|
+
},
|
3076
|
+
"tagName": "mdc-announcementdialog",
|
3077
|
+
"jsDoc": "/**\n * AnnouncementDialog component is a modal dialog that can be used to display announcements, extending the existing Dialog component.\n * It can be used to create custom dialogs where a illustration, content and footer actions are provided by the consumer.\n * The dialog is available in 4 sizes: medium, large, xlarge and fullscreen. It may also receive custom styling/sizing.\n * The dialog interrupts the user and will block interaction with the rest of the application until it is closed.\n *\n * The dialog can be controlled solely through the `visible` property, no trigger element is required.\n * If a `triggerId` is provided, the dialog will manage focus with that element, otherwise it will\n * remember the previously focused element before the dialog was opened.\n *\n * The dialog is a controlled component, meaning it does not have its own state management for visibility.\n * Use the `visible` property to control the visibility of the dialog.\n * Use the `onClose` event to handle the close action of the dialog (fired when Close button is clicked\n * or Escape is pressed).\n *\n * **Accessibility notes for consuming (have to be explicitly set when you consume the component)**\n *\n * - The dialog should have an aria-label or aria-labelledby attribute to provide a label for screen readers.\n * - Use aria-labelledby to reference the ID of the element that labels the dialog when there is no visible title.\n *\n * **Note: Programmatic show/hide requires the ? prefix on the visible attribute**\n * - Use `?visible=true/false` as an attribute instead of `visible=true/false`\n * - Reference docs for more info: https://lit.dev/docs/templates/expressions/#boolean-attribute-expressions\n *\n * @dependency mdc-button\n * @dependency mdc-illustration\n * @dependency mdc-text\n *\n * @tagname mdc-announcementdialog\n *\n * @event shown - (React: onShown) Dispatched when the dialog is shown\n * @event hidden - (React: onHidden) Dispatched when the dialog is hidden\n * @event created - (React: onCreated) Dispatched when the dialog is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) Dispatched when the dialog is destroyed (removed from the DOM)\n * @event close - (React: onClose) Dispatched when the Close Button is clicked or Escape key is pressed\n * (this does not hide the dialog)\n *\n * @cssproperty --mdc-announcementdialog-illustration-background-color - background color of the illustration section\n * @cssproperty --mdc-dialog-primary-background-color - primary background color of the dialog\n * @cssproperty --mdc-dialog-border-color - border color of the dialog\n * @cssproperty --mdc-dialog-header-text-color - text color of the header/title of the dialog\n * @cssproperty --mdc-dialog-description-text-color - text color of the below header description of the dialog\n * @cssproperty --mdc-dialog-elevation-3 - elevation of the dialog\n * @cssproperty --mdc-dialog-width - width of the dialog\n * @cssproperty --mdc-dialog-height - height of the dialog\n *\n * @csspart body - The main body container that holds the illustration and content sections\n * @csspart illustration-container - The container for the illustration section\n * @csspart content-container - The container for the content section\n * @csspart header-text - The header text\n *\n * @slot header-prefix - Slot for the dialog header content. This can be used to pass custom header content.\n * @slot dialog-body - Slot for the dialog body content\n * @slot illustration-container - Slot for the illustration container section\n * @slot content-container - Slot for the content (header, description, etc) section\n * @slot description-container - Slot for the description in the content (below header) - pass in Text, Links etc as needed.\n * @slot footer-link - This slot is for passing `mdc-link` component within the footer section.\n * @slot footer-button-secondary - This slot is for passing secondary variant of `mdc-button` component\n * within the footer section.\n * @slot footer-button-primary - This slot is for passing primary variant of\n * `mdc-button` component within the footer section.\n * @slot footer - This slot is for passing custom footer content. Only use this if really needed,\n * using the footer-link and footer-button slots is preferred\n */",
|
3078
|
+
"customElement": true
|
3079
|
+
}
|
3080
|
+
],
|
3081
|
+
"exports": [
|
3082
|
+
{
|
3083
|
+
"kind": "js",
|
3084
|
+
"name": "default",
|
3085
|
+
"declaration": {
|
3086
|
+
"name": "AnnouncementDialog",
|
3087
|
+
"module": "components/announcementdialog/announcementdialog.component.js"
|
3088
|
+
}
|
3089
|
+
}
|
3090
|
+
]
|
3091
|
+
},
|
3092
|
+
{
|
3093
|
+
"kind": "javascript-module",
|
3094
|
+
"path": "components/appheader/appheader.component.js",
|
3095
|
+
"declarations": [
|
3096
|
+
{
|
3097
|
+
"kind": "class",
|
3098
|
+
"description": "The `mdc-appheader` component provides a structured and accessible app header layout.\nIt consists of three primary sections: leading, center, and trailing.\n\n- The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n- The **center section** can contain a **search bar**, **icons** or action controls.\n- The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.",
|
3099
|
+
"name": "Appheader",
|
3100
|
+
"cssParts": [
|
3100
3101
|
{
|
3101
|
-
"
|
3102
|
-
"name": "
|
3103
|
-
"privacy": "private",
|
3104
|
-
"parameters": [
|
3105
|
-
{
|
3106
|
-
"name": "isActivated",
|
3107
|
-
"type": {
|
3108
|
-
"text": "boolean"
|
3109
|
-
}
|
3110
|
-
}
|
3111
|
-
],
|
3112
|
-
"inheritedFrom": {
|
3113
|
-
"name": "FocusTrapMixin",
|
3114
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
3115
|
-
}
|
3102
|
+
"description": "The main container for styling the header.",
|
3103
|
+
"name": "container"
|
3116
3104
|
},
|
3117
3105
|
{
|
3118
|
-
"
|
3119
|
-
"name": "
|
3120
|
-
"privacy": "public",
|
3121
|
-
"description": "Activate the focus trap",
|
3122
|
-
"inheritedFrom": {
|
3123
|
-
"name": "FocusTrapMixin",
|
3124
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
3125
|
-
}
|
3106
|
+
"description": "The leading section of the header.",
|
3107
|
+
"name": "leading-section"
|
3126
3108
|
},
|
3127
3109
|
{
|
3128
|
-
"
|
3129
|
-
"name": "
|
3130
|
-
"privacy": "public",
|
3131
|
-
"description": "Deactivate the focus trap.",
|
3132
|
-
"inheritedFrom": {
|
3133
|
-
"name": "FocusTrapMixin",
|
3134
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
3135
|
-
}
|
3110
|
+
"description": "The center section of the header.",
|
3111
|
+
"name": "center-section"
|
3136
3112
|
},
|
3137
3113
|
{
|
3138
|
-
"
|
3139
|
-
"name": "
|
3140
|
-
|
3141
|
-
|
3142
|
-
|
3143
|
-
|
3144
|
-
|
3145
|
-
|
3146
|
-
},
|
3147
|
-
"description": "The element to check."
|
3148
|
-
}
|
3149
|
-
],
|
3150
|
-
"description": "Checks if the element has no client rectangles (not visible in the viewport).",
|
3151
|
-
"return": {
|
3152
|
-
"type": {
|
3153
|
-
"text": ""
|
3154
|
-
}
|
3155
|
-
},
|
3156
|
-
"inheritedFrom": {
|
3157
|
-
"name": "FocusTrapMixin",
|
3158
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
3159
|
-
}
|
3114
|
+
"description": "The trailing section of the header.",
|
3115
|
+
"name": "trailing-section"
|
3116
|
+
}
|
3117
|
+
],
|
3118
|
+
"slots": [
|
3119
|
+
{
|
3120
|
+
"description": "Slot for the leading section (e.g., brand logo, brand name).",
|
3121
|
+
"name": "leading"
|
3160
3122
|
},
|
3161
3123
|
{
|
3162
|
-
"
|
3163
|
-
"name": "
|
3164
|
-
"privacy": "private",
|
3165
|
-
"parameters": [
|
3166
|
-
{
|
3167
|
-
"name": "element",
|
3168
|
-
"type": {
|
3169
|
-
"text": "HTMLElement"
|
3170
|
-
},
|
3171
|
-
"description": "The element to check."
|
3172
|
-
}
|
3173
|
-
],
|
3174
|
-
"description": "Checks if the element has zero dimensions (width and height are both 0).",
|
3175
|
-
"return": {
|
3176
|
-
"type": {
|
3177
|
-
"text": ""
|
3178
|
-
}
|
3179
|
-
},
|
3180
|
-
"inheritedFrom": {
|
3181
|
-
"name": "FocusTrapMixin",
|
3182
|
-
"module": "utils/mixins/FocusTrapMixin.js"
|
3183
|
-
}
|
3124
|
+
"description": "Slot for the center section (e.g., search bar, icons).",
|
3125
|
+
"name": "center"
|
3184
3126
|
},
|
3185
3127
|
{
|
3186
|
-
"
|
3187
|
-
"name": "
|
3188
|
-
|
3189
|
-
|
3190
|
-
|
3191
|
-
|
3192
|
-
|
3193
|
-
|
3194
|
-
|
3195
|
-
|
3196
|
-
|
3197
|
-
|
3198
|
-
|
3199
|
-
|
3200
|
-
|
3201
|
-
|
3202
|
-
|
3128
|
+
"description": "Slot for the trailing section (e.g., profile avatar, icons).",
|
3129
|
+
"name": "trailing"
|
3130
|
+
}
|
3131
|
+
],
|
3132
|
+
"members": [],
|
3133
|
+
"superclass": {
|
3134
|
+
"name": "Component",
|
3135
|
+
"module": "/src/models"
|
3136
|
+
},
|
3137
|
+
"tagName": "mdc-appheader",
|
3138
|
+
"jsDoc": "/**\n * The `mdc-appheader` component provides a structured and accessible app header layout.\n * It consists of three primary sections: leading, center, and trailing.\n *\n * - The **leading section** typically holds a **brand logo**, **brand name** or **menu icon**.\n * - The **center section** can contain a **search bar**, **icons** or action controls.\n * - The **trailing section** generally includes a **profile avatar**, **additional icons** or **action controls**.\n *\n * @tagname mdc-appheader\n *\n * @slot leading - Slot for the leading section (e.g., brand logo, brand name).\n * @slot center - Slot for the center section (e.g., search bar, icons).\n * @slot trailing - Slot for the trailing section (e.g., profile avatar, icons).\n *\n * @csspart container - The main container for styling the header.\n * @csspart leading-section - The leading section of the header.\n * @csspart center-section - The center section of the header.\n * @csspart trailing-section - The trailing section of the header.\n */",
|
3139
|
+
"customElement": true
|
3140
|
+
}
|
3141
|
+
],
|
3142
|
+
"exports": [
|
3143
|
+
{
|
3144
|
+
"kind": "js",
|
3145
|
+
"name": "default",
|
3146
|
+
"declaration": {
|
3147
|
+
"name": "Appheader",
|
3148
|
+
"module": "components/appheader/appheader.component.js"
|
3149
|
+
}
|
3150
|
+
}
|
3151
|
+
]
|
3152
|
+
},
|
3153
|
+
{
|
3154
|
+
"kind": "javascript-module",
|
3155
|
+
"path": "components/avatar/avatar.component.js",
|
3156
|
+
"declarations": [
|
3157
|
+
{
|
3158
|
+
"kind": "class",
|
3159
|
+
"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.",
|
3160
|
+
"name": "Avatar",
|
3161
|
+
"cssProperties": [
|
3162
|
+
{
|
3163
|
+
"description": "Allows customization of the default background color.",
|
3164
|
+
"name": "--mdc-avatar-default-background-color"
|
3165
|
+
},
|
3166
|
+
{
|
3167
|
+
"description": "Allows customization of the default foreground color.",
|
3168
|
+
"name": "--mdc-avatar-default-foreground-color"
|
3169
|
+
},
|
3170
|
+
{
|
3171
|
+
"description": "Allows customization of the loading indicator background color.",
|
3172
|
+
"name": "--mdc-avatar-loading-indicator-background-color"
|
3173
|
+
},
|
3174
|
+
{
|
3175
|
+
"description": "Allows customization of the loading indicator foreground color.",
|
3176
|
+
"name": "--mdc-avatar-loading-indicator-foreground-color"
|
3177
|
+
},
|
3178
|
+
{
|
3179
|
+
"description": "Allows customization of the loading overlay background color.",
|
3180
|
+
"name": "--mdc-avatar-loading-overlay-background-color"
|
3181
|
+
}
|
3182
|
+
],
|
3183
|
+
"cssParts": [
|
3184
|
+
{
|
3185
|
+
"description": "The main content of the avatar.",
|
3186
|
+
"name": "content"
|
3187
|
+
},
|
3188
|
+
{
|
3189
|
+
"description": "The photo of the avatar.",
|
3190
|
+
"name": "photo"
|
3191
|
+
},
|
3192
|
+
{
|
3193
|
+
"description": "The presence indicator of the avatar.",
|
3194
|
+
"name": "presence"
|
3195
|
+
},
|
3196
|
+
{
|
3197
|
+
"description": "The wrapper for the loading indicator.",
|
3198
|
+
"name": "loading-wrapper"
|
3199
|
+
},
|
3200
|
+
{
|
3201
|
+
"description": "The loading indicator of the avatar.",
|
3202
|
+
"name": "loader"
|
3203
|
+
}
|
3204
|
+
],
|
3205
|
+
"members": [
|
3206
|
+
{
|
3207
|
+
"kind": "field",
|
3208
|
+
"name": "src",
|
3209
|
+
"type": {
|
3210
|
+
"text": "string | undefined"
|
3203
3211
|
},
|
3212
|
+
"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.",
|
3213
|
+
"attribute": "src",
|
3204
3214
|
"inheritedFrom": {
|
3205
|
-
"name": "
|
3206
|
-
"module": "utils/mixins/
|
3215
|
+
"name": "AvatarComponentMixin",
|
3216
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3207
3217
|
}
|
3208
3218
|
},
|
3209
3219
|
{
|
3210
|
-
"kind": "
|
3211
|
-
"name": "
|
3212
|
-
"
|
3213
|
-
|
3214
|
-
{
|
3215
|
-
"name": "element",
|
3216
|
-
"type": {
|
3217
|
-
"text": "HTMLElement"
|
3218
|
-
},
|
3219
|
-
"description": "The element to check."
|
3220
|
-
}
|
3221
|
-
],
|
3222
|
-
"description": "Checks if the element has inline styles that make it hidden.",
|
3223
|
-
"return": {
|
3224
|
-
"type": {
|
3225
|
-
"text": ""
|
3226
|
-
}
|
3220
|
+
"kind": "field",
|
3221
|
+
"name": "initials",
|
3222
|
+
"type": {
|
3223
|
+
"text": "string | undefined"
|
3227
3224
|
},
|
3225
|
+
"description": "The initials to be displayed for the avatar.",
|
3226
|
+
"attribute": "initials",
|
3228
3227
|
"inheritedFrom": {
|
3229
|
-
"name": "
|
3230
|
-
"module": "utils/mixins/
|
3228
|
+
"name": "AvatarComponentMixin",
|
3229
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3231
3230
|
}
|
3232
3231
|
},
|
3233
3232
|
{
|
3234
|
-
"kind": "
|
3235
|
-
"name": "
|
3236
|
-
"
|
3237
|
-
|
3238
|
-
{
|
3239
|
-
"name": "element",
|
3240
|
-
"type": {
|
3241
|
-
"text": "HTMLElement"
|
3242
|
-
},
|
3243
|
-
"description": "The element to check."
|
3244
|
-
}
|
3245
|
-
],
|
3246
|
-
"description": "Checks if the element is hidden by a computed style.",
|
3247
|
-
"return": {
|
3248
|
-
"type": {
|
3249
|
-
"text": ""
|
3250
|
-
}
|
3233
|
+
"kind": "field",
|
3234
|
+
"name": "presence",
|
3235
|
+
"type": {
|
3236
|
+
"text": "PresenceType | undefined"
|
3251
3237
|
},
|
3238
|
+
"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`",
|
3239
|
+
"attribute": "presence",
|
3252
3240
|
"inheritedFrom": {
|
3253
|
-
"name": "
|
3254
|
-
"module": "utils/mixins/
|
3241
|
+
"name": "AvatarComponentMixin",
|
3242
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3255
3243
|
}
|
3256
3244
|
},
|
3257
3245
|
{
|
3258
|
-
"kind": "
|
3259
|
-
"name": "
|
3260
|
-
"
|
3261
|
-
|
3262
|
-
{
|
3263
|
-
"name": "element",
|
3264
|
-
"type": {
|
3265
|
-
"text": "HTMLElement"
|
3266
|
-
},
|
3267
|
-
"description": "The element to check."
|
3268
|
-
}
|
3269
|
-
],
|
3270
|
-
"description": "Checks if the element is hidden from the user.",
|
3271
|
-
"return": {
|
3272
|
-
"type": {
|
3273
|
-
"text": ""
|
3274
|
-
}
|
3246
|
+
"kind": "field",
|
3247
|
+
"name": "size",
|
3248
|
+
"type": {
|
3249
|
+
"text": "AvatarSize"
|
3275
3250
|
},
|
3251
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3252
|
+
"default": "32",
|
3253
|
+
"attribute": "size",
|
3254
|
+
"reflects": true,
|
3276
3255
|
"inheritedFrom": {
|
3277
|
-
"name": "
|
3278
|
-
"module": "utils/mixins/
|
3256
|
+
"name": "AvatarComponentMixin",
|
3257
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3279
3258
|
}
|
3280
3259
|
},
|
3281
3260
|
{
|
3282
|
-
"kind": "
|
3283
|
-
"name": "
|
3284
|
-
"
|
3285
|
-
|
3286
|
-
{
|
3287
|
-
"name": "element",
|
3288
|
-
"type": {
|
3289
|
-
"text": "any"
|
3290
|
-
},
|
3291
|
-
"description": "The element to check."
|
3292
|
-
}
|
3293
|
-
],
|
3294
|
-
"description": "Checks if the element is disabled.",
|
3295
|
-
"return": {
|
3296
|
-
"type": {
|
3297
|
-
"text": ""
|
3298
|
-
}
|
3261
|
+
"kind": "field",
|
3262
|
+
"name": "counter",
|
3263
|
+
"type": {
|
3264
|
+
"text": "number | undefined"
|
3299
3265
|
},
|
3266
|
+
"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`.",
|
3267
|
+
"attribute": "counter",
|
3300
3268
|
"inheritedFrom": {
|
3301
|
-
"name": "
|
3302
|
-
"module": "utils/mixins/
|
3269
|
+
"name": "AvatarComponentMixin",
|
3270
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3303
3271
|
}
|
3304
3272
|
},
|
3305
3273
|
{
|
3306
|
-
"kind": "
|
3307
|
-
"name": "
|
3308
|
-
"
|
3309
|
-
|
3310
|
-
{
|
3311
|
-
"name": "element",
|
3312
|
-
"type": {
|
3313
|
-
"text": "HTMLElement"
|
3314
|
-
},
|
3315
|
-
"description": "The element to check."
|
3316
|
-
}
|
3317
|
-
],
|
3318
|
-
"description": "Checks if the element is not tabbable.",
|
3319
|
-
"return": {
|
3320
|
-
"type": {
|
3321
|
-
"text": ""
|
3322
|
-
}
|
3274
|
+
"kind": "field",
|
3275
|
+
"name": "isTyping",
|
3276
|
+
"type": {
|
3277
|
+
"text": "boolean"
|
3323
3278
|
},
|
3279
|
+
"default": "false",
|
3280
|
+
"description": "Represents the typing indicator when the user is typing.",
|
3281
|
+
"attribute": "is-typing",
|
3324
3282
|
"inheritedFrom": {
|
3325
|
-
"name": "
|
3326
|
-
"module": "utils/mixins/
|
3283
|
+
"name": "AvatarComponentMixin",
|
3284
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3327
3285
|
}
|
3328
3286
|
},
|
3329
3287
|
{
|
3330
|
-
"kind": "
|
3331
|
-
"name": "
|
3332
|
-
"
|
3333
|
-
|
3334
|
-
"type": {
|
3335
|
-
"text": ""
|
3336
|
-
}
|
3288
|
+
"kind": "field",
|
3289
|
+
"name": "iconName",
|
3290
|
+
"type": {
|
3291
|
+
"text": "IconNames | undefined"
|
3337
3292
|
},
|
3338
|
-
"
|
3339
|
-
|
3340
|
-
"name": "element",
|
3341
|
-
"type": {
|
3342
|
-
"text": "HTMLElement"
|
3343
|
-
},
|
3344
|
-
"description": "The element to check."
|
3345
|
-
}
|
3346
|
-
],
|
3347
|
-
"description": "Checks if the element is interactive.",
|
3293
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3294
|
+
"attribute": "icon-name",
|
3348
3295
|
"inheritedFrom": {
|
3349
|
-
"name": "
|
3350
|
-
"module": "utils/mixins/
|
3296
|
+
"name": "IconNameMixin",
|
3297
|
+
"module": "utils/mixins/IconNameMixin.js"
|
3351
3298
|
}
|
3299
|
+
}
|
3300
|
+
],
|
3301
|
+
"mixins": [
|
3302
|
+
{
|
3303
|
+
"name": "AvatarComponentMixin",
|
3304
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
3352
3305
|
},
|
3353
3306
|
{
|
3354
|
-
"
|
3355
|
-
"
|
3356
|
-
|
3357
|
-
|
3358
|
-
|
3359
|
-
|
3360
|
-
|
3361
|
-
|
3362
|
-
|
3363
|
-
|
3364
|
-
|
3365
|
-
|
3366
|
-
|
3367
|
-
"
|
3368
|
-
|
3369
|
-
|
3370
|
-
}
|
3307
|
+
"name": "IconNameMixin",
|
3308
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
3309
|
+
}
|
3310
|
+
],
|
3311
|
+
"superclass": {
|
3312
|
+
"name": "Component",
|
3313
|
+
"module": "/src/models"
|
3314
|
+
},
|
3315
|
+
"tagName": "mdc-avatar",
|
3316
|
+
"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 content - The main content of the avatar.\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 */",
|
3317
|
+
"customElement": true,
|
3318
|
+
"attributes": [
|
3319
|
+
{
|
3320
|
+
"name": "src",
|
3321
|
+
"type": {
|
3322
|
+
"text": "string | undefined"
|
3371
3323
|
},
|
3324
|
+
"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.",
|
3325
|
+
"fieldName": "src",
|
3372
3326
|
"inheritedFrom": {
|
3373
|
-
"name": "
|
3374
|
-
"module": "utils/mixins/
|
3327
|
+
"name": "AvatarComponentMixin",
|
3328
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3375
3329
|
}
|
3376
3330
|
},
|
3377
3331
|
{
|
3378
|
-
"
|
3379
|
-
"
|
3380
|
-
|
3381
|
-
"return": {
|
3382
|
-
"type": {
|
3383
|
-
"text": ""
|
3384
|
-
}
|
3332
|
+
"name": "initials",
|
3333
|
+
"type": {
|
3334
|
+
"text": "string | undefined"
|
3385
3335
|
},
|
3386
|
-
"
|
3387
|
-
|
3388
|
-
"name": "root",
|
3389
|
-
"type": {
|
3390
|
-
"text": "ShadowRoot | HTMLElement"
|
3391
|
-
},
|
3392
|
-
"description": "The root element to search for focusable elements."
|
3393
|
-
},
|
3394
|
-
{
|
3395
|
-
"name": "matches",
|
3396
|
-
"default": "new Set()",
|
3397
|
-
"type": {
|
3398
|
-
"text": "Set<HTMLElement>"
|
3399
|
-
},
|
3400
|
-
"description": "The set of focusable elements."
|
3401
|
-
}
|
3402
|
-
],
|
3403
|
-
"description": "Recursively finds all focusable elements within the given root and its descendants.\n\nMake sure this is performant, as it will be called multiple times.",
|
3336
|
+
"description": "The initials to be displayed for the avatar.",
|
3337
|
+
"fieldName": "initials",
|
3404
3338
|
"inheritedFrom": {
|
3405
|
-
"name": "
|
3406
|
-
"module": "utils/mixins/
|
3339
|
+
"name": "AvatarComponentMixin",
|
3340
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3407
3341
|
}
|
3408
3342
|
},
|
3409
3343
|
{
|
3410
|
-
"
|
3411
|
-
"
|
3412
|
-
|
3413
|
-
|
3344
|
+
"name": "presence",
|
3345
|
+
"type": {
|
3346
|
+
"text": "PresenceType | undefined"
|
3347
|
+
},
|
3348
|
+
"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`",
|
3349
|
+
"fieldName": "presence",
|
3414
3350
|
"inheritedFrom": {
|
3415
|
-
"name": "
|
3416
|
-
"module": "utils/mixins/
|
3351
|
+
"name": "AvatarComponentMixin",
|
3352
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3417
3353
|
}
|
3418
3354
|
},
|
3419
3355
|
{
|
3420
|
-
"
|
3421
|
-
"
|
3422
|
-
|
3423
|
-
|
3424
|
-
|
3425
|
-
|
3426
|
-
|
3427
|
-
"type": {
|
3428
|
-
"text": "number"
|
3429
|
-
},
|
3430
|
-
"description": "The index of the preferable element to focus."
|
3431
|
-
}
|
3432
|
-
],
|
3433
|
-
"description": "Sets the initial focus within the container.",
|
3356
|
+
"name": "size",
|
3357
|
+
"type": {
|
3358
|
+
"text": "AvatarSize"
|
3359
|
+
},
|
3360
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3361
|
+
"default": "32",
|
3362
|
+
"fieldName": "size",
|
3434
3363
|
"inheritedFrom": {
|
3435
|
-
"name": "
|
3436
|
-
"module": "utils/mixins/
|
3364
|
+
"name": "AvatarComponentMixin",
|
3365
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3437
3366
|
}
|
3438
3367
|
},
|
3439
3368
|
{
|
3440
|
-
"
|
3441
|
-
"
|
3442
|
-
|
3443
|
-
"parameters": [
|
3444
|
-
{
|
3445
|
-
"name": "currentIndex",
|
3446
|
-
"type": {
|
3447
|
-
"text": "number"
|
3448
|
-
},
|
3449
|
-
"description": "The current index."
|
3450
|
-
},
|
3451
|
-
{
|
3452
|
-
"name": "step",
|
3453
|
-
"type": {
|
3454
|
-
"text": "number"
|
3455
|
-
},
|
3456
|
-
"description": "The step to calculate the next index."
|
3457
|
-
}
|
3458
|
-
],
|
3459
|
-
"description": "Calculates the next index for the focus trap.",
|
3460
|
-
"return": {
|
3461
|
-
"type": {
|
3462
|
-
"text": ""
|
3463
|
-
}
|
3369
|
+
"name": "counter",
|
3370
|
+
"type": {
|
3371
|
+
"text": "number | undefined"
|
3464
3372
|
},
|
3373
|
+
"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`.",
|
3374
|
+
"fieldName": "counter",
|
3465
3375
|
"inheritedFrom": {
|
3466
|
-
"name": "
|
3467
|
-
"module": "utils/mixins/
|
3376
|
+
"name": "AvatarComponentMixin",
|
3377
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3468
3378
|
}
|
3469
3379
|
},
|
3470
3380
|
{
|
3471
|
-
"
|
3472
|
-
"
|
3473
|
-
|
3474
|
-
"description": "Returns the deepest active element in the shadow DOM.",
|
3475
|
-
"return": {
|
3476
|
-
"type": {
|
3477
|
-
"text": ""
|
3478
|
-
}
|
3381
|
+
"name": "is-typing",
|
3382
|
+
"type": {
|
3383
|
+
"text": "boolean"
|
3479
3384
|
},
|
3385
|
+
"default": "false",
|
3386
|
+
"description": "Represents the typing indicator when the user is typing.",
|
3387
|
+
"fieldName": "isTyping",
|
3480
3388
|
"inheritedFrom": {
|
3481
|
-
"name": "
|
3482
|
-
"module": "utils/mixins/
|
3389
|
+
"name": "AvatarComponentMixin",
|
3390
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3483
3391
|
}
|
3484
3392
|
},
|
3485
3393
|
{
|
3486
|
-
"
|
3487
|
-
"
|
3488
|
-
|
3489
|
-
"parameters": [
|
3490
|
-
{
|
3491
|
-
"name": "activeElement",
|
3492
|
-
"type": {
|
3493
|
-
"text": "HTMLElement"
|
3494
|
-
},
|
3495
|
-
"description": "The active element."
|
3496
|
-
}
|
3497
|
-
],
|
3498
|
-
"description": "Finds the index of the active element within the focusable elements.",
|
3499
|
-
"return": {
|
3500
|
-
"type": {
|
3501
|
-
"text": ""
|
3502
|
-
}
|
3394
|
+
"name": "icon-name",
|
3395
|
+
"type": {
|
3396
|
+
"text": "IconNames | undefined"
|
3503
3397
|
},
|
3398
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3399
|
+
"fieldName": "iconName",
|
3504
3400
|
"inheritedFrom": {
|
3505
|
-
"name": "
|
3506
|
-
"module": "utils/mixins/
|
3401
|
+
"name": "IconNameMixin",
|
3402
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
3507
3403
|
}
|
3404
|
+
}
|
3405
|
+
]
|
3406
|
+
}
|
3407
|
+
],
|
3408
|
+
"exports": [
|
3409
|
+
{
|
3410
|
+
"kind": "js",
|
3411
|
+
"name": "default",
|
3412
|
+
"declaration": {
|
3413
|
+
"name": "Avatar",
|
3414
|
+
"module": "components/avatar/avatar.component.js"
|
3415
|
+
}
|
3416
|
+
}
|
3417
|
+
]
|
3418
|
+
},
|
3419
|
+
{
|
3420
|
+
"kind": "javascript-module",
|
3421
|
+
"path": "components/avatarbutton/avatarbutton.component.js",
|
3422
|
+
"declarations": [
|
3423
|
+
{
|
3424
|
+
"kind": "class",
|
3425
|
+
"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.",
|
3426
|
+
"name": "AvatarButton",
|
3427
|
+
"cssProperties": [
|
3428
|
+
{
|
3429
|
+
"description": "Background color of the overlay in rest state",
|
3430
|
+
"name": "--mdc-avatarbutton-overlay-background-color-rest"
|
3431
|
+
},
|
3432
|
+
{
|
3433
|
+
"description": "Background color of the overlay in hover state",
|
3434
|
+
"name": "--mdc-avatarbutton-overlay-background-color-hover"
|
3435
|
+
},
|
3436
|
+
{
|
3437
|
+
"description": "Background color of the overlay in active state",
|
3438
|
+
"name": "--mdc-avatarbutton-overlay-background-color-active"
|
3439
|
+
}
|
3440
|
+
],
|
3441
|
+
"cssParts": [
|
3442
|
+
{
|
3443
|
+
"description": "The overlay part of the avatar button.",
|
3444
|
+
"name": "overlay"
|
3445
|
+
},
|
3446
|
+
{
|
3447
|
+
"description": "The main content of the avatar.",
|
3448
|
+
"name": "content"
|
3449
|
+
},
|
3450
|
+
{
|
3451
|
+
"description": "The photo part of the avatar.",
|
3452
|
+
"name": "photo"
|
3508
3453
|
},
|
3509
3454
|
{
|
3510
|
-
"
|
3511
|
-
"name": "
|
3512
|
-
|
3513
|
-
|
3514
|
-
|
3515
|
-
|
3516
|
-
|
3517
|
-
|
3518
|
-
|
3519
|
-
|
3520
|
-
|
3521
|
-
|
3522
|
-
|
3523
|
-
|
3524
|
-
|
3525
|
-
|
3526
|
-
|
3527
|
-
|
3528
|
-
],
|
3529
|
-
"description": "Checks if the active element is equal to the given element.",
|
3530
|
-
"return": {
|
3531
|
-
"type": {
|
3532
|
-
"text": ""
|
3533
|
-
}
|
3455
|
+
"description": "The presence indicator part of the avatar.",
|
3456
|
+
"name": "presence"
|
3457
|
+
},
|
3458
|
+
{
|
3459
|
+
"description": "The wrapper for the loading indicator of the avatar.",
|
3460
|
+
"name": "loading-wrapper"
|
3461
|
+
},
|
3462
|
+
{
|
3463
|
+
"description": "The loading indicator part of the avatar.",
|
3464
|
+
"name": "loader"
|
3465
|
+
}
|
3466
|
+
],
|
3467
|
+
"members": [
|
3468
|
+
{
|
3469
|
+
"kind": "field",
|
3470
|
+
"name": "ariaLabel",
|
3471
|
+
"type": {
|
3472
|
+
"text": "string | null"
|
3534
3473
|
},
|
3535
|
-
"
|
3536
|
-
|
3537
|
-
|
3538
|
-
}
|
3474
|
+
"default": "null",
|
3475
|
+
"description": "Aria-label attribute to be set for accessibility",
|
3476
|
+
"attribute": "aria-label"
|
3539
3477
|
},
|
3540
3478
|
{
|
3541
3479
|
"kind": "method",
|
3542
|
-
"name": "
|
3480
|
+
"name": "setSize",
|
3543
3481
|
"privacy": "private",
|
3544
3482
|
"parameters": [
|
3545
3483
|
{
|
3546
|
-
"name": "
|
3484
|
+
"name": "size",
|
3547
3485
|
"type": {
|
3548
|
-
"text": "
|
3486
|
+
"text": "AvatarSize"
|
3549
3487
|
}
|
3550
|
-
},
|
3551
|
-
{
|
3552
|
-
"description": "The direction of the focus trap.\nIf true, the focus will be trapped in the previous element.",
|
3553
|
-
"name": "direction"
|
3554
3488
|
}
|
3555
|
-
]
|
3556
|
-
|
3489
|
+
]
|
3490
|
+
},
|
3491
|
+
{
|
3492
|
+
"kind": "field",
|
3493
|
+
"name": "src",
|
3494
|
+
"type": {
|
3495
|
+
"text": "string | undefined"
|
3496
|
+
},
|
3497
|
+
"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.",
|
3498
|
+
"attribute": "src",
|
3557
3499
|
"inheritedFrom": {
|
3558
|
-
"name": "
|
3559
|
-
"module": "utils/mixins/
|
3500
|
+
"name": "AvatarComponentMixin",
|
3501
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3560
3502
|
}
|
3561
3503
|
},
|
3562
3504
|
{
|
3563
|
-
"kind": "
|
3564
|
-
"name": "
|
3565
|
-
"
|
3566
|
-
|
3567
|
-
|
3568
|
-
|
3569
|
-
|
3570
|
-
"text": "KeyboardEvent"
|
3571
|
-
},
|
3572
|
-
"description": "The keyboard event."
|
3573
|
-
}
|
3574
|
-
],
|
3575
|
-
"description": "Traps focus within the container.",
|
3505
|
+
"kind": "field",
|
3506
|
+
"name": "initials",
|
3507
|
+
"type": {
|
3508
|
+
"text": "string | undefined"
|
3509
|
+
},
|
3510
|
+
"description": "The initials to be displayed for the avatar.",
|
3511
|
+
"attribute": "initials",
|
3576
3512
|
"inheritedFrom": {
|
3577
|
-
"name": "
|
3578
|
-
"module": "utils/mixins/
|
3513
|
+
"name": "AvatarComponentMixin",
|
3514
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3579
3515
|
}
|
3580
3516
|
},
|
3581
3517
|
{
|
3582
|
-
"kind": "
|
3583
|
-
"name": "
|
3584
|
-
"
|
3585
|
-
|
3586
|
-
"return": {
|
3587
|
-
"type": {
|
3588
|
-
"text": ""
|
3589
|
-
}
|
3518
|
+
"kind": "field",
|
3519
|
+
"name": "presence",
|
3520
|
+
"type": {
|
3521
|
+
"text": "PresenceType | undefined"
|
3590
3522
|
},
|
3523
|
+
"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`",
|
3524
|
+
"attribute": "presence",
|
3591
3525
|
"inheritedFrom": {
|
3592
|
-
"name": "
|
3593
|
-
"module": "utils/mixins/
|
3526
|
+
"name": "AvatarComponentMixin",
|
3527
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3594
3528
|
}
|
3595
3529
|
},
|
3596
3530
|
{
|
3597
3531
|
"kind": "field",
|
3598
|
-
"name": "
|
3532
|
+
"name": "size",
|
3599
3533
|
"type": {
|
3600
|
-
"text": "
|
3534
|
+
"text": "ButtonSize"
|
3601
3535
|
},
|
3602
|
-
"
|
3603
|
-
"
|
3604
|
-
"attribute": "
|
3536
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3537
|
+
"default": "32",
|
3538
|
+
"attribute": "size",
|
3605
3539
|
"reflects": true,
|
3606
3540
|
"inheritedFrom": {
|
3607
|
-
"name": "
|
3608
|
-
"module": "components/
|
3541
|
+
"name": "Buttonsimple",
|
3542
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3609
3543
|
}
|
3610
3544
|
},
|
3611
3545
|
{
|
3612
3546
|
"kind": "field",
|
3613
|
-
"name": "
|
3547
|
+
"name": "counter",
|
3614
3548
|
"type": {
|
3615
|
-
"text": "
|
3549
|
+
"text": "number | undefined"
|
3616
3550
|
},
|
3617
|
-
"description": "The
|
3618
|
-
"
|
3619
|
-
"attribute": "triggerId",
|
3620
|
-
"reflects": true,
|
3551
|
+
"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`.",
|
3552
|
+
"attribute": "counter",
|
3621
3553
|
"inheritedFrom": {
|
3622
|
-
"name": "
|
3623
|
-
"module": "
|
3554
|
+
"name": "AvatarComponentMixin",
|
3555
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3624
3556
|
}
|
3625
3557
|
},
|
3626
3558
|
{
|
3627
3559
|
"kind": "field",
|
3628
|
-
"name": "
|
3560
|
+
"name": "isTyping",
|
3629
3561
|
"type": {
|
3630
3562
|
"text": "boolean"
|
3631
3563
|
},
|
3632
|
-
"description": "The visibility of the dialog\n\nDialog is a controlled component, visible is the only property that controls the visibility of the dialog.",
|
3633
3564
|
"default": "false",
|
3634
|
-
"
|
3635
|
-
"
|
3565
|
+
"description": "Represents the typing indicator when the user is typing.",
|
3566
|
+
"attribute": "is-typing",
|
3636
3567
|
"inheritedFrom": {
|
3637
|
-
"name": "
|
3638
|
-
"module": "
|
3568
|
+
"name": "AvatarComponentMixin",
|
3569
|
+
"module": "utils/mixins/AvatarComponentMixin.js"
|
3639
3570
|
}
|
3640
3571
|
},
|
3641
3572
|
{
|
3642
3573
|
"kind": "field",
|
3643
|
-
"name": "
|
3574
|
+
"name": "iconName",
|
3644
3575
|
"type": {
|
3645
|
-
"text": "
|
3576
|
+
"text": "IconNames | undefined"
|
3646
3577
|
},
|
3647
|
-
"description": "
|
3648
|
-
"
|
3649
|
-
"attribute": "variant",
|
3650
|
-
"reflects": true,
|
3578
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
3579
|
+
"attribute": "icon-name",
|
3651
3580
|
"inheritedFrom": {
|
3652
|
-
"name": "
|
3653
|
-
"module": "
|
3581
|
+
"name": "IconNameMixin",
|
3582
|
+
"module": "utils/mixins/IconNameMixin.js"
|
3654
3583
|
}
|
3655
3584
|
},
|
3656
3585
|
{
|
3657
3586
|
"kind": "field",
|
3658
|
-
"name": "
|
3587
|
+
"name": "autoFocusOnMount",
|
3659
3588
|
"type": {
|
3660
|
-
"text": "
|
3589
|
+
"text": "boolean"
|
3661
3590
|
},
|
3662
|
-
"default": "
|
3663
|
-
"description": "
|
3664
|
-
"attribute": "
|
3591
|
+
"default": "false",
|
3592
|
+
"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.",
|
3593
|
+
"attribute": "auto-focus-on-mount",
|
3594
|
+
"reflects": true,
|
3665
3595
|
"inheritedFrom": {
|
3666
|
-
"name": "
|
3667
|
-
"module": "
|
3596
|
+
"name": "AutoFocusOnMountMixin",
|
3597
|
+
"module": "utils/mixins/AutoFocusOnMountMixin.js"
|
3668
3598
|
}
|
3669
3599
|
},
|
3670
3600
|
{
|
3671
3601
|
"kind": "field",
|
3672
|
-
"name": "
|
3602
|
+
"name": "tabIndex",
|
3673
3603
|
"type": {
|
3674
|
-
"text": "
|
3604
|
+
"text": "number"
|
3675
3605
|
},
|
3676
|
-
"default": "
|
3677
|
-
"description": "
|
3678
|
-
"attribute": "
|
3606
|
+
"default": "0",
|
3607
|
+
"description": "This property specifies the tab order of the element.",
|
3608
|
+
"attribute": "tabIndex",
|
3679
3609
|
"reflects": true,
|
3680
3610
|
"inheritedFrom": {
|
3681
|
-
"name": "
|
3682
|
-
"module": "
|
3611
|
+
"name": "TabIndexMixin",
|
3612
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
3683
3613
|
}
|
3684
3614
|
},
|
3685
3615
|
{
|
3686
3616
|
"kind": "field",
|
3687
|
-
"name": "
|
3617
|
+
"name": "disabled",
|
3688
3618
|
"type": {
|
3689
|
-
"text": "
|
3619
|
+
"text": "boolean | undefined"
|
3690
3620
|
},
|
3691
|
-
"
|
3692
|
-
"
|
3693
|
-
"attribute": "
|
3621
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
3622
|
+
"default": "undefined",
|
3623
|
+
"attribute": "disabled",
|
3694
3624
|
"reflects": true,
|
3695
3625
|
"inheritedFrom": {
|
3696
|
-
"name": "
|
3697
|
-
"module": "
|
3626
|
+
"name": "DisabledMixin",
|
3627
|
+
"module": "utils/mixins/DisabledMixin.js"
|
3698
3628
|
}
|
3699
3629
|
},
|
3700
3630
|
{
|
3701
3631
|
"kind": "field",
|
3702
|
-
"name": "
|
3632
|
+
"name": "active",
|
3703
3633
|
"type": {
|
3704
|
-
"text": "
|
3634
|
+
"text": "boolean | undefined"
|
3705
3635
|
},
|
3706
|
-
"
|
3707
|
-
"
|
3708
|
-
"attribute": "
|
3636
|
+
"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.",
|
3637
|
+
"default": "undefined",
|
3638
|
+
"attribute": "active",
|
3709
3639
|
"reflects": true,
|
3710
3640
|
"inheritedFrom": {
|
3711
|
-
"name": "
|
3712
|
-
"module": "components/
|
3641
|
+
"name": "Buttonsimple",
|
3642
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3713
3643
|
}
|
3714
3644
|
},
|
3715
3645
|
{
|
3716
3646
|
"kind": "field",
|
3717
|
-
"name": "
|
3647
|
+
"name": "softDisabled",
|
3718
3648
|
"type": {
|
3719
|
-
"text": "
|
3649
|
+
"text": "boolean | undefined"
|
3720
3650
|
},
|
3721
|
-
"
|
3722
|
-
"
|
3723
|
-
"attribute": "
|
3651
|
+
"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.",
|
3652
|
+
"default": "undefined",
|
3653
|
+
"attribute": "soft-disabled",
|
3724
3654
|
"reflects": true,
|
3725
3655
|
"inheritedFrom": {
|
3726
|
-
"name": "
|
3727
|
-
"module": "components/
|
3656
|
+
"name": "Buttonsimple",
|
3657
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3728
3658
|
}
|
3729
3659
|
},
|
3730
3660
|
{
|
3731
3661
|
"kind": "field",
|
3732
|
-
"name": "
|
3662
|
+
"name": "role",
|
3733
3663
|
"type": {
|
3734
|
-
"text": "
|
3664
|
+
"text": "RoleType"
|
3735
3665
|
},
|
3736
|
-
"description": "
|
3737
|
-
"
|
3666
|
+
"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.",
|
3667
|
+
"default": "button",
|
3668
|
+
"attribute": "role",
|
3738
3669
|
"reflects": true,
|
3739
3670
|
"inheritedFrom": {
|
3740
|
-
"name": "
|
3741
|
-
"module": "components/
|
3671
|
+
"name": "Buttonsimple",
|
3672
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3742
3673
|
}
|
3743
3674
|
},
|
3744
3675
|
{
|
3745
3676
|
"kind": "field",
|
3746
|
-
"name": "
|
3677
|
+
"name": "ariaStateKey",
|
3747
3678
|
"type": {
|
3748
3679
|
"text": "string | undefined"
|
3749
3680
|
},
|
3750
|
-
"description": "
|
3751
|
-
"
|
3681
|
+
"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`",
|
3682
|
+
"default": "'aria-pressed' (when)",
|
3683
|
+
"attribute": "ariaStateKey",
|
3752
3684
|
"reflects": true,
|
3753
3685
|
"inheritedFrom": {
|
3754
|
-
"name": "
|
3755
|
-
"module": "components/
|
3686
|
+
"name": "Buttonsimple",
|
3687
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3756
3688
|
}
|
3757
3689
|
},
|
3758
3690
|
{
|
3759
3691
|
"kind": "field",
|
3760
|
-
"name": "
|
3692
|
+
"name": "type",
|
3761
3693
|
"type": {
|
3762
|
-
"text": "
|
3694
|
+
"text": "ButtonType"
|
3763
3695
|
},
|
3764
|
-
"description": "The
|
3765
|
-
"
|
3696
|
+
"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.",
|
3697
|
+
"default": "button",
|
3698
|
+
"attribute": "type",
|
3766
3699
|
"reflects": true,
|
3767
3700
|
"inheritedFrom": {
|
3768
|
-
"name": "
|
3769
|
-
"module": "components/
|
3701
|
+
"name": "Buttonsimple",
|
3702
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3770
3703
|
}
|
3771
3704
|
},
|
3772
3705
|
{
|
3773
3706
|
"kind": "field",
|
3774
|
-
"name": "
|
3707
|
+
"name": "name",
|
3775
3708
|
"type": {
|
3776
|
-
"text": "string"
|
3709
|
+
"text": "string | undefined"
|
3777
3710
|
},
|
3778
|
-
"description": "The
|
3779
|
-
"attribute": "
|
3711
|
+
"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.",
|
3712
|
+
"attribute": "name",
|
3780
3713
|
"reflects": true,
|
3781
3714
|
"inheritedFrom": {
|
3782
|
-
"name": "
|
3783
|
-
"module": "components/
|
3715
|
+
"name": "Buttonsimple",
|
3716
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3784
3717
|
}
|
3785
3718
|
},
|
3786
3719
|
{
|
3787
3720
|
"kind": "field",
|
3788
|
-
"name": "
|
3721
|
+
"name": "value",
|
3789
3722
|
"type": {
|
3790
|
-
"text": "
|
3723
|
+
"text": "string | undefined"
|
3791
3724
|
},
|
3792
|
-
"description": "
|
3793
|
-
"
|
3794
|
-
"attribute": "role",
|
3725
|
+
"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.",
|
3726
|
+
"attribute": "value",
|
3795
3727
|
"reflects": true,
|
3796
3728
|
"inheritedFrom": {
|
3797
|
-
"name": "
|
3798
|
-
"module": "components/
|
3729
|
+
"name": "Buttonsimple",
|
3730
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3799
3731
|
}
|
3800
3732
|
},
|
3801
3733
|
{
|
3802
|
-
"kind": "
|
3803
|
-
"name": "
|
3804
|
-
"
|
3805
|
-
"text": "boolean"
|
3806
|
-
},
|
3807
|
-
"description": "Disable setting the aria-haspopup attribute on trigger element.\nMake sure to set this to true when the popover is extended and its role\nis not 'dialog' or 'alertdialog' i.e. listbox, menu, etc.",
|
3808
|
-
"default": "false",
|
3809
|
-
"attribute": "disable-aria-haspopup",
|
3810
|
-
"reflects": true,
|
3734
|
+
"kind": "method",
|
3735
|
+
"name": "executeAction",
|
3736
|
+
"privacy": "protected",
|
3811
3737
|
"inheritedFrom": {
|
3812
|
-
"name": "
|
3813
|
-
"module": "components/
|
3738
|
+
"name": "Buttonsimple",
|
3739
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3814
3740
|
}
|
3815
3741
|
},
|
3816
3742
|
{
|
3817
3743
|
"kind": "method",
|
3818
|
-
"name": "
|
3819
|
-
"privacy": "
|
3820
|
-
"
|
3744
|
+
"name": "setActive",
|
3745
|
+
"privacy": "protected",
|
3746
|
+
"parameters": [
|
3747
|
+
{
|
3748
|
+
"name": "element",
|
3749
|
+
"type": {
|
3750
|
+
"text": "HTMLElement"
|
3751
|
+
},
|
3752
|
+
"description": "The button element"
|
3753
|
+
},
|
3754
|
+
{
|
3755
|
+
"name": "active",
|
3756
|
+
"optional": true,
|
3757
|
+
"type": {
|
3758
|
+
"text": "boolean"
|
3759
|
+
},
|
3760
|
+
"description": "The active state of the element"
|
3761
|
+
}
|
3762
|
+
],
|
3763
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button.",
|
3821
3764
|
"inheritedFrom": {
|
3822
|
-
"name": "
|
3823
|
-
"module": "components/
|
3765
|
+
"name": "Buttonsimple",
|
3766
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3824
3767
|
}
|
3825
3768
|
},
|
3826
3769
|
{
|
3827
3770
|
"kind": "method",
|
3828
|
-
"name": "
|
3771
|
+
"name": "setSoftDisabled",
|
3829
3772
|
"privacy": "private",
|
3830
3773
|
"parameters": [
|
3831
3774
|
{
|
3832
|
-
"name": "
|
3775
|
+
"name": "element",
|
3833
3776
|
"type": {
|
3834
|
-
"text": "
|
3777
|
+
"text": "HTMLElement"
|
3835
3778
|
},
|
3836
|
-
"description": "The
|
3779
|
+
"description": "The button element."
|
3837
3780
|
},
|
3838
3781
|
{
|
3839
|
-
"name": "
|
3782
|
+
"name": "softDisabled",
|
3783
|
+
"optional": true,
|
3840
3784
|
"type": {
|
3841
3785
|
"text": "boolean"
|
3842
3786
|
},
|
3843
|
-
"description": "The
|
3787
|
+
"description": "The soft-disabled state."
|
3844
3788
|
}
|
3845
3789
|
],
|
3846
|
-
"description": "
|
3790
|
+
"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.",
|
3847
3791
|
"inheritedFrom": {
|
3848
|
-
"name": "
|
3849
|
-
"module": "components/
|
3792
|
+
"name": "Buttonsimple",
|
3793
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3850
3794
|
}
|
3851
|
-
}
|
3852
|
-
],
|
3853
|
-
"events": [
|
3795
|
+
},
|
3854
3796
|
{
|
3855
|
-
"
|
3856
|
-
"name": "
|
3857
|
-
"
|
3797
|
+
"kind": "method",
|
3798
|
+
"name": "setDisabled",
|
3799
|
+
"privacy": "private",
|
3800
|
+
"parameters": [
|
3801
|
+
{
|
3802
|
+
"name": "element",
|
3803
|
+
"type": {
|
3804
|
+
"text": "HTMLElement"
|
3805
|
+
},
|
3806
|
+
"description": "The button element."
|
3807
|
+
},
|
3808
|
+
{
|
3809
|
+
"name": "disabled",
|
3810
|
+
"type": {
|
3811
|
+
"text": "boolean"
|
3812
|
+
},
|
3813
|
+
"description": "The disabled state."
|
3814
|
+
}
|
3815
|
+
],
|
3816
|
+
"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.",
|
3858
3817
|
"inheritedFrom": {
|
3859
|
-
"name": "
|
3860
|
-
"module": "
|
3818
|
+
"name": "Buttonsimple",
|
3819
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3861
3820
|
}
|
3862
3821
|
},
|
3863
3822
|
{
|
3864
|
-
"
|
3865
|
-
"name": "
|
3866
|
-
"
|
3823
|
+
"kind": "method",
|
3824
|
+
"name": "triggerClickEvent",
|
3825
|
+
"privacy": "private",
|
3867
3826
|
"inheritedFrom": {
|
3868
|
-
"name": "
|
3869
|
-
"module": "
|
3827
|
+
"name": "Buttonsimple",
|
3828
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3870
3829
|
}
|
3871
3830
|
},
|
3872
3831
|
{
|
3873
|
-
"
|
3874
|
-
"name": "
|
3875
|
-
"
|
3832
|
+
"kind": "method",
|
3833
|
+
"name": "handleBlur",
|
3834
|
+
"privacy": "private",
|
3835
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed.",
|
3876
3836
|
"inheritedFrom": {
|
3877
|
-
"name": "
|
3878
|
-
"module": "
|
3837
|
+
"name": "Buttonsimple",
|
3838
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3879
3839
|
}
|
3880
3840
|
},
|
3881
3841
|
{
|
3882
|
-
"
|
3883
|
-
"name": "
|
3884
|
-
"
|
3842
|
+
"kind": "method",
|
3843
|
+
"name": "handleKeyDown",
|
3844
|
+
"privacy": "private",
|
3845
|
+
"parameters": [
|
3846
|
+
{
|
3847
|
+
"name": "event",
|
3848
|
+
"type": {
|
3849
|
+
"text": "KeyboardEvent"
|
3850
|
+
},
|
3851
|
+
"description": "The keyboard event."
|
3852
|
+
}
|
3853
|
+
],
|
3854
|
+
"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.",
|
3885
3855
|
"inheritedFrom": {
|
3886
|
-
"name": "
|
3887
|
-
"module": "
|
3856
|
+
"name": "Buttonsimple",
|
3857
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3888
3858
|
}
|
3889
3859
|
},
|
3890
3860
|
{
|
3891
|
-
"
|
3892
|
-
"name": "
|
3893
|
-
"
|
3861
|
+
"kind": "method",
|
3862
|
+
"name": "handleKeyUp",
|
3863
|
+
"privacy": "private",
|
3864
|
+
"parameters": [
|
3865
|
+
{
|
3866
|
+
"name": "event",
|
3867
|
+
"type": {
|
3868
|
+
"text": "KeyboardEvent"
|
3869
|
+
},
|
3870
|
+
"description": "The keyboard event."
|
3871
|
+
}
|
3872
|
+
],
|
3873
|
+
"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.",
|
3894
3874
|
"inheritedFrom": {
|
3895
|
-
"name": "
|
3896
|
-
"module": "
|
3875
|
+
"name": "Buttonsimple",
|
3876
|
+
"module": "components/buttonsimple/buttonsimple.component.js"
|
3897
3877
|
}
|
3898
3878
|
}
|
3899
3879
|
],
|
3900
|
-
"
|
3880
|
+
"events": [
|
3901
3881
|
{
|
3902
|
-
"
|
3903
|
-
"
|
3904
|
-
|
3905
|
-
|
3906
|
-
|
3907
|
-
|
3882
|
+
"description": "(React: onClick) This event is dispatched when the avatarbutton is clicked.",
|
3883
|
+
"name": "click",
|
3884
|
+
"reactName": "onClick",
|
3885
|
+
"inheritedFrom": {
|
3886
|
+
"name": "Buttonsimple",
|
3887
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3888
|
+
}
|
3908
3889
|
},
|
3909
3890
|
{
|
3910
|
-
"
|
3911
|
-
"
|
3912
|
-
|
3913
|
-
},
|
3914
|
-
"description": "The size of the announcement dialog, can be 'medium' (656px width), 'large' (992px width), 'xlarge' (90% width) or 'fullscreen' (100% width).",
|
3915
|
-
"default": "medium",
|
3916
|
-
"fieldName": "size",
|
3891
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the avatarbutton.",
|
3892
|
+
"name": "keydown",
|
3893
|
+
"reactName": "onKeyDown",
|
3917
3894
|
"inheritedFrom": {
|
3918
|
-
"name": "
|
3919
|
-
"module": "src/components/
|
3895
|
+
"name": "Buttonsimple",
|
3896
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3920
3897
|
}
|
3921
3898
|
},
|
3922
3899
|
{
|
3923
|
-
"
|
3924
|
-
"
|
3925
|
-
|
3926
|
-
},
|
3927
|
-
"default": "true",
|
3928
|
-
"description": "Determines whether focus should wrap around when reaching the first or last focusable element.\nIf true, focus will cycle from end to start and vice versa.\n\nThis only applies when `focusTrap` is true.",
|
3929
|
-
"fieldName": "shouldFocusTrapWrap",
|
3900
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the avatarbutton.",
|
3901
|
+
"name": "keyup",
|
3902
|
+
"reactName": "onKeyUp",
|
3930
3903
|
"inheritedFrom": {
|
3931
|
-
"name": "
|
3932
|
-
"module": "src/
|
3904
|
+
"name": "Buttonsimple",
|
3905
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3906
|
+
}
|
3907
|
+
},
|
3908
|
+
{
|
3909
|
+
"description": "(React: onFocus) This event is dispatched when the avatarbutton receives focus.",
|
3910
|
+
"name": "focus",
|
3911
|
+
"reactName": "onFocus",
|
3912
|
+
"inheritedFrom": {
|
3913
|
+
"name": "Buttonsimple",
|
3914
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3933
3915
|
}
|
3916
|
+
}
|
3917
|
+
],
|
3918
|
+
"attributes": [
|
3919
|
+
{
|
3920
|
+
"name": "aria-label",
|
3921
|
+
"type": {
|
3922
|
+
"text": "string | null"
|
3923
|
+
},
|
3924
|
+
"default": "null",
|
3925
|
+
"description": "Aria-label attribute to be set for accessibility",
|
3926
|
+
"fieldName": "ariaLabel"
|
3934
3927
|
},
|
3935
3928
|
{
|
3936
|
-
"name": "
|
3929
|
+
"name": "src",
|
3937
3930
|
"type": {
|
3938
|
-
"text": "string"
|
3931
|
+
"text": "string | undefined"
|
3939
3932
|
},
|
3940
|
-
"
|
3941
|
-
"
|
3942
|
-
"fieldName": "id",
|
3933
|
+
"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.",
|
3934
|
+
"fieldName": "src",
|
3943
3935
|
"inheritedFrom": {
|
3944
|
-
"name": "
|
3945
|
-
"module": "src/
|
3936
|
+
"name": "AvatarComponentMixin",
|
3937
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3946
3938
|
}
|
3947
3939
|
},
|
3948
3940
|
{
|
3949
|
-
"name": "
|
3941
|
+
"name": "initials",
|
3950
3942
|
"type": {
|
3951
3943
|
"text": "string | undefined"
|
3952
3944
|
},
|
3953
|
-
"description": "The
|
3954
|
-
"
|
3955
|
-
"fieldName": "triggerId",
|
3945
|
+
"description": "The initials to be displayed for the avatar.",
|
3946
|
+
"fieldName": "initials",
|
3956
3947
|
"inheritedFrom": {
|
3957
|
-
"name": "
|
3958
|
-
"module": "src/
|
3948
|
+
"name": "AvatarComponentMixin",
|
3949
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3959
3950
|
}
|
3960
3951
|
},
|
3961
3952
|
{
|
3962
|
-
"name": "
|
3953
|
+
"name": "presence",
|
3963
3954
|
"type": {
|
3964
|
-
"text": "
|
3955
|
+
"text": "PresenceType | undefined"
|
3965
3956
|
},
|
3966
|
-
"description": "The
|
3967
|
-
"
|
3968
|
-
"fieldName": "visible",
|
3957
|
+
"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`",
|
3958
|
+
"fieldName": "presence",
|
3969
3959
|
"inheritedFrom": {
|
3970
|
-
"name": "
|
3971
|
-
"module": "src/
|
3960
|
+
"name": "AvatarComponentMixin",
|
3961
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3972
3962
|
}
|
3973
3963
|
},
|
3974
3964
|
{
|
3975
|
-
"name": "
|
3965
|
+
"name": "size",
|
3976
3966
|
"type": {
|
3977
|
-
"text": "
|
3967
|
+
"text": "ButtonSize"
|
3978
3968
|
},
|
3979
|
-
"description": "
|
3980
|
-
"default": "
|
3981
|
-
"fieldName": "
|
3969
|
+
"description": "Acceptable values include (size in px unit):\n- 24\n- 32\n- 48\n- 64\n- 72\n- 88\n- 124",
|
3970
|
+
"default": "32",
|
3971
|
+
"fieldName": "size",
|
3982
3972
|
"inheritedFrom": {
|
3983
|
-
"name": "
|
3984
|
-
"module": "src/components/
|
3973
|
+
"name": "Buttonsimple",
|
3974
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
3985
3975
|
}
|
3986
3976
|
},
|
3987
3977
|
{
|
3988
|
-
"name": "
|
3978
|
+
"name": "counter",
|
3989
3979
|
"type": {
|
3990
|
-
"text": "
|
3980
|
+
"text": "number | undefined"
|
3991
3981
|
},
|
3992
|
-
"description": "The
|
3993
|
-
"
|
3994
|
-
"fieldName": "variant",
|
3982
|
+
"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`.",
|
3983
|
+
"fieldName": "counter",
|
3995
3984
|
"inheritedFrom": {
|
3996
|
-
"name": "
|
3997
|
-
"module": "src/
|
3985
|
+
"name": "AvatarComponentMixin",
|
3986
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
3998
3987
|
}
|
3999
3988
|
},
|
4000
3989
|
{
|
4001
|
-
"name": "
|
3990
|
+
"name": "is-typing",
|
4002
3991
|
"type": {
|
4003
|
-
"text": "
|
3992
|
+
"text": "boolean"
|
4004
3993
|
},
|
4005
|
-
"default": "
|
4006
|
-
"description": "
|
4007
|
-
"fieldName": "
|
3994
|
+
"default": "false",
|
3995
|
+
"description": "Represents the typing indicator when the user is typing.",
|
3996
|
+
"fieldName": "isTyping",
|
4008
3997
|
"inheritedFrom": {
|
4009
|
-
"name": "
|
4010
|
-
"module": "src/
|
3998
|
+
"name": "AvatarComponentMixin",
|
3999
|
+
"module": "src/utils/mixins/AvatarComponentMixin.ts"
|
4011
4000
|
}
|
4012
4001
|
},
|
4013
4002
|
{
|
4014
|
-
"name": "
|
4003
|
+
"name": "icon-name",
|
4015
4004
|
"type": {
|
4016
|
-
"text": "
|
4005
|
+
"text": "IconNames | undefined"
|
4017
4006
|
},
|
4018
|
-
"
|
4019
|
-
"
|
4020
|
-
"fieldName": "ariaLabel",
|
4007
|
+
"description": "Name of the icon (= filename).\n\nIf no `icon-name` is provided, no icon will be rendered.",
|
4008
|
+
"fieldName": "iconName",
|
4021
4009
|
"inheritedFrom": {
|
4022
|
-
"name": "
|
4023
|
-
"module": "src/
|
4010
|
+
"name": "IconNameMixin",
|
4011
|
+
"module": "src/utils/mixins/IconNameMixin.ts"
|
4024
4012
|
}
|
4025
4013
|
},
|
4026
4014
|
{
|
4027
|
-
"name": "
|
4015
|
+
"name": "auto-focus-on-mount",
|
4028
4016
|
"type": {
|
4029
|
-
"text": "
|
4017
|
+
"text": "boolean"
|
4030
4018
|
},
|
4031
|
-
"default": "
|
4032
|
-
"description": "
|
4033
|
-
"fieldName": "
|
4019
|
+
"default": "false",
|
4020
|
+
"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.",
|
4021
|
+
"fieldName": "autoFocusOnMount",
|
4034
4022
|
"inheritedFrom": {
|
4035
|
-
"name": "
|
4036
|
-
"module": "src/
|
4023
|
+
"name": "AutoFocusOnMountMixin",
|
4024
|
+
"module": "src/utils/mixins/AutoFocusOnMountMixin.ts"
|
4037
4025
|
}
|
4038
4026
|
},
|
4039
4027
|
{
|
4040
|
-
"name": "
|
4028
|
+
"name": "tabIndex",
|
4041
4029
|
"type": {
|
4042
|
-
"text": "
|
4030
|
+
"text": "number"
|
4043
4031
|
},
|
4044
|
-
"default": "
|
4045
|
-
"description": "
|
4046
|
-
"fieldName": "
|
4032
|
+
"default": "0",
|
4033
|
+
"description": "This property specifies the tab order of the element.",
|
4034
|
+
"fieldName": "tabIndex",
|
4047
4035
|
"inheritedFrom": {
|
4048
|
-
"name": "
|
4049
|
-
"module": "src/
|
4036
|
+
"name": "TabIndexMixin",
|
4037
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
4050
4038
|
}
|
4051
4039
|
},
|
4052
4040
|
{
|
4053
|
-
"name": "
|
4041
|
+
"name": "disabled",
|
4054
4042
|
"type": {
|
4055
|
-
"text": "
|
4043
|
+
"text": "boolean | undefined"
|
4056
4044
|
},
|
4057
|
-
"
|
4058
|
-
"
|
4059
|
-
"fieldName": "
|
4045
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
4046
|
+
"default": "undefined",
|
4047
|
+
"fieldName": "disabled",
|
4060
4048
|
"inheritedFrom": {
|
4061
|
-
"name": "
|
4062
|
-
"module": "src/
|
4049
|
+
"name": "DisabledMixin",
|
4050
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
4063
4051
|
}
|
4064
4052
|
},
|
4065
4053
|
{
|
4066
|
-
"name": "
|
4054
|
+
"name": "active",
|
4067
4055
|
"type": {
|
4068
|
-
"text": "
|
4056
|
+
"text": "boolean | undefined"
|
4069
4057
|
},
|
4070
|
-
"description": "
|
4071
|
-
"
|
4058
|
+
"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.",
|
4059
|
+
"default": "undefined",
|
4060
|
+
"fieldName": "active",
|
4072
4061
|
"inheritedFrom": {
|
4073
|
-
"name": "
|
4074
|
-
"module": "src/components/
|
4062
|
+
"name": "Buttonsimple",
|
4063
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4075
4064
|
}
|
4076
4065
|
},
|
4077
4066
|
{
|
4078
|
-
"name": "
|
4067
|
+
"name": "soft-disabled",
|
4079
4068
|
"type": {
|
4080
|
-
"text": "
|
4069
|
+
"text": "boolean | undefined"
|
4081
4070
|
},
|
4082
|
-
"description": "
|
4083
|
-
"
|
4071
|
+
"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.",
|
4072
|
+
"default": "undefined",
|
4073
|
+
"fieldName": "softDisabled",
|
4084
4074
|
"inheritedFrom": {
|
4085
|
-
"name": "
|
4086
|
-
"module": "src/components/
|
4075
|
+
"name": "Buttonsimple",
|
4076
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4087
4077
|
}
|
4088
4078
|
},
|
4089
4079
|
{
|
4090
|
-
"name": "
|
4080
|
+
"name": "role",
|
4091
4081
|
"type": {
|
4092
|
-
"text": "
|
4082
|
+
"text": "RoleType"
|
4093
4083
|
},
|
4094
|
-
"description": "
|
4095
|
-
"
|
4084
|
+
"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.",
|
4085
|
+
"default": "button",
|
4086
|
+
"fieldName": "role",
|
4096
4087
|
"inheritedFrom": {
|
4097
|
-
"name": "
|
4098
|
-
"module": "src/components/
|
4088
|
+
"name": "Buttonsimple",
|
4089
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4099
4090
|
}
|
4100
4091
|
},
|
4101
4092
|
{
|
4102
|
-
"name": "
|
4093
|
+
"name": "ariaStateKey",
|
4103
4094
|
"type": {
|
4104
|
-
"text": "string"
|
4095
|
+
"text": "string | undefined"
|
4105
4096
|
},
|
4106
|
-
"description": "
|
4107
|
-
"
|
4097
|
+
"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`",
|
4098
|
+
"default": "'aria-pressed' (when)",
|
4099
|
+
"fieldName": "ariaStateKey",
|
4108
4100
|
"inheritedFrom": {
|
4109
|
-
"name": "
|
4110
|
-
"module": "src/components/
|
4101
|
+
"name": "Buttonsimple",
|
4102
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4111
4103
|
}
|
4112
4104
|
},
|
4113
4105
|
{
|
4114
|
-
"name": "
|
4106
|
+
"name": "type",
|
4115
4107
|
"type": {
|
4116
|
-
"text": "
|
4108
|
+
"text": "ButtonType"
|
4117
4109
|
},
|
4118
|
-
"description": "
|
4119
|
-
"default": "
|
4120
|
-
"fieldName": "
|
4110
|
+
"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.",
|
4111
|
+
"default": "button",
|
4112
|
+
"fieldName": "type",
|
4121
4113
|
"inheritedFrom": {
|
4122
|
-
"name": "
|
4123
|
-
"module": "src/components/
|
4114
|
+
"name": "Buttonsimple",
|
4115
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4124
4116
|
}
|
4125
4117
|
},
|
4126
4118
|
{
|
4127
|
-
"name": "
|
4119
|
+
"name": "name",
|
4128
4120
|
"type": {
|
4129
|
-
"text": "
|
4121
|
+
"text": "string | undefined"
|
4130
4122
|
},
|
4131
|
-
"description": "
|
4132
|
-
"
|
4133
|
-
"fieldName": "disableAriaHasPopup",
|
4123
|
+
"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.",
|
4124
|
+
"fieldName": "name",
|
4134
4125
|
"inheritedFrom": {
|
4135
|
-
"name": "
|
4136
|
-
"module": "src/components/
|
4126
|
+
"name": "Buttonsimple",
|
4127
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4137
4128
|
}
|
4138
4129
|
},
|
4139
4130
|
{
|
4140
|
-
"name": "
|
4131
|
+
"name": "value",
|
4141
4132
|
"type": {
|
4142
|
-
"text": "
|
4133
|
+
"text": "string | undefined"
|
4143
4134
|
},
|
4144
|
-
"description": "
|
4145
|
-
"
|
4146
|
-
"fieldName": "focusTrap",
|
4135
|
+
"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.",
|
4136
|
+
"fieldName": "value",
|
4147
4137
|
"inheritedFrom": {
|
4148
|
-
"name": "
|
4149
|
-
"module": "src/components/
|
4138
|
+
"name": "Buttonsimple",
|
4139
|
+
"module": "src/components/buttonsimple/buttonsimple.component.ts"
|
4150
4140
|
}
|
4151
4141
|
}
|
4152
4142
|
],
|
4143
|
+
"mixins": [
|
4144
|
+
{
|
4145
|
+
"name": "AvatarComponentMixin",
|
4146
|
+
"module": "/src/utils/mixins/AvatarComponentMixin"
|
4147
|
+
},
|
4148
|
+
{
|
4149
|
+
"name": "IconNameMixin",
|
4150
|
+
"module": "/src/utils/mixins/IconNameMixin"
|
4151
|
+
}
|
4152
|
+
],
|
4153
4153
|
"superclass": {
|
4154
|
-
"name": "
|
4155
|
-
"module": "/src/components/
|
4154
|
+
"name": "Buttonsimple",
|
4155
|
+
"module": "/src/components/buttonsimple/buttonsimple.component"
|
4156
4156
|
},
|
4157
|
-
"tagName": "mdc-
|
4158
|
-
"jsDoc": "/**\n *
|
4157
|
+
"tagName": "mdc-avatarbutton",
|
4158
|
+
"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 */",
|
4159
4159
|
"customElement": true
|
4160
4160
|
}
|
4161
4161
|
],
|
@@ -4164,8 +4164,8 @@
|
|
4164
4164
|
"kind": "js",
|
4165
4165
|
"name": "default",
|
4166
4166
|
"declaration": {
|
4167
|
-
"name": "
|
4168
|
-
"module": "components/
|
4167
|
+
"name": "AvatarButton",
|
4168
|
+
"module": "components/avatarbutton/avatarbutton.component.js"
|
4169
4169
|
}
|
4170
4170
|
}
|
4171
4171
|
]
|