@momentum-design/components 0.110.1 → 0.110.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -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",
@@ -33675,18 +33675,82 @@
33675
33675
  "declarations": [
33676
33676
  {
33677
33677
  "kind": "class",
33678
- "description": "slider component, which ...",
33678
+ "description": "Slider component is used to select a value or range of values from within a defined range.\nIt provides a visual representation of the current value(s) and allows users to adjust the value(s) by dragging the thumb(s) along the track.\nIt can be used as a single slider or a range slider. This is set by the boolean attribute `range`\nIf the step value is more than 1, tick marks are shown to represent the steps between the min and max values. The slider thumb will snap to the nearest tick mark.",
33679
33679
  "name": "Slider",
33680
33680
  "cssProperties": [
33681
33681
  {
33682
- "description": "Description of the CSS custom property",
33683
- "name": "--custom-property-name"
33682
+ "description": "The color of the slider thumb",
33683
+ "name": "--mdc-slider-thumb-color"
33684
+ },
33685
+ {
33686
+ "description": "The color of the slider thumb border",
33687
+ "name": "--mdc-slider-thumb-border-color"
33688
+ },
33689
+ {
33690
+ "description": "The size of the slider thumb",
33691
+ "name": "--mdc-slider-thumb-size"
33692
+ },
33693
+ {
33694
+ "description": "The height of the slider input",
33695
+ "name": "--mdc-slider-input-size"
33696
+ },
33697
+ {
33698
+ "description": "The size of the slider tick marks",
33699
+ "name": "--mdc-slider-tick-size"
33700
+ },
33701
+ {
33702
+ "description": "The height of the slider track",
33703
+ "name": "--mdc-slider-track-height"
33704
+ },
33705
+ {
33706
+ "description": "The color of the slider tick marks",
33707
+ "name": "--mdc-slider-tick-color"
33708
+ },
33709
+ {
33710
+ "description": "The color of the slider progress",
33711
+ "name": "--mdc-slider-progress-color"
33712
+ },
33713
+ {
33714
+ "description": "The color of the slider track",
33715
+ "name": "--mdc-slider-track-color"
33716
+ },
33717
+ {
33718
+ "description": "The left position of the slider tooltip",
33719
+ "name": "--mdc-slider-tooltip-left"
33720
+ },
33721
+ {
33722
+ "description": "The left position of the slider tick marks",
33723
+ "name": "--mdc-slider-tick-left"
33684
33724
  }
33685
33725
  ],
33686
- "slots": [
33726
+ "cssParts": [
33687
33727
  {
33688
- "description": "This is a default/unnamed slot",
33689
- "name": "default"
33728
+ "description": "The tooltip of the slider",
33729
+ "name": "slider-tooltip"
33730
+ },
33731
+ {
33732
+ "description": "The track of the slider",
33733
+ "name": "slider-track"
33734
+ },
33735
+ {
33736
+ "description": "The wrapper around the slider input(s)",
33737
+ "name": "slider-wrapper"
33738
+ },
33739
+ {
33740
+ "description": "The container for the tick marks",
33741
+ "name": "slider-ticks"
33742
+ },
33743
+ {
33744
+ "description": "The individual tick marks",
33745
+ "name": "slider-tick"
33746
+ },
33747
+ {
33748
+ "description": "The input element of the slider",
33749
+ "name": "slider-input"
33750
+ },
33751
+ {
33752
+ "description": "The label of the slider",
33753
+ "name": "slider-label"
33690
33754
  }
33691
33755
  ],
33692
33756
  "members": [
@@ -33697,8 +33761,31 @@
33697
33761
  "text": "boolean"
33698
33762
  },
33699
33763
  "default": "false",
33700
- "description": "Whether or not to show a value range. When false, the slider displays a slide-able handle for the value property; when true, it displays slide-able handles for the valueStart and valueEnd properties.",
33701
- "attribute": "range"
33764
+ "description": "Indicates whether it is a range slider. When true, the slider displays two handles for selecting a range of values.\nWhen false, the slider displays a single handle for selecting a single value.",
33765
+ "attribute": "range",
33766
+ "reflects": true
33767
+ },
33768
+ {
33769
+ "kind": "field",
33770
+ "name": "min",
33771
+ "type": {
33772
+ "text": "number"
33773
+ },
33774
+ "description": "The slider minimum value.",
33775
+ "default": "0",
33776
+ "attribute": "min",
33777
+ "reflects": true
33778
+ },
33779
+ {
33780
+ "kind": "field",
33781
+ "name": "max",
33782
+ "type": {
33783
+ "text": "number"
33784
+ },
33785
+ "description": "The slider maximum value.",
33786
+ "default": "100",
33787
+ "attribute": "max",
33788
+ "reflects": true
33702
33789
  },
33703
33790
  {
33704
33791
  "kind": "field",
@@ -33706,8 +33793,9 @@
33706
33793
  "type": {
33707
33794
  "text": "boolean | undefined"
33708
33795
  },
33709
- "description": "Whether the slider is disabled.",
33710
- "attribute": "disabled"
33796
+ "description": "Whether the slider is disabled. When true, the slider cannot be interacted with.",
33797
+ "attribute": "disabled",
33798
+ "reflects": true
33711
33799
  },
33712
33800
  {
33713
33801
  "kind": "field",
@@ -33716,7 +33804,8 @@
33716
33804
  "text": "boolean | undefined"
33717
33805
  },
33718
33806
  "description": "Acts similar to disabled, but component is focusable and tooltip is shown on focus.",
33719
- "attribute": "soft-disabled"
33807
+ "attribute": "soft-disabled",
33808
+ "reflects": true
33720
33809
  },
33721
33810
  {
33722
33811
  "kind": "field",
@@ -33725,7 +33814,8 @@
33725
33814
  "text": "string | undefined"
33726
33815
  },
33727
33816
  "description": "Icon that represents the minimum value; ex: muted speaker.",
33728
- "attribute": "leading-icon"
33817
+ "attribute": "leading-icon",
33818
+ "reflects": true
33729
33819
  },
