@sbb-esta/lyne-elements-dev 4.7.0-dev.1772631734 → 4.7.0-dev.1772638329

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.
@@ -103879,168 +103879,52 @@
103879
103879
  },
103880
103880
  {
103881
103881
  "kind": "javascript-module",
103882
- "path": "stepper/stepper/stepper.component.js",
103882
+ "path": "stepper/step-label/step-label.component.js",
103883
103883
  "declarations": [
103884
103884
  {
103885
103885
  "kind": "class",
103886
- "description": "",
103887
- "name": "SbbStepChangeEvent",
103888
- "members": [
103889
- {
103890
- "kind": "field",
103891
- "name": "selectedIndex",
103892
- "type": {
103893
- "text": "number | null"
103894
- },
103895
- "privacy": "public",
103896
- "readonly": true,
103897
- "description": "The index of the newly selected step.",
103898
- "default": "selectedIndex"
103899
- },
103900
- {
103901
- "kind": "field",
103902
- "name": "previousIndex",
103903
- "type": {
103904
- "text": "number | null"
103905
- },
103906
- "privacy": "public",
103907
- "readonly": true,
103908
- "description": "The index of the previously selected step.",
103909
- "default": "previousIndex"
103910
- },
103911
- {
103912
- "kind": "field",
103913
- "name": "selectedStep",
103914
- "type": {
103915
- "text": "SbbStepElement | null"
103916
- },
103917
- "privacy": "public",
103918
- "readonly": true,
103919
- "description": "The newly selected step element.",
103920
- "default": "selectedStep"
103921
- },
103922
- {
103923
- "kind": "field",
103924
- "name": "previousStep",
103925
- "type": {
103926
- "text": "SbbStepElement | null"
103927
- },
103928
- "privacy": "public",
103929
- "readonly": true,
103930
- "description": "The previously selected step element.",
103931
- "default": "previousStep"
103932
- }
103933
- ],
103934
- "superclass": {
103935
- "name": "Event",
103936
- "module": "stepper/stepper/stepper.component.js"
103937
- }
103938
- },
103939
- {
103940
- "kind": "class",
103941
- "description": "Provides a structured, step-by-step workflow for user interactions.",
103942
- "name": "SbbStepperElement",
103886
+ "description": "Combined with a `sbb-stepper`, it displays a step's label.",
103887
+ "name": "SbbStepLabelElement",
103943
103888
  "slots": [
103944
103889
  {
103945
- "description": "Provide a `sbb-expansion-panel-header` and a `sbb-expansion-panel-content` to the stepper.",
103890
+ "description": "Use the unnamed slot to provide a label.",
103946
103891
  "name": ""
103947
103892
  },
103948
103893
  {
103949
- "description": "Use this slot to provide an `sbb-step-label`.",
103950
- "name": "step-label"
103951
- },
103952
- {
103953
- "description": "Use this slot to provide an `sbb-step`.",
103954
- "name": "step"
103894
+ "description": "Use this to display an icon in the label bubble.",
103895
+ "name": "icon"
103955
103896
  }
103956
103897
  ],
103957
103898
  "members": [
103958
103899
  {
103959
103900
  "kind": "field",
103960
- "name": "events",
103901
+ "name": "role",
103902
+ "type": {
103903
+ "text": "string"
103904
+ },
103961
103905
  "privacy": "public",
103962
103906
  "static": true,
103963
103907
  "readonly": true,
103964
- "default": "{ stepchange: 'stepchange', }",
103965
- "type": {
103966
- "text": "{\n stepchange: 'stepchange',\n }"
103908
+ "default": "'tab'",
103909
+ "inheritedFrom": {
103910
+ "name": "SbbButtonLikeBaseElement",
103911
+ "module": "core/base-elements/button-base-element.js"
103967
103912
  }
103968
103913
  },
103969
103914
  {
103970
103915
  "kind": "field",
103971
- "name": "_observer",
103972
- "privacy": "private",
103973
- "default": "new IntersectionController(this, { target: null, callback: (entries) => { entries.forEach((e) => { if (e.intersectionRatio > 0) { this._setStepperHeight(this.selected); this._setMarkerSize(); } }); }, })",
103974
- "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."
103975
- },
103976
- {
103977
- "kind": "field",
103978
- "name": "linear",
103916
+ "name": "step",
103979
103917
  "type": {
103980
- "text": "boolean"
103918
+ "text": "SbbStepElement | null"
103981
103919
  },
103982
103920
  "privacy": "public",
103983
- "default": "false",
103984
- "description": "If set to true, only the current and previous labels can be clicked and selected.",
103985
- "attribute": "linear"
103986
- },
103987
- {
103988
- "kind": "field",
103989
- "name": "horizontalFrom",
103990
- "privacy": "public",
103991
- "description": "Overrides the behavior of `orientation` property.",
103992
- "type": {
103993
- "text": "SbbHorizontalFrom | null"
103994
- },
103995
- "attribute": "horizontal-from",
103996
- "reflects": true,
103997
- "default": "null"
103998
- },
103999
- {
104000
- "kind": "field",
104001
- "name": "_horizontalFrom",
104002
- "type": {
104003
- "text": "SbbHorizontalFrom | null"
104004
- },
104005
- "privacy": "private",
103921
+ "description": "The step controlled by the label.",
103922
+ "readonly": true,
104006
103923
  "default": "null"
104007
103924
  },
104008
103925
  {
104009
103926
  "kind": "field",
104010
- "name": "orientation",
104011
- "type": {
104012
- "text": "SbbOrientation"
104013
- },
104014
- "privacy": "public",
104015
- "default": "'horizontal'",
104016
- "description": "Steps orientation, either horizontal or vertical.",
104017
- "attribute": "orientation",
104018
- "reflects": true
104019
- },
104020
- {
104021
- "kind": "field",
104022
- "name": "size",
104023
- "type": {
104024
- "text": "'s' | 'm'"
104025
- },
104026
- "privacy": "public",
104027
- "description": "Size variant, either s or m.",
104028
- "default": "'m' / 's' (lean)",
104029
- "attribute": "size",
104030
- "reflects": true
104031
- },
104032
- {
104033
- "kind": "field",
104034
- "name": "selected",
104035
- "privacy": "public",
104036
- "description": "The currently selected step.",
104037
- "type": {
104038
- "text": "SbbStepElement | null"
104039
- }
104040
- },
104041
- {
104042
- "kind": "field",
104043
- "name": "_requestedSelected",
103927
+ "name": "_step",
104044
103928
  "type": {
104045
103929
  "text": "SbbStepElement | null"
104046
103930
  },
@@ -104049,309 +103933,251 @@
104049
103933
  },
104050
103934
  {
104051
103935
  "kind": "field",
104052
- "name": "selectedIndex",
104053
- "privacy": "public",
104054
- "description": "The currently selected step index.",
104055
- "type": {
104056
- "text": "number | null"
104057
- },
104058
- "attribute": "selected-index"
104059
- },
104060
- {
104061
- "kind": "field",
104062
- "name": "_requestedSelectedIndex",
104063
- "type": {
104064
- "text": "number | null"
104065
- },
104066
- "privacy": "private",
104067
- "default": "null"
104068
- },
104069
- {
104070
- "kind": "field",
104071
- "name": "steps",
103936
+ "name": "stepper",
104072
103937
  "type": {
104073
- "text": "SbbStepElement[]"
103938
+ "text": "SbbStepperElement | null"
104074
103939
  },
104075
103940
  "privacy": "public",
104076
- "description": "The steps of the stepper.",
104077
- "readonly": true
104078
- },
104079
- {
104080
- "kind": "field",
104081
- "name": "_enabledSteps",
104082
- "type": {
104083
- "text": "SbbStepElement[]"
104084
- },
104085
- "privacy": "private",
104086
103941
  "readonly": true
104087
103942
  },
104088
103943
  {
104089
103944
  "kind": "field",
104090
- "name": "_loaded",
103945
+ "name": "disabled",
103946
+ "privacy": "public",
103947
+ "description": "Whether the component is disabled.",
103948
+ "default": "false",
104091
103949
  "type": {
104092
103950
  "text": "boolean"
104093
103951
  },
104094
- "privacy": "private",
104095
- "default": "false"
103952
+ "attribute": "disabled",
103953
+ "reflects": true,
103954
+ "inheritedFrom": {
103955
+ "name": "SbbDisabledMixin",
103956
+ "module": "core/mixins/disabled-mixin.js"
103957
+ }
104096
103958
  },
104097
103959
  {
104098
103960
  "kind": "field",
104099
- "name": "_resizeObserverTimeout",
103961
+ "name": "_previousOrientation",
104100
103962
  "type": {
104101
- "text": "ReturnType<typeof setTimeout> | null"
103963
+ "text": "string | undefined"
104102
103964
  },
104103
- "privacy": "private",
104104
- "default": "null"
103965
+ "privacy": "private"
104105
103966
  },
104106
103967
  {
104107
103968
  "kind": "field",
104108
- "name": "_mediaMatcher",
104109
- "privacy": "private",
104110
- "default": "new SbbMediaMatcherController(this, {})"
104111
- },
104112
- {
104113
- "kind": "method",
104114
- "name": "next",
104115
- "privacy": "public",
104116
- "return": {
104117
- "type": {
104118
- "text": "void"
104119
- }
104120
- },
104121
- "description": "Selects the next step."
104122
- },
104123
- {
104124
- "kind": "method",
104125
- "name": "previous",
104126
- "privacy": "public",
104127
- "return": {
104128
- "type": {
104129
- "text": "void"
104130
- }
104131
- },
104132
- "description": "Selects the previous step."
104133
- },
104134
- {
104135
- "kind": "method",
104136
- "name": "reset",
104137
- "privacy": "public",
104138
- "return": {
104139
- "type": {
104140
- "text": "void"
104141
- }
103969
+ "name": "_previousSize",
103970
+ "type": {
103971
+ "text": "string | undefined"
104142
103972
  },
104143
- "description": "Resets the form in which the stepper is nested or every form of each step, if any."
103973
+ "privacy": "private"
104144
103974
  },
104145
103975
  {
104146
103976
  "kind": "method",
104147
- "name": "_isSelectable",
103977
+ "name": "_isNotDeactivatedByLinearMode",
104148
103978
  "privacy": "private",
104149
103979
  "return": {
104150
103980
  "type": {
104151
- "text": "step is SbbStepElement"
103981
+ "text": "boolean"
104152
103982
  }
104153
103983
  },
104154
103984
  "parameters": [
104155
103985
  {
104156
103986
  "name": "step",
104157
103987
  "type": {
104158
- "text": "SbbStepElement | null"
103988
+ "text": "SbbStepElement"
104159
103989
  }
104160
103990
  }
104161
103991
  ]
104162
103992
  },
104163
103993
  {
104164
103994
  "kind": "method",
104165
- "name": "_select",
103995
+ "name": "_assignStep",
104166
103996
  "privacy": "private",
104167
103997
  "return": {
104168
103998
  "type": {
104169
103999
  "text": "void"
104170
104000
  }
104171
- },
104172
- "parameters": [
104173
- {
104174
- "name": "step",
104175
- "type": {
104176
- "text": "SbbStepElement | null"
104177
- }
104178
- }
104179
- ]
104001
+ }
104180
104002
  },
104181
104003
  {
104182
- "kind": "method",
104183
- "name": "_setMarkerSize",
104184
- "privacy": "private",
104185
- "return": {
104186
- "type": {
104187
- "text": "void"
104188
- }
104004
+ "kind": "field",
104005
+ "name": "iconName",
104006
+ "type": {
104007
+ "text": "string"
104008
+ },
104009
+ "privacy": "public",
104010
+ "default": "''",
104011
+ "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.",
104012
+ "attribute": "icon-name",
104013
+ "inheritedFrom": {
104014
+ "name": "SbbIconNameMixin",
104015
+ "module": "icon/icon-name-mixin.js"
104189
104016
  }
104190
104017
  },
104191
104018
  {
104192
104019
  "kind": "method",
104193
- "name": "_setStepperHeight",
104194
- "privacy": "private",
104020
+ "name": "renderIconSlot",
104021
+ "privacy": "protected",
104195
104022
  "return": {
104196
104023
  "type": {
104197
- "text": "void"
104024
+ "text": "TemplateResult"
104198
104025
  }
104199
104026
  },
104200
104027
  "parameters": [
104201
104028
  {
104202
- "name": "step",
104029
+ "name": "classname",
104030
+ "optional": true,
104203
104031
  "type": {
104204
- "text": "SbbStepElement | null"
104032
+ "text": "string"
104205
104033
  }
104206
104034
  }
104207
104035
  ],
104208
- "description": "Sets the stepper height based on the height of the provided step."
104209
- },
104210
- {
104211
- "kind": "method",
104212
- "name": "_calculateLabelOffsetTop",
104213
- "privacy": "private",
104214
- "return": {
104215
- "type": {
104216
- "text": "number | undefined"
104217
- }
104036
+ "inheritedFrom": {
104037
+ "name": "SbbIconNameMixin",
104038
+ "module": "icon/icon-name-mixin.js"
104218
104039
  }
104219
104040
  },
104220
104041
  {
104221
104042
  "kind": "method",
104222
- "name": "_onSelectedStepResize",
104223
- "privacy": "private",
104043
+ "name": "renderIconName",
104044
+ "privacy": "protected",
104224
104045
  "return": {
104225
104046
  "type": {
104226
- "text": "void"
104047
+ "text": "string"
104227
104048
  }
104228
104049
  },
104229
- "parameters": [
104230
- {
104231
- "name": "e",
104232
- "type": {
104233
- "text": "Event"
104234
- }
104235
- }
104236
- ]
104050
+ "inheritedFrom": {
104051
+ "name": "SbbIconNameMixin",
104052
+ "module": "icon/icon-name-mixin.js"
104053
+ }
104237
104054
  },
104238
104055
  {
104239
104056
  "kind": "method",
104240
- "name": "_configure",
104057
+ "name": "_renderIconName",
104241
104058
  "privacy": "private",
104242
104059
  "return": {
104243
104060
  "type": {
104244
- "text": "void"
104061
+ "text": "string"
104245
104062
  }
104063
+ },
104064
+ "inheritedFrom": {
104065
+ "name": "SbbIconNameMixin",
104066
+ "module": "icon/icon-name-mixin.js"
104246
104067
  }
104247
104068
  },
104248
104069
  {
104249
- "kind": "method",
104250
- "name": "_updateLabels",
104070
+ "kind": "field",
104071
+ "name": "#disabled",
104251
104072
  "privacy": "private",
104252
- "return": {
104253
- "type": {
104254
- "text": "void"
104255
- }
104073
+ "type": {
104074
+ "text": "boolean"
104075
+ },
104076
+ "default": "false",
104077
+ "inheritedFrom": {
104078
+ "name": "SbbDisabledMixin",
104079
+ "module": "core/mixins/disabled-mixin.js"
104256
104080
  }
104257
104081
  },
104258
104082
  {
104259
104083
  "kind": "method",
104260
- "name": "_checkOrientation",
104261
- "privacy": "private",
104084
+ "name": "isDisabledExternally",
104085
+ "privacy": "protected",
104262
104086
  "return": {
104263
104087
  "type": {
104264
- "text": "void"
104088
+ "text": "boolean"
104265
104089
  }
104090
+ },
104091
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
104092
+ "inheritedFrom": {
104093
+ "name": "SbbDisabledMixin",
104094
+ "module": "core/mixins/disabled-mixin.js"
104266
104095
  }
104267
104096
  },
104268
104097
  {
104269
104098
  "kind": "field",
104270
- "name": "_onStepperResize",
104271
- "privacy": "private"
104272
- },
104273
- {
104274
- "kind": "method",
104275
- "name": "_configureLinearMode",
104099
+ "name": "_elementsOnWhichEnterPressTriggersSubmit",
104100
+ "type": {
104101
+ "text": "array"
104102
+ },
104276
104103
  "privacy": "private",
104277
- "return": {
104278
- "type": {
104279
- "text": "void"
104280
- }
104104
+ "readonly": true,
104105
+ "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
104106
+ "inheritedFrom": {
104107
+ "name": "SbbButtonBaseElement",
104108
+ "module": "core/base-elements/button-base-element.js"
104281
104109
  }
104282
104110
  },
104283
104111
  {
104284
- "kind": "method",
104285
- "name": "_handleKeyDown",
104286
- "privacy": "private",
104287
- "return": {
104288
- "type": {
104289
- "text": "void"
104290
- }
104112
+ "kind": "field",
104113
+ "name": "value",
104114
+ "type": {
104115
+ "text": "string"
104291
104116
  },
104292
- "parameters": [
104293
- {
104294
- "name": "evt",
104295
- "type": {
104296
- "text": "KeyboardEvent"
104297
- }
104298
- }
104299
- ]
104117
+ "privacy": "public",
104118
+ "inheritedFrom": {
104119
+ "name": "SbbButtonBaseElement",
104120
+ "module": "core/base-elements/button-base-element.js"
104121
+ },
104122
+ "default": "''",
104123
+ "description": "Value of the form element.",
104124
+ "attribute": "value"
104300
104125
  },
104301
104126
  {
104302
104127
  "kind": "field",
104303
- "name": "_hydrationRequired",
104128
+ "name": "type",
104129
+ "privacy": "public",
104130
+ "description": "The type attribute to use for the button.",
104131
+ "default": "'button'",
104304
104132
  "type": {
104305
- "text": "boolean"
104133
+ "text": "SbbButtonType"
104306
104134
  },
104307
- "privacy": "private",
104308
- "default": "!!this.shadowRoot",
104135
+ "attribute": "type",
104309
104136
  "inheritedFrom": {
104310
- "name": "SbbHydrationMixin",
104311
- "module": "core/mixins/hydration-mixin.js"
104137
+ "name": "SbbButtonBaseElement",
104138
+ "module": "core/base-elements/button-base-element.js"
104312
104139
  }
104313
104140
  },
104314
104141
  {
104315
104142
  "kind": "field",
104316
- "name": "_hydrationComplete",
104317
- "privacy": "private",
104318
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
104143
+ "name": "form",
104144
+ "type": {
104145
+ "text": "HTMLFormElement | null"
104146
+ },
104147
+ "privacy": "public",
104148
+ "description": "The `<form>` element to associate the button with.",
104319
104149
  "inheritedFrom": {
104320
- "name": "SbbHydrationMixin",
104321
- "module": "core/mixins/hydration-mixin.js"
104322
- }
104150
+ "name": "SbbButtonBaseElement",
104151
+ "module": "core/base-elements/button-base-element.js"
104152
+ },
104153
+ "attribute": "form"
104323
104154
  },
104324
104155
  {
104325
104156
  "kind": "field",
104326
- "name": "_resolveHydration",
104157
+ "name": "_formId",
104327
104158
  "type": {
104328
- "text": "(hydrationRequired: boolean) => void"
104159
+ "text": "string"
104329
104160
  },
104330
104161
  "privacy": "private",
104162
+ "default": "''",
104331
104163
  "inheritedFrom": {
104332
- "name": "SbbHydrationMixin",
104333
- "module": "core/mixins/hydration-mixin.js"
104164
+ "name": "SbbButtonBaseElement",
104165
+ "module": "core/base-elements/button-base-element.js"
104334
104166
  }
104335
104167
  },
104336
104168
  {
104337
104169
  "kind": "field",
104338
- "name": "hydrationRequired",
104339
- "type": {
104340
- "text": "boolean"
104341
- },
104342
- "privacy": "protected",
104343
- "description": "Returns whether hydration is required and not completed.",
104344
- "readonly": true,
104170
+ "name": "_handleButtonClick",
104171
+ "privacy": "private",
104345
104172
  "inheritedFrom": {
104346
- "name": "SbbHydrationMixin",
104347
- "module": "core/mixins/hydration-mixin.js"
104348
- },
104349
- "default": "!!this.shadowRoot"
104173
+ "name": "SbbButtonBaseElement",
104174
+ "module": "core/base-elements/button-base-element.js"
104175
+ }
104350
104176
  },
104351
104177
  {
104352
104178
  "kind": "method",
104353
- "name": "toggleState",
104354
- "privacy": "protected",
104179
+ "name": "_requestSubmit",
104180
+ "privacy": "private",
104355
104181
  "return": {
104356
104182
  "type": {
104357
104183
  "text": "void"
@@ -104359,433 +104185,381 @@
104359
104185
  },
104360
104186
  "parameters": [
104361
104187
  {
104362
- "name": "value",
104363
- "type": {
104364
- "text": "string"
104365
- }
104366
- },
104367
- {
104368
- "name": "force",
104369
- "optional": true,
104188
+ "name": "form",
104370
104189
  "type": {
104371
- "text": "boolean"
104190
+ "text": "HTMLFormElement"
104372
104191
  }
104373
104192
  }
104374
104193
  ],
104375
104194
  "inheritedFrom": {
104376
- "name": "SbbElementInternalsMixin",
104377
- "module": "core/mixins/element-internals-mixin.js"
104195
+ "name": "SbbButtonBaseElement",
104196
+ "module": "core/base-elements/button-base-element.js"
104378
104197
  }
104379
- }
104380
- ],
104381
- "events": [
104198
+ },
104382
104199
  {
104383
- "type": {
104384
- "text": "SbbStepChangeEvent"
104385
- },
104386
- "description": "Emits whenever a step was changed.",
104387
- "name": "stepchange"
104388
- }
104389
- ],
104390
- "attributes": [
104200
+ "kind": "field",
104201
+ "name": "_formKeyDown",
104202
+ "privacy": "private",
104203
+ "inheritedFrom": {
104204
+ "name": "SbbButtonBaseElement",
104205
+ "module": "core/base-elements/button-base-element.js"
104206
+ }
104207
+ },
104391
104208
  {
104392
- "name": "linear",
104209
+ "kind": "field",
104210
+ "name": "formAssociated",
104393
104211
  "type": {
104394
104212
  "text": "boolean"
104395
104213
  },
104396
- "default": "false",
104397
- "description": "If set to true, only the current and previous labels can be clicked and selected.",
104398
- "fieldName": "linear"
104214
+ "privacy": "public",
104215
+ "static": true,
104216
+ "default": "true",
104217
+ "inheritedFrom": {
104218
+ "name": "SbbFormAssociatedMixin",
104219
+ "module": "core/mixins/form-associated-mixin.js"
104220
+ }
104399
104221
  },
104400
- {
104401
- "name": "horizontal-from",
104402
- "description": "Overrides the behavior of `orientation` property.",
104403
- "type": {
104404
- "text": "SbbHorizontalFrom | null"
104405
- },
104406
- "fieldName": "horizontalFrom"
104407
- },
104408
- {
104409
- "name": "orientation",
104410
- "type": {
104411
- "text": "SbbOrientation"
104412
- },
104413
- "default": "'horizontal'",
104414
- "description": "Steps orientation, either horizontal or vertical.",
104415
- "fieldName": "orientation"
104416
- },
104417
- {
104418
- "name": "size",
104419
- "type": {
104420
- "text": "'s' | 'm'"
104421
- },
104422
- "description": "Size variant, either s or m.",
104423
- "default": "'m' / 's' (lean)",
104424
- "fieldName": "size"
104425
- },
104426
- {
104427
- "name": "selected-index",
104428
- "description": "The currently selected step index.",
104429
- "type": {
104430
- "text": "number | null"
104431
- },
104432
- "fieldName": "selectedIndex"
104433
- }
104434
- ],
104435
- "mixins": [
104436
- {
104437
- "name": "SbbHydrationMixin",
104438
- "module": "core/mixins.js"
104439
- },
104440
- {
104441
- "name": "SbbElementInternalsMixin",
104442
- "module": "core/mixins.js"
104443
- }
104444
- ],
104445
- "superclass": {
104446
- "name": "LitElement",
104447
- "package": "lit"
104448
- },
104449
- "tagName": "sbb-stepper",
104450
- "customElement": true
104451
- },
104452
- {
104453
- "kind": "variable",
104454
- "name": "currentIndex"
104455
- },
104456
- {
104457
- "kind": "variable",
104458
- "name": "currentStep"
104459
- }
104460
- ],
104461
- "exports": [
104462
- {
104463
- "kind": "js",
104464
- "name": "SbbStepChangeEvent",
104465
- "declaration": {
104466
- "name": "SbbStepChangeEvent",
104467
- "module": "stepper/stepper/stepper.component.js"
104468
- }
104469
- },
104470
- {
104471
- "kind": "js",
104472
- "name": "SbbStepperElement",
104473
- "declaration": {
104474
- "name": "SbbStepperElement",
104475
- "module": "stepper/stepper/stepper.component.js"
104476
- }
104477
- },
104478
- {
104479
- "kind": "custom-element-definition",
104480
- "name": "sbb-stepper",
104481
- "declaration": {
104482
- "name": "SbbStepperElement",
104483
- "module": "stepper/stepper/stepper.component.js"
104484
- }
104485
- }
104486
- ]
104487
- },
104488
- {
104489
- "kind": "javascript-module",
104490
- "path": "stepper/step-label/step-label.component.js",
104491
- "declarations": [
104492
- {
104493
- "kind": "class",
104494
- "description": "Combined with a `sbb-stepper`, it displays a step's label.",
104495
- "name": "SbbStepLabelElement",
104496
- "slots": [
104497
- {
104498
- "description": "Use the unnamed slot to provide a label.",
104499
- "name": ""
104500
- },
104501
- {
104502
- "description": "Use this to display an icon in the label bubble.",
104503
- "name": "icon"
104504
- }
104505
- ],
104506
- "members": [
104507
104222
  {
104508
104223
  "kind": "field",
104509
- "name": "role",
104224
+ "name": "name",
104225
+ "privacy": "public",
104226
+ "description": "Name of the form element. Will be read from name attribute.",
104510
104227
  "type": {
104511
104228
  "text": "string"
104512
104229
  },
104513
- "privacy": "public",
104514
- "static": true,
104515
- "readonly": true,
104516
- "default": "'tab'",
104230
+ "attribute": "name",
104517
104231
  "inheritedFrom": {
104518
- "name": "SbbButtonLikeBaseElement",
104519
- "module": "core/base-elements/button-base-element.js"
104232
+ "name": "SbbFormAssociatedMixin",
104233
+ "module": "core/mixins/form-associated-mixin.js"
104520
104234
  }
104521
104235
  },
104522
104236
  {
104523
104237
  "kind": "field",
104524
- "name": "step",
104238
+ "name": "validity",
104525
104239
  "type": {
104526
- "text": "SbbStepElement | null"
104240
+ "text": "ValidityState"
104527
104241
  },
104528
104242
  "privacy": "public",
104529
- "description": "The step controlled by the label.",
104243
+ "description": "Returns the ValidityState object for this element.",
104530
104244
  "readonly": true,
104531
- "default": "null"
104532
- },
104533
- {
104534
- "kind": "field",
104535
- "name": "_step",
104536
- "type": {
104537
- "text": "SbbStepElement | null"
104538
- },
104539
- "privacy": "private",
104540
- "default": "null"
104245
+ "inheritedFrom": {
104246
+ "name": "SbbFormAssociatedMixin",
104247
+ "module": "core/mixins/form-associated-mixin.js"
104248
+ }
104541
104249
  },
104542
104250
  {
104543
104251
  "kind": "field",
104544
- "name": "stepper",
104252
+ "name": "validationMessage",
104545
104253
  "type": {
104546
- "text": "SbbStepperElement | null"
104254
+ "text": "string"
104547
104255
  },
104548
104256
  "privacy": "public",
104549
- "readonly": true
104257
+ "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.",
104258
+ "readonly": true,
104259
+ "inheritedFrom": {
104260
+ "name": "SbbFormAssociatedMixin",
104261
+ "module": "core/mixins/form-associated-mixin.js"
104262
+ }
104550
104263
  },
104551
104264
  {
104552
104265
  "kind": "field",
104553
- "name": "disabled",
104554
- "privacy": "public",
104555
- "description": "Whether the component is disabled.",
104556
- "default": "false",
104266
+ "name": "willValidate",
104557
104267
  "type": {
104558
104268
  "text": "boolean"
104559
104269
  },
104560
- "attribute": "disabled",
104561
- "reflects": true,
104270
+ "privacy": "public",
104271
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
104272
+ "readonly": true,
104562
104273
  "inheritedFrom": {
104563
- "name": "SbbDisabledMixin",
104564
- "module": "core/mixins/disabled-mixin.js"
104274
+ "name": "SbbFormAssociatedMixin",
104275
+ "module": "core/mixins/form-associated-mixin.js"
104565
104276
  }
104566
104277
  },
104567
104278
  {
104568
104279
  "kind": "field",
104569
- "name": "_previousOrientation",
104570
- "type": {
104571
- "text": "string | undefined"
104572
- },
104573
- "privacy": "private"
104280
+ "name": "_validityStates",
104281
+ "privacy": "private",
104282
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
104283
+ "inheritedFrom": {
104284
+ "name": "SbbFormAssociatedMixin",
104285
+ "module": "core/mixins/form-associated-mixin.js"
104286
+ }
104574
104287
  },
104575
104288
  {
104576
104289
  "kind": "field",
104577
- "name": "_previousSize",
104290
+ "name": "formDisabled",
104578
104291
  "type": {
104579
- "text": "string | undefined"
104292
+ "text": "boolean"
104580
104293
  },
104581
- "privacy": "private"
104294
+ "privacy": "protected",
104295
+ "default": "false",
104296
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
104297
+ "inheritedFrom": {
104298
+ "name": "SbbFormAssociatedMixin",
104299
+ "module": "core/mixins/form-associated-mixin.js"
104300
+ }
104582
104301
  },
104583
104302
  {
104584
104303
  "kind": "method",
104585
- "name": "_isNotDeactivatedByLinearMode",
104586
- "privacy": "private",
104304
+ "name": "checkValidity",
104305
+ "privacy": "public",
104587
104306
  "return": {
104588
104307
  "type": {
104589
104308
  "text": "boolean"
104590
104309
  }
104591
104310
  },
104592
- "parameters": [
104593
- {
104594
- "name": "step",
104595
- "type": {
104596
- "text": "SbbStepElement"
104597
- }
104598
- }
104599
- ]
104311
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
104312
+ "inheritedFrom": {
104313
+ "name": "SbbFormAssociatedMixin",
104314
+ "module": "core/mixins/form-associated-mixin.js"
104315
+ }
104600
104316
  },
104601
104317
  {
104602
104318
  "kind": "method",
104603
- "name": "_assignStep",
104604
- "privacy": "private",
104319
+ "name": "reportValidity",
104320
+ "privacy": "public",
104605
104321
  "return": {
104606
104322
  "type": {
104607
- "text": "void"
104323
+ "text": "boolean"
104608
104324
  }
104609
- }
104610
- },
104611
- {
104612
- "kind": "field",
104613
- "name": "iconName",
104614
- "type": {
104615
- "text": "string"
104616
104325
  },
104617
- "privacy": "public",
104618
- "default": "''",
104619
- "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.",
104620
- "attribute": "icon-name",
104326
+ "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.",
104621
104327
  "inheritedFrom": {
104622
- "name": "SbbIconNameMixin",
104623
- "module": "icon/icon-name-mixin.js"
104328
+ "name": "SbbFormAssociatedMixin",
104329
+ "module": "core/mixins/form-associated-mixin.js"
104624
104330
  }
104625
104331
  },
104626
104332
  {
104627
104333
  "kind": "method",
104628
- "name": "renderIconSlot",
104629
- "privacy": "protected",
104334
+ "name": "setCustomValidity",
104335
+ "privacy": "public",
104630
104336
  "return": {
104631
104337
  "type": {
104632
- "text": "TemplateResult"
104338
+ "text": "void"
104633
104339
  }
104634
104340
  },
104635
104341
  "parameters": [
104636
104342
  {
104637
- "name": "classname",
104638
- "optional": true,
104343
+ "name": "message",
104639
104344
  "type": {
104640
104345
  "text": "string"
104641
104346
  }
104642
104347
  }
104643
104348
  ],
104349
+ "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.",
104644
104350
  "inheritedFrom": {
104645
- "name": "SbbIconNameMixin",
104646
- "module": "icon/icon-name-mixin.js"
104351
+ "name": "SbbFormAssociatedMixin",
104352
+ "module": "core/mixins/form-associated-mixin.js"
104647
104353
  }
104648
104354
  },
104649
104355
  {
104650
104356
  "kind": "method",
104651
- "name": "renderIconName",
104652
- "privacy": "protected",
104357
+ "name": "_hasDisabledAncestor",
104358
+ "privacy": "private",
104653
104359
  "return": {
104654
104360
  "type": {
104655
- "text": "string"
104361
+ "text": "boolean"
104656
104362
  }
104657
104363
  },
104658
104364
  "inheritedFrom": {
104659
- "name": "SbbIconNameMixin",
104660
- "module": "icon/icon-name-mixin.js"
104365
+ "name": "SbbFormAssociatedMixin",
104366
+ "module": "core/mixins/form-associated-mixin.js"
104661
104367
  }
104662
104368
  },
104663
104369
  {
104664
104370
  "kind": "method",
104665
- "name": "_renderIconName",
104666
- "privacy": "private",
104371
+ "name": "updateFormValue",
104372
+ "privacy": "protected",
104667
104373
  "return": {
104668
104374
  "type": {
104669
- "text": "string"
104375
+ "text": "void"
104670
104376
  }
104671
104377
  },
104378
+ "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",
104672
104379
  "inheritedFrom": {
104673
- "name": "SbbIconNameMixin",
104674
- "module": "icon/icon-name-mixin.js"
104380
+ "name": "SbbFormAssociatedMixin",
104381
+ "module": "core/mixins/form-associated-mixin.js"
104675
104382
  }
104676
104383
  },
104677
104384
  {
104678
- "kind": "field",
104679
- "name": "#disabled",
104680
- "privacy": "private",
104681
- "type": {
104682
- "text": "boolean"
104385
+ "kind": "method",
104386
+ "name": "formState",
104387
+ "privacy": "protected",
104388
+ "return": {
104389
+ "type": {
104390
+ "text": "FormRestoreState"
104391
+ }
104683
104392
  },
104684
- "default": "false",
104685
104393
  "inheritedFrom": {
104686
- "name": "SbbDisabledMixin",
104687
- "module": "core/mixins/disabled-mixin.js"
104394
+ "name": "SbbFormAssociatedMixin",
104395
+ "module": "core/mixins/form-associated-mixin.js"
104688
104396
  }
104689
104397
  },
104690
104398
  {
104691
104399
  "kind": "method",
104692
- "name": "isDisabledExternally",
104400
+ "name": "setValidityFlag",
104693
104401
  "privacy": "protected",
104694
104402
  "return": {
104695
104403
  "type": {
104696
- "text": "boolean"
104404
+ "text": "void"
104697
104405
  }
104698
104406
  },
104699
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
104407
+ "parameters": [
104408
+ {
104409
+ "name": "flag",
104410
+ "type": {
104411
+ "text": "T"
104412
+ }
104413
+ },
104414
+ {
104415
+ "name": "message",
104416
+ "type": {
104417
+ "text": "string"
104418
+ }
104419
+ },
104420
+ {
104421
+ "name": "flagValue",
104422
+ "optional": true,
104423
+ "type": {
104424
+ "text": "ValidityStateFlags[T]"
104425
+ }
104426
+ }
104427
+ ],
104428
+ "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).",
104700
104429
  "inheritedFrom": {
104701
- "name": "SbbDisabledMixin",
104702
- "module": "core/mixins/disabled-mixin.js"
104430
+ "name": "SbbFormAssociatedMixin",
104431
+ "module": "core/mixins/form-associated-mixin.js"
104703
104432
  }
104704
104433
  },
104705
104434
  {
104706
- "kind": "field",
104707
- "name": "_elementsOnWhichEnterPressTriggersSubmit",
104708
- "type": {
104709
- "text": "array"
104435
+ "kind": "method",
104436
+ "name": "removeValidityFlag",
104437
+ "privacy": "protected",
104438
+ "return": {
104439
+ "type": {
104440
+ "text": "void"
104441
+ }
104710
104442
  },
104711
- "privacy": "private",
104712
- "readonly": true,
104713
- "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
104443
+ "parameters": [
104444
+ {
104445
+ "name": "flag",
104446
+ "type": {
104447
+ "text": "T"
104448
+ }
104449
+ }
104450
+ ],
104451
+ "description": "Removes the validity state flag entry and updates validity state.",
104714
104452
  "inheritedFrom": {
104715
- "name": "SbbButtonBaseElement",
104716
- "module": "core/base-elements/button-base-element.js"
104453
+ "name": "SbbFormAssociatedMixin",
104454
+ "module": "core/mixins/form-associated-mixin.js"
104717
104455
  }
104718
104456
  },
104719
104457
  {
104720
- "kind": "field",
104721
- "name": "value",
104722
- "type": {
104723
- "text": "string"
104458
+ "kind": "method",
104459
+ "name": "validate",
104460
+ "privacy": "protected",
104461
+ "return": {
104462
+ "type": {
104463
+ "text": "void"
104464
+ }
104724
104465
  },
104725
- "privacy": "public",
104466
+ "description": "To be called whenever the current element needs to be validated.",
104726
104467
  "inheritedFrom": {
104727
- "name": "SbbButtonBaseElement",
104728
- "module": "core/base-elements/button-base-element.js"
104468
+ "name": "SbbFormAssociatedMixin",
104469
+ "module": "core/mixins/form-associated-mixin.js"
104470
+ }
104471
+ },
104472
+ {
104473
+ "kind": "method",
104474
+ "name": "shouldValidate",
104475
+ "privacy": "protected",
104476
+ "return": {
104477
+ "type": {
104478
+ "text": "boolean"
104479
+ }
104729
104480
  },
104730
- "default": "''",
104731
- "description": "Value of the form element.",
104732
- "attribute": "value"
104481
+ "parameters": [
104482
+ {
104483
+ "name": "name",
104484
+ "type": {
104485
+ "text": "PropertyKey | undefined"
104486
+ }
104487
+ }
104488
+ ],
104489
+ "description": "Whether validation should be run on a property change with the given name.",
104490
+ "inheritedFrom": {
104491
+ "name": "SbbFormAssociatedMixin",
104492
+ "module": "core/mixins/form-associated-mixin.js"
104493
+ }
104733
104494
  },
104734
104495
  {
104735
- "kind": "field",
104736
- "name": "type",
104737
- "privacy": "public",
104738
- "description": "The type attribute to use for the button.",
104739
- "default": "'button'",
104740
- "type": {
104741
- "text": "SbbButtonType"
104496
+ "kind": "method",
104497
+ "name": "_setInternalValidity",
104498
+ "privacy": "private",
104499
+ "return": {
104500
+ "type": {
104501
+ "text": "void"
104502
+ }
104742
104503
  },
104743
- "attribute": "type",
104744
104504
  "inheritedFrom": {
104745
- "name": "SbbButtonBaseElement",
104505
+ "name": "SbbFormAssociatedMixin",
104506
+ "module": "core/mixins/form-associated-mixin.js"
104507
+ }
104508
+ },
104509
+ {
104510
+ "kind": "field",
104511
+ "name": "_preventScrollOnSpaceKeydown",
104512
+ "privacy": "private",
104513
+ "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
104514
+ "parameters": [
104515
+ {
104516
+ "description": "The origin event.",
104517
+ "name": "event"
104518
+ }
104519
+ ],
104520
+ "inheritedFrom": {
104521
+ "name": "SbbButtonLikeBaseElement",
104746
104522
  "module": "core/base-elements/button-base-element.js"
104747
104523
  }
104748
104524
  },
104749
104525
  {
104750
104526
  "kind": "field",
104751
- "name": "form",
104752
- "type": {
104753
- "text": "HTMLFormElement | null"
104754
- },
104755
- "privacy": "public",
104756
- "description": "The `<form>` element to associate the button with.",
104527
+ "name": "_removeActiveMarker",
104528
+ "privacy": "private",
104757
104529
  "inheritedFrom": {
104758
- "name": "SbbButtonBaseElement",
104530
+ "name": "SbbButtonLikeBaseElement",
104759
104531
  "module": "core/base-elements/button-base-element.js"
104760
- },
104761
- "attribute": "form"
104532
+ }
104762
104533
  },
104763
104534
  {
104764
104535
  "kind": "field",
104765
- "name": "_formId",
104766
- "type": {
104767
- "text": "string"
104768
- },
104536
+ "name": "_dispatchClickEventOnSpaceKeyup",
104769
104537
  "privacy": "private",
104770
- "default": "''",
104538
+ "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.",
104539
+ "parameters": [
104540
+ {
104541
+ "description": "The origin event.",
104542
+ "name": "event"
104543
+ }
104544
+ ],
104771
104545
  "inheritedFrom": {
104772
- "name": "SbbButtonBaseElement",
104546
+ "name": "SbbButtonLikeBaseElement",
104773
104547
  "module": "core/base-elements/button-base-element.js"
104774
104548
  }
104775
104549
  },
104776
104550
  {
104777
104551
  "kind": "field",
104778
- "name": "_handleButtonClick",
104552
+ "name": "_dispatchClickEvent",
104779
104553
  "privacy": "private",
104780
104554
  "inheritedFrom": {
104781
- "name": "SbbButtonBaseElement",
104555
+ "name": "SbbButtonLikeBaseElement",
104782
104556
  "module": "core/base-elements/button-base-element.js"
104783
104557
  }
104784
104558
  },
104785
104559
  {
104786
104560
  "kind": "method",
104787
- "name": "_requestSubmit",
104788
- "privacy": "private",
104561
+ "name": "toggleState",
104562
+ "privacy": "protected",
104789
104563
  "return": {
104790
104564
  "type": {
104791
104565
  "text": "void"
@@ -104793,256 +104567,510 @@
104793
104567
  },
104794
104568
  "parameters": [
104795
104569
  {
104796
- "name": "form",
104570
+ "name": "value",
104797
104571
  "type": {
104798
- "text": "HTMLFormElement"
104572
+ "text": "string"
104573
+ }
104574
+ },
104575
+ {
104576
+ "name": "force",
104577
+ "optional": true,
104578
+ "type": {
104579
+ "text": "boolean"
104799
104580
  }
104800
104581
  }
104801
104582
  ],
104802
104583
  "inheritedFrom": {
104803
- "name": "SbbButtonBaseElement",
104804
- "module": "core/base-elements/button-base-element.js"
104584
+ "name": "SbbActionBaseElement",
104585
+ "module": "core/base-elements/action-base-element.js"
104805
104586
  }
104806
104587
  },
104807
104588
  {
104808
104589
  "kind": "field",
104809
- "name": "_formKeyDown",
104810
- "privacy": "private",
104590
+ "name": "maybeDisabled",
104591
+ "type": {
104592
+ "text": "boolean | undefined"
104593
+ },
104594
+ "privacy": "protected",
104595
+ "readonly": true,
104811
104596
  "inheritedFrom": {
104812
- "name": "SbbButtonBaseElement",
104813
- "module": "core/base-elements/button-base-element.js"
104597
+ "name": "SbbActionBaseElement",
104598
+ "module": "core/base-elements/action-base-element.js"
104814
104599
  }
104815
104600
  },
104816
104601
  {
104817
104602
  "kind": "field",
104818
- "name": "formAssociated",
104603
+ "name": "maybeDisabledInteractive",
104819
104604
  "type": {
104820
- "text": "boolean"
104605
+ "text": "boolean | undefined"
104821
104606
  },
104822
- "privacy": "public",
104823
- "static": true,
104824
- "default": "true",
104607
+ "privacy": "protected",
104608
+ "readonly": true,
104825
104609
  "inheritedFrom": {
104826
- "name": "SbbFormAssociatedMixin",
104827
- "module": "core/mixins/form-associated-mixin.js"
104610
+ "name": "SbbActionBaseElement",
104611
+ "module": "core/base-elements/action-base-element.js"
104828
104612
  }
104829
104613
  },
104830
104614
  {
104831
- "kind": "field",
104832
- "name": "name",
104833
- "privacy": "public",
104834
- "description": "Name of the form element. Will be read from name attribute.",
104835
- "type": {
104836
- "text": "string"
104615
+ "kind": "method",
104616
+ "name": "setupBaseEventHandlers",
104617
+ "privacy": "protected",
104618
+ "return": {
104619
+ "type": {
104620
+ "text": "void"
104621
+ }
104837
104622
  },
104838
- "attribute": "name",
104839
104623
  "inheritedFrom": {
104840
- "name": "SbbFormAssociatedMixin",
104841
- "module": "core/mixins/form-associated-mixin.js"
104624
+ "name": "SbbActionBaseElement",
104625
+ "module": "core/base-elements/action-base-element.js"
104842
104626
  }
104843
104627
  },
104628
+ {
104629
+ "kind": "method",
104630
+ "name": "renderTemplate",
104631
+ "privacy": "protected",
104632
+ "return": {
104633
+ "type": {
104634
+ "text": "TemplateResult"
104635
+ }
104636
+ },
104637
+ "description": "Override this method to render the component template.",
104638
+ "inheritedFrom": {
104639
+ "name": "SbbActionBaseElement",
104640
+ "module": "core/base-elements/action-base-element.js"
104641
+ }
104642
+ }
104643
+ ],
104644
+ "mixins": [
104645
+ {
104646
+ "name": "SbbIconNameMixin",
104647
+ "module": "icon.js"
104648
+ },
104649
+ {
104650
+ "name": "SbbDisabledMixin",
104651
+ "module": "core/mixins.js"
104652
+ }
104653
+ ],
104654
+ "superclass": {
104655
+ "name": "SbbButtonBaseElement",
104656
+ "module": "core/base-elements.js"
104657
+ },
104658
+ "tagName": "sbb-step-label",
104659
+ "customElement": true,
104660
+ "attributes": [
104661
+ {
104662
+ "name": "icon-name",
104663
+ "type": {
104664
+ "text": "string"
104665
+ },
104666
+ "default": "''",
104667
+ "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.",
104668
+ "fieldName": "iconName",
104669
+ "inheritedFrom": {
104670
+ "name": "SbbIconNameMixin",
104671
+ "module": "icon/icon-name-mixin.js"
104672
+ }
104673
+ },
104674
+ {
104675
+ "name": "disabled",
104676
+ "description": "Whether the component is disabled.",
104677
+ "default": "false",
104678
+ "type": {
104679
+ "text": "boolean"
104680
+ },
104681
+ "fieldName": "disabled",
104682
+ "inheritedFrom": {
104683
+ "name": "SbbDisabledMixin",
104684
+ "module": "core/mixins/disabled-mixin.js"
104685
+ }
104686
+ },
104687
+ {
104688
+ "name": "value",
104689
+ "type": {
104690
+ "text": "string"
104691
+ },
104692
+ "default": "''",
104693
+ "description": "Value of the form element.",
104694
+ "fieldName": "value",
104695
+ "inheritedFrom": {
104696
+ "name": "SbbButtonBaseElement",
104697
+ "module": "core/base-elements/button-base-element.js"
104698
+ }
104699
+ },
104700
+ {
104701
+ "name": "type",
104702
+ "description": "The type attribute to use for the button.",
104703
+ "default": "'button'",
104704
+ "type": {
104705
+ "text": "SbbButtonType"
104706
+ },
104707
+ "fieldName": "type",
104708
+ "inheritedFrom": {
104709
+ "name": "SbbButtonBaseElement",
104710
+ "module": "core/base-elements/button-base-element.js"
104711
+ }
104712
+ },
104713
+ {
104714
+ "name": "form",
104715
+ "description": "The `<form>` element to associate the button with.",
104716
+ "type": {
104717
+ "text": "HTMLFormElement | null"
104718
+ },
104719
+ "fieldName": "form",
104720
+ "inheritedFrom": {
104721
+ "name": "SbbButtonBaseElement",
104722
+ "module": "core/base-elements/button-base-element.js"
104723
+ }
104724
+ },
104725
+ {
104726
+ "name": "name",
104727
+ "description": "Name of the form element. Will be read from name attribute.",
104728
+ "type": {
104729
+ "text": "string"
104730
+ },
104731
+ "fieldName": "name",
104732
+ "inheritedFrom": {
104733
+ "name": "SbbFormAssociatedMixin",
104734
+ "module": "core/mixins/form-associated-mixin.js"
104735
+ }
104736
+ }
104737
+ ]
104738
+ }
104739
+ ],
104740
+ "exports": [
104741
+ {
104742
+ "kind": "js",
104743
+ "name": "SbbStepLabelElement",
104744
+ "declaration": {
104745
+ "name": "SbbStepLabelElement",
104746
+ "module": "stepper/step-label/step-label.component.js"
104747
+ }
104748
+ },
104749
+ {
104750
+ "kind": "custom-element-definition",
104751
+ "name": "sbb-step-label",
104752
+ "declaration": {
104753
+ "name": "SbbStepLabelElement",
104754
+ "module": "stepper/step-label/step-label.component.js"
104755
+ }
104756
+ }
104757
+ ]
104758
+ },
104759
+ {
104760
+ "kind": "javascript-module",
104761
+ "path": "stepper/stepper/stepper.component.js",
104762
+ "declarations": [
104763
+ {
104764
+ "kind": "class",
104765
+ "description": "",
104766
+ "name": "SbbStepChangeEvent",
104767
+ "members": [
104768
+ {
104769
+ "kind": "field",
104770
+ "name": "selectedIndex",
104771
+ "type": {
104772
+ "text": "number | null"
104773
+ },
104774
+ "privacy": "public",
104775
+ "readonly": true,
104776
+ "description": "The index of the newly selected step.",
104777
+ "default": "selectedIndex"
104778
+ },
104779
+ {
104780
+ "kind": "field",
104781
+ "name": "previousIndex",
104782
+ "type": {
104783
+ "text": "number | null"
104784
+ },
104785
+ "privacy": "public",
104786
+ "readonly": true,
104787
+ "description": "The index of the previously selected step.",
104788
+ "default": "previousIndex"
104789
+ },
104790
+ {
104791
+ "kind": "field",
104792
+ "name": "selectedStep",
104793
+ "type": {
104794
+ "text": "SbbStepElement | null"
104795
+ },
104796
+ "privacy": "public",
104797
+ "readonly": true,
104798
+ "description": "The newly selected step element.",
104799
+ "default": "selectedStep"
104800
+ },
104801
+ {
104802
+ "kind": "field",
104803
+ "name": "previousStep",
104804
+ "type": {
104805
+ "text": "SbbStepElement | null"
104806
+ },
104807
+ "privacy": "public",
104808
+ "readonly": true,
104809
+ "description": "The previously selected step element.",
104810
+ "default": "previousStep"
104811
+ }
104812
+ ],
104813
+ "superclass": {
104814
+ "name": "Event",
104815
+ "module": "stepper/stepper/stepper.component.js"
104816
+ }
104817
+ },
104818
+ {
104819
+ "kind": "class",
104820
+ "description": "Provides a structured, step-by-step workflow for user interactions.",
104821
+ "name": "SbbStepperElement",
104822
+ "slots": [
104823
+ {
104824
+ "description": "Provide a `sbb-expansion-panel-header` and a `sbb-expansion-panel-content` to the stepper.",
104825
+ "name": ""
104826
+ },
104827
+ {
104828
+ "description": "Use this slot to provide an `sbb-step-label`.",
104829
+ "name": "step-label"
104830
+ },
104831
+ {
104832
+ "description": "Use this slot to provide an `sbb-step`.",
104833
+ "name": "step"
104834
+ }
104835
+ ],
104836
+ "members": [
104837
+ {
104838
+ "kind": "field",
104839
+ "name": "events",
104840
+ "privacy": "public",
104841
+ "static": true,
104842
+ "readonly": true,
104843
+ "default": "{ stepchange: 'stepchange', }",
104844
+ "type": {
104845
+ "text": "{\n stepchange: 'stepchange',\n }"
104846
+ }
104847
+ },
104848
+ {
104849
+ "kind": "field",
104850
+ "name": "_observer",
104851
+ "privacy": "private",
104852
+ "default": "new IntersectionController(this, { target: null, callback: (entries) => { entries.forEach((e) => { if (e.intersectionRatio > 0) { this._setStepperHeight(this.selected); this._setMarkerSize(); } }); }, })",
104853
+ "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."
104854
+ },
104855
+ {
104856
+ "kind": "field",
104857
+ "name": "linear",
104858
+ "type": {
104859
+ "text": "boolean"
104860
+ },
104861
+ "privacy": "public",
104862
+ "default": "false",
104863
+ "description": "If set to true, only the current and previous labels can be clicked and selected.",
104864
+ "attribute": "linear"
104865
+ },
104866
+ {
104867
+ "kind": "field",
104868
+ "name": "horizontalFrom",
104869
+ "privacy": "public",
104870
+ "description": "Overrides the behavior of `orientation` property.",
104871
+ "type": {
104872
+ "text": "SbbHorizontalFrom | null"
104873
+ },
104874
+ "attribute": "horizontal-from",
104875
+ "reflects": true,
104876
+ "default": "null"
104877
+ },
104878
+ {
104879
+ "kind": "field",
104880
+ "name": "_horizontalFrom",
104881
+ "type": {
104882
+ "text": "SbbHorizontalFrom | null"
104883
+ },
104884
+ "privacy": "private",
104885
+ "default": "null"
104886
+ },
104887
+ {
104888
+ "kind": "field",
104889
+ "name": "orientation",
104890
+ "type": {
104891
+ "text": "SbbOrientation"
104892
+ },
104893
+ "privacy": "public",
104894
+ "default": "'horizontal'",
104895
+ "description": "Steps orientation, either horizontal or vertical.",
104896
+ "attribute": "orientation",
104897
+ "reflects": true
104898
+ },
104899
+ {
104900
+ "kind": "field",
104901
+ "name": "size",
104902
+ "type": {
104903
+ "text": "'s' | 'm'"
104904
+ },
104905
+ "privacy": "public",
104906
+ "description": "Size variant, either s or m.",
104907
+ "default": "'m' / 's' (lean)",
104908
+ "attribute": "size",
104909
+ "reflects": true
104910
+ },
104911
+ {
104912
+ "kind": "field",
104913
+ "name": "selected",
104914
+ "privacy": "public",
104915
+ "description": "The currently selected step.",
104916
+ "type": {
104917
+ "text": "SbbStepElement | null"
104918
+ }
104919
+ },
104920
+ {
104921
+ "kind": "field",
104922
+ "name": "_requestedSelected",
104923
+ "type": {
104924
+ "text": "SbbStepElement | null"
104925
+ },
104926
+ "privacy": "private",
104927
+ "default": "null"
104928
+ },
104929
+ {
104930
+ "kind": "field",
104931
+ "name": "selectedIndex",
104932
+ "privacy": "public",
104933
+ "description": "The currently selected step index.",
104934
+ "type": {
104935
+ "text": "number | null"
104936
+ },
104937
+ "attribute": "selected-index"
104938
+ },
104939
+ {
104940
+ "kind": "field",
104941
+ "name": "_requestedSelectedIndex",
104942
+ "type": {
104943
+ "text": "number | null"
104944
+ },
104945
+ "privacy": "private",
104946
+ "default": "null"
104947
+ },
104844
104948
  {
104845
104949
  "kind": "field",
104846
- "name": "validity",
104950
+ "name": "steps",
104847
104951
  "type": {
104848
- "text": "ValidityState"
104952
+ "text": "SbbStepElement[]"
104849
104953
  },
104850
104954
  "privacy": "public",
104851
- "description": "Returns the ValidityState object for this element.",
104852
- "readonly": true,
104853
- "inheritedFrom": {
104854
- "name": "SbbFormAssociatedMixin",
104855
- "module": "core/mixins/form-associated-mixin.js"
104856
- }
104955
+ "description": "The steps of the stepper.",
104956
+ "readonly": true
104857
104957
  },
104858
104958
  {
104859
104959
  "kind": "field",
104860
- "name": "validationMessage",
104960
+ "name": "_enabledSteps",
104861
104961
  "type": {
104862
- "text": "string"
104962
+ "text": "SbbStepElement[]"
104863
104963
  },
104864
- "privacy": "public",
104865
- "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.",
104866
- "readonly": true,
104867
- "inheritedFrom": {
104868
- "name": "SbbFormAssociatedMixin",
104869
- "module": "core/mixins/form-associated-mixin.js"
104870
- }
104964
+ "privacy": "private",
104965
+ "readonly": true
104871
104966
  },
104872
104967
  {
104873
104968
  "kind": "field",
104874
- "name": "willValidate",
104969
+ "name": "_loaded",
104875
104970
  "type": {
104876
104971
  "text": "boolean"
104877
104972
  },
104878
- "privacy": "public",
104879
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
104880
- "readonly": true,
104881
- "inheritedFrom": {
104882
- "name": "SbbFormAssociatedMixin",
104883
- "module": "core/mixins/form-associated-mixin.js"
104884
- }
104973
+ "privacy": "private",
104974
+ "default": "false"
104885
104975
  },
104886
104976
  {
104887
104977
  "kind": "field",
104888
- "name": "_validityStates",
104978
+ "name": "_resizeObserverTimeout",
104979
+ "type": {
104980
+ "text": "ReturnType<typeof setTimeout> | null"
104981
+ },
104889
104982
  "privacy": "private",
104890
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
104891
- "inheritedFrom": {
104892
- "name": "SbbFormAssociatedMixin",
104893
- "module": "core/mixins/form-associated-mixin.js"
104894
- }
104983
+ "default": "null"
104895
104984
  },
104896
104985
  {
104897
104986
  "kind": "field",
104898
- "name": "formDisabled",
104899
- "type": {
104900
- "text": "boolean"
104901
- },
104902
- "privacy": "protected",
104903
- "default": "false",
104904
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
104905
- "inheritedFrom": {
104906
- "name": "SbbFormAssociatedMixin",
104907
- "module": "core/mixins/form-associated-mixin.js"
104908
- }
104987
+ "name": "_mediaMatcher",
104988
+ "privacy": "private",
104989
+ "default": "new SbbMediaMatcherController(this, {})"
104909
104990
  },
104910
104991
  {
104911
104992
  "kind": "method",
104912
- "name": "checkValidity",
104993
+ "name": "next",
104913
104994
  "privacy": "public",
104914
104995
  "return": {
104915
104996
  "type": {
104916
- "text": "boolean"
104997
+ "text": "void"
104917
104998
  }
104918
104999
  },
104919
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
104920
- "inheritedFrom": {
104921
- "name": "SbbFormAssociatedMixin",
104922
- "module": "core/mixins/form-associated-mixin.js"
104923
- }
105000
+ "description": "Selects the next step."
104924
105001
  },
104925
105002
  {
104926
105003
  "kind": "method",
104927
- "name": "reportValidity",
105004
+ "name": "previous",
104928
105005
  "privacy": "public",
104929
105006
  "return": {
104930
105007
  "type": {
104931
- "text": "boolean"
105008
+ "text": "void"
104932
105009
  }
104933
105010
  },
104934
- "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.",
104935
- "inheritedFrom": {
104936
- "name": "SbbFormAssociatedMixin",
104937
- "module": "core/mixins/form-associated-mixin.js"
104938
- }
105011
+ "description": "Selects the previous step."
104939
105012
  },
104940
105013
  {
104941
105014
  "kind": "method",
104942
- "name": "setCustomValidity",
105015
+ "name": "reset",
104943
105016
  "privacy": "public",
104944
105017
  "return": {
104945
105018
  "type": {
104946
105019
  "text": "void"
104947
105020
  }
104948
105021
  },
104949
- "parameters": [
104950
- {
104951
- "name": "message",
104952
- "type": {
104953
- "text": "string"
104954
- }
104955
- }
104956
- ],
104957
- "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.",
104958
- "inheritedFrom": {
104959
- "name": "SbbFormAssociatedMixin",
104960
- "module": "core/mixins/form-associated-mixin.js"
104961
- }
105022
+ "description": "Resets the form in which the stepper is nested or every form of each step, if any."
104962
105023
  },
104963
105024
  {
104964
105025
  "kind": "method",
104965
- "name": "_hasDisabledAncestor",
105026
+ "name": "_isSelectable",
104966
105027
  "privacy": "private",
104967
105028
  "return": {
104968
105029
  "type": {
104969
- "text": "boolean"
105030
+ "text": "step is SbbStepElement"
104970
105031
  }
104971
105032
  },
104972
- "inheritedFrom": {
104973
- "name": "SbbFormAssociatedMixin",
104974
- "module": "core/mixins/form-associated-mixin.js"
104975
- }
105033
+ "parameters": [
105034
+ {
105035
+ "name": "step",
105036
+ "type": {
105037
+ "text": "SbbStepElement | null"
105038
+ }
105039
+ }
105040
+ ]
104976
105041
  },
104977
105042
  {
104978
105043
  "kind": "method",
104979
- "name": "updateFormValue",
104980
- "privacy": "protected",
105044
+ "name": "_select",
105045
+ "privacy": "private",
104981
105046
  "return": {
104982
105047
  "type": {
104983
105048
  "text": "void"
104984
105049
  }
104985
105050
  },
104986
- "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",
104987
- "inheritedFrom": {
104988
- "name": "SbbFormAssociatedMixin",
104989
- "module": "core/mixins/form-associated-mixin.js"
104990
- }
104991
- },
104992
- {
104993
- "kind": "method",
104994
- "name": "formState",
104995
- "privacy": "protected",
104996
- "return": {
104997
- "type": {
104998
- "text": "FormRestoreState"
105051
+ "parameters": [
105052
+ {
105053
+ "name": "step",
105054
+ "type": {
105055
+ "text": "SbbStepElement | null"
105056
+ }
104999
105057
  }
105000
- },
105001
- "inheritedFrom": {
105002
- "name": "SbbFormAssociatedMixin",
105003
- "module": "core/mixins/form-associated-mixin.js"
105004
- }
105058
+ ]
105005
105059
  },
105006
105060
  {
105007
105061
  "kind": "method",
105008
- "name": "setValidityFlag",
105009
- "privacy": "protected",
105062
+ "name": "_setMarkerSize",
105063
+ "privacy": "private",
105010
105064
  "return": {
105011
105065
  "type": {
105012
105066
  "text": "void"
105013
105067
  }
105014
- },
105015
- "parameters": [
105016
- {
105017
- "name": "flag",
105018
- "type": {
105019
- "text": "T"
105020
- }
105021
- },
105022
- {
105023
- "name": "message",
105024
- "type": {
105025
- "text": "string"
105026
- }
105027
- },
105028
- {
105029
- "name": "flagValue",
105030
- "optional": true,
105031
- "type": {
105032
- "text": "ValidityStateFlags[T]"
105033
- }
105034
- }
105035
- ],
105036
- "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).",
105037
- "inheritedFrom": {
105038
- "name": "SbbFormAssociatedMixin",
105039
- "module": "core/mixins/form-associated-mixin.js"
105040
105068
  }
105041
105069
  },
105042
105070
  {
105043
105071
  "kind": "method",
105044
- "name": "removeValidityFlag",
105045
- "privacy": "protected",
105072
+ "name": "_setStepperHeight",
105073
+ "privacy": "private",
105046
105074
  "return": {
105047
105075
  "type": {
105048
105076
  "text": "void"
@@ -105050,124 +105078,91 @@
105050
105078
  },
105051
105079
  "parameters": [
105052
105080
  {
105053
- "name": "flag",
105081
+ "name": "step",
105054
105082
  "type": {
105055
- "text": "T"
105083
+ "text": "SbbStepElement | null"
105056
105084
  }
105057
105085
  }
105058
105086
  ],
105059
- "description": "Removes the validity state flag entry and updates validity state.",
105060
- "inheritedFrom": {
105061
- "name": "SbbFormAssociatedMixin",
105062
- "module": "core/mixins/form-associated-mixin.js"
105063
- }
105087
+ "description": "Sets the stepper height based on the height of the provided step."
105064
105088
  },
105065
105089
  {
105066
105090
  "kind": "method",
105067
- "name": "validate",
105068
- "privacy": "protected",
105091
+ "name": "_calculateLabelOffsetTop",
105092
+ "privacy": "private",
105069
105093
  "return": {
105070
105094
  "type": {
105071
- "text": "void"
105095
+ "text": "number | undefined"
105072
105096
  }
105073
- },
105074
- "description": "To be called whenever the current element needs to be validated.",
105075
- "inheritedFrom": {
105076
- "name": "SbbFormAssociatedMixin",
105077
- "module": "core/mixins/form-associated-mixin.js"
105078
105097
  }
105079
105098
  },
105080
105099
  {
105081
105100
  "kind": "method",
105082
- "name": "shouldValidate",
105083
- "privacy": "protected",
105101
+ "name": "_onSelectedStepResize",
105102
+ "privacy": "private",
105084
105103
  "return": {
105085
105104
  "type": {
105086
- "text": "boolean"
105105
+ "text": "void"
105087
105106
  }
105088
105107
  },
105089
105108
  "parameters": [
105090
105109
  {
105091
- "name": "name",
105110
+ "name": "e",
105092
105111
  "type": {
105093
- "text": "PropertyKey | undefined"
105112
+ "text": "Event"
105094
105113
  }
105095
105114
  }
105096
- ],
105097
- "description": "Whether validation should be run on a property change with the given name.",
105098
- "inheritedFrom": {
105099
- "name": "SbbFormAssociatedMixin",
105100
- "module": "core/mixins/form-associated-mixin.js"
105101
- }
105115
+ ]
105102
105116
  },
105103
105117
  {
105104
105118
  "kind": "method",
105105
- "name": "_setInternalValidity",
105119
+ "name": "_configure",
105106
105120
  "privacy": "private",
105107
105121
  "return": {
105108
105122
  "type": {
105109
105123
  "text": "void"
105110
105124
  }
105111
- },
105112
- "inheritedFrom": {
105113
- "name": "SbbFormAssociatedMixin",
105114
- "module": "core/mixins/form-associated-mixin.js"
105115
105125
  }
105116
105126
  },
105117
105127
  {
105118
- "kind": "field",
105119
- "name": "_preventScrollOnSpaceKeydown",
105128
+ "kind": "method",
105129
+ "name": "_updateLabels",
105120
105130
  "privacy": "private",
105121
- "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
105122
- "parameters": [
105123
- {
105124
- "description": "The origin event.",
105125
- "name": "event"
105131
+ "return": {
105132
+ "type": {
105133
+ "text": "void"
105126
105134
  }
105127
- ],
105128
- "inheritedFrom": {
105129
- "name": "SbbButtonLikeBaseElement",
105130
- "module": "core/base-elements/button-base-element.js"
105131
- }
105132
- },
105133
- {
105134
- "kind": "field",
105135
- "name": "_removeActiveMarker",
105136
- "privacy": "private",
105137
- "inheritedFrom": {
105138
- "name": "SbbButtonLikeBaseElement",
105139
- "module": "core/base-elements/button-base-element.js"
105140
105135
  }
105141
105136
  },
105142
105137
  {
105143
- "kind": "field",
105144
- "name": "_dispatchClickEventOnSpaceKeyup",
105138
+ "kind": "method",
105139
+ "name": "_checkOrientation",
105145
105140
  "privacy": "private",
105146
- "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.",
105147
- "parameters": [
105148
- {
105149
- "description": "The origin event.",
105150
- "name": "event"
105141
+ "return": {
105142
+ "type": {
105143
+ "text": "void"
105151
105144
  }
105152
- ],
105153
- "inheritedFrom": {
105154
- "name": "SbbButtonLikeBaseElement",
105155
- "module": "core/base-elements/button-base-element.js"
105156
105145
  }
105157
105146
  },
105158
105147
  {
105159
105148
  "kind": "field",
105160
- "name": "_dispatchClickEvent",
105149
+ "name": "_onStepperResize",
105150
+ "privacy": "private"
105151
+ },
105152
+ {
105153
+ "kind": "method",
105154
+ "name": "_configureLinearMode",
105161
105155
  "privacy": "private",
105162
- "inheritedFrom": {
105163
- "name": "SbbButtonLikeBaseElement",
105164
- "module": "core/base-elements/button-base-element.js"
105156
+ "return": {
105157
+ "type": {
105158
+ "text": "void"
105159
+ }
105165
105160
  }
105166
105161
  },
105167
105162
  {
105168
105163
  "kind": "method",
105169
- "name": "toggleState",
105170
- "privacy": "protected",
105164
+ "name": "_handleKeyDown",
105165
+ "privacy": "private",
105171
105166
  "return": {
105172
105167
  "type": {
105173
105168
  "text": "void"
@@ -105175,191 +105170,196 @@
105175
105170
  },
105176
105171
  "parameters": [
105177
105172
  {
105178
- "name": "value",
105179
- "type": {
105180
- "text": "string"
105181
- }
105182
- },
105183
- {
105184
- "name": "force",
105185
- "optional": true,
105173
+ "name": "evt",
105186
105174
  "type": {
105187
- "text": "boolean"
105175
+ "text": "KeyboardEvent"
105188
105176
  }
105189
105177
  }
105190
- ],
105178
+ ]
105179
+ },
105180
+ {
105181
+ "kind": "field",
105182
+ "name": "_hydrationRequired",
105183
+ "type": {
105184
+ "text": "boolean"
105185
+ },
105186
+ "privacy": "private",
105187
+ "default": "!!this.shadowRoot",
105191
105188
  "inheritedFrom": {
105192
- "name": "SbbActionBaseElement",
105193
- "module": "core/base-elements/action-base-element.js"
105189
+ "name": "SbbHydrationMixin",
105190
+ "module": "core/mixins/hydration-mixin.js"
105194
105191
  }
105195
105192
  },
105196
105193
  {
105197
105194
  "kind": "field",
105198
- "name": "maybeDisabled",
105195
+ "name": "_hydrationComplete",
105196
+ "privacy": "private",
105197
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
105198
+ "inheritedFrom": {
105199
+ "name": "SbbHydrationMixin",
105200
+ "module": "core/mixins/hydration-mixin.js"
105201
+ }
105202
+ },
105203
+ {
105204
+ "kind": "field",
105205
+ "name": "_resolveHydration",
105199
105206
  "type": {
105200
- "text": "boolean | undefined"
105207
+ "text": "(hydrationRequired: boolean) => void"
105201
105208
  },
105202
- "privacy": "protected",
105203
- "readonly": true,
105209
+ "privacy": "private",
105204
105210
  "inheritedFrom": {
105205
- "name": "SbbActionBaseElement",
105206
- "module": "core/base-elements/action-base-element.js"
105211
+ "name": "SbbHydrationMixin",
105212
+ "module": "core/mixins/hydration-mixin.js"
105207
105213
  }
105208
105214
  },
105209
105215
  {
105210
105216
  "kind": "field",
105211
- "name": "maybeDisabledInteractive",
105217
+ "name": "hydrationRequired",
105212
105218
  "type": {
105213
- "text": "boolean | undefined"
105219
+ "text": "boolean"
105214
105220
  },
105215
105221
  "privacy": "protected",
105222
+ "description": "Returns whether hydration is required and not completed.",
105216
105223
  "readonly": true,
105217
105224
  "inheritedFrom": {
105218
- "name": "SbbActionBaseElement",
105219
- "module": "core/base-elements/action-base-element.js"
105220
- }
105225
+ "name": "SbbHydrationMixin",
105226
+ "module": "core/mixins/hydration-mixin.js"
105227
+ },
105228
+ "default": "!!this.shadowRoot"
105221
105229
  },
105222
105230
  {
105223
105231
  "kind": "method",
105224
- "name": "setupBaseEventHandlers",
105232
+ "name": "toggleState",
105225
105233
  "privacy": "protected",
105226
105234
  "return": {
105227
105235
  "type": {
105228
105236
  "text": "void"
105229
105237
  }
105230
105238
  },
105231
- "inheritedFrom": {
105232
- "name": "SbbActionBaseElement",
105233
- "module": "core/base-elements/action-base-element.js"
105234
- }
105235
- },
105236
- {
105237
- "kind": "method",
105238
- "name": "renderTemplate",
105239
- "privacy": "protected",
105240
- "return": {
105241
- "type": {
105242
- "text": "TemplateResult"
105239
+ "parameters": [
105240
+ {
105241
+ "name": "value",
105242
+ "type": {
105243
+ "text": "string"
105244
+ }
105245
+ },
105246
+ {
105247
+ "name": "force",
105248
+ "optional": true,
105249
+ "type": {
105250
+ "text": "boolean"
105251
+ }
105243
105252
  }
105244
- },
105245
- "description": "Override this method to render the component template.",
105253
+ ],
105246
105254
  "inheritedFrom": {
105247
- "name": "SbbActionBaseElement",
105248
- "module": "core/base-elements/action-base-element.js"
105255
+ "name": "SbbElementInternalsMixin",
105256
+ "module": "core/mixins/element-internals-mixin.js"
105249
105257
  }
105250
105258
  }
105251
105259
  ],
105252
- "mixins": [
105253
- {
105254
- "name": "SbbIconNameMixin",
105255
- "module": "icon.js"
105256
- },
105260
+ "events": [
105257
105261
  {
105258
- "name": "SbbDisabledMixin",
105259
- "module": "core/mixins.js"
105262
+ "type": {
105263
+ "text": "SbbStepChangeEvent"
105264
+ },
105265
+ "description": "Emits whenever a step was changed.",
105266
+ "name": "stepchange"
105260
105267
  }
105261
105268
  ],
105262
- "superclass": {
105263
- "name": "SbbButtonBaseElement",
105264
- "module": "core/base-elements.js"
105265
- },
105266
- "tagName": "sbb-step-label",
105267
- "customElement": true,
105268
105269
  "attributes": [
105269
105270
  {
105270
- "name": "icon-name",
105271
+ "name": "linear",
105271
105272
  "type": {
105272
- "text": "string"
105273
+ "text": "boolean"
105273
105274
  },
105274
- "default": "''",
105275
- "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.",
105276
- "fieldName": "iconName",
105277
- "inheritedFrom": {
105278
- "name": "SbbIconNameMixin",
105279
- "module": "icon/icon-name-mixin.js"
105280
- }
105275
+ "default": "false",
105276
+ "description": "If set to true, only the current and previous labels can be clicked and selected.",
105277
+ "fieldName": "linear"
105281
105278
  },
105282
105279
  {
105283
- "name": "disabled",
105284
- "description": "Whether the component is disabled.",
105285
- "default": "false",
105280
+ "name": "horizontal-from",
105281
+ "description": "Overrides the behavior of `orientation` property.",
105286
105282
  "type": {
105287
- "text": "boolean"
105283
+ "text": "SbbHorizontalFrom | null"
105288
105284
  },
105289
- "fieldName": "disabled",
105290
- "inheritedFrom": {
105291
- "name": "SbbDisabledMixin",
105292
- "module": "core/mixins/disabled-mixin.js"
105293
- }
105285
+ "fieldName": "horizontalFrom"
105294
105286
  },
105295
105287
  {
105296
- "name": "value",
105288
+ "name": "orientation",
105297
105289
  "type": {
105298
- "text": "string"
105290
+ "text": "SbbOrientation"
105299
105291
  },
105300
- "default": "''",
105301
- "description": "Value of the form element.",
105302
- "fieldName": "value",
105303
- "inheritedFrom": {
105304
- "name": "SbbButtonBaseElement",
105305
- "module": "core/base-elements/button-base-element.js"
105306
- }
105292
+ "default": "'horizontal'",
105293
+ "description": "Steps orientation, either horizontal or vertical.",
105294
+ "fieldName": "orientation"
105307
105295
  },
105308
105296
  {
105309
- "name": "type",
105310
- "description": "The type attribute to use for the button.",
105311
- "default": "'button'",
105297
+ "name": "size",
105312
105298
  "type": {
105313
- "text": "SbbButtonType"
105299
+ "text": "'s' | 'm'"
105314
105300
  },
105315
- "fieldName": "type",
105316
- "inheritedFrom": {
105317
- "name": "SbbButtonBaseElement",
105318
- "module": "core/base-elements/button-base-element.js"
105319
- }
105301
+ "description": "Size variant, either s or m.",
105302
+ "default": "'m' / 's' (lean)",
105303
+ "fieldName": "size"
105320
105304
  },
105321
105305
  {
105322
- "name": "form",
105323
- "description": "The `<form>` element to associate the button with.",
105306
+ "name": "selected-index",
105307
+ "description": "The currently selected step index.",
105324
105308
  "type": {
105325
- "text": "HTMLFormElement | null"
105309
+ "text": "number | null"
105326
105310
  },
105327
- "fieldName": "form",
105328
- "inheritedFrom": {
105329
- "name": "SbbButtonBaseElement",
105330
- "module": "core/base-elements/button-base-element.js"
105331
- }
105311
+ "fieldName": "selectedIndex"
105312
+ }
105313
+ ],
105314
+ "mixins": [
105315
+ {
105316
+ "name": "SbbHydrationMixin",
105317
+ "module": "core/mixins.js"
105332
105318
  },
105333
105319
  {
105334
- "name": "name",
105335
- "description": "Name of the form element. Will be read from name attribute.",
105336
- "type": {
105337
- "text": "string"
105338
- },
105339
- "fieldName": "name",
105340
- "inheritedFrom": {
105341
- "name": "SbbFormAssociatedMixin",
105342
- "module": "core/mixins/form-associated-mixin.js"
105343
- }
105320
+ "name": "SbbElementInternalsMixin",
105321
+ "module": "core/mixins.js"
105344
105322
  }
105345
- ]
105323
+ ],
105324
+ "superclass": {
105325
+ "name": "LitElement",
105326
+ "package": "lit"
105327
+ },
105328
+ "tagName": "sbb-stepper",
105329
+ "customElement": true
105330
+ },
105331
+ {
105332
+ "kind": "variable",
105333
+ "name": "currentIndex"
105334
+ },
105335
+ {
105336
+ "kind": "variable",
105337
+ "name": "currentStep"
105346
105338
  }
105347
105339
  ],
105348
105340
  "exports": [
105349
105341
  {
105350
105342
  "kind": "js",
105351
- "name": "SbbStepLabelElement",
105343
+ "name": "SbbStepChangeEvent",
105352
105344
  "declaration": {
105353
- "name": "SbbStepLabelElement",
105354
- "module": "stepper/step-label/step-label.component.js"
105345
+ "name": "SbbStepChangeEvent",
105346
+ "module": "stepper/stepper/stepper.component.js"
105347
+ }
105348
+ },
105349
+ {
105350
+ "kind": "js",
105351
+ "name": "SbbStepperElement",
105352
+ "declaration": {
105353
+ "name": "SbbStepperElement",
105354
+ "module": "stepper/stepper/stepper.component.js"
105355
105355
  }
105356
105356
  },
105357
105357
  {
105358
105358
  "kind": "custom-element-definition",
105359
- "name": "sbb-step-label",
105359
+ "name": "sbb-stepper",
105360
105360
  "declaration": {
105361
- "name": "SbbStepLabelElement",
105362
- "module": "stepper/step-label/step-label.component.js"
105361
+ "name": "SbbStepperElement",
105362
+ "module": "stepper/stepper/stepper.component.js"
105363
105363
  }
105364
105364
  }
105365
105365
  ]