@momentum-design/components 0.102.4 → 0.102.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/index.js +2 -2
- package/dist/browser/index.js.map +3 -3
- package/dist/components/input/input.component.d.ts +1 -0
- package/dist/components/input/input.component.js +2 -0
- package/dist/components/input/input.types.d.ts +7 -3
- package/dist/components/searchfield/searchfield.component.d.ts +7 -2
- package/dist/components/searchfield/searchfield.component.js +8 -3
- package/dist/components/searchfield/searchfield.types.d.ts +2 -0
- package/dist/components/searchfield/searchfield.types.js +1 -0
- package/dist/custom-elements.json +2000 -1968
- package/dist/react/index.d.ts +3 -3
- package/dist/react/index.js +3 -3
- package/dist/react/input/index.d.ts +3 -1
- package/dist/react/input/index.js +2 -0
- package/dist/react/password/index.d.ts +2 -1
- package/dist/react/password/index.js +1 -0
- package/dist/react/searchfield/index.d.ts +9 -3
- package/dist/react/searchfield/index.js +8 -2
- 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",
|
@@ -968,6 +817,157 @@
|
|
968
817
|
}
|
969
818
|
]
|
970
819
|
},
|
820
|
+
{
|
821
|
+
"kind": "javascript-module",
|
822
|
+
"path": "components/accordiongroup/accordiongroup.component.js",
|
823
|
+
"declarations": [
|
824
|
+
{
|
825
|
+
"kind": "class",
|
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",
|
828
|
+
"cssProperties": [
|
829
|
+
{
|
830
|
+
"description": "The border color of the entire accordiongroup",
|
831
|
+
"name": "--mdc-accordiongroup-border-color"
|
832
|
+
}
|
833
|
+
],
|
834
|
+
"slots": [
|
835
|
+
{
|
836
|
+
"description": "The default slot can contain the `accordion` or `accordionbutton` components.",
|
837
|
+
"name": "default"
|
838
|
+
}
|
839
|
+
],
|
840
|
+
"members": [
|
841
|
+
{
|
842
|
+
"kind": "field",
|
843
|
+
"name": "size",
|
844
|
+
"type": {
|
845
|
+
"text": "Size"
|
846
|
+
},
|
847
|
+
"description": "The size of the accordion item.",
|
848
|
+
"default": "'small'",
|
849
|
+
"attribute": "size",
|
850
|
+
"reflects": true
|
851
|
+
},
|
852
|
+
{
|
853
|
+
"kind": "field",
|
854
|
+
"name": "variant",
|
855
|
+
"type": {
|
856
|
+
"text": "Variant"
|
857
|
+
},
|
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
|
862
|
+
},
|
863
|
+
{
|
864
|
+
"kind": "field",
|
865
|
+
"name": "allowMultiple",
|
866
|
+
"type": {
|
867
|
+
"text": "boolean"
|
868
|
+
},
|
869
|
+
"default": "false",
|
870
|
+
"description": "If true, multiple accordion items can be visible at the same time.",
|
871
|
+
"attribute": "allow-multiple",
|
872
|
+
"reflects": true
|
873
|
+
},
|
874
|
+
{
|
875
|
+
"kind": "method",
|
876
|
+
"name": "handleAccordionExpanded",
|
877
|
+
"privacy": "private",
|
878
|
+
"return": {
|
879
|
+
"type": {
|
880
|
+
"text": "void"
|
881
|
+
}
|
882
|
+
},
|
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."
|
893
|
+
},
|
894
|
+
{
|
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
971
|
{
|
972
972
|
"kind": "javascript-module",
|
973
973
|
"path": "components/alertchip/alertchip.component.js",
|
@@ -4068,22 +4068,22 @@
|
|
4068
4068
|
},
|
4069
4069
|
{
|
4070
4070
|
"kind": "javascript-module",
|
4071
|
-
"path": "components/
|
4071
|
+
"path": "components/buttonsimple/buttonsimple.component.js",
|
4072
4072
|
"declarations": [
|
4073
4073
|
{
|
4074
4074
|
"kind": "class",
|
4075
|
-
"description": "`mdc-
|
4076
|
-
"name": "
|
4075
|
+
"description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
|
4076
|
+
"name": "Buttonsimple",
|
4077
4077
|
"members": [
|
4078
4078
|
{
|
4079
4079
|
"kind": "field",
|
4080
|
-
"name": "
|
4080
|
+
"name": "active",
|
4081
4081
|
"type": {
|
4082
|
-
"text": "
|
4082
|
+
"text": "boolean | undefined"
|
4083
4083
|
},
|
4084
|
-
"description": "
|
4085
|
-
"default": "
|
4086
|
-
"attribute": "
|
4084
|
+
"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.",
|
4085
|
+
"default": "undefined",
|
4086
|
+
"attribute": "active",
|
4087
4087
|
"reflects": true
|
4088
4088
|
},
|
4089
4089
|
{
|
@@ -4092,176 +4092,182 @@
|
|
4092
4092
|
"type": {
|
4093
4093
|
"text": "boolean | undefined"
|
4094
4094
|
},
|
4095
|
-
"description": "Indicates whether the
|
4095
|
+
"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.",
|
4096
4096
|
"default": "undefined",
|
4097
4097
|
"attribute": "soft-disabled",
|
4098
4098
|
"reflects": true
|
4099
4099
|
},
|
4100
|
-
{
|
4101
|
-
"kind": "method",
|
4102
|
-
"name": "setSoftDisabled",
|
4103
|
-
"privacy": "private",
|
4104
|
-
"parameters": [
|
4105
|
-
{
|
4106
|
-
"name": "element",
|
4107
|
-
"type": {
|
4108
|
-
"text": "HTMLElement"
|
4109
|
-
},
|
4110
|
-
"description": "The buttonlink element."
|
4111
|
-
},
|
4112
|
-
{
|
4113
|
-
"name": "softDisabled",
|
4114
|
-
"optional": true,
|
4115
|
-
"type": {
|
4116
|
-
"text": "boolean"
|
4117
|
-
},
|
4118
|
-
"description": "The soft-disabled state."
|
4119
|
-
}
|
4120
|
-
],
|
4121
|
-
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
4122
|
-
},
|
4123
4100
|
{
|
4124
4101
|
"kind": "field",
|
4125
|
-
"name": "
|
4102
|
+
"name": "size",
|
4126
4103
|
"type": {
|
4127
|
-
"text": "
|
4104
|
+
"text": "ButtonSize"
|
4128
4105
|
},
|
4129
|
-
"description": "
|
4130
|
-
"
|
4131
|
-
"
|
4132
|
-
"
|
4133
|
-
"name": "ButtonComponentMixin",
|
4134
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4135
|
-
}
|
4106
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
4107
|
+
"default": "32",
|
4108
|
+
"attribute": "size",
|
4109
|
+
"reflects": true
|
4136
4110
|
},
|
4137
4111
|
{
|
4138
4112
|
"kind": "field",
|
4139
|
-
"name": "
|
4113
|
+
"name": "role",
|
4140
4114
|
"type": {
|
4141
|
-
"text": "
|
4115
|
+
"text": "RoleType"
|
4142
4116
|
},
|
4143
|
-
"description": "
|
4144
|
-
"
|
4145
|
-
"
|
4146
|
-
"
|
4147
|
-
"name": "ButtonComponentMixin",
|
4148
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4149
|
-
}
|
4117
|
+
"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.",
|
4118
|
+
"default": "button",
|
4119
|
+
"attribute": "role",
|
4120
|
+
"reflects": true
|
4150
4121
|
},
|
4151
4122
|
{
|
4152
4123
|
"kind": "field",
|
4153
|
-
"name": "
|
4124
|
+
"name": "ariaStateKey",
|
4154
4125
|
"type": {
|
4155
|
-
"text": "
|
4126
|
+
"text": "string | undefined"
|
4156
4127
|
},
|
4157
|
-
"description": "
|
4158
|
-
"default": "
|
4159
|
-
"attribute": "
|
4160
|
-
"
|
4161
|
-
"name": "ButtonComponentMixin",
|
4162
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4163
|
-
}
|
4128
|
+
"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`",
|
4129
|
+
"default": "'aria-pressed' (when)",
|
4130
|
+
"attribute": "ariaStateKey",
|
4131
|
+
"reflects": true
|
4164
4132
|
},
|
4165
4133
|
{
|
4166
4134
|
"kind": "field",
|
4167
|
-
"name": "
|
4135
|
+
"name": "type",
|
4168
4136
|
"type": {
|
4169
|
-
"text": "
|
4137
|
+
"text": "ButtonType"
|
4170
4138
|
},
|
4171
|
-
"description": "
|
4172
|
-
"default": "
|
4173
|
-
"attribute": "
|
4174
|
-
"
|
4175
|
-
"name": "ButtonComponentMixin",
|
4176
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4177
|
-
}
|
4139
|
+
"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.",
|
4140
|
+
"default": "button",
|
4141
|
+
"attribute": "type",
|
4142
|
+
"reflects": true
|
4178
4143
|
},
|
4179
4144
|
{
|
4180
4145
|
"kind": "method",
|
4181
|
-
"name": "
|
4146
|
+
"name": "executeAction",
|
4147
|
+
"privacy": "protected"
|
4148
|
+
},
|
4149
|
+
{
|
4150
|
+
"kind": "method",
|
4151
|
+
"name": "setActive",
|
4182
4152
|
"privacy": "protected",
|
4183
4153
|
"parameters": [
|
4184
4154
|
{
|
4185
|
-
"name": "
|
4155
|
+
"name": "element",
|
4186
4156
|
"type": {
|
4187
|
-
"text": "
|
4157
|
+
"text": "HTMLElement"
|
4188
4158
|
},
|
4189
|
-
"description": "The
|
4159
|
+
"description": "The button element"
|
4160
|
+
},
|
4161
|
+
{
|
4162
|
+
"name": "active",
|
4163
|
+
"optional": true,
|
4164
|
+
"type": {
|
4165
|
+
"text": "boolean"
|
4166
|
+
},
|
4167
|
+
"description": "The active state of the element"
|
4190
4168
|
}
|
4191
4169
|
],
|
4192
|
-
"description": "Sets the
|
4193
|
-
"inheritedFrom": {
|
4194
|
-
"name": "ButtonComponentMixin",
|
4195
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4196
|
-
}
|
4170
|
+
"description": "Sets the ariaStateKey attributes based on the active state of the button."
|
4197
4171
|
},
|
4198
4172
|
{
|
4199
4173
|
"kind": "method",
|
4200
|
-
"name": "
|
4201
|
-
"privacy": "
|
4174
|
+
"name": "setSoftDisabled",
|
4175
|
+
"privacy": "private",
|
4202
4176
|
"parameters": [
|
4203
4177
|
{
|
4204
|
-
"name": "
|
4178
|
+
"name": "element",
|
4205
4179
|
"type": {
|
4206
|
-
"text": "
|
4180
|
+
"text": "HTMLElement"
|
4207
4181
|
},
|
4208
|
-
"description": "The
|
4182
|
+
"description": "The button element."
|
4183
|
+
},
|
4184
|
+
{
|
4185
|
+
"name": "softDisabled",
|
4186
|
+
"optional": true,
|
4187
|
+
"type": {
|
4188
|
+
"text": "boolean"
|
4189
|
+
},
|
4190
|
+
"description": "The soft-disabled state."
|
4209
4191
|
}
|
4210
4192
|
],
|
4211
|
-
"description": "Sets the
|
4212
|
-
"inheritedFrom": {
|
4213
|
-
"name": "ButtonComponentMixin",
|
4214
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4215
|
-
}
|
4193
|
+
"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."
|
4216
4194
|
},
|
4217
4195
|
{
|
4218
4196
|
"kind": "method",
|
4219
|
-
"name": "
|
4220
|
-
"privacy": "
|
4197
|
+
"name": "setDisabled",
|
4198
|
+
"privacy": "private",
|
4221
4199
|
"parameters": [
|
4222
4200
|
{
|
4223
|
-
"name": "
|
4201
|
+
"name": "element",
|
4224
4202
|
"type": {
|
4225
|
-
"text": "
|
4203
|
+
"text": "HTMLElement"
|
4226
4204
|
},
|
4227
|
-
"description": "The
|
4205
|
+
"description": "The button element."
|
4206
|
+
},
|
4207
|
+
{
|
4208
|
+
"name": "disabled",
|
4209
|
+
"type": {
|
4210
|
+
"text": "boolean"
|
4211
|
+
},
|
4212
|
+
"description": "The disabled state."
|
4228
4213
|
}
|
4229
4214
|
],
|
4230
|
-
"description": "Sets the
|
4231
|
-
"inheritedFrom": {
|
4232
|
-
"name": "ButtonComponentMixin",
|
4233
|
-
"module": "utils/mixins/ButtonComponentMixin.js"
|
4234
|
-
}
|
4215
|
+
"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."
|
4235
4216
|
},
|
4236
4217
|
{
|
4237
4218
|
"kind": "method",
|
4238
|
-
"name": "
|
4239
|
-
"privacy": "
|
4240
|
-
|
4219
|
+
"name": "triggerClickEvent",
|
4220
|
+
"privacy": "private"
|
4221
|
+
},
|
4222
|
+
{
|
4223
|
+
"kind": "method",
|
4224
|
+
"name": "handleBlur",
|
4225
|
+
"privacy": "private",
|
4226
|
+
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
4227
|
+
},
|
4228
|
+
{
|
4229
|
+
"kind": "method",
|
4230
|
+
"name": "handleKeyDown",
|
4231
|
+
"privacy": "private",
|
4241
4232
|
"parameters": [
|
4242
4233
|
{
|
4243
|
-
"
|
4244
|
-
"
|
4234
|
+
"name": "event",
|
4235
|
+
"type": {
|
4236
|
+
"text": "KeyboardEvent"
|
4237
|
+
},
|
4238
|
+
"description": "The keyboard event."
|
4245
4239
|
}
|
4246
4240
|
],
|
4247
|
-
"
|
4248
|
-
|
4249
|
-
|
4250
|
-
|
4241
|
+
"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."
|
4242
|
+
},
|
4243
|
+
{
|
4244
|
+
"kind": "method",
|
4245
|
+
"name": "handleKeyUp",
|
4246
|
+
"privacy": "private",
|
4247
|
+
"parameters": [
|
4248
|
+
{
|
4249
|
+
"name": "event",
|
4250
|
+
"type": {
|
4251
|
+
"text": "KeyboardEvent"
|
4252
|
+
},
|
4253
|
+
"description": "The keyboard event."
|
4254
|
+
}
|
4255
|
+
],
|
4256
|
+
"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."
|
4251
4257
|
},
|
4252
4258
|
{
|
4253
4259
|
"kind": "field",
|
4254
|
-
"name": "
|
4260
|
+
"name": "autofocus",
|
4255
4261
|
"type": {
|
4256
|
-
"text": "boolean
|
4262
|
+
"text": "boolean"
|
4257
4263
|
},
|
4258
|
-
"
|
4259
|
-
"
|
4260
|
-
"attribute": "
|
4264
|
+
"default": "false",
|
4265
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
4266
|
+
"attribute": "autofocus",
|
4261
4267
|
"reflects": true,
|
4262
4268
|
"inheritedFrom": {
|
4263
|
-
"name": "
|
4264
|
-
"module": "utils/mixins/
|
4269
|
+
"name": "AutoFocusMixin",
|
4270
|
+
"module": "utils/mixins/AutoFocusMixin.js"
|
4265
4271
|
}
|
4266
4272
|
},
|
4267
4273
|
{
|
@@ -4281,238 +4287,108 @@
|
|
4281
4287
|
},
|
4282
4288
|
{
|
4283
4289
|
"kind": "field",
|
4284
|
-
"name": "
|
4285
|
-
"type": {
|
4286
|
-
"text": "boolean"
|
4287
|
-
},
|
4288
|
-
"description": "The link can be inline or standalone.",
|
4289
|
-
"default": "false",
|
4290
|
-
"attribute": "inline",
|
4291
|
-
"reflects": true,
|
4292
|
-
"inheritedFrom": {
|
4293
|
-
"name": "Linksimple",
|
4294
|
-
"module": "components/linksimple/linksimple.component.js"
|
4295
|
-
}
|
4296
|
-
},
|
4297
|
-
{
|
4298
|
-
"kind": "field",
|
4299
|
-
"name": "inverted",
|
4300
|
-
"type": {
|
4301
|
-
"text": "boolean"
|
4302
|
-
},
|
4303
|
-
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
4304
|
-
"default": "false",
|
4305
|
-
"attribute": "inverted",
|
4306
|
-
"reflects": true,
|
4307
|
-
"inheritedFrom": {
|
4308
|
-
"name": "Linksimple",
|
4309
|
-
"module": "components/linksimple/linksimple.component.js"
|
4310
|
-
}
|
4311
|
-
},
|
4312
|
-
{
|
4313
|
-
"kind": "field",
|
4314
|
-
"name": "href",
|
4315
|
-
"type": {
|
4316
|
-
"text": "string"
|
4317
|
-
},
|
4318
|
-
"default": "'#'",
|
4319
|
-
"description": "Href for navigation. The URL that the hyperlink points to",
|
4320
|
-
"attribute": "href",
|
4321
|
-
"reflects": true,
|
4322
|
-
"inheritedFrom": {
|
4323
|
-
"name": "Linksimple",
|
4324
|
-
"module": "components/linksimple/linksimple.component.js"
|
4325
|
-
}
|
4326
|
-
},
|
4327
|
-
{
|
4328
|
-
"kind": "field",
|
4329
|
-
"name": "target",
|
4330
|
-
"type": {
|
4331
|
-
"text": "string"
|
4332
|
-
},
|
4333
|
-
"default": "'_self'",
|
4334
|
-
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
4335
|
-
"attribute": "target",
|
4336
|
-
"reflects": true,
|
4337
|
-
"inheritedFrom": {
|
4338
|
-
"name": "Linksimple",
|
4339
|
-
"module": "components/linksimple/linksimple.component.js"
|
4340
|
-
}
|
4341
|
-
},
|
4342
|
-
{
|
4343
|
-
"kind": "field",
|
4344
|
-
"name": "rel",
|
4290
|
+
"name": "disabled",
|
4345
4291
|
"type": {
|
4346
|
-
"text": "
|
4292
|
+
"text": "boolean | undefined"
|
4347
4293
|
},
|
4348
|
-
"description": "
|
4349
|
-
"
|
4294
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
4295
|
+
"default": "undefined",
|
4296
|
+
"attribute": "disabled",
|
4350
4297
|
"reflects": true,
|
4351
4298
|
"inheritedFrom": {
|
4352
|
-
"name": "
|
4353
|
-
"module": "
|
4354
|
-
}
|
4355
|
-
},
|
4356
|
-
{
|
4357
|
-
"kind": "method",
|
4358
|
-
"name": "handleNavigation",
|
4359
|
-
"privacy": "private",
|
4360
|
-
"return": {
|
4361
|
-
"type": {
|
4362
|
-
"text": "void"
|
4363
|
-
}
|
4364
|
-
},
|
4365
|
-
"parameters": [
|
4366
|
-
{
|
4367
|
-
"name": "e",
|
4368
|
-
"type": {
|
4369
|
-
"text": "MouseEvent | KeyboardEvent"
|
4370
|
-
}
|
4371
|
-
}
|
4372
|
-
],
|
4373
|
-
"inheritedFrom": {
|
4374
|
-
"name": "Linksimple",
|
4375
|
-
"module": "components/linksimple/linksimple.component.js"
|
4376
|
-
}
|
4377
|
-
},
|
4378
|
-
{
|
4379
|
-
"kind": "method",
|
4380
|
-
"name": "setDisabled",
|
4381
|
-
"privacy": "private",
|
4382
|
-
"parameters": [
|
4383
|
-
{
|
4384
|
-
"name": "disabled",
|
4385
|
-
"type": {
|
4386
|
-
"text": "boolean"
|
4387
|
-
},
|
4388
|
-
"description": "Whether the element should be disabled"
|
4389
|
-
}
|
4390
|
-
],
|
4391
|
-
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored.",
|
4392
|
-
"inheritedFrom": {
|
4393
|
-
"name": "Linksimple",
|
4394
|
-
"module": "components/linksimple/linksimple.component.js"
|
4299
|
+
"name": "DisabledMixin",
|
4300
|
+
"module": "utils/mixins/DisabledMixin.js"
|
4395
4301
|
}
|
4396
4302
|
}
|
4397
4303
|
],
|
4398
4304
|
"events": [
|
4399
4305
|
{
|
4400
|
-
"description": "(React: onClick)
|
4306
|
+
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
4401
4307
|
"name": "click",
|
4402
|
-
"reactName": "onClick"
|
4403
|
-
"inheritedFrom": {
|
4404
|
-
"name": "Linksimple",
|
4405
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4406
|
-
}
|
4308
|
+
"reactName": "onClick"
|
4407
4309
|
},
|
4408
4310
|
{
|
4409
|
-
"description": "(React: onKeyDown)
|
4311
|
+
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
4410
4312
|
"name": "keydown",
|
4411
|
-
"reactName": "onKeyDown"
|
4412
|
-
"inheritedFrom": {
|
4413
|
-
"name": "Linksimple",
|
4414
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4415
|
-
}
|
4313
|
+
"reactName": "onKeyDown"
|
4416
4314
|
},
|
4417
4315
|
{
|
4418
|
-
"description": "(React:
|
4419
|
-
"name": "
|
4420
|
-
"reactName": "
|
4421
|
-
"inheritedFrom": {
|
4422
|
-
"name": "Linksimple",
|
4423
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4424
|
-
}
|
4316
|
+
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
4317
|
+
"name": "keyup",
|
4318
|
+
"reactName": "onKeyUp"
|
4425
4319
|
},
|
4426
4320
|
{
|
4427
|
-
"description": "(React:
|
4428
|
-
"name": "
|
4429
|
-
"reactName": "
|
4430
|
-
"inheritedFrom": {
|
4431
|
-
"name": "Linksimple",
|
4432
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4433
|
-
}
|
4321
|
+
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
4322
|
+
"name": "focus",
|
4323
|
+
"reactName": "onFocus"
|
4434
4324
|
}
|
4435
4325
|
],
|
4436
4326
|
"attributes": [
|
4437
4327
|
{
|
4438
|
-
"name": "
|
4328
|
+
"name": "active",
|
4439
4329
|
"type": {
|
4440
|
-
"text": "
|
4330
|
+
"text": "boolean | undefined"
|
4441
4331
|
},
|
4442
|
-
"description": "
|
4443
|
-
"default": "
|
4444
|
-
"fieldName": "
|
4332
|
+
"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.",
|
4333
|
+
"default": "undefined",
|
4334
|
+
"fieldName": "active"
|
4445
4335
|
},
|
4446
4336
|
{
|
4447
4337
|
"name": "soft-disabled",
|
4448
4338
|
"type": {
|
4449
4339
|
"text": "boolean | undefined"
|
4450
4340
|
},
|
4451
|
-
"description": "Indicates whether the
|
4341
|
+
"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.",
|
4452
4342
|
"default": "undefined",
|
4453
4343
|
"fieldName": "softDisabled"
|
4454
4344
|
},
|
4455
4345
|
{
|
4456
|
-
"name": "
|
4346
|
+
"name": "size",
|
4457
4347
|
"type": {
|
4458
|
-
"text": "
|
4348
|
+
"text": "ButtonSize"
|
4459
4349
|
},
|
4460
|
-
"description": "
|
4461
|
-
"
|
4462
|
-
"
|
4463
|
-
"name": "ButtonComponentMixin",
|
4464
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
4465
|
-
}
|
4350
|
+
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
4351
|
+
"default": "32",
|
4352
|
+
"fieldName": "size"
|
4466
4353
|
},
|
4467
4354
|
{
|
4468
|
-
"name": "
|
4355
|
+
"name": "role",
|
4469
4356
|
"type": {
|
4470
|
-
"text": "
|
4357
|
+
"text": "RoleType"
|
4471
4358
|
},
|
4472
|
-
"description": "
|
4473
|
-
"
|
4474
|
-
"
|
4475
|
-
"name": "ButtonComponentMixin",
|
4476
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
4477
|
-
}
|
4359
|
+
"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.",
|
4360
|
+
"default": "button",
|
4361
|
+
"fieldName": "role"
|
4478
4362
|
},
|
4479
4363
|
{
|
4480
|
-
"name": "
|
4364
|
+
"name": "ariaStateKey",
|
4481
4365
|
"type": {
|
4482
|
-
"text": "
|
4366
|
+
"text": "string | undefined"
|
4483
4367
|
},
|
4484
|
-
"description": "
|
4485
|
-
"default": "
|
4486
|
-
"fieldName": "
|
4487
|
-
"inheritedFrom": {
|
4488
|
-
"name": "ButtonComponentMixin",
|
4489
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
4490
|
-
}
|
4368
|
+
"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`",
|
4369
|
+
"default": "'aria-pressed' (when)",
|
4370
|
+
"fieldName": "ariaStateKey"
|
4491
4371
|
},
|
4492
4372
|
{
|
4493
|
-
"name": "
|
4373
|
+
"name": "type",
|
4494
4374
|
"type": {
|
4495
|
-
"text": "
|
4375
|
+
"text": "ButtonType"
|
4496
4376
|
},
|
4497
|
-
"description": "
|
4498
|
-
"default": "
|
4499
|
-
"fieldName": "
|
4500
|
-
"inheritedFrom": {
|
4501
|
-
"name": "ButtonComponentMixin",
|
4502
|
-
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
4503
|
-
}
|
4377
|
+
"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.",
|
4378
|
+
"default": "button",
|
4379
|
+
"fieldName": "type"
|
4504
4380
|
},
|
4505
4381
|
{
|
4506
|
-
"name": "
|
4382
|
+
"name": "autofocus",
|
4507
4383
|
"type": {
|
4508
|
-
"text": "boolean
|
4384
|
+
"text": "boolean"
|
4509
4385
|
},
|
4510
|
-
"
|
4511
|
-
"
|
4512
|
-
"fieldName": "
|
4386
|
+
"default": "false",
|
4387
|
+
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
4388
|
+
"fieldName": "autofocus",
|
4513
4389
|
"inheritedFrom": {
|
4514
|
-
"name": "
|
4515
|
-
"module": "src/utils/mixins/
|
4390
|
+
"name": "AutoFocusMixin",
|
4391
|
+
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
4516
4392
|
}
|
4517
4393
|
},
|
4518
4394
|
{
|
@@ -4529,530 +4405,27 @@
|
|
4529
4405
|
}
|
4530
4406
|
},
|
4531
4407
|
{
|
4532
|
-
"name": "
|
4408
|
+
"name": "disabled",
|
4533
4409
|
"type": {
|
4534
|
-
"text": "boolean"
|
4410
|
+
"text": "boolean | undefined"
|
4535
4411
|
},
|
4536
|
-
"description": "
|
4537
|
-
"default": "
|
4538
|
-
"fieldName": "
|
4412
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
4413
|
+
"default": "undefined",
|
4414
|
+
"fieldName": "disabled",
|
4539
4415
|
"inheritedFrom": {
|
4540
|
-
"name": "
|
4541
|
-
"module": "src/
|
4416
|
+
"name": "DisabledMixin",
|
4417
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
4542
4418
|
}
|
4543
|
-
}
|
4419
|
+
}
|
4420
|
+
],
|
4421
|
+
"mixins": [
|
4544
4422
|
{
|
4545
|
-
"name": "
|
4546
|
-
"
|
4547
|
-
"text": "boolean"
|
4548
|
-
},
|
4549
|
-
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
4550
|
-
"default": "false",
|
4551
|
-
"fieldName": "inverted",
|
4552
|
-
"inheritedFrom": {
|
4553
|
-
"name": "Linksimple",
|
4554
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4555
|
-
}
|
4423
|
+
"name": "AutoFocusMixin",
|
4424
|
+
"module": "/src/utils/mixins/AutoFocusMixin"
|
4556
4425
|
},
|
4557
4426
|
{
|
4558
|
-
"name": "
|
4559
|
-
"
|
4560
|
-
"text": "string"
|
4561
|
-
},
|
4562
|
-
"default": "'#'",
|
4563
|
-
"description": "Href for navigation. The URL that the hyperlink points to",
|
4564
|
-
"fieldName": "href",
|
4565
|
-
"inheritedFrom": {
|
4566
|
-
"name": "Linksimple",
|
4567
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4568
|
-
}
|
4569
|
-
},
|
4570
|
-
{
|
4571
|
-
"name": "target",
|
4572
|
-
"type": {
|
4573
|
-
"text": "string"
|
4574
|
-
},
|
4575
|
-
"default": "'_self'",
|
4576
|
-
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
4577
|
-
"fieldName": "target",
|
4578
|
-
"inheritedFrom": {
|
4579
|
-
"name": "Linksimple",
|
4580
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4581
|
-
}
|
4582
|
-
},
|
4583
|
-
{
|
4584
|
-
"name": "rel",
|
4585
|
-
"type": {
|
4586
|
-
"text": "string | undefined"
|
4587
|
-
},
|
4588
|
-
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
4589
|
-
"fieldName": "rel",
|
4590
|
-
"inheritedFrom": {
|
4591
|
-
"name": "Linksimple",
|
4592
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4593
|
-
}
|
4594
|
-
}
|
4595
|
-
],
|
4596
|
-
"mixins": [
|
4597
|
-
{
|
4598
|
-
"name": "ButtonComponentMixin",
|
4599
|
-
"module": "/src/utils/mixins/ButtonComponentMixin"
|
4600
|
-
}
|
4601
|
-
],
|
4602
|
-
"superclass": {
|
4603
|
-
"name": "Linksimple",
|
4604
|
-
"module": "/src/components/linksimple/linksimple.component"
|
4605
|
-
},
|
4606
|
-
"tagName": "mdc-buttonlink",
|
4607
|
-
"jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n */",
|
4608
|
-
"customElement": true,
|
4609
|
-
"cssProperties": [
|
4610
|
-
{
|
4611
|
-
"description": "Border radius of the link.",
|
4612
|
-
"name": "--mdc-link-border-radius",
|
4613
|
-
"inheritedFrom": {
|
4614
|
-
"name": "Linksimple",
|
4615
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4616
|
-
}
|
4617
|
-
},
|
4618
|
-
{
|
4619
|
-
"description": "Color of the link’s child content in the active state.",
|
4620
|
-
"name": "--mdc-link-color-active",
|
4621
|
-
"inheritedFrom": {
|
4622
|
-
"name": "Linksimple",
|
4623
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4624
|
-
}
|
4625
|
-
},
|
4626
|
-
{
|
4627
|
-
"description": "Color of the link’s child content in the disabled state.",
|
4628
|
-
"name": "--mdc-link-color-disabled",
|
4629
|
-
"inheritedFrom": {
|
4630
|
-
"name": "Linksimple",
|
4631
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4632
|
-
}
|
4633
|
-
},
|
4634
|
-
{
|
4635
|
-
"description": "Color of the link’s child content in the hover state.",
|
4636
|
-
"name": "--mdc-link-color-hover",
|
4637
|
-
"inheritedFrom": {
|
4638
|
-
"name": "Linksimple",
|
4639
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4640
|
-
}
|
4641
|
-
},
|
4642
|
-
{
|
4643
|
-
"description": "Color of the link’s child content in the normal state.",
|
4644
|
-
"name": "--mdc-link-color-normal",
|
4645
|
-
"inheritedFrom": {
|
4646
|
-
"name": "Linksimple",
|
4647
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4648
|
-
}
|
4649
|
-
},
|
4650
|
-
{
|
4651
|
-
"description": "Color of the inverted link’s child content in the active state.",
|
4652
|
-
"name": "--mdc-link-inverted-color-active",
|
4653
|
-
"inheritedFrom": {
|
4654
|
-
"name": "Linksimple",
|
4655
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4656
|
-
}
|
4657
|
-
},
|
4658
|
-
{
|
4659
|
-
"description": "Color of the inverted link’s child content in the disabled state.",
|
4660
|
-
"name": "--mdc-link-inverted-color-disabled",
|
4661
|
-
"inheritedFrom": {
|
4662
|
-
"name": "Linksimple",
|
4663
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4664
|
-
}
|
4665
|
-
},
|
4666
|
-
{
|
4667
|
-
"description": "Color of the inverted link’s child content in the hover state.",
|
4668
|
-
"name": "--mdc-link-inverted-color-hover",
|
4669
|
-
"inheritedFrom": {
|
4670
|
-
"name": "Linksimple",
|
4671
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4672
|
-
}
|
4673
|
-
},
|
4674
|
-
{
|
4675
|
-
"description": "Color of the inverted link’s child content in the normal state.",
|
4676
|
-
"name": "--mdc-link-inverted-color-normal",
|
4677
|
-
"inheritedFrom": {
|
4678
|
-
"name": "Linksimple",
|
4679
|
-
"module": "src/components/linksimple/linksimple.component.ts"
|
4680
|
-
}
|
4681
|
-
}
|
4682
|
-
]
|
4683
|
-
}
|
4684
|
-
],
|
4685
|
-
"exports": [
|
4686
|
-
{
|
4687
|
-
"kind": "js",
|
4688
|
-
"name": "default",
|
4689
|
-
"declaration": {
|
4690
|
-
"name": "ButtonLink",
|
4691
|
-
"module": "components/buttonlink/buttonlink.component.js"
|
4692
|
-
}
|
4693
|
-
}
|
4694
|
-
]
|
4695
|
-
},
|
4696
|
-
{
|
4697
|
-
"kind": "javascript-module",
|
4698
|
-
"path": "components/buttonsimple/buttonsimple.component.js",
|
4699
|
-
"declarations": [
|
4700
|
-
{
|
4701
|
-
"kind": "class",
|
4702
|
-
"description": "`mdc-buttonsimple` is a component that can be configured in various ways to suit different use cases.\nIt is used as an internal component and is not intended to be used directly by consumers.\nConsumers should use the `mdc-button` component instead.",
|
4703
|
-
"name": "Buttonsimple",
|
4704
|
-
"members": [
|
4705
|
-
{
|
4706
|
-
"kind": "field",
|
4707
|
-
"name": "active",
|
4708
|
-
"type": {
|
4709
|
-
"text": "boolean | undefined"
|
4710
|
-
},
|
4711
|
-
"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.",
|
4712
|
-
"default": "undefined",
|
4713
|
-
"attribute": "active",
|
4714
|
-
"reflects": true
|
4715
|
-
},
|
4716
|
-
{
|
4717
|
-
"kind": "field",
|
4718
|
-
"name": "softDisabled",
|
4719
|
-
"type": {
|
4720
|
-
"text": "boolean | undefined"
|
4721
|
-
},
|
4722
|
-
"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.",
|
4723
|
-
"default": "undefined",
|
4724
|
-
"attribute": "soft-disabled",
|
4725
|
-
"reflects": true
|
4726
|
-
},
|
4727
|
-
{
|
4728
|
-
"kind": "field",
|
4729
|
-
"name": "size",
|
4730
|
-
"type": {
|
4731
|
-
"text": "ButtonSize"
|
4732
|
-
},
|
4733
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
4734
|
-
"default": "32",
|
4735
|
-
"attribute": "size",
|
4736
|
-
"reflects": true
|
4737
|
-
},
|
4738
|
-
{
|
4739
|
-
"kind": "field",
|
4740
|
-
"name": "role",
|
4741
|
-
"type": {
|
4742
|
-
"text": "RoleType"
|
4743
|
-
},
|
4744
|
-
"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.",
|
4745
|
-
"default": "button",
|
4746
|
-
"attribute": "role",
|
4747
|
-
"reflects": true
|
4748
|
-
},
|
4749
|
-
{
|
4750
|
-
"kind": "field",
|
4751
|
-
"name": "ariaStateKey",
|
4752
|
-
"type": {
|
4753
|
-
"text": "string | undefined"
|
4754
|
-
},
|
4755
|
-
"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`",
|
4756
|
-
"default": "'aria-pressed' (when)",
|
4757
|
-
"attribute": "ariaStateKey",
|
4758
|
-
"reflects": true
|
4759
|
-
},
|
4760
|
-
{
|
4761
|
-
"kind": "field",
|
4762
|
-
"name": "type",
|
4763
|
-
"type": {
|
4764
|
-
"text": "ButtonType"
|
4765
|
-
},
|
4766
|
-
"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.",
|
4767
|
-
"default": "button",
|
4768
|
-
"attribute": "type",
|
4769
|
-
"reflects": true
|
4770
|
-
},
|
4771
|
-
{
|
4772
|
-
"kind": "method",
|
4773
|
-
"name": "executeAction",
|
4774
|
-
"privacy": "protected"
|
4775
|
-
},
|
4776
|
-
{
|
4777
|
-
"kind": "method",
|
4778
|
-
"name": "setActive",
|
4779
|
-
"privacy": "protected",
|
4780
|
-
"parameters": [
|
4781
|
-
{
|
4782
|
-
"name": "element",
|
4783
|
-
"type": {
|
4784
|
-
"text": "HTMLElement"
|
4785
|
-
},
|
4786
|
-
"description": "The button element"
|
4787
|
-
},
|
4788
|
-
{
|
4789
|
-
"name": "active",
|
4790
|
-
"optional": true,
|
4791
|
-
"type": {
|
4792
|
-
"text": "boolean"
|
4793
|
-
},
|
4794
|
-
"description": "The active state of the element"
|
4795
|
-
}
|
4796
|
-
],
|
4797
|
-
"description": "Sets the ariaStateKey attributes based on the active state of the button."
|
4798
|
-
},
|
4799
|
-
{
|
4800
|
-
"kind": "method",
|
4801
|
-
"name": "setSoftDisabled",
|
4802
|
-
"privacy": "private",
|
4803
|
-
"parameters": [
|
4804
|
-
{
|
4805
|
-
"name": "element",
|
4806
|
-
"type": {
|
4807
|
-
"text": "HTMLElement"
|
4808
|
-
},
|
4809
|
-
"description": "The button element."
|
4810
|
-
},
|
4811
|
-
{
|
4812
|
-
"name": "softDisabled",
|
4813
|
-
"optional": true,
|
4814
|
-
"type": {
|
4815
|
-
"text": "boolean"
|
4816
|
-
},
|
4817
|
-
"description": "The soft-disabled state."
|
4818
|
-
}
|
4819
|
-
],
|
4820
|
-
"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."
|
4821
|
-
},
|
4822
|
-
{
|
4823
|
-
"kind": "method",
|
4824
|
-
"name": "setDisabled",
|
4825
|
-
"privacy": "private",
|
4826
|
-
"parameters": [
|
4827
|
-
{
|
4828
|
-
"name": "element",
|
4829
|
-
"type": {
|
4830
|
-
"text": "HTMLElement"
|
4831
|
-
},
|
4832
|
-
"description": "The button element."
|
4833
|
-
},
|
4834
|
-
{
|
4835
|
-
"name": "disabled",
|
4836
|
-
"type": {
|
4837
|
-
"text": "boolean"
|
4838
|
-
},
|
4839
|
-
"description": "The disabled state."
|
4840
|
-
}
|
4841
|
-
],
|
4842
|
-
"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."
|
4843
|
-
},
|
4844
|
-
{
|
4845
|
-
"kind": "method",
|
4846
|
-
"name": "triggerClickEvent",
|
4847
|
-
"privacy": "private"
|
4848
|
-
},
|
4849
|
-
{
|
4850
|
-
"kind": "method",
|
4851
|
-
"name": "handleBlur",
|
4852
|
-
"privacy": "private",
|
4853
|
-
"description": "In case the button is pressed and the focus is lost while pressing,\nthe pressed class is removed."
|
4854
|
-
},
|
4855
|
-
{
|
4856
|
-
"kind": "method",
|
4857
|
-
"name": "handleKeyDown",
|
4858
|
-
"privacy": "private",
|
4859
|
-
"parameters": [
|
4860
|
-
{
|
4861
|
-
"name": "event",
|
4862
|
-
"type": {
|
4863
|
-
"text": "KeyboardEvent"
|
4864
|
-
},
|
4865
|
-
"description": "The keyboard event."
|
4866
|
-
}
|
4867
|
-
],
|
4868
|
-
"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."
|
4869
|
-
},
|
4870
|
-
{
|
4871
|
-
"kind": "method",
|
4872
|
-
"name": "handleKeyUp",
|
4873
|
-
"privacy": "private",
|
4874
|
-
"parameters": [
|
4875
|
-
{
|
4876
|
-
"name": "event",
|
4877
|
-
"type": {
|
4878
|
-
"text": "KeyboardEvent"
|
4879
|
-
},
|
4880
|
-
"description": "The keyboard event."
|
4881
|
-
}
|
4882
|
-
],
|
4883
|
-
"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."
|
4884
|
-
},
|
4885
|
-
{
|
4886
|
-
"kind": "field",
|
4887
|
-
"name": "autofocus",
|
4888
|
-
"type": {
|
4889
|
-
"text": "boolean"
|
4890
|
-
},
|
4891
|
-
"default": "false",
|
4892
|
-
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
4893
|
-
"attribute": "autofocus",
|
4894
|
-
"reflects": true,
|
4895
|
-
"inheritedFrom": {
|
4896
|
-
"name": "AutoFocusMixin",
|
4897
|
-
"module": "utils/mixins/AutoFocusMixin.js"
|
4898
|
-
}
|
4899
|
-
},
|
4900
|
-
{
|
4901
|
-
"kind": "field",
|
4902
|
-
"name": "tabIndex",
|
4903
|
-
"type": {
|
4904
|
-
"text": "number"
|
4905
|
-
},
|
4906
|
-
"default": "0",
|
4907
|
-
"description": "This property specifies the tab order of the element.",
|
4908
|
-
"attribute": "tabIndex",
|
4909
|
-
"reflects": true,
|
4910
|
-
"inheritedFrom": {
|
4911
|
-
"name": "TabIndexMixin",
|
4912
|
-
"module": "utils/mixins/TabIndexMixin.js"
|
4913
|
-
}
|
4914
|
-
},
|
4915
|
-
{
|
4916
|
-
"kind": "field",
|
4917
|
-
"name": "disabled",
|
4918
|
-
"type": {
|
4919
|
-
"text": "boolean | undefined"
|
4920
|
-
},
|
4921
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
4922
|
-
"default": "undefined",
|
4923
|
-
"attribute": "disabled",
|
4924
|
-
"reflects": true,
|
4925
|
-
"inheritedFrom": {
|
4926
|
-
"name": "DisabledMixin",
|
4927
|
-
"module": "utils/mixins/DisabledMixin.js"
|
4928
|
-
}
|
4929
|
-
}
|
4930
|
-
],
|
4931
|
-
"events": [
|
4932
|
-
{
|
4933
|
-
"description": "(React: onClick) This event is dispatched when the button is clicked.",
|
4934
|
-
"name": "click",
|
4935
|
-
"reactName": "onClick"
|
4936
|
-
},
|
4937
|
-
{
|
4938
|
-
"description": "(React: onKeyDown) This event is dispatched when a key is pressed down on the button.",
|
4939
|
-
"name": "keydown",
|
4940
|
-
"reactName": "onKeyDown"
|
4941
|
-
},
|
4942
|
-
{
|
4943
|
-
"description": "(React: onKeyUp) This event is dispatched when a key is released on the button.",
|
4944
|
-
"name": "keyup",
|
4945
|
-
"reactName": "onKeyUp"
|
4946
|
-
},
|
4947
|
-
{
|
4948
|
-
"description": "(React: onFocus) This event is dispatched when the button receives focus.",
|
4949
|
-
"name": "focus",
|
4950
|
-
"reactName": "onFocus"
|
4951
|
-
}
|
4952
|
-
],
|
4953
|
-
"attributes": [
|
4954
|
-
{
|
4955
|
-
"name": "active",
|
4956
|
-
"type": {
|
4957
|
-
"text": "boolean | undefined"
|
4958
|
-
},
|
4959
|
-
"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.",
|
4960
|
-
"default": "undefined",
|
4961
|
-
"fieldName": "active"
|
4962
|
-
},
|
4963
|
-
{
|
4964
|
-
"name": "soft-disabled",
|
4965
|
-
"type": {
|
4966
|
-
"text": "boolean | undefined"
|
4967
|
-
},
|
4968
|
-
"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.",
|
4969
|
-
"default": "undefined",
|
4970
|
-
"fieldName": "softDisabled"
|
4971
|
-
},
|
4972
|
-
{
|
4973
|
-
"name": "size",
|
4974
|
-
"type": {
|
4975
|
-
"text": "ButtonSize"
|
4976
|
-
},
|
4977
|
-
"description": "Simplebutton size is a super set of all the sizes supported by children components.",
|
4978
|
-
"default": "32",
|
4979
|
-
"fieldName": "size"
|
4980
|
-
},
|
4981
|
-
{
|
4982
|
-
"name": "role",
|
4983
|
-
"type": {
|
4984
|
-
"text": "RoleType"
|
4985
|
-
},
|
4986
|
-
"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.",
|
4987
|
-
"default": "button",
|
4988
|
-
"fieldName": "role"
|
4989
|
-
},
|
4990
|
-
{
|
4991
|
-
"name": "ariaStateKey",
|
4992
|
-
"type": {
|
4993
|
-
"text": "string | undefined"
|
4994
|
-
},
|
4995
|
-
"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`",
|
4996
|
-
"default": "'aria-pressed' (when)",
|
4997
|
-
"fieldName": "ariaStateKey"
|
4998
|
-
},
|
4999
|
-
{
|
5000
|
-
"name": "type",
|
5001
|
-
"type": {
|
5002
|
-
"text": "ButtonType"
|
5003
|
-
},
|
5004
|
-
"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.",
|
5005
|
-
"default": "button",
|
5006
|
-
"fieldName": "type"
|
5007
|
-
},
|
5008
|
-
{
|
5009
|
-
"name": "autofocus",
|
5010
|
-
"type": {
|
5011
|
-
"text": "boolean"
|
5012
|
-
},
|
5013
|
-
"default": "false",
|
5014
|
-
"description": "This property indicates whether the element should receive focus automatically when it is rendered.",
|
5015
|
-
"fieldName": "autofocus",
|
5016
|
-
"inheritedFrom": {
|
5017
|
-
"name": "AutoFocusMixin",
|
5018
|
-
"module": "src/utils/mixins/AutoFocusMixin.ts"
|
5019
|
-
}
|
5020
|
-
},
|
5021
|
-
{
|
5022
|
-
"name": "tabIndex",
|
5023
|
-
"type": {
|
5024
|
-
"text": "number"
|
5025
|
-
},
|
5026
|
-
"default": "0",
|
5027
|
-
"description": "This property specifies the tab order of the element.",
|
5028
|
-
"fieldName": "tabIndex",
|
5029
|
-
"inheritedFrom": {
|
5030
|
-
"name": "TabIndexMixin",
|
5031
|
-
"module": "src/utils/mixins/TabIndexMixin.ts"
|
5032
|
-
}
|
5033
|
-
},
|
5034
|
-
{
|
5035
|
-
"name": "disabled",
|
5036
|
-
"type": {
|
5037
|
-
"text": "boolean | undefined"
|
5038
|
-
},
|
5039
|
-
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
5040
|
-
"default": "undefined",
|
5041
|
-
"fieldName": "disabled",
|
5042
|
-
"inheritedFrom": {
|
5043
|
-
"name": "DisabledMixin",
|
5044
|
-
"module": "src/utils/mixins/DisabledMixin.ts"
|
5045
|
-
}
|
5046
|
-
}
|
5047
|
-
],
|
5048
|
-
"mixins": [
|
5049
|
-
{
|
5050
|
-
"name": "AutoFocusMixin",
|
5051
|
-
"module": "/src/utils/mixins/AutoFocusMixin"
|
5052
|
-
},
|
5053
|
-
{
|
5054
|
-
"name": "TabIndexMixin",
|
5055
|
-
"module": "/src/utils/mixins/TabIndexMixin"
|
4427
|
+
"name": "TabIndexMixin",
|
4428
|
+
"module": "/src/utils/mixins/TabIndexMixin"
|
5056
4429
|
},
|
5057
4430
|
{
|
5058
4431
|
"name": "DisabledMixin",
|
@@ -6370,6 +5743,633 @@
|
|
6370
5743
|
}
|
6371
5744
|
]
|
6372
5745
|
},
|
5746
|
+
{
|
5747
|
+
"kind": "javascript-module",
|
5748
|
+
"path": "components/buttonlink/buttonlink.component.js",
|
5749
|
+
"declarations": [
|
5750
|
+
{
|
5751
|
+
"kind": "class",
|
5752
|
+
"description": "`mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\nfeatures of `mdc-button`. This includes support for variants, sizing, and optional\nprefix and postfix icons via slots.\n\n### Features:\n- Behaves like an link while visually resembling a button.\n- Supports slots for `prefix-icon` and `postfix-icon`.\n- Customizable size, color, and variant through attributes.\n- Inherits accessibility and keyboard interaction support from `mdc-linksimple`.",
|
5753
|
+
"name": "ButtonLink",
|
5754
|
+
"members": [
|
5755
|
+
{
|
5756
|
+
"kind": "field",
|
5757
|
+
"name": "size",
|
5758
|
+
"type": {
|
5759
|
+
"text": "PillButtonSize | IconButtonSize"
|
5760
|
+
},
|
5761
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n- **Pill buttonlink**: 40, 32, 28, 24.\n- **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon buttonlink can also be 20.",
|
5762
|
+
"default": "32",
|
5763
|
+
"attribute": "size",
|
5764
|
+
"reflects": true
|
5765
|
+
},
|
5766
|
+
{
|
5767
|
+
"kind": "field",
|
5768
|
+
"name": "softDisabled",
|
5769
|
+
"type": {
|
5770
|
+
"text": "boolean | undefined"
|
5771
|
+
},
|
5772
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink 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 buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
5773
|
+
"default": "undefined",
|
5774
|
+
"attribute": "soft-disabled",
|
5775
|
+
"reflects": true
|
5776
|
+
},
|
5777
|
+
{
|
5778
|
+
"kind": "method",
|
5779
|
+
"name": "setSoftDisabled",
|
5780
|
+
"privacy": "private",
|
5781
|
+
"parameters": [
|
5782
|
+
{
|
5783
|
+
"name": "element",
|
5784
|
+
"type": {
|
5785
|
+
"text": "HTMLElement"
|
5786
|
+
},
|
5787
|
+
"description": "The buttonlink element."
|
5788
|
+
},
|
5789
|
+
{
|
5790
|
+
"name": "softDisabled",
|
5791
|
+
"optional": true,
|
5792
|
+
"type": {
|
5793
|
+
"text": "boolean"
|
5794
|
+
},
|
5795
|
+
"description": "The soft-disabled state."
|
5796
|
+
}
|
5797
|
+
],
|
5798
|
+
"description": "Sets the soft-disabled attribute for the buttonlink.\nWhen soft-disabled, the buttonlink looks to be disabled but remains focusable and clickable.\nAlso sets/removes aria-disabled attribute."
|
5799
|
+
},
|
5800
|
+
{
|
5801
|
+
"kind": "field",
|
5802
|
+
"name": "prefixIcon",
|
5803
|
+
"type": {
|
5804
|
+
"text": "IconNames | undefined"
|
5805
|
+
},
|
5806
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
5807
|
+
"attribute": "prefix-icon",
|
5808
|
+
"reflects": true,
|
5809
|
+
"inheritedFrom": {
|
5810
|
+
"name": "ButtonComponentMixin",
|
5811
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5812
|
+
}
|
5813
|
+
},
|
5814
|
+
{
|
5815
|
+
"kind": "field",
|
5816
|
+
"name": "postfixIcon",
|
5817
|
+
"type": {
|
5818
|
+
"text": "IconNames | undefined"
|
5819
|
+
},
|
5820
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
5821
|
+
"attribute": "postfix-icon",
|
5822
|
+
"reflects": true,
|
5823
|
+
"inheritedFrom": {
|
5824
|
+
"name": "ButtonComponentMixin",
|
5825
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5826
|
+
}
|
5827
|
+
},
|
5828
|
+
{
|
5829
|
+
"kind": "field",
|
5830
|
+
"name": "variant",
|
5831
|
+
"type": {
|
5832
|
+
"text": "ButtonVariant"
|
5833
|
+
},
|
5834
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
5835
|
+
"default": "primary",
|
5836
|
+
"attribute": "variant",
|
5837
|
+
"inheritedFrom": {
|
5838
|
+
"name": "ButtonComponentMixin",
|
5839
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5840
|
+
}
|
5841
|
+
},
|
5842
|
+
{
|
5843
|
+
"kind": "field",
|
5844
|
+
"name": "color",
|
5845
|
+
"type": {
|
5846
|
+
"text": "ButtonColor"
|
5847
|
+
},
|
5848
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
5849
|
+
"default": "default",
|
5850
|
+
"attribute": "color",
|
5851
|
+
"inheritedFrom": {
|
5852
|
+
"name": "ButtonComponentMixin",
|
5853
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5854
|
+
}
|
5855
|
+
},
|
5856
|
+
{
|
5857
|
+
"kind": "method",
|
5858
|
+
"name": "setVariant",
|
5859
|
+
"privacy": "protected",
|
5860
|
+
"parameters": [
|
5861
|
+
{
|
5862
|
+
"name": "variant",
|
5863
|
+
"type": {
|
5864
|
+
"text": "ButtonVariant"
|
5865
|
+
},
|
5866
|
+
"description": "The variant to set."
|
5867
|
+
}
|
5868
|
+
],
|
5869
|
+
"description": "Sets the variant attribute for the button component.\nIf the provided variant is not included in the BUTTON_VARIANTS,\nit defaults to the value specified in DEFAULTS.VARIANT.",
|
5870
|
+
"inheritedFrom": {
|
5871
|
+
"name": "ButtonComponentMixin",
|
5872
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5873
|
+
}
|
5874
|
+
},
|
5875
|
+
{
|
5876
|
+
"kind": "method",
|
5877
|
+
"name": "setColor",
|
5878
|
+
"privacy": "protected",
|
5879
|
+
"parameters": [
|
5880
|
+
{
|
5881
|
+
"name": "color",
|
5882
|
+
"type": {
|
5883
|
+
"text": "ButtonColor"
|
5884
|
+
},
|
5885
|
+
"description": "The color to set."
|
5886
|
+
}
|
5887
|
+
],
|
5888
|
+
"description": "Sets the color attribute for the button.\nDefaults to DEFAULTS.COLOR if invalid or for tertiary button.",
|
5889
|
+
"inheritedFrom": {
|
5890
|
+
"name": "ButtonComponentMixin",
|
5891
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5892
|
+
}
|
5893
|
+
},
|
5894
|
+
{
|
5895
|
+
"kind": "method",
|
5896
|
+
"name": "setSize",
|
5897
|
+
"privacy": "protected",
|
5898
|
+
"parameters": [
|
5899
|
+
{
|
5900
|
+
"name": "size",
|
5901
|
+
"type": {
|
5902
|
+
"text": "PillButtonSize | IconButtonSize"
|
5903
|
+
},
|
5904
|
+
"description": "The size to set."
|
5905
|
+
}
|
5906
|
+
],
|
5907
|
+
"description": "Sets the size attribute for the button component.\nValidates the size based on the button type (icon, pill, or tertiary).\nDefaults to DEFAULTS.SIZE if invalid.",
|
5908
|
+
"inheritedFrom": {
|
5909
|
+
"name": "ButtonComponentMixin",
|
5910
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5911
|
+
}
|
5912
|
+
},
|
5913
|
+
{
|
5914
|
+
"kind": "method",
|
5915
|
+
"name": "inferButtonType",
|
5916
|
+
"privacy": "protected",
|
5917
|
+
"description": "Infers the type of button based on the presence of slot and/or prefix and postfix icons.",
|
5918
|
+
"parameters": [
|
5919
|
+
{
|
5920
|
+
"description": "default slot of button",
|
5921
|
+
"name": "slot"
|
5922
|
+
}
|
5923
|
+
],
|
5924
|
+
"inheritedFrom": {
|
5925
|
+
"name": "ButtonComponentMixin",
|
5926
|
+
"module": "utils/mixins/ButtonComponentMixin.js"
|
5927
|
+
}
|
5928
|
+
},
|
5929
|
+
{
|
5930
|
+
"kind": "field",
|
5931
|
+
"name": "disabled",
|
5932
|
+
"type": {
|
5933
|
+
"text": "boolean | undefined"
|
5934
|
+
},
|
5935
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
5936
|
+
"default": "undefined",
|
5937
|
+
"attribute": "disabled",
|
5938
|
+
"reflects": true,
|
5939
|
+
"inheritedFrom": {
|
5940
|
+
"name": "DisabledMixin",
|
5941
|
+
"module": "utils/mixins/DisabledMixin.js"
|
5942
|
+
}
|
5943
|
+
},
|
5944
|
+
{
|
5945
|
+
"kind": "field",
|
5946
|
+
"name": "tabIndex",
|
5947
|
+
"type": {
|
5948
|
+
"text": "number"
|
5949
|
+
},
|
5950
|
+
"default": "0",
|
5951
|
+
"description": "This property specifies the tab order of the element.",
|
5952
|
+
"attribute": "tabIndex",
|
5953
|
+
"reflects": true,
|
5954
|
+
"inheritedFrom": {
|
5955
|
+
"name": "TabIndexMixin",
|
5956
|
+
"module": "utils/mixins/TabIndexMixin.js"
|
5957
|
+
}
|
5958
|
+
},
|
5959
|
+
{
|
5960
|
+
"kind": "field",
|
5961
|
+
"name": "inline",
|
5962
|
+
"type": {
|
5963
|
+
"text": "boolean"
|
5964
|
+
},
|
5965
|
+
"description": "The link can be inline or standalone.",
|
5966
|
+
"default": "false",
|
5967
|
+
"attribute": "inline",
|
5968
|
+
"reflects": true,
|
5969
|
+
"inheritedFrom": {
|
5970
|
+
"name": "Linksimple",
|
5971
|
+
"module": "components/linksimple/linksimple.component.js"
|
5972
|
+
}
|
5973
|
+
},
|
5974
|
+
{
|
5975
|
+
"kind": "field",
|
5976
|
+
"name": "inverted",
|
5977
|
+
"type": {
|
5978
|
+
"text": "boolean"
|
5979
|
+
},
|
5980
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
5981
|
+
"default": "false",
|
5982
|
+
"attribute": "inverted",
|
5983
|
+
"reflects": true,
|
5984
|
+
"inheritedFrom": {
|
5985
|
+
"name": "Linksimple",
|
5986
|
+
"module": "components/linksimple/linksimple.component.js"
|
5987
|
+
}
|
5988
|
+
},
|
5989
|
+
{
|
5990
|
+
"kind": "field",
|
5991
|
+
"name": "href",
|
5992
|
+
"type": {
|
5993
|
+
"text": "string"
|
5994
|
+
},
|
5995
|
+
"default": "'#'",
|
5996
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
5997
|
+
"attribute": "href",
|
5998
|
+
"reflects": true,
|
5999
|
+
"inheritedFrom": {
|
6000
|
+
"name": "Linksimple",
|
6001
|
+
"module": "components/linksimple/linksimple.component.js"
|
6002
|
+
}
|
6003
|
+
},
|
6004
|
+
{
|
6005
|
+
"kind": "field",
|
6006
|
+
"name": "target",
|
6007
|
+
"type": {
|
6008
|
+
"text": "string"
|
6009
|
+
},
|
6010
|
+
"default": "'_self'",
|
6011
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
6012
|
+
"attribute": "target",
|
6013
|
+
"reflects": true,
|
6014
|
+
"inheritedFrom": {
|
6015
|
+
"name": "Linksimple",
|
6016
|
+
"module": "components/linksimple/linksimple.component.js"
|
6017
|
+
}
|
6018
|
+
},
|
6019
|
+
{
|
6020
|
+
"kind": "field",
|
6021
|
+
"name": "rel",
|
6022
|
+
"type": {
|
6023
|
+
"text": "string | undefined"
|
6024
|
+
},
|
6025
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
6026
|
+
"attribute": "rel",
|
6027
|
+
"reflects": true,
|
6028
|
+
"inheritedFrom": {
|
6029
|
+
"name": "Linksimple",
|
6030
|
+
"module": "components/linksimple/linksimple.component.js"
|
6031
|
+
}
|
6032
|
+
},
|
6033
|
+
{
|
6034
|
+
"kind": "method",
|
6035
|
+
"name": "handleNavigation",
|
6036
|
+
"privacy": "private",
|
6037
|
+
"return": {
|
6038
|
+
"type": {
|
6039
|
+
"text": "void"
|
6040
|
+
}
|
6041
|
+
},
|
6042
|
+
"parameters": [
|
6043
|
+
{
|
6044
|
+
"name": "e",
|
6045
|
+
"type": {
|
6046
|
+
"text": "MouseEvent | KeyboardEvent"
|
6047
|
+
}
|
6048
|
+
}
|
6049
|
+
],
|
6050
|
+
"inheritedFrom": {
|
6051
|
+
"name": "Linksimple",
|
6052
|
+
"module": "components/linksimple/linksimple.component.js"
|
6053
|
+
}
|
6054
|
+
},
|
6055
|
+
{
|
6056
|
+
"kind": "method",
|
6057
|
+
"name": "setDisabled",
|
6058
|
+
"privacy": "private",
|
6059
|
+
"parameters": [
|
6060
|
+
{
|
6061
|
+
"name": "disabled",
|
6062
|
+
"type": {
|
6063
|
+
"text": "boolean"
|
6064
|
+
},
|
6065
|
+
"description": "Whether the element should be disabled"
|
6066
|
+
}
|
6067
|
+
],
|
6068
|
+
"description": "Sets or removes `aria-disabled` and updates `tabIndex` to reflect\nthe disabled state. When disabled, the element becomes unfocusable;\nwhen enabled, the previous `tabIndex` is restored.",
|
6069
|
+
"inheritedFrom": {
|
6070
|
+
"name": "Linksimple",
|
6071
|
+
"module": "components/linksimple/linksimple.component.js"
|
6072
|
+
}
|
6073
|
+
}
|
6074
|
+
],
|
6075
|
+
"events": [
|
6076
|
+
{
|
6077
|
+
"description": "(React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.",
|
6078
|
+
"name": "click",
|
6079
|
+
"reactName": "onClick",
|
6080
|
+
"inheritedFrom": {
|
6081
|
+
"name": "Linksimple",
|
6082
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6083
|
+
}
|
6084
|
+
},
|
6085
|
+
{
|
6086
|
+
"description": "(React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.",
|
6087
|
+
"name": "keydown",
|
6088
|
+
"reactName": "onKeyDown",
|
6089
|
+
"inheritedFrom": {
|
6090
|
+
"name": "Linksimple",
|
6091
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6092
|
+
}
|
6093
|
+
},
|
6094
|
+
{
|
6095
|
+
"description": "(React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.",
|
6096
|
+
"name": "focus",
|
6097
|
+
"reactName": "onFocus",
|
6098
|
+
"inheritedFrom": {
|
6099
|
+
"name": "Linksimple",
|
6100
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6101
|
+
}
|
6102
|
+
},
|
6103
|
+
{
|
6104
|
+
"description": "(React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.",
|
6105
|
+
"name": "blur",
|
6106
|
+
"reactName": "onBlur",
|
6107
|
+
"inheritedFrom": {
|
6108
|
+
"name": "Linksimple",
|
6109
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6110
|
+
}
|
6111
|
+
}
|
6112
|
+
],
|
6113
|
+
"attributes": [
|
6114
|
+
{
|
6115
|
+
"name": "size",
|
6116
|
+
"type": {
|
6117
|
+
"text": "PillButtonSize | IconButtonSize"
|
6118
|
+
},
|
6119
|
+
"description": "ButtonLink sizing is based on the buttonlink type.\n- **Pill buttonlink**: 40, 32, 28, 24.\n- **Icon buttonlink**: 64, 52, 40, 32, 28, 24.\n- Tertiary icon buttonlink can also be 20.",
|
6120
|
+
"default": "32",
|
6121
|
+
"fieldName": "size"
|
6122
|
+
},
|
6123
|
+
{
|
6124
|
+
"name": "soft-disabled",
|
6125
|
+
"type": {
|
6126
|
+
"text": "boolean | undefined"
|
6127
|
+
},
|
6128
|
+
"description": "Indicates whether the buttonlink is soft disabled.\nWhen set to `true`, the buttonlink 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 buttonlink behaves like a disabled buttonlink, allowing only focus and\npreventing any interactions (clicks or keyboard actions) from triggering unintended actions.",
|
6129
|
+
"default": "undefined",
|
6130
|
+
"fieldName": "softDisabled"
|
6131
|
+
},
|
6132
|
+
{
|
6133
|
+
"name": "prefix-icon",
|
6134
|
+
"type": {
|
6135
|
+
"text": "IconNames | undefined"
|
6136
|
+
},
|
6137
|
+
"description": "The name of the icon to display as a prefix.\nThe icon is displayed on the left side of the button.",
|
6138
|
+
"fieldName": "prefixIcon",
|
6139
|
+
"inheritedFrom": {
|
6140
|
+
"name": "ButtonComponentMixin",
|
6141
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
6142
|
+
}
|
6143
|
+
},
|
6144
|
+
{
|
6145
|
+
"name": "postfix-icon",
|
6146
|
+
"type": {
|
6147
|
+
"text": "IconNames | undefined"
|
6148
|
+
},
|
6149
|
+
"description": "The name of the icon to display as a postfix.\nThe icon is displayed on the right side of the button.",
|
6150
|
+
"fieldName": "postfixIcon",
|
6151
|
+
"inheritedFrom": {
|
6152
|
+
"name": "ButtonComponentMixin",
|
6153
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
6154
|
+
}
|
6155
|
+
},
|
6156
|
+
{
|
6157
|
+
"name": "variant",
|
6158
|
+
"type": {
|
6159
|
+
"text": "ButtonVariant"
|
6160
|
+
},
|
6161
|
+
"description": "There are 3 variants of button: primary, secondary, tertiary. They are styled differently.\n- **Primary**: Solid background color.\n- **Secondary**: Transparent background with a solid border.\n- **Tertiary**: No background or border, appears as plain text but retains all button functionalities.",
|
6162
|
+
"default": "primary",
|
6163
|
+
"fieldName": "variant",
|
6164
|
+
"inheritedFrom": {
|
6165
|
+
"name": "ButtonComponentMixin",
|
6166
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
6167
|
+
}
|
6168
|
+
},
|
6169
|
+
{
|
6170
|
+
"name": "color",
|
6171
|
+
"type": {
|
6172
|
+
"text": "ButtonColor"
|
6173
|
+
},
|
6174
|
+
"description": "There are 5 colors for button: positive, negative, accent, promotional, default.",
|
6175
|
+
"default": "default",
|
6176
|
+
"fieldName": "color",
|
6177
|
+
"inheritedFrom": {
|
6178
|
+
"name": "ButtonComponentMixin",
|
6179
|
+
"module": "src/utils/mixins/ButtonComponentMixin.ts"
|
6180
|
+
}
|
6181
|
+
},
|
6182
|
+
{
|
6183
|
+
"name": "disabled",
|
6184
|
+
"type": {
|
6185
|
+
"text": "boolean | undefined"
|
6186
|
+
},
|
6187
|
+
"description": "Indicates whether the component is disabled.\nWhen the component is disabled for user interaction; it is not focusable or clickable.",
|
6188
|
+
"default": "undefined",
|
6189
|
+
"fieldName": "disabled",
|
6190
|
+
"inheritedFrom": {
|
6191
|
+
"name": "DisabledMixin",
|
6192
|
+
"module": "src/utils/mixins/DisabledMixin.ts"
|
6193
|
+
}
|
6194
|
+
},
|
6195
|
+
{
|
6196
|
+
"name": "tabIndex",
|
6197
|
+
"type": {
|
6198
|
+
"text": "number"
|
6199
|
+
},
|
6200
|
+
"default": "0",
|
6201
|
+
"description": "This property specifies the tab order of the element.",
|
6202
|
+
"fieldName": "tabIndex",
|
6203
|
+
"inheritedFrom": {
|
6204
|
+
"name": "TabIndexMixin",
|
6205
|
+
"module": "src/utils/mixins/TabIndexMixin.ts"
|
6206
|
+
}
|
6207
|
+
},
|
6208
|
+
{
|
6209
|
+
"name": "inline",
|
6210
|
+
"type": {
|
6211
|
+
"text": "boolean"
|
6212
|
+
},
|
6213
|
+
"description": "The link can be inline or standalone.",
|
6214
|
+
"default": "false",
|
6215
|
+
"fieldName": "inline",
|
6216
|
+
"inheritedFrom": {
|
6217
|
+
"name": "Linksimple",
|
6218
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6219
|
+
}
|
6220
|
+
},
|
6221
|
+
{
|
6222
|
+
"name": "inverted",
|
6223
|
+
"type": {
|
6224
|
+
"text": "boolean"
|
6225
|
+
},
|
6226
|
+
"description": "The link color can be inverted by setting the inverted attribute to true.",
|
6227
|
+
"default": "false",
|
6228
|
+
"fieldName": "inverted",
|
6229
|
+
"inheritedFrom": {
|
6230
|
+
"name": "Linksimple",
|
6231
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6232
|
+
}
|
6233
|
+
},
|
6234
|
+
{
|
6235
|
+
"name": "href",
|
6236
|
+
"type": {
|
6237
|
+
"text": "string"
|
6238
|
+
},
|
6239
|
+
"default": "'#'",
|
6240
|
+
"description": "Href for navigation. The URL that the hyperlink points to",
|
6241
|
+
"fieldName": "href",
|
6242
|
+
"inheritedFrom": {
|
6243
|
+
"name": "Linksimple",
|
6244
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6245
|
+
}
|
6246
|
+
},
|
6247
|
+
{
|
6248
|
+
"name": "target",
|
6249
|
+
"type": {
|
6250
|
+
"text": "string"
|
6251
|
+
},
|
6252
|
+
"default": "'_self'",
|
6253
|
+
"description": "Optional target: _blank, _self, _parent, _top and _unfencedTop",
|
6254
|
+
"fieldName": "target",
|
6255
|
+
"inheritedFrom": {
|
6256
|
+
"name": "Linksimple",
|
6257
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6258
|
+
}
|
6259
|
+
},
|
6260
|
+
{
|
6261
|
+
"name": "rel",
|
6262
|
+
"type": {
|
6263
|
+
"text": "string | undefined"
|
6264
|
+
},
|
6265
|
+
"description": "Optional rel attribute that defines the relationship of the linked URL as space-separated link types.",
|
6266
|
+
"fieldName": "rel",
|
6267
|
+
"inheritedFrom": {
|
6268
|
+
"name": "Linksimple",
|
6269
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6270
|
+
}
|
6271
|
+
}
|
6272
|
+
],
|
6273
|
+
"mixins": [
|
6274
|
+
{
|
6275
|
+
"name": "ButtonComponentMixin",
|
6276
|
+
"module": "/src/utils/mixins/ButtonComponentMixin"
|
6277
|
+
}
|
6278
|
+
],
|
6279
|
+
"superclass": {
|
6280
|
+
"name": "Linksimple",
|
6281
|
+
"module": "/src/components/linksimple/linksimple.component"
|
6282
|
+
},
|
6283
|
+
"tagName": "mdc-buttonlink",
|
6284
|
+
"jsDoc": "/**\n * `mdc-buttonlink` combines the functional behavior of `mdc-linksimple` with the visual and structural\n * features of `mdc-button`. This includes support for variants, sizing, and optional\n * prefix and postfix icons via slots.\n *\n * ### Features:\n * - Behaves like an link while visually resembling a button.\n * - Supports slots for `prefix-icon` and `postfix-icon`.\n * - Customizable size, color, and variant through attributes.\n * - Inherits accessibility and keyboard interaction support from `mdc-linksimple`.\n *\n * @dependency mdc-icon\n *\n * @tagname mdc-buttonlink\n *\n * @event click - (React: onClick) Fired when the user activates the buttonLink using a mouse or assistive technology.\n * @event keydown - (React: onKeyDown) Fired when the user presses a key while the buttonLink has focus.\n * @event focus - (React: onFocus) Fired when the buttonLink receives keyboard or mouse focus.\n * @event blur - (React: onBlur) Fired when the buttonLink loses keyboard or mouse focus.\n *\n */",
|
6285
|
+
"customElement": true,
|
6286
|
+
"cssProperties": [
|
6287
|
+
{
|
6288
|
+
"description": "Border radius of the link.",
|
6289
|
+
"name": "--mdc-link-border-radius",
|
6290
|
+
"inheritedFrom": {
|
6291
|
+
"name": "Linksimple",
|
6292
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6293
|
+
}
|
6294
|
+
},
|
6295
|
+
{
|
6296
|
+
"description": "Color of the link’s child content in the active state.",
|
6297
|
+
"name": "--mdc-link-color-active",
|
6298
|
+
"inheritedFrom": {
|
6299
|
+
"name": "Linksimple",
|
6300
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6301
|
+
}
|
6302
|
+
},
|
6303
|
+
{
|
6304
|
+
"description": "Color of the link’s child content in the disabled state.",
|
6305
|
+
"name": "--mdc-link-color-disabled",
|
6306
|
+
"inheritedFrom": {
|
6307
|
+
"name": "Linksimple",
|
6308
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6309
|
+
}
|
6310
|
+
},
|
6311
|
+
{
|
6312
|
+
"description": "Color of the link’s child content in the hover state.",
|
6313
|
+
"name": "--mdc-link-color-hover",
|
6314
|
+
"inheritedFrom": {
|
6315
|
+
"name": "Linksimple",
|
6316
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6317
|
+
}
|
6318
|
+
},
|
6319
|
+
{
|
6320
|
+
"description": "Color of the link’s child content in the normal state.",
|
6321
|
+
"name": "--mdc-link-color-normal",
|
6322
|
+
"inheritedFrom": {
|
6323
|
+
"name": "Linksimple",
|
6324
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6325
|
+
}
|
6326
|
+
},
|
6327
|
+
{
|
6328
|
+
"description": "Color of the inverted link’s child content in the active state.",
|
6329
|
+
"name": "--mdc-link-inverted-color-active",
|
6330
|
+
"inheritedFrom": {
|
6331
|
+
"name": "Linksimple",
|
6332
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6333
|
+
}
|
6334
|
+
},
|
6335
|
+
{
|
6336
|
+
"description": "Color of the inverted link’s child content in the disabled state.",
|
6337
|
+
"name": "--mdc-link-inverted-color-disabled",
|
6338
|
+
"inheritedFrom": {
|
6339
|
+
"name": "Linksimple",
|
6340
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6341
|
+
}
|
6342
|
+
},
|
6343
|
+
{
|
6344
|
+
"description": "Color of the inverted link’s child content in the hover state.",
|
6345
|
+
"name": "--mdc-link-inverted-color-hover",
|
6346
|
+
"inheritedFrom": {
|
6347
|
+
"name": "Linksimple",
|
6348
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6349
|
+
}
|
6350
|
+
},
|
6351
|
+
{
|
6352
|
+
"description": "Color of the inverted link’s child content in the normal state.",
|
6353
|
+
"name": "--mdc-link-inverted-color-normal",
|
6354
|
+
"inheritedFrom": {
|
6355
|
+
"name": "Linksimple",
|
6356
|
+
"module": "src/components/linksimple/linksimple.component.ts"
|
6357
|
+
}
|
6358
|
+
}
|
6359
|
+
]
|
6360
|
+
}
|
6361
|
+
],
|
6362
|
+
"exports": [
|
6363
|
+
{
|
6364
|
+
"kind": "js",
|
6365
|
+
"name": "default",
|
6366
|
+
"declaration": {
|
6367
|
+
"name": "ButtonLink",
|
6368
|
+
"module": "components/buttonlink/buttonlink.component.js"
|
6369
|
+
}
|
6370
|
+
}
|
6371
|
+
]
|
6372
|
+
},
|
6373
6373
|
{
|
6374
6374
|
"kind": "javascript-module",
|
6375
6375
|
"path": "components/cardcheckbox/cardcheckbox.component.js",
|
@@ -14650,6 +14650,14 @@
|
|
14650
14650
|
"text": "EventConstructor"
|
14651
14651
|
}
|
14652
14652
|
},
|
14653
|
+
{
|
14654
|
+
"name": "clear",
|
14655
|
+
"type": {
|
14656
|
+
"text": "CustomEvent"
|
14657
|
+
},
|
14658
|
+
"description": "(React: onClear) This event is dispatched when the input text is cleared.",
|
14659
|
+
"reactName": "onClear"
|
14660
|
+
},
|
14653
14661
|
{
|
14654
14662
|
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
14655
14663
|
"name": "input",
|
@@ -14979,7 +14987,7 @@
|
|
14979
14987
|
"module": "/src/components/formfieldwrapper"
|
14980
14988
|
},
|
14981
14989
|
"tagName": "mdc-input",
|
14982
|
-
"jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
|
14990
|
+
"jsDoc": "/**\n * mdc-input is a component that allows users to input text.\n * It contains:\n * - label field - describe the input field.\n * - input field - contains the value\n * - help text or validation message - displayed below the input field.\n * - trailing button - it displays a clear the input field.\n * - prefix text - displayed before the input field.\n * - leading icon - displayed before the input field.\n * - clear-aria-label - aria label for the trailing button.\n * - all the attributes of the input field.\n *\n * @tagname mdc-input\n *\n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @dependency mdc-icon\n * @dependency mdc-text\n * @dependency mdc-button\n * @dependency mdc-toggletip\n *\n * @cssproperty --mdc-input-disabled-border-color - Border color for the input container when disabled\n * @cssproperty --mdc-input-disabled-text-color - Text color for the input field when disabled\n * @cssproperty --mdc-input-disabled-background-color - Background color for the input field when disabled\n * @cssproperty --mdc-input-border-color - Border color for the input container\n * @cssproperty --mdc-input-text-color - Text color for the input field\n * @cssproperty --mdc-input-background-color - Background color for the input field\n * @cssproperty --mdc-input-selection-background-color - Background color for the selected text\n * @cssproperty --mdc-input-selection-text-color - Text color for the selected text\n * @cssproperty --mdc-input-support-text-color - Text color for the help text\n * @cssproperty --mdc-input-hover-background-color - Background color for the input field when hovered\n * @cssproperty --mdc-input-focused-background-color - Background color for the input field when focused\n * @cssproperty --mdc-input-focused-border-color - Border color for the input container when focused\n * @cssproperty --mdc-input-error-border-color - Border color for the input container when error\n * @cssproperty --mdc-input-warning-border-color - Border color for the input container when warning\n * @cssproperty --mdc-input-success-border-color - Border color for the input container when success\n * @cssproperty --mdc-input-primary-border-color - Border color for the input container when primary\n *\n */",
|
14983
14991
|
"customElement": true
|
14984
14992
|
}
|
14985
14993
|
],
|
@@ -26058,6 +26066,18 @@
|
|
26058
26066
|
"name": "Input",
|
26059
26067
|
"module": "src/components/input/input.component.ts"
|
26060
26068
|
}
|
26069
|
+
},
|
26070
|
+
{
|
26071
|
+
"name": "clear",
|
26072
|
+
"type": {
|
26073
|
+
"text": "CustomEvent"
|
26074
|
+
},
|
26075
|
+
"description": "(React: onClear) This event is dispatched when the input text is cleared.",
|
26076
|
+
"reactName": "onClear",
|
26077
|
+
"inheritedFrom": {
|
26078
|
+
"name": "Input",
|
26079
|
+
"module": "src/components/input/input.component.ts"
|
26080
|
+
}
|
26061
26081
|
}
|
26062
26082
|
],
|
26063
26083
|
"attributes": [
|
@@ -30580,7 +30600,7 @@
|
|
30580
30600
|
"declarations": [
|
30581
30601
|
{
|
30582
30602
|
"kind": "class",
|
30583
|
-
"description": "searchfield component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
|
30603
|
+
"description": "`mdc-searchfield` component is used as an input field for search functionality.\n\nIt supports `mdc-inputchip` as filters.\n\nThis component is built by extending the `mdc-input` component.",
|
30584
30604
|
"name": "Searchfield",
|
30585
30605
|
"slots": [
|
30586
30606
|
{
|
@@ -31279,12 +31299,71 @@
|
|
31279
31299
|
}
|
31280
31300
|
}
|
31281
31301
|
],
|
31302
|
+
"events": [
|
31303
|
+
{
|
31304
|
+
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
31305
|
+
"name": "input",
|
31306
|
+
"reactName": "onInput",
|
31307
|
+
"inheritedFrom": {
|
31308
|
+
"name": "Input",
|
31309
|
+
"module": "src/components/input/input.component.ts"
|
31310
|
+
}
|
31311
|
+
},
|
31312
|
+
{
|
31313
|
+
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
31314
|
+
"name": "change",
|
31315
|
+
"reactName": "onChange",
|
31316
|
+
"inheritedFrom": {
|
31317
|
+
"name": "Input",
|
31318
|
+
"module": "src/components/input/input.component.ts"
|
31319
|
+
}
|
31320
|
+
},
|
31321
|
+
{
|
31322
|
+
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
31323
|
+
"name": "focus",
|
31324
|
+
"reactName": "onFocus",
|
31325
|
+
"inheritedFrom": {
|
31326
|
+
"name": "Input",
|
31327
|
+
"module": "src/components/input/input.component.ts"
|
31328
|
+
}
|
31329
|
+
},
|
31330
|
+
{
|
31331
|
+
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
31332
|
+
"name": "blur",
|
31333
|
+
"reactName": "onBlur",
|
31334
|
+
"inheritedFrom": {
|
31335
|
+
"name": "Input",
|
31336
|
+
"module": "src/components/input/input.component.ts"
|
31337
|
+
}
|
31338
|
+
},
|
31339
|
+
{
|
31340
|
+
"name": "clear",
|
31341
|
+
"type": {
|
31342
|
+
"text": "CustomEvent"
|
31343
|
+
},
|
31344
|
+
"description": "(React: onClear) This event is dispatched when the input text is cleared.",
|
31345
|
+
"reactName": "onClear",
|
31346
|
+
"inheritedFrom": {
|
31347
|
+
"name": "Input",
|
31348
|
+
"module": "src/components/input/input.component.ts"
|
31349
|
+
}
|
31350
|
+
},
|
31351
|
+
{
|
31352
|
+
"type": {
|
31353
|
+
"text": "EventConstructor"
|
31354
|
+
},
|
31355
|
+
"inheritedFrom": {
|
31356
|
+
"name": "Input",
|
31357
|
+
"module": "src/components/input/input.component.ts"
|
31358
|
+
}
|
31359
|
+
}
|
31360
|
+
],
|
31282
31361
|
"superclass": {
|
31283
31362
|
"name": "Input",
|
31284
31363
|
"module": "/src/components/input/input.component"
|
31285
31364
|
},
|
31286
31365
|
"tagName": "mdc-searchfield",
|
31287
|
-
"jsDoc": "/**\n * searchfield component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n *\n * @slot filters - Slot for input chips\n
|
31366
|
+
"jsDoc": "/**\n * `mdc-searchfield` component is used as an input field for search functionality.\n *\n * It supports `mdc-inputchip` as filters.\n *\n * This component is built by extending the `mdc-input` component.\n *\n * @tagname mdc-searchfield\n * \n * @event input - (React: onInput) This event is dispatched when the value of the input field changes (every press).\n * @event change - (React: onChange) This event is dispatched when the value of the input field changes (on blur).\n * @event focus - (React: onFocus) This event is dispatched when the input receives focus.\n * @event blur - (React: onBlur) This event is dispatched when the input loses focus.\n * @event clear - (React: onClear) This event is dispatched when the input text is cleared.\n *\n * @slot filters - Slot for input chips\n */",
|
31288
31367
|
"customElement": true,
|
31289
31368
|
"attributes": [
|
31290
31369
|
{
|
@@ -31768,53 +31847,6 @@
|
|
31768
31847
|
"module": "src/components/input/input.component.ts"
|
31769
31848
|
}
|
31770
31849
|
}
|
31771
|
-
],
|
31772
|
-
"events": [
|
31773
|
-
{
|
31774
|
-
"type": {
|
31775
|
-
"text": "EventConstructor"
|
31776
|
-
},
|
31777
|
-
"inheritedFrom": {
|
31778
|
-
"name": "Input",
|
31779
|
-
"module": "src/components/input/input.component.ts"
|
31780
|
-
}
|
31781
|
-
},
|
31782
|
-
{
|
31783
|
-
"description": "(React: onInput) This event is dispatched when the value of the input field changes (every press).",
|
31784
|
-
"name": "input",
|
31785
|
-
"reactName": "onInput",
|
31786
|
-
"inheritedFrom": {
|
31787
|
-
"name": "Input",
|
31788
|
-
"module": "src/components/input/input.component.ts"
|
31789
|
-
}
|
31790
|
-
},
|
31791
|
-
{
|
31792
|
-
"description": "(React: onChange) This event is dispatched when the value of the input field changes (on blur).",
|
31793
|
-
"name": "change",
|
31794
|
-
"reactName": "onChange",
|
31795
|
-
"inheritedFrom": {
|
31796
|
-
"name": "Input",
|
31797
|
-
"module": "src/components/input/input.component.ts"
|
31798
|
-
}
|
31799
|
-
},
|
31800
|
-
{
|
31801
|
-
"description": "(React: onFocus) This event is dispatched when the input receives focus.",
|
31802
|
-
"name": "focus",
|
31803
|
-
"reactName": "onFocus",
|
31804
|
-
"inheritedFrom": {
|
31805
|
-
"name": "Input",
|
31806
|
-
"module": "src/components/input/input.component.ts"
|
31807
|
-
}
|
31808
|
-
},
|
31809
|
-
{
|
31810
|
-
"description": "(React: onBlur) This event is dispatched when the input loses focus.",
|
31811
|
-
"name": "blur",
|
31812
|
-
"reactName": "onBlur",
|
31813
|
-
"inheritedFrom": {
|
31814
|
-
"name": "Input",
|
31815
|
-
"module": "src/components/input/input.component.ts"
|
31816
|
-
}
|
31817
|
-
}
|
31818
31850
|
]
|
31819
31851
|
}
|
31820
31852
|
],
|
@@ -37269,24 +37301,28 @@
|
|
37269
37301
|
},
|
37270
37302
|
{
|
37271
37303
|
"kind": "javascript-module",
|
37272
|
-
"path": "components/
|
37304
|
+
"path": "components/tooltip/tooltip.component.js",
|
37273
37305
|
"declarations": [
|
37274
37306
|
{
|
37275
37307
|
"kind": "class",
|
37276
|
-
"description": "A
|
37277
|
-
"name": "
|
37308
|
+
"description": "A tooltip is triggered by mouse hover or by keyboard focus\nand will disappear upon mouse exit or focus change.\n\nNote: Tooltips cannot contain content that can be focused or interacted with.",
|
37309
|
+
"name": "Tooltip",
|
37278
37310
|
"cssProperties": [
|
37279
37311
|
{
|
37280
|
-
"description": "The maximum width of the
|
37281
|
-
"name": "--mdc-
|
37312
|
+
"description": "The maximum width of the tooltip.",
|
37313
|
+
"name": "--mdc-tooltip-max-width"
|
37282
37314
|
},
|
37283
37315
|
{
|
37284
|
-
"description": "The
|
37285
|
-
"name": "--mdc-
|
37316
|
+
"description": "The padding of the tooltip.",
|
37317
|
+
"name": "--mdc-tooltip-padding"
|
37286
37318
|
},
|
37287
37319
|
{
|
37288
|
-
"description": "The text color of the
|
37289
|
-
"name": "--mdc-
|
37320
|
+
"description": "The text color of the tooltip.",
|
37321
|
+
"name": "--mdc-tooltip-text-color"
|
37322
|
+
},
|
37323
|
+
{
|
37324
|
+
"description": "The text color of the tooltip when the color is contrast.",
|
37325
|
+
"name": "--mdc-tooltip-text-color-contrast"
|
37290
37326
|
},
|
37291
37327
|
{
|
37292
37328
|
"description": "radius of the arrow border",
|
@@ -37369,53 +37405,29 @@
|
|
37369
37405
|
}
|
37370
37406
|
}
|
37371
37407
|
],
|
37372
|
-
"slots": [
|
37373
|
-
{
|
37374
|
-
"description": "Default slot for the toggletip content",
|
37375
|
-
"name": "",
|
37376
|
-
"inheritedFrom": {
|
37377
|
-
"name": "Popover",
|
37378
|
-
"module": "src/components/popover/popover.component.ts"
|
37379
|
-
}
|
37380
|
-
}
|
37381
|
-
],
|
37382
37408
|
"members": [
|
37383
37409
|
{
|
37384
37410
|
"kind": "field",
|
37385
|
-
"name": "
|
37386
|
-
"type": {
|
37387
|
-
"text": "Array<Node>"
|
37388
|
-
},
|
37389
|
-
"privacy": "private"
|
37390
|
-
},
|
37391
|
-
{
|
37392
|
-
"kind": "field",
|
37393
|
-
"name": "screenreaderAnnouncerIdentity",
|
37411
|
+
"name": "tooltipType",
|
37394
37412
|
"type": {
|
37395
|
-
"text": "
|
37413
|
+
"text": "TooltipType"
|
37396
37414
|
},
|
37397
|
-
"description": "
|
37398
|
-
"
|
37415
|
+
"description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
|
37416
|
+
"default": "'description'",
|
37417
|
+
"attribute": "tooltip-type",
|
37399
37418
|
"reflects": true
|
37400
37419
|
},
|
37401
37420
|
{
|
37402
37421
|
"kind": "field",
|
37403
|
-
"name": "
|
37422
|
+
"name": "defaultSlotNodes",
|
37404
37423
|
"type": {
|
37405
|
-
"text": "
|
37424
|
+
"text": "Array<Node>"
|
37406
37425
|
},
|
37407
|
-
"
|
37408
|
-
"default": "bottom",
|
37409
|
-
"attribute": "placement",
|
37410
|
-
"reflects": true,
|
37411
|
-
"inheritedFrom": {
|
37412
|
-
"name": "Popover",
|
37413
|
-
"module": "components/popover/popover.component.js"
|
37414
|
-
}
|
37426
|
+
"privacy": "private"
|
37415
37427
|
},
|
37416
37428
|
{
|
37417
37429
|
"kind": "method",
|
37418
|
-
"name": "
|
37430
|
+
"name": "getTooltipText",
|
37419
37431
|
"privacy": "private",
|
37420
37432
|
"return": {
|
37421
37433
|
"type": {
|
@@ -37423,6 +37435,37 @@
|
|
37423
37435
|
}
|
37424
37436
|
}
|
37425
37437
|
},
|
37438
|
+
{
|
37439
|
+
"kind": "method",
|
37440
|
+
"name": "setTooltipType",
|
37441
|
+
"privacy": "private",
|
37442
|
+
"return": {
|
37443
|
+
"type": {
|
37444
|
+
"text": "void"
|
37445
|
+
}
|
37446
|
+
},
|
37447
|
+
"parameters": [
|
37448
|
+
{
|
37449
|
+
"name": "type",
|
37450
|
+
"type": {
|
37451
|
+
"text": "TooltipType"
|
37452
|
+
},
|
37453
|
+
"description": "The type to set."
|
37454
|
+
}
|
37455
|
+
],
|
37456
|
+
"description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
|
37457
|
+
},
|
37458
|
+
{
|
37459
|
+
"kind": "method",
|
37460
|
+
"name": "onIdUpdated",
|
37461
|
+
"privacy": "private",
|
37462
|
+
"return": {
|
37463
|
+
"type": {
|
37464
|
+
"text": "Promise<void>"
|
37465
|
+
}
|
37466
|
+
},
|
37467
|
+
"description": "Updates the tooltip id if it is empty."
|
37468
|
+
},
|
37426
37469
|
{
|
37427
37470
|
"kind": "method",
|
37428
37471
|
"name": "onPlacementUpdated",
|
@@ -37432,7 +37475,27 @@
|
|
37432
37475
|
"text": "void"
|
37433
37476
|
}
|
37434
37477
|
},
|
37435
|
-
"description": "Updates the placement attribute if it is not a valid placement.\
|
37478
|
+
"description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
|
37479
|
+
},
|
37480
|
+
{
|
37481
|
+
"kind": "method",
|
37482
|
+
"name": "onTooltipTypeUpdated",
|
37483
|
+
"privacy": "private",
|
37484
|
+
"return": {
|
37485
|
+
"type": {
|
37486
|
+
"text": "void"
|
37487
|
+
}
|
37488
|
+
},
|
37489
|
+
"parameters": [
|
37490
|
+
{
|
37491
|
+
"name": "changedProperties",
|
37492
|
+
"type": {
|
37493
|
+
"text": "PropertyValues"
|
37494
|
+
},
|
37495
|
+
"description": "The changed properties."
|
37496
|
+
}
|
37497
|
+
],
|
37498
|
+
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
37436
37499
|
},
|
37437
37500
|
{
|
37438
37501
|
"kind": "field",
|
@@ -38025,6 +38088,21 @@
|
|
38025
38088
|
"module": "components/popover/popover.component.js"
|
38026
38089
|
}
|
38027
38090
|
},
|
38091
|
+
{
|
38092
|
+
"kind": "field",
|
38093
|
+
"name": "placement",
|
38094
|
+
"type": {
|
38095
|
+
"text": "PopoverPlacement"
|
38096
|
+
},
|
38097
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
38098
|
+
"default": "bottom",
|
38099
|
+
"attribute": "placement",
|
38100
|
+
"reflects": true,
|
38101
|
+
"inheritedFrom": {
|
38102
|
+
"name": "Popover",
|
38103
|
+
"module": "components/popover/popover.component.js"
|
38104
|
+
}
|
38105
|
+
},
|
38028
38106
|
{
|
38029
38107
|
"kind": "field",
|
38030
38108
|
"name": "color",
|
@@ -38653,550 +38731,1031 @@
|
|
38653
38731
|
"description": "Hides the popover.",
|
38654
38732
|
"inheritedFrom": {
|
38655
38733
|
"name": "Popover",
|
38656
|
-
"module": "components/popover/popover.component.js"
|
38734
|
+
"module": "components/popover/popover.component.js"
|
38735
|
+
}
|
38736
|
+
},
|
38737
|
+
{
|
38738
|
+
"kind": "field",
|
38739
|
+
"name": "togglePopoverVisible",
|
38740
|
+
"privacy": "public",
|
38741
|
+
"description": "Toggles the popover visibility.",
|
38742
|
+
"inheritedFrom": {
|
38743
|
+
"name": "Popover",
|
38744
|
+
"module": "components/popover/popover.component.js"
|
38745
|
+
}
|
38746
|
+
},
|
38747
|
+
{
|
38748
|
+
"kind": "field",
|
38749
|
+
"name": "positionPopover",
|
38750
|
+
"privacy": "private",
|
38751
|
+
"description": "Positions the popover based on the trigger element.\nIt also handles the flip, size and arrow placement.\nIt uses the floating-ui/dom library to calculate the position.",
|
38752
|
+
"inheritedFrom": {
|
38753
|
+
"name": "Popover",
|
38754
|
+
"module": "components/popover/popover.component.js"
|
38755
|
+
}
|
38756
|
+
},
|
38757
|
+
{
|
38758
|
+
"kind": "field",
|
38759
|
+
"name": "findClosestPopover",
|
38760
|
+
"privacy": "protected",
|
38761
|
+
"description": "Finds the closest popover to the passed element in the DOM tree.\n\nUseful when need to find the parent popover in a nested popover scenario.",
|
38762
|
+
"parameters": [
|
38763
|
+
{
|
38764
|
+
"description": "The element to start searching from.",
|
38765
|
+
"name": "element"
|
38766
|
+
}
|
38767
|
+
],
|
38768
|
+
"inheritedFrom": {
|
38769
|
+
"name": "Popover",
|
38770
|
+
"module": "components/popover/popover.component.js"
|
38771
|
+
}
|
38772
|
+
},
|
38773
|
+
{
|
38774
|
+
"kind": "field",
|
38775
|
+
"name": "utils",
|
38776
|
+
"default": "new PopoverUtils(this)",
|
38777
|
+
"inheritedFrom": {
|
38778
|
+
"name": "Popover",
|
38779
|
+
"module": "components/popover/popover.component.js"
|
38780
|
+
}
|
38781
|
+
}
|
38782
|
+
],
|
38783
|
+
"events": [
|
38784
|
+
{
|
38785
|
+
"description": "(React: onShown) This event is dispatched when the tooltip is shown",
|
38786
|
+
"name": "shown",
|
38787
|
+
"reactName": "onShown",
|
38788
|
+
"inheritedFrom": {
|
38789
|
+
"name": "Popover",
|
38790
|
+
"module": "src/components/popover/popover.component.ts"
|
38791
|
+
}
|
38792
|
+
},
|
38793
|
+
{
|
38794
|
+
"description": "(React: onHidden) This event is dispatched when the tooltip is hidden",
|
38795
|
+
"name": "hidden",
|
38796
|
+
"reactName": "onHidden",
|
38797
|
+
"inheritedFrom": {
|
38798
|
+
"name": "Popover",
|
38799
|
+
"module": "src/components/popover/popover.component.ts"
|
38800
|
+
}
|
38801
|
+
},
|
38802
|
+
{
|
38803
|
+
"description": "(React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)",
|
38804
|
+
"name": "created",
|
38805
|
+
"reactName": "onCreated",
|
38806
|
+
"inheritedFrom": {
|
38807
|
+
"name": "Popover",
|
38808
|
+
"module": "src/components/popover/popover.component.ts"
|
38809
|
+
}
|
38810
|
+
},
|
38811
|
+
{
|
38812
|
+
"description": "(React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)",
|
38813
|
+
"name": "destroyed",
|
38814
|
+
"reactName": "onDestroyed",
|
38815
|
+
"inheritedFrom": {
|
38816
|
+
"name": "Popover",
|
38817
|
+
"module": "src/components/popover/popover.component.ts"
|
38818
|
+
}
|
38819
|
+
}
|
38820
|
+
],
|
38821
|
+
"attributes": [
|
38822
|
+
{
|
38823
|
+
"name": "tooltip-type",
|
38824
|
+
"type": {
|
38825
|
+
"text": "TooltipType"
|
38826
|
+
},
|
38827
|
+
"description": "The type of tooltip.\n- **description** sets aria-describedby on the trigger component which refers to the tooltip id.\n- **label** sets aria-labelledby on the trigger component which refers to the tooltip id.\n- **none** no aria props set on trigger component referring to the tooltip id.",
|
38828
|
+
"default": "'description'",
|
38829
|
+
"fieldName": "tooltipType"
|
38830
|
+
},
|
38831
|
+
{
|
38832
|
+
"name": "should-focus-trap-wrap",
|
38833
|
+
"type": {
|
38834
|
+
"text": "boolean"
|
38835
|
+
},
|
38836
|
+
"default": "true",
|
38837
|
+
"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.",
|
38838
|
+
"fieldName": "shouldFocusTrapWrap",
|
38839
|
+
"inheritedFrom": {
|
38840
|
+
"name": "Popover",
|
38841
|
+
"module": "src/components/popover/popover.component.ts"
|
38842
|
+
}
|
38843
|
+
},
|
38844
|
+
{
|
38845
|
+
"name": "id",
|
38846
|
+
"type": {
|
38847
|
+
"text": "string"
|
38848
|
+
},
|
38849
|
+
"default": "''",
|
38850
|
+
"description": "The unique ID of the popover.",
|
38851
|
+
"fieldName": "id",
|
38852
|
+
"inheritedFrom": {
|
38853
|
+
"name": "Popover",
|
38854
|
+
"module": "src/components/popover/popover.component.ts"
|
38855
|
+
}
|
38856
|
+
},
|
38857
|
+
{
|
38858
|
+
"name": "triggerID",
|
38859
|
+
"type": {
|
38860
|
+
"text": "string"
|
38861
|
+
},
|
38862
|
+
"default": "''",
|
38863
|
+
"description": "The ID of the element that triggers the popover.\nThis attribute is required for the popover to work.",
|
38864
|
+
"fieldName": "triggerID",
|
38865
|
+
"inheritedFrom": {
|
38866
|
+
"name": "Popover",
|
38867
|
+
"module": "src/components/popover/popover.component.ts"
|
38868
|
+
}
|
38869
|
+
},
|
38870
|
+
{
|
38871
|
+
"name": "trigger",
|
38872
|
+
"type": {
|
38873
|
+
"text": "PopoverTrigger"
|
38874
|
+
},
|
38875
|
+
"description": "Determines the events that cause the Popover to show.\nMultiple event names should be separated by spaces.\nFor example to allow both click and hover, use 'click mouseenter' as the trigger.\n- **click**\n- **mouseenter**\n- **focusin**\n- **manual**",
|
38876
|
+
"default": "click",
|
38877
|
+
"fieldName": "trigger",
|
38878
|
+
"inheritedFrom": {
|
38879
|
+
"name": "Popover",
|
38880
|
+
"module": "src/components/popover/popover.component.ts"
|
38881
|
+
}
|
38882
|
+
},
|
38883
|
+
{
|
38884
|
+
"name": "placement",
|
38885
|
+
"type": {
|
38886
|
+
"text": "PopoverPlacement"
|
38887
|
+
},
|
38888
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
38889
|
+
"default": "bottom",
|
38890
|
+
"fieldName": "placement",
|
38891
|
+
"inheritedFrom": {
|
38892
|
+
"name": "Popover",
|
38893
|
+
"module": "src/components/popover/popover.component.ts"
|
38894
|
+
}
|
38895
|
+
},
|
38896
|
+
{
|
38897
|
+
"name": "color",
|
38898
|
+
"type": {
|
38899
|
+
"text": "PopoverColor"
|
38900
|
+
},
|
38901
|
+
"description": "Color of the popover\n- **tonal**\n- **contrast**",
|
38902
|
+
"default": "tonal",
|
38903
|
+
"fieldName": "color",
|
38904
|
+
"inheritedFrom": {
|
38905
|
+
"name": "Popover",
|
38906
|
+
"module": "src/components/popover/popover.component.ts"
|
38907
|
+
}
|
38908
|
+
},
|
38909
|
+
{
|
38910
|
+
"name": "visible",
|
38911
|
+
"type": {
|
38912
|
+
"text": "boolean"
|
38913
|
+
},
|
38914
|
+
"description": "The visibility of the popover.",
|
38915
|
+
"default": "false",
|
38916
|
+
"fieldName": "visible",
|
38917
|
+
"inheritedFrom": {
|
38918
|
+
"name": "Popover",
|
38919
|
+
"module": "src/components/popover/popover.component.ts"
|
38920
|
+
}
|
38921
|
+
},
|
38922
|
+
{
|
38923
|
+
"name": "offset",
|
38924
|
+
"type": {
|
38925
|
+
"text": "number"
|
38926
|
+
},
|
38927
|
+
"description": "The offset of the popover.",
|
38928
|
+
"default": "4",
|
38929
|
+
"fieldName": "offset",
|
38930
|
+
"inheritedFrom": {
|
38931
|
+
"name": "Popover",
|
38932
|
+
"module": "src/components/popover/popover.component.ts"
|
38933
|
+
}
|
38934
|
+
},
|
38935
|
+
{
|
38936
|
+
"name": "boundary",
|
38937
|
+
"type": {
|
38938
|
+
"text": "'clippingAncestors' | string"
|
38939
|
+
},
|
38940
|
+
"description": "This describes the clipping element(s) or area that overflow will be checked relative to.\nThe default is 'clippingAncestors', which are the overflow ancestors which will cause the\nelement to be clipped.\n\nPossible values:\n - 'clippingAncestors'\n - any css selector",
|
38941
|
+
"default": "'clippingAncestors'",
|
38942
|
+
"fieldName": "boundary",
|
38943
|
+
"inheritedFrom": {
|
38944
|
+
"name": "Popover",
|
38945
|
+
"module": "src/components/popover/popover.component.ts"
|
38946
|
+
}
|
38947
|
+
},
|
38948
|
+
{
|
38949
|
+
"name": "boundary-root",
|
38950
|
+
"type": {
|
38951
|
+
"text": "'viewport' | 'document'"
|
38952
|
+
},
|
38953
|
+
"description": "This describes the root boundary that the element will be checked for overflow relative to.\nThe default is 'viewport', which is the area of the page the user can see on the screen.\n\nThe other string option is 'document', which is the entire page outside the viewport.",
|
38954
|
+
"default": "'viewport'",
|
38955
|
+
"fieldName": "boundaryRoot",
|
38956
|
+
"inheritedFrom": {
|
38957
|
+
"name": "Popover",
|
38958
|
+
"module": "src/components/popover/popover.component.ts"
|
38959
|
+
}
|
38960
|
+
},
|
38961
|
+
{
|
38962
|
+
"name": "boundary-padding",
|
38963
|
+
"type": {
|
38964
|
+
"text": "undefined | number"
|
38965
|
+
},
|
38966
|
+
"description": "Virtual padding around the boundary to check for overflow.\nSo the popover will not be placed on top of the edge of the boundary.\n\nDefault works well for most cases, but you can set this to customise it when necessary.",
|
38967
|
+
"default": "undefined",
|
38968
|
+
"fieldName": "boundaryPadding",
|
38969
|
+
"inheritedFrom": {
|
38970
|
+
"name": "Popover",
|
38971
|
+
"module": "src/components/popover/popover.component.ts"
|
38972
|
+
}
|
38973
|
+
},
|
38974
|
+
{
|
38975
|
+
"name": "focus-trap",
|
38976
|
+
"type": {
|
38977
|
+
"text": "boolean"
|
38978
|
+
},
|
38979
|
+
"description": "Determines whether the focus trap is enabled.\nIf true, focus will be restricted to the content within this component.",
|
38980
|
+
"default": "false",
|
38981
|
+
"fieldName": "focusTrap",
|
38982
|
+
"inheritedFrom": {
|
38983
|
+
"name": "Popover",
|
38984
|
+
"module": "src/components/popover/popover.component.ts"
|
38657
38985
|
}
|
38658
38986
|
},
|
38659
38987
|
{
|
38660
|
-
"
|
38661
|
-
"
|
38662
|
-
|
38663
|
-
|
38988
|
+
"name": "prevent-scroll",
|
38989
|
+
"type": {
|
38990
|
+
"text": "boolean"
|
38991
|
+
},
|
38992
|
+
"description": "Prevent outside scrolling when popover is shown.",
|
38993
|
+
"default": "false",
|
38994
|
+
"fieldName": "preventScroll",
|
38664
38995
|
"inheritedFrom": {
|
38665
38996
|
"name": "Popover",
|
38666
|
-
"module": "components/popover/popover.component.
|
38997
|
+
"module": "src/components/popover/popover.component.ts"
|
38667
38998
|
}
|
38668
38999
|
},
|
38669
39000
|
{
|
38670
|
-
"
|
38671
|
-
"
|
38672
|
-
|
38673
|
-
|
39001
|
+
"name": "show-arrow",
|
39002
|
+
"type": {
|
39003
|
+
"text": "boolean"
|
39004
|
+
},
|
39005
|
+
"description": "The arrow visibility of the popover.",
|
39006
|
+
"default": "false",
|
39007
|
+
"fieldName": "showArrow",
|
38674
39008
|
"inheritedFrom": {
|
38675
39009
|
"name": "Popover",
|
38676
|
-
"module": "components/popover/popover.component.
|
39010
|
+
"module": "src/components/popover/popover.component.ts"
|
38677
39011
|
}
|
38678
39012
|
},
|
38679
39013
|
{
|
38680
|
-
"
|
38681
|
-
"
|
38682
|
-
|
38683
|
-
|
38684
|
-
"
|
38685
|
-
|
38686
|
-
|
38687
|
-
"name": "element"
|
38688
|
-
}
|
38689
|
-
],
|
39014
|
+
"name": "close-button",
|
39015
|
+
"type": {
|
39016
|
+
"text": "boolean"
|
39017
|
+
},
|
39018
|
+
"description": "The close button visibility of the popover.",
|
39019
|
+
"default": "false",
|
39020
|
+
"fieldName": "closeButton",
|
38690
39021
|
"inheritedFrom": {
|
38691
39022
|
"name": "Popover",
|
38692
|
-
"module": "components/popover/popover.component.
|
39023
|
+
"module": "src/components/popover/popover.component.ts"
|
38693
39024
|
}
|
38694
39025
|
},
|
38695
39026
|
{
|
38696
|
-
"
|
38697
|
-
"
|
38698
|
-
|
39027
|
+
"name": "interactive",
|
39028
|
+
"type": {
|
39029
|
+
"text": "boolean"
|
39030
|
+
},
|
39031
|
+
"description": "Determines whether the popover is interactive.\nMake sure to set focusTrap to true to keep the focus inside the popover in case necessary.\nSetting interactive to true will not automatically set focusTrap!",
|
39032
|
+
"default": "false",
|
39033
|
+
"fieldName": "interactive",
|
38699
39034
|
"inheritedFrom": {
|
38700
39035
|
"name": "Popover",
|
38701
|
-
"module": "components/popover/popover.component.
|
39036
|
+
"module": "src/components/popover/popover.component.ts"
|
38702
39037
|
}
|
38703
|
-
}
|
38704
|
-
],
|
38705
|
-
"events": [
|
39038
|
+
},
|
38706
39039
|
{
|
38707
|
-
"
|
38708
|
-
"
|
38709
|
-
|
39040
|
+
"name": "delay",
|
39041
|
+
"type": {
|
39042
|
+
"text": "string"
|
39043
|
+
},
|
39044
|
+
"description": "The delay of the show/hide popover.",
|
39045
|
+
"default": "0,0",
|
39046
|
+
"fieldName": "delay",
|
38710
39047
|
"inheritedFrom": {
|
38711
39048
|
"name": "Popover",
|
38712
39049
|
"module": "src/components/popover/popover.component.ts"
|
38713
39050
|
}
|
38714
39051
|
},
|
38715
39052
|
{
|
38716
|
-
"
|
38717
|
-
"
|
38718
|
-
|
39053
|
+
"name": "hide-on-escape",
|
39054
|
+
"type": {
|
39055
|
+
"text": "boolean"
|
39056
|
+
},
|
39057
|
+
"description": "Hide popover on escape key press.",
|
39058
|
+
"default": "false",
|
39059
|
+
"fieldName": "hideOnEscape",
|
38719
39060
|
"inheritedFrom": {
|
38720
39061
|
"name": "Popover",
|
38721
39062
|
"module": "src/components/popover/popover.component.ts"
|
38722
39063
|
}
|
38723
39064
|
},
|
38724
39065
|
{
|
38725
|
-
"
|
38726
|
-
"
|
38727
|
-
|
39066
|
+
"name": "propagate-event-on-escape",
|
39067
|
+
"type": {
|
39068
|
+
"text": "boolean"
|
39069
|
+
},
|
39070
|
+
"description": "Propagates the event, when the escape key is pressed (only when pressed inside the popover)\nIf true, the escape key press close the popover and will propagate the keydown event.\nIf false, the escape key press will close the popover but will not propagate the keydown event.\n(set to false to prevent the event from bubbling up to the document).\n\nThis only works when `hideOnEscape` is true.",
|
39071
|
+
"default": "false",
|
39072
|
+
"fieldName": "propagateEventOnEscape",
|
38728
39073
|
"inheritedFrom": {
|
38729
39074
|
"name": "Popover",
|
38730
39075
|
"module": "src/components/popover/popover.component.ts"
|
38731
39076
|
}
|
38732
39077
|
},
|
38733
39078
|
{
|
38734
|
-
"
|
38735
|
-
"
|
38736
|
-
|
39079
|
+
"name": "hide-on-blur",
|
39080
|
+
"type": {
|
39081
|
+
"text": "boolean"
|
39082
|
+
},
|
39083
|
+
"description": "Hide popover on blur.",
|
39084
|
+
"default": "false",
|
39085
|
+
"fieldName": "hideOnBlur",
|
38737
39086
|
"inheritedFrom": {
|
38738
39087
|
"name": "Popover",
|
38739
39088
|
"module": "src/components/popover/popover.component.ts"
|
38740
39089
|
}
|
38741
|
-
}
|
38742
|
-
],
|
38743
|
-
"attributes": [
|
38744
|
-
{
|
38745
|
-
"name": "screenreader-announcer-identity",
|
38746
|
-
"type": {
|
38747
|
-
"text": "string | undefined"
|
38748
|
-
},
|
38749
|
-
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
38750
|
-
"fieldName": "screenreaderAnnouncerIdentity"
|
38751
39090
|
},
|
38752
39091
|
{
|
38753
|
-
"name": "
|
39092
|
+
"name": "hide-on-outside-click",
|
38754
39093
|
"type": {
|
38755
|
-
"text": "
|
39094
|
+
"text": "boolean"
|
38756
39095
|
},
|
38757
|
-
"description": "
|
38758
|
-
"default": "
|
38759
|
-
"fieldName": "
|
39096
|
+
"description": "Hide on outside click of the popover.",
|
39097
|
+
"default": "false",
|
39098
|
+
"fieldName": "hideOnOutsideClick",
|
38760
39099
|
"inheritedFrom": {
|
38761
39100
|
"name": "Popover",
|
38762
39101
|
"module": "src/components/popover/popover.component.ts"
|
38763
39102
|
}
|
38764
39103
|
},
|
38765
39104
|
{
|
38766
|
-
"name": "
|
39105
|
+
"name": "focus-back-to-trigger",
|
38767
39106
|
"type": {
|
38768
39107
|
"text": "boolean"
|
38769
39108
|
},
|
38770
|
-
"
|
38771
|
-
"
|
38772
|
-
"fieldName": "
|
39109
|
+
"description": "The focus back to trigger after the popover hide.",
|
39110
|
+
"default": "false",
|
39111
|
+
"fieldName": "focusBackToTrigger",
|
38773
39112
|
"inheritedFrom": {
|
38774
39113
|
"name": "Popover",
|
38775
39114
|
"module": "src/components/popover/popover.component.ts"
|
38776
39115
|
}
|
38777
39116
|
},
|
38778
39117
|
{
|
38779
|
-
"name": "
|
39118
|
+
"name": "backdrop",
|
38780
39119
|
"type": {
|
38781
|
-
"text": "
|
39120
|
+
"text": "boolean"
|
38782
39121
|
},
|
38783
|
-
"
|
38784
|
-
"
|
38785
|
-
"fieldName": "
|
39122
|
+
"description": "Determines whether the popover with backdrop.\nOther than popover and trigger element, the rest of the screen will be covered with a backdrop.",
|
39123
|
+
"default": "false",
|
39124
|
+
"fieldName": "backdrop",
|
38786
39125
|
"inheritedFrom": {
|
38787
39126
|
"name": "Popover",
|
38788
39127
|
"module": "src/components/popover/popover.component.ts"
|
38789
39128
|
}
|
38790
39129
|
},
|
38791
39130
|
{
|
38792
|
-
"name": "
|
39131
|
+
"name": "flip",
|
38793
39132
|
"type": {
|
38794
|
-
"text": "
|
39133
|
+
"text": "boolean"
|
38795
39134
|
},
|
38796
|
-
"
|
38797
|
-
"
|
38798
|
-
"fieldName": "
|
39135
|
+
"description": "Changes the placement of popover to keep it in view when scrolling.",
|
39136
|
+
"default": "true",
|
39137
|
+
"fieldName": "flip",
|
38799
39138
|
"inheritedFrom": {
|
38800
39139
|
"name": "Popover",
|
38801
39140
|
"module": "src/components/popover/popover.component.ts"
|
38802
39141
|
}
|
38803
39142
|
},
|
38804
39143
|
{
|
38805
|
-
"name": "
|
39144
|
+
"name": "size",
|
38806
39145
|
"type": {
|
38807
|
-
"text": "
|
39146
|
+
"text": "boolean"
|
38808
39147
|
},
|
38809
|
-
"description": "
|
38810
|
-
"default": "
|
38811
|
-
"fieldName": "
|
39148
|
+
"description": "Changes the size of popover to keep it in view when scrolling.",
|
39149
|
+
"default": "false",
|
39150
|
+
"fieldName": "size",
|
38812
39151
|
"inheritedFrom": {
|
38813
39152
|
"name": "Popover",
|
38814
39153
|
"module": "src/components/popover/popover.component.ts"
|
38815
39154
|
}
|
38816
39155
|
},
|
38817
39156
|
{
|
38818
|
-
"name": "
|
39157
|
+
"name": "z-index",
|
38819
39158
|
"type": {
|
38820
|
-
"text": "
|
39159
|
+
"text": "number"
|
38821
39160
|
},
|
38822
|
-
"description": "
|
38823
|
-
"default": "
|
38824
|
-
"fieldName": "
|
39161
|
+
"description": "The z-index of the popover.",
|
39162
|
+
"default": "1000",
|
39163
|
+
"fieldName": "zIndex",
|
38825
39164
|
"inheritedFrom": {
|
38826
39165
|
"name": "Popover",
|
38827
39166
|
"module": "src/components/popover/popover.component.ts"
|
38828
39167
|
}
|
38829
39168
|
},
|
38830
39169
|
{
|
38831
|
-
"name": "
|
39170
|
+
"name": "append-to",
|
38832
39171
|
"type": {
|
38833
|
-
"text": "
|
39172
|
+
"text": "string | undefined"
|
38834
39173
|
},
|
38835
|
-
"description": "
|
38836
|
-
"default": "
|
38837
|
-
"fieldName": "
|
39174
|
+
"description": "Element ID that the popover append to.",
|
39175
|
+
"default": "''",
|
39176
|
+
"fieldName": "appendTo",
|
38838
39177
|
"inheritedFrom": {
|
38839
39178
|
"name": "Popover",
|
38840
39179
|
"module": "src/components/popover/popover.component.ts"
|
38841
39180
|
}
|
38842
39181
|
},
|
38843
39182
|
{
|
38844
|
-
"name": "
|
39183
|
+
"name": "close-button-aria-label",
|
38845
39184
|
"type": {
|
38846
|
-
"text": "
|
39185
|
+
"text": "string | null"
|
38847
39186
|
},
|
38848
|
-
"
|
38849
|
-
"
|
38850
|
-
"fieldName": "
|
39187
|
+
"default": "null",
|
39188
|
+
"description": "aria-label attribute to be set for close button accessibility.",
|
39189
|
+
"fieldName": "closeButtonAriaLabel",
|
38851
39190
|
"inheritedFrom": {
|
38852
39191
|
"name": "Popover",
|
38853
39192
|
"module": "src/components/popover/popover.component.ts"
|
38854
39193
|
}
|
38855
39194
|
},
|
38856
39195
|
{
|
38857
|
-
"name": "
|
39196
|
+
"name": "role",
|
38858
39197
|
"type": {
|
38859
|
-
"text": "'
|
39198
|
+
"text": "HTMLElement['role']"
|
38860
39199
|
},
|
38861
|
-
"description": "
|
38862
|
-
"default": "
|
38863
|
-
"fieldName": "
|
39200
|
+
"description": "Role of the popover",
|
39201
|
+
"default": "dialog",
|
39202
|
+
"fieldName": "role",
|
38864
39203
|
"inheritedFrom": {
|
38865
39204
|
"name": "Popover",
|
38866
39205
|
"module": "src/components/popover/popover.component.ts"
|
38867
39206
|
}
|
38868
39207
|
},
|
38869
39208
|
{
|
38870
|
-
"name": "
|
39209
|
+
"name": "aria-labelledby",
|
38871
39210
|
"type": {
|
38872
|
-
"text": "
|
39211
|
+
"text": "string | null"
|
38873
39212
|
},
|
38874
|
-
"
|
38875
|
-
"
|
38876
|
-
"fieldName": "
|
39213
|
+
"default": "null",
|
39214
|
+
"description": "aria-labelledby for an interactive popover only, defaults to the trigger component id.\nUsed in nested cases where the triggerComponent isn't the actual button.",
|
39215
|
+
"fieldName": "ariaLabelledby",
|
38877
39216
|
"inheritedFrom": {
|
38878
39217
|
"name": "Popover",
|
38879
39218
|
"module": "src/components/popover/popover.component.ts"
|
38880
39219
|
}
|
38881
39220
|
},
|
38882
39221
|
{
|
38883
|
-
"name": "
|
39222
|
+
"name": "aria-describedby",
|
38884
39223
|
"type": {
|
38885
|
-
"text": "
|
39224
|
+
"text": "string | null"
|
38886
39225
|
},
|
38887
|
-
"
|
38888
|
-
"
|
38889
|
-
"fieldName": "
|
39226
|
+
"default": "null",
|
39227
|
+
"description": "aria-describedby of the popover.",
|
39228
|
+
"fieldName": "ariaDescribedby",
|
38890
39229
|
"inheritedFrom": {
|
38891
39230
|
"name": "Popover",
|
38892
39231
|
"module": "src/components/popover/popover.component.ts"
|
38893
39232
|
}
|
38894
39233
|
},
|
38895
39234
|
{
|
38896
|
-
"name": "
|
39235
|
+
"name": "disable-aria-expanded",
|
38897
39236
|
"type": {
|
38898
39237
|
"text": "boolean"
|
38899
39238
|
},
|
38900
|
-
"description": "
|
39239
|
+
"description": "Disable setting the aria-expanded attribute on trigger element.\nMake sure to set this to false when the popover is interactive.",
|
38901
39240
|
"default": "false",
|
38902
|
-
"fieldName": "
|
39241
|
+
"fieldName": "disableAriaExpanded",
|
38903
39242
|
"inheritedFrom": {
|
38904
39243
|
"name": "Popover",
|
38905
39244
|
"module": "src/components/popover/popover.component.ts"
|
38906
39245
|
}
|
38907
39246
|
},
|
38908
39247
|
{
|
38909
|
-
"name": "
|
39248
|
+
"name": "disable-aria-haspopup",
|
38910
39249
|
"type": {
|
38911
39250
|
"text": "boolean"
|
38912
39251
|
},
|
38913
|
-
"description": "
|
39252
|
+
"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.",
|
38914
39253
|
"default": "false",
|
38915
|
-
"fieldName": "
|
39254
|
+
"fieldName": "disableAriaHasPopup",
|
38916
39255
|
"inheritedFrom": {
|
38917
39256
|
"name": "Popover",
|
38918
39257
|
"module": "src/components/popover/popover.component.ts"
|
38919
39258
|
}
|
38920
39259
|
},
|
38921
39260
|
{
|
38922
|
-
"name": "
|
39261
|
+
"name": "keep-connected-tooltip-closed",
|
38923
39262
|
"type": {
|
38924
39263
|
"text": "boolean"
|
38925
39264
|
},
|
38926
|
-
"description": "
|
38927
|
-
"
|
38928
|
-
"
|
39265
|
+
"description": "If a tooltip is connected to the same trigger element,\nthis property will keep the connected tooltip closed if this popover is open.\nThis is useful when you want to show a popover with a tooltip\nbut you don't want the tooltip to be shown at the same time.",
|
39266
|
+
"fieldName": "keepConnectedTooltipClosed",
|
39267
|
+
"inheritedFrom": {
|
39268
|
+
"name": "Popover",
|
39269
|
+
"module": "src/components/popover/popover.component.ts"
|
39270
|
+
}
|
39271
|
+
}
|
39272
|
+
],
|
39273
|
+
"superclass": {
|
39274
|
+
"name": "Popover",
|
39275
|
+
"module": "/src/components/popover/popover.component"
|
39276
|
+
},
|
39277
|
+
"tagName": "mdc-tooltip",
|
39278
|
+
"jsDoc": "/**\n * A tooltip is triggered by mouse hover or by keyboard focus\n * and will disappear upon mouse exit or focus change.\n *\n * Note: Tooltips cannot contain content that can be focused or interacted with.\n *\n * @tagname mdc-tooltip\n *\n * @event shown - (React: onShown) This event is dispatched when the tooltip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the tooltip is hidden\n * @event created - (React: onCreated) This event is dispatched when the tooltip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the tooltip is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-tooltip-max-width - The maximum width of the tooltip.\n * @cssproperty --mdc-tooltip-padding - The padding of the tooltip.\n * @cssproperty --mdc-tooltip-text-color - The text color of the tooltip.\n * @cssproperty --mdc-tooltip-text-color-contrast - The text color of the tooltip when the color is contrast.\n *\n */",
|
39279
|
+
"customElement": true,
|
39280
|
+
"slots": [
|
39281
|
+
{
|
39282
|
+
"description": "Default slot for the popover content",
|
39283
|
+
"name": "",
|
38929
39284
|
"inheritedFrom": {
|
38930
39285
|
"name": "Popover",
|
38931
39286
|
"module": "src/components/popover/popover.component.ts"
|
38932
39287
|
}
|
39288
|
+
}
|
39289
|
+
]
|
39290
|
+
}
|
39291
|
+
],
|
39292
|
+
"exports": [
|
39293
|
+
{
|
39294
|
+
"kind": "js",
|
39295
|
+
"name": "default",
|
39296
|
+
"declaration": {
|
39297
|
+
"name": "Tooltip",
|
39298
|
+
"module": "components/tooltip/tooltip.component.js"
|
39299
|
+
}
|
39300
|
+
}
|
39301
|
+
]
|
39302
|
+
},
|
39303
|
+
{
|
39304
|
+
"kind": "javascript-module",
|
39305
|
+
"path": "components/typewriter/typewriter.component.js",
|
39306
|
+
"declarations": [
|
39307
|
+
{
|
39308
|
+
"kind": "class",
|
39309
|
+
"description": "Typewriter component that creates a typewriter effect on text content.\nIt uses the Text component internally, adding a progressive typing effect.\n\nThe `type` attribute allows changing the text style (passed to the internal Text component).\nThe `tagname` attribute allows changing the tag name of the text element (passed to the internal Text component).\nThe default tag name is `p`.\n\nThe `speed` attribute controls typing speed in milliseconds per character:\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds\n\nAdvanced features:\n- Dynamic speed adjustment during typing\n- Chunked text addition via addTextChunk() method\n- Instant text addition via addInstantTextChunk() method or instant parameter\n- Mixed instant and animated chunks in queue\n- Continues typing in background tabs\n- Performance optimized for large text\n- maxQueueSize to limit memory usage from excessive queuing\n- event handling for typing completion and content changes\n\nThe component includes accessibility features:\n- Screen readers announce the complete text, not character by character\n- Uses aria-live=\"polite\" for dynamic content updates\n- Sets aria-busy during typing animation",
|
39310
|
+
"name": "Typewriter",
|
39311
|
+
"cssParts": [
|
39312
|
+
{
|
39313
|
+
"description": "Container for the text element",
|
39314
|
+
"name": "container"
|
39315
|
+
},
|
39316
|
+
{
|
39317
|
+
"description": "The text element (forwarded to mdc-text)",
|
39318
|
+
"name": "text"
|
39319
|
+
}
|
39320
|
+
],
|
39321
|
+
"slots": [
|
39322
|
+
{
|
39323
|
+
"description": "Default slot for text content",
|
39324
|
+
"name": ""
|
39325
|
+
}
|
39326
|
+
],
|
39327
|
+
"members": [
|
39328
|
+
{
|
39329
|
+
"kind": "field",
|
39330
|
+
"name": "type",
|
39331
|
+
"type": {
|
39332
|
+
"text": "TextType"
|
39333
|
+
},
|
39334
|
+
"privacy": "public",
|
39335
|
+
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
39336
|
+
"default": "body-large-regular",
|
39337
|
+
"attribute": "type",
|
39338
|
+
"reflects": true
|
39339
|
+
},
|
39340
|
+
{
|
39341
|
+
"kind": "field",
|
39342
|
+
"name": "tagname",
|
39343
|
+
"type": {
|
39344
|
+
"text": "TagName | undefined"
|
39345
|
+
},
|
39346
|
+
"privacy": "public",
|
39347
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the internal text element.\n\nAcceptable values include all valid tag names from the Text component.",
|
39348
|
+
"attribute": "tagname",
|
39349
|
+
"reflects": true
|
39350
|
+
},
|
39351
|
+
{
|
39352
|
+
"kind": "field",
|
39353
|
+
"name": "speed",
|
39354
|
+
"type": {
|
39355
|
+
"text": "TypewriterSpeed"
|
39356
|
+
},
|
39357
|
+
"privacy": "public",
|
39358
|
+
"description": "Speed of the typewriter effect in milliseconds per character.\nCan be a string preset or a numeric string in milliseconds.\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds (e.g., '100')",
|
39359
|
+
"default": "'normal' (60ms per character)",
|
39360
|
+
"attribute": "speed",
|
39361
|
+
"reflects": true
|
39362
|
+
},
|
39363
|
+
{
|
39364
|
+
"kind": "field",
|
39365
|
+
"name": "maxQueueSize",
|
39366
|
+
"type": {
|
39367
|
+
"text": "number"
|
39368
|
+
},
|
39369
|
+
"privacy": "public",
|
39370
|
+
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
39371
|
+
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
39372
|
+
"attribute": "max-queue-size",
|
39373
|
+
"reflects": true
|
39374
|
+
},
|
39375
|
+
{
|
39376
|
+
"kind": "method",
|
39377
|
+
"name": "createTimeout",
|
39378
|
+
"privacy": "private",
|
39379
|
+
"return": {
|
39380
|
+
"type": {
|
39381
|
+
"text": "number"
|
39382
|
+
}
|
39383
|
+
},
|
39384
|
+
"parameters": [
|
39385
|
+
{
|
39386
|
+
"name": "callback",
|
39387
|
+
"type": {
|
39388
|
+
"text": "() => void"
|
39389
|
+
}
|
39390
|
+
},
|
39391
|
+
{
|
39392
|
+
"name": "delay",
|
39393
|
+
"type": {
|
39394
|
+
"text": "number"
|
39395
|
+
}
|
39396
|
+
}
|
39397
|
+
],
|
39398
|
+
"description": "Helper to create tracked setTimeout that will be cleaned up on disconnect"
|
39399
|
+
},
|
39400
|
+
{
|
39401
|
+
"kind": "method",
|
39402
|
+
"name": "clearAllTimeouts",
|
39403
|
+
"privacy": "private",
|
39404
|
+
"return": {
|
39405
|
+
"type": {
|
39406
|
+
"text": "void"
|
39407
|
+
}
|
39408
|
+
},
|
39409
|
+
"description": "Clear all pending timeouts"
|
39410
|
+
},
|
39411
|
+
{
|
39412
|
+
"kind": "method",
|
39413
|
+
"name": "clearQueue",
|
39414
|
+
"privacy": "public",
|
39415
|
+
"return": {
|
39416
|
+
"type": {
|
39417
|
+
"text": "void"
|
39418
|
+
}
|
39419
|
+
},
|
39420
|
+
"description": "Clears the text chunk queue and stops processing\nUseful for resetting the component state"
|
39421
|
+
},
|
39422
|
+
{
|
39423
|
+
"kind": "method",
|
39424
|
+
"name": "addTextChunk",
|
39425
|
+
"privacy": "public",
|
39426
|
+
"return": {
|
39427
|
+
"type": {
|
39428
|
+
"text": "void"
|
39429
|
+
}
|
39430
|
+
},
|
39431
|
+
"parameters": [
|
39432
|
+
{
|
39433
|
+
"name": "text",
|
39434
|
+
"type": {
|
39435
|
+
"text": "string"
|
39436
|
+
},
|
39437
|
+
"description": "The text to add"
|
39438
|
+
},
|
39439
|
+
{
|
39440
|
+
"name": "speed",
|
39441
|
+
"optional": true,
|
39442
|
+
"type": {
|
39443
|
+
"text": "TypewriterSpeed"
|
39444
|
+
},
|
39445
|
+
"description": "Optional speed override for this chunk"
|
39446
|
+
},
|
39447
|
+
{
|
39448
|
+
"name": "instant",
|
39449
|
+
"optional": true,
|
39450
|
+
"type": {
|
39451
|
+
"text": "boolean"
|
39452
|
+
},
|
39453
|
+
"description": "If true, text appears instantly without animation"
|
39454
|
+
}
|
39455
|
+
],
|
39456
|
+
"description": "Adds a chunk of text to be typed out, optionally with a different speed"
|
39457
|
+
},
|
39458
|
+
{
|
39459
|
+
"kind": "method",
|
39460
|
+
"name": "addInstantTextChunk",
|
39461
|
+
"privacy": "public",
|
39462
|
+
"return": {
|
39463
|
+
"type": {
|
39464
|
+
"text": "void"
|
39465
|
+
}
|
39466
|
+
},
|
39467
|
+
"parameters": [
|
39468
|
+
{
|
39469
|
+
"name": "text",
|
39470
|
+
"type": {
|
39471
|
+
"text": "string"
|
39472
|
+
},
|
39473
|
+
"description": "The text to add instantly"
|
39474
|
+
}
|
39475
|
+
],
|
39476
|
+
"description": "Adds a chunk of text instantly without typing animation"
|
39477
|
+
},
|
39478
|
+
{
|
39479
|
+
"kind": "method",
|
39480
|
+
"name": "processChunkQueue",
|
39481
|
+
"privacy": "private",
|
39482
|
+
"return": {
|
39483
|
+
"type": {
|
39484
|
+
"text": "void"
|
39485
|
+
}
|
39486
|
+
},
|
39487
|
+
"description": "Processes all chunks in the queue"
|
39488
|
+
},
|
39489
|
+
{
|
39490
|
+
"kind": "method",
|
39491
|
+
"name": "processNextChunk",
|
39492
|
+
"privacy": "private",
|
39493
|
+
"return": {
|
39494
|
+
"type": {
|
39495
|
+
"text": "void"
|
39496
|
+
}
|
39497
|
+
},
|
39498
|
+
"description": "Processes the next chunk in the queue"
|
39499
|
+
},
|
39500
|
+
{
|
39501
|
+
"kind": "method",
|
39502
|
+
"name": "getTypingDelayMs",
|
39503
|
+
"privacy": "private",
|
39504
|
+
"return": {
|
39505
|
+
"type": {
|
39506
|
+
"text": "number"
|
39507
|
+
}
|
39508
|
+
},
|
39509
|
+
"description": "Gets the typing delay in milliseconds per character"
|
39510
|
+
},
|
39511
|
+
{
|
39512
|
+
"kind": "method",
|
39513
|
+
"name": "captureAndProcessContent",
|
39514
|
+
"privacy": "private",
|
39515
|
+
"return": {
|
39516
|
+
"type": {
|
39517
|
+
"text": "void"
|
39518
|
+
}
|
39519
|
+
},
|
39520
|
+
"description": "Captures slot content and starts typewriter animation"
|
39521
|
+
},
|
39522
|
+
{
|
39523
|
+
"kind": "method",
|
39524
|
+
"name": "startTypingAnimation",
|
39525
|
+
"privacy": "private",
|
39526
|
+
"return": {
|
39527
|
+
"type": {
|
39528
|
+
"text": "void"
|
39529
|
+
}
|
39530
|
+
},
|
39531
|
+
"parameters": [
|
39532
|
+
{
|
39533
|
+
"name": "onComplete",
|
39534
|
+
"optional": true,
|
39535
|
+
"type": {
|
39536
|
+
"text": "() => void"
|
39537
|
+
}
|
39538
|
+
}
|
39539
|
+
],
|
39540
|
+
"description": "Starts the typewriter animation"
|
38933
39541
|
},
|
38934
39542
|
{
|
38935
|
-
"
|
38936
|
-
"
|
38937
|
-
|
39543
|
+
"kind": "method",
|
39544
|
+
"name": "clearTypingAnimation",
|
39545
|
+
"privacy": "private",
|
39546
|
+
"return": {
|
39547
|
+
"type": {
|
39548
|
+
"text": "void"
|
39549
|
+
}
|
38938
39550
|
},
|
38939
|
-
"description": "
|
38940
|
-
"default": "false",
|
38941
|
-
"fieldName": "closeButton",
|
38942
|
-
"inheritedFrom": {
|
38943
|
-
"name": "Popover",
|
38944
|
-
"module": "src/components/popover/popover.component.ts"
|
38945
|
-
}
|
39551
|
+
"description": "Clears the typing animation timeout"
|
38946
39552
|
},
|
38947
39553
|
{
|
38948
|
-
"
|
38949
|
-
"
|
38950
|
-
|
39554
|
+
"kind": "method",
|
39555
|
+
"name": "handleSlotChange",
|
39556
|
+
"privacy": "private",
|
39557
|
+
"return": {
|
39558
|
+
"type": {
|
39559
|
+
"text": "void"
|
39560
|
+
}
|
38951
39561
|
},
|
38952
|
-
"description": "
|
38953
|
-
|
38954
|
-
|
38955
|
-
|
38956
|
-
"name": "Popover",
|
38957
|
-
"module": "src/components/popover/popover.component.ts"
|
38958
|
-
}
|
38959
|
-
},
|
39562
|
+
"description": "Handler for slotchange event"
|
39563
|
+
}
|
39564
|
+
],
|
39565
|
+
"events": [
|
38960
39566
|
{
|
38961
|
-
"name": "delay",
|
38962
39567
|
"type": {
|
38963
|
-
"text": "
|
38964
|
-
},
|
38965
|
-
"description": "The delay of the show/hide popover.",
|
38966
|
-
"default": "0,0",
|
38967
|
-
"fieldName": "delay",
|
38968
|
-
"inheritedFrom": {
|
38969
|
-
"name": "Popover",
|
38970
|
-
"module": "src/components/popover/popover.component.ts"
|
39568
|
+
"text": "CustomEvent"
|
38971
39569
|
}
|
38972
39570
|
},
|
38973
39571
|
{
|
38974
|
-
"
|
38975
|
-
"
|
38976
|
-
|
38977
|
-
},
|
38978
|
-
"description": "Hide popover on escape key press.",
|
38979
|
-
"default": "false",
|
38980
|
-
"fieldName": "hideOnEscape",
|
38981
|
-
"inheritedFrom": {
|
38982
|
-
"name": "Popover",
|
38983
|
-
"module": "src/components/popover/popover.component.ts"
|
38984
|
-
}
|
39572
|
+
"description": "(React: onTypingComplete) Fired when the typewriter finishes typing all content. Detail: \\{ finalContent: string \\}",
|
39573
|
+
"name": "typing-complete",
|
39574
|
+
"reactName": "onTypingComplete"
|
38985
39575
|
},
|
38986
39576
|
{
|
38987
|
-
"
|
38988
|
-
"
|
38989
|
-
|
38990
|
-
|
38991
|
-
|
38992
|
-
|
38993
|
-
"fieldName": "propagateEventOnEscape",
|
38994
|
-
"inheritedFrom": {
|
38995
|
-
"name": "Popover",
|
38996
|
-
"module": "src/components/popover/popover.component.ts"
|
38997
|
-
}
|
38998
|
-
},
|
39577
|
+
"description": "(React: onChange) Fired when the content of the typewriter changes. Detail: \\{ content: string, isTyping: boolean \\}",
|
39578
|
+
"name": "change",
|
39579
|
+
"reactName": "onChange"
|
39580
|
+
}
|
39581
|
+
],
|
39582
|
+
"attributes": [
|
38999
39583
|
{
|
39000
|
-
"name": "
|
39584
|
+
"name": "type",
|
39001
39585
|
"type": {
|
39002
|
-
"text": "
|
39586
|
+
"text": "TextType"
|
39003
39587
|
},
|
39004
|
-
"description": "
|
39005
|
-
"default": "
|
39006
|
-
"fieldName": "
|
39007
|
-
"inheritedFrom": {
|
39008
|
-
"name": "Popover",
|
39009
|
-
"module": "src/components/popover/popover.component.ts"
|
39010
|
-
}
|
39588
|
+
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
39589
|
+
"default": "body-large-regular",
|
39590
|
+
"fieldName": "type"
|
39011
39591
|
},
|
39012
39592
|
{
|
39013
|
-
"name": "
|
39593
|
+
"name": "tagname",
|
39014
39594
|
"type": {
|
39015
|
-
"text": "
|
39595
|
+
"text": "TagName | undefined"
|
39016
39596
|
},
|
39017
|
-
"description": "
|
39018
|
-
"
|
39019
|
-
"fieldName": "hideOnOutsideClick",
|
39020
|
-
"inheritedFrom": {
|
39021
|
-
"name": "Popover",
|
39022
|
-
"module": "src/components/popover/popover.component.ts"
|
39023
|
-
}
|
39597
|
+
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the internal text element.\n\nAcceptable values include all valid tag names from the Text component.",
|
39598
|
+
"fieldName": "tagname"
|
39024
39599
|
},
|
39025
39600
|
{
|
39026
|
-
"name": "
|
39601
|
+
"name": "speed",
|
39027
39602
|
"type": {
|
39028
|
-
"text": "
|
39603
|
+
"text": "TypewriterSpeed"
|
39029
39604
|
},
|
39030
|
-
"description": "
|
39031
|
-
"default": "
|
39032
|
-
"fieldName": "
|
39033
|
-
"inheritedFrom": {
|
39034
|
-
"name": "Popover",
|
39035
|
-
"module": "src/components/popover/popover.component.ts"
|
39036
|
-
}
|
39605
|
+
"description": "Speed of the typewriter effect in milliseconds per character.\nCan be a string preset or a numeric string in milliseconds.\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds (e.g., '100')",
|
39606
|
+
"default": "'normal' (60ms per character)",
|
39607
|
+
"fieldName": "speed"
|
39037
39608
|
},
|
39038
39609
|
{
|
39039
|
-
"name": "
|
39610
|
+
"name": "max-queue-size",
|
39040
39611
|
"type": {
|
39041
|
-
"text": "
|
39612
|
+
"text": "number"
|
39042
39613
|
},
|
39043
|
-
"description": "
|
39044
|
-
"default": "
|
39045
|
-
"fieldName": "
|
39046
|
-
|
39047
|
-
|
39048
|
-
|
39049
|
-
|
39050
|
-
|
39614
|
+
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
39615
|
+
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
39616
|
+
"fieldName": "maxQueueSize"
|
39617
|
+
}
|
39618
|
+
],
|
39619
|
+
"superclass": {
|
39620
|
+
"name": "Component",
|
39621
|
+
"module": "/src/models"
|
39622
|
+
},
|
39623
|
+
"tagName": "mdc-typewriter",
|
39624
|
+
"jsDoc": "/**\n * Typewriter component that creates a typewriter effect on text content.\n * It uses the Text component internally, adding a progressive typing effect.\n *\n * The `type` attribute allows changing the text style (passed to the internal Text component).\n * The `tagname` attribute allows changing the tag name of the text element (passed to the internal Text component).\n * The default tag name is `p`.\n *\n * The `speed` attribute controls typing speed in milliseconds per character:\n * - 'very-slow' = 240ms per character\n * - 'slow' = 120ms per character\n * - 'normal' = 60ms per character (default)\n * - 'fast' = 20ms per character\n * - 'very-fast' = 1ms per character\n * - Or any numeric string representing milliseconds\n *\n * Advanced features:\n * - Dynamic speed adjustment during typing\n * - Chunked text addition via addTextChunk() method\n * - Instant text addition via addInstantTextChunk() method or instant parameter\n * - Mixed instant and animated chunks in queue\n * - Continues typing in background tabs\n * - Performance optimized for large text\n * - maxQueueSize to limit memory usage from excessive queuing\n * - event handling for typing completion and content changes\n *\n * The component includes accessibility features:\n * - Screen readers announce the complete text, not character by character\n * - Uses aria-live=\"polite\" for dynamic content updates\n * - Sets aria-busy during typing animation\n *\n * @dependency mdc-text\n *\n * @tagname mdc-typewriter\n * @slot - Default slot for text content\n *\n * @csspart container - Container for the text element\n * @csspart text - The text element (forwarded to mdc-text)\n *\n * @event typing-complete - (React: onTypingComplete) Fired when the typewriter finishes typing all content.\n * Detail: \\{ finalContent: string \\}\n * @event change - (React: onChange) Fired when the content of the typewriter changes.\n * Detail: \\{ content: string, isTyping: boolean \\}\n */",
|
39625
|
+
"customElement": true
|
39626
|
+
}
|
39627
|
+
],
|
39628
|
+
"exports": [
|
39629
|
+
{
|
39630
|
+
"kind": "js",
|
39631
|
+
"name": "default",
|
39632
|
+
"declaration": {
|
39633
|
+
"name": "Typewriter",
|
39634
|
+
"module": "components/typewriter/typewriter.component.js"
|
39635
|
+
}
|
39636
|
+
}
|
39637
|
+
]
|
39638
|
+
},
|
39639
|
+
{
|
39640
|
+
"kind": "javascript-module",
|
39641
|
+
"path": "components/virtualizedlist/virtualizedlist.component.js",
|
39642
|
+
"declarations": [
|
39643
|
+
{
|
39644
|
+
"kind": "class",
|
39645
|
+
"description": "`mdc-virtualizedlist` component for creating custom virtualized lists.\nIMPORTANT: This component does not create it's own list/list items.\nUse the setlistdata callback prop to update client state in order to\nPass list/listitems as a child of this component, which this will virtuailze\nThis implementation handles dynamic lists as well as fixed sized lists.\nPlease refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.",
|
39646
|
+
"name": "VirtualizedList",
|
39647
|
+
"slots": [
|
39051
39648
|
{
|
39052
|
-
"
|
39053
|
-
"
|
39054
|
-
|
39055
|
-
|
39056
|
-
|
39057
|
-
"default": "true",
|
39058
|
-
"fieldName": "flip",
|
39059
|
-
"inheritedFrom": {
|
39060
|
-
"name": "Popover",
|
39061
|
-
"module": "src/components/popover/popover.component.ts"
|
39062
|
-
}
|
39063
|
-
},
|
39649
|
+
"description": "Client side List with nested list items.",
|
39650
|
+
"name": ""
|
39651
|
+
}
|
39652
|
+
],
|
39653
|
+
"members": [
|
39064
39654
|
{
|
39065
|
-
"
|
39655
|
+
"kind": "field",
|
39656
|
+
"name": "onscroll",
|
39066
39657
|
"type": {
|
39067
|
-
"text": "
|
39658
|
+
"text": "((this: GlobalEventHandlers, ev: Event) => void) | null"
|
39068
39659
|
},
|
39069
|
-
"description": "
|
39070
|
-
"default": "
|
39071
|
-
"
|
39072
|
-
"inheritedFrom": {
|
39073
|
-
"name": "Popover",
|
39074
|
-
"module": "src/components/popover/popover.component.ts"
|
39075
|
-
}
|
39660
|
+
"description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
|
39661
|
+
"default": "null",
|
39662
|
+
"attribute": "onscroll"
|
39076
39663
|
},
|
39077
39664
|
{
|
39078
|
-
"
|
39665
|
+
"kind": "field",
|
39666
|
+
"name": "virtualizerProps",
|
39079
39667
|
"type": {
|
39080
|
-
"text": "
|
39668
|
+
"text": "VirtualizerProps"
|
39081
39669
|
},
|
39082
|
-
"description": "The
|
39083
|
-
"
|
39084
|
-
"fieldName": "zIndex",
|
39085
|
-
"inheritedFrom": {
|
39086
|
-
"name": "Popover",
|
39087
|
-
"module": "src/components/popover/popover.component.ts"
|
39088
|
-
}
|
39670
|
+
"description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
|
39671
|
+
"attribute": "virtualizerprops"
|
39089
39672
|
},
|
39090
39673
|
{
|
39091
|
-
"
|
39674
|
+
"kind": "field",
|
39675
|
+
"name": "setlistdata",
|
39092
39676
|
"type": {
|
39093
|
-
"text": "
|
39677
|
+
"text": "(({ virtualItems, measureElement, listStyle }: SetListDataProps) => void) | null"
|
39094
39678
|
},
|
39095
|
-
"description": "
|
39096
|
-
"default": "
|
39097
|
-
"
|
39098
|
-
"inheritedFrom": {
|
39099
|
-
"name": "Popover",
|
39100
|
-
"module": "src/components/popover/popover.component.ts"
|
39101
|
-
}
|
39679
|
+
"description": "Callback that gets envoked when updates to the virtualizer interally occur.\nThis must be implemented in such a way that this function will trigger update to parent.\n\nvirtualItems - Array that will be what the client displays on screen. Use this to render\na List of your choosing with these items nested inside as your ListItems.\nmeasureElement - Ref to pass to each ListItem rendered client side.\nEach ListItem should also be be passed key and a data-index (which can be found on the virtualItem).\nlistStyle - This should be passed as the style attribute to your List.",
|
39680
|
+
"default": "null",
|
39681
|
+
"attribute": "setlistdata"
|
39102
39682
|
},
|
39103
39683
|
{
|
39104
|
-
"
|
39684
|
+
"kind": "field",
|
39685
|
+
"name": "scrollElementRef",
|
39105
39686
|
"type": {
|
39106
|
-
"text": "
|
39687
|
+
"text": "Ref<HTMLDivElement>"
|
39107
39688
|
},
|
39108
|
-
"
|
39109
|
-
"description": "aria-label attribute to be set for close button accessibility.",
|
39110
|
-
"fieldName": "closeButtonAriaLabel",
|
39111
|
-
"inheritedFrom": {
|
39112
|
-
"name": "Popover",
|
39113
|
-
"module": "src/components/popover/popover.component.ts"
|
39114
|
-
}
|
39689
|
+
"privacy": "public"
|
39115
39690
|
},
|
39116
39691
|
{
|
39117
|
-
"
|
39692
|
+
"kind": "field",
|
39693
|
+
"name": "virtualizer",
|
39118
39694
|
"type": {
|
39119
|
-
"text": "
|
39695
|
+
"text": "Virtualizer<Element, Element> | null"
|
39120
39696
|
},
|
39121
|
-
"
|
39122
|
-
"default": "
|
39123
|
-
"fieldName": "role",
|
39124
|
-
"inheritedFrom": {
|
39125
|
-
"name": "Popover",
|
39126
|
-
"module": "src/components/popover/popover.component.ts"
|
39127
|
-
}
|
39697
|
+
"privacy": "public",
|
39698
|
+
"default": "null"
|
39128
39699
|
},
|
39129
39700
|
{
|
39130
|
-
"
|
39701
|
+
"kind": "field",
|
39702
|
+
"name": "virtualItems",
|
39131
39703
|
"type": {
|
39132
|
-
"text": "
|
39704
|
+
"text": "Array<VirtualItem>"
|
39133
39705
|
},
|
39134
|
-
"
|
39135
|
-
"
|
39136
|
-
"fieldName": "ariaLabelledby",
|
39137
|
-
"inheritedFrom": {
|
39138
|
-
"name": "Popover",
|
39139
|
-
"module": "src/components/popover/popover.component.ts"
|
39140
|
-
}
|
39706
|
+
"privacy": "public",
|
39707
|
+
"default": "[]"
|
39141
39708
|
},
|
39142
39709
|
{
|
39143
|
-
"
|
39710
|
+
"kind": "field",
|
39711
|
+
"name": "virtualizerController",
|
39144
39712
|
"type": {
|
39145
|
-
"text": "
|
39713
|
+
"text": "null"
|
39146
39714
|
},
|
39147
|
-
"default": "null"
|
39148
|
-
|
39149
|
-
|
39150
|
-
|
39151
|
-
"name": "Popover",
|
39152
|
-
"module": "src/components/popover/popover.component.ts"
|
39153
|
-
}
|
39154
|
-
},
|
39715
|
+
"default": "null"
|
39716
|
+
}
|
39717
|
+
],
|
39718
|
+
"events": [
|
39155
39719
|
{
|
39156
|
-
"
|
39720
|
+
"description": "(React: onScroll) Event that gets called when user scrolls inside of list.",
|
39721
|
+
"name": "onscroll",
|
39722
|
+
"reactName": "onScroll"
|
39723
|
+
}
|
39724
|
+
],
|
39725
|
+
"attributes": [
|
39726
|
+
{
|
39727
|
+
"name": "onscroll",
|
39157
39728
|
"type": {
|
39158
|
-
"text": "
|
39729
|
+
"text": "((this: GlobalEventHandlers, ev: Event) => void) | null"
|
39159
39730
|
},
|
39160
|
-
"description": "
|
39161
|
-
"default": "
|
39162
|
-
"fieldName": "
|
39163
|
-
"inheritedFrom": {
|
39164
|
-
"name": "Popover",
|
39165
|
-
"module": "src/components/popover/popover.component.ts"
|
39166
|
-
}
|
39731
|
+
"description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
|
39732
|
+
"default": "null",
|
39733
|
+
"fieldName": "onscroll"
|
39167
39734
|
},
|
39168
39735
|
{
|
39169
|
-
"name": "
|
39736
|
+
"name": "virtualizerprops",
|
39170
39737
|
"type": {
|
39171
|
-
"text": "
|
39738
|
+
"text": "VirtualizerProps"
|
39172
39739
|
},
|
39173
|
-
"description": "
|
39174
|
-
"
|
39175
|
-
"fieldName": "disableAriaHasPopup",
|
39176
|
-
"inheritedFrom": {
|
39177
|
-
"name": "Popover",
|
39178
|
-
"module": "src/components/popover/popover.component.ts"
|
39179
|
-
}
|
39740
|
+
"description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
|
39741
|
+
"fieldName": "virtualizerProps"
|
39180
39742
|
},
|
39181
39743
|
{
|
39182
|
-
"name": "
|
39744
|
+
"name": "setlistdata",
|
39183
39745
|
"type": {
|
39184
|
-
"text": "
|
39746
|
+
"text": "(({ virtualItems, measureElement, listStyle }: SetListDataProps) => void) | null"
|
39185
39747
|
},
|
39186
|
-
"description": "
|
39187
|
-
"
|
39188
|
-
"
|
39189
|
-
"name": "Popover",
|
39190
|
-
"module": "src/components/popover/popover.component.ts"
|
39191
|
-
}
|
39748
|
+
"description": "Callback that gets envoked when updates to the virtualizer interally occur.\nThis must be implemented in such a way that this function will trigger update to parent.\n\nvirtualItems - Array that will be what the client displays on screen. Use this to render\na List of your choosing with these items nested inside as your ListItems.\nmeasureElement - Ref to pass to each ListItem rendered client side.\nEach ListItem should also be be passed key and a data-index (which can be found on the virtualItem).\nlistStyle - This should be passed as the style attribute to your List.",
|
39749
|
+
"default": "null",
|
39750
|
+
"fieldName": "setlistdata"
|
39192
39751
|
}
|
39193
39752
|
],
|
39194
39753
|
"superclass": {
|
39195
|
-
"name": "
|
39196
|
-
"module": "/src/
|
39754
|
+
"name": "Component",
|
39755
|
+
"module": "/src/models"
|
39197
39756
|
},
|
39198
|
-
"tagName": "mdc-
|
39199
|
-
"jsDoc": "/**\n *
|
39757
|
+
"tagName": "mdc-virtualizedlist",
|
39758
|
+
"jsDoc": "/**\n * `mdc-virtualizedlist` component for creating custom virtualized lists.\n * IMPORTANT: This component does not create it's own list/list items.\n * Use the setlistdata callback prop to update client state in order to\n * Pass list/listitems as a child of this component, which this will virtuailze\n * This implementation handles dynamic lists as well as fixed sized lists.\n * Please refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.\n *\n * @tagname mdc-virtualizedlist\n *\n * @event onscroll - (React: onScroll) Event that gets called when user scrolls inside of list.\n *\n * @slot - Client side List with nested list items.\n */",
|
39200
39759
|
"customElement": true
|
39201
39760
|
}
|
39202
39761
|
],
|
@@ -39205,36 +39764,32 @@
|
|
39205
39764
|
"kind": "js",
|
39206
39765
|
"name": "default",
|
39207
39766
|
"declaration": {
|
39208
|
-
"name": "
|
39209
|
-
"module": "components/
|
39767
|
+
"name": "VirtualizedList",
|
39768
|
+
"module": "components/virtualizedlist/virtualizedlist.component.js"
|
39210
39769
|
}
|
39211
39770
|
}
|
39212
39771
|
]
|
39213
39772
|
},
|
39214
39773
|
{
|
39215
39774
|
"kind": "javascript-module",
|
39216
|
-
"path": "components/
|
39775
|
+
"path": "components/toggletip/toggletip.component.js",
|
39217
39776
|
"declarations": [
|
39218
39777
|
{
|
39219
39778
|
"kind": "class",
|
39220
|
-
"description": "A
|
39221
|
-
"name": "
|
39779
|
+
"description": "A toggletip is triggered by clicking a trigger element.\n\nIt can contain interactive content and can be closed by\nclicking outside the toggletip or pressing the escape key.\n\nIt can have optional close button to close the toggletip.\n\nToggletip component uses `mdc-screenreaderannouncer` internally to\nannounce the toggletip text content with screen readers when the toggletip is shown.\n\n`screenreader-announcer-identity` attribute can be used to provide ID of an element\nin DOM to which announcement elements are added. If not set, a visually hidden\ndiv element is created in DOM to which announcement elements are added.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
39780
|
+
"name": "ToggleTip",
|
39222
39781
|
"cssProperties": [
|
39223
39782
|
{
|
39224
|
-
"description": "The maximum width of the
|
39225
|
-
"name": "--mdc-
|
39226
|
-
},
|
39227
|
-
{
|
39228
|
-
"description": "The padding of the tooltip.",
|
39229
|
-
"name": "--mdc-tooltip-padding"
|
39783
|
+
"description": "The maximum width of the toggletip.",
|
39784
|
+
"name": "--mdc-toggletip-max-width"
|
39230
39785
|
},
|
39231
39786
|
{
|
39232
|
-
"description": "The text color of the
|
39233
|
-
"name": "--mdc-
|
39787
|
+
"description": "The text color of the toggletip.",
|
39788
|
+
"name": "--mdc-toggletip-text-color"
|
39234
39789
|
},
|
39235
39790
|
{
|
39236
|
-
"description": "The text color of the
|
39237
|
-
"name": "--mdc-
|
39791
|
+
"description": "The text color of the toggletip when the color is contrast.",
|
39792
|
+
"name": "--mdc-toggletip-text-color-contrast"
|
39238
39793
|
},
|
39239
39794
|
{
|
39240
39795
|
"description": "radius of the arrow border",
|
@@ -39317,18 +39872,17 @@
|
|
39317
39872
|
}
|
39318
39873
|
}
|
39319
39874
|
],
|
39320
|
-
"
|
39875
|
+
"slots": [
|
39321
39876
|
{
|
39322
|
-
"
|
39323
|
-
"name": "
|
39324
|
-
"
|
39325
|
-
"
|
39326
|
-
|
39327
|
-
|
39328
|
-
|
39329
|
-
|
39330
|
-
|
39331
|
-
},
|
39877
|
+
"description": "Default slot for the toggletip content",
|
39878
|
+
"name": "",
|
39879
|
+
"inheritedFrom": {
|
39880
|
+
"name": "Popover",
|
39881
|
+
"module": "src/components/popover/popover.component.ts"
|
39882
|
+
}
|
39883
|
+
}
|
39884
|
+
],
|
39885
|
+
"members": [
|
39332
39886
|
{
|
39333
39887
|
"kind": "field",
|
39334
39888
|
"name": "defaultSlotNodes",
|
@@ -39338,76 +39892,50 @@
|
|
39338
39892
|
"privacy": "private"
|
39339
39893
|
},
|
39340
39894
|
{
|
39341
|
-
"kind": "
|
39342
|
-
"name": "
|
39343
|
-
"
|
39344
|
-
|
39345
|
-
"type": {
|
39346
|
-
"text": ""
|
39347
|
-
}
|
39348
|
-
}
|
39349
|
-
},
|
39350
|
-
{
|
39351
|
-
"kind": "method",
|
39352
|
-
"name": "setTooltipType",
|
39353
|
-
"privacy": "private",
|
39354
|
-
"return": {
|
39355
|
-
"type": {
|
39356
|
-
"text": "void"
|
39357
|
-
}
|
39895
|
+
"kind": "field",
|
39896
|
+
"name": "screenreaderAnnouncerIdentity",
|
39897
|
+
"type": {
|
39898
|
+
"text": "string | undefined"
|
39358
39899
|
},
|
39359
|
-
"
|
39360
|
-
|
39361
|
-
|
39362
|
-
"type": {
|
39363
|
-
"text": "TooltipType"
|
39364
|
-
},
|
39365
|
-
"description": "The type to set."
|
39366
|
-
}
|
39367
|
-
],
|
39368
|
-
"description": "Sets the type attribute for the tooltip component.\nIf the provided type is not included in the TOOLTIP_TYPES,\nit defaults to the value specified in DEFAULTS.TOOLTIP_TYPE."
|
39900
|
+
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
39901
|
+
"attribute": "screenreader-announcer-identity",
|
39902
|
+
"reflects": true
|
39369
39903
|
},
|
39370
39904
|
{
|
39371
|
-
"kind": "
|
39372
|
-
"name": "
|
39373
|
-
"
|
39374
|
-
|
39375
|
-
"type": {
|
39376
|
-
"text": "Promise<void>"
|
39377
|
-
}
|
39905
|
+
"kind": "field",
|
39906
|
+
"name": "placement",
|
39907
|
+
"type": {
|
39908
|
+
"text": "PopoverPlacement"
|
39378
39909
|
},
|
39379
|
-
"description": "
|
39910
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
39911
|
+
"default": "bottom",
|
39912
|
+
"attribute": "placement",
|
39913
|
+
"reflects": true,
|
39914
|
+
"inheritedFrom": {
|
39915
|
+
"name": "Popover",
|
39916
|
+
"module": "components/popover/popover.component.js"
|
39917
|
+
}
|
39380
39918
|
},
|
39381
39919
|
{
|
39382
39920
|
"kind": "method",
|
39383
|
-
"name": "
|
39921
|
+
"name": "getToggleTipText",
|
39384
39922
|
"privacy": "private",
|
39385
39923
|
"return": {
|
39386
39924
|
"type": {
|
39387
|
-
"text": "
|
39925
|
+
"text": ""
|
39388
39926
|
}
|
39389
|
-
}
|
39390
|
-
"description": "Updates the placement attribute if it is not a valid placement.\nOverriding the default from Popover"
|
39927
|
+
}
|
39391
39928
|
},
|
39392
39929
|
{
|
39393
39930
|
"kind": "method",
|
39394
|
-
"name": "
|
39931
|
+
"name": "onPlacementUpdated",
|
39395
39932
|
"privacy": "private",
|
39396
39933
|
"return": {
|
39397
39934
|
"type": {
|
39398
39935
|
"text": "void"
|
39399
39936
|
}
|
39400
39937
|
},
|
39401
|
-
"
|
39402
|
-
{
|
39403
|
-
"name": "changedProperties",
|
39404
|
-
"type": {
|
39405
|
-
"text": "PropertyValues"
|
39406
|
-
},
|
39407
|
-
"description": "The changed properties."
|
39408
|
-
}
|
39409
|
-
],
|
39410
|
-
"description": "Updates the tooltip type attribute and sets the appropriate aria props on the trigger component."
|
39938
|
+
"description": "Updates the placement attribute if it is not a valid placement.\nDefault placement for toggle tip is top."
|
39411
39939
|
},
|
39412
39940
|
{
|
39413
39941
|
"kind": "field",
|
@@ -40000,21 +40528,6 @@
|
|
40000
40528
|
"module": "components/popover/popover.component.js"
|
40001
40529
|
}
|
40002
40530
|
},
|
40003
|
-
{
|
40004
|
-
"kind": "field",
|
40005
|
-
"name": "placement",
|
40006
|
-
"type": {
|
40007
|
-
"text": "PopoverPlacement"
|
40008
|
-
},
|
40009
|
-
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
40010
|
-
"default": "bottom",
|
40011
|
-
"attribute": "placement",
|
40012
|
-
"reflects": true,
|
40013
|
-
"inheritedFrom": {
|
40014
|
-
"name": "Popover",
|
40015
|
-
"module": "components/popover/popover.component.js"
|
40016
|
-
}
|
40017
|
-
},
|
40018
40531
|
{
|
40019
40532
|
"kind": "field",
|
40020
40533
|
"name": "color",
|
@@ -40694,7 +41207,7 @@
|
|
40694
41207
|
],
|
40695
41208
|
"events": [
|
40696
41209
|
{
|
40697
|
-
"description": "(React: onShown) This event is dispatched when the
|
41210
|
+
"description": "(React: onShown) This event is dispatched when the toggletip is shown",
|
40698
41211
|
"name": "shown",
|
40699
41212
|
"reactName": "onShown",
|
40700
41213
|
"inheritedFrom": {
|
@@ -40703,7 +41216,7 @@
|
|
40703
41216
|
}
|
40704
41217
|
},
|
40705
41218
|
{
|
40706
|
-
"description": "(React: onHidden) This event is dispatched when the
|
41219
|
+
"description": "(React: onHidden) This event is dispatched when the toggletip is hidden",
|
40707
41220
|
"name": "hidden",
|
40708
41221
|
"reactName": "onHidden",
|
40709
41222
|
"inheritedFrom": {
|
@@ -40712,7 +41225,7 @@
|
|
40712
41225
|
}
|
40713
41226
|
},
|
40714
41227
|
{
|
40715
|
-
"description": "(React: onCreated) This event is dispatched when the
|
41228
|
+
"description": "(React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)",
|
40716
41229
|
"name": "created",
|
40717
41230
|
"reactName": "onCreated",
|
40718
41231
|
"inheritedFrom": {
|
@@ -40721,24 +41234,36 @@
|
|
40721
41234
|
}
|
40722
41235
|
},
|
40723
41236
|
{
|
40724
|
-
"description": "(React: onDestroyed) This event is dispatched when the
|
41237
|
+
"description": "(React: onDestroyed) This event is dispatched when the toggletip is destroyed (removed from the DOM)",
|
40725
41238
|
"name": "destroyed",
|
40726
41239
|
"reactName": "onDestroyed",
|
40727
41240
|
"inheritedFrom": {
|
40728
41241
|
"name": "Popover",
|
40729
41242
|
"module": "src/components/popover/popover.component.ts"
|
40730
41243
|
}
|
40731
|
-
}
|
40732
|
-
],
|
40733
|
-
"attributes": [
|
40734
|
-
{
|
40735
|
-
"name": "
|
40736
|
-
"type": {
|
40737
|
-
"text": "
|
40738
|
-
},
|
40739
|
-
"description": "
|
40740
|
-
"
|
40741
|
-
|
41244
|
+
}
|
41245
|
+
],
|
41246
|
+
"attributes": [
|
41247
|
+
{
|
41248
|
+
"name": "screenreader-announcer-identity",
|
41249
|
+
"type": {
|
41250
|
+
"text": "string | undefined"
|
41251
|
+
},
|
41252
|
+
"description": "Set this attribute with the id of the element in the DOM, to which announcement\nelements will be appended.\nIf an id is provided, the announcement elements will be appended to this element.\nIf id is not provided, a visually hidden div element will be created in the DOM.\n\nPlease refer to the `mdc-screenreaderannouncer` component for more details.",
|
41253
|
+
"fieldName": "screenreaderAnnouncerIdentity"
|
41254
|
+
},
|
41255
|
+
{
|
41256
|
+
"name": "placement",
|
41257
|
+
"type": {
|
41258
|
+
"text": "PopoverPlacement"
|
41259
|
+
},
|
41260
|
+
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
41261
|
+
"default": "bottom",
|
41262
|
+
"fieldName": "placement",
|
41263
|
+
"inheritedFrom": {
|
41264
|
+
"name": "Popover",
|
41265
|
+
"module": "src/components/popover/popover.component.ts"
|
41266
|
+
}
|
40742
41267
|
},
|
40743
41268
|
{
|
40744
41269
|
"name": "should-focus-trap-wrap",
|
@@ -40792,19 +41317,6 @@
|
|
40792
41317
|
"module": "src/components/popover/popover.component.ts"
|
40793
41318
|
}
|
40794
41319
|
},
|
40795
|
-
{
|
40796
|
-
"name": "placement",
|
40797
|
-
"type": {
|
40798
|
-
"text": "PopoverPlacement"
|
40799
|
-
},
|
40800
|
-
"description": "The placement of the popover.\n- **top**\n- **top-start**\n- **top-end**\n- **bottom**\n- **bottom-start**\n- **bottom-end**\n- **left**\n- **left-start**\n- **left-end**\n- **right**\n- **right-start**\n- **right-end**",
|
40801
|
-
"default": "bottom",
|
40802
|
-
"fieldName": "placement",
|
40803
|
-
"inheritedFrom": {
|
40804
|
-
"name": "Popover",
|
40805
|
-
"module": "src/components/popover/popover.component.ts"
|
40806
|
-
}
|
40807
|
-
},
|
40808
41320
|
{
|
40809
41321
|
"name": "color",
|
40810
41322
|
"type": {
|
@@ -41186,488 +41698,8 @@
|
|
41186
41698
|
"name": "Popover",
|
41187
41699
|
"module": "/src/components/popover/popover.component"
|
41188
41700
|
},
|
41189
|
-
"tagName": "mdc-
|
41190
|
-
"jsDoc": "/**\n * A
|
41191
|
-
"customElement": true,
|
41192
|
-
"slots": [
|
41193
|
-
{
|
41194
|
-
"description": "Default slot for the popover content",
|
41195
|
-
"name": "",
|
41196
|
-
"inheritedFrom": {
|
41197
|
-
"name": "Popover",
|
41198
|
-
"module": "src/components/popover/popover.component.ts"
|
41199
|
-
}
|
41200
|
-
}
|
41201
|
-
]
|
41202
|
-
}
|
41203
|
-
],
|
41204
|
-
"exports": [
|
41205
|
-
{
|
41206
|
-
"kind": "js",
|
41207
|
-
"name": "default",
|
41208
|
-
"declaration": {
|
41209
|
-
"name": "Tooltip",
|
41210
|
-
"module": "components/tooltip/tooltip.component.js"
|
41211
|
-
}
|
41212
|
-
}
|
41213
|
-
]
|
41214
|
-
},
|
41215
|
-
{
|
41216
|
-
"kind": "javascript-module",
|
41217
|
-
"path": "components/typewriter/typewriter.component.js",
|
41218
|
-
"declarations": [
|
41219
|
-
{
|
41220
|
-
"kind": "class",
|
41221
|
-
"description": "Typewriter component that creates a typewriter effect on text content.\nIt uses the Text component internally, adding a progressive typing effect.\n\nThe `type` attribute allows changing the text style (passed to the internal Text component).\nThe `tagname` attribute allows changing the tag name of the text element (passed to the internal Text component).\nThe default tag name is `p`.\n\nThe `speed` attribute controls typing speed in milliseconds per character:\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds\n\nAdvanced features:\n- Dynamic speed adjustment during typing\n- Chunked text addition via addTextChunk() method\n- Instant text addition via addInstantTextChunk() method or instant parameter\n- Mixed instant and animated chunks in queue\n- Continues typing in background tabs\n- Performance optimized for large text\n- maxQueueSize to limit memory usage from excessive queuing\n- event handling for typing completion and content changes\n\nThe component includes accessibility features:\n- Screen readers announce the complete text, not character by character\n- Uses aria-live=\"polite\" for dynamic content updates\n- Sets aria-busy during typing animation",
|
41222
|
-
"name": "Typewriter",
|
41223
|
-
"cssParts": [
|
41224
|
-
{
|
41225
|
-
"description": "Container for the text element",
|
41226
|
-
"name": "container"
|
41227
|
-
},
|
41228
|
-
{
|
41229
|
-
"description": "The text element (forwarded to mdc-text)",
|
41230
|
-
"name": "text"
|
41231
|
-
}
|
41232
|
-
],
|
41233
|
-
"slots": [
|
41234
|
-
{
|
41235
|
-
"description": "Default slot for text content",
|
41236
|
-
"name": ""
|
41237
|
-
}
|
41238
|
-
],
|
41239
|
-
"members": [
|
41240
|
-
{
|
41241
|
-
"kind": "field",
|
41242
|
-
"name": "type",
|
41243
|
-
"type": {
|
41244
|
-
"text": "TextType"
|
41245
|
-
},
|
41246
|
-
"privacy": "public",
|
41247
|
-
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
41248
|
-
"default": "body-large-regular",
|
41249
|
-
"attribute": "type",
|
41250
|
-
"reflects": true
|
41251
|
-
},
|
41252
|
-
{
|
41253
|
-
"kind": "field",
|
41254
|
-
"name": "tagname",
|
41255
|
-
"type": {
|
41256
|
-
"text": "TagName | undefined"
|
41257
|
-
},
|
41258
|
-
"privacy": "public",
|
41259
|
-
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the internal text element.\n\nAcceptable values include all valid tag names from the Text component.",
|
41260
|
-
"attribute": "tagname",
|
41261
|
-
"reflects": true
|
41262
|
-
},
|
41263
|
-
{
|
41264
|
-
"kind": "field",
|
41265
|
-
"name": "speed",
|
41266
|
-
"type": {
|
41267
|
-
"text": "TypewriterSpeed"
|
41268
|
-
},
|
41269
|
-
"privacy": "public",
|
41270
|
-
"description": "Speed of the typewriter effect in milliseconds per character.\nCan be a string preset or a numeric string in milliseconds.\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds (e.g., '100')",
|
41271
|
-
"default": "'normal' (60ms per character)",
|
41272
|
-
"attribute": "speed",
|
41273
|
-
"reflects": true
|
41274
|
-
},
|
41275
|
-
{
|
41276
|
-
"kind": "field",
|
41277
|
-
"name": "maxQueueSize",
|
41278
|
-
"type": {
|
41279
|
-
"text": "number"
|
41280
|
-
},
|
41281
|
-
"privacy": "public",
|
41282
|
-
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
41283
|
-
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
41284
|
-
"attribute": "max-queue-size",
|
41285
|
-
"reflects": true
|
41286
|
-
},
|
41287
|
-
{
|
41288
|
-
"kind": "method",
|
41289
|
-
"name": "createTimeout",
|
41290
|
-
"privacy": "private",
|
41291
|
-
"return": {
|
41292
|
-
"type": {
|
41293
|
-
"text": "number"
|
41294
|
-
}
|
41295
|
-
},
|
41296
|
-
"parameters": [
|
41297
|
-
{
|
41298
|
-
"name": "callback",
|
41299
|
-
"type": {
|
41300
|
-
"text": "() => void"
|
41301
|
-
}
|
41302
|
-
},
|
41303
|
-
{
|
41304
|
-
"name": "delay",
|
41305
|
-
"type": {
|
41306
|
-
"text": "number"
|
41307
|
-
}
|
41308
|
-
}
|
41309
|
-
],
|
41310
|
-
"description": "Helper to create tracked setTimeout that will be cleaned up on disconnect"
|
41311
|
-
},
|
41312
|
-
{
|
41313
|
-
"kind": "method",
|
41314
|
-
"name": "clearAllTimeouts",
|
41315
|
-
"privacy": "private",
|
41316
|
-
"return": {
|
41317
|
-
"type": {
|
41318
|
-
"text": "void"
|
41319
|
-
}
|
41320
|
-
},
|
41321
|
-
"description": "Clear all pending timeouts"
|
41322
|
-
},
|
41323
|
-
{
|
41324
|
-
"kind": "method",
|
41325
|
-
"name": "clearQueue",
|
41326
|
-
"privacy": "public",
|
41327
|
-
"return": {
|
41328
|
-
"type": {
|
41329
|
-
"text": "void"
|
41330
|
-
}
|
41331
|
-
},
|
41332
|
-
"description": "Clears the text chunk queue and stops processing\nUseful for resetting the component state"
|
41333
|
-
},
|
41334
|
-
{
|
41335
|
-
"kind": "method",
|
41336
|
-
"name": "addTextChunk",
|
41337
|
-
"privacy": "public",
|
41338
|
-
"return": {
|
41339
|
-
"type": {
|
41340
|
-
"text": "void"
|
41341
|
-
}
|
41342
|
-
},
|
41343
|
-
"parameters": [
|
41344
|
-
{
|
41345
|
-
"name": "text",
|
41346
|
-
"type": {
|
41347
|
-
"text": "string"
|
41348
|
-
},
|
41349
|
-
"description": "The text to add"
|
41350
|
-
},
|
41351
|
-
{
|
41352
|
-
"name": "speed",
|
41353
|
-
"optional": true,
|
41354
|
-
"type": {
|
41355
|
-
"text": "TypewriterSpeed"
|
41356
|
-
},
|
41357
|
-
"description": "Optional speed override for this chunk"
|
41358
|
-
},
|
41359
|
-
{
|
41360
|
-
"name": "instant",
|
41361
|
-
"optional": true,
|
41362
|
-
"type": {
|
41363
|
-
"text": "boolean"
|
41364
|
-
},
|
41365
|
-
"description": "If true, text appears instantly without animation"
|
41366
|
-
}
|
41367
|
-
],
|
41368
|
-
"description": "Adds a chunk of text to be typed out, optionally with a different speed"
|
41369
|
-
},
|
41370
|
-
{
|
41371
|
-
"kind": "method",
|
41372
|
-
"name": "addInstantTextChunk",
|
41373
|
-
"privacy": "public",
|
41374
|
-
"return": {
|
41375
|
-
"type": {
|
41376
|
-
"text": "void"
|
41377
|
-
}
|
41378
|
-
},
|
41379
|
-
"parameters": [
|
41380
|
-
{
|
41381
|
-
"name": "text",
|
41382
|
-
"type": {
|
41383
|
-
"text": "string"
|
41384
|
-
},
|
41385
|
-
"description": "The text to add instantly"
|
41386
|
-
}
|
41387
|
-
],
|
41388
|
-
"description": "Adds a chunk of text instantly without typing animation"
|
41389
|
-
},
|
41390
|
-
{
|
41391
|
-
"kind": "method",
|
41392
|
-
"name": "processChunkQueue",
|
41393
|
-
"privacy": "private",
|
41394
|
-
"return": {
|
41395
|
-
"type": {
|
41396
|
-
"text": "void"
|
41397
|
-
}
|
41398
|
-
},
|
41399
|
-
"description": "Processes all chunks in the queue"
|
41400
|
-
},
|
41401
|
-
{
|
41402
|
-
"kind": "method",
|
41403
|
-
"name": "processNextChunk",
|
41404
|
-
"privacy": "private",
|
41405
|
-
"return": {
|
41406
|
-
"type": {
|
41407
|
-
"text": "void"
|
41408
|
-
}
|
41409
|
-
},
|
41410
|
-
"description": "Processes the next chunk in the queue"
|
41411
|
-
},
|
41412
|
-
{
|
41413
|
-
"kind": "method",
|
41414
|
-
"name": "getTypingDelayMs",
|
41415
|
-
"privacy": "private",
|
41416
|
-
"return": {
|
41417
|
-
"type": {
|
41418
|
-
"text": "number"
|
41419
|
-
}
|
41420
|
-
},
|
41421
|
-
"description": "Gets the typing delay in milliseconds per character"
|
41422
|
-
},
|
41423
|
-
{
|
41424
|
-
"kind": "method",
|
41425
|
-
"name": "captureAndProcessContent",
|
41426
|
-
"privacy": "private",
|
41427
|
-
"return": {
|
41428
|
-
"type": {
|
41429
|
-
"text": "void"
|
41430
|
-
}
|
41431
|
-
},
|
41432
|
-
"description": "Captures slot content and starts typewriter animation"
|
41433
|
-
},
|
41434
|
-
{
|
41435
|
-
"kind": "method",
|
41436
|
-
"name": "startTypingAnimation",
|
41437
|
-
"privacy": "private",
|
41438
|
-
"return": {
|
41439
|
-
"type": {
|
41440
|
-
"text": "void"
|
41441
|
-
}
|
41442
|
-
},
|
41443
|
-
"parameters": [
|
41444
|
-
{
|
41445
|
-
"name": "onComplete",
|
41446
|
-
"optional": true,
|
41447
|
-
"type": {
|
41448
|
-
"text": "() => void"
|
41449
|
-
}
|
41450
|
-
}
|
41451
|
-
],
|
41452
|
-
"description": "Starts the typewriter animation"
|
41453
|
-
},
|
41454
|
-
{
|
41455
|
-
"kind": "method",
|
41456
|
-
"name": "clearTypingAnimation",
|
41457
|
-
"privacy": "private",
|
41458
|
-
"return": {
|
41459
|
-
"type": {
|
41460
|
-
"text": "void"
|
41461
|
-
}
|
41462
|
-
},
|
41463
|
-
"description": "Clears the typing animation timeout"
|
41464
|
-
},
|
41465
|
-
{
|
41466
|
-
"kind": "method",
|
41467
|
-
"name": "handleSlotChange",
|
41468
|
-
"privacy": "private",
|
41469
|
-
"return": {
|
41470
|
-
"type": {
|
41471
|
-
"text": "void"
|
41472
|
-
}
|
41473
|
-
},
|
41474
|
-
"description": "Handler for slotchange event"
|
41475
|
-
}
|
41476
|
-
],
|
41477
|
-
"events": [
|
41478
|
-
{
|
41479
|
-
"type": {
|
41480
|
-
"text": "CustomEvent"
|
41481
|
-
}
|
41482
|
-
},
|
41483
|
-
{
|
41484
|
-
"description": "(React: onTypingComplete) Fired when the typewriter finishes typing all content. Detail: \\{ finalContent: string \\}",
|
41485
|
-
"name": "typing-complete",
|
41486
|
-
"reactName": "onTypingComplete"
|
41487
|
-
},
|
41488
|
-
{
|
41489
|
-
"description": "(React: onChange) Fired when the content of the typewriter changes. Detail: \\{ content: string, isTyping: boolean \\}",
|
41490
|
-
"name": "change",
|
41491
|
-
"reactName": "onChange"
|
41492
|
-
}
|
41493
|
-
],
|
41494
|
-
"attributes": [
|
41495
|
-
{
|
41496
|
-
"name": "type",
|
41497
|
-
"type": {
|
41498
|
-
"text": "TextType"
|
41499
|
-
},
|
41500
|
-
"description": "Specifies the text style to be applied to the internal text component.\nUses the same types as the Text component.",
|
41501
|
-
"default": "body-large-regular",
|
41502
|
-
"fieldName": "type"
|
41503
|
-
},
|
41504
|
-
{
|
41505
|
-
"name": "tagname",
|
41506
|
-
"type": {
|
41507
|
-
"text": "TagName | undefined"
|
41508
|
-
},
|
41509
|
-
"description": "Specifies the HTML tag name for the text element. The default tag name is `p`.\nThis attribute is optional. When set, it changes the tag name of the internal text element.\n\nAcceptable values include all valid tag names from the Text component.",
|
41510
|
-
"fieldName": "tagname"
|
41511
|
-
},
|
41512
|
-
{
|
41513
|
-
"name": "speed",
|
41514
|
-
"type": {
|
41515
|
-
"text": "TypewriterSpeed"
|
41516
|
-
},
|
41517
|
-
"description": "Speed of the typewriter effect in milliseconds per character.\nCan be a string preset or a numeric string in milliseconds.\n- 'very-slow' = 240ms per character\n- 'slow' = 120ms per character\n- 'normal' = 60ms per character (default)\n- 'fast' = 20ms per character\n- 'very-fast' = 1ms per character\n- Or any numeric string representing milliseconds (e.g., '100')",
|
41518
|
-
"default": "'normal' (60ms per character)",
|
41519
|
-
"fieldName": "speed"
|
41520
|
-
},
|
41521
|
-
{
|
41522
|
-
"name": "max-queue-size",
|
41523
|
-
"type": {
|
41524
|
-
"text": "number"
|
41525
|
-
},
|
41526
|
-
"description": "Maximum number of text chunks that can be queued before oldest chunks are dropped.\nSet to prevent memory accumulation from excessive queuing.",
|
41527
|
-
"default": "Number.MAX_SAFE_INTEGER (effectively unlimited)",
|
41528
|
-
"fieldName": "maxQueueSize"
|
41529
|
-
}
|
41530
|
-
],
|
41531
|
-
"superclass": {
|
41532
|
-
"name": "Component",
|
41533
|
-
"module": "/src/models"
|
41534
|
-
},
|
41535
|
-
"tagName": "mdc-typewriter",
|
41536
|
-
"jsDoc": "/**\n * Typewriter component that creates a typewriter effect on text content.\n * It uses the Text component internally, adding a progressive typing effect.\n *\n * The `type` attribute allows changing the text style (passed to the internal Text component).\n * The `tagname` attribute allows changing the tag name of the text element (passed to the internal Text component).\n * The default tag name is `p`.\n *\n * The `speed` attribute controls typing speed in milliseconds per character:\n * - 'very-slow' = 240ms per character\n * - 'slow' = 120ms per character\n * - 'normal' = 60ms per character (default)\n * - 'fast' = 20ms per character\n * - 'very-fast' = 1ms per character\n * - Or any numeric string representing milliseconds\n *\n * Advanced features:\n * - Dynamic speed adjustment during typing\n * - Chunked text addition via addTextChunk() method\n * - Instant text addition via addInstantTextChunk() method or instant parameter\n * - Mixed instant and animated chunks in queue\n * - Continues typing in background tabs\n * - Performance optimized for large text\n * - maxQueueSize to limit memory usage from excessive queuing\n * - event handling for typing completion and content changes\n *\n * The component includes accessibility features:\n * - Screen readers announce the complete text, not character by character\n * - Uses aria-live=\"polite\" for dynamic content updates\n * - Sets aria-busy during typing animation\n *\n * @dependency mdc-text\n *\n * @tagname mdc-typewriter\n * @slot - Default slot for text content\n *\n * @csspart container - Container for the text element\n * @csspart text - The text element (forwarded to mdc-text)\n *\n * @event typing-complete - (React: onTypingComplete) Fired when the typewriter finishes typing all content.\n * Detail: \\{ finalContent: string \\}\n * @event change - (React: onChange) Fired when the content of the typewriter changes.\n * Detail: \\{ content: string, isTyping: boolean \\}\n */",
|
41537
|
-
"customElement": true
|
41538
|
-
}
|
41539
|
-
],
|
41540
|
-
"exports": [
|
41541
|
-
{
|
41542
|
-
"kind": "js",
|
41543
|
-
"name": "default",
|
41544
|
-
"declaration": {
|
41545
|
-
"name": "Typewriter",
|
41546
|
-
"module": "components/typewriter/typewriter.component.js"
|
41547
|
-
}
|
41548
|
-
}
|
41549
|
-
]
|
41550
|
-
},
|
41551
|
-
{
|
41552
|
-
"kind": "javascript-module",
|
41553
|
-
"path": "components/virtualizedlist/virtualizedlist.component.js",
|
41554
|
-
"declarations": [
|
41555
|
-
{
|
41556
|
-
"kind": "class",
|
41557
|
-
"description": "`mdc-virtualizedlist` component for creating custom virtualized lists.\nIMPORTANT: This component does not create it's own list/list items.\nUse the setlistdata callback prop to update client state in order to\nPass list/listitems as a child of this component, which this will virtuailze\nThis implementation handles dynamic lists as well as fixed sized lists.\nPlease refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.",
|
41558
|
-
"name": "VirtualizedList",
|
41559
|
-
"slots": [
|
41560
|
-
{
|
41561
|
-
"description": "Client side List with nested list items.",
|
41562
|
-
"name": ""
|
41563
|
-
}
|
41564
|
-
],
|
41565
|
-
"members": [
|
41566
|
-
{
|
41567
|
-
"kind": "field",
|
41568
|
-
"name": "onscroll",
|
41569
|
-
"type": {
|
41570
|
-
"text": "((this: GlobalEventHandlers, ev: Event) => void) | null"
|
41571
|
-
},
|
41572
|
-
"description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
|
41573
|
-
"default": "null",
|
41574
|
-
"attribute": "onscroll"
|
41575
|
-
},
|
41576
|
-
{
|
41577
|
-
"kind": "field",
|
41578
|
-
"name": "virtualizerProps",
|
41579
|
-
"type": {
|
41580
|
-
"text": "VirtualizerProps"
|
41581
|
-
},
|
41582
|
-
"description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
|
41583
|
-
"attribute": "virtualizerprops"
|
41584
|
-
},
|
41585
|
-
{
|
41586
|
-
"kind": "field",
|
41587
|
-
"name": "setlistdata",
|
41588
|
-
"type": {
|
41589
|
-
"text": "(({ virtualItems, measureElement, listStyle }: SetListDataProps) => void) | null"
|
41590
|
-
},
|
41591
|
-
"description": "Callback that gets envoked when updates to the virtualizer interally occur.\nThis must be implemented in such a way that this function will trigger update to parent.\n\nvirtualItems - Array that will be what the client displays on screen. Use this to render\na List of your choosing with these items nested inside as your ListItems.\nmeasureElement - Ref to pass to each ListItem rendered client side.\nEach ListItem should also be be passed key and a data-index (which can be found on the virtualItem).\nlistStyle - This should be passed as the style attribute to your List.",
|
41592
|
-
"default": "null",
|
41593
|
-
"attribute": "setlistdata"
|
41594
|
-
},
|
41595
|
-
{
|
41596
|
-
"kind": "field",
|
41597
|
-
"name": "scrollElementRef",
|
41598
|
-
"type": {
|
41599
|
-
"text": "Ref<HTMLDivElement>"
|
41600
|
-
},
|
41601
|
-
"privacy": "public"
|
41602
|
-
},
|
41603
|
-
{
|
41604
|
-
"kind": "field",
|
41605
|
-
"name": "virtualizer",
|
41606
|
-
"type": {
|
41607
|
-
"text": "Virtualizer<Element, Element> | null"
|
41608
|
-
},
|
41609
|
-
"privacy": "public",
|
41610
|
-
"default": "null"
|
41611
|
-
},
|
41612
|
-
{
|
41613
|
-
"kind": "field",
|
41614
|
-
"name": "virtualItems",
|
41615
|
-
"type": {
|
41616
|
-
"text": "Array<VirtualItem>"
|
41617
|
-
},
|
41618
|
-
"privacy": "public",
|
41619
|
-
"default": "[]"
|
41620
|
-
},
|
41621
|
-
{
|
41622
|
-
"kind": "field",
|
41623
|
-
"name": "virtualizerController",
|
41624
|
-
"type": {
|
41625
|
-
"text": "null"
|
41626
|
-
},
|
41627
|
-
"default": "null"
|
41628
|
-
}
|
41629
|
-
],
|
41630
|
-
"events": [
|
41631
|
-
{
|
41632
|
-
"description": "(React: onScroll) Event that gets called when user scrolls inside of list.",
|
41633
|
-
"name": "onscroll",
|
41634
|
-
"reactName": "onScroll"
|
41635
|
-
}
|
41636
|
-
],
|
41637
|
-
"attributes": [
|
41638
|
-
{
|
41639
|
-
"name": "onscroll",
|
41640
|
-
"type": {
|
41641
|
-
"text": "((this: GlobalEventHandlers, ev: Event) => void) | null"
|
41642
|
-
},
|
41643
|
-
"description": "Callback that gets called when user scrolls inside of list. This gives access to the scroll container element\nas well via the event. Particularly useful for\nhandling logic related when the user scrolls to the top or bottom of a list.",
|
41644
|
-
"default": "null",
|
41645
|
-
"fieldName": "onscroll"
|
41646
|
-
},
|
41647
|
-
{
|
41648
|
-
"name": "virtualizerprops",
|
41649
|
-
"type": {
|
41650
|
-
"text": "VirtualizerProps"
|
41651
|
-
},
|
41652
|
-
"description": "Object that sets and updates the virtualizer with any relevant props.\nThere are two required object props in order to get virtualization to work properly.\ncount - The length of your list that you are virtualizing.\nAs your list grows/shrinks, this component must be updated with the appropriate value\n(Same with any other updated prop).\nestimateSize - A function that returns the estimated size of your items.\nIf your list is fixed, this will just be the size of your items.\nIf your list is dynamic, try to return approximate the size of each item.\n\nA full list of possible props can be in\n[Tanstack Virtualizer API Docs](https://tanstack.com/virtual/latest/docs/api/virtualizer)",
|
41653
|
-
"fieldName": "virtualizerProps"
|
41654
|
-
},
|
41655
|
-
{
|
41656
|
-
"name": "setlistdata",
|
41657
|
-
"type": {
|
41658
|
-
"text": "(({ virtualItems, measureElement, listStyle }: SetListDataProps) => void) | null"
|
41659
|
-
},
|
41660
|
-
"description": "Callback that gets envoked when updates to the virtualizer interally occur.\nThis must be implemented in such a way that this function will trigger update to parent.\n\nvirtualItems - Array that will be what the client displays on screen. Use this to render\na List of your choosing with these items nested inside as your ListItems.\nmeasureElement - Ref to pass to each ListItem rendered client side.\nEach ListItem should also be be passed key and a data-index (which can be found on the virtualItem).\nlistStyle - This should be passed as the style attribute to your List.",
|
41661
|
-
"default": "null",
|
41662
|
-
"fieldName": "setlistdata"
|
41663
|
-
}
|
41664
|
-
],
|
41665
|
-
"superclass": {
|
41666
|
-
"name": "Component",
|
41667
|
-
"module": "/src/models"
|
41668
|
-
},
|
41669
|
-
"tagName": "mdc-virtualizedlist",
|
41670
|
-
"jsDoc": "/**\n * `mdc-virtualizedlist` component for creating custom virtualized lists.\n * IMPORTANT: This component does not create it's own list/list items.\n * Use the setlistdata callback prop to update client state in order to\n * Pass list/listitems as a child of this component, which this will virtuailze\n * This implementation handles dynamic lists as well as fixed sized lists.\n * Please refer to [Tanstack Virtual Docs](https://tanstack.com/virtual/latest) for more in depth documentation.\n *\n * @tagname mdc-virtualizedlist\n *\n * @event onscroll - (React: onScroll) Event that gets called when user scrolls inside of list.\n *\n * @slot - Client side List with nested list items.\n */",
|
41701
|
+
"tagName": "mdc-toggletip",
|
41702
|
+
"jsDoc": "/**\n * A toggletip is triggered by clicking a trigger element.\n *\n * It can contain interactive content and can be closed by\n * clicking outside the toggletip or pressing the escape key.\n *\n * It can have optional close button to close the toggletip.\n *\n * Toggletip component uses `mdc-screenreaderannouncer` internally to\n * announce the toggletip text content with screen readers when the toggletip is shown.\n *\n * `screenreader-announcer-identity` attribute can be used to provide ID of an element\n * in DOM to which announcement elements are added. If not set, a visually hidden\n * div element is created in DOM to which announcement elements are added.\n *\n * Please refer to the `mdc-screenreaderannouncer` component for more details.\n *\n * @dependency mdc-screenreaderannouncer\n * @dependency mdc-button\n *\n * @tagname mdc-toggletip\n *\n * @event shown - (React: onShown) This event is dispatched when the toggletip is shown\n * @event hidden - (React: onHidden) This event is dispatched when the toggletip is hidden\n * @event created - (React: onCreated) This event is dispatched when the toggletip is created (added to the DOM)\n * @event destroyed - (React: onDestroyed) This event is dispatched when the toggletip\n * is destroyed (removed from the DOM)\n *\n * @cssproperty --mdc-toggletip-max-width - The maximum width of the toggletip.\n * @cssproperty --mdc-toggletip-text-color - The text color of the toggletip.\n * @cssproperty --mdc-toggletip-text-color-contrast - The text color of the toggletip\n * when the color is contrast.\n *\n * @slot - Default slot for the toggletip content\n */",
|
41671
41703
|
"customElement": true
|
41672
41704
|
}
|
41673
41705
|
],
|
@@ -41676,8 +41708,8 @@
|
|
41676
41708
|
"kind": "js",
|
41677
41709
|
"name": "default",
|
41678
41710
|
"declaration": {
|
41679
|
-
"name": "
|
41680
|
-
"module": "components/
|
41711
|
+
"name": "ToggleTip",
|
41712
|
+
"module": "components/toggletip/toggletip.component.js"
|
41681
41713
|
}
|
41682
41714
|
}
|
41683
41715
|
]
|