33730
33820
  {
33731
33821
  "kind": "field",
@@ -33734,27 +33824,8 @@
33734
33824
  "text": "string | undefined"
33735
33825
  },
33736
33826
  "description": "Icon that represents the maximum value; ex: speaker with full volume.",
33737
- "attribute": "trailing-icon"
33738
- },
33739
- {
33740
- "kind": "field",
33741
- "name": "min",
33742
- "type": {
33743
- "text": "number"
33744
- },
33745
- "default": "0",
33746
- "description": "The slider minimum value.",
33747
- "attribute": "min"
33748
- },
33749
- {
33750
- "kind": "field",
33751
- "name": "max",
33752
- "type": {
33753
- "text": "number"
33754
- },
33755
- "default": "100",
33756
- "description": "The slider maximum value.",
33757
- "attribute": "max"
33827
+ "attribute": "trailing-icon",
33828
+ "reflects": true
33758
33829
  },
33759
33830
  {
33760
33831
  "kind": "field",
@@ -33763,7 +33834,8 @@
33763
33834
  "text": "number | undefined"
33764
33835
  },
33765
33836
  "description": "The slider value displayed when range is false.",
33766
- "attribute": "value"
33837
+ "attribute": "value",
33838
+ "reflects": true
33767
33839
  },
33768
33840
  {
33769
33841
  "kind": "field",
@@ -33772,7 +33844,8 @@
33772
33844
  "text": "number | undefined"
33773
33845
  },
33774
33846
  "description": "The slider start value displayed when range is true.",
33775
- "attribute": "value-start"
33847
+ "attribute": "value-start",
33848
+ "reflects": true
33776
33849
  },
33777
33850
  {
33778
33851
  "kind": "field",
@@ -33781,7 +33854,8 @@
33781
33854
  "text": "number | undefined"
33782
33855
  },
33783
33856
  "description": "The slider end value displayed when range is true.",
33784
- "attribute": "value-end"
33857
+ "attribute": "value-end",
33858
+ "reflects": true
33785
33859
  },
33786
33860
  {
33787
33861
  "kind": "field",
@@ -33789,9 +33863,10 @@
33789
33863
  "type": {
33790
33864
  "text": "number"
33791
33865
  },
33866
+ "description": "The step between values. If defined and greater than 1, we will show tick marks and the stepper will snap to the nearest tick mark.",
33792
33867
  "default": "1",
33793
- "description": "The step between values. This will show tick marks and the stepper will snap to the nearest tick mark.",
33794
- "attribute": "step"
33868
+ "attribute": "step",
33869
+ "reflects": true
33795
33870
  },
