@sbb-esta/lyne-elements-dev 4.11.0-dev.1776939746 → 4.11.0-dev.1776944043

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.
@@ -122784,16 +122784,20 @@
122784
122784
  },
122785
122785
  {
122786
122786
  "kind": "javascript-module",
122787
- "path": "stepper/step/step.component.js",
122787
+ "path": "stepper/step-label/step-label.component.js",
122788
122788
  "declarations": [
122789
122789
  {
122790
122790
  "kind": "class",
122791
- "description": "Combined with a `sbb-stepper`, it displays a step's content.",
122792
- "name": "SbbStepElement",
122791
+ "description": "Combined with a `sbb-stepper`, it displays a step's label.",
122792
+ "name": "SbbStepLabelElement",
122793
122793
  "slots": [
122794
122794
  {
122795
- "description": "Use the unnamed slot to provide content.",
122795
+ "description": "Use the unnamed slot to provide a label.",
122796
122796
  "name": ""
122797
+ },
122798
+ {
122799
+ "description": "Use this to display an icon in the label bubble.",
122800
+ "name": "icon"
122797
122801
  }
122798
122802
  ],
122799
122803
  "members": [
@@ -122806,11 +122810,11 @@
122806
122810
  "privacy": "public",
122807
122811
  "static": true,
122808
122812
  "readonly": true,
122809
- "default": "'sbb-step'",
122810
122813
  "inheritedFrom": {
122811
122814
  "name": "SbbElement",
122812
122815
  "module": "core/base-elements/element.js"
122813
- }
122816
+ },
122817
+ "default": "'sbb-step-label'"
122814
122818
  },
122815
122819
  {
122816
122820
  "kind": "field",
@@ -122821,41 +122825,28 @@
122821
122825
  "privacy": "public",
122822
122826
  "static": true,
122823
122827
  "readonly": true,
122824
- "default": "'tabpanel'"
122825
- },
122826
- {
122827
- "kind": "field",
122828
- "name": "events",
122829
- "privacy": "public",
122830
- "static": true,
122831
- "readonly": true,
122832
- "default": "{ validate: 'validate', resizechange: 'resizechange', }",
122833
- "type": {
122834
- "text": "{\n validate: 'validate',\n resizechange: 'resizechange',\n }"
122828
+ "default": "'tab'",
122829
+ "inheritedFrom": {
122830
+ "name": "SbbButtonLikeBaseElement",
122831
+ "module": "core/base-elements/button-base-element.js"
122835
122832
  }
122836
122833
  },
122837
122834
  {
122838
122835
  "kind": "field",
122839
- "name": "_stepResizeObserver",
122840
- "privacy": "private",
122841
- "default": "new ResizeController(this, { target: null, skipInitial: true, callback: () => setTimeout(() => this._onStepElementResize()), })"
122842
- },
122843
- {
122844
- "kind": "field",
122845
- "name": "label",
122836
+ "name": "step",
122846
122837
  "type": {
122847
- "text": "SbbStepLabelElement | null"
122838
+ "text": "SbbStepElement | null"
122848
122839
  },
122849
122840
  "privacy": "public",
122850
- "description": "The label of the step.",
122841
+ "description": "The step controlled by the label.",
122851
122842
  "readonly": true,
122852
122843
  "default": "null"
122853
122844
  },
122854
122845
  {
122855
122846
  "kind": "field",
122856
- "name": "_label",
122847
+ "name": "_step",
122857
122848
  "type": {
122858
- "text": "SbbStepLabelElement | null"
122849
+ "text": "SbbStepElement | null"
122859
122850
  },
122860
122851
  "privacy": "private",
122861
122852
  "default": "null"
@@ -122869,6 +122860,22 @@
122869
122860
  "privacy": "public",
122870
122861
  "readonly": true
122871
122862
  },
122863
+ {
122864
+ "kind": "field",
122865
+ "name": "disabled",
122866
+ "privacy": "public",
122867
+ "description": "Whether the component is disabled.",
122868
+ "default": "false",
122869
+ "type": {
122870
+ "text": "boolean"
122871
+ },
122872
+ "attribute": "disabled",
122873
+ "reflects": true,
122874
+ "inheritedFrom": {
122875
+ "name": "SbbDisabledMixin",
122876
+ "module": "core/mixins/disabled-mixin.js"
122877
+ }
122878
+ },
122872
122879
  {
122873
122880
  "kind": "field",
122874
122881
  "name": "_previousOrientation",
@@ -122877,686 +122884,707 @@
122877
122884
  },
122878
122885
  "privacy": "private"
122879
122886
  },
122887
+ {
122888
+ "kind": "field",
122889
+ "name": "_previousSize",
122890
+ "type": {
122891
+ "text": "string | undefined"
122892
+ },
122893
+ "privacy": "private"
122894
+ },
122880
122895
  {
122881
122896
  "kind": "method",
122882
- "name": "_handleClick",
122897
+ "name": "_isNotDeactivatedByLinearMode",
122883
122898
  "privacy": "private",
122884
122899
  "return": {
122885
122900
  "type": {
122886
- "text": "void"
122901
+ "text": "boolean"
122887
122902
  }
122888
122903
  },
122889
122904
  "parameters": [
122890
122905
  {
122891
- "name": "event",
122906
+ "name": "step",
122892
122907
  "type": {
122893
- "text": "Event"
122908
+ "text": "SbbStepElement"
122894
122909
  }
122895
122910
  }
122896
- ],
122897
- "description": "Watches for clicked elements with `sbb-stepper-next` or `sbb-stepper-previous` attributes."
122911
+ ]
122898
122912
  },
122899
122913
  {
122900
122914
  "kind": "method",
122901
- "name": "_isGoNextElement",
122915
+ "name": "_assignStep",
122902
122916
  "privacy": "private",
122903
122917
  "return": {
122904
122918
  "type": {
122905
- "text": "boolean"
122919
+ "text": "void"
122906
122920
  }
122921
+ }
122922
+ },
122923
+ {
122924
+ "kind": "field",
122925
+ "name": "iconName",
122926
+ "type": {
122927
+ "text": "string"
122907
122928
  },
122908
- "parameters": [
122909
- {
122910
- "name": "element",
122911
- "type": {
122912
- "text": "HTMLElement"
122913
- }
122914
- }
122915
- ]
122929
+ "privacy": "public",
122930
+ "default": "''",
122931
+ "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.",
122932
+ "attribute": "icon-name",
122933
+ "inheritedFrom": {
122934
+ "name": "SbbIconNameMixin",
122935
+ "module": "icon/icon-name-mixin.js"
122936
+ }
122916
122937
  },
122917
122938
  {
122918
122939
  "kind": "method",
122919
- "name": "_isGoPreviousElement",
122920
- "privacy": "private",
122940
+ "name": "renderIconSlot",
122941
+ "privacy": "protected",
122921
122942
  "return": {
122922
122943
  "type": {
122923
- "text": "boolean"
122944
+ "text": "TemplateResult"
122924
122945
  }
122925
122946
  },
122926
122947
  "parameters": [
122927
122948
  {
122928
- "name": "element",
122949
+ "name": "classname",
122950
+ "optional": true,
122929
122951
  "type": {
122930
- "text": "HTMLElement"
122952
+ "text": "string"
122931
122953
  }
122932
122954
  }
122933
- ]
122955
+ ],
122956
+ "inheritedFrom": {
122957
+ "name": "SbbIconNameMixin",
122958
+ "module": "icon/icon-name-mixin.js"
122959
+ }
122934
122960
  },
