@sbb-esta/lyne-elements-dev 4.6.0-dev.1772439044 → 4.6.0-dev.1772440255

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.
Files changed (2) hide show
  1. package/custom-elements.json +1824 -1824
  2. package/package.json +2 -2
package/custom-elements.json CHANGED
@@ -86708,23 +86708,27 @@
86708
86708
  },
86709
86709
  {
86710
86710
  "kind": "javascript-module",
86711
- "path": "menu/menu/menu.component.js",
86711
+ "path": "menu/menu-button/menu-button.component.js",
86712
86712
  "declarations": [
86713
86713
  {
86714
86714
  "kind": "class",
86715
- "description": "It displays a contextual menu with one or more action element.",
86716
- "name": "SbbMenuElement",
86715
+ "description": "It displays a button element that can be used in the `sbb-menu` component.",
86716
+ "name": "SbbMenuButtonElement",
86717
86717
  "cssProperties": [
86718
86718
  {
86719
- "description": "To specify a custom stack order, the `z-index` can be overridden by defining this CSS variable. The default `z-index` of the component is set to `var(--sbb-overlay-default-z-index)` with a value of `1000`.",
86720
- "name": "--sbb-menu-z-index",
86721
- "default": "var(--sbb-overlay-default-z-index)"
86719
+ "description": "Can be used to modify horizontal padding.",
86720
+ "name": "--sbb-menu-action-outer-horizontal-padding",
86721
+ "default": "var(--sbb-spacing-fixed-3x)"
86722
86722
  }
86723
86723
  ],
86724
86724
  "slots": [
86725
86725
  {
86726
- "description": "Use the unnamed slot to add `sbb-menu-button`/`sbb-menu-link` or other elements to the menu.",
86726
+ "description": "Use the unnamed slot to add content to the `sbb-menu-button`.",
86727
86727
  "name": ""
86728
+ },
86729
+ {
86730
+ "description": "Use this slot to provide an icon. If `icon-name` is set, a `sbb-icon` will be used.",
86731
+ "name": "icon"
86728
86732
  }
86729
86733
  ],
86730
86734
  "members": [
@@ -86732,268 +86736,255 @@
86732
86736
  "kind": "field",
86733
86737
  "name": "role",
86734
86738
  "type": {
86735
- "text": "string"
86739
+ "text": "ElementInternals['role']"
86736
86740
  },
86737
86741
  "privacy": "public",
86738
86742
  "static": true,
86739
86743
  "readonly": true,
86740
- "default": "'menu'"
86744
+ "default": "'menuitem'",
86745
+ "inheritedFrom": {
86746
+ "name": "SbbButtonLikeBaseElement",
86747
+ "module": "core/base-elements/button-base-element.js"
86748
+ }
86741
86749
  },
86742
86750
  {
86743
86751
  "kind": "field",
86744
- "name": "trigger",
86752
+ "name": "disabledInteractive",
86745
86753
  "type": {
86746
- "text": "HTMLElement | null"
86754
+ "text": "boolean"
86747
86755
  },
86748
86756
  "privacy": "public",
86749
- "default": "null",
86750
- "description": "The element that will trigger the menu overlay.\n\nFor attribute usage, provide an id reference.",
86751
- "attribute": "trigger"
86752
- },
86753
- {
86754
- "kind": "field",
86755
- "name": "_menu",
86756
- "type": {
86757
- "text": "HTMLDivElement"
86758
- },
86759
- "privacy": "private"
86760
- },
86761
- {
86762
- "kind": "field",
86763
- "name": "_triggerElement",
86764
- "type": {
86765
- "text": "HTMLElement | null"
86766
- },
86767
- "privacy": "private",
86768
- "default": "null"
86769
- },
86770
- {
86771
- "kind": "field",
86772
- "name": "_triggerAbortController",
86773
- "type": {
86774
- "text": "AbortController"
86775
- },
86776
- "privacy": "private"
86757
+ "default": "false",
86758
+ "description": "Whether the button should be aria-disabled but stay interactive.",
86759
+ "attribute": "disabled-interactive",
86760
+ "reflects": true,
86761
+ "inheritedFrom": {
86762
+ "name": "SbbDisabledInteractiveMixin",
86763
+ "module": "core/mixins/disabled-mixin.js"
86764
+ }
86777
86765
  },
86778
86766
  {
86779
86767
  "kind": "field",
86780
- "name": "_isPointerDownEventOnMenu",
86768
+ "name": "disabled",
86769
+ "privacy": "public",
86770
+ "description": "Whether the component is disabled.",
86771
+ "default": "false",
86781
86772
  "type": {
86782
86773
  "text": "boolean"
86783
86774
  },
86784
- "privacy": "private",
86785
- "default": "false"
86786
- },
86787
- {
86788
- "kind": "field",
86789
- "name": "_windowEventsController",
86790
- "type": {
86791
- "text": "AbortController"
86792
- },
86793
- "privacy": "private"
86794
- },
86795
- {
86796
- "kind": "field",
86797
- "name": "_escapableOverlayController",
86798
- "privacy": "private",
86799
- "default": "new SbbEscapableOverlayController(this)"
86800
- },
86801
- {
86802
- "kind": "field",
86803
- "name": "_focusTrapController",
86804
- "privacy": "private",
86805
- "default": "new SbbFocusTrapController(this)"
86806
- },
86807
- {
86808
- "kind": "field",
86809
- "name": "_scrollHandler",
86810
- "privacy": "private",
86811
- "default": "new SbbScrollHandler()"
86812
- },
86813
- {
86814
- "kind": "field",
86815
- "name": "_inertController",
86816
- "privacy": "private",
86817
- "default": "new SbbInertController(this)"
86818
- },
86819
- {
86820
- "kind": "field",
86821
- "name": "_mobileBreakpoint",
86822
- "privacy": "private",
86823
- "default": "SbbMediaQueryBreakpointSmallAndBelow"
86824
- },
86825
- {
86826
- "kind": "field",
86827
- "name": "_mediaMatcher",
86828
- "privacy": "private",
86829
- "default": "new SbbMediaMatcherController(this, { [this._mobileBreakpoint]: (matches) => { if (matches && (this.state === 'opening' || this.state === 'opened')) { this._scrollHandler.disableScroll(); } else { this._scrollHandler.enableScroll(); } }, })"
86830
- },
86831
- {
86832
- "kind": "field",
86833
- "name": "_darkModeController",
86834
- "privacy": "private",
86835
- "default": "new SbbDarkModeController(this, () => this._syncNegative())"
86775
+ "attribute": "disabled",
86776
+ "reflects": true,
86777
+ "inheritedFrom": {
86778
+ "name": "SbbDisabledMixin",
86779
+ "module": "core/mixins/disabled-mixin.js"
86780
+ }
86836
86781
  },
86837
86782
  {
86838
86783
  "kind": "field",
86839
- "name": "_language",
86784
+ "name": "#disabled",
86840
86785
  "privacy": "private",
86841
- "default": "new SbbLanguageController(this)"
86842
- },
86843
- {
86844
- "kind": "field",
86845
- "name": "_nestedMenu",
86846
86786
  "type": {
86847
- "text": "SbbMenuElement | null"
86787
+ "text": "boolean"
86848
86788
  },
86849
- "privacy": "private",
86850
- "default": "null"
86789
+ "default": "false",
86790
+ "inheritedFrom": {
86791
+ "name": "SbbDisabledMixin",
86792
+ "module": "core/mixins/disabled-mixin.js"
86793
+ }
86851
86794
  },
86852
86795
  {
86853
86796
  "kind": "method",
86854
- "name": "escapeStrategy",
86855
- "privacy": "public",
86797
+ "name": "isDisabledExternally",
86798
+ "privacy": "protected",
86856
86799
  "return": {
86857
86800
  "type": {
86858
- "text": "void"
86801
+ "text": "boolean"
86859
86802
  }
86860
86803
  },
86861
- "description": "The method which is called on escape key press. Defaults to calling close()",
86804
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
86862
86805
  "inheritedFrom": {
86863
- "name": "SbbOpenCloseBaseElement",
86864
- "module": "core/base-elements/open-close-base-element.js"
86806
+ "name": "SbbDisabledMixin",
86807
+ "module": "core/mixins/disabled-mixin.js"
86865
86808
  }
86866
86809
  },
86867
86810
  {
86868
- "kind": "method",
86869
- "name": "open",
86870
- "privacy": "public",
86871
- "return": {
86872
- "type": {
86873
- "text": "void"
86874
- }
86811
+ "kind": "field",
86812
+ "name": "styles",
86813
+ "type": {
86814
+ "text": "CSSResultGroup"
86875
86815
  },
86876
- "description": "Opens the menu on trigger click.",
86816
+ "privacy": "public",
86817
+ "static": true,
86818
+ "default": "[boxSizingStyles, style]",
86877
86819
  "inheritedFrom": {
86878
- "name": "SbbOpenCloseBaseElement",
86879
- "module": "core/base-elements/open-close-base-element.js"
86820
+ "name": "SbbMenuActionCommonElementMixin",
86821
+ "module": "menu/common/menu-action-common.js"
86880
86822
  }
86881
86823
  },
86882
86824
  {
86883
86825
  "kind": "method",
86884
- "name": "close",
86885
- "privacy": "public",
86826
+ "name": "renderTemplate",
86827
+ "privacy": "protected",
86886
86828
  "return": {
86887
86829
  "type": {
86888
- "text": "void"
86830
+ "text": "TemplateResult"
86889
86831
  }
86890
86832
  },
86891
- "description": "Closes the menu and all its nested menus.",
86833
+ "description": "Override this method to render the component template.",
86892
86834
  "inheritedFrom": {
86893
- "name": "SbbOpenCloseBaseElement",
86894
- "module": "core/base-elements/open-close-base-element.js"
86835
+ "name": "SbbActionBaseElement",
86836
+ "module": "core/base-elements/action-base-element.js"
86895
86837
  }
86896
86838
  },
86897
86839
  {
86898
- "kind": "method",
86899
- "name": "closeAll",
86900
- "privacy": "public",
86901
- "return": {
86902
- "type": {
86903
- "text": "void"
86904
- }
86840
+ "kind": "field",
86841
+ "name": "iconName",
86842
+ "type": {
86843
+ "text": "string"
86905
86844
  },
86906
- "description": "Closes the menu and all related menus (nested and parent menus)."
86845
+ "privacy": "public",
86846
+ "default": "''",
86847
+ "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
86848
+ "attribute": "icon-name",
86849
+ "inheritedFrom": {
86850
+ "name": "SbbIconNameMixin",
86851
+ "module": "icon/icon-name-mixin.js"
86852
+ }
86907
86853
  },
86908
86854
  {
86909
86855
  "kind": "method",
86910
- "name": "_close",
86911
- "privacy": "private",
86856
+ "name": "renderIconSlot",
86857
+ "privacy": "protected",
86912
86858
  "return": {
86913
86859
  "type": {
86914
- "text": "void"
86860
+ "text": "TemplateResult"
86915
86861
  }
86916
86862
  },
86917
86863
  "parameters": [
86918
86864
  {
86919
- "name": "closeAll",
86920
- "default": "false",
86921
- "description": "If true, it ensures animations are correct by toggling some states when closing all related menus at once.",
86922
- "optional": true
86923
- }
86924
- ]
86925
- },
86926
- {
86927
- "kind": "method",
86928
- "name": "_isZeroAnimationDuration",
86929
- "privacy": "private",
86930
- "return": {
86931
- "type": {
86932
- "text": "boolean"
86865
+ "name": "classname",
86866
+ "optional": true,
86867
+ "type": {
86868
+ "text": "string"
86869
+ }
86933
86870
  }
86871
+ ],
86872
+ "inheritedFrom": {
86873
+ "name": "SbbIconNameMixin",
86874
+ "module": "icon/icon-name-mixin.js"
86934
86875
  }
86935
86876
  },
86936
86877
  {
86937
86878
  "kind": "method",
86938
- "name": "_handleOpening",
86939
- "privacy": "private",
86879
+ "name": "renderIconName",
86880
+ "privacy": "protected",
86940
86881
  "return": {
86941
86882
  "type": {
86942
- "text": "void"
86883
+ "text": "string"
86943
86884
  }
86885
+ },
86886
+ "inheritedFrom": {
86887
+ "name": "SbbIconNameMixin",
86888
+ "module": "icon/icon-name-mixin.js"
86944
86889
  }
86945
86890
  },
86946
86891
  {
86947
86892
  "kind": "method",
86948
- "name": "_handleClosing",
86893
+ "name": "_renderIconName",
86949
86894
  "privacy": "private",
86950
86895
  "return": {
86951
86896
  "type": {
86952
- "text": "void"
86897
+ "text": "string"
86953
86898
  }
86899
+ },
86900
+ "inheritedFrom": {
86901
+ "name": "SbbIconNameMixin",
86902
+ "module": "icon/icon-name-mixin.js"
86954
86903
  }
86955
86904
  },
86956
86905
  {
86957
- "kind": "method",
86958
- "name": "_handleKeyDown",
86906
+ "kind": "field",
86907
+ "name": "_elementsOnWhichEnterPressTriggersSubmit",
86908
+ "type": {
86909
+ "text": "array"
86910
+ },
86959
86911
  "privacy": "private",
86960
- "return": {
86961
- "type": {
86962
- "text": "void"
86963
- }
86912
+ "readonly": true,
86913
+ "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
86914
+ "inheritedFrom": {
86915
+ "name": "SbbButtonBaseElement",
86916
+ "module": "core/base-elements/button-base-element.js"
86917
+ }
86918
+ },
86919
+ {
86920
+ "kind": "field",
86921
+ "name": "value",
86922
+ "type": {
86923
+ "text": "string"
86964
86924
  },
86965
- "parameters": [
86966
- {
86967
- "name": "evt",
86968
- "type": {
86969
- "text": "KeyboardEvent"
86970
- }
86971
- }
86972
- ]
86925
+ "privacy": "public",
86926
+ "inheritedFrom": {
86927
+ "name": "SbbButtonBaseElement",
86928
+ "module": "core/base-elements/button-base-element.js"
86929
+ },
86930
+ "default": "''",
86931
+ "description": "Value of the form element.",
86932
+ "attribute": "value"
86973
86933
  },
86974
86934
  {
86975
- "kind": "method",
86976
- "name": "_configureTrigger",
86935
+ "kind": "field",
86936
+ "name": "type",
86937
+ "privacy": "public",
86938
+ "description": "The type attribute to use for the button.",
86939
+ "default": "'button'",
86940
+ "type": {
86941
+ "text": "SbbButtonType"
86942
+ },
86943
+ "attribute": "type",
86944
+ "inheritedFrom": {
86945
+ "name": "SbbButtonBaseElement",
86946
+ "module": "core/base-elements/button-base-element.js"
86947
+ }
86948
+ },
86949
+ {
86950
+ "kind": "field",
86951
+ "name": "form",
86952
+ "type": {
86953
+ "text": "HTMLFormElement | null"
86954
+ },
86955
+ "privacy": "public",
86956
+ "description": "The `<form>` element to associate the button with.",
86957
+ "inheritedFrom": {
86958
+ "name": "SbbButtonBaseElement",
86959
+ "module": "core/base-elements/button-base-element.js"
86960
+ },
86961
+ "attribute": "form"
86962
+ },
86963
+ {
86964
+ "kind": "field",
86965
+ "name": "_formId",
86966
+ "type": {
86967
+ "text": "string"
86968
+ },
86977
86969
  "privacy": "private",
86978
- "return": {
86979
- "type": {
86980
- "text": "void"
86981
- }
86970
+ "default": "''",
86971
+ "inheritedFrom": {
86972
+ "name": "SbbButtonBaseElement",
86973
+ "module": "core/base-elements/button-base-element.js"
86982
86974
  }
86983
86975
  },
86984
86976
  {
86985
- "kind": "method",
86986
- "name": "_attachWindowEvents",
86977
+ "kind": "field",
86978
+ "name": "_handleButtonClick",
86987
86979
  "privacy": "private",
86988
- "return": {
86989
- "type": {
86990
- "text": "void"
86991
- }
86980
+ "inheritedFrom": {
86981
+ "name": "SbbButtonBaseElement",
86982
+ "module": "core/base-elements/button-base-element.js"
86992
86983
  }
86993
86984
  },
86994
86985
  {
86995
86986
  "kind": "method",
86996
- "name": "_interactiveElementClick",
86987
+ "name": "_requestSubmit",
86997
86988
  "privacy": "private",
86998
86989
  "return": {
86999
86990
  "type": {
@@ -87002,79 +86993,154 @@
87002
86993
  },
87003
86994
  "parameters": [
87004
86995
  {
87005
- "name": "event",
86996
+ "name": "form",
87006
86997
  "type": {
87007
- "text": "Event"
86998
+ "text": "HTMLFormElement"
87008
86999
  }
87009
87000
  }
87010
- ]
87001
+ ],
87002
+ "inheritedFrom": {
87003
+ "name": "SbbButtonBaseElement",
87004
+ "module": "core/base-elements/button-base-element.js"
87005
+ }
87011
87006
  },
87012
87007
  {
87013
87008
  "kind": "field",
87014
- "name": "_pointerDownListener",
87015
- "privacy": "private"
87009
+ "name": "_formKeyDown",
87010
+ "privacy": "private",
87011
+ "inheritedFrom": {
87012
+ "name": "SbbButtonBaseElement",
87013
+ "module": "core/base-elements/button-base-element.js"
87014
+ }
87016
87015
  },
87017
87016
  {
87018
87017
  "kind": "field",
87019
- "name": "_closeOnBackdropClick",
87020
- "privacy": "private"
87018
+ "name": "formAssociated",
87019
+ "type": {
87020
+ "text": "boolean"
87021
+ },
87022
+ "privacy": "public",
87023
+ "static": true,
87024
+ "default": "true",
87025
+ "inheritedFrom": {
87026
+ "name": "SbbFormAssociatedMixin",
87027
+ "module": "core/mixins/form-associated-mixin.js"
87028
+ }
87021
87029
  },
87022
87030
  {
87023
- "kind": "method",
87024
- "name": "_nestedMenus",
87025
- "privacy": "private",
87026
- "return": {
87027
- "type": {
87028
- "text": "SbbMenuElement[]"
87029
- }
87031
+ "kind": "field",
87032
+ "name": "name",
87033
+ "privacy": "public",
87034
+ "description": "Name of the form element. Will be read from name attribute.",
87035
+ "type": {
87036
+ "text": "string"
87030
87037
  },
87031
- "description": "Converts the linked list into an array of SbbMenuElement."
87038
+ "attribute": "name",
87039
+ "inheritedFrom": {
87040
+ "name": "SbbFormAssociatedMixin",
87041
+ "module": "core/mixins/form-associated-mixin.js"
87042
+ }
87032
87043
  },
87033
87044
  {
87034
- "kind": "method",
87035
- "name": "_parentMenu",
87036
- "privacy": "private",
87037
- "return": {
87038
- "type": {
87039
- "text": "SbbMenuElement | null"
87040
- }
87045
+ "kind": "field",
87046
+ "name": "validity",
87047
+ "type": {
87048
+ "text": "ValidityState"
87049
+ },
87050
+ "privacy": "public",
87051
+ "description": "Returns the ValidityState object for this element.",
87052
+ "readonly": true,
87053
+ "inheritedFrom": {
87054
+ "name": "SbbFormAssociatedMixin",
87055
+ "module": "core/mixins/form-associated-mixin.js"
87041
87056
  }
87042
87057
  },
87043
87058
  {
87044
- "kind": "method",
87045
- "name": "_mainMenu",
87059
+ "kind": "field",
87060
+ "name": "validationMessage",
87061
+ "type": {
87062
+ "text": "string"
87063
+ },
87064
+ "privacy": "public",
87065
+ "description": "Returns the current error message, if available, which corresponds\nto the current validation state.\nPlease note that only one message is returned at a time (e.g. if\nmultiple validity states are invalid, only the chronologically first one\nis returned until it is fixed, at which point the next message might be\nreturned, if it is still applicable). Also, a custom validity message\n(see below) has precedence over native validation messages.",
87066
+ "readonly": true,
87067
+ "inheritedFrom": {
87068
+ "name": "SbbFormAssociatedMixin",
87069
+ "module": "core/mixins/form-associated-mixin.js"
87070
+ }
87071
+ },
87072
+ {
87073
+ "kind": "field",
87074
+ "name": "willValidate",
87075
+ "type": {
87076
+ "text": "boolean"
87077
+ },
87078
+ "privacy": "public",
87079
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
87080
+ "readonly": true,
87081
+ "inheritedFrom": {
87082
+ "name": "SbbFormAssociatedMixin",
87083
+ "module": "core/mixins/form-associated-mixin.js"
87084
+ }
87085
+ },
87086
+ {
87087
+ "kind": "field",
87088
+ "name": "_validityStates",
87046
87089
  "privacy": "private",
87047
- "return": {
87048
- "type": {
87049
- "text": "SbbMenuElement"
87050
- }
87090
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
87091
+ "inheritedFrom": {
87092
+ "name": "SbbFormAssociatedMixin",
87093
+ "module": "core/mixins/form-associated-mixin.js"
87094
+ }
87095
+ },
87096
+ {
87097
+ "kind": "field",
87098
+ "name": "formDisabled",
87099
+ "type": {
87100
+ "text": "boolean"
87051
87101
  },
87052
- "description": "The outermost menu."
87102
+ "privacy": "protected",
87103
+ "default": "false",
87104
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
87105
+ "inheritedFrom": {
87106
+ "name": "SbbFormAssociatedMixin",
87107
+ "module": "core/mixins/form-associated-mixin.js"
87108
+ }
87053
87109
  },
87054
87110
  {
87055
87111
  "kind": "method",
87056
- "name": "_isNested",
87057
- "privacy": "private",
87112
+ "name": "checkValidity",
87113
+ "privacy": "public",
87058
87114
  "return": {
87059
87115
  "type": {
87060
87116
  "text": "boolean"
87061
87117
  }
87118
+ },
87119
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
87120
+ "inheritedFrom": {
87121
+ "name": "SbbFormAssociatedMixin",
87122
+ "module": "core/mixins/form-associated-mixin.js"
87062
87123
  }
87063
87124
  },
87064
87125
  {
87065
87126
  "kind": "method",
87066
- "name": "_updateNestedInert",
87067
- "privacy": "private",
87127
+ "name": "reportValidity",
87128
+ "privacy": "public",
87068
87129
  "return": {
87069
87130
  "type": {
87070
- "text": "void"
87131
+ "text": "boolean"
87071
87132
  }
87133
+ },
87134
+ "description": "Returns true if this element has no validity problems; otherwise,\nreturns false, fires an invalid event at the element,\nand (if the event isn't canceled) reports the problem to the user.",
87135
+ "inheritedFrom": {
87136
+ "name": "SbbFormAssociatedMixin",
87137
+ "module": "core/mixins/form-associated-mixin.js"
87072
87138
  }
87073
87139
  },
87074
87140
  {
87075
87141
  "kind": "method",
87076
- "name": "_handleMouseOver",
87077
- "privacy": "private",
87142
+ "name": "setCustomValidity",
87143
+ "privacy": "public",
87078
87144
  "return": {
87079
87145
  "type": {
87080
87146
  "text": "void"
@@ -87082,64 +87148,100 @@
87082
87148
  },
87083
87149
  "parameters": [
87084
87150
  {
87085
- "name": "event",
87151
+ "name": "message",
87086
87152
  "type": {
87087
- "text": "MouseEvent"
87153
+ "text": "string"
87088
87154
  }
87089
87155
  }
87090
- ]
87156
+ ],
87157
+ "description": "Sets the custom validity message for this element. Use the empty string\nto indicate that the element does not have a custom validity error.",
87158
+ "inheritedFrom": {
87159
+ "name": "SbbFormAssociatedMixin",
87160
+ "module": "core/mixins/form-associated-mixin.js"
87161
+ }
87091
87162
  },
87092
87163
  {
87093
87164
  "kind": "method",
87094
- "name": "_onMenuAnimationEnd",
87165
+ "name": "_hasDisabledAncestor",
87095
87166
  "privacy": "private",
87096
87167
  "return": {
87097
87168
  "type": {
87098
- "text": "void"
87169
+ "text": "boolean"
87099
87170
  }
87100
87171
  },
87101
- "parameters": [
87102
- {
87103
- "name": "event",
87104
- "type": {
87105
- "text": "AnimationEvent"
87106
- }
87107
- }
87108
- ]
87172
+ "inheritedFrom": {
87173
+ "name": "SbbFormAssociatedMixin",
87174
+ "module": "core/mixins/form-associated-mixin.js"
87175
+ }
87109
87176
  },
87110
87177
  {
87111
87178
  "kind": "method",
87112
- "name": "_setMenuPosition",
87113
- "privacy": "private",
87179
+ "name": "updateFormValue",
87180
+ "privacy": "protected",
87114
87181
  "return": {
87115
87182
  "type": {
87116
87183
  "text": "void"
87117
87184
  }
87185
+ },
87186
+ "description": "Should be called when form value is changed.\nAdapts and sets the formValue in the supported format (string | FormData | File | null)\nhttps://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/setFormValue",
87187
+ "inheritedFrom": {
87188
+ "name": "SbbFormAssociatedMixin",
87189
+ "module": "core/mixins/form-associated-mixin.js"
87118
87190
  }
87119
87191
  },
87120
87192
  {
87121
87193
  "kind": "method",
87122
- "name": "_syncNegative",
87123
- "privacy": "private",
87194
+ "name": "formState",
87195
+ "privacy": "protected",
87124
87196
  "return": {
87125
87197
  "type": {
87126
- "text": "void"
87198
+ "text": "FormRestoreState"
87127
87199
  }
87200
+ },
87201
+ "inheritedFrom": {
87202
+ "name": "SbbFormAssociatedMixin",
87203
+ "module": "core/mixins/form-associated-mixin.js"
87128
87204
  }
87129
87205
  },
87130
87206
  {
87131
87207
  "kind": "method",
87132
- "name": "_isMobile",
87133
- "privacy": "private",
87208
+ "name": "setValidityFlag",
87209
+ "privacy": "protected",
87134
87210
  "return": {
87135
87211
  "type": {
87136
- "text": "boolean"
87212
+ "text": "void"
87213
+ }
87214
+ },
87215
+ "parameters": [
87216
+ {
87217
+ "name": "flag",
87218
+ "type": {
87219
+ "text": "T"
87220
+ }
87221
+ },
87222
+ {
87223
+ "name": "message",
87224
+ "type": {
87225
+ "text": "string"
87226
+ }
87227
+ },
87228
+ {
87229
+ "name": "flagValue",
87230
+ "optional": true,
87231
+ "type": {
87232
+ "text": "ValidityStateFlags[T]"
87233
+ }
87137
87234
  }
87235
+ ],
87236
+ "description": "Marks this element as suffering from the constraint indicated by the\nflag argument and associates the given message to it.\nNote that only one message is displayed at a time and custom messages by\nconsumers are always displayed before internal messages and internal\nmessages are displayed in the order they were added.\nTo set/define custom validity state flags, you need to extend the\nValidityState prototype (and the CustomValidityState interface).",
87237
+ "inheritedFrom": {
87238
+ "name": "SbbFormAssociatedMixin",
87239
+ "module": "core/mixins/form-associated-mixin.js"
87138
87240
  }
87139
87241
  },
87140
87242
  {
87141
87243
  "kind": "method",
87142
- "name": "toggleState",
87244
+ "name": "removeValidityFlag",
87143
87245
  "privacy": "protected",
87144
87246
  "return": {
87145
87247
  "type": {
@@ -87148,196 +87250,294 @@
87148
87250
  },
87149
87251
  "parameters": [
87150
87252
  {
87151
- "name": "value",
87253
+ "name": "flag",
87152
87254
  "type": {
87153
- "text": "string"
87255
+ "text": "T"
87154
87256
  }
87155
- },
87257
+ }
87258
+ ],
87259
+ "description": "Removes the validity state flag entry and updates validity state.",
87260
+ "inheritedFrom": {
87261
+ "name": "SbbFormAssociatedMixin",
87262
+ "module": "core/mixins/form-associated-mixin.js"
87263
+ }
87264
+ },
87265
+ {
87266
+ "kind": "method",
87267
+ "name": "validate",
87268
+ "privacy": "protected",
87269
+ "return": {
87270
+ "type": {
87271
+ "text": "void"
87272
+ }
87273
+ },
87274
+ "description": "To be called whenever the current element needs to be validated.",
87275
+ "inheritedFrom": {
87276
+ "name": "SbbFormAssociatedMixin",
87277
+ "module": "core/mixins/form-associated-mixin.js"
87278
+ }
87279
+ },
87280
+ {
87281
+ "kind": "method",
87282
+ "name": "shouldValidate",
87283
+ "privacy": "protected",
87284
+ "return": {
87285
+ "type": {
87286
+ "text": "boolean"
87287
+ }
87288
+ },
87289
+ "parameters": [
87156
87290
  {
87157
- "name": "force",
87158
- "optional": true,
87291
+ "name": "name",
87159
87292
  "type": {
87160
- "text": "boolean"
87293
+ "text": "PropertyKey | undefined"
87161
87294
  }
87162
87295
  }
87163
87296
  ],
87297
+ "description": "Whether validation should be run on a property change with the given name.",
87164
87298
  "inheritedFrom": {
87165
- "name": "SbbOpenCloseBaseElement",
87166
- "module": "core/base-elements/open-close-base-element.js"
87299
+ "name": "SbbFormAssociatedMixin",
87300
+ "module": "core/mixins/form-associated-mixin.js"
87167
87301
  }
87168
87302
  },
87169
87303
  {
87170
- "kind": "field",
87171
- "name": "events",
87172
- "privacy": "public",
87173
- "static": true,
87174
- "readonly": true,
87175
- "default": "{ beforeopen: 'beforeopen', open: 'open', beforeclose: 'beforeclose', close: 'close', }",
87176
- "type": {
87177
- "text": "{\n beforeopen: 'beforeopen',\n open: 'open',\n beforeclose: 'beforeclose',\n close: 'close',\n }"
87304
+ "kind": "method",
87305
+ "name": "_setInternalValidity",
87306
+ "privacy": "private",
87307
+ "return": {
87308
+ "type": {
87309
+ "text": "void"
87310
+ }
87178
87311
  },
87179
87312
  "inheritedFrom": {
87180
- "name": "SbbOpenCloseBaseElement",
87181
- "module": "core/base-elements/open-close-base-element.js"
87313
+ "name": "SbbFormAssociatedMixin",
87314
+ "module": "core/mixins/form-associated-mixin.js"
87182
87315
  }
87183
87316
  },
87184
87317
  {
87185
87318
  "kind": "field",
87186
- "name": "state",
87187
- "privacy": "protected",
87188
- "description": "The state of the component.",
87189
- "type": {
87190
- "text": "SbbOpenedClosedState"
87191
- },
87192
- "default": "'closed'",
87319
+ "name": "_preventScrollOnSpaceKeydown",
87320
+ "privacy": "private",
87321
+ "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
87322
+ "parameters": [
87323
+ {
87324
+ "description": "The origin event.",
87325
+ "name": "event"
87326
+ }
87327
+ ],
87193
87328
  "inheritedFrom": {
87194
- "name": "SbbOpenCloseBaseElement",
87195
- "module": "core/base-elements/open-close-base-element.js"
87329
+ "name": "SbbButtonLikeBaseElement",
87330
+ "module": "core/base-elements/button-base-element.js"
87196
87331
  }
87197
87332
  },
87198
87333
  {
87199
87334
  "kind": "field",
87200
- "name": "_state",
87201
- "type": {
87202
- "text": "SbbOpenedClosedState"
87203
- },
87335
+ "name": "_removeActiveMarker",
87204
87336
  "privacy": "private",
87205
87337
  "inheritedFrom": {
87206
- "name": "SbbOpenCloseBaseElement",
87207
- "module": "core/base-elements/open-close-base-element.js"
87338
+ "name": "SbbButtonLikeBaseElement",
87339
+ "module": "core/base-elements/button-base-element.js"
87208
87340
  }
87209
87341
  },
87210
87342
  {
87211
87343
  "kind": "field",
87212
- "name": "isOpen",
87213
- "type": {
87214
- "text": "boolean"
87215
- },
87216
- "privacy": "public",
87217
- "description": "Whether the element is open.",
87218
- "readonly": true,
87344
+ "name": "_dispatchClickEventOnSpaceKeyup",
87345
+ "privacy": "private",
87346
+ "description": "Dispatches a 'click' PointerEvent if the original keyboard event is a 'Space' press.\nAs verified with the native button, when 'Space' is pressed, a 'click' event is dispatched\nafter the 'keyup' event.",
87347
+ "parameters": [
87348
+ {
87349
+ "description": "The origin event.",
87350
+ "name": "event"
87351
+ }
87352
+ ],
87219
87353
  "inheritedFrom": {
87220
- "name": "SbbOpenCloseBaseElement",
87221
- "module": "core/base-elements/open-close-base-element.js"
87354
+ "name": "SbbButtonLikeBaseElement",
87355
+ "module": "core/base-elements/button-base-element.js"
87222
87356
  }
87223
87357
  },
87224
87358
  {
87225
- "kind": "method",
87226
- "name": "dispatchBeforeOpenEvent",
87227
- "privacy": "protected",
87228
- "return": {
87229
- "type": {
87230
- "text": "boolean"
87231
- }
87232
- },
87359
+ "kind": "field",
87360
+ "name": "_dispatchClickEvent",
87361
+ "privacy": "private",
87233
87362
  "inheritedFrom": {
87234
- "name": "SbbOpenCloseBaseElement",
87235
- "module": "core/base-elements/open-close-base-element.js"
87363
+ "name": "SbbButtonLikeBaseElement",
87364
+ "module": "core/base-elements/button-base-element.js"
87236
87365
  }
87237
87366
  },
87238
87367
  {
87239
87368
  "kind": "method",
87240
- "name": "dispatchOpenEvent",
87369
+ "name": "toggleState",
87241
87370
  "privacy": "protected",
87242
87371
  "return": {
87243
87372
  "type": {
87244
- "text": "boolean"
87373
+ "text": "void"
87245
87374
  }
87246
87375
  },
87376
+ "parameters": [
87377
+ {
87378
+ "name": "value",
87379
+ "type": {
87380
+ "text": "string"
87381
+ }
87382
+ },
87383
+ {
87384
+ "name": "force",
87385
+ "optional": true,
87386
+ "type": {
87387
+ "text": "boolean"
87388
+ }
87389
+ }
87390
+ ],
87247
87391
  "inheritedFrom": {
87248
- "name": "SbbOpenCloseBaseElement",
87249
- "module": "core/base-elements/open-close-base-element.js"
87392
+ "name": "SbbActionBaseElement",
87393
+ "module": "core/base-elements/action-base-element.js"
87250
87394
  }
87251
87395
  },
87252
87396
  {
87253
- "kind": "method",
87254
- "name": "dispatchBeforeCloseEvent",
87397
+ "kind": "field",
87398
+ "name": "maybeDisabled",
87399
+ "type": {
87400
+ "text": "boolean | undefined"
87401
+ },
87255
87402
  "privacy": "protected",
87256
- "return": {
87257
- "type": {
87258
- "text": "boolean"
87259
- }
87403
+ "readonly": true,
87404
+ "inheritedFrom": {
87405
+ "name": "SbbActionBaseElement",
87406
+ "module": "core/base-elements/action-base-element.js"
87407
+ }
87408
+ },
87409
+ {
87410
+ "kind": "field",
87411
+ "name": "maybeDisabledInteractive",
87412
+ "type": {
87413
+ "text": "boolean | undefined"
87260
87414
  },
87415
+ "privacy": "protected",
87416
+ "readonly": true,
87261
87417
  "inheritedFrom": {
87262
- "name": "SbbOpenCloseBaseElement",
87263
- "module": "core/base-elements/open-close-base-element.js"
87418
+ "name": "SbbActionBaseElement",
87419
+ "module": "core/base-elements/action-base-element.js"
87264
87420
  }
87265
87421
  },
87266
87422
  {
87267
87423
  "kind": "method",
87268
- "name": "dispatchCloseEvent",
87424
+ "name": "setupBaseEventHandlers",
87269
87425
  "privacy": "protected",
87270
87426
  "return": {
87271
87427
  "type": {
87272
- "text": "boolean"
87428
+ "text": "void"
87273
87429
  }
87274
87430
  },
87275
87431
  "inheritedFrom": {
87276
- "name": "SbbOpenCloseBaseElement",
87277
- "module": "core/base-elements/open-close-base-element.js"
87432
+ "name": "SbbActionBaseElement",
87433
+ "module": "core/base-elements/action-base-element.js"
87278
87434
  }
87279
87435
  }
87280
87436
  ],
87281
- "attributes": [
87437
+ "mixins": [
87282
87438
  {
87283
- "name": "trigger",
87284
- "type": {
87285
- "text": "HTMLElement | null"
87286
- },
87287
- "default": "null",
87288
- "description": "The element that will trigger the menu overlay.\n\nFor attribute usage, provide an id reference.",
87289
- "fieldName": "trigger"
87439
+ "name": "SbbDisabledTabIndexActionMixin",
87440
+ "module": "core/mixins.js"
87441
+ },
87442
+ {
87443
+ "name": "SbbMenuActionCommonElementMixin",
87444
+ "module": "menu/common.js"
87290
87445
  }
87291
87446
  ],
87292
87447
  "superclass": {
87293
- "name": "SbbOpenCloseBaseElement",
87448
+ "name": "SbbButtonBaseElement",
87294
87449
  "module": "core/base-elements.js"
87295
87450
  },
87296
- "tagName": "sbb-menu",
87451
+ "tagName": "sbb-menu-button",
87297
87452
  "customElement": true,
87298
- "events": [
87453
+ "attributes": [
87299
87454
  {
87300
- "name": "beforeopen",
87455
+ "name": "disabled-interactive",
87301
87456
  "type": {
87302
- "text": "Event"
87457
+ "text": "boolean"
87303
87458
  },
87304
- "description": "Emits whenever the component starts the opening transition. Can be canceled.",
87459
+ "default": "false",
87460
+ "description": "Whether the button should be aria-disabled but stay interactive.",
87461
+ "fieldName": "disabledInteractive",
87305
87462
  "inheritedFrom": {
87306
- "name": "SbbOpenCloseBaseElement",
87307
- "module": "core/base-elements/open-close-base-element.js"
87463
+ "name": "SbbDisabledInteractiveMixin",
87464
+ "module": "core/mixins/disabled-mixin.js"
87308
87465
  }
87309
87466
  },
87310
87467
  {
87311
- "name": "open",
87468
+ "name": "disabled",
87469
+ "description": "Whether the component is disabled.",
87470
+ "default": "false",
87312
87471
  "type": {
87313
- "text": "Event"
87472
+ "text": "boolean"
87314
87473
  },
87315
- "description": "Emits whenever the component is opened.",
87474
+ "fieldName": "disabled",
87316
87475
  "inheritedFrom": {
87317
- "name": "SbbOpenCloseBaseElement",
87318
- "module": "core/base-elements/open-close-base-element.js"
87476
+ "name": "SbbDisabledMixin",
87477
+ "module": "core/mixins/disabled-mixin.js"
87319
87478
  }
87320
87479
  },
87321
87480
  {
87322
- "name": "beforeclose",
87481
+ "name": "icon-name",
87323
87482
  "type": {
87324
- "text": "Event"
87483
+ "text": "string"
87325
87484
  },
87326
- "description": "Emits whenever the component begins the closing transition. Can be canceled.",
87485
+ "default": "''",
87486
+ "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
87487
+ "fieldName": "iconName",
87327
87488
  "inheritedFrom": {
87328
- "name": "SbbOpenCloseBaseElement",
87329
- "module": "core/base-elements/open-close-base-element.js"
87489
+ "name": "SbbIconNameMixin",
87490
+ "module": "icon/icon-name-mixin.js"
87330
87491
  }
87331
87492
  },
87332
87493
  {
87333
- "name": "close",
87494
+ "name": "value",
87334
87495
  "type": {
87335
- "text": "Event"
87496
+ "text": "string"
87336
87497
  },
87337
- "description": "Emits whenever the component is closed.",
87498
+ "default": "''",
87499
+ "description": "Value of the form element.",
87500
+ "fieldName": "value",
87338
87501
  "inheritedFrom": {
87339
- "name": "SbbOpenCloseBaseElement",
87340
- "module": "core/base-elements/open-close-base-element.js"
87502
+ "name": "SbbButtonBaseElement",
87503
+ "module": "core/base-elements/button-base-element.js"
87504
+ }
87505
+ },
87506
+ {
87507
+ "name": "type",
87508
+ "description": "The type attribute to use for the button.",
87509
+ "default": "'button'",
87510
+ "type": {
87511
+ "text": "SbbButtonType"
87512
+ },
87513
+ "fieldName": "type",
87514
+ "inheritedFrom": {
87515
+ "name": "SbbButtonBaseElement",
87516
+ "module": "core/base-elements/button-base-element.js"
87517
+ }
87518
+ },
87519
+ {
87520
+ "name": "form",
87521
+ "description": "The `<form>` element to associate the button with.",
87522
+ "type": {
87523
+ "text": "HTMLFormElement | null"
87524
+ },
87525
+ "fieldName": "form",
87526
+ "inheritedFrom": {
87527
+ "name": "SbbButtonBaseElement",
87528
+ "module": "core/base-elements/button-base-element.js"
87529
+ }
87530
+ },
87531
+ {
87532
+ "name": "name",
87533
+ "description": "Name of the form element. Will be read from name attribute.",
87534
+ "type": {
87535
+ "text": "string"
87536
+ },
87537
+ "fieldName": "name",
87538
+ "inheritedFrom": {
87539
+ "name": "SbbFormAssociatedMixin",
87540
+ "module": "core/mixins/form-associated-mixin.js"
87341
87541
  }
87342
87542
  }
87343
87543
  ]
@@ -87346,45 +87546,41 @@
87346
87546
  "exports": [
87347
87547
  {
87348
87548
  "kind": "js",
87349
- "name": "SbbMenuElement",
87549
+ "name": "SbbMenuButtonElement",
87350
87550
  "declaration": {
87351
- "name": "SbbMenuElement",
87352
- "module": "menu/menu/menu.component.js"
87551
+ "name": "SbbMenuButtonElement",
87552
+ "module": "menu/menu-button/menu-button.component.js"
87353
87553
  }
87354
87554
  },
87355
87555
  {
87356
87556
  "kind": "custom-element-definition",
87357
- "name": "sbb-menu",
87557
+ "name": "sbb-menu-button",
87358
87558
  "declaration": {
87359
- "name": "SbbMenuElement",
87360
- "module": "menu/menu/menu.component.js"
87559
+ "name": "SbbMenuButtonElement",
87560
+ "module": "menu/menu-button/menu-button.component.js"
87361
87561
  }
87362
87562
  }
87363
87563
  ]
87364
87564
  },
87365
87565
  {
87366
87566
  "kind": "javascript-module",
87367
- "path": "menu/menu-button/menu-button.component.js",
87567
+ "path": "menu/menu/menu.component.js",
87368
87568
  "declarations": [
87369
87569
  {
87370
87570
  "kind": "class",
87371
- "description": "It displays a button element that can be used in the `sbb-menu` component.",
87372
- "name": "SbbMenuButtonElement",
87571
+ "description": "It displays a contextual menu with one or more action element.",
87572
+ "name": "SbbMenuElement",
87373
87573
  "cssProperties": [
87374
87574
  {
87375
- "description": "Can be used to modify horizontal padding.",
87376
- "name": "--sbb-menu-action-outer-horizontal-padding",
87377
- "default": "var(--sbb-spacing-fixed-3x)"
87575
+ "description": "To specify a custom stack order, the `z-index` can be overridden by defining this CSS variable. The default `z-index` of the component is set to `var(--sbb-overlay-default-z-index)` with a value of `1000`.",
87576
+ "name": "--sbb-menu-z-index",
87577
+ "default": "var(--sbb-overlay-default-z-index)"
87378
87578
  }
87379
87579
  ],
87380
87580
  "slots": [
87381
87581
  {
87382
- "description": "Use the unnamed slot to add content to the `sbb-menu-button`.",
87582
+ "description": "Use the unnamed slot to add `sbb-menu-button`/`sbb-menu-link` or other elements to the menu.",
87383
87583
  "name": ""
87384
- },
87385
- {
87386
- "description": "Use this slot to provide an icon. If `icon-name` is set, a `sbb-icon` will be used.",
87387
- "name": "icon"
87388
87584
  }
87389
87585
  ],
87390
87586
  "members": [
@@ -87392,255 +87588,230 @@
87392
87588
  "kind": "field",
87393
87589
  "name": "role",
87394
87590
  "type": {
87395
- "text": "ElementInternals['role']"
87591
+ "text": "string"
87396
87592
  },
87397
87593
  "privacy": "public",
87398
87594
  "static": true,
87399
87595
  "readonly": true,
87400
- "default": "'menuitem'",
87401
- "inheritedFrom": {
87402
- "name": "SbbButtonLikeBaseElement",
87403
- "module": "core/base-elements/button-base-element.js"
87404
- }
87596
+ "default": "'menu'"
87405
87597
  },
87406
87598
  {
87407
87599
  "kind": "field",
87408
- "name": "disabledInteractive",
87600
+ "name": "trigger",
87409
87601
  "type": {
87410
- "text": "boolean"
87602
+ "text": "HTMLElement | null"
87411
87603
  },
87412
87604
  "privacy": "public",
87413
- "default": "false",
87414
- "description": "Whether the button should be aria-disabled but stay interactive.",
87415
- "attribute": "disabled-interactive",
87416
- "reflects": true,
87417
- "inheritedFrom": {
87418
- "name": "SbbDisabledInteractiveMixin",
87419
- "module": "core/mixins/disabled-mixin.js"
87420
- }
87605
+ "default": "null",
87606
+ "description": "The element that will trigger the menu overlay.\n\nFor attribute usage, provide an id reference.",
87607
+ "attribute": "trigger"
87421
87608
  },
87422
87609
  {
87423
87610
  "kind": "field",
87424
- "name": "disabled",
87425
- "privacy": "public",
87426
- "description": "Whether the component is disabled.",
87427
- "default": "false",
87611
+ "name": "_menu",
87428
87612
  "type": {
87429
- "text": "boolean"
87613
+ "text": "HTMLDivElement"
87430
87614
  },
87431
- "attribute": "disabled",
87432
- "reflects": true,
87433
- "inheritedFrom": {
87434
- "name": "SbbDisabledMixin",
87435
- "module": "core/mixins/disabled-mixin.js"
87436
- }
87615
+ "privacy": "private"
87437
87616
  },
87438
87617
  {
87439
87618
  "kind": "field",
87440
- "name": "#disabled",
87441
- "privacy": "private",
87619
+ "name": "_triggerElement",
87442
87620
  "type": {
87443
- "text": "boolean"
87621
+ "text": "HTMLElement | null"
87444
87622
  },
87445
- "default": "false",
87446
- "inheritedFrom": {
87447
- "name": "SbbDisabledMixin",
87448
- "module": "core/mixins/disabled-mixin.js"
87449
- }
87623
+ "privacy": "private",
87624
+ "default": "null"
87450
87625
  },
87451
87626
  {
87452
- "kind": "method",
87453
- "name": "isDisabledExternally",
87454
- "privacy": "protected",
87455
- "return": {
87456
- "type": {
87457
- "text": "boolean"
87458
- }
87627
+ "kind": "field",
87628
+ "name": "_triggerAbortController",
87629
+ "type": {
87630
+ "text": "AbortController"
87459
87631
  },
87460
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
87461
- "inheritedFrom": {
87462
- "name": "SbbDisabledMixin",
87463
- "module": "core/mixins/disabled-mixin.js"
87464
- }
87632
+ "privacy": "private"
87465
87633
  },
87466
87634
  {
87467
87635
  "kind": "field",
87468
- "name": "styles",
87636
+ "name": "_isPointerDownEventOnMenu",
87469
87637
  "type": {
87470
- "text": "CSSResultGroup"
87638
+ "text": "boolean"
87471
87639
  },
87472
- "privacy": "public",
87473
- "static": true,
87474
- "default": "[boxSizingStyles, style]",
87475
- "inheritedFrom": {
87476
- "name": "SbbMenuActionCommonElementMixin",
87477
- "module": "menu/common/menu-action-common.js"
87478
- }
87640
+ "privacy": "private",
87641
+ "default": "false"
87479
87642
  },
87480
87643
  {
87481
- "kind": "method",
87482
- "name": "renderTemplate",
87483
- "privacy": "protected",
87484
- "return": {
87485
- "type": {
87486
- "text": "TemplateResult"
87487
- }
87644
+ "kind": "field",
87645
+ "name": "_windowEventsController",
87646
+ "type": {
87647
+ "text": "AbortController"
87488
87648
  },
87489
- "description": "Override this method to render the component template.",
87490
- "inheritedFrom": {
87491
- "name": "SbbActionBaseElement",
87492
- "module": "core/base-elements/action-base-element.js"
87493
- }
87649
+ "privacy": "private"
87494
87650
  },
87495
87651
  {
87496
87652
  "kind": "field",
87497
- "name": "iconName",
87498
- "type": {
87499
- "text": "string"
87500
- },
87501
- "privacy": "public",
87502
- "default": "''",
87503
- "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
87504
- "attribute": "icon-name",
87505
- "inheritedFrom": {
87506
- "name": "SbbIconNameMixin",
87507
- "module": "icon/icon-name-mixin.js"
87508
- }
87653
+ "name": "_escapableOverlayController",
87654
+ "privacy": "private",
87655
+ "default": "new SbbEscapableOverlayController(this)"
87509
87656
  },
87510
87657
  {
87511
- "kind": "method",
87512
- "name": "renderIconSlot",
87513
- "privacy": "protected",
87514
- "return": {
87515
- "type": {
87516
- "text": "TemplateResult"
87517
- }
87518
- },
87519
- "parameters": [
87520
- {
87521
- "name": "classname",
87522
- "optional": true,
87523
- "type": {
87524
- "text": "string"
87525
- }
87526
- }
87527
- ],
87528
- "inheritedFrom": {
87529
- "name": "SbbIconNameMixin",
87530
- "module": "icon/icon-name-mixin.js"
87531
- }
87658
+ "kind": "field",
87659
+ "name": "_focusTrapController",
87660
+ "privacy": "private",
87661
+ "default": "new SbbFocusTrapController(this)"
87662
+ },
87663
+ {
87664
+ "kind": "field",
87665
+ "name": "_scrollHandler",
87666
+ "privacy": "private",
87667
+ "default": "new SbbScrollHandler()"
87668
+ },
87669
+ {
87670
+ "kind": "field",
87671
+ "name": "_inertController",
87672
+ "privacy": "private",
87673
+ "default": "new SbbInertController(this)"
87674
+ },
87675
+ {
87676
+ "kind": "field",
87677
+ "name": "_mobileBreakpoint",
87678
+ "privacy": "private",
87679
+ "default": "SbbMediaQueryBreakpointSmallAndBelow"
87680
+ },
87681
+ {
87682
+ "kind": "field",
87683
+ "name": "_mediaMatcher",
87684
+ "privacy": "private",
87685
+ "default": "new SbbMediaMatcherController(this, { [this._mobileBreakpoint]: (matches) => { if (matches && (this.state === 'opening' || this.state === 'opened')) { this._scrollHandler.disableScroll(); } else { this._scrollHandler.enableScroll(); } }, })"
87686
+ },
87687
+ {
87688
+ "kind": "field",
87689
+ "name": "_darkModeController",
87690
+ "privacy": "private",
87691
+ "default": "new SbbDarkModeController(this, () => this._syncNegative())"
87692
+ },
87693
+ {
87694
+ "kind": "field",
87695
+ "name": "_language",
87696
+ "privacy": "private",
87697
+ "default": "new SbbLanguageController(this)"
87698
+ },
87699
+ {
87700
+ "kind": "field",
87701
+ "name": "_nestedMenu",
87702
+ "type": {
87703
+ "text": "SbbMenuElement | null"
87704
+ },
87705
+ "privacy": "private",
87706
+ "default": "null"
87532
87707
  },
87533
87708
  {
87534
87709
  "kind": "method",
87535
- "name": "renderIconName",
87536
- "privacy": "protected",
87710
+ "name": "escapeStrategy",
87711
+ "privacy": "public",
87537
87712
  "return": {
87538
87713
  "type": {
87539
- "text": "string"
87714
+ "text": "void"
87540
87715
  }
87541
87716
  },
87717
+ "description": "The method which is called on escape key press. Defaults to calling close()",
87542
87718
  "inheritedFrom": {
87543
- "name": "SbbIconNameMixin",
87544
- "module": "icon/icon-name-mixin.js"
87719
+ "name": "SbbOpenCloseBaseElement",
87720
+ "module": "core/base-elements/open-close-base-element.js"
87545
87721
  }
87546
87722
  },
87547
87723
  {
87548
87724
  "kind": "method",
87549
- "name": "_renderIconName",
87550
- "privacy": "private",
87725
+ "name": "open",
87726
+ "privacy": "public",
87551
87727
  "return": {
87552
87728
  "type": {
87553
- "text": "string"
87729
+ "text": "void"
87554
87730
  }
87555
87731
  },
87732
+ "description": "Opens the menu on trigger click.",
87556
87733
  "inheritedFrom": {
87557
- "name": "SbbIconNameMixin",
87558
- "module": "icon/icon-name-mixin.js"
87734
+ "name": "SbbOpenCloseBaseElement",
87735
+ "module": "core/base-elements/open-close-base-element.js"
87559
87736
  }
87560
87737
  },
87561
87738
  {
87562
- "kind": "field",
87563
- "name": "_elementsOnWhichEnterPressTriggersSubmit",
87564
- "type": {
87565
- "text": "array"
87739
+ "kind": "method",
87740
+ "name": "close",
87741
+ "privacy": "public",
87742
+ "return": {
87743
+ "type": {
87744
+ "text": "void"
87745
+ }
87566
87746
  },
87567
- "privacy": "private",
87568
- "readonly": true,
87569
- "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
87747
+ "description": "Closes the menu and all its nested menus.",
87570
87748
  "inheritedFrom": {
87571
- "name": "SbbButtonBaseElement",
87572
- "module": "core/base-elements/button-base-element.js"
87749
+ "name": "SbbOpenCloseBaseElement",
87750
+ "module": "core/base-elements/open-close-base-element.js"
87573
87751
  }
87574
87752
  },
87575
87753
  {
87576
- "kind": "field",
87577
- "name": "value",
87578
- "type": {
87579
- "text": "string"
87580
- },
87754
+ "kind": "method",
87755
+ "name": "closeAll",
87581
87756
  "privacy": "public",
87582
- "inheritedFrom": {
87583
- "name": "SbbButtonBaseElement",
87584
- "module": "core/base-elements/button-base-element.js"
87757
+ "return": {
87758
+ "type": {
87759
+ "text": "void"
87760
+ }
87585
87761
  },
87586
- "default": "''",
87587
- "description": "Value of the form element.",
87588
- "attribute": "value"
87762
+ "description": "Closes the menu and all related menus (nested and parent menus)."
87589
87763
  },
87590
87764
  {
87591
- "kind": "field",
87592
- "name": "type",
87593
- "privacy": "public",
87594
- "description": "The type attribute to use for the button.",
87595
- "default": "'button'",
87596
- "type": {
87597
- "text": "SbbButtonType"
87765
+ "kind": "method",
87766
+ "name": "_close",
87767
+ "privacy": "private",
87768
+ "return": {
87769
+ "type": {
87770
+ "text": "void"
87771
+ }
87598
87772
  },
87599
- "attribute": "type",
87600
- "inheritedFrom": {
87601
- "name": "SbbButtonBaseElement",
87602
- "module": "core/base-elements/button-base-element.js"
87603
- }
87773
+ "parameters": [
87774
+ {
87775
+ "name": "closeAll",
87776
+ "default": "false",
87777
+ "description": "If true, it ensures animations are correct by toggling some states when closing all related menus at once.",
87778
+ "optional": true
87779
+ }
87780
+ ]
87604
87781
  },
87605
87782
  {
87606
- "kind": "field",
87607
- "name": "form",
87608
- "type": {
87609
- "text": "HTMLFormElement | null"
87610
- },
87611
- "privacy": "public",
87612
- "description": "The `<form>` element to associate the button with.",
87613
- "inheritedFrom": {
87614
- "name": "SbbButtonBaseElement",
87615
- "module": "core/base-elements/button-base-element.js"
87616
- },
87617
- "attribute": "form"
87783
+ "kind": "method",
87784
+ "name": "_isZeroAnimationDuration",
87785
+ "privacy": "private",
87786
+ "return": {
87787
+ "type": {
87788
+ "text": "boolean"
87789
+ }
87790
+ }
87618
87791
  },
87619
87792
  {
87620
- "kind": "field",
87621
- "name": "_formId",
87622
- "type": {
87623
- "text": "string"
87624
- },
87793
+ "kind": "method",
87794
+ "name": "_handleOpening",
87625
87795
  "privacy": "private",
87626
- "default": "''",
87627
- "inheritedFrom": {
87628
- "name": "SbbButtonBaseElement",
87629
- "module": "core/base-elements/button-base-element.js"
87796
+ "return": {
87797
+ "type": {
87798
+ "text": "void"
87799
+ }
87630
87800
  }
87631
87801
  },
87632
87802
  {
87633
- "kind": "field",
87634
- "name": "_handleButtonClick",
87803
+ "kind": "method",
87804
+ "name": "_handleClosing",
87635
87805
  "privacy": "private",
87636
- "inheritedFrom": {
87637
- "name": "SbbButtonBaseElement",
87638
- "module": "core/base-elements/button-base-element.js"
87806
+ "return": {
87807
+ "type": {
87808
+ "text": "void"
87809
+ }
87639
87810
  }
87640
87811
  },
87641
87812
  {
87642
87813
  "kind": "method",
87643
- "name": "_requestSubmit",
87814
+ "name": "_handleKeyDown",
87644
87815
  "privacy": "private",
87645
87816
  "return": {
87646
87817
  "type": {
@@ -87649,154 +87820,117 @@
87649
87820
  },
87650
87821
  "parameters": [
87651
87822
  {
87652
- "name": "form",
87823
+ "name": "evt",
87653
87824
  "type": {
87654
- "text": "HTMLFormElement"
87825
+ "text": "KeyboardEvent"
87655
87826
  }
87656
87827
  }
87657
- ],
87658
- "inheritedFrom": {
87659
- "name": "SbbButtonBaseElement",
87660
- "module": "core/base-elements/button-base-element.js"
87828
+ ]
87829
+ },
87830
+ {
87831
+ "kind": "method",
87832
+ "name": "_configureTrigger",
87833
+ "privacy": "private",
87834
+ "return": {
87835
+ "type": {
87836
+ "text": "void"
87837
+ }
87661
87838
  }
87662
87839
  },
87663
87840
  {
87664
- "kind": "field",
87665
- "name": "_formKeyDown",
87841
+ "kind": "method",
87842
+ "name": "_attachWindowEvents",
87666
87843
  "privacy": "private",
87667
- "inheritedFrom": {
87668
- "name": "SbbButtonBaseElement",
87669
- "module": "core/base-elements/button-base-element.js"
87844
+ "return": {
87845
+ "type": {
87846
+ "text": "void"
87847
+ }
87670
87848
  }
87671
87849
  },
87672
87850
  {
87673
- "kind": "field",
87674
- "name": "formAssociated",
87675
- "type": {
87676
- "text": "boolean"
87851
+ "kind": "method",
87852
+ "name": "_interactiveElementClick",
87853
+ "privacy": "private",
87854
+ "return": {
87855
+ "type": {
87856
+ "text": "void"
87857
+ }
87677
87858
  },
87678
- "privacy": "public",
87679
- "static": true,
87680
- "default": "true",
87681
- "inheritedFrom": {
87682
- "name": "SbbFormAssociatedMixin",
87683
- "module": "core/mixins/form-associated-mixin.js"
87684
- }
87859
+ "parameters": [
87860
+ {
87861
+ "name": "event",
87862
+ "type": {
87863
+ "text": "Event"
87864
+ }
87865
+ }
87866
+ ]
87685
87867
  },
87686
87868
  {
87687
87869
  "kind": "field",
87688
- "name": "name",
87689
- "privacy": "public",
87690
- "description": "Name of the form element. Will be read from name attribute.",
87691
- "type": {
87692
- "text": "string"
87693
- },
87694
- "attribute": "name",
87695
- "inheritedFrom": {
87696
- "name": "SbbFormAssociatedMixin",
87697
- "module": "core/mixins/form-associated-mixin.js"
87698
- }
87699
- },
87700
- {
87701
- "kind": "field",
87702
- "name": "validity",
87703
- "type": {
87704
- "text": "ValidityState"
87705
- },
87706
- "privacy": "public",
87707
- "description": "Returns the ValidityState object for this element.",
87708
- "readonly": true,
87709
- "inheritedFrom": {
87710
- "name": "SbbFormAssociatedMixin",
87711
- "module": "core/mixins/form-associated-mixin.js"
87712
- }
87870
+ "name": "_pointerDownListener",
87871
+ "privacy": "private"
87713
87872
  },
87714
87873
  {
87715
87874
  "kind": "field",
87716
- "name": "validationMessage",
87717
- "type": {
87718
- "text": "string"
87719
- },
87720
- "privacy": "public",
87721
- "description": "Returns the current error message, if available, which corresponds\nto the current validation state.\nPlease note that only one message is returned at a time (e.g. if\nmultiple validity states are invalid, only the chronologically first one\nis returned until it is fixed, at which point the next message might be\nreturned, if it is still applicable). Also, a custom validity message\n(see below) has precedence over native validation messages.",
87722
- "readonly": true,
87723
- "inheritedFrom": {
87724
- "name": "SbbFormAssociatedMixin",
87725
- "module": "core/mixins/form-associated-mixin.js"
87726
- }
87875
+ "name": "_closeOnBackdropClick",
87876
+ "privacy": "private"
87727
87877
  },
87728
87878
  {
87729
- "kind": "field",
87730
- "name": "willValidate",
87731
- "type": {
87732
- "text": "boolean"
87879
+ "kind": "method",
87880
+ "name": "_nestedMenus",
87881
+ "privacy": "private",
87882
+ "return": {
87883
+ "type": {
87884
+ "text": "SbbMenuElement[]"
87885
+ }
87733
87886
  },
87734
- "privacy": "public",
87735
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
87736
- "readonly": true,
87737
- "inheritedFrom": {
87738
- "name": "SbbFormAssociatedMixin",
87739
- "module": "core/mixins/form-associated-mixin.js"
87740
- }
87887
+ "description": "Converts the linked list into an array of SbbMenuElement."
87741
87888
  },
87742
87889
  {
87743
- "kind": "field",
87744
- "name": "_validityStates",
87890
+ "kind": "method",
87891
+ "name": "_parentMenu",
87745
87892
  "privacy": "private",
87746
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
87747
- "inheritedFrom": {
87748
- "name": "SbbFormAssociatedMixin",
87749
- "module": "core/mixins/form-associated-mixin.js"
87893
+ "return": {
87894
+ "type": {
87895
+ "text": "SbbMenuElement | null"
87896
+ }
87750
87897
  }
87751
87898
  },
87752
87899
  {
87753
- "kind": "field",
87754
- "name": "formDisabled",
87755
- "type": {
87756
- "text": "boolean"
87900
+ "kind": "method",
87901
+ "name": "_mainMenu",
87902
+ "privacy": "private",
87903
+ "return": {
87904
+ "type": {
87905
+ "text": "SbbMenuElement"
87906
+ }
87757
87907
  },
87758
- "privacy": "protected",
87759
- "default": "false",
87760
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
87761
- "inheritedFrom": {
87762
- "name": "SbbFormAssociatedMixin",
87763
- "module": "core/mixins/form-associated-mixin.js"
87764
- }
87908
+ "description": "The outermost menu."
87765
87909
  },
87766
87910
  {
87767
87911
  "kind": "method",
87768
- "name": "checkValidity",
87769
- "privacy": "public",
87912
+ "name": "_isNested",
87913
+ "privacy": "private",
87770
87914
  "return": {
87771
87915
  "type": {
87772
87916
  "text": "boolean"
87773
87917
  }
87774
- },
87775
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
87776
- "inheritedFrom": {
87777
- "name": "SbbFormAssociatedMixin",
87778
- "module": "core/mixins/form-associated-mixin.js"
87779
87918
  }
87780
87919
  },
87781
87920
  {
87782
87921
  "kind": "method",
87783
- "name": "reportValidity",
87784
- "privacy": "public",
87922
+ "name": "_updateNestedInert",
87923
+ "privacy": "private",
87785
87924
  "return": {
87786
87925
  "type": {
87787
- "text": "boolean"
87926
+ "text": "void"
87788
87927
  }
87789
- },
87790
- "description": "Returns true if this element has no validity problems; otherwise,\nreturns false, fires an invalid event at the element,\nand (if the event isn't canceled) reports the problem to the user.",
87791
- "inheritedFrom": {
87792
- "name": "SbbFormAssociatedMixin",
87793
- "module": "core/mixins/form-associated-mixin.js"
87794
87928
  }
87795
87929
  },
87796
87930
  {
87797
87931
  "kind": "method",
87798
- "name": "setCustomValidity",
87799
- "privacy": "public",
87932
+ "name": "_handleMouseOver",
87933
+ "privacy": "private",
87800
87934
  "return": {
87801
87935
  "type": {
87802
87936
  "text": "void"
@@ -87804,64 +87938,64 @@
87804
87938
  },
87805
87939
  "parameters": [
87806
87940
  {
87807
- "name": "message",
87941
+ "name": "event",
87808
87942
  "type": {
87809
- "text": "string"
87943
+ "text": "MouseEvent"
87810
87944
  }
87811
87945
  }
87812
- ],
87813
- "description": "Sets the custom validity message for this element. Use the empty string\nto indicate that the element does not have a custom validity error.",
87814
- "inheritedFrom": {
87815
- "name": "SbbFormAssociatedMixin",
87816
- "module": "core/mixins/form-associated-mixin.js"
87817
- }
87946
+ ]
87818
87947
  },
87819
87948
  {
87820
87949
  "kind": "method",
87821
- "name": "_hasDisabledAncestor",
87950
+ "name": "_onMenuAnimationEnd",
87822
87951
  "privacy": "private",
87823
87952
  "return": {
87824
87953
  "type": {
87825
- "text": "boolean"
87954
+ "text": "void"
87826
87955
  }
87827
87956
  },
87828
- "inheritedFrom": {
87829
- "name": "SbbFormAssociatedMixin",
87830
- "module": "core/mixins/form-associated-mixin.js"
87957
+ "parameters": [
87958
+ {
87959
+ "name": "event",
87960
+ "type": {
87961
+ "text": "AnimationEvent"
87962
+ }
87963
+ }
87964
+ ]
87965
+ },
87966
+ {
87967
+ "kind": "method",
87968
+ "name": "_setMenuPosition",
87969
+ "privacy": "private",
87970
+ "return": {
87971
+ "type": {
87972
+ "text": "void"
87973
+ }
87831
87974
  }
87832
87975
  },
87833
87976
  {
87834
87977
  "kind": "method",
87835
- "name": "updateFormValue",
87836
- "privacy": "protected",
87978
+ "name": "_syncNegative",
87979
+ "privacy": "private",
87837
87980
  "return": {
87838
87981
  "type": {
87839
87982
  "text": "void"
87840
87983
  }
87841
- },
87842
- "description": "Should be called when form value is changed.\nAdapts and sets the formValue in the supported format (string | FormData | File | null)\nhttps://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/setFormValue",
87843
- "inheritedFrom": {
87844
- "name": "SbbFormAssociatedMixin",
87845
- "module": "core/mixins/form-associated-mixin.js"
87846
87984
  }
87847
87985
  },
87848
87986
  {
87849
87987
  "kind": "method",
87850
- "name": "formState",
87851
- "privacy": "protected",
87988
+ "name": "_isMobile",
87989
+ "privacy": "private",
87852
87990
  "return": {
87853
87991
  "type": {
87854
- "text": "FormRestoreState"
87992
+ "text": "boolean"
87855
87993
  }
87856
- },
87857
- "inheritedFrom": {
87858
- "name": "SbbFormAssociatedMixin",
87859
- "module": "core/mixins/form-associated-mixin.js"
87860
87994
  }
87861
87995
  },
87862
87996
  {
87863
87997
  "kind": "method",
87864
- "name": "setValidityFlag",
87998
+ "name": "toggleState",
87865
87999
  "privacy": "protected",
87866
88000
  "return": {
87867
88001
  "type": {
@@ -87870,330 +88004,196 @@
87870
88004
  },
87871
88005
  "parameters": [
87872
88006
  {
87873
- "name": "flag",
87874
- "type": {
87875
- "text": "T"
87876
- }
87877
- },
87878
- {
87879
- "name": "message",
88007
+ "name": "value",
87880
88008
  "type": {
87881
88009
  "text": "string"
87882
88010
  }
87883
88011
  },
87884
88012
  {
87885
- "name": "flagValue",
88013
+ "name": "force",
87886
88014
  "optional": true,
87887
88015
  "type": {
87888
- "text": "ValidityStateFlags[T]"
88016
+ "text": "boolean"
87889
88017
  }
87890
88018
  }
87891
88019
  ],
87892
- "description": "Marks this element as suffering from the constraint indicated by the\nflag argument and associates the given message to it.\nNote that only one message is displayed at a time and custom messages by\nconsumers are always displayed before internal messages and internal\nmessages are displayed in the order they were added.\nTo set/define custom validity state flags, you need to extend the\nValidityState prototype (and the CustomValidityState interface).",
87893
88020
  "inheritedFrom": {
87894
- "name": "SbbFormAssociatedMixin",
87895
- "module": "core/mixins/form-associated-mixin.js"
88021
+ "name": "SbbOpenCloseBaseElement",
88022
+ "module": "core/base-elements/open-close-base-element.js"
87896
88023
  }
87897
88024
  },
87898
88025
  {
87899
- "kind": "method",
87900
- "name": "removeValidityFlag",
87901
- "privacy": "protected",
87902
- "return": {
87903
- "type": {
87904
- "text": "void"
87905
- }
88026
+ "kind": "field",
88027
+ "name": "events",
88028
+ "privacy": "public",
88029
+ "static": true,
88030
+ "readonly": true,
88031
+ "default": "{ beforeopen: 'beforeopen', open: 'open', beforeclose: 'beforeclose', close: 'close', }",
88032
+ "type": {
88033
+ "text": "{\n beforeopen: 'beforeopen',\n open: 'open',\n beforeclose: 'beforeclose',\n close: 'close',\n }"
87906
88034
  },
87907
- "parameters": [
87908
- {
87909
- "name": "flag",
87910
- "type": {
87911
- "text": "T"
87912
- }
87913
- }
87914
- ],
87915
- "description": "Removes the validity state flag entry and updates validity state.",
87916
88035
  "inheritedFrom": {
87917
- "name": "SbbFormAssociatedMixin",
87918
- "module": "core/mixins/form-associated-mixin.js"
88036
+ "name": "SbbOpenCloseBaseElement",
88037
+ "module": "core/base-elements/open-close-base-element.js"
87919
88038
  }
87920
88039
  },
87921
88040
  {
87922
- "kind": "method",
87923
- "name": "validate",
88041
+ "kind": "field",
88042
+ "name": "state",
87924
88043
  "privacy": "protected",
87925
- "return": {
87926
- "type": {
87927
- "text": "void"
87928
- }
88044
+ "description": "The state of the component.",
88045
+ "type": {
88046
+ "text": "SbbOpenedClosedState"
87929
88047
  },
87930
- "description": "To be called whenever the current element needs to be validated.",
88048
+ "default": "'closed'",
87931
88049
  "inheritedFrom": {
87932
- "name": "SbbFormAssociatedMixin",
87933
- "module": "core/mixins/form-associated-mixin.js"
88050
+ "name": "SbbOpenCloseBaseElement",
88051
+ "module": "core/base-elements/open-close-base-element.js"
88052
+ }
88053
+ },
88054
+ {
88055
+ "kind": "field",
88056
+ "name": "_state",
88057
+ "type": {
88058
+ "text": "SbbOpenedClosedState"
88059
+ },
88060
+ "privacy": "private",
88061
+ "inheritedFrom": {
88062
+ "name": "SbbOpenCloseBaseElement",
88063
+ "module": "core/base-elements/open-close-base-element.js"
88064
+ }
88065
+ },
88066
+ {
88067
+ "kind": "field",
88068
+ "name": "isOpen",
88069
+ "type": {
88070
+ "text": "boolean"
88071
+ },
88072
+ "privacy": "public",
88073
+ "description": "Whether the element is open.",
88074
+ "readonly": true,
88075
+ "inheritedFrom": {
88076
+ "name": "SbbOpenCloseBaseElement",
88077
+ "module": "core/base-elements/open-close-base-element.js"
87934
88078
  }
87935
88079
  },
87936
88080
  {
87937
88081
  "kind": "method",
87938
- "name": "shouldValidate",
88082
+ "name": "dispatchBeforeOpenEvent",
87939
88083
  "privacy": "protected",
87940
88084
  "return": {
87941
88085
  "type": {
87942
88086
  "text": "boolean"
87943
88087
  }
87944
88088
  },
87945
- "parameters": [
87946
- {
87947
- "name": "name",
87948
- "type": {
87949
- "text": "PropertyKey | undefined"
87950
- }
87951
- }
87952
- ],
87953
- "description": "Whether validation should be run on a property change with the given name.",
87954
88089
  "inheritedFrom": {
87955
- "name": "SbbFormAssociatedMixin",
87956
- "module": "core/mixins/form-associated-mixin.js"
88090
+ "name": "SbbOpenCloseBaseElement",
88091
+ "module": "core/base-elements/open-close-base-element.js"
87957
88092
  }
87958
88093
  },
87959
88094
  {
87960
88095
  "kind": "method",
87961
- "name": "_setInternalValidity",
87962
- "privacy": "private",
88096
+ "name": "dispatchOpenEvent",
88097
+ "privacy": "protected",
87963
88098
  "return": {
87964
88099
  "type": {
87965
- "text": "void"
88100
+ "text": "boolean"
87966
88101
  }
87967
88102
  },
87968
88103
  "inheritedFrom": {
87969
- "name": "SbbFormAssociatedMixin",
87970
- "module": "core/mixins/form-associated-mixin.js"
87971
- }
87972
- },
87973
- {
87974
- "kind": "field",
87975
- "name": "_preventScrollOnSpaceKeydown",
87976
- "privacy": "private",
87977
- "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
87978
- "parameters": [
87979
- {
87980
- "description": "The origin event.",
87981
- "name": "event"
87982
- }
87983
- ],
87984
- "inheritedFrom": {
87985
- "name": "SbbButtonLikeBaseElement",
87986
- "module": "core/base-elements/button-base-element.js"
87987
- }
87988
- },
87989
- {
87990
- "kind": "field",
87991
- "name": "_removeActiveMarker",
87992
- "privacy": "private",
87993
- "inheritedFrom": {
87994
- "name": "SbbButtonLikeBaseElement",
87995
- "module": "core/base-elements/button-base-element.js"
87996
- }
87997
- },
87998
- {
87999
- "kind": "field",
88000
- "name": "_dispatchClickEventOnSpaceKeyup",
88001
- "privacy": "private",
88002
- "description": "Dispatches a 'click' PointerEvent if the original keyboard event is a 'Space' press.\nAs verified with the native button, when 'Space' is pressed, a 'click' event is dispatched\nafter the 'keyup' event.",
88003
- "parameters": [
88004
- {
88005
- "description": "The origin event.",
88006
- "name": "event"
88007
- }
88008
- ],
88009
- "inheritedFrom": {
88010
- "name": "SbbButtonLikeBaseElement",
88011
- "module": "core/base-elements/button-base-element.js"
88012
- }
88013
- },
88014
- {
88015
- "kind": "field",
88016
- "name": "_dispatchClickEvent",
88017
- "privacy": "private",
88018
- "inheritedFrom": {
88019
- "name": "SbbButtonLikeBaseElement",
88020
- "module": "core/base-elements/button-base-element.js"
88104
+ "name": "SbbOpenCloseBaseElement",
88105
+ "module": "core/base-elements/open-close-base-element.js"
88021
88106
  }
88022
88107
  },
88023
88108
  {
88024
88109
  "kind": "method",
88025
- "name": "toggleState",
88110
+ "name": "dispatchBeforeCloseEvent",
88026
88111
  "privacy": "protected",
88027
88112
  "return": {
88028
88113
  "type": {
88029
- "text": "void"
88030
- }
88031
- },
88032
- "parameters": [
88033
- {
88034
- "name": "value",
88035
- "type": {
88036
- "text": "string"
88037
- }
88038
- },
88039
- {
88040
- "name": "force",
88041
- "optional": true,
88042
- "type": {
88043
- "text": "boolean"
88044
- }
88114
+ "text": "boolean"
88045
88115
  }
88046
- ],
88047
- "inheritedFrom": {
88048
- "name": "SbbActionBaseElement",
88049
- "module": "core/base-elements/action-base-element.js"
88050
- }
88051
- },
88052
- {
88053
- "kind": "field",
88054
- "name": "maybeDisabled",
88055
- "type": {
88056
- "text": "boolean | undefined"
88057
- },
88058
- "privacy": "protected",
88059
- "readonly": true,
88060
- "inheritedFrom": {
88061
- "name": "SbbActionBaseElement",
88062
- "module": "core/base-elements/action-base-element.js"
88063
- }
88064
- },
88065
- {
88066
- "kind": "field",
88067
- "name": "maybeDisabledInteractive",
88068
- "type": {
88069
- "text": "boolean | undefined"
88070
88116
  },
88071
- "privacy": "protected",
88072
- "readonly": true,
88073
88117
  "inheritedFrom": {
88074
- "name": "SbbActionBaseElement",
88075
- "module": "core/base-elements/action-base-element.js"
88118
+ "name": "SbbOpenCloseBaseElement",
88119
+ "module": "core/base-elements/open-close-base-element.js"
88076
88120
  }
88077
88121
  },
88078
88122
  {
88079
88123
  "kind": "method",
88080
- "name": "setupBaseEventHandlers",
88124
+ "name": "dispatchCloseEvent",
88081
88125
  "privacy": "protected",
88082
88126
  "return": {
88083
88127
  "type": {
88084
- "text": "void"
88128
+ "text": "boolean"
88085
88129
  }
88086
88130
  },
88087
88131
  "inheritedFrom": {
88088
- "name": "SbbActionBaseElement",
88089
- "module": "core/base-elements/action-base-element.js"
88132
+ "name": "SbbOpenCloseBaseElement",
88133
+ "module": "core/base-elements/open-close-base-element.js"
88090
88134
  }
88091
88135
  }
88092
88136
  ],
88093
- "mixins": [
88094
- {
88095
- "name": "SbbDisabledTabIndexActionMixin",
88096
- "module": "core/mixins.js"
88097
- },
88137
+ "attributes": [
88098
88138
  {
88099
- "name": "SbbMenuActionCommonElementMixin",
88100
- "module": "menu/common.js"
88139
+ "name": "trigger",
88140
+ "type": {
88141
+ "text": "HTMLElement | null"
88142
+ },
88143
+ "default": "null",
88144
+ "description": "The element that will trigger the menu overlay.\n\nFor attribute usage, provide an id reference.",
88145
+ "fieldName": "trigger"
88101
88146
  }
88102
88147
  ],
88103
88148
  "superclass": {
88104
- "name": "SbbButtonBaseElement",
88149
+ "name": "SbbOpenCloseBaseElement",
88105
88150
  "module": "core/base-elements.js"
88106
88151
  },
88107
- "tagName": "sbb-menu-button",
88152
+ "tagName": "sbb-menu",
88108
88153
  "customElement": true,
88109
- "attributes": [
88110
- {
88111
- "name": "disabled-interactive",
88112
- "type": {
88113
- "text": "boolean"
88114
- },
88115
- "default": "false",
88116
- "description": "Whether the button should be aria-disabled but stay interactive.",
88117
- "fieldName": "disabledInteractive",
88118
- "inheritedFrom": {
88119
- "name": "SbbDisabledInteractiveMixin",
88120
- "module": "core/mixins/disabled-mixin.js"
88121
- }
88122
- },
88123
- {
88124
- "name": "disabled",
88125
- "description": "Whether the component is disabled.",
88126
- "default": "false",
88127
- "type": {
88128
- "text": "boolean"
88129
- },
88130
- "fieldName": "disabled",
88131
- "inheritedFrom": {
88132
- "name": "SbbDisabledMixin",
88133
- "module": "core/mixins/disabled-mixin.js"
88134
- }
88135
- },
88136
- {
88137
- "name": "icon-name",
88138
- "type": {
88139
- "text": "string"
88140
- },
88141
- "default": "''",
88142
- "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
88143
- "fieldName": "iconName",
88144
- "inheritedFrom": {
88145
- "name": "SbbIconNameMixin",
88146
- "module": "icon/icon-name-mixin.js"
88147
- }
88148
- },
88154
+ "events": [
88149
88155
  {
88150
- "name": "value",
88156
+ "name": "beforeopen",
88151
88157
  "type": {
88152
- "text": "string"
88158
+ "text": "Event"
88153
88159
  },
88154
- "default": "''",
88155
- "description": "Value of the form element.",
88156
- "fieldName": "value",
88160
+ "description": "Emits whenever the component starts the opening transition. Can be canceled.",
88157
88161
  "inheritedFrom": {
88158
- "name": "SbbButtonBaseElement",
88159
- "module": "core/base-elements/button-base-element.js"
88162
+ "name": "SbbOpenCloseBaseElement",
88163
+ "module": "core/base-elements/open-close-base-element.js"
88160
88164
  }
88161
88165
  },
88162
88166
  {
88163
- "name": "type",
88164
- "description": "The type attribute to use for the button.",
88165
- "default": "'button'",
88167
+ "name": "open",
88166
88168
  "type": {
88167
- "text": "SbbButtonType"
88169
+ "text": "Event"
88168
88170
  },
88169
- "fieldName": "type",
88171
+ "description": "Emits whenever the component is opened.",
88170
88172
  "inheritedFrom": {
88171
- "name": "SbbButtonBaseElement",
88172
- "module": "core/base-elements/button-base-element.js"
88173
+ "name": "SbbOpenCloseBaseElement",
88174
+ "module": "core/base-elements/open-close-base-element.js"
88173
88175
  }
88174
88176
  },
88175
88177
  {
88176
- "name": "form",
88177
- "description": "The `<form>` element to associate the button with.",
88178
+ "name": "beforeclose",
88178
88179
  "type": {
88179
- "text": "HTMLFormElement | null"
88180
+ "text": "Event"
88180
88181
  },
88181
- "fieldName": "form",
88182
+ "description": "Emits whenever the component begins the closing transition. Can be canceled.",
88182
88183
  "inheritedFrom": {
88183
- "name": "SbbButtonBaseElement",
88184
- "module": "core/base-elements/button-base-element.js"
88184
+ "name": "SbbOpenCloseBaseElement",
88185
+ "module": "core/base-elements/open-close-base-element.js"
88185
88186
  }
88186
88187
  },
88187
88188
  {
88188
- "name": "name",
88189
- "description": "Name of the form element. Will be read from name attribute.",
88189
+ "name": "close",
88190
88190
  "type": {
88191
- "text": "string"
88191
+ "text": "Event"
88192
88192
  },
88193
- "fieldName": "name",
88193
+ "description": "Emits whenever the component is closed.",
88194
88194
  "inheritedFrom": {
88195
- "name": "SbbFormAssociatedMixin",
88196
- "module": "core/mixins/form-associated-mixin.js"
88195
+ "name": "SbbOpenCloseBaseElement",
88196
+ "module": "core/base-elements/open-close-base-element.js"
88197
88197
  }
88198
88198
  }
88199
88199
  ]
@@ -88202,18 +88202,18 @@
88202
88202
  "exports": [
88203
88203
  {
88204
88204
  "kind": "js",
88205
- "name": "SbbMenuButtonElement",
88205
+ "name": "SbbMenuElement",
88206
88206
  "declaration": {
88207
- "name": "SbbMenuButtonElement",
88208
- "module": "menu/menu-button/menu-button.component.js"
88207
+ "name": "SbbMenuElement",
88208
+ "module": "menu/menu/menu.component.js"
88209
88209
  }
88210
88210
  },
88211
88211
  {
88212
88212
  "kind": "custom-element-definition",
88213
- "name": "sbb-menu-button",
88213
+ "name": "sbb-menu",
88214
88214
  "declaration": {
88215
- "name": "SbbMenuButtonElement",
88216
- "module": "menu/menu-button/menu-button.component.js"
88215
+ "name": "SbbMenuElement",
88216
+ "module": "menu/menu/menu.component.js"
88217
88217
  }
88218
88218
  }
88219
88219
  ]
@@ -103581,242 +103581,15 @@
103581
103581
  },
103582
103582
  {
103583
103583
  "kind": "javascript-module",
103584
- "path": "stepper/step/step.component.js",
103584
+ "path": "stepper/step-label/step-label.component.js",
103585
103585
  "declarations": [
103586
103586
  {
103587
103587
  "kind": "class",
103588
- "description": "Combined with a `sbb-stepper`, it displays a step's content.",
103589
- "name": "SbbStepElement",
103588
+ "description": "Combined with a `sbb-stepper`, it displays a step's label.",
103589
+ "name": "SbbStepLabelElement",
103590
103590
  "slots": [
103591
103591
  {
103592
- "description": "Use the unnamed slot to provide content.",
103593
- "name": ""
103594
- }
103595
- ],
103596
- "members": [
103597
- {
103598
- "kind": "field",
103599
- "name": "role",
103600
- "type": {
103601
- "text": "string"
103602
- },
103603
- "privacy": "public",
103604
- "static": true,
103605
- "readonly": true,
103606
- "default": "'tabpanel'"
103607
- },
103608
- {
103609
- "kind": "field",
103610
- "name": "events",
103611
- "privacy": "public",
103612
- "static": true,
103613
- "readonly": true,
103614
- "default": "{ validate: 'validate', resizechange: 'resizechange', }",
103615
- "type": {
103616
- "text": "{\n validate: 'validate',\n resizechange: 'resizechange',\n }"
103617
- }
103618
- },
103619
- {
103620
- "kind": "field",
103621
- "name": "_stepResizeObserver",
103622
- "privacy": "private",
103623
- "default": "new ResizeController(this, { target: null, skipInitial: true, callback: () => setTimeout(() => this._onStepElementResize()), })"
103624
- },
103625
- {
103626
- "kind": "field",
103627
- "name": "label",
103628
- "type": {
103629
- "text": "SbbStepLabelElement | null"
103630
- },
103631
- "privacy": "public",
103632
- "description": "The label of the step.",
103633
- "readonly": true,
103634
- "default": "null"
103635
- },
103636
- {
103637
- "kind": "field",
103638
- "name": "_label",
103639
- "type": {
103640
- "text": "SbbStepLabelElement | null"
103641
- },
103642
- "privacy": "private",
103643
- "default": "null"
103644
- },
103645
- {
103646
- "kind": "field",
103647
- "name": "stepper",
103648
- "type": {
103649
- "text": "SbbStepperElement | null"
103650
- },
103651
- "privacy": "public",
103652
- "readonly": true
103653
- },
103654
- {
103655
- "kind": "field",
103656
- "name": "_previousOrientation",
103657
- "type": {
103658
- "text": "string | undefined"
103659
- },
103660
- "privacy": "private"
103661
- },
103662
- {
103663
- "kind": "method",
103664
- "name": "_handleClick",
103665
- "privacy": "private",
103666
- "return": {
103667
- "type": {
103668
- "text": "void"
103669
- }
103670
- },
103671
- "parameters": [
103672
- {
103673
- "name": "event",
103674
- "type": {
103675
- "text": "Event"
103676
- }
103677
- }
103678
- ],
103679
- "description": "Watches for clicked elements with `sbb-stepper-next` or `sbb-stepper-previous` attributes."
103680
- },
103681
- {
103682
- "kind": "method",
103683
- "name": "_isGoNextElement",
103684
- "privacy": "private",
103685
- "return": {
103686
- "type": {
103687
- "text": "boolean"
103688
- }
103689
- },
103690
- "parameters": [
103691
- {
103692
- "name": "element",
103693
- "type": {
103694
- "text": "HTMLElement"
103695
- }
103696
- }
103697
- ]
103698
- },
103699
- {
103700
- "kind": "method",
103701
- "name": "_isGoPreviousElement",
103702
- "privacy": "private",
103703
- "return": {
103704
- "type": {
103705
- "text": "boolean"
103706
- }
103707
- },
103708
- "parameters": [
103709
- {
103710
- "name": "element",
103711
- "type": {
103712
- "text": "HTMLElement"
103713
- }
103714
- }
103715
- ]
103716
- },
103717
- {
103718
- "kind": "method",
103719
- "name": "_onStepElementResize",
103720
- "privacy": "private",
103721
- "return": {
103722
- "type": {
103723
- "text": "void"
103724
- }
103725
- }
103726
- },
103727
- {
103728
- "kind": "method",
103729
- "name": "_assignLabel",
103730
- "privacy": "private",
103731
- "return": {
103732
- "type": {
103733
- "text": "void"
103734
- }
103735
- }
103736
- },
103737
- {
103738
- "kind": "method",
103739
- "name": "toggleState",
103740
- "privacy": "protected",
103741
- "return": {
103742
- "type": {
103743
- "text": "void"
103744
- }
103745
- },
103746
- "parameters": [
103747
- {
103748
- "name": "value",
103749
- "type": {
103750
- "text": "string"
103751
- }
103752
- },
103753
- {
103754
- "name": "force",
103755
- "optional": true,
103756
- "type": {
103757
- "text": "boolean"
103758
- }
103759
- }
103760
- ],
103761
- "inheritedFrom": {
103762
- "name": "SbbElementInternalsMixin",
103763
- "module": "core/mixins/element-internals-mixin.js"
103764
- }
103765
- }
103766
- ],
103767
- "events": [
103768
- {
103769
- "name": "validate",
103770
- "type": {
103771
- "text": "CustomEvent<SbbStepValidateEventDetails>"
103772
- },
103773
- "description": "The validate event is dispatched when a step change is triggered. Can be canceled to abort the step change."
103774
- }
103775
- ],
103776
- "mixins": [
103777
- {
103778
- "name": "SbbElementInternalsMixin",
103779
- "module": "core/mixins.js"
103780
- }
103781
- ],
103782
- "superclass": {
103783
- "name": "LitElement",
103784
- "package": "lit"
103785
- },
103786
- "tagName": "sbb-step",
103787
- "customElement": true
103788
- }
103789
- ],
103790
- "exports": [
103791
- {
103792
- "kind": "js",
103793
- "name": "SbbStepElement",
103794
- "declaration": {
103795
- "name": "SbbStepElement",
103796
- "module": "stepper/step/step.component.js"
103797
- }
103798
- },
103799
- {
103800
- "kind": "custom-element-definition",
103801
- "name": "sbb-step",
103802
- "declaration": {
103803
- "name": "SbbStepElement",
103804
- "module": "stepper/step/step.component.js"
103805
- }
103806
- }
103807
- ]
103808
- },
103809
- {
103810
- "kind": "javascript-module",
103811
- "path": "stepper/step-label/step-label.component.js",
103812
- "declarations": [
103813
- {
103814
- "kind": "class",
103815
- "description": "Combined with a `sbb-stepper`, it displays a step's label.",
103816
- "name": "SbbStepLabelElement",
103817
- "slots": [
103818
- {
103819
- "description": "Use the unnamed slot to provide a label.",
103592
+ "description": "Use the unnamed slot to provide a label.",
103820
103593
  "name": ""
103821
103594
  },
103822
103595
  {
@@ -104452,37 +104225,392 @@
104452
104225
  }
104453
104226
  },
104454
104227
  {
104455
- "kind": "field",
104456
- "name": "_removeActiveMarker",
104228
+ "kind": "field",
104229
+ "name": "_removeActiveMarker",
104230
+ "privacy": "private",
104231
+ "inheritedFrom": {
104232
+ "name": "SbbButtonLikeBaseElement",
104233
+ "module": "core/base-elements/button-base-element.js"
104234
+ }
104235
+ },
104236
+ {
104237
+ "kind": "field",
104238
+ "name": "_dispatchClickEventOnSpaceKeyup",
104239
+ "privacy": "private",
104240
+ "description": "Dispatches a 'click' PointerEvent if the original keyboard event is a 'Space' press.\nAs verified with the native button, when 'Space' is pressed, a 'click' event is dispatched\nafter the 'keyup' event.",
104241
+ "parameters": [
104242
+ {
104243
+ "description": "The origin event.",
104244
+ "name": "event"
104245
+ }
104246
+ ],
104247
+ "inheritedFrom": {
104248
+ "name": "SbbButtonLikeBaseElement",
104249
+ "module": "core/base-elements/button-base-element.js"
104250
+ }
104251
+ },
104252
+ {
104253
+ "kind": "field",
104254
+ "name": "_dispatchClickEvent",
104255
+ "privacy": "private",
104256
+ "inheritedFrom": {
104257
+ "name": "SbbButtonLikeBaseElement",
104258
+ "module": "core/base-elements/button-base-element.js"
104259
+ }
104260
+ },
104261
+ {
104262
+ "kind": "method",
104263
+ "name": "toggleState",
104264
+ "privacy": "protected",
104265
+ "return": {
104266
+ "type": {
104267
+ "text": "void"
104268
+ }
104269
+ },
104270
+ "parameters": [
104271
+ {
104272
+ "name": "value",
104273
+ "type": {
104274
+ "text": "string"
104275
+ }
104276
+ },
104277
+ {
104278
+ "name": "force",
104279
+ "optional": true,
104280
+ "type": {
104281
+ "text": "boolean"
104282
+ }
104283
+ }
104284
+ ],
104285
+ "inheritedFrom": {
104286
+ "name": "SbbActionBaseElement",
104287
+ "module": "core/base-elements/action-base-element.js"
104288
+ }
104289
+ },
104290
+ {
104291
+ "kind": "field",
104292
+ "name": "maybeDisabled",
104293
+ "type": {
104294
+ "text": "boolean | undefined"
104295
+ },
104296
+ "privacy": "protected",
104297
+ "readonly": true,
104298
+ "inheritedFrom": {
104299
+ "name": "SbbActionBaseElement",
104300
+ "module": "core/base-elements/action-base-element.js"
104301
+ }
104302
+ },
104303
+ {
104304
+ "kind": "field",
104305
+ "name": "maybeDisabledInteractive",
104306
+ "type": {
104307
+ "text": "boolean | undefined"
104308
+ },
104309
+ "privacy": "protected",
104310
+ "readonly": true,
104311
+ "inheritedFrom": {
104312
+ "name": "SbbActionBaseElement",
104313
+ "module": "core/base-elements/action-base-element.js"
104314
+ }
104315
+ },
104316
+ {
104317
+ "kind": "method",
104318
+ "name": "setupBaseEventHandlers",
104319
+ "privacy": "protected",
104320
+ "return": {
104321
+ "type": {
104322
+ "text": "void"
104323
+ }
104324
+ },
104325
+ "inheritedFrom": {
104326
+ "name": "SbbActionBaseElement",
104327
+ "module": "core/base-elements/action-base-element.js"
104328
+ }
104329
+ },
104330
+ {
104331
+ "kind": "method",
104332
+ "name": "renderTemplate",
104333
+ "privacy": "protected",
104334
+ "return": {
104335
+ "type": {
104336
+ "text": "TemplateResult"
104337
+ }
104338
+ },
104339
+ "description": "Override this method to render the component template.",
104340
+ "inheritedFrom": {
104341
+ "name": "SbbActionBaseElement",
104342
+ "module": "core/base-elements/action-base-element.js"
104343
+ }
104344
+ }
104345
+ ],
104346
+ "mixins": [
104347
+ {
104348
+ "name": "SbbIconNameMixin",
104349
+ "module": "icon.js"
104350
+ },
104351
+ {
104352
+ "name": "SbbDisabledMixin",
104353
+ "module": "core/mixins.js"
104354
+ }
104355
+ ],
104356
+ "superclass": {
104357
+ "name": "SbbButtonBaseElement",
104358
+ "module": "core/base-elements.js"
104359
+ },
104360
+ "tagName": "sbb-step-label",
104361
+ "customElement": true,
104362
+ "attributes": [
104363
+ {
104364
+ "name": "icon-name",
104365
+ "type": {
104366
+ "text": "string"
104367
+ },
104368
+ "default": "''",
104369
+ "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
104370
+ "fieldName": "iconName",
104371
+ "inheritedFrom": {
104372
+ "name": "SbbIconNameMixin",
104373
+ "module": "icon/icon-name-mixin.js"
104374
+ }
104375
+ },
104376
+ {
104377
+ "name": "disabled",
104378
+ "description": "Whether the component is disabled.",
104379
+ "default": "false",
104380
+ "type": {
104381
+ "text": "boolean"
104382
+ },
104383
+ "fieldName": "disabled",
104384
+ "inheritedFrom": {
104385
+ "name": "SbbDisabledMixin",
104386
+ "module": "core/mixins/disabled-mixin.js"
104387
+ }
104388
+ },
104389
+ {
104390
+ "name": "value",
104391
+ "type": {
104392
+ "text": "string"
104393
+ },
104394
+ "default": "''",
104395
+ "description": "Value of the form element.",
104396
+ "fieldName": "value",
104397
+ "inheritedFrom": {
104398
+ "name": "SbbButtonBaseElement",
104399
+ "module": "core/base-elements/button-base-element.js"
104400
+ }
104401
+ },
104402
+ {
104403
+ "name": "type",
104404
+ "description": "The type attribute to use for the button.",
104405
+ "default": "'button'",
104406
+ "type": {
104407
+ "text": "SbbButtonType"
104408
+ },
104409
+ "fieldName": "type",
104410
+ "inheritedFrom": {
104411
+ "name": "SbbButtonBaseElement",
104412
+ "module": "core/base-elements/button-base-element.js"
104413
+ }
104414
+ },
104415
+ {
104416
+ "name": "form",
104417
+ "description": "The `<form>` element to associate the button with.",
104418
+ "type": {
104419
+ "text": "HTMLFormElement | null"
104420
+ },
104421
+ "fieldName": "form",
104422
+ "inheritedFrom": {
104423
+ "name": "SbbButtonBaseElement",
104424
+ "module": "core/base-elements/button-base-element.js"
104425
+ }
104426
+ },
104427
+ {
104428
+ "name": "name",
104429
+ "description": "Name of the form element. Will be read from name attribute.",
104430
+ "type": {
104431
+ "text": "string"
104432
+ },
104433
+ "fieldName": "name",
104434
+ "inheritedFrom": {
104435
+ "name": "SbbFormAssociatedMixin",
104436
+ "module": "core/mixins/form-associated-mixin.js"
104437
+ }
104438
+ }
104439
+ ]
104440
+ }
104441
+ ],
104442
+ "exports": [
104443
+ {
104444
+ "kind": "js",
104445
+ "name": "SbbStepLabelElement",
104446
+ "declaration": {
104447
+ "name": "SbbStepLabelElement",
104448
+ "module": "stepper/step-label/step-label.component.js"
104449
+ }
104450
+ },
104451
+ {
104452
+ "kind": "custom-element-definition",
104453
+ "name": "sbb-step-label",
104454
+ "declaration": {
104455
+ "name": "SbbStepLabelElement",
104456
+ "module": "stepper/step-label/step-label.component.js"
104457
+ }
104458
+ }
104459
+ ]
104460
+ },
104461
+ {
104462
+ "kind": "javascript-module",
104463
+ "path": "stepper/step/step.component.js",
104464
+ "declarations": [
104465
+ {
104466
+ "kind": "class",
104467
+ "description": "Combined with a `sbb-stepper`, it displays a step's content.",
104468
+ "name": "SbbStepElement",
104469
+ "slots": [
104470
+ {
104471
+ "description": "Use the unnamed slot to provide content.",
104472
+ "name": ""
104473
+ }
104474
+ ],
104475
+ "members": [
104476
+ {
104477
+ "kind": "field",
104478
+ "name": "role",
104479
+ "type": {
104480
+ "text": "string"
104481
+ },
104482
+ "privacy": "public",
104483
+ "static": true,
104484
+ "readonly": true,
104485
+ "default": "'tabpanel'"
104486
+ },
104487
+ {
104488
+ "kind": "field",
104489
+ "name": "events",
104490
+ "privacy": "public",
104491
+ "static": true,
104492
+ "readonly": true,
104493
+ "default": "{ validate: 'validate', resizechange: 'resizechange', }",
104494
+ "type": {
104495
+ "text": "{\n validate: 'validate',\n resizechange: 'resizechange',\n }"
104496
+ }
104497
+ },
104498
+ {
104499
+ "kind": "field",
104500
+ "name": "_stepResizeObserver",
104501
+ "privacy": "private",
104502
+ "default": "new ResizeController(this, { target: null, skipInitial: true, callback: () => setTimeout(() => this._onStepElementResize()), })"
104503
+ },
104504
+ {
104505
+ "kind": "field",
104506
+ "name": "label",
104507
+ "type": {
104508
+ "text": "SbbStepLabelElement | null"
104509
+ },
104510
+ "privacy": "public",
104511
+ "description": "The label of the step.",
104512
+ "readonly": true,
104513
+ "default": "null"
104514
+ },
104515
+ {
104516
+ "kind": "field",
104517
+ "name": "_label",
104518
+ "type": {
104519
+ "text": "SbbStepLabelElement | null"
104520
+ },
104521
+ "privacy": "private",
104522
+ "default": "null"
104523
+ },
104524
+ {
104525
+ "kind": "field",
104526
+ "name": "stepper",
104527
+ "type": {
104528
+ "text": "SbbStepperElement | null"
104529
+ },
104530
+ "privacy": "public",
104531
+ "readonly": true
104532
+ },
104533
+ {
104534
+ "kind": "field",
104535
+ "name": "_previousOrientation",
104536
+ "type": {
104537
+ "text": "string | undefined"
104538
+ },
104539
+ "privacy": "private"
104540
+ },
104541
+ {
104542
+ "kind": "method",
104543
+ "name": "_handleClick",
104544
+ "privacy": "private",
104545
+ "return": {
104546
+ "type": {
104547
+ "text": "void"
104548
+ }
104549
+ },
104550
+ "parameters": [
104551
+ {
104552
+ "name": "event",
104553
+ "type": {
104554
+ "text": "Event"
104555
+ }
104556
+ }
104557
+ ],
104558
+ "description": "Watches for clicked elements with `sbb-stepper-next` or `sbb-stepper-previous` attributes."
104559
+ },
104560
+ {
104561
+ "kind": "method",
104562
+ "name": "_isGoNextElement",
104563
+ "privacy": "private",
104564
+ "return": {
104565
+ "type": {
104566
+ "text": "boolean"
104567
+ }
104568
+ },
104569
+ "parameters": [
104570
+ {
104571
+ "name": "element",
104572
+ "type": {
104573
+ "text": "HTMLElement"
104574
+ }
104575
+ }
104576
+ ]
104577
+ },
104578
+ {
104579
+ "kind": "method",
104580
+ "name": "_isGoPreviousElement",
104457
104581
  "privacy": "private",
104458
- "inheritedFrom": {
104459
- "name": "SbbButtonLikeBaseElement",
104460
- "module": "core/base-elements/button-base-element.js"
104461
- }
104582
+ "return": {
104583
+ "type": {
104584
+ "text": "boolean"
104585
+ }
104586
+ },
104587
+ "parameters": [
104588
+ {
104589
+ "name": "element",
104590
+ "type": {
104591
+ "text": "HTMLElement"
104592
+ }
104593
+ }
104594
+ ]
104462
104595
  },
104463
104596
  {
104464
- "kind": "field",
104465
- "name": "_dispatchClickEventOnSpaceKeyup",
104597
+ "kind": "method",
104598
+ "name": "_onStepElementResize",
104466
104599
  "privacy": "private",
104467
- "description": "Dispatches a 'click' PointerEvent if the original keyboard event is a 'Space' press.\nAs verified with the native button, when 'Space' is pressed, a 'click' event is dispatched\nafter the 'keyup' event.",
104468
- "parameters": [
104469
- {
104470
- "description": "The origin event.",
104471
- "name": "event"
104600
+ "return": {
104601
+ "type": {
104602
+ "text": "void"
104472
104603
  }
104473
- ],
104474
- "inheritedFrom": {
104475
- "name": "SbbButtonLikeBaseElement",
104476
- "module": "core/base-elements/button-base-element.js"
104477
104604
  }
104478
104605
  },
104479
104606
  {
104480
- "kind": "field",
104481
- "name": "_dispatchClickEvent",
104607
+ "kind": "method",
104608
+ "name": "_assignLabel",
104482
104609
  "privacy": "private",
104483
- "inheritedFrom": {
104484
- "name": "SbbButtonLikeBaseElement",
104485
- "module": "core/base-elements/button-base-element.js"
104610
+ "return": {
104611
+ "type": {
104612
+ "text": "void"
104613
+ }
104486
104614
  }
104487
104615
  },
104488
104616
  {
@@ -104510,177 +104638,49 @@
104510
104638
  }
104511
104639
  ],
104512
104640
  "inheritedFrom": {
104513
- "name": "SbbActionBaseElement",
104514
- "module": "core/base-elements/action-base-element.js"
104515
- }
104516
- },
104517
- {
104518
- "kind": "field",
104519
- "name": "maybeDisabled",
104520
- "type": {
104521
- "text": "boolean | undefined"
104522
- },
104523
- "privacy": "protected",
104524
- "readonly": true,
104525
- "inheritedFrom": {
104526
- "name": "SbbActionBaseElement",
104527
- "module": "core/base-elements/action-base-element.js"
104641
+ "name": "SbbElementInternalsMixin",
104642
+ "module": "core/mixins/element-internals-mixin.js"
104528
104643
  }
104529
- },
104644
+ }
104645
+ ],
104646
+ "events": [
104530
104647
  {
104531
- "kind": "field",
104532
- "name": "maybeDisabledInteractive",
104648
+ "name": "validate",
104533
104649
  "type": {
104534
- "text": "boolean | undefined"
104535
- },
104536
- "privacy": "protected",
104537
- "readonly": true,
104538
- "inheritedFrom": {
104539
- "name": "SbbActionBaseElement",
104540
- "module": "core/base-elements/action-base-element.js"
104541
- }
104542
- },
104543
- {
104544
- "kind": "method",
104545
- "name": "setupBaseEventHandlers",
104546
- "privacy": "protected",
104547
- "return": {
104548
- "type": {
104549
- "text": "void"
104550
- }
104551
- },
104552
- "inheritedFrom": {
104553
- "name": "SbbActionBaseElement",
104554
- "module": "core/base-elements/action-base-element.js"
104555
- }
104556
- },
104557
- {
104558
- "kind": "method",
104559
- "name": "renderTemplate",
104560
- "privacy": "protected",
104561
- "return": {
104562
- "type": {
104563
- "text": "TemplateResult"
104564
- }
104650
+ "text": "CustomEvent<SbbStepValidateEventDetails>"
104565
104651
  },
104566
- "description": "Override this method to render the component template.",
104567
- "inheritedFrom": {
104568
- "name": "SbbActionBaseElement",
104569
- "module": "core/base-elements/action-base-element.js"
104570
- }
104652
+ "description": "The validate event is dispatched when a step change is triggered. Can be canceled to abort the step change."
104571
104653
  }
104572
104654
  ],
104573
104655
  "mixins": [
104574
104656
  {
104575
- "name": "SbbIconNameMixin",
104576
- "module": "icon.js"
104577
- },
104578
- {
104579
- "name": "SbbDisabledMixin",
104657
+ "name": "SbbElementInternalsMixin",
104580
104658
  "module": "core/mixins.js"
104581
104659
  }
104582
104660
  ],
104583
104661
  "superclass": {
104584
- "name": "SbbButtonBaseElement",
104585
- "module": "core/base-elements.js"
104662
+ "name": "LitElement",
104663
+ "package": "lit"
104586
104664
  },
104587
- "tagName": "sbb-step-label",
104588
- "customElement": true,
104589
- "attributes": [
104590
- {
104591
- "name": "icon-name",
104592
- "type": {
104593
- "text": "string"
104594
- },
104595
- "default": "''",
104596
- "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
104597
- "fieldName": "iconName",
104598
- "inheritedFrom": {
104599
- "name": "SbbIconNameMixin",
104600
- "module": "icon/icon-name-mixin.js"
104601
- }
104602
- },
104603
- {
104604
- "name": "disabled",
104605
- "description": "Whether the component is disabled.",
104606
- "default": "false",
104607
- "type": {
104608
- "text": "boolean"
104609
- },
104610
- "fieldName": "disabled",
104611
- "inheritedFrom": {
104612
- "name": "SbbDisabledMixin",
104613
- "module": "core/mixins/disabled-mixin.js"
104614
- }
104615
- },
104616
- {
104617
- "name": "value",
104618
- "type": {
104619
- "text": "string"
104620
- },
104621
- "default": "''",
104622
- "description": "Value of the form element.",
104623
- "fieldName": "value",
104624
- "inheritedFrom": {
104625
- "name": "SbbButtonBaseElement",
104626
- "module": "core/base-elements/button-base-element.js"
104627
- }
104628
- },
104629
- {
104630
- "name": "type",
104631
- "description": "The type attribute to use for the button.",
104632
- "default": "'button'",
104633
- "type": {
104634
- "text": "SbbButtonType"
104635
- },
104636
- "fieldName": "type",
104637
- "inheritedFrom": {
104638
- "name": "SbbButtonBaseElement",
104639
- "module": "core/base-elements/button-base-element.js"
104640
- }
104641
- },
104642
- {
104643
- "name": "form",
104644
- "description": "The `<form>` element to associate the button with.",
104645
- "type": {
104646
- "text": "HTMLFormElement | null"
104647
- },
104648
- "fieldName": "form",
104649
- "inheritedFrom": {
104650
- "name": "SbbButtonBaseElement",
104651
- "module": "core/base-elements/button-base-element.js"
104652
- }
104653
- },
104654
- {
104655
- "name": "name",
104656
- "description": "Name of the form element. Will be read from name attribute.",
104657
- "type": {
104658
- "text": "string"
104659
- },
104660
- "fieldName": "name",
104661
- "inheritedFrom": {
104662
- "name": "SbbFormAssociatedMixin",
104663
- "module": "core/mixins/form-associated-mixin.js"
104664
- }
104665
- }
104666
- ]
104665
+ "tagName": "sbb-step",
104666
+ "customElement": true
104667
104667
  }
104668
104668
  ],
104669
104669
  "exports": [
104670
104670
  {
104671
104671
  "kind": "js",
104672
- "name": "SbbStepLabelElement",
104672
+ "name": "SbbStepElement",
104673
104673
  "declaration": {
104674
- "name": "SbbStepLabelElement",
104675
- "module": "stepper/step-label/step-label.component.js"
104674
+ "name": "SbbStepElement",
104675
+ "module": "stepper/step/step.component.js"
104676
104676
  }
104677
104677
  },
104678
104678
  {
104679
104679
  "kind": "custom-element-definition",
104680
- "name": "sbb-step-label",
104680
+ "name": "sbb-step",
104681
104681
  "declaration": {
104682
- "name": "SbbStepLabelElement",
104683
- "module": "stepper/step-label/step-label.component.js"
104682
+ "name": "SbbStepElement",
104683
+ "module": "stepper/step/step.component.js"
104684
104684
  }
104685
104685
  }
104686
104686
  ]
@@ -110733,20 +110733,16 @@
110733
110733
  },
110734
110734
  {
110735
110735
  "kind": "javascript-module",
110736
- "path": "toggle/toggle-option/toggle-option.component.js",
110736
+ "path": "toggle/toggle/toggle.component.js",
110737
110737
  "declarations": [
110738
110738
  {
110739
110739
  "kind": "class",
110740
- "description": "It displays a toggle option within a `sbb-toggle`.",
110741
- "name": "SbbToggleOptionElement",
110740
+ "description": "It can be used as a container for two `sbb-toggle-option`, acting as a toggle button.",
110741
+ "name": "SbbToggleElement",
110742
110742
  "slots": [
110743
110743
  {
110744
- "description": "Use the unnamed slot to add content to the label of the toggle option.",
110744
+ "description": "Use the unnamed slot to add `<sbb-toggle-option>` elements to the toggle.",
110745
110745
  "name": ""
110746
- },
110747
- {
110748
- "description": "Slot used to render the `sbb-icon`.",
110749
- "name": "icon"
110750
110746
  }
110751
110747
  ],
110752
110748
  "members": [
@@ -110759,18 +110755,41 @@
110759
110755
  "privacy": "public",
110760
110756
  "static": true,
110761
110757
  "readonly": true,
110762
- "default": "'radio'"
110758
+ "default": "'radiogroup'"
110763
110759
  },
110764
110760
  {
110765
110761
  "kind": "field",
110766
- "name": "checked",
110762
+ "name": "events",
110763
+ "privacy": "public",
110764
+ "static": true,
110765
+ "readonly": true,
110766
+ "default": "{ change: 'change', }",
110767
+ "type": {
110768
+ "text": "{\n change: 'change',\n }"
110769
+ }
110770
+ },
110771
+ {
110772
+ "kind": "field",
110773
+ "name": "even",
110767
110774
  "type": {
110768
110775
  "text": "boolean"
110769
110776
  },
110770
110777
  "privacy": "public",
110771
110778
  "default": "false",
110772
- "description": "Whether the toggle-option is checked.",
110773
- "attribute": "checked",
110779
+ "description": "If true, set the width of the component fixed; if false,\nthe width is dynamic based on the label of the sbb-toggle-option.",
110780
+ "attribute": "even",
110781
+ "reflects": true
110782
+ },
110783
+ {
110784
+ "kind": "field",
110785
+ "name": "size",
110786
+ "type": {
110787
+ "text": "'s' | 'm'"
110788
+ },
110789
+ "privacy": "public",
110790
+ "description": "Size variant, either m or s.",
110791
+ "default": "'m' / 's' (lean)",
110792
+ "attribute": "size",
110774
110793
  "reflects": true
110775
110794
  },
110776
110795
  {
@@ -110780,22 +110799,53 @@
110780
110799
  "text": "(T = string) | null"
110781
110800
  },
110782
110801
  "privacy": "public",
110783
- "default": "null",
110784
- "description": "Value of toggle-option.",
110785
- "attribute": "value"
110802
+ "description": "The value of the toggle. It needs to be mutable since it is updated whenever\na new option is selected (see the `onToggleOptionSelect()` method).",
110803
+ "attribute": "value",
110804
+ "inheritedFrom": {
110805
+ "name": "SbbFormAssociatedMixin",
110806
+ "module": "core/mixins/form-associated-mixin.js"
110807
+ }
110786
110808
  },
110787
110809
  {
110788
110810
  "kind": "field",
110789
- "name": "_toggle",
110811
+ "name": "_fallbackValue",
110790
110812
  "type": {
110791
- "text": "SbbToggleElement | null"
110813
+ "text": "T | null"
110792
110814
  },
110793
110815
  "privacy": "private",
110794
110816
  "default": "null"
110795
110817
  },
110818
+ {
110819
+ "kind": "field",
110820
+ "name": "options",
110821
+ "type": {
110822
+ "text": "SbbToggleOptionElement<T>[]"
110823
+ },
110824
+ "privacy": "public",
110825
+ "description": "The child instances of sbb-toggle-option as an array.",
110826
+ "readonly": true
110827
+ },
110796
110828
  {
110797
110829
  "kind": "method",
110798
- "name": "_uncheckOtherOptions",
110830
+ "name": "_readFormData",
110831
+ "privacy": "private",
110832
+ "return": {
110833
+ "type": {
110834
+ "text": "Promise<T>"
110835
+ }
110836
+ },
110837
+ "parameters": [
110838
+ {
110839
+ "name": "formData",
110840
+ "type": {
110841
+ "text": "FormData"
110842
+ }
110843
+ }
110844
+ ]
110845
+ },
110846
+ {
110847
+ "kind": "method",
110848
+ "name": "_updateToggle",
110799
110849
  "privacy": "private",
110800
110850
  "return": {
110801
110851
  "type": {
@@ -110805,7 +110855,25 @@
110805
110855
  },
110806
110856
  {
110807
110857
  "kind": "method",
110808
- "name": "_handleDisabledChange",
110858
+ "name": "_valueChanged",
110859
+ "privacy": "private",
110860
+ "return": {
110861
+ "type": {
110862
+ "text": "void"
110863
+ }
110864
+ },
110865
+ "parameters": [
110866
+ {
110867
+ "name": "value",
110868
+ "type": {
110869
+ "text": "T | null"
110870
+ }
110871
+ }
110872
+ ]
110873
+ },
110874
+ {
110875
+ "kind": "method",
110876
+ "name": "_updateDisabled",
110809
110877
  "privacy": "private",
110810
110878
  "return": {
110811
110879
  "type": {
@@ -110821,17 +110889,44 @@
110821
110889
  "type": {
110822
110890
  "text": "void"
110823
110891
  }
110824
- }
110892
+ },
110893
+ "description": "Called on user interaction (click or keyboard)"
110825
110894
  },
110826
110895
  {
110827
110896
  "kind": "method",
110828
- "name": "_verifyTabindex",
110897
+ "name": "_handleKeyDown",
110829
110898
  "privacy": "private",
110830
110899
  "return": {
110831
110900
  "type": {
110832
110901
  "text": "void"
110833
110902
  }
110834
- }
110903
+ },
110904
+ "parameters": [
110905
+ {
110906
+ "name": "evt",
110907
+ "type": {
110908
+ "text": "KeyboardEvent"
110909
+ }
110910
+ }
110911
+ ]
110912
+ },
110913
+ {
110914
+ "kind": "method",
110915
+ "name": "_selectAndFocusOption",
110916
+ "privacy": "private",
110917
+ "return": {
110918
+ "type": {
110919
+ "text": "void"
110920
+ }
110921
+ },
110922
+ "parameters": [
110923
+ {
110924
+ "name": "option",
110925
+ "type": {
110926
+ "text": "SbbToggleOptionElement<T> | undefined"
110927
+ }
110928
+ }
110929
+ ]
110835
110930
  },
110836
110931
  {
110837
110932
  "kind": "field",
@@ -110879,73 +110974,211 @@
110879
110974
  },
110880
110975
  {
110881
110976
  "kind": "field",
110882
- "name": "iconName",
110977
+ "name": "formAssociated",
110978
+ "type": {
110979
+ "text": "boolean"
110980
+ },
110981
+ "privacy": "public",
110982
+ "static": true,
110983
+ "default": "true",
110984
+ "inheritedFrom": {
110985
+ "name": "SbbFormAssociatedMixin",
110986
+ "module": "core/mixins/form-associated-mixin.js"
110987
+ }
110988
+ },
110989
+ {
110990
+ "kind": "field",
110991
+ "name": "form",
110992
+ "type": {
110993
+ "text": "HTMLFormElement | null"
110994
+ },
110995
+ "privacy": "public",
110996
+ "description": "Returns the form owner of this element.",
110997
+ "readonly": true,
110998
+ "inheritedFrom": {
110999
+ "name": "SbbFormAssociatedMixin",
111000
+ "module": "core/mixins/form-associated-mixin.js"
111001
+ }
111002
+ },
111003
+ {
111004
+ "kind": "field",
111005
+ "name": "name",
111006
+ "privacy": "public",
111007
+ "description": "Name of the form element. Will be read from name attribute.",
110883
111008
  "type": {
110884
111009
  "text": "string"
110885
111010
  },
111011
+ "attribute": "name",
111012
+ "inheritedFrom": {
111013
+ "name": "SbbFormAssociatedMixin",
111014
+ "module": "core/mixins/form-associated-mixin.js"
111015
+ }
111016
+ },
111017
+ {
111018
+ "kind": "field",
111019
+ "name": "validity",
111020
+ "type": {
111021
+ "text": "ValidityState"
111022
+ },
110886
111023
  "privacy": "public",
110887
- "default": "''",
110888
- "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
110889
- "attribute": "icon-name",
111024
+ "description": "Returns the ValidityState object for this element.",
111025
+ "readonly": true,
110890
111026
  "inheritedFrom": {
110891
- "name": "SbbIconNameMixin",
110892
- "module": "icon/icon-name-mixin.js"
111027
+ "name": "SbbFormAssociatedMixin",
111028
+ "module": "core/mixins/form-associated-mixin.js"
110893
111029
  }
110894
111030
  },
110895
111031
  {
110896
- "kind": "method",
110897
- "name": "renderIconSlot",
111032
+ "kind": "field",
111033
+ "name": "validationMessage",
111034
+ "type": {
111035
+ "text": "string"
111036
+ },
111037
+ "privacy": "public",
111038
+ "description": "Returns the current error message, if available, which corresponds\nto the current validation state.\nPlease note that only one message is returned at a time (e.g. if\nmultiple validity states are invalid, only the chronologically first one\nis returned until it is fixed, at which point the next message might be\nreturned, if it is still applicable). Also, a custom validity message\n(see below) has precedence over native validation messages.",
111039
+ "readonly": true,
111040
+ "inheritedFrom": {
111041
+ "name": "SbbFormAssociatedMixin",
111042
+ "module": "core/mixins/form-associated-mixin.js"
111043
+ }
111044
+ },
111045
+ {
111046
+ "kind": "field",
111047
+ "name": "willValidate",
111048
+ "type": {
111049
+ "text": "boolean"
111050
+ },
111051
+ "privacy": "public",
111052
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
111053
+ "readonly": true,
111054
+ "inheritedFrom": {
111055
+ "name": "SbbFormAssociatedMixin",
111056
+ "module": "core/mixins/form-associated-mixin.js"
111057
+ }
111058
+ },
111059
+ {
111060
+ "kind": "field",
111061
+ "name": "_validityStates",
111062
+ "privacy": "private",
111063
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
111064
+ "inheritedFrom": {
111065
+ "name": "SbbFormAssociatedMixin",
111066
+ "module": "core/mixins/form-associated-mixin.js"
111067
+ }
111068
+ },
111069
+ {
111070
+ "kind": "field",
111071
+ "name": "formDisabled",
111072
+ "type": {
111073
+ "text": "boolean"
111074
+ },
110898
111075
  "privacy": "protected",
111076
+ "default": "false",
111077
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
111078
+ "inheritedFrom": {
111079
+ "name": "SbbFormAssociatedMixin",
111080
+ "module": "core/mixins/form-associated-mixin.js"
111081
+ }
111082
+ },
111083
+ {
111084
+ "kind": "method",
111085
+ "name": "checkValidity",
111086
+ "privacy": "public",
111087
+ "return": {
111088
+ "type": {
111089
+ "text": "boolean"
111090
+ }
111091
+ },
111092
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
111093
+ "inheritedFrom": {
111094
+ "name": "SbbFormAssociatedMixin",
111095
+ "module": "core/mixins/form-associated-mixin.js"
111096
+ }
111097
+ },
111098
+ {
111099
+ "kind": "method",
111100
+ "name": "reportValidity",
111101
+ "privacy": "public",
111102
+ "return": {
111103
+ "type": {
111104
+ "text": "boolean"
111105
+ }
111106
+ },
111107
+ "description": "Returns true if this element has no validity problems; otherwise,\nreturns false, fires an invalid event at the element,\nand (if the event isn't canceled) reports the problem to the user.",
111108
+ "inheritedFrom": {
111109
+ "name": "SbbFormAssociatedMixin",
111110
+ "module": "core/mixins/form-associated-mixin.js"
111111
+ }
111112
+ },
111113
+ {
111114
+ "kind": "method",
111115
+ "name": "setCustomValidity",
111116
+ "privacy": "public",
111117
+ "return": {
111118
+ "type": {
111119
+ "text": "void"
111120
+ }
111121
+ },
111122
+ "parameters": [
111123
+ {
111124
+ "name": "message",
111125
+ "type": {
111126
+ "text": "string"
111127
+ }
111128
+ }
111129
+ ],
111130
+ "description": "Sets the custom validity message for this element. Use the empty string\nto indicate that the element does not have a custom validity error.",
111131
+ "inheritedFrom": {
111132
+ "name": "SbbFormAssociatedMixin",
111133
+ "module": "core/mixins/form-associated-mixin.js"
111134
+ }
111135
+ },
111136
+ {
111137
+ "kind": "method",
111138
+ "name": "_hasDisabledAncestor",
111139
+ "privacy": "private",
110899
111140
  "return": {
110900
111141
  "type": {
110901
- "text": "TemplateResult"
111142
+ "text": "boolean"
110902
111143
  }
110903
111144
  },
110904
- "parameters": [
110905
- {
110906
- "name": "classname",
110907
- "optional": true,
110908
- "type": {
110909
- "text": "string"
110910
- }
110911
- }
110912
- ],
110913
111145
  "inheritedFrom": {
110914
- "name": "SbbIconNameMixin",
110915
- "module": "icon/icon-name-mixin.js"
111146
+ "name": "SbbFormAssociatedMixin",
111147
+ "module": "core/mixins/form-associated-mixin.js"
110916
111148
  }
110917
111149
  },
110918
111150
  {
110919
111151
  "kind": "method",
110920
- "name": "renderIconName",
111152
+ "name": "updateFormValue",
110921
111153
  "privacy": "protected",
110922
111154
  "return": {
110923
111155
  "type": {
110924
- "text": "string"
111156
+ "text": "void"
110925
111157
  }
110926
111158
  },
111159
+ "description": "Should be called when form value is changed.\nAdapts and sets the formValue in the supported format (string | FormData | File | null)\nhttps://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/setFormValue",
110927
111160
  "inheritedFrom": {
110928
- "name": "SbbIconNameMixin",
110929
- "module": "icon/icon-name-mixin.js"
111161
+ "name": "SbbFormAssociatedMixin",
111162
+ "module": "core/mixins/form-associated-mixin.js"
110930
111163
  }
110931
111164
  },
110932
111165
  {
110933
111166
  "kind": "method",
110934
- "name": "_renderIconName",
110935
- "privacy": "private",
111167
+ "name": "formState",
111168
+ "privacy": "protected",
110936
111169
  "return": {
110937
111170
  "type": {
110938
- "text": "string"
111171
+ "text": "FormRestoreState"
110939
111172
  }
110940
111173
  },
110941
111174
  "inheritedFrom": {
110942
- "name": "SbbIconNameMixin",
110943
- "module": "icon/icon-name-mixin.js"
111175
+ "name": "SbbFormAssociatedMixin",
111176
+ "module": "core/mixins/form-associated-mixin.js"
110944
111177
  }
110945
111178
  },
110946
111179
  {
110947
111180
  "kind": "method",
110948
- "name": "toggleState",
111181
+ "name": "setValidityFlag",
110949
111182
  "privacy": "protected",
110950
111183
  "return": {
110951
111184
  "type": {
@@ -110954,278 +111187,110 @@
110954
111187
  },
110955
111188
  "parameters": [
110956
111189
  {
110957
- "name": "value",
111190
+ "name": "flag",
111191
+ "type": {
111192
+ "text": "T"
111193
+ }
111194
+ },
111195
+ {
111196
+ "name": "message",
110958
111197
  "type": {
110959
111198
  "text": "string"
110960
111199
  }
110961
111200
  },
110962
111201
  {
110963
- "name": "force",
111202
+ "name": "flagValue",
110964
111203
  "optional": true,
110965
111204
  "type": {
110966
- "text": "boolean"
111205
+ "text": "ValidityStateFlags[T]"
110967
111206
  }
110968
111207
  }
110969
111208
  ],
110970
- "inheritedFrom": {
110971
- "name": "SbbElementInternalsMixin",
110972
- "module": "core/mixins/element-internals-mixin.js"
110973
- }
110974
- }
110975
- ],
110976
- "attributes": [
110977
- {
110978
- "name": "checked",
110979
- "type": {
110980
- "text": "boolean"
110981
- },
110982
- "default": "false",
110983
- "description": "Whether the toggle-option is checked.",
110984
- "fieldName": "checked"
110985
- },
110986
- {
110987
- "name": "value",
110988
- "type": {
110989
- "text": "T | null"
110990
- },
110991
- "default": "null",
110992
- "description": "Value of toggle-option.",
110993
- "fieldName": "value"
110994
- },
110995
- {
110996
- "name": "disabled",
110997
- "description": "Whether the component is disabled.",
110998
- "default": "false",
110999
- "type": {
111000
- "text": "boolean"
111001
- },
111002
- "fieldName": "disabled",
111003
- "inheritedFrom": {
111004
- "name": "SbbDisabledMixin",
111005
- "module": "core/mixins/disabled-mixin.js"
111006
- }
111007
- },
111008
- {
111009
- "name": "icon-name",
111010
- "type": {
111011
- "text": "string"
111012
- },
111013
- "default": "''",
111014
- "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
111015
- "fieldName": "iconName",
111016
- "inheritedFrom": {
111017
- "name": "SbbIconNameMixin",
111018
- "module": "icon/icon-name-mixin.js"
111019
- }
111020
- }
111021
- ],
111022
- "mixins": [
111023
- {
111024
- "name": "SbbDisabledMixin",
111025
- "module": "core/mixins.js"
111026
- },
111027
- {
111028
- "name": "SbbIconNameMixin",
111029
- "module": "icon.js"
111030
- },
111031
- {
111032
- "name": "SbbElementInternalsMixin",
111033
- "module": "core/mixins.js"
111034
- }
111035
- ],
111036
- "superclass": {
111037
- "name": "LitElement",
111038
- "package": "lit"
111039
- },
111040
- "classGenerics": "T = string",
111041
- "tagName": "sbb-toggle-option",
111042
- "customElement": true
111043
- }
111044
- ],
111045
- "exports": [
111046
- {
111047
- "kind": "js",
111048
- "name": "SbbToggleOptionElement",
111049
- "declaration": {
111050
- "name": "SbbToggleOptionElement",
111051
- "module": "toggle/toggle-option/toggle-option.component.js"
111052
- }
111053
- },
111054
- {
111055
- "kind": "custom-element-definition",
111056
- "name": "sbb-toggle-option",
111057
- "declaration": {
111058
- "name": "SbbToggleOptionElement",
111059
- "module": "toggle/toggle-option/toggle-option.component.js"
111060
- }
111061
- }
111062
- ]
111063
- },
111064
- {
111065
- "kind": "javascript-module",
111066
- "path": "toggle/toggle/toggle.component.js",
111067
- "declarations": [
111068
- {
111069
- "kind": "class",
111070
- "description": "It can be used as a container for two `sbb-toggle-option`, acting as a toggle button.",
111071
- "name": "SbbToggleElement",
111072
- "slots": [
111073
- {
111074
- "description": "Use the unnamed slot to add `<sbb-toggle-option>` elements to the toggle.",
111075
- "name": ""
111076
- }
111077
- ],
111078
- "members": [
111079
- {
111080
- "kind": "field",
111081
- "name": "role",
111082
- "type": {
111083
- "text": "string"
111084
- },
111085
- "privacy": "public",
111086
- "static": true,
111087
- "readonly": true,
111088
- "default": "'radiogroup'"
111089
- },
111090
- {
111091
- "kind": "field",
111092
- "name": "events",
111093
- "privacy": "public",
111094
- "static": true,
111095
- "readonly": true,
111096
- "default": "{ change: 'change', }",
111097
- "type": {
111098
- "text": "{\n change: 'change',\n }"
111099
- }
111100
- },
111101
- {
111102
- "kind": "field",
111103
- "name": "even",
111104
- "type": {
111105
- "text": "boolean"
111106
- },
111107
- "privacy": "public",
111108
- "default": "false",
111109
- "description": "If true, set the width of the component fixed; if false,\nthe width is dynamic based on the label of the sbb-toggle-option.",
111110
- "attribute": "even",
111111
- "reflects": true
111112
- },
111113
- {
111114
- "kind": "field",
111115
- "name": "size",
111116
- "type": {
111117
- "text": "'s' | 'm'"
111118
- },
111119
- "privacy": "public",
111120
- "description": "Size variant, either m or s.",
111121
- "default": "'m' / 's' (lean)",
111122
- "attribute": "size",
111123
- "reflects": true
111124
- },
111125
- {
111126
- "kind": "field",
111127
- "name": "value",
111128
- "type": {
111129
- "text": "(T = string) | null"
111130
- },
111131
- "privacy": "public",
111132
- "description": "The value of the toggle. It needs to be mutable since it is updated whenever\na new option is selected (see the `onToggleOptionSelect()` method).",
111133
- "attribute": "value",
111209
+ "description": "Marks this element as suffering from the constraint indicated by the\nflag argument and associates the given message to it.\nNote that only one message is displayed at a time and custom messages by\nconsumers are always displayed before internal messages and internal\nmessages are displayed in the order they were added.\nTo set/define custom validity state flags, you need to extend the\nValidityState prototype (and the CustomValidityState interface).",
111134
111210
  "inheritedFrom": {
111135
111211
  "name": "SbbFormAssociatedMixin",
111136
111212
  "module": "core/mixins/form-associated-mixin.js"
111137
111213
  }
111138
111214
  },
111139
- {
111140
- "kind": "field",
111141
- "name": "_fallbackValue",
111142
- "type": {
111143
- "text": "T | null"
111144
- },
111145
- "privacy": "private",
111146
- "default": "null"
111147
- },
111148
- {
111149
- "kind": "field",
111150
- "name": "options",
111151
- "type": {
111152
- "text": "SbbToggleOptionElement<T>[]"
111153
- },
111154
- "privacy": "public",
111155
- "description": "The child instances of sbb-toggle-option as an array.",
111156
- "readonly": true
111157
- },
111158
111215
  {
111159
111216
  "kind": "method",
111160
- "name": "_readFormData",
111161
- "privacy": "private",
111217
+ "name": "removeValidityFlag",
111218
+ "privacy": "protected",
111162
111219
  "return": {
111163
111220
  "type": {
111164
- "text": "Promise<T>"
111221
+ "text": "void"
111165
111222
  }
111166
111223
  },
111167
111224
  "parameters": [
111168
111225
  {
111169
- "name": "formData",
111226
+ "name": "flag",
111170
111227
  "type": {
111171
- "text": "FormData"
111228
+ "text": "T"
111172
111229
  }
111173
111230
  }
111174
- ]
111231
+ ],
111232
+ "description": "Removes the validity state flag entry and updates validity state.",
111233
+ "inheritedFrom": {
111234
+ "name": "SbbFormAssociatedMixin",
111235
+ "module": "core/mixins/form-associated-mixin.js"
111236
+ }
111175
111237
  },
111176
111238
  {
111177
111239
  "kind": "method",
111178
- "name": "_updateToggle",
111179
- "privacy": "private",
111240
+ "name": "validate",
111241
+ "privacy": "protected",
111180
111242
  "return": {
111181
111243
  "type": {
111182
111244
  "text": "void"
111183
111245
  }
111246
+ },
111247
+ "description": "To be called whenever the current element needs to be validated.",
111248
+ "inheritedFrom": {
111249
+ "name": "SbbFormAssociatedMixin",
111250
+ "module": "core/mixins/form-associated-mixin.js"
111184
111251
  }
111185
111252
  },
111186
111253
  {
111187
111254
  "kind": "method",
111188
- "name": "_valueChanged",
111189
- "privacy": "private",
111255
+ "name": "shouldValidate",
111256
+ "privacy": "protected",
111190
111257
  "return": {
111191
111258
  "type": {
111192
- "text": "void"
111259
+ "text": "boolean"
111193
111260
  }
111194
111261
  },
111195
111262
  "parameters": [
111196
111263
  {
111197
- "name": "value",
111264
+ "name": "name",
111198
111265
  "type": {
111199
- "text": "T | null"
111266
+ "text": "PropertyKey | undefined"
111200
111267
  }
111201
111268
  }
111202
- ]
111203
- },
111204
- {
111205
- "kind": "method",
111206
- "name": "_updateDisabled",
111207
- "privacy": "private",
111208
- "return": {
111209
- "type": {
111210
- "text": "void"
111211
- }
111269
+ ],
111270
+ "description": "Whether validation should be run on a property change with the given name.",
111271
+ "inheritedFrom": {
111272
+ "name": "SbbFormAssociatedMixin",
111273
+ "module": "core/mixins/form-associated-mixin.js"
111212
111274
  }
111213
111275
  },
111214
111276
  {
111215
111277
  "kind": "method",
111216
- "name": "_handleInput",
111278
+ "name": "_setInternalValidity",
111217
111279
  "privacy": "private",
111218
111280
  "return": {
111219
111281
  "type": {
111220
111282
  "text": "void"
111221
111283
  }
111222
111284
  },
111223
- "description": "Called on user interaction (click or keyboard)"
111285
+ "inheritedFrom": {
111286
+ "name": "SbbFormAssociatedMixin",
111287
+ "module": "core/mixins/form-associated-mixin.js"
111288
+ }
111224
111289
  },
111225
111290
  {
111226
111291
  "kind": "method",
111227
- "name": "_handleKeyDown",
111228
- "privacy": "private",
111292
+ "name": "toggleState",
111293
+ "privacy": "protected",
111229
111294
  "return": {
111230
111295
  "type": {
111231
111296
  "text": "void"
@@ -111233,388 +111298,339 @@
111233
111298
  },
111234
111299
  "parameters": [
111235
111300
  {
111236
- "name": "evt",
111301
+ "name": "value",
111237
111302
  "type": {
111238
- "text": "KeyboardEvent"
111303
+ "text": "string"
111239
111304
  }
111240
- }
111241
- ]
111242
- },
111243
- {
111244
- "kind": "method",
111245
- "name": "_selectAndFocusOption",
111246
- "privacy": "private",
111247
- "return": {
111248
- "type": {
111249
- "text": "void"
111250
- }
111251
- },
111252
- "parameters": [
111305
+ },
111253
111306
  {
111254
- "name": "option",
111307
+ "name": "force",
111308
+ "optional": true,
111255
111309
  "type": {
111256
- "text": "SbbToggleOptionElement<T> | undefined"
111310
+ "text": "boolean"
111257
111311
  }
111258
111312
  }
111259
- ]
111260
- },
111313
+ ],
111314
+ "inheritedFrom": {
111315
+ "name": "SbbElementInternalsMixin",
111316
+ "module": "core/mixins/element-internals-mixin.js"
111317
+ }
111318
+ }
111319
+ ],
111320
+ "events": [
111261
111321
  {
111262
- "kind": "field",
111263
- "name": "disabled",
111264
- "privacy": "public",
111265
- "description": "Whether the component is disabled.",
111266
- "default": "false",
111322
+ "name": "change",
111267
111323
  "type": {
111268
- "text": "boolean"
111324
+ "text": "Event"
111269
111325
  },
111270
- "attribute": "disabled",
111271
- "reflects": true,
111272
- "inheritedFrom": {
111273
- "name": "SbbDisabledMixin",
111274
- "module": "core/mixins/disabled-mixin.js"
111275
- }
111276
- },
111326
+ "description": "The change event is fired when the user modifies the element's value.\nUnlike the input event, the change event is not necessarily fired\nfor each alteration to an element's value."
111327
+ }
111328
+ ],
111329
+ "attributes": [
111277
111330
  {
111278
- "kind": "field",
111279
- "name": "#disabled",
111280
- "privacy": "private",
111331
+ "name": "even",
111281
111332
  "type": {
111282
111333
  "text": "boolean"
111283
111334
  },
111284
111335
  "default": "false",
111285
- "inheritedFrom": {
111286
- "name": "SbbDisabledMixin",
111287
- "module": "core/mixins/disabled-mixin.js"
111288
- }
111336
+ "description": "If true, set the width of the component fixed; if false,\nthe width is dynamic based on the label of the sbb-toggle-option.",
111337
+ "fieldName": "even"
111289
111338
  },
111290
111339
  {
111291
- "kind": "method",
111292
- "name": "isDisabledExternally",
111293
- "privacy": "protected",
111294
- "return": {
111295
- "type": {
111296
- "text": "boolean"
111297
- }
111340
+ "name": "size",
111341
+ "type": {
111342
+ "text": "'s' | 'm'"
111298
111343
  },
111299
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
111300
- "inheritedFrom": {
111301
- "name": "SbbDisabledMixin",
111302
- "module": "core/mixins/disabled-mixin.js"
111303
- }
111344
+ "description": "Size variant, either m or s.",
111345
+ "default": "'m' / 's' (lean)",
111346
+ "fieldName": "size"
111304
111347
  },
111305
111348
  {
111306
- "kind": "field",
111307
- "name": "formAssociated",
111349
+ "name": "value",
111350
+ "description": "The value of the toggle. It needs to be mutable since it is updated whenever\na new option is selected (see the `onToggleOptionSelect()` method).",
111308
111351
  "type": {
111309
- "text": "boolean"
111352
+ "text": "T | null"
111310
111353
  },
111311
- "privacy": "public",
111312
- "static": true,
111313
- "default": "true",
111314
- "inheritedFrom": {
111315
- "name": "SbbFormAssociatedMixin",
111316
- "module": "core/mixins/form-associated-mixin.js"
111317
- }
111354
+ "fieldName": "value"
111318
111355
  },
111319
111356
  {
111320
- "kind": "field",
111321
- "name": "form",
111357
+ "name": "disabled",
111358
+ "description": "Whether the component is disabled.",
111359
+ "default": "false",
111322
111360
  "type": {
111323
- "text": "HTMLFormElement | null"
111361
+ "text": "boolean"
111324
111362
  },
111325
- "privacy": "public",
111326
- "description": "Returns the form owner of this element.",
111327
- "readonly": true,
111363
+ "fieldName": "disabled",
111328
111364
  "inheritedFrom": {
111329
- "name": "SbbFormAssociatedMixin",
111330
- "module": "core/mixins/form-associated-mixin.js"
111365
+ "name": "SbbDisabledMixin",
111366
+ "module": "core/mixins/disabled-mixin.js"
111331
111367
  }
111332
111368
  },
111333
111369
  {
111334
- "kind": "field",
111335
111370
  "name": "name",
111336
- "privacy": "public",
111337
111371
  "description": "Name of the form element. Will be read from name attribute.",
111338
111372
  "type": {
111339
111373
  "text": "string"
111340
111374
  },
111341
- "attribute": "name",
111375
+ "fieldName": "name",
111342
111376
  "inheritedFrom": {
111343
111377
  "name": "SbbFormAssociatedMixin",
111344
111378
  "module": "core/mixins/form-associated-mixin.js"
111345
111379
  }
111380
+ }
111381
+ ],
111382
+ "mixins": [
111383
+ {
111384
+ "name": "SbbDisabledMixin",
111385
+ "module": "core/mixins.js"
111346
111386
  },
111347
111387
  {
111348
- "kind": "field",
111349
- "name": "validity",
111350
- "type": {
111351
- "text": "ValidityState"
111352
- },
111353
- "privacy": "public",
111354
- "description": "Returns the ValidityState object for this element.",
111355
- "readonly": true,
111356
- "inheritedFrom": {
111357
- "name": "SbbFormAssociatedMixin",
111358
- "module": "core/mixins/form-associated-mixin.js"
111359
- }
111388
+ "name": "SbbFormAssociatedMixin",
111389
+ "module": "core/mixins.js"
111390
+ },
111391
+ {
111392
+ "name": "SbbElementInternalsMixin",
111393
+ "module": "core/mixins.js"
111394
+ }
111395
+ ],
111396
+ "superclass": {
111397
+ "name": "LitElement",
111398
+ "package": "lit"
111399
+ },
111400
+ "classGenerics": "T = string",
111401
+ "tagName": "sbb-toggle",
111402
+ "customElement": true
111403
+ }
111404
+ ],
111405
+ "exports": [
111406
+ {
111407
+ "kind": "js",
111408
+ "name": "SbbToggleElement",
111409
+ "declaration": {
111410
+ "name": "SbbToggleElement",
111411
+ "module": "toggle/toggle/toggle.component.js"
111412
+ }
111413
+ },
111414
+ {
111415
+ "kind": "custom-element-definition",
111416
+ "name": "sbb-toggle",
111417
+ "declaration": {
111418
+ "name": "SbbToggleElement",
111419
+ "module": "toggle/toggle/toggle.component.js"
111420
+ }
111421
+ }
111422
+ ]
111423
+ },
111424
+ {
111425
+ "kind": "javascript-module",
111426
+ "path": "toggle/toggle-option/toggle-option.component.js",
111427
+ "declarations": [
111428
+ {
111429
+ "kind": "class",
111430
+ "description": "It displays a toggle option within a `sbb-toggle`.",
111431
+ "name": "SbbToggleOptionElement",
111432
+ "slots": [
111433
+ {
111434
+ "description": "Use the unnamed slot to add content to the label of the toggle option.",
111435
+ "name": ""
111360
111436
  },
111437
+ {
111438
+ "description": "Slot used to render the `sbb-icon`.",
111439
+ "name": "icon"
111440
+ }
111441
+ ],
111442
+ "members": [
111361
111443
  {
111362
111444
  "kind": "field",
111363
- "name": "validationMessage",
111445
+ "name": "role",
111364
111446
  "type": {
111365
111447
  "text": "string"
111366
111448
  },
111367
111449
  "privacy": "public",
111368
- "description": "Returns the current error message, if available, which corresponds\nto the current validation state.\nPlease note that only one message is returned at a time (e.g. if\nmultiple validity states are invalid, only the chronologically first one\nis returned until it is fixed, at which point the next message might be\nreturned, if it is still applicable). Also, a custom validity message\n(see below) has precedence over native validation messages.",
111450
+ "static": true,
111369
111451
  "readonly": true,
111370
- "inheritedFrom": {
111371
- "name": "SbbFormAssociatedMixin",
111372
- "module": "core/mixins/form-associated-mixin.js"
111373
- }
111452
+ "default": "'radio'"
111374
111453
  },
111375
111454
  {
111376
111455
  "kind": "field",
111377
- "name": "willValidate",
111456
+ "name": "checked",
111378
111457
  "type": {
111379
111458
  "text": "boolean"
111380
111459
  },
111381
111460
  "privacy": "public",
111382
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
111383
- "readonly": true,
111384
- "inheritedFrom": {
111385
- "name": "SbbFormAssociatedMixin",
111386
- "module": "core/mixins/form-associated-mixin.js"
111387
- }
111461
+ "default": "false",
111462
+ "description": "Whether the toggle-option is checked.",
111463
+ "attribute": "checked",
111464
+ "reflects": true
111388
111465
  },
111389
111466
  {
111390
111467
  "kind": "field",
111391
- "name": "_validityStates",
111392
- "privacy": "private",
111393
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
111394
- "inheritedFrom": {
111395
- "name": "SbbFormAssociatedMixin",
111396
- "module": "core/mixins/form-associated-mixin.js"
111397
- }
111468
+ "name": "value",
111469
+ "type": {
111470
+ "text": "(T = string) | null"
111471
+ },
111472
+ "privacy": "public",
111473
+ "default": "null",
111474
+ "description": "Value of toggle-option.",
111475
+ "attribute": "value"
111398
111476
  },
111399
111477
  {
111400
111478
  "kind": "field",
111401
- "name": "formDisabled",
111479
+ "name": "_toggle",
111402
111480
  "type": {
111403
- "text": "boolean"
111481
+ "text": "SbbToggleElement | null"
111404
111482
  },
111405
- "privacy": "protected",
111406
- "default": "false",
111407
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
111408
- "inheritedFrom": {
111409
- "name": "SbbFormAssociatedMixin",
111410
- "module": "core/mixins/form-associated-mixin.js"
111411
- }
111483
+ "privacy": "private",
111484
+ "default": "null"
111412
111485
  },
111413
111486
  {
111414
111487
  "kind": "method",
111415
- "name": "checkValidity",
111416
- "privacy": "public",
111488
+ "name": "_uncheckOtherOptions",
111489
+ "privacy": "private",
111417
111490
  "return": {
111418
111491
  "type": {
111419
- "text": "boolean"
111492
+ "text": "void"
111420
111493
  }
111421
- },
111422
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
111423
- "inheritedFrom": {
111424
- "name": "SbbFormAssociatedMixin",
111425
- "module": "core/mixins/form-associated-mixin.js"
111426
111494
  }
111427
111495
  },
111428
111496
  {
111429
111497
  "kind": "method",
111430
- "name": "reportValidity",
111431
- "privacy": "public",
111498
+ "name": "_handleDisabledChange",
111499
+ "privacy": "private",
111432
111500
  "return": {
111433
111501
  "type": {
111434
- "text": "boolean"
111502
+ "text": "void"
111435
111503
  }
111436
- },
111437
- "description": "Returns true if this element has no validity problems; otherwise,\nreturns false, fires an invalid event at the element,\nand (if the event isn't canceled) reports the problem to the user.",
111438
- "inheritedFrom": {
111439
- "name": "SbbFormAssociatedMixin",
111440
- "module": "core/mixins/form-associated-mixin.js"
111441
111504
  }
111442
111505
  },
111443
111506
  {
111444
111507
  "kind": "method",
111445
- "name": "setCustomValidity",
111446
- "privacy": "public",
111508
+ "name": "_handleInput",
111509
+ "privacy": "private",
111447
111510
  "return": {
111448
111511
  "type": {
111449
111512
  "text": "void"
111450
111513
  }
111451
- },
111452
- "parameters": [
111453
- {
111454
- "name": "message",
111455
- "type": {
111456
- "text": "string"
111457
- }
111458
- }
111459
- ],
111460
- "description": "Sets the custom validity message for this element. Use the empty string\nto indicate that the element does not have a custom validity error.",
111461
- "inheritedFrom": {
111462
- "name": "SbbFormAssociatedMixin",
111463
- "module": "core/mixins/form-associated-mixin.js"
111464
111514
  }
111465
111515
  },
111466
111516
  {
111467
111517
  "kind": "method",
111468
- "name": "_hasDisabledAncestor",
111518
+ "name": "_verifyTabindex",
111469
111519
  "privacy": "private",
111470
111520
  "return": {
111471
111521
  "type": {
111472
- "text": "boolean"
111522
+ "text": "void"
111473
111523
  }
111524
+ }
111525
+ },
111526
+ {
111527
+ "kind": "field",
111528
+ "name": "disabled",
111529
+ "privacy": "public",
111530
+ "description": "Whether the component is disabled.",
111531
+ "default": "false",
111532
+ "type": {
111533
+ "text": "boolean"
111474
111534
  },
111535
+ "attribute": "disabled",
111536
+ "reflects": true,
111475
111537
  "inheritedFrom": {
111476
- "name": "SbbFormAssociatedMixin",
111477
- "module": "core/mixins/form-associated-mixin.js"
111538
+ "name": "SbbDisabledMixin",
111539
+ "module": "core/mixins/disabled-mixin.js"
111478
111540
  }
111479
111541
  },
111480
111542
  {
111481
- "kind": "method",
111482
- "name": "updateFormValue",
111483
- "privacy": "protected",
111484
- "return": {
111485
- "type": {
111486
- "text": "void"
111487
- }
111543
+ "kind": "field",
111544
+ "name": "#disabled",
111545
+ "privacy": "private",
111546
+ "type": {
111547
+ "text": "boolean"
111488
111548
  },
111489
- "description": "Should be called when form value is changed.\nAdapts and sets the formValue in the supported format (string | FormData | File | null)\nhttps://developer.mozilla.org/en-US/docs/Web/API/ElementInternals/setFormValue",
111549
+ "default": "false",
111490
111550
  "inheritedFrom": {
111491
- "name": "SbbFormAssociatedMixin",
111492
- "module": "core/mixins/form-associated-mixin.js"
111551
+ "name": "SbbDisabledMixin",
111552
+ "module": "core/mixins/disabled-mixin.js"
111493
111553
  }
111494
111554
  },
111495
111555
  {
111496
111556
  "kind": "method",
111497
- "name": "formState",
111557
+ "name": "isDisabledExternally",
111498
111558
  "privacy": "protected",
111499
111559
  "return": {
111500
111560
  "type": {
111501
- "text": "FormRestoreState"
111561
+ "text": "boolean"
111502
111562
  }
111503
111563
  },
111564
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
111504
111565
  "inheritedFrom": {
111505
- "name": "SbbFormAssociatedMixin",
111506
- "module": "core/mixins/form-associated-mixin.js"
111566
+ "name": "SbbDisabledMixin",
111567
+ "module": "core/mixins/disabled-mixin.js"
111507
111568
  }
111508
111569
  },
111509
111570
  {
111510
- "kind": "method",
111511
- "name": "setValidityFlag",
111512
- "privacy": "protected",
111513
- "return": {
111514
- "type": {
111515
- "text": "void"
111516
- }
111571
+ "kind": "field",
111572
+ "name": "iconName",
111573
+ "type": {
111574
+ "text": "string"
111517
111575
  },
111518
- "parameters": [
111519
- {
111520
- "name": "flag",
111521
- "type": {
111522
- "text": "T"
111523
- }
111524
- },
111525
- {
111526
- "name": "message",
111527
- "type": {
111528
- "text": "string"
111529
- }
111530
- },
111531
- {
111532
- "name": "flagValue",
111533
- "optional": true,
111534
- "type": {
111535
- "text": "ValidityStateFlags[T]"
111536
- }
111537
- }
111538
- ],
111539
- "description": "Marks this element as suffering from the constraint indicated by the\nflag argument and associates the given message to it.\nNote that only one message is displayed at a time and custom messages by\nconsumers are always displayed before internal messages and internal\nmessages are displayed in the order they were added.\nTo set/define custom validity state flags, you need to extend the\nValidityState prototype (and the CustomValidityState interface).",
111576
+ "privacy": "public",
111577
+ "default": "''",
111578
+ "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
111579
+ "attribute": "icon-name",
111540
111580
  "inheritedFrom": {
111541
- "name": "SbbFormAssociatedMixin",
111542
- "module": "core/mixins/form-associated-mixin.js"
111581
+ "name": "SbbIconNameMixin",
111582
+ "module": "icon/icon-name-mixin.js"
111543
111583
  }
111544
111584
  },
111545
111585
  {
111546
111586
  "kind": "method",
111547
- "name": "removeValidityFlag",
111587
+ "name": "renderIconSlot",
111548
111588
  "privacy": "protected",
111549
111589
  "return": {
111550
111590
  "type": {
111551
- "text": "void"
111591
+ "text": "TemplateResult"
111552
111592
  }
111553
111593
  },
111554
111594
  "parameters": [
111555
111595
  {
111556
- "name": "flag",
111596
+ "name": "classname",
111597
+ "optional": true,
111557
111598
  "type": {
111558
- "text": "T"
111599
+ "text": "string"
111559
111600
  }
111560
111601
  }
111561
111602
  ],
111562
- "description": "Removes the validity state flag entry and updates validity state.",
111563
- "inheritedFrom": {
111564
- "name": "SbbFormAssociatedMixin",
111565
- "module": "core/mixins/form-associated-mixin.js"
111566
- }
111567
- },
111568
- {
111569
- "kind": "method",
111570
- "name": "validate",
111571
- "privacy": "protected",
111572
- "return": {
111573
- "type": {
111574
- "text": "void"
111575
- }
111576
- },
111577
- "description": "To be called whenever the current element needs to be validated.",
111578
111603
  "inheritedFrom": {
111579
- "name": "SbbFormAssociatedMixin",
111580
- "module": "core/mixins/form-associated-mixin.js"
111604
+ "name": "SbbIconNameMixin",
111605
+ "module": "icon/icon-name-mixin.js"
111581
111606
  }
111582
111607
  },
111583
111608
  {
111584
111609
  "kind": "method",
111585
- "name": "shouldValidate",
111610
+ "name": "renderIconName",
111586
111611
  "privacy": "protected",
111587
111612
  "return": {
111588
111613
  "type": {
111589
- "text": "boolean"
111614
+ "text": "string"
111590
111615
  }
111591
111616
  },
111592
- "parameters": [
111593
- {
111594
- "name": "name",
111595
- "type": {
111596
- "text": "PropertyKey | undefined"
111597
- }
111598
- }
111599
- ],
111600
- "description": "Whether validation should be run on a property change with the given name.",
111601
111617
  "inheritedFrom": {
111602
- "name": "SbbFormAssociatedMixin",
111603
- "module": "core/mixins/form-associated-mixin.js"
111618
+ "name": "SbbIconNameMixin",
111619
+ "module": "icon/icon-name-mixin.js"
111604
111620
  }
111605
111621
  },
111606
111622
  {
111607
111623
  "kind": "method",
111608
- "name": "_setInternalValidity",
111624
+ "name": "_renderIconName",
111609
111625
  "privacy": "private",
111610
111626
  "return": {
111611
111627
  "type": {
111612
- "text": "void"
111628
+ "text": "string"
111613
111629
  }
111614
111630
  },
111615
111631
  "inheritedFrom": {
111616
- "name": "SbbFormAssociatedMixin",
111617
- "module": "core/mixins/form-associated-mixin.js"
111632
+ "name": "SbbIconNameMixin",
111633
+ "module": "icon/icon-name-mixin.js"
111618
111634
  }
111619
111635
  },
111620
111636
  {
@@ -111647,40 +111663,23 @@
111647
111663
  }
111648
111664
  }
111649
111665
  ],
111650
- "events": [
111651
- {
111652
- "name": "change",
111653
- "type": {
111654
- "text": "Event"
111655
- },
111656
- "description": "The change event is fired when the user modifies the element's value.\nUnlike the input event, the change event is not necessarily fired\nfor each alteration to an element's value."
111657
- }
111658
- ],
111659
111666
  "attributes": [
111660
111667
  {
111661
- "name": "even",
111668
+ "name": "checked",
111662
111669
  "type": {
111663
111670
  "text": "boolean"
111664
111671
  },
111665
111672
  "default": "false",
111666
- "description": "If true, set the width of the component fixed; if false,\nthe width is dynamic based on the label of the sbb-toggle-option.",
111667
- "fieldName": "even"
111668
- },
111669
- {
111670
- "name": "size",
111671
- "type": {
111672
- "text": "'s' | 'm'"
111673
- },
111674
- "description": "Size variant, either m or s.",
111675
- "default": "'m' / 's' (lean)",
111676
- "fieldName": "size"
111673
+ "description": "Whether the toggle-option is checked.",
111674
+ "fieldName": "checked"
111677
111675
  },
111678
111676
  {
111679
111677
  "name": "value",
111680
- "description": "The value of the toggle. It needs to be mutable since it is updated whenever\na new option is selected (see the `onToggleOptionSelect()` method).",
111681
111678
  "type": {
111682
111679
  "text": "T | null"
111683
111680
  },
111681
+ "default": "null",
111682
+ "description": "Value of toggle-option.",
111684
111683
  "fieldName": "value"
111685
111684
  },
111686
111685
  {
@@ -111697,15 +111696,16 @@
111697
111696
  }
111698
111697
  },
111699
111698
  {
111700
- "name": "name",
111701
- "description": "Name of the form element. Will be read from name attribute.",
111699
+ "name": "icon-name",
111702
111700
  "type": {
111703
111701
  "text": "string"
111704
111702
  },
111705
- "fieldName": "name",
111703
+ "default": "''",
111704
+ "description": "The icon name we want to use, choose from the small icon variants\nfrom the ui-icons category from here\nhttps://icons.app.sbb.ch.",
111705
+ "fieldName": "iconName",
111706
111706
  "inheritedFrom": {
111707
- "name": "SbbFormAssociatedMixin",
111708
- "module": "core/mixins/form-associated-mixin.js"
111707
+ "name": "SbbIconNameMixin",
111708
+ "module": "icon/icon-name-mixin.js"
111709
111709
  }
111710
111710
  }
111711
111711
  ],
@@ -111715,8 +111715,8 @@
111715
111715
  "module": "core/mixins.js"
111716
111716
  },
111717
111717
  {
111718
- "name": "SbbFormAssociatedMixin",
111719
- "module": "core/mixins.js"
111718
+ "name": "SbbIconNameMixin",
111719
+ "module": "icon.js"
111720
111720
  },
111721
111721
  {
111722
111722
  "name": "SbbElementInternalsMixin",
@@ -111728,25 +111728,25 @@
111728
111728
  "package": "lit"
111729
111729
  },
111730
111730
  "classGenerics": "T = string",
111731
- "tagName": "sbb-toggle",
111731
+ "tagName": "sbb-toggle-option",
111732
111732
  "customElement": true
111733
111733
  }
111734
111734
  ],
111735
111735
  "exports": [
111736
111736
  {
111737
111737
  "kind": "js",
111738
- "name": "SbbToggleElement",
111738
+ "name": "SbbToggleOptionElement",
111739
111739
  "declaration": {
111740
- "name": "SbbToggleElement",
111741
- "module": "toggle/toggle/toggle.component.js"
111740
+ "name": "SbbToggleOptionElement",
111741
+ "module": "toggle/toggle-option/toggle-option.component.js"
111742
111742
  }
111743
111743
  },
111744
111744
  {
111745
111745
  "kind": "custom-element-definition",
111746
- "name": "sbb-toggle",
111746
+ "name": "sbb-toggle-option",
111747
111747
  "declaration": {
111748
- "name": "SbbToggleElement",
111749
- "module": "toggle/toggle/toggle.component.js"
111748
+ "name": "SbbToggleOptionElement",
111749
+ "module": "toggle/toggle-option/toggle-option.component.js"
111750
111750
  }
111751
111751
  }
111752
111752
  ]