33796
33871
  {
33797
33872
  "kind": "field",
@@ -33800,7 +33875,8 @@
33800
33875
  "text": "string | undefined"
33801
33876
  },
33802
33877
  "description": "It represents the label for slider component.",
33803
- "attribute": "label"
33878
+ "attribute": "label",
33879
+ "reflects": true
33804
33880
  },
33805
33881
  {
33806
33882
  "kind": "field",
@@ -33809,7 +33885,8 @@
33809
33885
  "text": "string | undefined"
33810
33886
  },
33811
33887
  "description": "The label text is shown below the slider (on leading side) representing the minimum starting value of the slider.",
33812
- "attribute": "label-start"
33888
+ "attribute": "label-start",
33889
+ "reflects": true
33813
33890
  },
33814
33891
  {
33815
33892
  "kind": "field",
@@ -33818,124 +33895,325 @@
33818
33895
  "text": "string | undefined"
33819
33896
  },
33820
33897
  "description": "The label text is shown below the slider (on trailing side) representing the maximum starting value of the slider.",
33821
- "attribute": "label-end"
33898
+ "attribute": "label-end",
33899
+ "reflects": true
33822
33900
  },
33823
33901
  {
33824
33902
  "kind": "field",
33825
33903
  "name": "valueLabel",
33826
33904
  "type": {
33827
- "text": "string"
33905
+ "text": "string | undefined"
33828
33906
  },
33829
- "default": "''",
33830
- "description": "An optional label for the slider's value displayed when range is false; if not set, the label is the value itself.",
33831
- "attribute": "value-label"
33907
+ "description": "An optional label for the slider's value displayed when range is false; if not set, the label is the 'value' itself.",
33908
+ "attribute": "value-label",
33909
+ "reflects": true
33832
33910
  },
33833
33911
  {
33834
33912
  "kind": "field",
33835
33913
  "name": "valueLabelStart",
33836
33914
  "type": {
33837
- "text": "string"
33915
+ "text": "string | undefined"
33838
33916
  },
33839
- "default": "''",
33840
- "description": "An optional label for the slider's start value displayed when range is true; if not set, the label is the valueStart itself.",
33841
- "attribute": "value-label-start"
33917
+ "description": "An optional label for the slider's start value displayed when range is true; if not set, the label is the 'valueStart' itself.",
33918
+ "attribute": "value-label-start",
33919
+ "reflects": true
33842
33920
  },
33843
33921
  {
33844
33922
  "kind": "field",
33845
33923
  "name": "valueLabelEnd",
33846
33924
  "type": {
33847
- "text": "string"
33925
+ "text": "string | undefined"
33848
33926
  },
33849
- "default": "''",
33850
- "description": "An optional label for the slider's end value displayed when range is true; if not set, the label is the valueEnd itself.",
33851
- "attribute": "value-label-end"
33927
+ "description": "An optional label for the slider's end value displayed when range is true; if not set, the label is the 'valueEnd' itself.",
33928
+ "attribute": "value-label-end",
33929
+ "reflects": true
33852
33930
  },
33853
33931
  {
33854
33932
  "kind": "field",
33855
- "name": "ariaLabelStart",
33933
+ "name": "name",
33856
33934
  "type": {
33857
- "text": "string"
33935
+ "text": "string | undefined"
33858
33936
  },
33859
- "default": "''",
33860
- "description": "Aria label for the slider's start handle displayed when range is true.",
33861
- "attribute": "aria-label-start"
33937
+ "description": "Name attribute for the slider (single value).",
33938
+ "attribute": "name",
33939
+ "reflects": true
33862
33940
  },
33863
33941
  {
33864
33942
  "kind": "field",
33865
- "name": "ariaValuetextStart",
33943
+ "name": "nameStart",
33866
33944
  "type": {
33867
- "text": "string"
33945
+ "text": "string | undefined"
33868
33946
  },
33869
- "default": "''",
33870
- "description": "Aria value text for the slider's start value displayed when range is true.",
33871
- "attribute": "aria-valuetext-start"
33947
+ "description": "Name attribute for the slider's start handle when range is true.",
33948
+ "attribute": "name-start",
33949
+ "reflects": true
33872
33950
  },