122935
122961
  {
122936
122962
  "kind": "method",
122937
- "name": "_onStepElementResize",
122938
- "privacy": "private",
122963
+ "name": "renderIconName",
122964
+ "privacy": "protected",
122939
122965
  "return": {
122940
122966
  "type": {
122941
- "text": "void"
122967
+ "text": "string"
122942
122968
  }
122969
+ },
122970
+ "inheritedFrom": {
122971
+ "name": "SbbIconNameMixin",
122972
+ "module": "icon/icon-name-mixin.js"
122943
122973
  }
122944
122974
  },
122945
122975
  {
122946
122976
  "kind": "method",
122947
- "name": "_assignLabel",
122977
+ "name": "_renderIconName",
122948
122978
  "privacy": "private",
122949
122979
  "return": {
122950
122980
  "type": {
122951
- "text": "void"
122981
+ "text": "string"
122952
122982
  }
122983
+ },
122984
+ "inheritedFrom": {
122985
+ "name": "SbbIconNameMixin",
122986
+ "module": "icon/icon-name-mixin.js"
122953
122987
  }
122954
122988
  },
122955
122989
  {
122956
122990
  "kind": "field",
122957
- "name": "_hydrationRequired",
122991
+ "name": "#disabled",
122992
+ "privacy": "private",
122958
122993
  "type": {
122959
122994
  "text": "boolean"
122960
122995
  },
122961
- "privacy": "private",
122962
- "default": "!!this.shadowRoot",
122996
+ "default": "false",
122963
122997
  "inheritedFrom": {
122964
- "name": "SbbElement",
122965
- "module": "core/base-elements/element.js"
122998
+ "name": "SbbDisabledMixin",
122999
+ "module": "core/mixins/disabled-mixin.js"
122966
123000
  }
122967
123001
  },
122968
123002
  {
122969
- "kind": "field",
122970
- "name": "_hydrationComplete",
122971
- "privacy": "private",
122972
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
123003
+ "kind": "method",
123004
+ "name": "isDisabledExternally",
123005
+ "privacy": "protected",
123006
+ "return": {
123007
+ "type": {
123008
+ "text": "boolean"
123009
+ }
123010
+ },
123011
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
122973
123012
  "inheritedFrom": {
122974
- "name": "SbbElement",
122975
- "module": "core/base-elements/element.js"
123013
+ "name": "SbbDisabledMixin",
123014
+ "module": "core/mixins/disabled-mixin.js"
122976
123015
  }
122977
123016
  },
122978
123017
  {
122979
123018
  "kind": "field",
122980
- "name": "_resolveHydration",
123019
+ "name": "_elementsOnWhichEnterPressTriggersSubmit",
122981
123020
  "type": {
122982
- "text": "(hydrationRequired: boolean) => void"
123021
+ "text": "array"
122983
123022
  },
122984
123023
  "privacy": "private",
123024
+ "readonly": true,
123025
+ "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
122985
123026
  "inheritedFrom": {
122986
- "name": "SbbElement",
122987
- "module": "core/base-elements/element.js"
123027
+ "name": "SbbButtonBaseElement",
123028
+ "module": "core/base-elements/button-base-element.js"
122988
123029
  }
122989
123030
  },
122990
123031
  {
122991
123032
  "kind": "field",
122992
- "name": "hydrationRequired",
123033
+ "name": "value",
122993
123034
  "type": {
122994
- "text": "boolean"
123035
+ "text": "string"
122995
123036
  },
122996
- "privacy": "protected",
122997
- "description": "Returns whether hydration is required and not completed.",
122998
- "readonly": true,
123037
+ "privacy": "public",
122999
123038
  "inheritedFrom": {
123000
- "name": "SbbElement",
123001
- "module": "core/base-elements/element.js"
123039
+ "name": "SbbButtonBaseElement",
123040
+ "module": "core/base-elements/button-base-element.js"
123002
123041
  },
123003
- "default": "!!this.shadowRoot"
123042
+ "default": "''",
123043
+ "description": "Value of the form element.",
123044
+ "attribute": "value"
123004
123045
  },
123005
123046
  {
123006
- "kind": "method",
123007
- "name": "toggleState",
123008
- "privacy": "protected",
123009
- "return": {
123010
- "type": {
123011
- "text": "void"
123012
- }
123047
+ "kind": "field",
123048
+ "name": "type",
123049
+ "privacy": "public",
123050
+ "description": "The type attribute to use for the button.",
123051
+ "default": "'button'",
123052
+ "type": {
123053
+ "text": "SbbButtonType"
123013
123054
  },
123014
- "parameters": [
123015
- {
123016
- "name": "value",
123017
- "type": {
123018
- "text": "string"
123019
- }
123020
- },
123021
- {
123022
- "name": "force",
123023
- "optional": true,
123024
- "type": {
123025
- "text": "boolean"
123026
- }
123027
- }
123028
- ],
123055
+ "attribute": "type",
123029
123056
  "inheritedFrom": {
123030
- "name": "SbbElement",
123031
- "module": "core/base-elements/element.js"
123057
+ "name": "SbbButtonBaseElement",
123058
+ "module": "core/base-elements/button-base-element.js"
123032
123059
  }
123033
123060
  },
123034
123061
  {
123035
123062
  "kind": "field",
123036
- "name": "['_$sbbElement$']",
123063
+ "name": "form",
123037
123064
  "type": {
123038
- "text": "boolean"
123065
+ "text": "HTMLFormElement | null"
123039
123066
  },
123040
123067
  "privacy": "public",
123041
- "static": true,
123042
- "default": "true",
123068
+ "description": "The `<form>` element to associate the button with.",
123043
123069
  "inheritedFrom": {
123044
- "name": "SbbElement",
123045
- "module": "core/base-elements/element.js"
123046
- }
123070
+ "name": "SbbButtonBaseElement",
123071
+ "module": "core/base-elements/button-base-element.js"
123072
+ },
123073
+ "attribute": "form"
123047
123074
  },
