@sbb-esta/lyne-elements-dev 4.9.0-dev.1775125441 → 4.9.0-dev.1775130554

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.
@@ -122873,20 +122873,79 @@
122873
122873
  },
122874
122874
  {
122875
122875
  "kind": "javascript-module",
122876
- "path": "stepper/step-label/step-label.component.js",
122876
+ "path": "stepper/stepper/stepper.component.js",
122877
122877
  "declarations": [
122878
122878
  {
122879
122879
  "kind": "class",
122880
- "description": "Combined with a `sbb-stepper`, it displays a step's label.",
122881
- "name": "SbbStepLabelElement",
122880
+ "description": "",
122881
+ "name": "SbbStepChangeEvent",
122882
+ "members": [
122883
+ {
122884
+ "kind": "field",
122885
+ "name": "selectedIndex",
122886
+ "type": {
122887
+ "text": "number | null"
122888
+ },
122889
+ "privacy": "public",
122890
+ "readonly": true,
122891
+ "description": "The index of the newly selected step.",
122892
+ "default": "selectedIndex"
122893
+ },
122894
+ {
122895
+ "kind": "field",
122896
+ "name": "previousIndex",
122897
+ "type": {
122898
+ "text": "number | null"
122899
+ },
122900
+ "privacy": "public",
122901
+ "readonly": true,
122902
+ "description": "The index of the previously selected step.",
122903
+ "default": "previousIndex"
122904
+ },
122905
+ {
122906
+ "kind": "field",
122907
+ "name": "selectedStep",
122908
+ "type": {
122909
+ "text": "SbbStepElement | null"
122910
+ },
122911
+ "privacy": "public",
122912
+ "readonly": true,
122913
+ "description": "The newly selected step element.",
122914
+ "default": "selectedStep"
122915
+ },
122916
+ {
122917
+ "kind": "field",
122918
+ "name": "previousStep",
122919
+ "type": {
122920
+ "text": "SbbStepElement | null"
122921
+ },
122922
+ "privacy": "public",
122923
+ "readonly": true,
122924
+ "description": "The previously selected step element.",
122925
+ "default": "previousStep"
122926
+ }
122927
+ ],
122928
+ "superclass": {
122929
+ "name": "Event",
122930
+ "module": "stepper/stepper/stepper.component.js"
122931
+ }
122932
+ },
122933
+ {
122934
+ "kind": "class",
122935
+ "description": "Provides a structured, step-by-step workflow for user interactions.",
122936
+ "name": "SbbStepperElement",
122882
122937
  "slots": [
122883
122938
  {
122884
- "description": "Use the unnamed slot to provide a label.",
122939
+ "description": "Provide a `sbb-expansion-panel-header` and a `sbb-expansion-panel-content` to the stepper.",
122885
122940
  "name": ""
122886
122941
  },
122887
122942
  {
122888
- "description": "Use this to display an icon in the label bubble.",
122889
- "name": "icon"
122943
+ "description": "Use this slot to provide an `sbb-step-label`.",
122944
+ "name": "step-label"
122945
+ },
122946
+ {
122947
+ "description": "Use this slot to provide an `sbb-step`.",
122948
+ "name": "step"
122890
122949
  }
122891
122950
  ],
122892
122951
  "members": [
@@ -122899,41 +122958,98 @@
122899
122958
  "privacy": "public",
122900
122959
  "static": true,
122901
122960
  "readonly": true,
122961
+ "default": "'sbb-stepper'",
122902
122962
  "inheritedFrom": {
122903
122963
  "name": "SbbElement",
122904
122964
  "module": "core/base-elements/element.js"
122905
- },
122906
- "default": "'sbb-step-label'"
122965
+ }
122907
122966
  },
122908
122967
  {
122909
122968
  "kind": "field",
122910
- "name": "role",
122911
- "type": {
122912
- "text": "string"
122913
- },
122969
+ "name": "events",
122914
122970
  "privacy": "public",
122915
122971
  "static": true,
122916
122972
  "readonly": true,
122917
- "default": "'tab'",
122918
- "inheritedFrom": {
122919
- "name": "SbbButtonLikeBaseElement",
122920
- "module": "core/base-elements/button-base-element.js"
122973
+ "default": "{ stepchange: 'stepchange', }",
122974
+ "type": {
122975
+ "text": "{\n stepchange: 'stepchange',\n }"
122921
122976
  }
122922
122977
  },
122923
122978
  {
122924
122979
  "kind": "field",
122925
- "name": "step",
122980
+ "name": "_observer",
122981
+ "privacy": "private",
122982
+ "default": "new IntersectionController(this, { target: null, callback: (entries) => { entries.forEach((e) => { if (e.intersectionRatio > 0) { this._setStepperHeight(this.selected); this._setMarkerSize(); } }); }, })",
122983
+ "description": "If the sbb-stepper is used in a sbb-dialog, the marker on the selected element will not appear,\nbecause the calculations are done when the dialog is closed, so the marker has a width of 0;\nthe same happens for the stepper height.\nWe need to recalculate it when the element becomes visible."
122984
+ },
122985
+ {
122986
+ "kind": "field",
122987
+ "name": "linear",
122926
122988
  "type": {
122927
- "text": "SbbStepElement | null"
122989
+ "text": "boolean"
122928
122990
  },
122929
122991
  "privacy": "public",
122930
- "description": "The step controlled by the label.",
122931
- "readonly": true,
122992
+ "default": "false",
122993
+ "description": "If set to true, only the current and previous labels can be clicked and selected.",
122994
+ "attribute": "linear"
122995
+ },
122996
+ {
122997
+ "kind": "field",
122998
+ "name": "horizontalFrom",
122999
+ "privacy": "public",
123000
+ "description": "Overrides the behavior of `orientation` property.",
123001
+ "type": {
123002
+ "text": "SbbHorizontalFrom | null"
123003
+ },
123004
+ "attribute": "horizontal-from",
123005
+ "reflects": true,
122932
123006
  "default": "null"
122933
123007
  },
122934
123008
  {
122935
123009
  "kind": "field",
122936
- "name": "_step",
123010
+ "name": "_horizontalFrom",
123011
+ "type": {
123012
+ "text": "SbbHorizontalFrom | null"
123013
+ },
123014
+ "privacy": "private",
123015
+ "default": "null"
123016
+ },
123017
+ {
123018
+ "kind": "field",
123019
+ "name": "orientation",
123020
+ "type": {
123021
+ "text": "SbbOrientation"
123022
+ },
123023
+ "privacy": "public",
123024
+ "default": "'horizontal'",
123025
+ "description": "Steps orientation, either horizontal or vertical.",
123026
+ "attribute": "orientation",
123027
+ "reflects": true
123028
+ },
123029
+ {
123030
+ "kind": "field",
123031
+ "name": "size",
123032
+ "type": {
123033
+ "text": "'s' | 'm'"
123034
+ },
123035
+ "privacy": "public",
123036
+ "description": "Size variant, either s or m.",
123037
+ "default": "'m' / 's' (lean)",
123038
+ "attribute": "size",
123039
+ "reflects": true
123040
+ },
123041
+ {
123042
+ "kind": "field",
123043
+ "name": "selected",
123044
+ "privacy": "public",
123045
+ "description": "The currently selected step.",
123046
+ "type": {
123047
+ "text": "SbbStepElement | null"
123048
+ }
123049
+ },
123050
+ {
123051
+ "kind": "field",
123052
+ "name": "_requestedSelected",
122937
123053
  "type": {
122938
123054
  "text": "SbbStepElement | null"
122939
123055
  },
@@ -122942,250 +123058,240 @@
122942
123058
  },
122943
123059
  {
122944
123060
  "kind": "field",
122945
- "name": "stepper",
123061
+ "name": "selectedIndex",
123062
+ "privacy": "public",
123063
+ "description": "The currently selected step index.",
122946
123064
  "type": {
122947
- "text": "SbbStepperElement | null"
123065
+ "text": "number | null"
123066
+ },
123067
+ "attribute": "selected-index"
123068
+ },
123069
+ {
123070
+ "kind": "field",
123071
+ "name": "_requestedSelectedIndex",
123072
+ "type": {
123073
+ "text": "number | null"
123074
+ },
123075
+ "privacy": "private",
123076
+ "default": "null"
123077
+ },
123078
+ {
123079
+ "kind": "field",
123080
+ "name": "steps",
123081
+ "type": {
123082
+ "text": "SbbStepElement[]"
122948
123083
  },
122949
123084
  "privacy": "public",
123085
+ "description": "The steps of the stepper.",
122950
123086
  "readonly": true
122951
123087
  },
122952
123088
  {
122953
123089
  "kind": "field",
122954
- "name": "disabled",
122955
- "privacy": "public",
122956
- "description": "Whether the component is disabled.",
122957
- "default": "false",
123090
+ "name": "_enabledSteps",
122958
123091
  "type": {
122959
- "text": "boolean"
123092
+ "text": "SbbStepElement[]"
122960
123093
  },
122961
- "attribute": "disabled",
122962
- "reflects": true,
122963
- "inheritedFrom": {
122964
- "name": "SbbDisabledMixin",
122965
- "module": "core/mixins/disabled-mixin.js"
122966
- }
123094
+ "privacy": "private",
123095
+ "readonly": true
122967
123096
  },
122968
123097
  {
122969
123098
  "kind": "field",
122970
- "name": "_previousOrientation",
123099
+ "name": "_loaded",
122971
123100
  "type": {
122972
- "text": "string | undefined"
123101
+ "text": "boolean"
122973
123102
  },
122974
- "privacy": "private"
123103
+ "privacy": "private",
123104
+ "default": "false"
122975
123105
  },
122976
123106
  {
122977
123107
  "kind": "field",
122978
- "name": "_previousSize",
123108
+ "name": "_resizeObserverTimeout",
122979
123109
  "type": {
122980
- "text": "string | undefined"
123110
+ "text": "ReturnType<typeof setTimeout> | null"
122981
123111
  },
122982
- "privacy": "private"
123112
+ "privacy": "private",
123113
+ "default": "null"
122983
123114
  },
122984
123115
  {
122985
- "kind": "method",
122986
- "name": "_isNotDeactivatedByLinearMode",
123116
+ "kind": "field",
123117
+ "name": "_mediaMatcher",
122987
123118
  "privacy": "private",
123119
+ "default": "new SbbMediaMatcherController(this, {})"
123120
+ },
123121
+ {
123122
+ "kind": "method",
123123
+ "name": "next",
123124
+ "privacy": "public",
122988
123125
  "return": {
122989
123126
  "type": {
122990
- "text": "boolean"
123127
+ "text": "void"
122991
123128
  }
122992
123129
  },
122993
- "parameters": [
122994
- {
122995
- "name": "step",
122996
- "type": {
122997
- "text": "SbbStepElement"
122998
- }
122999
- }
123000
- ]
123130
+ "description": "Selects the next step."
123001
123131
  },
123002
123132
  {
123003
123133
  "kind": "method",
123004
- "name": "_assignStep",
123005
- "privacy": "private",
123134
+ "name": "previous",
123135
+ "privacy": "public",
123006
123136
  "return": {
123007
123137
  "type": {
123008
123138
  "text": "void"
123009
123139
  }
123010
- }
123011
- },
123012
- {
123013
- "kind": "field",
123014
- "name": "iconName",
123015
- "type": {
123016
- "text": "string"
123017
123140
  },
123018
- "privacy": "public",
123019
- "default": "''",
123020
- "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.",
123021
- "attribute": "icon-name",
123022
- "inheritedFrom": {
123023
- "name": "SbbIconNameMixin",
123024
- "module": "icon/icon-name-mixin.js"
123025
- }
123141
+ "description": "Selects the previous step."
123026
123142
  },
123027
123143
  {
123028
123144
  "kind": "method",
123029
- "name": "renderIconSlot",
123030
- "privacy": "protected",
123145
+ "name": "reset",
123146
+ "privacy": "public",
123031
123147
  "return": {
123032
123148
  "type": {
123033
- "text": "TemplateResult"
123149
+ "text": "void"
123150
+ }
123151
+ },
123152
+ "description": "Resets the form in which the stepper is nested or every form of each step, if any."
123153
+ },
123154
+ {
123155
+ "kind": "method",
123156
+ "name": "_isSelectable",
123157
+ "privacy": "private",
123158
+ "return": {
123159
+ "type": {
123160
+ "text": "step is SbbStepElement"
123034
123161
  }
123035
123162
  },
123036
123163
  "parameters": [
123037
123164
  {
123038
- "name": "classname",
123039
- "optional": true,
123165
+ "name": "step",
123040
123166
  "type": {
123041
- "text": "string"
123167
+ "text": "SbbStepElement | null"
123042
123168
  }
123043
123169
  }
123044
- ],
123045
- "inheritedFrom": {
123046
- "name": "SbbIconNameMixin",
123047
- "module": "icon/icon-name-mixin.js"
123048
- }
123170
+ ]
123049
123171
  },
123050
123172
  {
123051
123173
  "kind": "method",
123052
- "name": "renderIconName",
123053
- "privacy": "protected",
123174
+ "name": "_select",
123175
+ "privacy": "private",
123054
123176
  "return": {
123055
123177
  "type": {
123056
- "text": "string"
123178
+ "text": "void"
123057
123179
  }
123058
123180
  },
123059
- "inheritedFrom": {
123060
- "name": "SbbIconNameMixin",
123061
- "module": "icon/icon-name-mixin.js"
123062
- }
123181
+ "parameters": [
123182
+ {
123183
+ "name": "step",
123184
+ "type": {
123185
+ "text": "SbbStepElement | null"
123186
+ }
123187
+ }
123188
+ ]
123063
123189
  },
123064
123190
  {
123065
123191
  "kind": "method",
123066
- "name": "_renderIconName",
123192
+ "name": "_setMarkerSize",
123067
123193
  "privacy": "private",
123068
123194
  "return": {
123069
123195
  "type": {
123070
- "text": "string"
123196
+ "text": "void"
123071
123197
  }
123072
- },
123073
- "inheritedFrom": {
123074
- "name": "SbbIconNameMixin",
123075
- "module": "icon/icon-name-mixin.js"
123076
123198
  }
123077
123199
  },
123078
123200
  {
123079
- "kind": "field",
123080
- "name": "#disabled",
123201
+ "kind": "method",
123202
+ "name": "_setStepperHeight",
123081
123203
  "privacy": "private",
123082
- "type": {
123083
- "text": "boolean"
123204
+ "return": {
123205
+ "type": {
123206
+ "text": "void"
123207
+ }
123084
123208
  },
123085
- "default": "false",
123086
- "inheritedFrom": {
123087
- "name": "SbbDisabledMixin",
123088
- "module": "core/mixins/disabled-mixin.js"
123089
- }
123209
+ "parameters": [
123210
+ {
123211
+ "name": "step",
123212
+ "type": {
123213
+ "text": "SbbStepElement | null"
123214
+ }
123215
+ }
123216
+ ],
123217
+ "description": "Sets the stepper height based on the height of the provided step."
123090
123218
  },
123091
123219
  {
123092
123220
  "kind": "method",
123093
- "name": "isDisabledExternally",
123094
- "privacy": "protected",
123221
+ "name": "_calculateLabelOffsetTop",
123222
+ "privacy": "private",
123095
123223
  "return": {
123096
123224
  "type": {
123097
- "text": "boolean"
123225
+ "text": "number | undefined"
123098
123226
  }
123099
- },
123100
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
123101
- "inheritedFrom": {
123102
- "name": "SbbDisabledMixin",
123103
- "module": "core/mixins/disabled-mixin.js"
123104
123227
  }
123105
123228
  },
123106
123229
  {
123107
- "kind": "field",
123108
- "name": "_elementsOnWhichEnterPressTriggersSubmit",
123109
- "type": {
123110
- "text": "array"
123111
- },
123230
+ "kind": "method",
123231
+ "name": "_onSelectedStepResize",
123112
123232
  "privacy": "private",
123113
- "readonly": true,
123114
- "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
123115
- "inheritedFrom": {
123116
- "name": "SbbButtonBaseElement",
123117
- "module": "core/base-elements/button-base-element.js"
123118
- }
123119
- },
123120
- {
123121
- "kind": "field",
123122
- "name": "value",
123123
- "type": {
123124
- "text": "string"
123125
- },
123126
- "privacy": "public",
123127
- "inheritedFrom": {
123128
- "name": "SbbButtonBaseElement",
123129
- "module": "core/base-elements/button-base-element.js"
123233
+ "return": {
123234
+ "type": {
123235
+ "text": "void"
123236
+ }
123130
123237
  },
123131
- "default": "''",
123132
- "description": "Value of the form element.",
123133
- "attribute": "value"
123238
+ "parameters": [
123239
+ {
123240
+ "name": "e",
123241
+ "type": {
123242
+ "text": "Event"
123243
+ }
123244
+ }
123245
+ ]
123134
123246
  },
123135
123247
  {
123136
- "kind": "field",
123137
- "name": "type",
123138
- "privacy": "public",
123139
- "description": "The type attribute to use for the button.",
123140
- "default": "'button'",
123141
- "type": {
123142
- "text": "SbbButtonType"
123143
- },
123144
- "attribute": "type",
123145
- "inheritedFrom": {
123146
- "name": "SbbButtonBaseElement",
123147
- "module": "core/base-elements/button-base-element.js"
123248
+ "kind": "method",
123249
+ "name": "_configure",
123250
+ "privacy": "private",
123251
+ "return": {
123252
+ "type": {
123253
+ "text": "void"
123254
+ }
123148
123255
  }
123149
123256
  },
123150
123257
  {
123151
- "kind": "field",
123152
- "name": "form",
123153
- "type": {
123154
- "text": "HTMLFormElement | null"
123155
- },
123156
- "privacy": "public",
123157
- "description": "The `<form>` element to associate the button with.",
123158
- "inheritedFrom": {
123159
- "name": "SbbButtonBaseElement",
123160
- "module": "core/base-elements/button-base-element.js"
123161
- },
123162
- "attribute": "form"
123258
+ "kind": "method",
123259
+ "name": "_updateLabels",
123260
+ "privacy": "private",
123261
+ "return": {
123262
+ "type": {
123263
+ "text": "void"
123264
+ }
123265
+ }
123163
123266
  },
123164
123267
  {
123165
- "kind": "field",
123166
- "name": "_formId",
123167
- "type": {
123168
- "text": "string"
123169
- },
123268
+ "kind": "method",
123269
+ "name": "_checkOrientation",
123170
123270
  "privacy": "private",
123171
- "default": "''",
123172
- "inheritedFrom": {
123173
- "name": "SbbButtonBaseElement",
123174
- "module": "core/base-elements/button-base-element.js"
123271
+ "return": {
123272
+ "type": {
123273
+ "text": "void"
123274
+ }
123175
123275
  }
123176
123276
  },
123177
123277
  {
123178
123278
  "kind": "field",
123179
- "name": "_handleButtonClick",
123279
+ "name": "_onStepperResize",
123280
+ "privacy": "private"
123281
+ },
123282
+ {
123283
+ "kind": "method",
123284
+ "name": "_configureLinearMode",
123180
123285
  "privacy": "private",
123181
- "inheritedFrom": {
123182
- "name": "SbbButtonBaseElement",
123183
- "module": "core/base-elements/button-base-element.js"
123286
+ "return": {
123287
+ "type": {
123288
+ "text": "void"
123289
+ }
123184
123290
  }
123185
123291
  },
123186
123292
  {
123187
123293
  "kind": "method",
123188
- "name": "_requestSubmit",
123294
+ "name": "_handleKeyDown",
123189
123295
  "privacy": "private",
123190
123296
  "return": {
123191
123297
  "type": {
@@ -123194,154 +123300,67 @@
123194
123300
  },
123195
123301
  "parameters": [
123196
123302
  {
123197
- "name": "form",
123303
+ "name": "evt",
123198
123304
  "type": {
123199
- "text": "HTMLFormElement"
123305
+ "text": "KeyboardEvent"
123200
123306
  }
123201
123307
  }
123202
- ],
123203
- "inheritedFrom": {
123204
- "name": "SbbButtonBaseElement",
123205
- "module": "core/base-elements/button-base-element.js"
123206
- }
123308
+ ]
123207
123309
  },
123208
123310
  {
123209
123311
  "kind": "field",
123210
- "name": "_formKeyDown",
123312
+ "name": "_hydrationRequired",
123313
+ "type": {
123314
+ "text": "boolean"
123315
+ },
123211
123316
  "privacy": "private",
123317
+ "default": "!!this.shadowRoot",
123212
123318
  "inheritedFrom": {
123213
- "name": "SbbButtonBaseElement",
123214
- "module": "core/base-elements/button-base-element.js"
123319
+ "name": "SbbElement",
123320
+ "module": "core/base-elements/element.js"
123215
123321
  }
123216
123322
  },
123217
123323
  {
123218
123324
  "kind": "field",
123219
- "name": "formAssociated",
123220
- "type": {
123221
- "text": "boolean"
123222
- },
123223
- "privacy": "public",
123224
- "static": true,
123225
- "default": "true",
123325
+ "name": "_hydrationComplete",
123326
+ "privacy": "private",
123327
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
123226
123328
  "inheritedFrom": {
123227
- "name": "SbbFormAssociatedMixin",
123228
- "module": "core/mixins/form-associated-mixin.js"
123329
+ "name": "SbbElement",
123330
+ "module": "core/base-elements/element.js"
123229
123331
  }
123230
123332
  },
123231
123333
  {
123232
123334
  "kind": "field",
123233
- "name": "name",
123234
- "privacy": "public",
123235
- "description": "Name of the form element. Will be read from name attribute.",
123335
+ "name": "_resolveHydration",
123236
123336
  "type": {
123237
- "text": "string"
123337
+ "text": "(hydrationRequired: boolean) => void"
123238
123338
  },
123239
- "attribute": "name",
123339
+ "privacy": "private",
123240
123340
  "inheritedFrom": {
123241
- "name": "SbbFormAssociatedMixin",
123242
- "module": "core/mixins/form-associated-mixin.js"
123341
+ "name": "SbbElement",
123342
+ "module": "core/base-elements/element.js"
123243
123343
  }
123244
123344
  },
123245
123345
  {
123246
123346
  "kind": "field",
123247
- "name": "validity",
123347
+ "name": "hydrationRequired",
123248
123348
  "type": {
123249
- "text": "ValidityState"
123349
+ "text": "boolean"
123250
123350
  },
123251
- "privacy": "public",
123252
- "description": "Returns the ValidityState object for this element.",
123351
+ "privacy": "protected",
123352
+ "description": "Returns whether hydration is required and not completed.",
123253
123353
  "readonly": true,
123254
123354
  "inheritedFrom": {
123255
- "name": "SbbFormAssociatedMixin",
123256
- "module": "core/mixins/form-associated-mixin.js"
123257
- }
123258
- },
123259
- {
123260
- "kind": "field",
123261
- "name": "validationMessage",
123262
- "type": {
123263
- "text": "string"
123264
- },
123265
- "privacy": "public",
123266
- "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.",
123267
- "readonly": true,
123268
- "inheritedFrom": {
123269
- "name": "SbbFormAssociatedMixin",
123270
- "module": "core/mixins/form-associated-mixin.js"
123271
- }
123272
- },
123273
- {
123274
- "kind": "field",
123275
- "name": "willValidate",
123276
- "type": {
123277
- "text": "boolean"
123278
- },
123279
- "privacy": "public",
123280
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
123281
- "readonly": true,
123282
- "inheritedFrom": {
123283
- "name": "SbbFormAssociatedMixin",
123284
- "module": "core/mixins/form-associated-mixin.js"
123285
- }
123286
- },
123287
- {
123288
- "kind": "field",
123289
- "name": "_validityStates",
123290
- "privacy": "private",
123291
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
123292
- "inheritedFrom": {
123293
- "name": "SbbFormAssociatedMixin",
123294
- "module": "core/mixins/form-associated-mixin.js"
123295
- }
123296
- },
123297
- {
123298
- "kind": "field",
123299
- "name": "formDisabled",
123300
- "type": {
123301
- "text": "boolean"
123302
- },
123303
- "privacy": "protected",
123304
- "default": "false",
123305
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
123306
- "inheritedFrom": {
123307
- "name": "SbbFormAssociatedMixin",
123308
- "module": "core/mixins/form-associated-mixin.js"
123309
- }
123355
+ "name": "SbbElement",
123356
+ "module": "core/base-elements/element.js"
123357
+ },
123358
+ "default": "!!this.shadowRoot"
123310
123359
  },
123311
123360
  {
123312
123361
  "kind": "method",
123313
- "name": "checkValidity",
123314
- "privacy": "public",
123315
- "return": {
123316
- "type": {
123317
- "text": "boolean"
123318
- }
123319
- },
123320
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
123321
- "inheritedFrom": {
123322
- "name": "SbbFormAssociatedMixin",
123323
- "module": "core/mixins/form-associated-mixin.js"
123324
- }
123325
- },
123326
- {
123327
- "kind": "method",
123328
- "name": "reportValidity",
123329
- "privacy": "public",
123330
- "return": {
123331
- "type": {
123332
- "text": "boolean"
123333
- }
123334
- },
123335
- "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.",
123336
- "inheritedFrom": {
123337
- "name": "SbbFormAssociatedMixin",
123338
- "module": "core/mixins/form-associated-mixin.js"
123339
- }
123340
- },
123341
- {
123342
- "kind": "method",
123343
- "name": "setCustomValidity",
123344
- "privacy": "public",
123362
+ "name": "toggleState",
123363
+ "privacy": "protected",
123345
123364
  "return": {
123346
123365
  "type": {
123347
123366
  "text": "void"
@@ -123349,792 +123368,713 @@
123349
123368
  },
123350
123369
  "parameters": [
123351
123370
  {
123352
- "name": "message",
123371
+ "name": "value",
123353
123372
  "type": {
123354
123373
  "text": "string"
123355
123374
  }
123375
+ },
123376
+ {
123377
+ "name": "force",
123378
+ "optional": true,
123379
+ "type": {
123380
+ "text": "boolean"
123381
+ }
123356
123382
  }
123357
123383
  ],
123358
- "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.",
123359
123384
  "inheritedFrom": {
123360
- "name": "SbbFormAssociatedMixin",
123361
- "module": "core/mixins/form-associated-mixin.js"
123385
+ "name": "SbbElement",
123386
+ "module": "core/base-elements/element.js"
123362
123387
  }
123363
123388
  },
123364
123389
  {
123365
- "kind": "method",
123366
- "name": "_hasDisabledAncestor",
123367
- "privacy": "private",
123368
- "return": {
123369
- "type": {
123370
- "text": "boolean"
123371
- }
123390
+ "kind": "field",
123391
+ "name": "['_$sbbElement$']",
123392
+ "type": {
123393
+ "text": "boolean"
123372
123394
  },
123395
+ "privacy": "public",
123396
+ "static": true,
123397
+ "default": "true",
123373
123398
  "inheritedFrom": {
123374
- "name": "SbbFormAssociatedMixin",
123375
- "module": "core/mixins/form-associated-mixin.js"
123399
+ "name": "SbbElement",
123400
+ "module": "core/base-elements/element.js"
123376
123401
  }
123377
123402
  },
123378
123403
  {
123379
- "kind": "method",
123380
- "name": "updateFormValue",
123381
- "privacy": "protected",
123382
- "return": {
123383
- "type": {
123384
- "text": "void"
123385
- }
123404
+ "kind": "field",
123405
+ "name": "_controllers",
123406
+ "type": {
123407
+ "text": "Set<SbbReactiveController> | undefined"
123386
123408
  },
123387
- "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",
123409
+ "privacy": "private",
123388
123410
  "inheritedFrom": {
123389
- "name": "SbbFormAssociatedMixin",
123390
- "module": "core/mixins/form-associated-mixin.js"
123411
+ "name": "SbbElement",
123412
+ "module": "core/base-elements/element.js"
123391
123413
  }
123392
- },
123414
+ }
123415
+ ],
123416
+ "events": [
123393
123417
  {
123394
- "kind": "method",
123395
- "name": "formState",
123396
- "privacy": "protected",
123397
- "return": {
123398
- "type": {
123399
- "text": "FormRestoreState"
123400
- }
123418
+ "type": {
123419
+ "text": "SbbStepChangeEvent"
123401
123420
  },
123402
- "inheritedFrom": {
123403
- "name": "SbbFormAssociatedMixin",
123404
- "module": "core/mixins/form-associated-mixin.js"
123405
- }
123406
- },
123421
+ "description": "Emits whenever a step was changed.",
123422
+ "name": "stepchange"
123423
+ }
123424
+ ],
123425
+ "attributes": [
123407
123426
  {
123408
- "kind": "method",
123409
- "name": "setValidityFlag",
123410
- "privacy": "protected",
123411
- "return": {
123412
- "type": {
123413
- "text": "void"
123414
- }
123427
+ "name": "linear",
123428
+ "type": {
123429
+ "text": "boolean"
123415
123430
  },
123416
- "parameters": [
123417
- {
123418
- "name": "flag",
123419
- "type": {
123420
- "text": "T"
123421
- }
123422
- },
123423
- {
123424
- "name": "message",
123425
- "type": {
123426
- "text": "string"
123427
- }
123428
- },
123429
- {
123430
- "name": "flagValue",
123431
- "optional": true,
123432
- "type": {
123433
- "text": "ValidityStateFlags[T]"
123434
- }
123435
- }
123436
- ],
123437
- "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).",
123438
- "inheritedFrom": {
123439
- "name": "SbbFormAssociatedMixin",
123440
- "module": "core/mixins/form-associated-mixin.js"
123441
- }
123431
+ "default": "false",
123432
+ "description": "If set to true, only the current and previous labels can be clicked and selected.",
123433
+ "fieldName": "linear"
123442
123434
  },
123443
123435
  {
123444
- "kind": "method",
123445
- "name": "removeValidityFlag",
123446
- "privacy": "protected",
123447
- "return": {
123448
- "type": {
123449
- "text": "void"
123450
- }
123436
+ "name": "horizontal-from",
123437
+ "description": "Overrides the behavior of `orientation` property.",
123438
+ "type": {
123439
+ "text": "SbbHorizontalFrom | null"
123451
123440
  },
123452
- "parameters": [
123453
- {
123454
- "name": "flag",
123455
- "type": {
123456
- "text": "T"
123457
- }
123458
- }
123459
- ],
123460
- "description": "Removes the validity state flag entry and updates validity state.",
123461
- "inheritedFrom": {
123462
- "name": "SbbFormAssociatedMixin",
123463
- "module": "core/mixins/form-associated-mixin.js"
123464
- }
123441
+ "fieldName": "horizontalFrom"
123465
123442
  },
123466
123443
  {
123467
- "kind": "method",
123468
- "name": "validate",
123469
- "privacy": "protected",
123470
- "return": {
123471
- "type": {
123472
- "text": "void"
123473
- }
123444
+ "name": "orientation",
123445
+ "type": {
123446
+ "text": "SbbOrientation"
123474
123447
  },
123475
- "description": "To be called whenever the current element needs to be validated.",
123476
- "inheritedFrom": {
123477
- "name": "SbbFormAssociatedMixin",
123478
- "module": "core/mixins/form-associated-mixin.js"
123479
- }
123448
+ "default": "'horizontal'",
123449
+ "description": "Steps orientation, either horizontal or vertical.",
123450
+ "fieldName": "orientation"
123480
123451
  },
123481
123452
  {
123482
- "kind": "method",
123483
- "name": "shouldValidate",
123484
- "privacy": "protected",
123485
- "return": {
123486
- "type": {
123487
- "text": "boolean"
123488
- }
123453
+ "name": "size",
123454
+ "type": {
123455
+ "text": "'s' | 'm'"
123489
123456
  },
123490
- "parameters": [
123491
- {
123492
- "name": "name",
123493
- "type": {
123494
- "text": "PropertyKey | undefined"
123495
- }
123496
- }
123497
- ],
123498
- "description": "Whether validation should be run on a property change with the given name.",
123499
- "inheritedFrom": {
123500
- "name": "SbbFormAssociatedMixin",
123501
- "module": "core/mixins/form-associated-mixin.js"
123502
- }
123457
+ "description": "Size variant, either s or m.",
123458
+ "default": "'m' / 's' (lean)",
123459
+ "fieldName": "size"
123503
123460
  },
123504
123461
  {
123505
- "kind": "method",
123506
- "name": "_setInternalValidity",
123507
- "privacy": "private",
123508
- "return": {
123509
- "type": {
123510
- "text": "void"
123511
- }
123462
+ "name": "selected-index",
123463
+ "description": "The currently selected step index.",
123464
+ "type": {
123465
+ "text": "number | null"
123512
123466
  },
123513
- "inheritedFrom": {
123514
- "name": "SbbFormAssociatedMixin",
123515
- "module": "core/mixins/form-associated-mixin.js"
123516
- }
123517
- },
123518
- {
123519
- "kind": "field",
123520
- "name": "_preventScrollOnSpaceKeydown",
123521
- "privacy": "private",
123522
- "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
123523
- "parameters": [
123524
- {
123525
- "description": "The origin event.",
123526
- "name": "event"
123527
- }
123528
- ],
123529
- "inheritedFrom": {
123530
- "name": "SbbButtonLikeBaseElement",
123531
- "module": "core/base-elements/button-base-element.js"
123532
- }
123533
- },
123467
+ "fieldName": "selectedIndex"
123468
+ }
123469
+ ],
123470
+ "superclass": {
123471
+ "name": "SbbElement",
123472
+ "module": "core/base-elements.js"
123473
+ },
123474
+ "tagName": "sbb-stepper",
123475
+ "customElement": true
123476
+ },
123477
+ {
123478
+ "kind": "variable",
123479
+ "name": "currentIndex"
123480
+ },
123481
+ {
123482
+ "kind": "variable",
123483
+ "name": "currentStep"
123484
+ }
123485
+ ],
123486
+ "exports": [
123487
+ {
123488
+ "kind": "js",
123489
+ "name": "SbbStepChangeEvent",
123490
+ "declaration": {
123491
+ "name": "SbbStepChangeEvent",
123492
+ "module": "stepper/stepper/stepper.component.js"
123493
+ }
123494
+ },
123495
+ {
123496
+ "kind": "js",
123497
+ "name": "SbbStepperElement",
123498
+ "declaration": {
123499
+ "name": "SbbStepperElement",
123500
+ "module": "stepper/stepper/stepper.component.js"
123501
+ }
123502
+ }
123503
+ ]
123504
+ },
123505
+ {
123506
+ "kind": "javascript-module",
123507
+ "path": "stepper/step-label/step-label.component.js",
123508
+ "declarations": [
123509
+ {
123510
+ "kind": "class",
123511
+ "description": "Combined with a `sbb-stepper`, it displays a step's label.",
123512
+ "name": "SbbStepLabelElement",
123513
+ "slots": [
123534
123514
  {
123535
- "kind": "field",
123536
- "name": "_removeActiveMarker",
123537
- "privacy": "private",
123538
- "inheritedFrom": {
123539
- "name": "SbbButtonLikeBaseElement",
123540
- "module": "core/base-elements/button-base-element.js"
123541
- }
123515
+ "description": "Use the unnamed slot to provide a label.",
123516
+ "name": ""
123542
123517
  },
123543
123518
  {
123544
- "kind": "field",
123545
- "name": "_dispatchClickEventOnSpaceKeyup",
123546
- "privacy": "private",
123547
- "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.",
123548
- "parameters": [
123549
- {
123550
- "description": "The origin event.",
123551
- "name": "event"
123552
- }
123553
- ],
123554
- "inheritedFrom": {
123555
- "name": "SbbButtonLikeBaseElement",
123556
- "module": "core/base-elements/button-base-element.js"
123557
- }
123558
- },
123519
+ "description": "Use this to display an icon in the label bubble.",
123520
+ "name": "icon"
123521
+ }
123522
+ ],
123523
+ "members": [
123559
123524
  {
123560
123525
  "kind": "field",
123561
- "name": "_dispatchClickEvent",
123562
- "privacy": "private",
123526
+ "name": "elementName",
123527
+ "type": {
123528
+ "text": "string"
123529
+ },
123530
+ "privacy": "public",
123531
+ "static": true,
123532
+ "readonly": true,
123563
123533
  "inheritedFrom": {
123564
- "name": "SbbButtonLikeBaseElement",
123565
- "module": "core/base-elements/button-base-element.js"
123566
- }
123534
+ "name": "SbbElement",
123535
+ "module": "core/base-elements/element.js"
123536
+ },
123537
+ "default": "'sbb-step-label'"
123567
123538
  },
123568
123539
  {
123569
123540
  "kind": "field",
123570
- "name": "maybeDisabled",
123541
+ "name": "role",
123571
123542
  "type": {
123572
- "text": "boolean | undefined"
123543
+ "text": "string"
123573
123544
  },
123574
- "privacy": "protected",
123545
+ "privacy": "public",
123546
+ "static": true,
123575
123547
  "readonly": true,
123548
+ "default": "'tab'",
123576
123549
  "inheritedFrom": {
123577
- "name": "SbbActionBaseElement",
123578
- "module": "core/base-elements/action-base-element.js"
123550
+ "name": "SbbButtonLikeBaseElement",
123551
+ "module": "core/base-elements/button-base-element.js"
123579
123552
  }
123580
123553
  },
123581
123554
  {
123582
123555
  "kind": "field",
123583
- "name": "maybeDisabledInteractive",
123556
+ "name": "step",
123584
123557
  "type": {
123585
- "text": "boolean | undefined"
123558
+ "text": "SbbStepElement | null"
123586
123559
  },
123587
- "privacy": "protected",
123560
+ "privacy": "public",
123561
+ "description": "The step controlled by the label.",
123588
123562
  "readonly": true,
123589
- "inheritedFrom": {
123590
- "name": "SbbActionBaseElement",
123591
- "module": "core/base-elements/action-base-element.js"
123592
- }
123563
+ "default": "null"
123593
123564
  },
123594
123565
  {
123595
- "kind": "method",
123596
- "name": "setupBaseEventHandlers",
123597
- "privacy": "protected",
123598
- "return": {
123599
- "type": {
123600
- "text": "void"
123601
- }
123566
+ "kind": "field",
123567
+ "name": "_step",
123568
+ "type": {
123569
+ "text": "SbbStepElement | null"
123602
123570
  },
123603
- "inheritedFrom": {
123604
- "name": "SbbActionBaseElement",
123605
- "module": "core/base-elements/action-base-element.js"
123606
- }
123571
+ "privacy": "private",
123572
+ "default": "null"
123607
123573
  },
123608
123574
  {
123609
- "kind": "method",
123610
- "name": "renderTemplate",
123611
- "privacy": "protected",
123612
- "return": {
123613
- "type": {
123614
- "text": "TemplateResult"
123615
- }
123575
+ "kind": "field",
123576
+ "name": "stepper",
123577
+ "type": {
123578
+ "text": "SbbStepperElement | null"
123616
123579
  },
123617
- "description": "Override this method to render the component template.",
123618
- "inheritedFrom": {
123619
- "name": "SbbActionBaseElement",
123620
- "module": "core/base-elements/action-base-element.js"
123621
- }
123580
+ "privacy": "public",
123581
+ "readonly": true
123622
123582
  },
123623
123583
  {
123624
123584
  "kind": "field",
123625
- "name": "_hydrationRequired",
123585
+ "name": "disabled",
123586
+ "privacy": "public",
123587
+ "description": "Whether the component is disabled.",
123588
+ "default": "false",
123626
123589
  "type": {
123627
123590
  "text": "boolean"
123628
123591
  },
123629
- "privacy": "private",
123630
- "default": "!!this.shadowRoot",
123631
- "inheritedFrom": {
123632
- "name": "SbbElement",
123633
- "module": "core/base-elements/element.js"
123634
- }
123635
- },
123636
- {
123637
- "kind": "field",
123638
- "name": "_hydrationComplete",
123639
- "privacy": "private",
123640
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
123592
+ "attribute": "disabled",
123593
+ "reflects": true,
123641
123594
  "inheritedFrom": {
123642
- "name": "SbbElement",
123643
- "module": "core/base-elements/element.js"
123595
+ "name": "SbbDisabledMixin",
123596
+ "module": "core/mixins/disabled-mixin.js"
123644
123597
  }
123645
123598
  },
123646
123599
  {
123647
123600
  "kind": "field",
123648
- "name": "_resolveHydration",
123601
+ "name": "_previousOrientation",
123649
123602
  "type": {
123650
- "text": "(hydrationRequired: boolean) => void"
123603
+ "text": "string | undefined"
123651
123604
  },
123652
- "privacy": "private",
123653
- "inheritedFrom": {
123654
- "name": "SbbElement",
123655
- "module": "core/base-elements/element.js"
123656
- }
123605
+ "privacy": "private"
123657
123606
  },
123658
123607
  {
123659
123608
  "kind": "field",
123660
- "name": "hydrationRequired",
123609
+ "name": "_previousSize",
123661
123610
  "type": {
123662
- "text": "boolean"
123663
- },
123664
- "privacy": "protected",
123665
- "description": "Returns whether hydration is required and not completed.",
123666
- "readonly": true,
123667
- "inheritedFrom": {
123668
- "name": "SbbElement",
123669
- "module": "core/base-elements/element.js"
123611
+ "text": "string | undefined"
123670
123612
  },
123671
- "default": "!!this.shadowRoot"
123613
+ "privacy": "private"
123672
123614
  },
123673
123615
  {
123674
123616
  "kind": "method",
123675
- "name": "toggleState",
123676
- "privacy": "protected",
123617
+ "name": "_isNotDeactivatedByLinearMode",
123618
+ "privacy": "private",
123677
123619
  "return": {
123678
123620
  "type": {
123679
- "text": "void"
123621
+ "text": "boolean"
123680
123622
  }
123681
123623
  },
123682
123624
  "parameters": [
123683
123625
  {
123684
- "name": "value",
123685
- "type": {
123686
- "text": "string"
123687
- }
123688
- },
123689
- {
123690
- "name": "force",
123691
- "optional": true,
123626
+ "name": "step",
123692
123627
  "type": {
123693
- "text": "boolean"
123628
+ "text": "SbbStepElement"
123694
123629
  }
123695
123630
  }
123696
- ],
123697
- "inheritedFrom": {
123698
- "name": "SbbElement",
123699
- "module": "core/base-elements/element.js"
123700
- }
123631
+ ]
123701
123632
  },
123702
123633
  {
123703
- "kind": "field",
123704
- "name": "['_$sbbElement$']",
123705
- "type": {
123706
- "text": "boolean"
123707
- },
123708
- "privacy": "public",
123709
- "static": true,
123710
- "default": "true",
123711
- "inheritedFrom": {
123712
- "name": "SbbElement",
123713
- "module": "core/base-elements/element.js"
123634
+ "kind": "method",
123635
+ "name": "_assignStep",
123636
+ "privacy": "private",
123637
+ "return": {
123638
+ "type": {
123639
+ "text": "void"
123640
+ }
123714
123641
  }
123715
123642
  },
123716
123643
  {
123717
123644
  "kind": "field",
123718
- "name": "_controllers",
123645
+ "name": "iconName",
123719
123646
  "type": {
123720
- "text": "Set<SbbReactiveController> | undefined"
123647
+ "text": "string"
123721
123648
  },
123722
- "privacy": "private",
123649
+ "privacy": "public",
123650
+ "default": "''",
123651
+ "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.",
123652
+ "attribute": "icon-name",
123723
123653
  "inheritedFrom": {
123724
- "name": "SbbElement",
123725
- "module": "core/base-elements/element.js"
123654
+ "name": "SbbIconNameMixin",
123655
+ "module": "icon/icon-name-mixin.js"
123726
123656
  }
123727
- }
123728
- ],
123729
- "mixins": [
123730
- {
123731
- "name": "SbbIconNameMixin",
123732
- "module": "icon.js"
123733
123657
  },
123734
123658
  {
123735
- "name": "SbbDisabledMixin",
123736
- "module": "core/mixins.js"
123737
- }
123738
- ],
123739
- "superclass": {
123740
- "name": "SbbButtonBaseElement",
123741
- "module": "core/base-elements.js"
123742
- },
123743
- "tagName": "sbb-step-label",
123744
- "customElement": true,
123745
- "attributes": [
123746
- {
123747
- "name": "icon-name",
123748
- "type": {
123749
- "text": "string"
123659
+ "kind": "method",
123660
+ "name": "renderIconSlot",
123661
+ "privacy": "protected",
123662
+ "return": {
123663
+ "type": {
123664
+ "text": "TemplateResult"
123665
+ }
123750
123666
  },
123751
- "default": "''",
123752
- "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.",
123753
- "fieldName": "iconName",
123667
+ "parameters": [
123668
+ {
123669
+ "name": "classname",
123670
+ "optional": true,
123671
+ "type": {
123672
+ "text": "string"
123673
+ }
123674
+ }
123675
+ ],
123754
123676
  "inheritedFrom": {
123755
123677
  "name": "SbbIconNameMixin",
123756
123678
  "module": "icon/icon-name-mixin.js"
123757
123679
  }
123758
123680
  },
123759
123681
  {
123760
- "name": "disabled",
123761
- "description": "Whether the component is disabled.",
123762
- "default": "false",
123763
- "type": {
123764
- "text": "boolean"
123682
+ "kind": "method",
123683
+ "name": "renderIconName",
123684
+ "privacy": "protected",
123685
+ "return": {
123686
+ "type": {
123687
+ "text": "string"
123688
+ }
123765
123689
  },
123766
- "fieldName": "disabled",
123767
123690
  "inheritedFrom": {
123768
- "name": "SbbDisabledMixin",
123769
- "module": "core/mixins/disabled-mixin.js"
123691
+ "name": "SbbIconNameMixin",
123692
+ "module": "icon/icon-name-mixin.js"
123770
123693
  }
123771
123694
  },
123772
123695
  {
123773
- "name": "value",
123774
- "type": {
123775
- "text": "string"
123696
+ "kind": "method",
123697
+ "name": "_renderIconName",
123698
+ "privacy": "private",
123699
+ "return": {
123700
+ "type": {
123701
+ "text": "string"
123702
+ }
123776
123703
  },
123777
- "default": "''",
123778
- "description": "Value of the form element.",
123779
- "fieldName": "value",
123780
123704
  "inheritedFrom": {
123781
- "name": "SbbButtonBaseElement",
123782
- "module": "core/base-elements/button-base-element.js"
123705
+ "name": "SbbIconNameMixin",
123706
+ "module": "icon/icon-name-mixin.js"
123783
123707
  }
123784
123708
  },
123785
123709
  {
123786
- "name": "type",
123787
- "description": "The type attribute to use for the button.",
123788
- "default": "'button'",
123710
+ "kind": "field",
123711
+ "name": "#disabled",
123712
+ "privacy": "private",
123789
123713
  "type": {
123790
- "text": "SbbButtonType"
123714
+ "text": "boolean"
123791
123715
  },
123792
- "fieldName": "type",
123716
+ "default": "false",
123793
123717
  "inheritedFrom": {
123794
- "name": "SbbButtonBaseElement",
123795
- "module": "core/base-elements/button-base-element.js"
123718
+ "name": "SbbDisabledMixin",
123719
+ "module": "core/mixins/disabled-mixin.js"
123796
123720
  }
123797
123721
  },
123798
123722
  {
123799
- "name": "form",
123800
- "description": "The `<form>` element to associate the button with.",
123801
- "type": {
123802
- "text": "HTMLFormElement | null"
123723
+ "kind": "method",
123724
+ "name": "isDisabledExternally",
123725
+ "privacy": "protected",
123726
+ "return": {
123727
+ "type": {
123728
+ "text": "boolean"
123729
+ }
123803
123730
  },
123804
- "fieldName": "form",
123731
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
123805
123732
  "inheritedFrom": {
123806
- "name": "SbbButtonBaseElement",
123807
- "module": "core/base-elements/button-base-element.js"
123733
+ "name": "SbbDisabledMixin",
123734
+ "module": "core/mixins/disabled-mixin.js"
123808
123735
  }
123809
123736
  },
123810
- {
123811
- "name": "name",
123812
- "description": "Name of the form element. Will be read from name attribute.",
123813
- "type": {
123814
- "text": "string"
123815
- },
123816
- "fieldName": "name",
123817
- "inheritedFrom": {
123818
- "name": "SbbFormAssociatedMixin",
123819
- "module": "core/mixins/form-associated-mixin.js"
123820
- }
123821
- }
123822
- ]
123823
- }
123824
- ],
123825
- "exports": [
123826
- {
123827
- "kind": "js",
123828
- "name": "SbbStepLabelElement",
123829
- "declaration": {
123830
- "name": "SbbStepLabelElement",
123831
- "module": "stepper/step-label/step-label.component.js"
123832
- }
123833
- }
123834
- ]
123835
- },
123836
- {
123837
- "kind": "javascript-module",
123838
- "path": "stepper/stepper/stepper.component.js",
123839
- "declarations": [
123840
- {
123841
- "kind": "class",
123842
- "description": "",
123843
- "name": "SbbStepChangeEvent",
123844
- "members": [
123845
123737
  {
123846
123738
  "kind": "field",
123847
- "name": "selectedIndex",
123739
+ "name": "_elementsOnWhichEnterPressTriggersSubmit",
123848
123740
  "type": {
123849
- "text": "number | null"
123741
+ "text": "array"
123850
123742
  },
123851
- "privacy": "public",
123743
+ "privacy": "private",
123852
123744
  "readonly": true,
123853
- "description": "The index of the newly selected step.",
123854
- "default": "selectedIndex"
123745
+ "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
123746
+ "inheritedFrom": {
123747
+ "name": "SbbButtonBaseElement",
123748
+ "module": "core/base-elements/button-base-element.js"
123749
+ }
123855
123750
  },
123856
123751
  {
123857
123752
  "kind": "field",
123858
- "name": "previousIndex",
123753
+ "name": "value",
123859
123754
  "type": {
123860
- "text": "number | null"
123755
+ "text": "string"
123861
123756
  },
123862
123757
  "privacy": "public",
123863
- "readonly": true,
123864
- "description": "The index of the previously selected step.",
123865
- "default": "previousIndex"
123758
+ "inheritedFrom": {
123759
+ "name": "SbbButtonBaseElement",
123760
+ "module": "core/base-elements/button-base-element.js"
123761
+ },
123762
+ "default": "''",
123763
+ "description": "Value of the form element.",
123764
+ "attribute": "value"
123866
123765
  },
123867
123766
  {
123868
123767
  "kind": "field",
123869
- "name": "selectedStep",
123768
+ "name": "type",
123769
+ "privacy": "public",
123770
+ "description": "The type attribute to use for the button.",
123771
+ "default": "'button'",
123870
123772
  "type": {
123871
- "text": "SbbStepElement | null"
123773
+ "text": "SbbButtonType"
123872
123774
  },
123873
- "privacy": "public",
123874
- "readonly": true,
123875
- "description": "The newly selected step element.",
123876
- "default": "selectedStep"
123775
+ "attribute": "type",
123776
+ "inheritedFrom": {
123777
+ "name": "SbbButtonBaseElement",
123778
+ "module": "core/base-elements/button-base-element.js"
123779
+ }
123877
123780
  },
123878
123781
  {
123879
123782
  "kind": "field",
123880
- "name": "previousStep",
123783
+ "name": "form",
123881
123784
  "type": {
123882
- "text": "SbbStepElement | null"
123785
+ "text": "HTMLFormElement | null"
123883
123786
  },
123884
123787
  "privacy": "public",
123885
- "readonly": true,
123886
- "description": "The previously selected step element.",
123887
- "default": "previousStep"
123888
- }
123889
- ],
123890
- "superclass": {
123891
- "name": "Event",
123892
- "module": "stepper/stepper/stepper.component.js"
123893
- }
123894
- },
123895
- {
123896
- "kind": "class",
123897
- "description": "Provides a structured, step-by-step workflow for user interactions.",
123898
- "name": "SbbStepperElement",
123899
- "slots": [
123900
- {
123901
- "description": "Provide a `sbb-expansion-panel-header` and a `sbb-expansion-panel-content` to the stepper.",
123902
- "name": ""
123903
- },
123904
- {
123905
- "description": "Use this slot to provide an `sbb-step-label`.",
123906
- "name": "step-label"
123788
+ "description": "The `<form>` element to associate the button with.",
123789
+ "inheritedFrom": {
123790
+ "name": "SbbButtonBaseElement",
123791
+ "module": "core/base-elements/button-base-element.js"
123792
+ },
123793
+ "attribute": "form"
123907
123794
  },
123908
- {
123909
- "description": "Use this slot to provide an `sbb-step`.",
123910
- "name": "step"
123911
- }
123912
- ],
123913
- "members": [
123914
123795
  {
123915
123796
  "kind": "field",
123916
- "name": "elementName",
123797
+ "name": "_formId",
123917
123798
  "type": {
123918
123799
  "text": "string"
123919
123800
  },
123920
- "privacy": "public",
123921
- "static": true,
123922
- "readonly": true,
123923
- "default": "'sbb-stepper'",
123801
+ "privacy": "private",
123802
+ "default": "''",
123924
123803
  "inheritedFrom": {
123925
- "name": "SbbElement",
123926
- "module": "core/base-elements/element.js"
123804
+ "name": "SbbButtonBaseElement",
123805
+ "module": "core/base-elements/button-base-element.js"
123927
123806
  }
123928
123807
  },
123929
123808
  {
123930
123809
  "kind": "field",
123931
- "name": "events",
123932
- "privacy": "public",
123933
- "static": true,
123934
- "readonly": true,
123935
- "default": "{ stepchange: 'stepchange', }",
123936
- "type": {
123937
- "text": "{\n stepchange: 'stepchange',\n }"
123810
+ "name": "_handleButtonClick",
123811
+ "privacy": "private",
123812
+ "inheritedFrom": {
123813
+ "name": "SbbButtonBaseElement",
123814
+ "module": "core/base-elements/button-base-element.js"
123938
123815
  }
123939
123816
  },
123940
123817
  {
123941
- "kind": "field",
123942
- "name": "_observer",
123818
+ "kind": "method",
123819
+ "name": "_requestSubmit",
123943
123820
  "privacy": "private",
123944
- "default": "new IntersectionController(this, { target: null, callback: (entries) => { entries.forEach((e) => { if (e.intersectionRatio > 0) { this._setStepperHeight(this.selected); this._setMarkerSize(); } }); }, })",
123945
- "description": "If the sbb-stepper is used in a sbb-dialog, the marker on the selected element will not appear,\nbecause the calculations are done when the dialog is closed, so the marker has a width of 0;\nthe same happens for the stepper height.\nWe need to recalculate it when the element becomes visible."
123946
- },
123947
- {
123948
- "kind": "field",
123949
- "name": "linear",
123950
- "type": {
123951
- "text": "boolean"
123952
- },
123953
- "privacy": "public",
123954
- "default": "false",
123955
- "description": "If set to true, only the current and previous labels can be clicked and selected.",
123956
- "attribute": "linear"
123957
- },
123958
- {
123959
- "kind": "field",
123960
- "name": "horizontalFrom",
123961
- "privacy": "public",
123962
- "description": "Overrides the behavior of `orientation` property.",
123963
- "type": {
123964
- "text": "SbbHorizontalFrom | null"
123965
- },
123966
- "attribute": "horizontal-from",
123967
- "reflects": true,
123968
- "default": "null"
123969
- },
123970
- {
123971
- "kind": "field",
123972
- "name": "_horizontalFrom",
123973
- "type": {
123974
- "text": "SbbHorizontalFrom | null"
123821
+ "return": {
123822
+ "type": {
123823
+ "text": "void"
123824
+ }
123975
123825
  },
123976
- "privacy": "private",
123977
- "default": "null"
123826
+ "parameters": [
123827
+ {
123828
+ "name": "form",
123829
+ "type": {
123830
+ "text": "HTMLFormElement"
123831
+ }
123832
+ }
123833
+ ],
123834
+ "inheritedFrom": {
123835
+ "name": "SbbButtonBaseElement",
123836
+ "module": "core/base-elements/button-base-element.js"
123837
+ }
123978
123838
  },
123979
123839
  {
123980
123840
  "kind": "field",
123981
- "name": "orientation",
123982
- "type": {
123983
- "text": "SbbOrientation"
123984
- },
123985
- "privacy": "public",
123986
- "default": "'horizontal'",
123987
- "description": "Steps orientation, either horizontal or vertical.",
123988
- "attribute": "orientation",
123989
- "reflects": true
123841
+ "name": "_formKeyDown",
123842
+ "privacy": "private",
123843
+ "inheritedFrom": {
123844
+ "name": "SbbButtonBaseElement",
123845
+ "module": "core/base-elements/button-base-element.js"
123846
+ }
123990
123847
  },
123991
123848
  {
123992
123849
  "kind": "field",
123993
- "name": "size",
123850
+ "name": "formAssociated",
123994
123851
  "type": {
123995
- "text": "'s' | 'm'"
123852
+ "text": "boolean"
123996
123853
  },
123997
123854
  "privacy": "public",
123998
- "description": "Size variant, either s or m.",
123999
- "default": "'m' / 's' (lean)",
124000
- "attribute": "size",
124001
- "reflects": true
123855
+ "static": true,
123856
+ "default": "true",
123857
+ "inheritedFrom": {
123858
+ "name": "SbbFormAssociatedMixin",
123859
+ "module": "core/mixins/form-associated-mixin.js"
123860
+ }
124002
123861
  },
124003
123862
  {
124004
123863
  "kind": "field",
124005
- "name": "selected",
123864
+ "name": "name",
124006
123865
  "privacy": "public",
124007
- "description": "The currently selected step.",
123866
+ "description": "Name of the form element. Will be read from name attribute.",
124008
123867
  "type": {
124009
- "text": "SbbStepElement | null"
123868
+ "text": "string"
123869
+ },
123870
+ "attribute": "name",
123871
+ "inheritedFrom": {
123872
+ "name": "SbbFormAssociatedMixin",
123873
+ "module": "core/mixins/form-associated-mixin.js"
124010
123874
  }
124011
123875
  },
124012
123876
  {
124013
123877
  "kind": "field",
124014
- "name": "_requestedSelected",
123878
+ "name": "validity",
124015
123879
  "type": {
124016
- "text": "SbbStepElement | null"
123880
+ "text": "ValidityState"
124017
123881
  },
124018
- "privacy": "private",
124019
- "default": "null"
124020
- },
124021
- {
124022
- "kind": "field",
124023
- "name": "selectedIndex",
124024
123882
  "privacy": "public",
124025
- "description": "The currently selected step index.",
124026
- "type": {
124027
- "text": "number | null"
124028
- },
124029
- "attribute": "selected-index"
123883
+ "description": "Returns the ValidityState object for this element.",
123884
+ "readonly": true,
123885
+ "inheritedFrom": {
123886
+ "name": "SbbFormAssociatedMixin",
123887
+ "module": "core/mixins/form-associated-mixin.js"
123888
+ }
124030
123889
  },
124031
123890
  {
124032
123891
  "kind": "field",
124033
- "name": "_requestedSelectedIndex",
123892
+ "name": "validationMessage",
124034
123893
  "type": {
124035
- "text": "number | null"
123894
+ "text": "string"
124036
123895
  },
124037
- "privacy": "private",
124038
- "default": "null"
123896
+ "privacy": "public",
123897
+ "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.",
123898
+ "readonly": true,
123899
+ "inheritedFrom": {
123900
+ "name": "SbbFormAssociatedMixin",
123901
+ "module": "core/mixins/form-associated-mixin.js"
123902
+ }
124039
123903
  },
124040
123904
  {
124041
123905
  "kind": "field",
124042
- "name": "steps",
123906
+ "name": "willValidate",
124043
123907
  "type": {
124044
- "text": "SbbStepElement[]"
123908
+ "text": "boolean"
124045
123909
  },
124046
123910
  "privacy": "public",
124047
- "description": "The steps of the stepper.",
124048
- "readonly": true
123911
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
123912
+ "readonly": true,
123913
+ "inheritedFrom": {
123914
+ "name": "SbbFormAssociatedMixin",
123915
+ "module": "core/mixins/form-associated-mixin.js"
123916
+ }
124049
123917
  },
124050
123918
  {
124051
123919
  "kind": "field",
124052
- "name": "_enabledSteps",
124053
- "type": {
124054
- "text": "SbbStepElement[]"
124055
- },
123920
+ "name": "_validityStates",
124056
123921
  "privacy": "private",
124057
- "readonly": true
123922
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
123923
+ "inheritedFrom": {
123924
+ "name": "SbbFormAssociatedMixin",
123925
+ "module": "core/mixins/form-associated-mixin.js"
123926
+ }
124058
123927
  },
124059
123928
  {
124060
123929
  "kind": "field",
124061
- "name": "_loaded",
123930
+ "name": "formDisabled",
124062
123931
  "type": {
124063
123932
  "text": "boolean"
124064
123933
  },
124065
- "privacy": "private",
124066
- "default": "false"
123934
+ "privacy": "protected",
123935
+ "default": "false",
123936
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
123937
+ "inheritedFrom": {
123938
+ "name": "SbbFormAssociatedMixin",
123939
+ "module": "core/mixins/form-associated-mixin.js"
123940
+ }
124067
123941
  },
124068
123942
  {
124069
- "kind": "field",
124070
- "name": "_resizeObserverTimeout",
124071
- "type": {
124072
- "text": "ReturnType<typeof setTimeout> | null"
123943
+ "kind": "method",
123944
+ "name": "checkValidity",
123945
+ "privacy": "public",
123946
+ "return": {
123947
+ "type": {
123948
+ "text": "boolean"
123949
+ }
124073
123950
  },
124074
- "privacy": "private",
124075
- "default": "null"
123951
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
123952
+ "inheritedFrom": {
123953
+ "name": "SbbFormAssociatedMixin",
123954
+ "module": "core/mixins/form-associated-mixin.js"
123955
+ }
124076
123956
  },
124077
123957
  {
124078
- "kind": "field",
124079
- "name": "_mediaMatcher",
124080
- "privacy": "private",
124081
- "default": "new SbbMediaMatcherController(this, {})"
123958
+ "kind": "method",
123959
+ "name": "reportValidity",
123960
+ "privacy": "public",
123961
+ "return": {
123962
+ "type": {
123963
+ "text": "boolean"
123964
+ }
123965
+ },
123966
+ "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.",
123967
+ "inheritedFrom": {
123968
+ "name": "SbbFormAssociatedMixin",
123969
+ "module": "core/mixins/form-associated-mixin.js"
123970
+ }
124082
123971
  },
124083
123972
  {
124084
123973
  "kind": "method",
124085
- "name": "next",
123974
+ "name": "setCustomValidity",
124086
123975
  "privacy": "public",
124087
123976
  "return": {
124088
123977
  "type": {
124089
123978
  "text": "void"
124090
123979
  }
124091
123980
  },
124092
- "description": "Selects the next step."
123981
+ "parameters": [
123982
+ {
123983
+ "name": "message",
123984
+ "type": {
123985
+ "text": "string"
123986
+ }
123987
+ }
123988
+ ],
123989
+ "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.",
123990
+ "inheritedFrom": {
123991
+ "name": "SbbFormAssociatedMixin",
123992
+ "module": "core/mixins/form-associated-mixin.js"
123993
+ }
124093
123994
  },
124094
123995
  {
124095
123996
  "kind": "method",
124096
- "name": "previous",
124097
- "privacy": "public",
123997
+ "name": "_hasDisabledAncestor",
123998
+ "privacy": "private",
124098
123999
  "return": {
124099
124000
  "type": {
124100
- "text": "void"
124001
+ "text": "boolean"
124101
124002
  }
124102
124003
  },
124103
- "description": "Selects the previous step."
124004
+ "inheritedFrom": {
124005
+ "name": "SbbFormAssociatedMixin",
124006
+ "module": "core/mixins/form-associated-mixin.js"
124007
+ }
124104
124008
  },
124105
124009
  {
124106
124010
  "kind": "method",
124107
- "name": "reset",
124108
- "privacy": "public",
124011
+ "name": "updateFormValue",
124012
+ "privacy": "protected",
124109
124013
  "return": {
124110
124014
  "type": {
124111
124015
  "text": "void"
124112
124016
  }
124113
124017
  },
124114
- "description": "Resets the form in which the stepper is nested or every form of each step, if any."
124018
+ "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",
124019
+ "inheritedFrom": {
124020
+ "name": "SbbFormAssociatedMixin",
124021
+ "module": "core/mixins/form-associated-mixin.js"
124022
+ }
124115
124023
  },
124116
124024
  {
124117
124025
  "kind": "method",
124118
- "name": "_isSelectable",
124119
- "privacy": "private",
124026
+ "name": "formState",
124027
+ "privacy": "protected",
124120
124028
  "return": {
124121
124029
  "type": {
124122
- "text": "step is SbbStepElement"
124030
+ "text": "FormRestoreState"
124031
+ }
124032
+ },
124033
+ "inheritedFrom": {
124034
+ "name": "SbbFormAssociatedMixin",
124035
+ "module": "core/mixins/form-associated-mixin.js"
124036
+ }
124037
+ },
124038
+ {
124039
+ "kind": "method",
124040
+ "name": "setValidityFlag",
124041
+ "privacy": "protected",
124042
+ "return": {
124043
+ "type": {
124044
+ "text": "void"
124123
124045
  }
124124
124046
  },
124125
124047
  "parameters": [
124126
124048
  {
124127
- "name": "step",
124049
+ "name": "flag",
124128
124050
  "type": {
124129
- "text": "SbbStepElement | null"
124051
+ "text": "T"
124052
+ }
124053
+ },
124054
+ {
124055
+ "name": "message",
124056
+ "type": {
124057
+ "text": "string"
124058
+ }
124059
+ },
124060
+ {
124061
+ "name": "flagValue",
124062
+ "optional": true,
124063
+ "type": {
124064
+ "text": "ValidityStateFlags[T]"
124130
124065
  }
124131
124066
  }
124132
- ]
124067
+ ],
124068
+ "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).",
124069
+ "inheritedFrom": {
124070
+ "name": "SbbFormAssociatedMixin",
124071
+ "module": "core/mixins/form-associated-mixin.js"
124072
+ }
124133
124073
  },
124134
124074
  {
124135
124075
  "kind": "method",
124136
- "name": "_select",
124137
- "privacy": "private",
124076
+ "name": "removeValidityFlag",
124077
+ "privacy": "protected",
124138
124078
  "return": {
124139
124079
  "type": {
124140
124080
  "text": "void"
@@ -124142,132 +124082,174 @@
124142
124082
  },
124143
124083
  "parameters": [
124144
124084
  {
124145
- "name": "step",
124085
+ "name": "flag",
124146
124086
  "type": {
124147
- "text": "SbbStepElement | null"
124087
+ "text": "T"
124148
124088
  }
124149
124089
  }
124150
- ]
124090
+ ],
124091
+ "description": "Removes the validity state flag entry and updates validity state.",
124092
+ "inheritedFrom": {
124093
+ "name": "SbbFormAssociatedMixin",
124094
+ "module": "core/mixins/form-associated-mixin.js"
124095
+ }
124151
124096
  },
124152
124097
  {
124153
124098
  "kind": "method",
124154
- "name": "_setMarkerSize",
124155
- "privacy": "private",
124099
+ "name": "validate",
124100
+ "privacy": "protected",
124156
124101
  "return": {
124157
124102
  "type": {
124158
124103
  "text": "void"
124159
124104
  }
124105
+ },
124106
+ "description": "To be called whenever the current element needs to be validated.",
124107
+ "inheritedFrom": {
124108
+ "name": "SbbFormAssociatedMixin",
124109
+ "module": "core/mixins/form-associated-mixin.js"
124160
124110
  }
124161
124111
  },
124162
124112
  {
124163
124113
  "kind": "method",
124164
- "name": "_setStepperHeight",
124165
- "privacy": "private",
124114
+ "name": "shouldValidate",
124115
+ "privacy": "protected",
124166
124116
  "return": {
124167
124117
  "type": {
124168
- "text": "void"
124118
+ "text": "boolean"
124169
124119
  }
124170
124120
  },
124171
124121
  "parameters": [
124172
124122
  {
124173
- "name": "step",
124123
+ "name": "name",
124174
124124
  "type": {
124175
- "text": "SbbStepElement | null"
124125
+ "text": "PropertyKey | undefined"
124176
124126
  }
124177
124127
  }
124178
124128
  ],
124179
- "description": "Sets the stepper height based on the height of the provided step."
124129
+ "description": "Whether validation should be run on a property change with the given name.",
124130
+ "inheritedFrom": {
124131
+ "name": "SbbFormAssociatedMixin",
124132
+ "module": "core/mixins/form-associated-mixin.js"
124133
+ }
124180
124134
  },
124181
124135
  {
124182
124136
  "kind": "method",
124183
- "name": "_calculateLabelOffsetTop",
124137
+ "name": "_setInternalValidity",
124184
124138
  "privacy": "private",
124185
124139
  "return": {
124186
124140
  "type": {
124187
- "text": "number | undefined"
124141
+ "text": "void"
124188
124142
  }
124143
+ },
124144
+ "inheritedFrom": {
124145
+ "name": "SbbFormAssociatedMixin",
124146
+ "module": "core/mixins/form-associated-mixin.js"
124189
124147
  }
124190
124148
  },
124191
124149
  {
124192
- "kind": "method",
124193
- "name": "_onSelectedStepResize",
124150
+ "kind": "field",
124151
+ "name": "_preventScrollOnSpaceKeydown",
124194
124152
  "privacy": "private",
124195
- "return": {
124196
- "type": {
124197
- "text": "void"
124198
- }
124199
- },
124153
+ "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
124200
124154
  "parameters": [
124201
124155
  {
124202
- "name": "e",
124203
- "type": {
124204
- "text": "Event"
124205
- }
124156
+ "description": "The origin event.",
124157
+ "name": "event"
124206
124158
  }
124207
- ]
124159
+ ],
124160
+ "inheritedFrom": {
124161
+ "name": "SbbButtonLikeBaseElement",
124162
+ "module": "core/base-elements/button-base-element.js"
124163
+ }
124208
124164
  },
124209
124165
  {
124210
- "kind": "method",
124211
- "name": "_configure",
124166
+ "kind": "field",
124167
+ "name": "_removeActiveMarker",
124212
124168
  "privacy": "private",
124213
- "return": {
124214
- "type": {
124215
- "text": "void"
124216
- }
124169
+ "inheritedFrom": {
124170
+ "name": "SbbButtonLikeBaseElement",
124171
+ "module": "core/base-elements/button-base-element.js"
124217
124172
  }
124218
124173
  },
124219
124174
  {
124220
- "kind": "method",
124221
- "name": "_updateLabels",
124175
+ "kind": "field",
124176
+ "name": "_dispatchClickEventOnSpaceKeyup",
124222
124177
  "privacy": "private",
124223
- "return": {
124224
- "type": {
124225
- "text": "void"
124178
+ "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.",
124179
+ "parameters": [
124180
+ {
124181
+ "description": "The origin event.",
124182
+ "name": "event"
124226
124183
  }
124184
+ ],
124185
+ "inheritedFrom": {
124186
+ "name": "SbbButtonLikeBaseElement",
124187
+ "module": "core/base-elements/button-base-element.js"
124227
124188
  }
124228
124189
  },
124229
124190
  {
124230
- "kind": "method",
124231
- "name": "_checkOrientation",
124191
+ "kind": "field",
124192
+ "name": "_dispatchClickEvent",
124232
124193
  "privacy": "private",
124233
- "return": {
124234
- "type": {
124235
- "text": "void"
124236
- }
124194
+ "inheritedFrom": {
124195
+ "name": "SbbButtonLikeBaseElement",
124196
+ "module": "core/base-elements/button-base-element.js"
124237
124197
  }
124238
124198
  },
124239
124199
  {
124240
124200
  "kind": "field",
124241
- "name": "_onStepperResize",
124242
- "privacy": "private"
124201
+ "name": "maybeDisabled",
124202
+ "type": {
124203
+ "text": "boolean | undefined"
124204
+ },
124205
+ "privacy": "protected",
124206
+ "readonly": true,
124207
+ "inheritedFrom": {
124208
+ "name": "SbbActionBaseElement",
124209
+ "module": "core/base-elements/action-base-element.js"
124210
+ }
124211
+ },
124212
+ {
124213
+ "kind": "field",
124214
+ "name": "maybeDisabledInteractive",
124215
+ "type": {
124216
+ "text": "boolean | undefined"
124217
+ },
124218
+ "privacy": "protected",
124219
+ "readonly": true,
124220
+ "inheritedFrom": {
124221
+ "name": "SbbActionBaseElement",
124222
+ "module": "core/base-elements/action-base-element.js"
124223
+ }
124243
124224
  },
124244
124225
  {
124245
124226
  "kind": "method",
124246
- "name": "_configureLinearMode",
124247
- "privacy": "private",
124227
+ "name": "setupBaseEventHandlers",
124228
+ "privacy": "protected",
124248
124229
  "return": {
124249
124230
  "type": {
124250
124231
  "text": "void"
124251
124232
  }
124233
+ },
124234
+ "inheritedFrom": {
124235
+ "name": "SbbActionBaseElement",
124236
+ "module": "core/base-elements/action-base-element.js"
124252
124237
  }
124253
124238
  },
124254
124239
  {
124255
124240
  "kind": "method",
124256
- "name": "_handleKeyDown",
124257
- "privacy": "private",
124241
+ "name": "renderTemplate",
124242
+ "privacy": "protected",
124258
124243
  "return": {
124259
124244
  "type": {
124260
- "text": "void"
124245
+ "text": "TemplateResult"
124261
124246
  }
124262
124247
  },
124263
- "parameters": [
124264
- {
124265
- "name": "evt",
124266
- "type": {
124267
- "text": "KeyboardEvent"
124268
- }
124269
- }
124270
- ]
124248
+ "description": "Override this method to render the component template.",
124249
+ "inheritedFrom": {
124250
+ "name": "SbbActionBaseElement",
124251
+ "module": "core/base-elements/action-base-element.js"
124252
+ }
124271
124253
  },
124272
124254
  {
124273
124255
  "kind": "field",
@@ -124375,91 +124357,109 @@
124375
124357
  }
124376
124358
  }
124377
124359
  ],
124378
- "events": [
124360
+ "mixins": [
124379
124361
  {
124380
- "type": {
124381
- "text": "SbbStepChangeEvent"
124382
- },
124383
- "description": "Emits whenever a step was changed.",
124384
- "name": "stepchange"
124362
+ "name": "SbbIconNameMixin",
124363
+ "module": "icon.js"
124364
+ },
124365
+ {
124366
+ "name": "SbbDisabledMixin",
124367
+ "module": "core/mixins.js"
124385
124368
  }
124386
124369
  ],
124370
+ "superclass": {
124371
+ "name": "SbbButtonBaseElement",
124372
+ "module": "core/base-elements.js"
124373
+ },
124374
+ "tagName": "sbb-step-label",
124375
+ "customElement": true,
124387
124376
  "attributes": [
124388
124377
  {
124389
- "name": "linear",
124378
+ "name": "icon-name",
124390
124379
  "type": {
124391
- "text": "boolean"
124380
+ "text": "string"
124392
124381
  },
124382
+ "default": "''",
124383
+ "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.",
124384
+ "fieldName": "iconName",
124385
+ "inheritedFrom": {
124386
+ "name": "SbbIconNameMixin",
124387
+ "module": "icon/icon-name-mixin.js"
124388
+ }
124389
+ },
124390
+ {
124391
+ "name": "disabled",
124392
+ "description": "Whether the component is disabled.",
124393
124393
  "default": "false",
124394
- "description": "If set to true, only the current and previous labels can be clicked and selected.",
124395
- "fieldName": "linear"
124394
+ "type": {
124395
+ "text": "boolean"
124396
+ },
124397
+ "fieldName": "disabled",
124398
+ "inheritedFrom": {
124399
+ "name": "SbbDisabledMixin",
124400
+ "module": "core/mixins/disabled-mixin.js"
124401
+ }
124396
124402
  },
124397
124403
  {
124398
- "name": "horizontal-from",
124399
- "description": "Overrides the behavior of `orientation` property.",
124404
+ "name": "value",
124400
124405
  "type": {
124401
- "text": "SbbHorizontalFrom | null"
124406
+ "text": "string"
124402
124407
  },
124403
- "fieldName": "horizontalFrom"
124408
+ "default": "''",
124409
+ "description": "Value of the form element.",
124410
+ "fieldName": "value",
124411
+ "inheritedFrom": {
124412
+ "name": "SbbButtonBaseElement",
124413
+ "module": "core/base-elements/button-base-element.js"
124414
+ }
124404
124415
  },
124405
124416
  {
124406
- "name": "orientation",
124417
+ "name": "type",
124418
+ "description": "The type attribute to use for the button.",
124419
+ "default": "'button'",
124407
124420
  "type": {
124408
- "text": "SbbOrientation"
124421
+ "text": "SbbButtonType"
124409
124422
  },
124410
- "default": "'horizontal'",
124411
- "description": "Steps orientation, either horizontal or vertical.",
124412
- "fieldName": "orientation"
124423
+ "fieldName": "type",
124424
+ "inheritedFrom": {
124425
+ "name": "SbbButtonBaseElement",
124426
+ "module": "core/base-elements/button-base-element.js"
124427
+ }
124413
124428
  },
124414
124429
  {
124415
- "name": "size",
124430
+ "name": "form",
124431
+ "description": "The `<form>` element to associate the button with.",
124416
124432
  "type": {
124417
- "text": "'s' | 'm'"
124433
+ "text": "HTMLFormElement | null"
124418
124434
  },
124419
- "description": "Size variant, either s or m.",
124420
- "default": "'m' / 's' (lean)",
124421
- "fieldName": "size"
124435
+ "fieldName": "form",
124436
+ "inheritedFrom": {
124437
+ "name": "SbbButtonBaseElement",
124438
+ "module": "core/base-elements/button-base-element.js"
124439
+ }
124422
124440
  },
124423
124441
  {
124424
- "name": "selected-index",
124425
- "description": "The currently selected step index.",
124442
+ "name": "name",
124443
+ "description": "Name of the form element. Will be read from name attribute.",
124426
124444
  "type": {
124427
- "text": "number | null"
124445
+ "text": "string"
124428
124446
  },
124429
- "fieldName": "selectedIndex"
124447
+ "fieldName": "name",
124448
+ "inheritedFrom": {
124449
+ "name": "SbbFormAssociatedMixin",
124450
+ "module": "core/mixins/form-associated-mixin.js"
124451
+ }
124430
124452
  }
124431
- ],
124432
- "superclass": {
124433
- "name": "SbbElement",
124434
- "module": "core/base-elements.js"
124435
- },
124436
- "tagName": "sbb-stepper",
124437
- "customElement": true
124438
- },
124439
- {
124440
- "kind": "variable",
124441
- "name": "currentIndex"
124442
- },
124443
- {
124444
- "kind": "variable",
124445
- "name": "currentStep"
124453
+ ]
124446
124454
  }
124447
124455
  ],
124448
124456
  "exports": [
124449
124457
  {
124450
124458
  "kind": "js",
124451
- "name": "SbbStepChangeEvent",
124452
- "declaration": {
124453
- "name": "SbbStepChangeEvent",
124454
- "module": "stepper/stepper/stepper.component.js"
124455
- }
124456
- },
124457
- {
124458
- "kind": "js",
124459
- "name": "SbbStepperElement",
124459
+ "name": "SbbStepLabelElement",
124460
124460
  "declaration": {
124461
- "name": "SbbStepperElement",
124462
- "module": "stepper/stepper/stepper.component.js"
124461
+ "name": "SbbStepLabelElement",
124462
+ "module": "stepper/step-label/step-label.component.js"
124463
124463
  }
124464
124464
  }
124465
124465
  ]