33873
33951
  {
33874
33952
  "kind": "field",
33875
- "name": "ariaLabelEnd",
33953
+ "name": "nameEnd",
33876
33954
  "type": {
33877
- "text": "string"
33955
+ "text": "string | undefined"
33878
33956
  },
33879
- "default": "''",
33880
- "description": "Aria label for the slider's end handle displayed when range is true.",
33881
- "attribute": "aria-label-end"
33957
+ "description": "Name attribute for the slider's end handle when range is true.",
33958
+ "attribute": "name-end",
33959
+ "reflects": true
33882
33960
  },
33883
33961
  {
33884
33962
  "kind": "field",
33885
- "name": "ariaValuetextEnd",
33963
+ "name": "dataAriaLabel",
33886
33964
  "type": {
33887
- "text": "string"
33965
+ "text": "string | undefined"
33888
33966
  },
33889
- "default": "''",
33890
- "description": "Aria value text for the slider's end value displayed when range is true.",
33891
- "attribute": "aria-valuetext-end"
33967
+ "description": "Aria label for the slider's handle displayed when range is false.",
33968
+ "attribute": "data-aria-label",
33969
+ "reflects": true
33892
33970
  },
33893
33971
  {
33894
33972
  "kind": "field",
33895
- "name": "name",
33973
+ "name": "startAriaLabel",
33896
33974
  "type": {
33897
33975
  "text": "string | undefined"
33898
33976
  },
33899
- "description": "Name attribute for the slider (single value).",
33900
- "attribute": "name"
33977
+ "description": "Aria label for the slider's start handle displayed when range is true.",
33978
+ "attribute": "start-aria-label",
33979
+ "reflects": true
33901
33980
  },
33902
33981
  {
33903
33982
  "kind": "field",
33904
- "name": "nameStart",
33983
+ "name": "endAriaLabel",
33905
33984
  "type": {
33906
33985
  "text": "string | undefined"
33907
33986
  },
33908
- "description": "Name attribute for the slider's start handle (range).",
33909
- "attribute": "name-start"
33987
+ "description": "Aria label for the slider's end handle displayed when range is true.",
33988
+ "attribute": "end-aria-label",
33989
+ "reflects": true
33910
33990
  },
33911
33991
  {
33912
33992
  "kind": "field",
33913
- "name": "nameEnd",
33993
+ "name": "dataAriaValuetext",
33914
33994
  "type": {
33915
33995
  "text": "string | undefined"
33916
33996
  },
33917
- "description": "Name attribute for the slider's end handle (range).",
33918
- "attribute": "name-end"
33997
+ "description": "Aria value text for the slider's value displayed when range is false.",
33998
+ "attribute": "data-aria-valuetext",
33999
+ "reflects": true
33919
34000
  },
33920
34001
  {
33921
34002
  "kind": "field",
33922
- "name": "dataAriaValuetext",
34003
+ "name": "startAriaValuetext",
33923
34004
  "type": {
33924
- "text": "string"
34005
+ "text": "string | undefined"
33925
34006
  },
33926
- "default": "''",
33927
- "description": "Aria value text for the slider's value displayed when range is false.",
33928
- "attribute": "data-aria-valuetext"
34007
+ "description": "Aria value text for the slider's start value displayed when range is true.",
34008
+ "attribute": "start-aria-valuetext",
34009
+ "reflects": true
33929
34010
  },