123048
123075
  {
123049
123076
  "kind": "field",
123050
- "name": "_controllers",
123077
+ "name": "_formId",
123051
123078
  "type": {
123052
- "text": "Set<SbbReactiveController> | undefined"
123079
+ "text": "string"
123053
123080
  },
123054
123081
  "privacy": "private",
123082
+ "default": "''",
123055
123083
  "inheritedFrom": {
123056
- "name": "SbbElement",
123057
- "module": "core/base-elements/element.js"
123084
+ "name": "SbbButtonBaseElement",
123085
+ "module": "core/base-elements/button-base-element.js"
123058
123086
  }
123059
- }
123060
- ],
123061
- "events": [
123087
+ },
123062
123088
  {
123063
- "name": "validate",
123064
- "type": {
123065
- "text": "CustomEvent<SbbStepValidateEventDetails>"
123066
- },
123067
- "description": "The validate event is dispatched when a step change is triggered. Can be canceled to abort the step change."
123068
- }
123069
- ],
123070
- "superclass": {
123071
- "name": "SbbElement",
123072
- "module": "core/base-elements.js"
123073
- },
123074
- "tagName": "sbb-step",
123075
- "customElement": true
123076
- }
123077
- ],
123078
- "exports": [
123079
- {
123080
- "kind": "js",
123081
- "name": "SbbStepElement",
123082
- "declaration": {
123083
- "name": "SbbStepElement",
123084
- "module": "stepper/step/step.component.js"
123085
- }
123086
- }
123087
- ]
123088
- },
123089
- {
123090
- "kind": "javascript-module",
123091
- "path": "stepper/step-label/step-label.component.js",
123092
- "declarations": [
123093
- {
123094
- "kind": "class",
123095
- "description": "Combined with a `sbb-stepper`, it displays a step's label.",
123096
- "name": "SbbStepLabelElement",
123097
- "slots": [
123089
+ "kind": "field",
123090
+ "name": "_handleButtonClick",
123091
+ "privacy": "private",
123092
+ "inheritedFrom": {
123093
+ "name": "SbbButtonBaseElement",
123094
+ "module": "core/base-elements/button-base-element.js"
123095
+ }
123096
+ },
123098
123097
  {
123099
- "description": "Use the unnamed slot to provide a label.",
123100
- "name": ""
123098
+ "kind": "method",
123099
+ "name": "_requestSubmit",
123100
+ "privacy": "private",
123101
+ "return": {
123102
+ "type": {
123103
+ "text": "void"
123104
+ }
123105
+ },
123106
+ "parameters": [
123107
+ {
123108
+ "name": "form",
123109
+ "type": {
123110
+ "text": "HTMLFormElement"
123111
+ }
123112
+ }
123113
+ ],
123114
+ "inheritedFrom": {
123115
+ "name": "SbbButtonBaseElement",
123116
+ "module": "core/base-elements/button-base-element.js"
123117
+ }
123101
123118
  },
123102
123119
  {
123103
- "description": "Use this to display an icon in the label bubble.",
123104
- "name": "icon"
123105
- }
123106
- ],
123107
- "members": [
123120
+ "kind": "field",
123121
+ "name": "_formKeyDown",
123122
+ "privacy": "private",
123123
+ "inheritedFrom": {
123124
+ "name": "SbbButtonBaseElement",
123125
+ "module": "core/base-elements/button-base-element.js"
123126
+ }
123127
+ },
123108
123128
  {
123109
123129
  "kind": "field",
123110
- "name": "elementName",
123130
+ "name": "formAssociated",
123111
123131
  "type": {
123112
- "text": "string"
123132
+ "text": "boolean"
123113
123133
  },
123114
123134
  "privacy": "public",
123115
123135
  "static": true,
123116
- "readonly": true,
123136
+ "default": "true",
123117
123137
  "inheritedFrom": {
123118
- "name": "SbbElement",
123119
- "module": "core/base-elements/element.js"
123120
- },
123121
- "default": "'sbb-step-label'"
123138
+ "name": "SbbFormAssociatedMixin",
123139
+ "module": "core/mixins/form-associated-mixin.js"
123140
+ }
123122
123141
  },
123123
123142
  {
123124
123143
  "kind": "field",
123125
- "name": "role",
123144
+ "name": "name",
123145
+ "privacy": "public",
123146
+ "description": "Name of the form element. Will be read from name attribute.",
123126
123147
  "type": {
123127
123148
  "text": "string"
123128
123149
  },
123129
- "privacy": "public",
123130
- "static": true,
123131
- "readonly": true,
123132
- "default": "'tab'",
123150
+ "attribute": "name",
123133
123151
  "inheritedFrom": {
123134
- "name": "SbbButtonLikeBaseElement",
123135
- "module": "core/base-elements/button-base-element.js"
123152
+ "name": "SbbFormAssociatedMixin",
123153
+ "module": "core/mixins/form-associated-mixin.js"
123136
123154
  }
123137
123155
  },
123138
123156
  {
123139
123157
  "kind": "field",
123140
- "name": "step",
123158
+ "name": "validity",
123141
123159
  "type": {
123142
- "text": "SbbStepElement | null"
123160
+ "text": "ValidityState"
123143
123161
  },
123144
123162
  "privacy": "public",
123145
- "description": "The step controlled by the label.",
123163
+ "description": "Returns the ValidityState object for this element.",
123146
123164
  "readonly": true,
123147
- "default": "null"
123148
- },
123149
- {
123150
- "kind": "field",
123151
- "name": "_step",
123152
- "type": {
123153
- "text": "SbbStepElement | null"
123154
- },
123155
- "privacy": "private",
123156
- "default": "null"
123165
+ "inheritedFrom": {
123166
+ "name": "SbbFormAssociatedMixin",
123167
+ "module": "core/mixins/form-associated-mixin.js"
123168
+ }
123157
123169
  },
123158
123170
  {
123159
123171
  "kind": "field",
123160
- "name": "stepper",
123172
+ "name": "validationMessage",
123161
123173
  "type": {
123162
- "text": "SbbStepperElement | null"
123174
+ "text": "string"
123163
123175
  },
123164
123176
  "privacy": "public",
123165
- "readonly": true
123177
+ "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.",
123178
+ "readonly": true,
123179
+ "inheritedFrom": {
123180
+ "name": "SbbFormAssociatedMixin",
123181
+ "module": "core/mixins/form-associated-mixin.js"
123182
+ }
123166
123183
  },
123167
123184
  {
123168
123185
  "kind": "field",
123169
- "name": "disabled",
123170
- "privacy": "public",
123171
- "description": "Whether the component is disabled.",
123172
- "default": "false",
123186
+ "name": "willValidate",
123173
123187
  "type": {
123174
123188
  "text": "boolean"
123175
123189
  },
123176
- "attribute": "disabled",
123177
- "reflects": true,
123190
+ "privacy": "public",
123191
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
123192
+ "readonly": true,
123178
123193
  "inheritedFrom": {
123179
- "name": "SbbDisabledMixin",
123180
- "module": "core/mixins/disabled-mixin.js"
123194
+ "name": "SbbFormAssociatedMixin",
123195
+ "module": "core/mixins/form-associated-mixin.js"
123181
123196
  }
123182
123197
  },
123183
123198
  {
123184
123199
  "kind": "field",
123185
- "name": "_previousOrientation",
123186
- "type": {
123187
- "text": "string | undefined"
123188
- },
123189
- "privacy": "private"
123200
+ "name": "_validityStates",
123201
+ "privacy": "private",
123202
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
123203
+ "inheritedFrom": {
123204
+ "name": "SbbFormAssociatedMixin",
123205
+ "module": "core/mixins/form-associated-mixin.js"
123206
+ }
123190
123207
  },
123191
123208
  {
123192
123209
  "kind": "field",
123193
- "name": "_previousSize",
123210
+ "name": "formDisabled",
123194
123211
  "type": {
123195
- "text": "string | undefined"
123212
+ "text": "boolean"
123196
123213
  },
123197
- "privacy": "private"
123214
+ "privacy": "protected",
123215
+ "default": "false",
123216
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
123217
+ "inheritedFrom": {
123218
+ "name": "SbbFormAssociatedMixin",
123219
+ "module": "core/mixins/form-associated-mixin.js"
123220
+ }
123198
123221
  },
123199
123222
  {
123200
123223
  "kind": "method",
123201
- "name": "_isNotDeactivatedByLinearMode",
123202
- "privacy": "private",
123224
+ "name": "checkValidity",
123225
+ "privacy": "public",
123203
123226
  "return": {
123204
123227
  "type": {
123205
123228
  "text": "boolean"
123206
123229
  }
123207
123230
  },
123208
- "parameters": [
123209
- {
123210
- "name": "step",
123211
- "type": {
123212
- "text": "SbbStepElement"
123213
- }
123214
- }
123215
- ]
123231
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
123232
+ "inheritedFrom": {
123233
+ "name": "SbbFormAssociatedMixin",
123234
+ "module": "core/mixins/form-associated-mixin.js"
123235
+ }
123216
123236
  },
123217
123237
  {
123218
123238
  "kind": "method",
123219
- "name": "_assignStep",
123220
- "privacy": "private",
123239
+ "name": "reportValidity",
123240
+ "privacy": "public",
123221
123241
  "return": {
123222
123242
  "type": {
123223
- "text": "void"
123243
+ "text": "boolean"
123224
123244
  }
123225
- }
123226
- },
123227
- {
123228
- "kind": "field",
123229
- "name": "iconName",
123230
- "type": {
123231
- "text": "string"
123232
123245
  },
123233
- "privacy": "public",
123234
- "default": "''",
123235
- "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.",
123236
- "attribute": "icon-name",
123246
+ "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.",
123237
123247
  "inheritedFrom": {
123238
- "name": "SbbIconNameMixin",
123239
- "module": "icon/icon-name-mixin.js"
123248
+ "name": "SbbFormAssociatedMixin",
123249
+ "module": "core/mixins/form-associated-mixin.js"
123240
123250
  }
123241
123251
  },
123242
123252
  {
123243
123253
  "kind": "method",
123244
- "name": "renderIconSlot",
123245
- "privacy": "protected",
123254
+ "name": "setCustomValidity",
123255
+ "privacy": "public",
123246
123256
  "return": {
123247
123257
  "type": {
123248
- "text": "TemplateResult"
123258
+ "text": "void"
123249
123259
  }
123250
123260
  },
123251
123261
  "parameters": [
123252
123262
  {
123253
- "name": "classname",
123254
- "optional": true,
123263
+ "name": "message",
123255
123264
  "type": {
123256
123265
  "text": "string"
123257
123266
  }
123258
123267
  }
123259
123268
  ],
123269
+ "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.",
123260
123270
  "inheritedFrom": {
123261
- "name": "SbbIconNameMixin",
123262
- "module": "icon/icon-name-mixin.js"
123271
+ "name": "SbbFormAssociatedMixin",
123272
+ "module": "core/mixins/form-associated-mixin.js"
123263
123273
  }
123264
123274
  },
123265
123275
  {
123266
123276
  "kind": "method",
123267
- "name": "renderIconName",
123268
- "privacy": "protected",
123277
+ "name": "_hasDisabledAncestor",
123278
+ "privacy": "private",
123269
123279
  "return": {
123270
123280
  "type": {
123271
- "text": "string"
123281
+ "text": "boolean"
123272
123282
  }
123273
123283
  },
123274
123284
  "inheritedFrom": {
123275
- "name": "SbbIconNameMixin",
123276
- "module": "icon/icon-name-mixin.js"
123285
+ "name": "SbbFormAssociatedMixin",
123286
+ "module": "core/mixins/form-associated-mixin.js"
123277
123287
  }
123278
123288
  },
123279
123289
  {
123280
123290
  "kind": "method",
123281
- "name": "_renderIconName",
123282
- "privacy": "private",
123291
+ "name": "updateFormValue",
123292
+ "privacy": "protected",
123283
123293
  "return": {
123284
123294
  "type": {
123285
- "text": "string"
123295
+ "text": "void"
123286
123296
  }
123287
123297
  },
123298
+ "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",
123288
123299
  "inheritedFrom": {
123289
- "name": "SbbIconNameMixin",
123290
- "module": "icon/icon-name-mixin.js"
123300
+ "name": "SbbFormAssociatedMixin",
123301
+ "module": "core/mixins/form-associated-mixin.js"
123291
123302
  }
123292
123303
  },
123293
123304
  {
123294
- "kind": "field",
123295
- "name": "#disabled",
123296
- "privacy": "private",
123297
- "type": {
123298
- "text": "boolean"
123299
- },
123300
- "default": "false",
123305
+ "kind": "method",
123306
+ "name": "formState",
123307
+ "privacy": "protected",
123308
+ "return": {
123309
+ "type": {
123310
+ "text": "FormRestoreState"
123311
+ }
123312
+ },
123301
123313
  "inheritedFrom": {
123302
- "name": "SbbDisabledMixin",
123303
- "module": "core/mixins/disabled-mixin.js"
123314
+ "name": "SbbFormAssociatedMixin",
123315
+ "module": "core/mixins/form-associated-mixin.js"
123304
123316
  }
123305
123317
  },
123306
123318
  {
123307
123319
  "kind": "method",
123308
- "name": "isDisabledExternally",
123320
+ "name": "setValidityFlag",
123309
123321
  "privacy": "protected",
123310
123322
  "return": {
123311
123323
  "type": {
123312
- "text": "boolean"
123324
+ "text": "void"
123313
123325
  }
123314
123326
  },
123315
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
123327
+ "parameters": [
123328
+ {
123329
+ "name": "flag",
123330
+ "type": {
123331
+ "text": "T"
123332
+ }
123333
+ },
123334
+ {
123335
+ "name": "message",
123336
+ "type": {
123337
+ "text": "string"
123338
+ }
123339
+ },
123340
+ {
123341
+ "name": "flagValue",
123342
+ "optional": true,
123343
+ "type": {
123344
+ "text": "ValidityStateFlags[T]"
123345
+ }
123346
+ }
123347
+ ],
123348
+ "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).",
123316
123349
  "inheritedFrom": {
123317
- "name": "SbbDisabledMixin",
123318
- "module": "core/mixins/disabled-mixin.js"
123350
+ "name": "SbbFormAssociatedMixin",
123351
+ "module": "core/mixins/form-associated-mixin.js"
123319
123352
  }
123320
123353
  },
123321
123354
  {
123322
- "kind": "field",
123323
- "name": "_elementsOnWhichEnterPressTriggersSubmit",
123324
- "type": {
123325
- "text": "array"
123355
+ "kind": "method",
123356
+ "name": "removeValidityFlag",
123357
+ "privacy": "protected",
123358
+ "return": {
123359
+ "type": {
123360
+ "text": "void"
123361
+ }
123326
123362
  },
123327
- "privacy": "private",
123328
- "readonly": true,
123329
- "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
123363
+ "parameters": [
123364
+ {
123365
+ "name": "flag",
123366
+ "type": {
123367
+ "text": "T"
123368
+ }
123369
+ }
123370
+ ],
123371
+ "description": "Removes the validity state flag entry and updates validity state.",
123330
123372
  "inheritedFrom": {
123331
- "name": "SbbButtonBaseElement",
123332
- "module": "core/base-elements/button-base-element.js"
123373
+ "name": "SbbFormAssociatedMixin",
123374
+ "module": "core/mixins/form-associated-mixin.js"
123333
123375
  }
123334
123376
  },
123335
123377
  {
123336
- "kind": "field",
123337
- "name": "value",
123338
- "type": {
123339
- "text": "string"
123378
+ "kind": "method",
123379
+ "name": "validate",
123380
+ "privacy": "protected",
123381
+ "return": {
123382
+ "type": {
123383
+ "text": "void"
123384
+ }
123340
123385
  },
123341
- "privacy": "public",
123386
+ "description": "To be called whenever the current element needs to be validated.",
123342
123387
  "inheritedFrom": {
123343
- "name": "SbbButtonBaseElement",
123344
- "module": "core/base-elements/button-base-element.js"
123345
- },
123346
- "default": "''",
123347
- "description": "Value of the form element.",
123348
- "attribute": "value"
123388
+ "name": "SbbFormAssociatedMixin",
123389
+ "module": "core/mixins/form-associated-mixin.js"
123390
+ }
123349
123391
  },
123350
123392
  {
123351
- "kind": "field",
123352
- "name": "type",
123353
- "privacy": "public",
123354
- "description": "The type attribute to use for the button.",
123355
- "default": "'button'",
123356
- "type": {
123357
- "text": "SbbButtonType"
123393
+ "kind": "method",
123394
+ "name": "shouldValidate",
123395
+ "privacy": "protected",
123396
+ "return": {
123397
+ "type": {
123398
+ "text": "boolean"
123399
+ }
123358
123400
  },
123359
- "attribute": "type",
123401
+ "parameters": [
123402
+ {
123403
+ "name": "name",
123404
+ "type": {
123405
+ "text": "PropertyKey | undefined"
123406
+ }
123407
+ }
123408
+ ],
123409
+ "description": "Whether validation should be run on a property change with the given name.",
123360
123410
  "inheritedFrom": {
123361
- "name": "SbbButtonBaseElement",
123362
- "module": "core/base-elements/button-base-element.js"
123411
+ "name": "SbbFormAssociatedMixin",
123412
+ "module": "core/mixins/form-associated-mixin.js"
123363
123413
  }
123364
123414
  },
123365
123415
  {
123366
- "kind": "field",
123367
- "name": "form",
123368
- "type": {
123369
- "text": "HTMLFormElement | null"
123416
+ "kind": "method",
123417
+ "name": "_setInternalValidity",
123418
+ "privacy": "private",
123419
+ "return": {
123420
+ "type": {
123421
+ "text": "void"
123422
+ }
123370
123423
  },
123371
- "privacy": "public",
123372
- "description": "The `<form>` element to associate the button with.",
123373
123424
  "inheritedFrom": {
123374
- "name": "SbbButtonBaseElement",
123375
- "module": "core/base-elements/button-base-element.js"
123376
- },
123377
- "attribute": "form"
123425
+ "name": "SbbFormAssociatedMixin",
123426
+ "module": "core/mixins/form-associated-mixin.js"
123427
+ }
123378
123428
  },
123379
123429
  {
123380
123430
  "kind": "field",
123381
- "name": "_formId",
123382
- "type": {
123383
- "text": "string"
123384
- },
123431
+ "name": "_preventScrollOnSpaceKeydown",
123385
123432
  "privacy": "private",
123386
- "default": "''",
123433
+ "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
123434
+ "parameters": [
123435
+ {
123436
+ "description": "The origin event.",
123437
+ "name": "event"
123438
+ }
123439
+ ],
123387
123440
  "inheritedFrom": {
123388
- "name": "SbbButtonBaseElement",
123441
+ "name": "SbbButtonLikeBaseElement",
123389
123442
  "module": "core/base-elements/button-base-element.js"
123390
123443
  }
123391
123444
  },
123392
123445
  {
123393
123446
  "kind": "field",
123394
- "name": "_handleButtonClick",
123447
+ "name": "_removeActiveMarker",
123395
123448
  "privacy": "private",
123396
123449
  "inheritedFrom": {
123397
- "name": "SbbButtonBaseElement",
123450
+ "name": "SbbButtonLikeBaseElement",
123398
123451
  "module": "core/base-elements/button-base-element.js"
123399
123452
  }
123400
123453
  },
123401
123454
  {
123402
- "kind": "method",
123403
- "name": "_requestSubmit",
123455
+ "kind": "field",
123456
+ "name": "_dispatchClickEventOnSpaceKeyup",
123404
123457
  "privacy": "private",
123405
- "return": {
123406
- "type": {
123407
- "text": "void"
123408
- }
123409
- },
123458
+ "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.",
123410
123459
  "parameters": [
123411
123460
  {
123412
- "name": "form",
123413
- "type": {
123414
- "text": "HTMLFormElement"
123415
- }
123461
+ "description": "The origin event.",
123462
+ "name": "event"
123416
123463
  }
123417
123464
  ],
123418
123465
  "inheritedFrom": {
123419
- "name": "SbbButtonBaseElement",
123466
+ "name": "SbbButtonLikeBaseElement",
123420
123467
  "module": "core/base-elements/button-base-element.js"
123421
123468
  }
123422
123469
  },
123423
123470
  {
123424
123471
  "kind": "field",
123425
- "name": "_formKeyDown",
123472
+ "name": "_dispatchClickEvent",
123426
123473
  "privacy": "private",
123427
123474
  "inheritedFrom": {
123428
- "name": "SbbButtonBaseElement",
123475
+ "name": "SbbButtonLikeBaseElement",
123429
123476
  "module": "core/base-elements/button-base-element.js"
123430
123477
  }
123431
123478
  },
123432
123479
  {
123433
123480
  "kind": "field",
123434
- "name": "formAssociated",
123481
+ "name": "maybeDisabled",
123435
123482
  "type": {
123436
- "text": "boolean"
123483
+ "text": "boolean | undefined"
123437
123484
  },
123438
- "privacy": "public",
123439
- "static": true,
123440
- "default": "true",
123485
+ "privacy": "protected",
123486
+ "readonly": true,
123441
123487
  "inheritedFrom": {
123442
- "name": "SbbFormAssociatedMixin",
123443
- "module": "core/mixins/form-associated-mixin.js"
123488
+ "name": "SbbActionBaseElement",
123489
+ "module": "core/base-elements/action-base-element.js"
123444
123490
  }
123445
123491
  },
123446
123492
  {
123447
123493
  "kind": "field",
123448
- "name": "name",
123449
- "privacy": "public",
123450
- "description": "Name of the form element. Will be read from name attribute.",
123494
+ "name": "maybeDisabledInteractive",
123451
123495
  "type": {
123452
- "text": "string"
123496
+ "text": "boolean | undefined"
123453
123497
  },
123454
- "attribute": "name",
123498
+ "privacy": "protected",
123499
+ "readonly": true,
123455
123500
  "inheritedFrom": {
123456
- "name": "SbbFormAssociatedMixin",
123457
- "module": "core/mixins/form-associated-mixin.js"
123501
+ "name": "SbbActionBaseElement",
123502
+ "module": "core/base-elements/action-base-element.js"
123458
123503
  }
123459
123504
  },
123460
123505
  {
123461
- "kind": "field",
123462
- "name": "validity",
123463
- "type": {
123464
- "text": "ValidityState"
123506
+ "kind": "method",
123507
+ "name": "setupBaseEventHandlers",
123508
+ "privacy": "protected",
123509
+ "return": {
123510
+ "type": {
123511
+ "text": "void"
123512
+ }
123465
123513
  },
123466
- "privacy": "public",
123467
- "description": "Returns the ValidityState object for this element.",
123468
- "readonly": true,
123469
123514
  "inheritedFrom": {
123470
- "name": "SbbFormAssociatedMixin",
123471
- "module": "core/mixins/form-associated-mixin.js"
123515
+ "name": "SbbActionBaseElement",
123516
+ "module": "core/base-elements/action-base-element.js"
123472
123517
  }
123473
123518
  },
123474
123519
  {
123475
- "kind": "field",
123476
- "name": "validationMessage",
123477
- "type": {
123478
- "text": "string"
123520
+ "kind": "method",
123521
+ "name": "renderTemplate",
123522
+ "privacy": "protected",
123523
+ "return": {
123524
+ "type": {
123525
+ "text": "TemplateResult"
123526
+ }
123479
123527
  },
123480
- "privacy": "public",
123481
- "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.",
123482
- "readonly": true,
123528
+ "description": "Override this method to render the component template.",
123483
123529
  "inheritedFrom": {
123484
- "name": "SbbFormAssociatedMixin",
123485
- "module": "core/mixins/form-associated-mixin.js"
123530
+ "name": "SbbActionBaseElement",
123531
+ "module": "core/base-elements/action-base-element.js"
123486
123532
  }
123487
123533
  },
123488
123534
  {
123489
123535
  "kind": "field",
123490
- "name": "willValidate",
123536
+ "name": "_hydrationRequired",
123491
123537
  "type": {
123492
123538
  "text": "boolean"
123493
123539
  },
123494
- "privacy": "public",
123495
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
123496
- "readonly": true,
123540
+ "privacy": "private",
123541
+ "default": "!!this.shadowRoot",
123497
123542
  "inheritedFrom": {
123498
- "name": "SbbFormAssociatedMixin",
123499
- "module": "core/mixins/form-associated-mixin.js"
123543
+ "name": "SbbElement",
123544
+ "module": "core/base-elements/element.js"
123500
123545
  }
123501
123546
  },
123502
123547
  {
123503
123548
  "kind": "field",
123504
- "name": "_validityStates",
123549
+ "name": "_hydrationComplete",
123505
123550
  "privacy": "private",
123506
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
123551
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
123507
123552
  "inheritedFrom": {
123508
- "name": "SbbFormAssociatedMixin",
123509
- "module": "core/mixins/form-associated-mixin.js"
123553
+ "name": "SbbElement",
123554
+ "module": "core/base-elements/element.js"
123510
123555
  }
123511
123556
  },
123512
123557
  {
123513
123558
  "kind": "field",
123514
- "name": "formDisabled",
123559
+ "name": "_resolveHydration",
123515
123560
  "type": {
123516
- "text": "boolean"
123561
+ "text": "(hydrationRequired: boolean) => void"
123517
123562
  },
123518
- "privacy": "protected",
123519
- "default": "false",
123520
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
123563
+ "privacy": "private",
123521
123564
  "inheritedFrom": {
123522
- "name": "SbbFormAssociatedMixin",
123523
- "module": "core/mixins/form-associated-mixin.js"
123565
+ "name": "SbbElement",
123566
+ "module": "core/base-elements/element.js"
123524
123567
  }
123525
123568
  },
123526
123569
  {
123527
- "kind": "method",
123528
- "name": "checkValidity",
123529
- "privacy": "public",
123530
- "return": {
123531
- "type": {
123532
- "text": "boolean"
123533
- }
123570
+ "kind": "field",
123571
+ "name": "hydrationRequired",
123572
+ "type": {
123573
+ "text": "boolean"
123534
123574
  },
123535
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
123575
+ "privacy": "protected",
123576
+ "description": "Returns whether hydration is required and not completed.",
123577
+ "readonly": true,
123536
123578
  "inheritedFrom": {
123537
- "name": "SbbFormAssociatedMixin",
123538
- "module": "core/mixins/form-associated-mixin.js"
123539
- }
123540
- },
123541
- {
123542
- "kind": "method",
123543
- "name": "reportValidity",
123544
- "privacy": "public",
123545
- "return": {
123546
- "type": {
123547
- "text": "boolean"
123548
- }
123579
+ "name": "SbbElement",
123580
+ "module": "core/base-elements/element.js"
123549
123581
  },
123550
- "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.",
123551
- "inheritedFrom": {
123552
- "name": "SbbFormAssociatedMixin",
123553
- "module": "core/mixins/form-associated-mixin.js"
123554
- }
123582
+ "default": "!!this.shadowRoot"
123555
123583
  },
123556
123584
  {
123557
123585
  "kind": "method",
123558
- "name": "setCustomValidity",
123559
- "privacy": "public",
123586
+ "name": "toggleState",
123587
+ "privacy": "protected",
123560
123588
  "return": {
123561
123589
  "type": {
123562
123590
  "text": "void"
@@ -123564,101 +123592,257 @@
123564
123592
  },
123565
123593
  "parameters": [
123566
123594
  {
123567
- "name": "message",
123595
+ "name": "value",
123568
123596
  "type": {
123569
123597
  "text": "string"
123570
123598
  }
123599
+ },
123600
+ {
123601
+ "name": "force",
123602
+ "optional": true,
123603
+ "type": {
123604
+ "text": "boolean"
123605
+ }
123571
123606
  }
123572
123607
  ],
123573
- "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.",
123574
123608
  "inheritedFrom": {
123575
- "name": "SbbFormAssociatedMixin",
123576
- "module": "core/mixins/form-associated-mixin.js"
123609
+ "name": "SbbElement",
123610
+ "module": "core/base-elements/element.js"
123577
123611
  }
123578
123612
  },
123579
123613
  {
123580
- "kind": "method",
123581
- "name": "_hasDisabledAncestor",
123614
+ "kind": "field",
123615
+ "name": "['_$sbbElement$']",
123616
+ "type": {
123617
+ "text": "boolean"
123618
+ },
123619
+ "privacy": "public",
123620
+ "static": true,
123621
+ "default": "true",
123622
+ "inheritedFrom": {
123623
+ "name": "SbbElement",
123624
+ "module": "core/base-elements/element.js"
123625
+ }
123626
+ },
123627
+ {
123628
+ "kind": "field",
123629
+ "name": "_controllers",
123630
+ "type": {
123631
+ "text": "Set<SbbReactiveController> | undefined"
123632
+ },
123582
123633
  "privacy": "private",
123583
- "return": {
123584
- "type": {
123585
- "text": "boolean"
123586
- }
123634
+ "inheritedFrom": {
123635
+ "name": "SbbElement",
123636
+ "module": "core/base-elements/element.js"
123637
+ }
123638
+ }
123639
+ ],
123640
+ "mixins": [
123641
+ {
123642
+ "name": "SbbIconNameMixin",
123643
+ "module": "icon.js"
123644
+ },
123645
+ {
123646
+ "name": "SbbDisabledMixin",
123647
+ "module": "core/mixins.js"
123648
+ }
123649
+ ],
123650
+ "superclass": {
123651
+ "name": "SbbButtonBaseElement",
123652
+ "module": "core/base-elements.js"
123653
+ },
123654
+ "tagName": "sbb-step-label",
123655
+ "customElement": true,
123656
+ "attributes": [
123657
+ {
123658
+ "name": "icon-name",
123659
+ "type": {
123660
+ "text": "string"
123587
123661
  },
123662
+ "default": "''",
123663
+ "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.",
123664
+ "fieldName": "iconName",
123588
123665
  "inheritedFrom": {
123589
- "name": "SbbFormAssociatedMixin",
123590
- "module": "core/mixins/form-associated-mixin.js"
123666
+ "name": "SbbIconNameMixin",
123667
+ "module": "icon/icon-name-mixin.js"
123591
123668
  }
123592
123669
  },
123593
123670
  {
123594
- "kind": "method",
123595
- "name": "updateFormValue",
123596
- "privacy": "protected",
123597
- "return": {
123598
- "type": {
123599
- "text": "void"
123600
- }
123671
+ "name": "disabled",
123672
+ "description": "Whether the component is disabled.",
123673
+ "default": "false",
123674
+ "type": {
123675
+ "text": "boolean"
123601
123676
  },
123602
- "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",
123677
+ "fieldName": "disabled",
123603
123678
  "inheritedFrom": {
123604
- "name": "SbbFormAssociatedMixin",
123605
- "module": "core/mixins/form-associated-mixin.js"
123679
+ "name": "SbbDisabledMixin",
123680
+ "module": "core/mixins/disabled-mixin.js"
123606
123681
  }
123607
123682
  },
123608
123683
  {
123609
- "kind": "method",
123610
- "name": "formState",
123611
- "privacy": "protected",
123612
- "return": {
123613
- "type": {
123614
- "text": "FormRestoreState"
123615
- }
123684
+ "name": "value",
123685
+ "type": {
123686
+ "text": "string"
123616
123687
  },
123688
+ "default": "''",
123689
+ "description": "Value of the form element.",
123690
+ "fieldName": "value",
123617
123691
  "inheritedFrom": {
123618
- "name": "SbbFormAssociatedMixin",
123619
- "module": "core/mixins/form-associated-mixin.js"
123692
+ "name": "SbbButtonBaseElement",
123693
+ "module": "core/base-elements/button-base-element.js"
123620
123694
  }
123621
123695
  },
123622
123696
  {
123623
- "kind": "method",
123624
- "name": "setValidityFlag",
123625
- "privacy": "protected",
123626
- "return": {
123627
- "type": {
123628
- "text": "void"
123629
- }
123697
+ "name": "type",
123698
+ "description": "The type attribute to use for the button.",
123699
+ "default": "'button'",
123700
+ "type": {
123701
+ "text": "SbbButtonType"
123630
123702
  },
123631
- "parameters": [
123632
- {
123633
- "name": "flag",
123634
- "type": {
123635
- "text": "T"
123636
- }
123637
- },
123638
- {
123639
- "name": "message",
123640
- "type": {
123641
- "text": "string"
123642
- }
123643
- },
123644
- {
123645
- "name": "flagValue",
123646
- "optional": true,
123647
- "type": {
123648
- "text": "ValidityStateFlags[T]"
123649
- }
123650
- }
123651
- ],
123652
- "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).",
123703
+ "fieldName": "type",
123704
+ "inheritedFrom": {
123705
+ "name": "SbbButtonBaseElement",
123706
+ "module": "core/base-elements/button-base-element.js"
123707
+ }
123708
+ },
123709
+ {
123710
+ "name": "form",
123711
+ "description": "The `<form>` element to associate the button with.",
123712
+ "type": {
123713
+ "text": "HTMLFormElement | null"
123714
+ },
123715
+ "fieldName": "form",
123716
+ "inheritedFrom": {
123717
+ "name": "SbbButtonBaseElement",
123718
+ "module": "core/base-elements/button-base-element.js"
123719
+ }
123720
+ },
123721
+ {
123722
+ "name": "name",
123723
+ "description": "Name of the form element. Will be read from name attribute.",
123724
+ "type": {
123725
+ "text": "string"
123726
+ },
123727
+ "fieldName": "name",
123653
123728
  "inheritedFrom": {
123654
123729
  "name": "SbbFormAssociatedMixin",
123655
123730
  "module": "core/mixins/form-associated-mixin.js"
123656
123731
  }
123732
+ }
123733
+ ]
123734
+ }
123735
+ ],
123736
+ "exports": [
123737
+ {
123738
+ "kind": "js",
123739
+ "name": "SbbStepLabelElement",
123740
+ "declaration": {
123741
+ "name": "SbbStepLabelElement",
123742
+ "module": "stepper/step-label/step-label.component.js"
123743
+ }
123744
+ }
123745
+ ]
123746
+ },
123747
+ {
123748
+ "kind": "javascript-module",
123749
+ "path": "stepper/step/step.component.js",
123750
+ "declarations": [
123751
+ {
123752
+ "kind": "class",
123753
+ "description": "Combined with a `sbb-stepper`, it displays a step's content.",
123754
+ "name": "SbbStepElement",
123755
+ "slots": [
123756
+ {
123757
+ "description": "Use the unnamed slot to provide content.",
123758
+ "name": ""
123759
+ }
123760
+ ],
123761
+ "members": [
123762
+ {
123763
+ "kind": "field",
123764
+ "name": "elementName",
123765
+ "type": {
123766
+ "text": "string"
123767
+ },
123768
+ "privacy": "public",
123769
+ "static": true,
123770
+ "readonly": true,
123771
+ "default": "'sbb-step'",
123772
+ "inheritedFrom": {
123773
+ "name": "SbbElement",
123774
+ "module": "core/base-elements/element.js"
123775
+ }
123776
+ },
123777
+ {
123778
+ "kind": "field",
123779
+ "name": "role",
123780
+ "type": {
123781
+ "text": "string"
123782
+ },
123783
+ "privacy": "public",
123784
+ "static": true,
123785
+ "readonly": true,
123786
+ "default": "'tabpanel'"
123787
+ },
123788
+ {
123789
+ "kind": "field",
123790
+ "name": "events",
123791
+ "privacy": "public",
123792
+ "static": true,
123793
+ "readonly": true,
123794
+ "default": "{ validate: 'validate', resizechange: 'resizechange', }",
123795
+ "type": {
123796
+ "text": "{\n validate: 'validate',\n resizechange: 'resizechange',\n }"
123797
+ }
123798
+ },
123799
+ {
123800
+ "kind": "field",
123801
+ "name": "_stepResizeObserver",
123802
+ "privacy": "private",
123803
+ "default": "new ResizeController(this, { target: null, skipInitial: true, callback: () => setTimeout(() => this._onStepElementResize()), })"
123804
+ },
123805
+ {
123806
+ "kind": "field",
123807
+ "name": "label",
123808
+ "type": {
123809
+ "text": "SbbStepLabelElement | null"
123810
+ },
123811
+ "privacy": "public",
123812
+ "description": "The label of the step.",
123813
+ "readonly": true,
123814
+ "default": "null"
123815
+ },
123816
+ {
123817
+ "kind": "field",
123818
+ "name": "_label",
123819
+ "type": {
123820
+ "text": "SbbStepLabelElement | null"
123821
+ },
123822
+ "privacy": "private",
123823
+ "default": "null"
123824
+ },
123825
+ {
123826
+ "kind": "field",
123827
+ "name": "stepper",
123828
+ "type": {
123829
+ "text": "SbbStepperElement | null"
123830
+ },
123831
+ "privacy": "public",
123832
+ "readonly": true
123833
+ },
123834
+ {
123835
+ "kind": "field",
123836
+ "name": "_previousOrientation",
123837
+ "type": {
123838
+ "text": "string | undefined"
123839
+ },
123840
+ "privacy": "private"
123657
123841
  },
123658
123842
  {
123659
123843
  "kind": "method",
123660
- "name": "removeValidityFlag",
123661
- "privacy": "protected",
123844
+ "name": "_handleClick",
123845
+ "privacy": "private",
123662
123846
  "return": {
123663
123847
  "type": {
123664
123848
  "text": "void"
@@ -123666,37 +123850,18 @@
123666
123850
  },
123667
123851
  "parameters": [
123668
123852
  {
123669
- "name": "flag",
123853
+ "name": "event",
123670
123854
  "type": {
123671
- "text": "T"
123855
+ "text": "Event"
123672
123856
  }
123673
123857
  }
123674
123858
  ],
123675
- "description": "Removes the validity state flag entry and updates validity state.",
123676
- "inheritedFrom": {
123677
- "name": "SbbFormAssociatedMixin",
123678
- "module": "core/mixins/form-associated-mixin.js"
123679
- }
123680
- },
123681
- {
123682
- "kind": "method",
123683
- "name": "validate",
123684
- "privacy": "protected",
123685
- "return": {
123686
- "type": {
123687
- "text": "void"
123688
- }
123689
- },
123690
- "description": "To be called whenever the current element needs to be validated.",
123691
- "inheritedFrom": {
123692
- "name": "SbbFormAssociatedMixin",
123693
- "module": "core/mixins/form-associated-mixin.js"
123694
- }
123859
+ "description": "Watches for clicked elements with `sbb-stepper-next` or `sbb-stepper-previous` attributes."
123695
123860
  },
123696
123861
  {
123697
123862
  "kind": "method",
123698
- "name": "shouldValidate",
123699
- "privacy": "protected",
123863
+ "name": "_isGoNextElement",
123864
+ "privacy": "private",
123700
123865
  "return": {
123701
123866
  "type": {
123702
123867
  "text": "boolean"
@@ -123704,135 +123869,49 @@
123704
123869
  },
123705
123870
  "parameters": [
123706
123871
  {
123707
- "name": "name",
123872
+ "name": "element",
123708
123873
  "type": {
123709
- "text": "PropertyKey | undefined"
123874
+ "text": "HTMLElement"
123710
123875
  }
123711
123876
  }
123712
- ],
123713
- "description": "Whether validation should be run on a property change with the given name.",
123714
- "inheritedFrom": {
123715
- "name": "SbbFormAssociatedMixin",
123716
- "module": "core/mixins/form-associated-mixin.js"
123717
- }
123877
+ ]
123718
123878
  },
123719
123879
  {
123720
123880
  "kind": "method",
123721
- "name": "_setInternalValidity",
123881
+ "name": "_isGoPreviousElement",
123722
123882
  "privacy": "private",
123723
123883
  "return": {
123724
123884
  "type": {
123725
- "text": "void"
123885
+ "text": "boolean"
123726
123886
  }
123727
123887
  },
123728
- "inheritedFrom": {
123729
- "name": "SbbFormAssociatedMixin",
123730
- "module": "core/mixins/form-associated-mixin.js"
123731
- }
123732
- },
123733
- {
123734
- "kind": "field",
123735
- "name": "_preventScrollOnSpaceKeydown",
123736
- "privacy": "private",
123737
- "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
123738
- "parameters": [
123739
- {
123740
- "description": "The origin event.",
123741
- "name": "event"
123742
- }
123743
- ],
123744
- "inheritedFrom": {
123745
- "name": "SbbButtonLikeBaseElement",
123746
- "module": "core/base-elements/button-base-element.js"
123747
- }
123748
- },
123749
- {
123750
- "kind": "field",
123751
- "name": "_removeActiveMarker",
123752
- "privacy": "private",
123753
- "inheritedFrom": {
123754
- "name": "SbbButtonLikeBaseElement",
123755
- "module": "core/base-elements/button-base-element.js"
123756
- }
123757
- },
123758
- {
123759
- "kind": "field",
123760
- "name": "_dispatchClickEventOnSpaceKeyup",
123761
- "privacy": "private",
123762
- "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.",
123763
123888
  "parameters": [
123764
123889
  {
123765
- "description": "The origin event.",
123766
- "name": "event"
123890
+ "name": "element",
123891
+ "type": {
123892
+ "text": "HTMLElement"
123893
+ }
123767
123894
  }
123768
- ],
123769
- "inheritedFrom": {
123770
- "name": "SbbButtonLikeBaseElement",
123771
- "module": "core/base-elements/button-base-element.js"
123772
- }
123773
- },
123774
- {
123775
- "kind": "field",
123776
- "name": "_dispatchClickEvent",
123777
- "privacy": "private",
123778
- "inheritedFrom": {
123779
- "name": "SbbButtonLikeBaseElement",
123780
- "module": "core/base-elements/button-base-element.js"
123781
- }
123782
- },
123783
- {
123784
- "kind": "field",
123785
- "name": "maybeDisabled",
123786
- "type": {
123787
- "text": "boolean | undefined"
123788
- },
123789
- "privacy": "protected",
123790
- "readonly": true,
123791
- "inheritedFrom": {
123792
- "name": "SbbActionBaseElement",
123793
- "module": "core/base-elements/action-base-element.js"
123794
- }
123795
- },
123796
- {
123797
- "kind": "field",
123798
- "name": "maybeDisabledInteractive",
123799
- "type": {
123800
- "text": "boolean | undefined"
123801
- },
123802
- "privacy": "protected",
123803
- "readonly": true,
123804
- "inheritedFrom": {
123805
- "name": "SbbActionBaseElement",
123806
- "module": "core/base-elements/action-base-element.js"
123807
- }
123895
+ ]
123808
123896
  },
123809
123897
  {
123810
123898
  "kind": "method",
123811
- "name": "setupBaseEventHandlers",
123812
- "privacy": "protected",
123899
+ "name": "_onStepElementResize",
123900
+ "privacy": "private",
123813
123901
  "return": {
123814
123902
  "type": {
123815
123903
  "text": "void"
123816
123904
  }
123817
- },
123818
- "inheritedFrom": {
123819
- "name": "SbbActionBaseElement",
123820
- "module": "core/base-elements/action-base-element.js"
123821
123905
  }
123822
123906
  },
123823
123907
  {
123824
123908
  "kind": "method",
123825
- "name": "renderTemplate",
123826
- "privacy": "protected",
123909
+ "name": "_assignLabel",
123910
+ "privacy": "private",
123827
123911
  "return": {
123828
123912
  "type": {
123829
- "text": "TemplateResult"
123913
+ "text": "void"
123830
123914
  }
123831
- },
123832
- "description": "Override this method to render the component template.",
123833
- "inheritedFrom": {
123834
- "name": "SbbActionBaseElement",
123835
- "module": "core/base-elements/action-base-element.js"
123836
123915
  }
123837
123916
  },
123838
123917
  {
@@ -123941,109 +124020,30 @@
123941
124020
  }
123942
124021
  }
123943
124022
  ],
123944
- "mixins": [
123945
- {
123946
- "name": "SbbIconNameMixin",
123947
- "module": "icon.js"
123948
- },
124023
+ "events": [
123949
124024
  {
123950
- "name": "SbbDisabledMixin",
123951
- "module": "core/mixins.js"
124025
+ "name": "validate",
124026
+ "type": {
124027
+ "text": "CustomEvent<SbbStepValidateEventDetails>"
124028
+ },
124029
+ "description": "The validate event is dispatched when a step change is triggered. Can be canceled to abort the step change."
123952
124030
  }
123953
124031
  ],
123954
124032
  "superclass": {
123955
- "name": "SbbButtonBaseElement",
124033
+ "name": "SbbElement",
123956
124034
  "module": "core/base-elements.js"
123957
124035
  },
123958
- "tagName": "sbb-step-label",
123959
- "customElement": true,
123960
- "attributes": [
123961
- {
123962
- "name": "icon-name",
123963
- "type": {
123964
- "text": "string"
123965
- },
123966
- "default": "''",
123967
- "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.",
123968
- "fieldName": "iconName",
123969
- "inheritedFrom": {
123970
- "name": "SbbIconNameMixin",
123971
- "module": "icon/icon-name-mixin.js"
123972
- }
123973
- },
123974
- {
123975
- "name": "disabled",
123976
- "description": "Whether the component is disabled.",
123977
- "default": "false",
123978
- "type": {
123979
- "text": "boolean"
123980
- },
123981
- "fieldName": "disabled",
123982
- "inheritedFrom": {
123983
- "name": "SbbDisabledMixin",
123984
- "module": "core/mixins/disabled-mixin.js"
123985
- }
123986
- },
123987
- {
123988
- "name": "value",
123989
- "type": {
123990
- "text": "string"
123991
- },
123992
- "default": "''",
123993
- "description": "Value of the form element.",
123994
- "fieldName": "value",
123995
- "inheritedFrom": {
123996
- "name": "SbbButtonBaseElement",
123997
- "module": "core/base-elements/button-base-element.js"
123998
- }
123999
- },
124000
- {
124001
- "name": "type",
124002
- "description": "The type attribute to use for the button.",
124003
- "default": "'button'",
124004
- "type": {
124005
- "text": "SbbButtonType"
124006
- },
124007
- "fieldName": "type",
124008
- "inheritedFrom": {
124009
- "name": "SbbButtonBaseElement",
124010
- "module": "core/base-elements/button-base-element.js"
124011
- }
124012
- },
124013
- {
124014
- "name": "form",
124015
- "description": "The `<form>` element to associate the button with.",
124016
- "type": {
124017
- "text": "HTMLFormElement | null"
124018
- },
124019
- "fieldName": "form",
124020
- "inheritedFrom": {
124021
- "name": "SbbButtonBaseElement",
124022
- "module": "core/base-elements/button-base-element.js"
124023
- }
124024
- },
124025
- {
124026
- "name": "name",
124027
- "description": "Name of the form element. Will be read from name attribute.",
124028
- "type": {
124029
- "text": "string"
124030
- },
124031
- "fieldName": "name",
124032
- "inheritedFrom": {
124033
- "name": "SbbFormAssociatedMixin",
124034
- "module": "core/mixins/form-associated-mixin.js"
124035
- }
124036
- }
124037
- ]
124036
+ "tagName": "sbb-step",
124037
+ "customElement": true
124038
124038
  }
124039
124039
  ],
124040
124040
  "exports": [
124041
124041
  {
124042
124042
  "kind": "js",
124043
- "name": "SbbStepLabelElement",
124043
+ "name": "SbbStepElement",
124044
124044
  "declaration": {
124045
- "name": "SbbStepLabelElement",
124046
- "module": "stepper/step-label/step-label.component.js"
124045
+ "name": "SbbStepElement",
124046
+ "module": "stepper/step/step.component.js"
124047
124047
  }
124048
124048
  }
124049
124049
  ]