33930
34011
  {
33931
34012
  "kind": "field",
33932
- "name": "dataAriaLabel",
34013
+ "name": "endAriaValueText",
33933
34014
  "type": {
33934
- "text": "string"
34015
+ "text": "string | undefined"
33935
34016
  },
33936
- "default": "''",
33937
- "description": "Aria label for the slider's handle displayed when range is false.",
33938
- "attribute": "data-aria-label"
34017
+ "description": "Aria value text for the slider's end value displayed when range is true.",
34018
+ "attribute": "end-aria-valuetext",
34019
+ "reflects": true
34020
+ },
34021
+ {
34022
+ "kind": "method",
34023
+ "name": "preventChange",
34024
+ "privacy": "private",
34025
+ "parameters": [
34026
+ {
34027
+ "name": "e",
34028
+ "type": {
34029
+ "text": "Event"
34030
+ },
34031
+ "description": "The event to prevent."
34032
+ }
34033
+ ],
34034
+ "description": "Prevents default behavior for mouse and keyboard events.\nThis prevents user interaction with the slider when it is soft-disabled."
34035
+ },
34036
+ {
34037
+ "kind": "method",
34038
+ "name": "setSoftDisabled",
34039
+ "privacy": "private",
34040
+ "description": "Sets the soft-disabled state for the slider.\nApplies the appropriate ARIA attributes."
34041
+ },
34042
+ {
34043
+ "kind": "method",
34044
+ "name": "initializeRangeSlider",
34045
+ "privacy": "private",
34046
+ "description": "Initializes the range slider by setting default values for the start and end handles.\nUpdates the slider's input elements to reflect the current values."
34047
+ },
34048
+ {
34049
+ "kind": "method",
34050
+ "name": "handleInput",
34051
+ "privacy": "private",
34052
+ "parameters": [
34053
+ {
34054
+ "name": "thumbIndex",
34055
+ "type": {
34056
+ "text": "0 | 1"
34057
+ },
34058
+ "description": "0 for start thumb, 1 for end thumb."
34059
+ }
34060
+ ],
34061
+ "description": "Handles input changes for either the start or end thumb of the range slider.\nEnsures thumbs do not cross over each other."
34062
+ },
34063
+ {
34064
+ "kind": "method",
34065
+ "name": "iconTemplate",
34066
+ "privacy": "private",
34067
+ "parameters": [
34068
+ {
34069
+ "name": "icon",
34070
+ "type": {
34071
+ "text": "string | undefined"
34072
+ },
34073
+ "description": "The name of the icon to render."
34074
+ },
34075
+ {
34076
+ "name": "part",
34077
+ "type": {
34078
+ "text": "string"
34079
+ },
34080
+ "description": "The part attribute for the icon element."
34081
+ }
34082
+ ],
34083
+ "description": "Renders an icon element.",
34084
+ "return": {
34085
+ "type": {
34086
+ "text": ""
34087
+ }
34088
+ }
34089
+ },
34090
+ {
34091
+ "kind": "method",
34092
+ "name": "tooltipTemplate",
34093
+ "privacy": "private",
34094
+ "parameters": [
34095
+ {
34096
+ "name": "label",
34097
+ "type": {
34098
+ "text": "string | undefined"
34099
+ },
34100
+ "description": "The label to display in the tooltip."
34101
+ },
34102
+ {
34103
+ "name": "source",
34104
+ "optional": true,
34105
+ "type": {
34106
+ "text": "string"
34107
+ },
34108
+ "description": "The source of the tooltip (e.g., 'start' or 'end')."
34109
+ }
34110
+ ],
34111
+ "description": "Renders a visual representation of tooltip element and places it exactly above the slider thumb.",
34112
+ "return": {
34113
+ "type": {
34114
+ "text": ""
34115
+ }
34116
+ }
34117
+ },
34118
+ {
34119
+ "kind": "method",
34120
+ "name": "updateTrackStyling",
34121
+ "description": "Updates the styling of the slider track.\nThe progress value is calculated and updated using appropriate tokens\nIn a range slider, both thumbs are considered.\nThe track is filled between the two thumbs."
34122
+ },
34123
+ {
34124
+ "kind": "method",
34125
+ "name": "onInput",
34126
+ "parameters": [
34127
+ {
34128
+ "name": "e",
34129
+ "type": {
34130
+ "text": "Event"
34131
+ },
34132
+ "description": "The input event."
34133
+ }
34134
+ ],
34135
+ "description": "Handles the input event for the single value slider."
34136
+ },
34137
+ {
34138
+ "kind": "method",
34139
+ "name": "onChange",
34140
+ "parameters": [
34141
+ {
34142
+ "name": "e",
34143
+ "type": {
34144
+ "text": "Event"
34145
+ },
34146
+ "description": "The change event."
34147
+ }
34148
+ ],
34149
+ "description": "Handles the change event for the single value slider."
34150
+ },
34151
+ {
34152
+ "kind": "method",
34153
+ "name": "onChangeStart",
34154
+ "parameters": [
34155
+ {
34156
+ "name": "e",
34157
+ "type": {
34158
+ "text": "Event"
34159
+ },
34160
+ "description": "The change event."
34161
+ }
34162
+ ],
34163
+ "description": "Handles the change event for the start thumb of the range slider."
34164
+ },
34165
+ {
34166
+ "kind": "method",
34167
+ "name": "onChangeEnd",
34168
+ "parameters": [
34169
+ {
34170
+ "name": "e",
34171
+ "type": {
34172
+ "text": "Event"
34173
+ },
34174
+ "description": "The change event."
34175
+ }
34176
+ ],
34177
+ "description": "Handles the change event for the end thumb of the range slider."
34178
+ },
34179
+ {
34180
+ "kind": "method",
34181
+ "name": "getTickStyles",
34182
+ "parameters": [
34183
+ {
34184
+ "name": "tick",
34185
+ "type": {
34186
+ "text": "number"
34187
+ },
34188
+ "description": "The tick value."
34189
+ }
34190
+ ],
34191
+ "description": "Get the styles for the tick marks.\nSince the ticks are placed above the slider, we need to hide the tick that is placed exactly where the slider thumb is.\nBased on this condition, it renders the styles appropriately.",
34192
+ "return": {
34193
+ "type": {
34194
+ "text": ""
34195
+ }
34196
+ }
34197
+ },
34198
+ {
34199
+ "kind": "method",
34200
+ "name": "renderTicks",
34201
+ "privacy": "private"
34202
+ }
34203
+ ],
34204
+ "events": [
34205
+ {
34206
+ "name": "change",
34207
+ "type": {
34208
+ "text": "CustomEvent"
34209
+ },
34210
+ "description": "Fired when the slider value is committed",
34211
+ "reactName": "onChange"
34212
+ },
34213
+ {
34214
+ "description": "Fired when the slider value changes",
34215
+ "name": "input",
34216
+ "reactName": "onInput"
33939
34217
  }
33940
34218
  ],
33941
34219
  "attributes": [
@@ -33945,15 +34223,33 @@
33945
34223
  "text": "boolean"
33946
34224
  },
33947
34225
  "default": "false",
33948
- "description": "Whether or not to show a value range. When false, the slider displays a slide-able handle for the value property; when true, it displays slide-able handles for the valueStart and valueEnd properties.",
34226
+ "description": "Indicates whether it is a range slider. When true, the slider displays two handles for selecting a range of values.\nWhen false, the slider displays a single handle for selecting a single value.",
33949
34227
  "fieldName": "range"
33950
34228
  },
34229
+ {
34230
+ "name": "min",
34231
+ "type": {
34232
+ "text": "number"
34233
+ },
34234
+ "description": "The slider minimum value.",
34235
+ "default": "0",
34236
+ "fieldName": "min"
34237
+ },
34238
+ {
34239
+ "name": "max",
34240
+ "type": {
34241
+ "text": "number"
34242
+ },
34243
+ "description": "The slider maximum value.",
34244
+ "default": "100",
34245
+ "fieldName": "max"
34246
+ },
33951
34247
  {
33952
34248
  "name": "disabled",
33953
34249
  "type": {
33954
34250
  "text": "boolean | undefined"
33955
34251
  },
33956
- "description": "Whether the slider is disabled.",
34252
+ "description": "Whether the slider is disabled. When true, the slider cannot be interacted with.",
33957
34253
  "fieldName": "disabled"
33958
34254
  },
33959
34255
  {
@@ -33980,24 +34276,6 @@
33980
34276
  "description": "Icon that represents the maximum value; ex: speaker with full volume.",
33981
34277
  "fieldName": "trailingIcon"
33982
34278
  },
33983
- {
33984
- "name": "min",
33985
- "type": {
33986
- "text": "number"
33987
- },
33988
- "default": "0",
33989
- "description": "The slider minimum value.",
33990
- "fieldName": "min"
33991
- },
33992
- {
33993
- "name": "max",
33994
- "type": {
33995
- "text": "number"
33996
- },
33997
- "default": "100",
33998
- "description": "The slider maximum value.",
33999
- "fieldName": "max"
34000
- },
34001
34279
  {
34002
34280
  "name": "value",
34003
34281
  "type": {
@@ -34027,8 +34305,8 @@
34027
34305
  "type": {
34028
34306
  "text": "number"
34029
34307
  },
34308
+ "description": "The step between values. If defined and greater than 1, we will show tick marks and the stepper will snap to the nearest tick mark.",
34030
34309
  "default": "1",
34031
- "description": "The step between values. This will show tick marks and the stepper will snap to the nearest tick mark.",
34032
34310
  "fieldName": "step"
34033
34311
  },
34034
34312
  {
@@ -34058,107 +34336,98 @@
34058
34336
  {
34059
34337
  "name": "value-label",
34060
34338
  "type": {
34061
- "text": "string"
34339
+ "text": "string | undefined"
34062
34340
  },
34063
- "default": "''",
34064
- "description": "An optional label for the slider's value displayed when range is false; if not set, the label is the value itself.",
34341
+ "description": "An optional label for the slider's value displayed when range is false; if not set, the label is the 'value' itself.",
34065
34342
  "fieldName": "valueLabel"
34066
34343
  },
34067
34344
  {
34068
34345
  "name": "value-label-start",
34069
34346
  "type": {
34070
- "text": "string"
34347
+ "text": "string | undefined"
34071
34348
  },
34072
- "default": "''",
34073
- "description": "An optional label for the slider's start value displayed when range is true; if not set, the label is the valueStart itself.",
34349
+ "description": "An optional label for the slider's start value displayed when range is true; if not set, the label is the 'valueStart' itself.",
34074
34350
  "fieldName": "valueLabelStart"
34075
34351
  },
34076
34352
  {
34077
34353
  "name": "value-label-end",
34078
34354
  "type": {
34079
- "text": "string"
34355
+ "text": "string | undefined"
34080
34356
  },
34081
- "default": "''",
34082
- "description": "An optional label for the slider's end value displayed when range is true; if not set, the label is the valueEnd itself.",
34357
+ "description": "An optional label for the slider's end value displayed when range is true; if not set, the label is the 'valueEnd' itself.",
34083
34358
  "fieldName": "valueLabelEnd"
34084
34359
  },
34085
34360
  {
34086
- "name": "aria-label-start",
34361
+ "name": "name",
34087
34362
  "type": {
34088
- "text": "string"
34363
+ "text": "string | undefined"
34089
34364
  },
34090
- "default": "''",
34091
- "description": "Aria label for the slider's start handle displayed when range is true.",
34092
- "fieldName": "ariaLabelStart"
34365
+ "description": "Name attribute for the slider (single value).",
34366
+ "fieldName": "name"
34093
34367
  },
34094
34368
  {
34095
- "name": "aria-valuetext-start",
34369
+ "name": "name-start",
34096
34370
  "type": {
34097
- "text": "string"
34371
+ "text": "string | undefined"
34098
34372
  },
34099
- "default": "''",
34100
- "description": "Aria value text for the slider's start value displayed when range is true.",
34101
- "fieldName": "ariaValuetextStart"
34373
+ "description": "Name attribute for the slider's start handle when range is true.",
34374
+ "fieldName": "nameStart"
34102
34375
  },
34103
34376
  {
34104
- "name": "aria-label-end",
34377
+ "name": "name-end",
34105
34378
  "type": {
34106
- "text": "string"
34379
+ "text": "string | undefined"
34107
34380
  },
34108
- "default": "''",
34109
- "description": "Aria label for the slider's end handle displayed when range is true.",
34110
- "fieldName": "ariaLabelEnd"
34381
+ "description": "Name attribute for the slider's end handle when range is true.",
34382
+ "fieldName": "nameEnd"
34111
34383
  },
34112
34384
  {
34113
- "name": "aria-valuetext-end",
34385
+ "name": "data-aria-label",
34114
34386
  "type": {
34115
- "text": "string"
34387
+ "text": "string | undefined"
34116
34388
  },
34117
- "default": "''",
34118
- "description": "Aria value text for the slider's end value displayed when range is true.",
34119
- "fieldName": "ariaValuetextEnd"
34389
+ "description": "Aria label for the slider's handle displayed when range is false.",
34390
+ "fieldName": "dataAriaLabel"
34120
34391
  },
34121
34392
  {
34122
- "name": "name",
34393
+ "name": "start-aria-label",
34123
34394
  "type": {
34124
34395
  "text": "string | undefined"
34125
34396
  },
34126
- "description": "Name attribute for the slider (single value).",
34127
- "fieldName": "name"
34397
+ "description": "Aria label for the slider's start handle displayed when range is true.",
34398
+ "fieldName": "startAriaLabel"
34128
34399
  },
34129
34400
  {
34130
- "name": "name-start",
34401
+ "name": "end-aria-label",
34131
34402
  "type": {
34132
34403
  "text": "string | undefined"
34133
34404
  },
34134
- "description": "Name attribute for the slider's start handle (range).",
34135
- "fieldName": "nameStart"
34405
+ "description": "Aria label for the slider's end handle displayed when range is true.",
34406
+ "fieldName": "endAriaLabel"
34136
34407
  },
34137
34408
  {
34138
- "name": "name-end",
34409
+ "name": "data-aria-valuetext",
34139
34410
  "type": {
34140
34411
  "text": "string | undefined"
34141
34412
  },
34142
- "description": "Name attribute for the slider's end handle (range).",
34143
- "fieldName": "nameEnd"
34413
+ "description": "Aria value text for the slider's value displayed when range is false.",
34414
+ "fieldName": "dataAriaValuetext"
34144
34415
  },
34145
34416
  {
34146
- "name": "data-aria-valuetext",
34417
+ "name": "start-aria-valuetext",
34147
34418
  "type": {
34148
- "text": "string"
34419
+ "text": "string | undefined"
34149
34420
  },
34150
- "default": "''",
34151
- "description": "Aria value text for the slider's value displayed when range is false.",
34152
- "fieldName": "dataAriaValuetext"
34421
+ "description": "Aria value text for the slider's start value displayed when range is true.",
34422
+ "fieldName": "startAriaValuetext"
34153
34423
  },
34154
34424
  {
34155
- "name": "data-aria-label",
34425
+ "name": "end-aria-valuetext",
34156
34426
  "type": {
34157
- "text": "string"
34427
+ "text": "string | undefined"
34158
34428
  },
34159
- "default": "''",
34160
- "description": "Aria label for the slider's handle displayed when range is false.",
34161
- "fieldName": "dataAriaLabel"
34429
+ "description": "Aria value text for the slider's end value displayed when range is true.",
34430
+ "fieldName": "endAriaValueText"
34162
34431
  }
34163
34432
  ],
34164
34433
  "superclass": {
@@ -34166,7 +34435,7 @@
34166
34435
  "module": "/src/models"
34167
34436
  },
34168
34437
  "tagName": "mdc-slider",
34169
- "jsDoc": "/**\n * slider component, which ...\n *\n * @tagname mdc-slider\n *\n * @slot default - This is a default/unnamed slot\n *\n * @cssproperty --custom-property-name - Description of the CSS custom property\n */",
34438
+ "jsDoc": "/**\n * Slider component is used to select a value or range of values from within a defined range.\n * It provides a visual representation of the current value(s) and allows users to adjust the value(s) by dragging the thumb(s) along the track.\n * It can be used as a single slider or a range slider. This is set by the boolean attribute `range`\n * If the step value is more than 1, tick marks are shown to represent the steps between the min and max values. The slider thumb will snap to the nearest tick mark.\n *\n * @tagname mdc-slider\n *\n * @dependency mdc-icon\n *\n * @csspart slider-tooltip - The tooltip of the slider\n * @csspart slider-track - The track of the slider\n * @csspart slider-wrapper - The wrapper around the slider input(s)\n * @csspart slider-ticks - The container for the tick marks\n * @csspart slider-tick - The individual tick marks\n * @csspart slider-input - The input element of the slider\n * @csspart slider-label - The label of the slider\n *\n * @event input - Fired when the slider value changes\n * @event change - Fired when the slider value is committed\n *\n * @cssproperty --mdc-slider-thumb-color - The color of the slider thumb\n * @cssproperty --mdc-slider-thumb-border-color - The color of the slider thumb border\n * @cssproperty --mdc-slider-thumb-size - The size of the slider thumb\n * @cssproperty --mdc-slider-input-size - The height of the slider input\n * @cssproperty --mdc-slider-tick-size - The size of the slider tick marks\n * @cssproperty --mdc-slider-track-height - The height of the slider track\n * @cssproperty --mdc-slider-tick-color - The color of the slider tick marks\n * @cssproperty --mdc-slider-progress-color - The color of the slider progress\n * @cssproperty --mdc-slider-track-color - The color of the slider track\n * @cssproperty --mdc-slider-tooltip-left - The left position of the slider tooltip\n * @cssproperty --mdc-slider-tick-left - The left position of the slider tick marks\n */",
34170
34439
  "customElement": true
34171
34440
  }
34172
34441
  ],