@sbb-esta/lyne-elements-dev 4.12.0-dev.1777535342 → 4.12.0-dev.1777543942

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/custom-elements.json +1360 -1360
  2. package/package.json +2 -2
@@ -94658,253 +94658,6 @@
94658
94658
  }
94659
94659
  ]
94660
94660
  },
94661
- {
94662
- "kind": "javascript-module",
94663
- "path": "form-field/form-field-text-counter/form-field-text-counter.component.js",
94664
- "declarations": [
94665
- {
94666
- "kind": "class",
94667
- "description": "It displays the remaining characters count for input/textarea elements with a configured\nmaxlength property in the `sbb-form-field`.\nThe component automatically uses the form field's inputElement and displays the remaining character count.\nIf the input is disabled, readonly or an `sbb-error` is present, the output is suppressed.",
94668
- "name": "SbbFormFieldTextCounterElement",
94669
- "slots": [
94670
- {
94671
- "description": "Use the unnamed slot to display a custom description text after the counter.",
94672
- "name": "",
94673
- "inheritedFrom": {
94674
- "name": "SbbHintElement",
94675
- "module": "form-field/hint/hint.component.js"
94676
- }
94677
- }
94678
- ],
94679
- "members": [
94680
- {
94681
- "kind": "field",
94682
- "name": "elementName",
94683
- "type": {
94684
- "text": "string"
94685
- },
94686
- "privacy": "public",
94687
- "static": true,
94688
- "readonly": true,
94689
- "default": "'sbb-form-field-text-counter'",
94690
- "inheritedFrom": {
94691
- "name": "SbbElement",
94692
- "module": "core/base-elements/element.js"
94693
- }
94694
- },
94695
- {
94696
- "kind": "field",
94697
- "name": "_remainingCharacters",
94698
- "type": {
94699
- "text": "number"
94700
- },
94701
- "privacy": "private",
94702
- "default": "0"
94703
- },
94704
- {
94705
- "kind": "field",
94706
- "name": "_language",
94707
- "privacy": "private",
94708
- "default": "new SbbLanguageController(this)"
94709
- },
94710
- {
94711
- "kind": "field",
94712
- "name": "_abortController",
94713
- "type": {
94714
- "text": "AbortController | null"
94715
- },
94716
- "privacy": "private",
94717
- "default": "null"
94718
- },
94719
- {
94720
- "kind": "method",
94721
- "name": "_onInputUpdate",
94722
- "privacy": "private",
94723
- "return": {
94724
- "type": {
94725
- "text": "void"
94726
- }
94727
- }
94728
- },
94729
- {
94730
- "kind": "method",
94731
- "name": "_infoText",
94732
- "privacy": "private",
94733
- "return": {
94734
- "type": {
94735
- "text": "string"
94736
- }
94737
- }
94738
- },
94739
- {
94740
- "kind": "field",
94741
- "name": "negative",
94742
- "type": {
94743
- "text": "boolean"
94744
- },
94745
- "privacy": "public",
94746
- "default": "false",
94747
- "description": "Negative coloring variant flag.",
94748
- "attribute": "negative",
94749
- "reflects": true,
94750
- "inheritedFrom": {
94751
- "name": "SbbNegativeMixin",
94752
- "module": "core/mixins/negative-mixin.js"
94753
- }
94754
- },
94755
- {
94756
- "kind": "field",
94757
- "name": "formField",
94758
- "type": {
94759
- "text": "SbbFormFieldElement | null"
94760
- },
94761
- "privacy": "protected",
94762
- "default": "null",
94763
- "inheritedFrom": {
94764
- "name": "SbbHintElement",
94765
- "module": "form-field/hint/hint.component.js"
94766
- }
94767
- },
94768
- {
94769
- "kind": "field",
94770
- "name": "_hydrationRequired",
94771
- "type": {
94772
- "text": "boolean"
94773
- },
94774
- "privacy": "private",
94775
- "default": "!!this.shadowRoot",
94776
- "inheritedFrom": {
94777
- "name": "SbbElement",
94778
- "module": "core/base-elements/element.js"
94779
- }
94780
- },
94781
- {
94782
- "kind": "field",
94783
- "name": "_hydrationComplete",
94784
- "privacy": "private",
94785
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
94786
- "inheritedFrom": {
94787
- "name": "SbbElement",
94788
- "module": "core/base-elements/element.js"
94789
- }
94790
- },
94791
- {
94792
- "kind": "field",
94793
- "name": "_resolveHydration",
94794
- "type": {
94795
- "text": "(hydrationRequired: boolean) => void"
94796
- },
94797
- "privacy": "private",
94798
- "inheritedFrom": {
94799
- "name": "SbbElement",
94800
- "module": "core/base-elements/element.js"
94801
- }
94802
- },
94803
- {
94804
- "kind": "field",
94805
- "name": "hydrationRequired",
94806
- "type": {
94807
- "text": "boolean"
94808
- },
94809
- "privacy": "protected",
94810
- "description": "Returns whether hydration is required and not completed.",
94811
- "readonly": true,
94812
- "inheritedFrom": {
94813
- "name": "SbbElement",
94814
- "module": "core/base-elements/element.js"
94815
- },
94816
- "default": "!!this.shadowRoot"
94817
- },
94818
- {
94819
- "kind": "method",
94820
- "name": "toggleState",
94821
- "privacy": "protected",
94822
- "return": {
94823
- "type": {
94824
- "text": "void"
94825
- }
94826
- },
94827
- "parameters": [
94828
- {
94829
- "name": "value",
94830
- "type": {
94831
- "text": "string"
94832
- }
94833
- },
94834
- {
94835
- "name": "force",
94836
- "optional": true,
94837
- "type": {
94838
- "text": "boolean"
94839
- }
94840
- }
94841
- ],
94842
- "inheritedFrom": {
94843
- "name": "SbbElement",
94844
- "module": "core/base-elements/element.js"
94845
- }
94846
- },
94847
- {
94848
- "kind": "field",
94849
- "name": "['_$sbbElement$']",
94850
- "type": {
94851
- "text": "boolean"
94852
- },
94853
- "privacy": "public",
94854
- "static": true,
94855
- "default": "true",
94856
- "inheritedFrom": {
94857
- "name": "SbbElement",
94858
- "module": "core/base-elements/element.js"
94859
- }
94860
- },
94861
- {
94862
- "kind": "field",
94863
- "name": "_controllers",
94864
- "type": {
94865
- "text": "Set<SbbReactiveController> | undefined"
94866
- },
94867
- "privacy": "private",
94868
- "inheritedFrom": {
94869
- "name": "SbbElement",
94870
- "module": "core/base-elements/element.js"
94871
- }
94872
- }
94873
- ],
94874
- "superclass": {
94875
- "name": "SbbHintElement",
94876
- "module": "form-field/hint/hint.component.js"
94877
- },
94878
- "tagName": "sbb-form-field-text-counter",
94879
- "customElement": true,
94880
- "attributes": [
94881
- {
94882
- "name": "negative",
94883
- "type": {
94884
- "text": "boolean"
94885
- },
94886
- "default": "false",
94887
- "description": "Negative coloring variant flag.",
94888
- "fieldName": "negative",
94889
- "inheritedFrom": {
94890
- "name": "SbbNegativeMixin",
94891
- "module": "core/mixins/negative-mixin.js"
94892
- }
94893
- }
94894
- ]
94895
- }
94896
- ],
94897
- "exports": [
94898
- {
94899
- "kind": "js",
94900
- "name": "SbbFormFieldTextCounterElement",
94901
- "declaration": {
94902
- "name": "SbbFormFieldTextCounterElement",
94903
- "module": "form-field/form-field-text-counter/form-field-text-counter.component.js"
94904
- }
94905
- }
94906
- ]
94907
- },
94908
94661
  {
94909
94662
  "kind": "javascript-module",
94910
94663
  "path": "form-field/form-field-clear/form-field-clear.component.js",
@@ -95715,17 +95468,264 @@
95715
95468
  },
95716
95469
  {
95717
95470
  "kind": "javascript-module",
95718
- "path": "form-field/hint/hint.component.js",
95471
+ "path": "form-field/form-field-text-counter/form-field-text-counter.component.js",
95719
95472
  "declarations": [
95720
95473
  {
95721
95474
  "kind": "class",
95722
- "description": "It displays a hint message in the `sbb-form-field`.",
95723
- "name": "SbbHintElement",
95475
+ "description": "It displays the remaining characters count for input/textarea elements with a configured\nmaxlength property in the `sbb-form-field`.\nThe component automatically uses the form field's inputElement and displays the remaining character count.\nIf the input is disabled, readonly or an `sbb-error` is present, the output is suppressed.",
95476
+ "name": "SbbFormFieldTextCounterElement",
95724
95477
  "slots": [
95725
95478
  {
95726
- "description": "Use the unnamed slot to display the hint message.",
95727
- "name": ""
95728
- }
95479
+ "description": "Use the unnamed slot to display a custom description text after the counter.",
95480
+ "name": "",
95481
+ "inheritedFrom": {
95482
+ "name": "SbbHintElement",
95483
+ "module": "form-field/hint/hint.component.js"
95484
+ }
95485
+ }
95486
+ ],
95487
+ "members": [
95488
+ {
95489
+ "kind": "field",
95490
+ "name": "elementName",
95491
+ "type": {
95492
+ "text": "string"
95493
+ },
95494
+ "privacy": "public",
95495
+ "static": true,
95496
+ "readonly": true,
95497
+ "default": "'sbb-form-field-text-counter'",
95498
+ "inheritedFrom": {
95499
+ "name": "SbbElement",
95500
+ "module": "core/base-elements/element.js"
95501
+ }
95502
+ },
95503
+ {
95504
+ "kind": "field",
95505
+ "name": "_remainingCharacters",
95506
+ "type": {
95507
+ "text": "number"
95508
+ },
95509
+ "privacy": "private",
95510
+ "default": "0"
95511
+ },
95512
+ {
95513
+ "kind": "field",
95514
+ "name": "_language",
95515
+ "privacy": "private",
95516
+ "default": "new SbbLanguageController(this)"
95517
+ },
95518
+ {
95519
+ "kind": "field",
95520
+ "name": "_abortController",
95521
+ "type": {
95522
+ "text": "AbortController | null"
95523
+ },
95524
+ "privacy": "private",
95525
+ "default": "null"
95526
+ },
95527
+ {
95528
+ "kind": "method",
95529
+ "name": "_onInputUpdate",
95530
+ "privacy": "private",
95531
+ "return": {
95532
+ "type": {
95533
+ "text": "void"
95534
+ }
95535
+ }
95536
+ },
95537
+ {
95538
+ "kind": "method",
95539
+ "name": "_infoText",
95540
+ "privacy": "private",
95541
+ "return": {
95542
+ "type": {
95543
+ "text": "string"
95544
+ }
95545
+ }
95546
+ },
95547
+ {
95548
+ "kind": "field",
95549
+ "name": "negative",
95550
+ "type": {
95551
+ "text": "boolean"
95552
+ },
95553
+ "privacy": "public",
95554
+ "default": "false",
95555
+ "description": "Negative coloring variant flag.",
95556
+ "attribute": "negative",
95557
+ "reflects": true,
95558
+ "inheritedFrom": {
95559
+ "name": "SbbNegativeMixin",
95560
+ "module": "core/mixins/negative-mixin.js"
95561
+ }
95562
+ },
95563
+ {
95564
+ "kind": "field",
95565
+ "name": "formField",
95566
+ "type": {
95567
+ "text": "SbbFormFieldElement | null"
95568
+ },
95569
+ "privacy": "protected",
95570
+ "default": "null",
95571
+ "inheritedFrom": {
95572
+ "name": "SbbHintElement",
95573
+ "module": "form-field/hint/hint.component.js"
95574
+ }
95575
+ },
95576
+ {
95577
+ "kind": "field",
95578
+ "name": "_hydrationRequired",
95579
+ "type": {
95580
+ "text": "boolean"
95581
+ },
95582
+ "privacy": "private",
95583
+ "default": "!!this.shadowRoot",
95584
+ "inheritedFrom": {
95585
+ "name": "SbbElement",
95586
+ "module": "core/base-elements/element.js"
95587
+ }
95588
+ },
95589
+ {
95590
+ "kind": "field",
95591
+ "name": "_hydrationComplete",
95592
+ "privacy": "private",
95593
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
95594
+ "inheritedFrom": {
95595
+ "name": "SbbElement",
95596
+ "module": "core/base-elements/element.js"
95597
+ }
95598
+ },
95599
+ {
95600
+ "kind": "field",
95601
+ "name": "_resolveHydration",
95602
+ "type": {
95603
+ "text": "(hydrationRequired: boolean) => void"
95604
+ },
95605
+ "privacy": "private",
95606
+ "inheritedFrom": {
95607
+ "name": "SbbElement",
95608
+ "module": "core/base-elements/element.js"
95609
+ }
95610
+ },
95611
+ {
95612
+ "kind": "field",
95613
+ "name": "hydrationRequired",
95614
+ "type": {
95615
+ "text": "boolean"
95616
+ },
95617
+ "privacy": "protected",
95618
+ "description": "Returns whether hydration is required and not completed.",
95619
+ "readonly": true,
95620
+ "inheritedFrom": {
95621
+ "name": "SbbElement",
95622
+ "module": "core/base-elements/element.js"
95623
+ },
95624
+ "default": "!!this.shadowRoot"
95625
+ },
95626
+ {
95627
+ "kind": "method",
95628
+ "name": "toggleState",
95629
+ "privacy": "protected",
95630
+ "return": {
95631
+ "type": {
95632
+ "text": "void"
95633
+ }
95634
+ },
95635
+ "parameters": [
95636
+ {
95637
+ "name": "value",
95638
+ "type": {
95639
+ "text": "string"
95640
+ }
95641
+ },
95642
+ {
95643
+ "name": "force",
95644
+ "optional": true,
95645
+ "type": {
95646
+ "text": "boolean"
95647
+ }
95648
+ }
95649
+ ],
95650
+ "inheritedFrom": {
95651
+ "name": "SbbElement",
95652
+ "module": "core/base-elements/element.js"
95653
+ }
95654
+ },
95655
+ {
95656
+ "kind": "field",
95657
+ "name": "['_$sbbElement$']",
95658
+ "type": {
95659
+ "text": "boolean"
95660
+ },
95661
+ "privacy": "public",
95662
+ "static": true,
95663
+ "default": "true",
95664
+ "inheritedFrom": {
95665
+ "name": "SbbElement",
95666
+ "module": "core/base-elements/element.js"
95667
+ }
95668
+ },
95669
+ {
95670
+ "kind": "field",
95671
+ "name": "_controllers",
95672
+ "type": {
95673
+ "text": "Set<SbbReactiveController> | undefined"
95674
+ },
95675
+ "privacy": "private",
95676
+ "inheritedFrom": {
95677
+ "name": "SbbElement",
95678
+ "module": "core/base-elements/element.js"
95679
+ }
95680
+ }
95681
+ ],
95682
+ "superclass": {
95683
+ "name": "SbbHintElement",
95684
+ "module": "form-field/hint/hint.component.js"
95685
+ },
95686
+ "tagName": "sbb-form-field-text-counter",
95687
+ "customElement": true,
95688
+ "attributes": [
95689
+ {
95690
+ "name": "negative",
95691
+ "type": {
95692
+ "text": "boolean"
95693
+ },
95694
+ "default": "false",
95695
+ "description": "Negative coloring variant flag.",
95696
+ "fieldName": "negative",
95697
+ "inheritedFrom": {
95698
+ "name": "SbbNegativeMixin",
95699
+ "module": "core/mixins/negative-mixin.js"
95700
+ }
95701
+ }
95702
+ ]
95703
+ }
95704
+ ],
95705
+ "exports": [
95706
+ {
95707
+ "kind": "js",
95708
+ "name": "SbbFormFieldTextCounterElement",
95709
+ "declaration": {
95710
+ "name": "SbbFormFieldTextCounterElement",
95711
+ "module": "form-field/form-field-text-counter/form-field-text-counter.component.js"
95712
+ }
95713
+ }
95714
+ ]
95715
+ },
95716
+ {
95717
+ "kind": "javascript-module",
95718
+ "path": "form-field/hint/hint.component.js",
95719
+ "declarations": [
95720
+ {
95721
+ "kind": "class",
95722
+ "description": "It displays a hint message in the `sbb-form-field`.",
95723
+ "name": "SbbHintElement",
95724
+ "slots": [
95725
+ {
95726
+ "description": "Use the unnamed slot to display the hint message.",
95727
+ "name": ""
95728
+ }
95729
95729
  ],
95730
95730
  "members": [
95731
95731
  {
@@ -121194,224 +121194,12 @@
121194
121194
  },
121195
121195
  {
121196
121196
  "kind": "javascript-module",
121197
- "path": "sidebar/sidebar-container/sidebar-container.component.js",
121197
+ "path": "sidebar/sidebar-close-button/sidebar-close-button.component.js",
121198
121198
  "declarations": [
121199
121199
  {
121200
121200
  "kind": "class",
121201
- "description": "This is the parent component to one or two `<sbb-sidebar>`s that validates the state internally\nand coordinates the backdrop and content styling.",
121202
- "name": "SbbSidebarContainerElement",
121203
- "slots": [
121204
- {
121205
- "description": "Use the unnamed slot to add `sbb-sidebar` and `sbb-sidebar-content` elements.",
121206
- "name": ""
121207
- }
121208
- ],
121209
- "members": [
121210
- {
121211
- "kind": "field",
121212
- "name": "elementName",
121213
- "type": {
121214
- "text": "string"
121215
- },
121216
- "privacy": "public",
121217
- "static": true,
121218
- "readonly": true,
121219
- "default": "'sbb-sidebar-container'",
121220
- "inheritedFrom": {
121221
- "name": "SbbElement",
121222
- "module": "core/base-elements/element.js"
121223
- }
121224
- },
121225
- {
121226
- "kind": "field",
121227
- "name": "sidebars",
121228
- "type": {
121229
- "text": "SbbSidebarElement[]"
121230
- },
121231
- "privacy": "public",
121232
- "description": "The sidebar children.",
121233
- "readonly": true
121234
- },
121235
- {
121236
- "kind": "field",
121237
- "name": "start",
121238
- "type": {
121239
- "text": "SbbSidebarElement | null"
121240
- },
121241
- "privacy": "public",
121242
- "description": "The sidebar child with the `start` position.",
121243
- "readonly": true
121244
- },
121245
- {
121246
- "kind": "field",
121247
- "name": "end",
121248
- "type": {
121249
- "text": "SbbSidebarElement | null"
121250
- },
121251
- "privacy": "public",
121252
- "description": "The sidebar child with the `end` position.",
121253
- "readonly": true
121254
- },
121255
- {
121256
- "kind": "field",
121257
- "name": "_forcedClosedSidebars",
121258
- "privacy": "private",
121259
- "default": "new WeakSet<SbbSidebarElement>()"
121260
- },
121261
- {
121262
- "kind": "method",
121263
- "name": "_handleWidthChange",
121264
- "privacy": "private",
121265
- "return": {
121266
- "type": {
121267
- "text": "void"
121268
- }
121269
- }
121270
- },
121271
- {
121272
- "kind": "method",
121273
- "name": "_calculateSpaceState",
121274
- "privacy": "private",
121275
- "return": {
121276
- "type": {
121277
- "text": "Promise<void>"
121278
- }
121279
- },
121280
- "description": "Closes and opens sidebars depending on available width\nof the container and its parent container."
121281
- },
121282
- {
121283
- "kind": "field",
121284
- "name": "_hydrationRequired",
121285
- "type": {
121286
- "text": "boolean"
121287
- },
121288
- "privacy": "private",
121289
- "default": "!!this.shadowRoot",
121290
- "inheritedFrom": {
121291
- "name": "SbbElement",
121292
- "module": "core/base-elements/element.js"
121293
- }
121294
- },
121295
- {
121296
- "kind": "field",
121297
- "name": "_hydrationComplete",
121298
- "privacy": "private",
121299
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
121300
- "inheritedFrom": {
121301
- "name": "SbbElement",
121302
- "module": "core/base-elements/element.js"
121303
- }
121304
- },
121305
- {
121306
- "kind": "field",
121307
- "name": "_resolveHydration",
121308
- "type": {
121309
- "text": "(hydrationRequired: boolean) => void"
121310
- },
121311
- "privacy": "private",
121312
- "inheritedFrom": {
121313
- "name": "SbbElement",
121314
- "module": "core/base-elements/element.js"
121315
- }
121316
- },
121317
- {
121318
- "kind": "field",
121319
- "name": "hydrationRequired",
121320
- "type": {
121321
- "text": "boolean"
121322
- },
121323
- "privacy": "protected",
121324
- "description": "Returns whether hydration is required and not completed.",
121325
- "readonly": true,
121326
- "inheritedFrom": {
121327
- "name": "SbbElement",
121328
- "module": "core/base-elements/element.js"
121329
- },
121330
- "default": "!!this.shadowRoot"
121331
- },
121332
- {
121333
- "kind": "method",
121334
- "name": "toggleState",
121335
- "privacy": "protected",
121336
- "return": {
121337
- "type": {
121338
- "text": "void"
121339
- }
121340
- },
121341
- "parameters": [
121342
- {
121343
- "name": "value",
121344
- "type": {
121345
- "text": "string"
121346
- }
121347
- },
121348
- {
121349
- "name": "force",
121350
- "optional": true,
121351
- "type": {
121352
- "text": "boolean"
121353
- }
121354
- }
121355
- ],
121356
- "inheritedFrom": {
121357
- "name": "SbbElement",
121358
- "module": "core/base-elements/element.js"
121359
- }
121360
- },
121361
- {
121362
- "kind": "field",
121363
- "name": "['_$sbbElement$']",
121364
- "type": {
121365
- "text": "boolean"
121366
- },
121367
- "privacy": "public",
121368
- "static": true,
121369
- "default": "true",
121370
- "inheritedFrom": {
121371
- "name": "SbbElement",
121372
- "module": "core/base-elements/element.js"
121373
- }
121374
- },
121375
- {
121376
- "kind": "field",
121377
- "name": "_controllers",
121378
- "type": {
121379
- "text": "Set<SbbReactiveController> | undefined"
121380
- },
121381
- "privacy": "private",
121382
- "inheritedFrom": {
121383
- "name": "SbbElement",
121384
- "module": "core/base-elements/element.js"
121385
- }
121386
- }
121387
- ],
121388
- "superclass": {
121389
- "name": "SbbElement",
121390
- "module": "core/base-elements.js"
121391
- },
121392
- "tagName": "sbb-sidebar-container",
121393
- "customElement": true
121394
- }
121395
- ],
121396
- "exports": [
121397
- {
121398
- "kind": "js",
121399
- "name": "SbbSidebarContainerElement",
121400
- "declaration": {
121401
- "name": "SbbSidebarContainerElement",
121402
- "module": "sidebar/sidebar-container/sidebar-container.component.js"
121403
- }
121404
- }
121405
- ]
121406
- },
121407
- {
121408
- "kind": "javascript-module",
121409
- "path": "sidebar/sidebar-close-button/sidebar-close-button.component.js",
121410
- "declarations": [
121411
- {
121412
- "kind": "class",
121413
- "description": "Sidebar close button, intended to be placed inside sbb-sidebar.",
121414
- "name": "SbbSidebarCloseButtonElement",
121201
+ "description": "Sidebar close button, intended to be placed inside sbb-sidebar.",
121202
+ "name": "SbbSidebarCloseButtonElement",
121415
121203
  "slots": [
121416
121204
  {
121417
121205
  "description": "Use the unnamed slot to add content to the sidebar-close-button. Not intended to be used in this context.",
@@ -122426,15 +122214,15 @@
122426
122214
  },
122427
122215
  {
122428
122216
  "kind": "javascript-module",
122429
- "path": "sidebar/sidebar-content/sidebar-content.component.js",
122217
+ "path": "sidebar/sidebar-container/sidebar-container.component.js",
122430
122218
  "declarations": [
122431
122219
  {
122432
122220
  "kind": "class",
122433
- "description": "Container for the sidebar content. Intended to be placed inside an `sbb-sidebar-container` element.",
122434
- "name": "SbbSidebarContentElement",
122221
+ "description": "This is the parent component to one or two `<sbb-sidebar>`s that validates the state internally\nand coordinates the backdrop and content styling.",
122222
+ "name": "SbbSidebarContainerElement",
122435
122223
  "slots": [
122436
122224
  {
122437
- "description": "Use the unnamed slot to add any content elements. Further `sbb-sidebar-container`s are possible.",
122225
+ "description": "Use the unnamed slot to add `sbb-sidebar` and `sbb-sidebar-content` elements.",
122438
122226
  "name": ""
122439
122227
  }
122440
122228
  ],
@@ -122448,7 +122236,7 @@
122448
122236
  "privacy": "public",
122449
122237
  "static": true,
122450
122238
  "readonly": true,
122451
- "default": "'sbb-sidebar-content'",
122239
+ "default": "'sbb-sidebar-container'",
122452
122240
  "inheritedFrom": {
122453
122241
  "name": "SbbElement",
122454
122242
  "module": "core/base-elements/element.js"
@@ -122456,36 +122244,248 @@
122456
122244
  },
122457
122245
  {
122458
122246
  "kind": "field",
122459
- "name": "_hydrationRequired",
122247
+ "name": "sidebars",
122460
122248
  "type": {
122461
- "text": "boolean"
122249
+ "text": "SbbSidebarElement[]"
122462
122250
  },
122463
- "privacy": "private",
122464
- "default": "!!this.shadowRoot",
122465
- "inheritedFrom": {
122466
- "name": "SbbElement",
122467
- "module": "core/base-elements/element.js"
122468
- }
122251
+ "privacy": "public",
122252
+ "description": "The sidebar children.",
122253
+ "readonly": true
122469
122254
  },
122470
122255
  {
122471
122256
  "kind": "field",
122472
- "name": "_hydrationComplete",
122473
- "privacy": "private",
122474
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
122475
- "inheritedFrom": {
122476
- "name": "SbbElement",
122477
- "module": "core/base-elements/element.js"
122478
- }
122257
+ "name": "start",
122258
+ "type": {
122259
+ "text": "SbbSidebarElement | null"
122260
+ },
122261
+ "privacy": "public",
122262
+ "description": "The sidebar child with the `start` position.",
122263
+ "readonly": true
122479
122264
  },
122480
122265
  {
122481
122266
  "kind": "field",
122482
- "name": "_resolveHydration",
122267
+ "name": "end",
122483
122268
  "type": {
122484
- "text": "(hydrationRequired: boolean) => void"
122269
+ "text": "SbbSidebarElement | null"
122485
122270
  },
122486
- "privacy": "private",
122487
- "inheritedFrom": {
122488
- "name": "SbbElement",
122271
+ "privacy": "public",
122272
+ "description": "The sidebar child with the `end` position.",
122273
+ "readonly": true
122274
+ },
122275
+ {
122276
+ "kind": "field",
122277
+ "name": "_forcedClosedSidebars",
122278
+ "privacy": "private",
122279
+ "default": "new WeakSet<SbbSidebarElement>()"
122280
+ },
122281
+ {
122282
+ "kind": "method",
122283
+ "name": "_handleWidthChange",
122284
+ "privacy": "private",
122285
+ "return": {
122286
+ "type": {
122287
+ "text": "void"
122288
+ }
122289
+ }
122290
+ },
122291
+ {
122292
+ "kind": "method",
122293
+ "name": "_calculateSpaceState",
122294
+ "privacy": "private",
122295
+ "return": {
122296
+ "type": {
122297
+ "text": "Promise<void>"
122298
+ }
122299
+ },
122300
+ "description": "Closes and opens sidebars depending on available width\nof the container and its parent container."
122301
+ },
122302
+ {
122303
+ "kind": "field",
122304
+ "name": "_hydrationRequired",
122305
+ "type": {
122306
+ "text": "boolean"
122307
+ },
122308
+ "privacy": "private",
122309
+ "default": "!!this.shadowRoot",
122310
+ "inheritedFrom": {
122311
+ "name": "SbbElement",
122312
+ "module": "core/base-elements/element.js"
122313
+ }
122314
+ },
122315
+ {
122316
+ "kind": "field",
122317
+ "name": "_hydrationComplete",
122318
+ "privacy": "private",
122319
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
122320
+ "inheritedFrom": {
122321
+ "name": "SbbElement",
122322
+ "module": "core/base-elements/element.js"
122323
+ }
122324
+ },
122325
+ {
122326
+ "kind": "field",
122327
+ "name": "_resolveHydration",
122328
+ "type": {
122329
+ "text": "(hydrationRequired: boolean) => void"
122330
+ },
122331
+ "privacy": "private",
122332
+ "inheritedFrom": {
122333
+ "name": "SbbElement",
122334
+ "module": "core/base-elements/element.js"
122335
+ }
122336
+ },
122337
+ {
122338
+ "kind": "field",
122339
+ "name": "hydrationRequired",
122340
+ "type": {
122341
+ "text": "boolean"
122342
+ },
122343
+ "privacy": "protected",
122344
+ "description": "Returns whether hydration is required and not completed.",
122345
+ "readonly": true,
122346
+ "inheritedFrom": {
122347
+ "name": "SbbElement",
122348
+ "module": "core/base-elements/element.js"
122349
+ },
122350
+ "default": "!!this.shadowRoot"
122351
+ },
122352
+ {
122353
+ "kind": "method",
122354
+ "name": "toggleState",
122355
+ "privacy": "protected",
122356
+ "return": {
122357
+ "type": {
122358
+ "text": "void"
122359
+ }
122360
+ },
122361
+ "parameters": [
122362
+ {
122363
+ "name": "value",
122364
+ "type": {
122365
+ "text": "string"
122366
+ }
122367
+ },
122368
+ {
122369
+ "name": "force",
122370
+ "optional": true,
122371
+ "type": {
122372
+ "text": "boolean"
122373
+ }
122374
+ }
122375
+ ],
122376
+ "inheritedFrom": {
122377
+ "name": "SbbElement",
122378
+ "module": "core/base-elements/element.js"
122379
+ }
122380
+ },
122381
+ {
122382
+ "kind": "field",
122383
+ "name": "['_$sbbElement$']",
122384
+ "type": {
122385
+ "text": "boolean"
122386
+ },
122387
+ "privacy": "public",
122388
+ "static": true,
122389
+ "default": "true",
122390
+ "inheritedFrom": {
122391
+ "name": "SbbElement",
122392
+ "module": "core/base-elements/element.js"
122393
+ }
122394
+ },
122395
+ {
122396
+ "kind": "field",
122397
+ "name": "_controllers",
122398
+ "type": {
122399
+ "text": "Set<SbbReactiveController> | undefined"
122400
+ },
122401
+ "privacy": "private",
122402
+ "inheritedFrom": {
122403
+ "name": "SbbElement",
122404
+ "module": "core/base-elements/element.js"
122405
+ }
122406
+ }
122407
+ ],
122408
+ "superclass": {
122409
+ "name": "SbbElement",
122410
+ "module": "core/base-elements.js"
122411
+ },
122412
+ "tagName": "sbb-sidebar-container",
122413
+ "customElement": true
122414
+ }
122415
+ ],
122416
+ "exports": [
122417
+ {
122418
+ "kind": "js",
122419
+ "name": "SbbSidebarContainerElement",
122420
+ "declaration": {
122421
+ "name": "SbbSidebarContainerElement",
122422
+ "module": "sidebar/sidebar-container/sidebar-container.component.js"
122423
+ }
122424
+ }
122425
+ ]
122426
+ },
122427
+ {
122428
+ "kind": "javascript-module",
122429
+ "path": "sidebar/sidebar-content/sidebar-content.component.js",
122430
+ "declarations": [
122431
+ {
122432
+ "kind": "class",
122433
+ "description": "Container for the sidebar content. Intended to be placed inside an `sbb-sidebar-container` element.",
122434
+ "name": "SbbSidebarContentElement",
122435
+ "slots": [
122436
+ {
122437
+ "description": "Use the unnamed slot to add any content elements. Further `sbb-sidebar-container`s are possible.",
122438
+ "name": ""
122439
+ }
122440
+ ],
122441
+ "members": [
122442
+ {
122443
+ "kind": "field",
122444
+ "name": "elementName",
122445
+ "type": {
122446
+ "text": "string"
122447
+ },
122448
+ "privacy": "public",
122449
+ "static": true,
122450
+ "readonly": true,
122451
+ "default": "'sbb-sidebar-content'",
122452
+ "inheritedFrom": {
122453
+ "name": "SbbElement",
122454
+ "module": "core/base-elements/element.js"
122455
+ }
122456
+ },
122457
+ {
122458
+ "kind": "field",
122459
+ "name": "_hydrationRequired",
122460
+ "type": {
122461
+ "text": "boolean"
122462
+ },
122463
+ "privacy": "private",
122464
+ "default": "!!this.shadowRoot",
122465
+ "inheritedFrom": {
122466
+ "name": "SbbElement",
122467
+ "module": "core/base-elements/element.js"
122468
+ }
122469
+ },
122470
+ {
122471
+ "kind": "field",
122472
+ "name": "_hydrationComplete",
122473
+ "privacy": "private",
122474
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
122475
+ "inheritedFrom": {
122476
+ "name": "SbbElement",
122477
+ "module": "core/base-elements/element.js"
122478
+ }
122479
+ },
122480
+ {
122481
+ "kind": "field",
122482
+ "name": "_resolveHydration",
122483
+ "type": {
122484
+ "text": "(hydrationRequired: boolean) => void"
122485
+ },
122486
+ "privacy": "private",
122487
+ "inheritedFrom": {
122488
+ "name": "SbbElement",
122489
122489
  "module": "core/base-elements/element.js"
122490
122490
  }
122491
122491
  },
@@ -123114,334 +123114,475 @@
123114
123114
  },
123115
123115
  {
123116
123116
  "kind": "javascript-module",
123117
- "path": "stepper/stepper/stepper.component.js",
123117
+ "path": "stepper/step-label/step-label.component.js",
123118
123118
  "declarations": [
123119
123119
  {
123120
123120
  "kind": "class",
123121
- "description": "",
123122
- "name": "SbbStepChangeEvent",
123121
+ "description": "Combined with a `sbb-stepper`, it displays a step's label.",
123122
+ "name": "SbbStepLabelElement",
123123
+ "slots": [
123124
+ {
123125
+ "description": "Use the unnamed slot to provide a label.",
123126
+ "name": ""
123127
+ },
123128
+ {
123129
+ "description": "Use this to display an icon in the label bubble.",
123130
+ "name": "icon"
123131
+ }
123132
+ ],
123123
123133
  "members": [
123124
123134
  {
123125
123135
  "kind": "field",
123126
- "name": "selectedIndex",
123136
+ "name": "elementName",
123127
123137
  "type": {
123128
- "text": "number | null"
123138
+ "text": "string"
123129
123139
  },
123130
123140
  "privacy": "public",
123141
+ "static": true,
123131
123142
  "readonly": true,
123132
- "description": "The index of the newly selected step.",
123133
- "default": "selectedIndex"
123143
+ "inheritedFrom": {
123144
+ "name": "SbbElement",
123145
+ "module": "core/base-elements/element.js"
123146
+ },
123147
+ "default": "'sbb-step-label'"
123134
123148
  },
123135
123149
  {
123136
123150
  "kind": "field",
123137
- "name": "previousIndex",
123151
+ "name": "role",
123138
123152
  "type": {
123139
- "text": "number | null"
123153
+ "text": "string"
123140
123154
  },
123141
123155
  "privacy": "public",
123156
+ "static": true,
123142
123157
  "readonly": true,
123143
- "description": "The index of the previously selected step.",
123144
- "default": "previousIndex"
123145
- },
123146
- {
123147
- "kind": "field",
123148
- "name": "selectedStep",
123158
+ "default": "'tab'",
123159
+ "inheritedFrom": {
123160
+ "name": "SbbButtonLikeBaseElement",
123161
+ "module": "core/base-elements/button-base-element.js"
123162
+ }
123163
+ },
123164
+ {
123165
+ "kind": "field",
123166
+ "name": "step",
123149
123167
  "type": {
123150
123168
  "text": "SbbStepElement | null"
123151
123169
  },
123152
123170
  "privacy": "public",
123171
+ "description": "The step controlled by the label.",
123153
123172
  "readonly": true,
123154
- "description": "The newly selected step element.",
123155
- "default": "selectedStep"
123173
+ "default": "null"
123156
123174
  },
123157
123175
  {
123158
123176
  "kind": "field",
123159
- "name": "previousStep",
123177
+ "name": "_step",
123160
123178
  "type": {
123161
123179
  "text": "SbbStepElement | null"
123162
123180
  },
123163
- "privacy": "public",
123164
- "readonly": true,
123165
- "description": "The previously selected step element.",
123166
- "default": "previousStep"
123167
- }
123168
- ],
123169
- "superclass": {
123170
- "name": "Event",
123171
- "module": "stepper/stepper/stepper.component.js"
123172
- }
123173
- },
123174
- {
123175
- "kind": "class",
123176
- "description": "Provides a structured, step-by-step workflow for user interactions.",
123177
- "name": "SbbStepperElement",
123178
- "slots": [
123179
- {
123180
- "description": "Provide a `sbb-expansion-panel-header` and a `sbb-expansion-panel-content` to the stepper.",
123181
- "name": ""
123182
- },
123183
- {
123184
- "description": "Use this slot to provide an `sbb-step-label`.",
123185
- "name": "step-label"
123181
+ "privacy": "private",
123182
+ "default": "null"
123186
123183
  },
123187
- {
123188
- "description": "Use this slot to provide an `sbb-step`.",
123189
- "name": "step"
123190
- }
123191
- ],
123192
- "members": [
123193
123184
  {
123194
123185
  "kind": "field",
123195
- "name": "elementName",
123186
+ "name": "stepper",
123196
123187
  "type": {
123197
- "text": "string"
123188
+ "text": "SbbStepperElement | null"
123198
123189
  },
123199
123190
  "privacy": "public",
123200
- "static": true,
123201
- "readonly": true,
123202
- "default": "'sbb-stepper'",
123203
- "inheritedFrom": {
123204
- "name": "SbbElement",
123205
- "module": "core/base-elements/element.js"
123206
- }
123191
+ "readonly": true
123207
123192
  },
123208
123193
  {
123209
123194
  "kind": "field",
123210
- "name": "events",
123195
+ "name": "disabled",
123211
123196
  "privacy": "public",
123212
- "static": true,
123213
- "readonly": true,
123214
- "default": "{ stepchange: 'stepchange', }",
123197
+ "description": "Whether the component is disabled.",
123198
+ "default": "false",
123215
123199
  "type": {
123216
- "text": "{\n stepchange: 'stepchange',\n }"
123200
+ "text": "boolean"
123201
+ },
123202
+ "attribute": "disabled",
123203
+ "reflects": true,
123204
+ "inheritedFrom": {
123205
+ "name": "SbbDisabledMixin",
123206
+ "module": "core/mixins/disabled-mixin.js"
123217
123207
  }
123218
123208
  },
123219
123209
  {
123220
123210
  "kind": "field",
123221
- "name": "_observer",
123222
- "privacy": "private",
123223
- "default": "new IntersectionController(this, { target: null, callback: (entries) => { entries.forEach((e) => { if (e.intersectionRatio > 0) { this._setStepperHeight(this.selected); this._setMarkerSize(); } }); }, })",
123224
- "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."
123225
- },
123226
- {
123227
- "kind": "field",
123228
- "name": "linear",
123211
+ "name": "_previousOrientation",
123229
123212
  "type": {
123230
- "text": "boolean"
123213
+ "text": "string | undefined"
123231
123214
  },
123232
- "privacy": "public",
123233
- "default": "false",
123234
- "description": "If set to true, only the current and previous labels can be clicked and selected.",
123235
- "attribute": "linear"
123215
+ "privacy": "private"
123236
123216
  },
123237
123217
  {
123238
123218
  "kind": "field",
123239
- "name": "horizontalFrom",
123240
- "privacy": "public",
123241
- "description": "Overrides the behavior of `orientation` property.",
123219
+ "name": "_previousSize",
123242
123220
  "type": {
123243
- "text": "SbbHorizontalFrom | null"
123221
+ "text": "string | undefined"
123244
123222
  },
123245
- "attribute": "horizontal-from",
123246
- "reflects": true,
123247
- "default": "null"
123223
+ "privacy": "private"
123248
123224
  },
123249
123225
  {
123250
- "kind": "field",
123251
- "name": "_horizontalFrom",
123252
- "type": {
123253
- "text": "SbbHorizontalFrom | null"
123226
+ "kind": "method",
123227
+ "name": "_isNotDeactivatedByLinearMode",
123228
+ "privacy": "private",
123229
+ "return": {
123230
+ "type": {
123231
+ "text": "boolean"
123232
+ }
123254
123233
  },
123234
+ "parameters": [
123235
+ {
123236
+ "name": "step",
123237
+ "type": {
123238
+ "text": "SbbStepElement"
123239
+ }
123240
+ }
123241
+ ]
123242
+ },
123243
+ {
123244
+ "kind": "method",
123245
+ "name": "_assignStep",
123255
123246
  "privacy": "private",
123256
- "default": "null"
123247
+ "return": {
123248
+ "type": {
123249
+ "text": "void"
123250
+ }
123251
+ }
123257
123252
  },
123258
123253
  {
123259
123254
  "kind": "field",
123260
- "name": "orientation",
123255
+ "name": "iconName",
123261
123256
  "type": {
123262
- "text": "SbbOrientation"
123257
+ "text": "string"
123263
123258
  },
123264
123259
  "privacy": "public",
123265
- "default": "'horizontal'",
123266
- "description": "Steps orientation, either horizontal or vertical.",
123267
- "attribute": "orientation",
123268
- "reflects": true
123260
+ "default": "''",
123261
+ "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.",
123262
+ "attribute": "icon-name",
123263
+ "inheritedFrom": {
123264
+ "name": "SbbIconNameMixin",
123265
+ "module": "icon/icon-name-mixin.js"
123266
+ }
123269
123267
  },
123270
123268
  {
123271
- "kind": "field",
123272
- "name": "size",
123273
- "type": {
123274
- "text": "'s' | 'm'"
123269
+ "kind": "method",
123270
+ "name": "renderIconSlot",
123271
+ "privacy": "protected",
123272
+ "return": {
123273
+ "type": {
123274
+ "text": "TemplateResult"
123275
+ }
123275
123276
  },
123276
- "privacy": "public",
123277
- "description": "Size variant, either s or m.",
123278
- "default": "'m' / 's' (lean)",
123279
- "attribute": "size",
123280
- "reflects": true
123277
+ "parameters": [
123278
+ {
123279
+ "name": "classname",
123280
+ "optional": true,
123281
+ "type": {
123282
+ "text": "string"
123283
+ }
123284
+ }
123285
+ ],
123286
+ "inheritedFrom": {
123287
+ "name": "SbbIconNameMixin",
123288
+ "module": "icon/icon-name-mixin.js"
123289
+ }
123281
123290
  },
123282
123291
  {
123283
- "kind": "field",
123284
- "name": "selected",
123285
- "privacy": "public",
123286
- "description": "The currently selected step.",
123287
- "type": {
123288
- "text": "SbbStepElement | null"
123292
+ "kind": "method",
123293
+ "name": "renderIconName",
123294
+ "privacy": "protected",
123295
+ "return": {
123296
+ "type": {
123297
+ "text": "string"
123298
+ }
123299
+ },
123300
+ "inheritedFrom": {
123301
+ "name": "SbbIconNameMixin",
123302
+ "module": "icon/icon-name-mixin.js"
123289
123303
  }
123290
123304
  },
123291
123305
  {
123292
- "kind": "field",
123293
- "name": "_requestedSelected",
123294
- "type": {
123295
- "text": "SbbStepElement | null"
123296
- },
123306
+ "kind": "method",
123307
+ "name": "_renderIconName",
123297
123308
  "privacy": "private",
123298
- "default": "null"
123309
+ "return": {
123310
+ "type": {
123311
+ "text": "string"
123312
+ }
123313
+ },
123314
+ "inheritedFrom": {
123315
+ "name": "SbbIconNameMixin",
123316
+ "module": "icon/icon-name-mixin.js"
123317
+ }
123299
123318
  },
123300
123319
  {
123301
123320
  "kind": "field",
123302
- "name": "selectedIndex",
123303
- "privacy": "public",
123304
- "description": "The currently selected step index.",
123321
+ "name": "#disabled",
123322
+ "privacy": "private",
123305
123323
  "type": {
123306
- "text": "number | null"
123324
+ "text": "boolean"
123307
123325
  },
123308
- "attribute": "selected-index"
123326
+ "default": "false",
123327
+ "inheritedFrom": {
123328
+ "name": "SbbDisabledMixin",
123329
+ "module": "core/mixins/disabled-mixin.js"
123330
+ }
123309
123331
  },
123310
123332
  {
123311
- "kind": "field",
123312
- "name": "_requestedSelectedIndex",
123313
- "type": {
123314
- "text": "number | null"
123333
+ "kind": "method",
123334
+ "name": "isDisabledExternally",
123335
+ "privacy": "protected",
123336
+ "return": {
123337
+ "type": {
123338
+ "text": "boolean"
123339
+ }
123315
123340
  },
123316
- "privacy": "private",
123317
- "default": "null"
123341
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
123342
+ "inheritedFrom": {
123343
+ "name": "SbbDisabledMixin",
123344
+ "module": "core/mixins/disabled-mixin.js"
123345
+ }
123318
123346
  },
123319
123347
  {
123320
123348
  "kind": "field",
123321
- "name": "steps",
123349
+ "name": "_elementsOnWhichEnterPressTriggersSubmit",
123322
123350
  "type": {
123323
- "text": "SbbStepElement[]"
123351
+ "text": "array"
123324
123352
  },
123325
- "privacy": "public",
123326
- "description": "The steps of the stepper.",
123327
- "readonly": true
123353
+ "privacy": "private",
123354
+ "readonly": true,
123355
+ "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
123356
+ "inheritedFrom": {
123357
+ "name": "SbbButtonBaseElement",
123358
+ "module": "core/base-elements/button-base-element.js"
123359
+ }
123328
123360
  },
123329
123361
  {
123330
123362
  "kind": "field",
123331
- "name": "_enabledSteps",
123363
+ "name": "value",
123332
123364
  "type": {
123333
- "text": "SbbStepElement[]"
123365
+ "text": "string"
123334
123366
  },
123335
- "privacy": "private",
123336
- "readonly": true
123367
+ "privacy": "public",
123368
+ "inheritedFrom": {
123369
+ "name": "SbbButtonBaseElement",
123370
+ "module": "core/base-elements/button-base-element.js"
123371
+ },
123372
+ "default": "''",
123373
+ "description": "Value of the form element.",
123374
+ "attribute": "value"
123337
123375
  },
123338
123376
  {
123339
123377
  "kind": "field",
123340
- "name": "_loaded",
123378
+ "name": "type",
123379
+ "privacy": "public",
123380
+ "description": "The type attribute to use for the button.",
123381
+ "default": "'button'",
123341
123382
  "type": {
123342
- "text": "boolean"
123383
+ "text": "SbbButtonType"
123343
123384
  },
123344
- "privacy": "private",
123345
- "default": "false"
123385
+ "attribute": "type",
123386
+ "inheritedFrom": {
123387
+ "name": "SbbButtonBaseElement",
123388
+ "module": "core/base-elements/button-base-element.js"
123389
+ }
123346
123390
  },
123347
123391
  {
123348
123392
  "kind": "field",
123349
- "name": "_resizeObserverTimeout",
123393
+ "name": "form",
123350
123394
  "type": {
123351
- "text": "ReturnType<typeof setTimeout> | null"
123395
+ "text": "HTMLFormElement | null"
123396
+ },
123397
+ "privacy": "public",
123398
+ "description": "The `<form>` element to associate the button with.",
123399
+ "inheritedFrom": {
123400
+ "name": "SbbButtonBaseElement",
123401
+ "module": "core/base-elements/button-base-element.js"
123402
+ },
123403
+ "attribute": "form"
123404
+ },
123405
+ {
123406
+ "kind": "field",
123407
+ "name": "_formId",
123408
+ "type": {
123409
+ "text": "string"
123352
123410
  },
123353
123411
  "privacy": "private",
123354
- "default": "null"
123412
+ "default": "''",
123413
+ "inheritedFrom": {
123414
+ "name": "SbbButtonBaseElement",
123415
+ "module": "core/base-elements/button-base-element.js"
123416
+ }
123355
123417
  },
123356
123418
  {
123357
123419
  "kind": "field",
123358
- "name": "_mediaMatcher",
123420
+ "name": "_handleButtonClick",
123359
123421
  "privacy": "private",
123360
- "default": "new SbbMediaMatcherController(this, {})"
123422
+ "inheritedFrom": {
123423
+ "name": "SbbButtonBaseElement",
123424
+ "module": "core/base-elements/button-base-element.js"
123425
+ }
123361
123426
  },
123362
123427
  {
123363
123428
  "kind": "method",
123364
- "name": "next",
123365
- "privacy": "public",
123429
+ "name": "_requestSubmit",
123430
+ "privacy": "private",
123366
123431
  "return": {
123367
123432
  "type": {
123368
123433
  "text": "void"
123369
123434
  }
123370
123435
  },
123371
- "description": "Selects the next step."
123436
+ "parameters": [
123437
+ {
123438
+ "name": "form",
123439
+ "type": {
123440
+ "text": "HTMLFormElement"
123441
+ }
123442
+ }
123443
+ ],
123444
+ "inheritedFrom": {
123445
+ "name": "SbbButtonBaseElement",
123446
+ "module": "core/base-elements/button-base-element.js"
123447
+ }
123372
123448
  },
123373
123449
  {
123374
- "kind": "method",
123375
- "name": "previous",
123450
+ "kind": "field",
123451
+ "name": "_formKeyDown",
123452
+ "privacy": "private",
123453
+ "inheritedFrom": {
123454
+ "name": "SbbButtonBaseElement",
123455
+ "module": "core/base-elements/button-base-element.js"
123456
+ }
123457
+ },
123458
+ {
123459
+ "kind": "field",
123460
+ "name": "formAssociated",
123461
+ "type": {
123462
+ "text": "boolean"
123463
+ },
123376
123464
  "privacy": "public",
123377
- "return": {
123378
- "type": {
123379
- "text": "void"
123380
- }
123465
+ "static": true,
123466
+ "default": "true",
123467
+ "inheritedFrom": {
123468
+ "name": "SbbFormAssociatedMixin",
123469
+ "module": "core/mixins/form-associated-mixin.js"
123470
+ }
123471
+ },
123472
+ {
123473
+ "kind": "field",
123474
+ "name": "name",
123475
+ "privacy": "public",
123476
+ "description": "Name of the form element. Will be read from name attribute.",
123477
+ "type": {
123478
+ "text": "string"
123381
123479
  },
123382
- "description": "Selects the previous step."
123480
+ "attribute": "name",
123481
+ "inheritedFrom": {
123482
+ "name": "SbbFormAssociatedMixin",
123483
+ "module": "core/mixins/form-associated-mixin.js"
123484
+ }
123383
123485
  },
123384
123486
  {
123385
- "kind": "method",
123386
- "name": "reset",
123487
+ "kind": "field",
123488
+ "name": "validity",
123489
+ "type": {
123490
+ "text": "ValidityState"
123491
+ },
123387
123492
  "privacy": "public",
123388
- "return": {
123389
- "type": {
123390
- "text": "void"
123391
- }
123493
+ "description": "Returns the ValidityState object for this element.",
123494
+ "readonly": true,
123495
+ "inheritedFrom": {
123496
+ "name": "SbbFormAssociatedMixin",
123497
+ "module": "core/mixins/form-associated-mixin.js"
123498
+ }
123499
+ },
123500
+ {
123501
+ "kind": "field",
123502
+ "name": "validationMessage",
123503
+ "type": {
123504
+ "text": "string"
123392
123505
  },
123393
- "description": "Resets the form in which the stepper is nested or every form of each step, if any."
123506
+ "privacy": "public",
123507
+ "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.",
123508
+ "readonly": true,
123509
+ "inheritedFrom": {
123510
+ "name": "SbbFormAssociatedMixin",
123511
+ "module": "core/mixins/form-associated-mixin.js"
123512
+ }
123394
123513
  },
123395
123514
  {
123396
- "kind": "method",
123397
- "name": "_isSelectable",
123515
+ "kind": "field",
123516
+ "name": "willValidate",
123517
+ "type": {
123518
+ "text": "boolean"
123519
+ },
123520
+ "privacy": "public",
123521
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
123522
+ "readonly": true,
123523
+ "inheritedFrom": {
123524
+ "name": "SbbFormAssociatedMixin",
123525
+ "module": "core/mixins/form-associated-mixin.js"
123526
+ }
123527
+ },
123528
+ {
123529
+ "kind": "field",
123530
+ "name": "_validityStates",
123398
123531
  "privacy": "private",
123399
- "return": {
123400
- "type": {
123401
- "text": "step is SbbStepElement"
123402
- }
123532
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
123533
+ "inheritedFrom": {
123534
+ "name": "SbbFormAssociatedMixin",
123535
+ "module": "core/mixins/form-associated-mixin.js"
123536
+ }
123537
+ },
123538
+ {
123539
+ "kind": "field",
123540
+ "name": "formDisabled",
123541
+ "type": {
123542
+ "text": "boolean"
123403
123543
  },
123404
- "parameters": [
123405
- {
123406
- "name": "step",
123407
- "type": {
123408
- "text": "SbbStepElement | null"
123409
- }
123410
- }
123411
- ]
123544
+ "privacy": "protected",
123545
+ "default": "false",
123546
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
123547
+ "inheritedFrom": {
123548
+ "name": "SbbFormAssociatedMixin",
123549
+ "module": "core/mixins/form-associated-mixin.js"
123550
+ }
123412
123551
  },
123413
123552
  {
123414
123553
  "kind": "method",
123415
- "name": "_select",
123416
- "privacy": "private",
123554
+ "name": "checkValidity",
123555
+ "privacy": "public",
123417
123556
  "return": {
123418
123557
  "type": {
123419
- "text": "void"
123558
+ "text": "boolean"
123420
123559
  }
123421
123560
  },
123422
- "parameters": [
123423
- {
123424
- "name": "step",
123425
- "type": {
123426
- "text": "SbbStepElement | null"
123427
- }
123428
- }
123429
- ]
123561
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
123562
+ "inheritedFrom": {
123563
+ "name": "SbbFormAssociatedMixin",
123564
+ "module": "core/mixins/form-associated-mixin.js"
123565
+ }
123430
123566
  },
123431
123567
  {
123432
123568
  "kind": "method",
123433
- "name": "_setMarkerSize",
123434
- "privacy": "private",
123569
+ "name": "reportValidity",
123570
+ "privacy": "public",
123435
123571
  "return": {
123436
123572
  "type": {
123437
- "text": "void"
123573
+ "text": "boolean"
123438
123574
  }
123575
+ },
123576
+ "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.",
123577
+ "inheritedFrom": {
123578
+ "name": "SbbFormAssociatedMixin",
123579
+ "module": "core/mixins/form-associated-mixin.js"
123439
123580
  }
123440
123581
  },
123441
123582
  {
123442
123583
  "kind": "method",
123443
- "name": "_setStepperHeight",
123444
- "privacy": "private",
123584
+ "name": "setCustomValidity",
123585
+ "privacy": "public",
123445
123586
  "return": {
123446
123587
  "type": {
123447
123588
  "text": "void"
@@ -123449,104 +123590,276 @@
123449
123590
  },
123450
123591
  "parameters": [
123451
123592
  {
123452
- "name": "step",
123593
+ "name": "message",
123453
123594
  "type": {
123454
- "text": "SbbStepElement | null"
123595
+ "text": "string"
123455
123596
  }
123456
123597
  }
123457
123598
  ],
123458
- "description": "Sets the stepper height based on the height of the provided step."
123599
+ "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.",
123600
+ "inheritedFrom": {
123601
+ "name": "SbbFormAssociatedMixin",
123602
+ "module": "core/mixins/form-associated-mixin.js"
123603
+ }
123459
123604
  },
123460
123605
  {
123461
123606
  "kind": "method",
123462
- "name": "_calculateLabelOffsetTop",
123607
+ "name": "_hasDisabledAncestor",
123463
123608
  "privacy": "private",
123464
123609
  "return": {
123465
123610
  "type": {
123466
- "text": "number | undefined"
123611
+ "text": "boolean"
123467
123612
  }
123613
+ },
123614
+ "inheritedFrom": {
123615
+ "name": "SbbFormAssociatedMixin",
123616
+ "module": "core/mixins/form-associated-mixin.js"
123468
123617
  }
123469
123618
  },
123470
123619
  {
123471
123620
  "kind": "method",
123472
- "name": "_onSelectedStepResize",
123473
- "privacy": "private",
123621
+ "name": "updateFormValue",
123622
+ "privacy": "protected",
123474
123623
  "return": {
123475
123624
  "type": {
123476
123625
  "text": "void"
123477
123626
  }
123478
123627
  },
123479
- "parameters": [
123480
- {
123481
- "name": "e",
123482
- "type": {
123483
- "text": "Event"
123484
- }
123485
- }
123486
- ]
123487
- },
123628
+ "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",
123629
+ "inheritedFrom": {
123630
+ "name": "SbbFormAssociatedMixin",
123631
+ "module": "core/mixins/form-associated-mixin.js"
123632
+ }
123633
+ },
123488
123634
  {
123489
123635
  "kind": "method",
123490
- "name": "_configure",
123491
- "privacy": "private",
123636
+ "name": "formState",
123637
+ "privacy": "protected",
123492
123638
  "return": {
123493
123639
  "type": {
123494
- "text": "void"
123640
+ "text": "FormRestoreState"
123495
123641
  }
123642
+ },
123643
+ "inheritedFrom": {
123644
+ "name": "SbbFormAssociatedMixin",
123645
+ "module": "core/mixins/form-associated-mixin.js"
123496
123646
  }
123497
123647
  },
123498
123648
  {
123499
123649
  "kind": "method",
123500
- "name": "_updateLabels",
123501
- "privacy": "private",
123650
+ "name": "setValidityFlag",
123651
+ "privacy": "protected",
123502
123652
  "return": {
123503
123653
  "type": {
123504
123654
  "text": "void"
123505
123655
  }
123656
+ },
123657
+ "parameters": [
123658
+ {
123659
+ "name": "flag",
123660
+ "type": {
123661
+ "text": "T"
123662
+ }
123663
+ },
123664
+ {
123665
+ "name": "message",
123666
+ "type": {
123667
+ "text": "string"
123668
+ }
123669
+ },
123670
+ {
123671
+ "name": "flagValue",
123672
+ "optional": true,
123673
+ "type": {
123674
+ "text": "ValidityStateFlags[T]"
123675
+ }
123676
+ }
123677
+ ],
123678
+ "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).",
123679
+ "inheritedFrom": {
123680
+ "name": "SbbFormAssociatedMixin",
123681
+ "module": "core/mixins/form-associated-mixin.js"
123506
123682
  }
123507
123683
  },
123508
123684
  {
123509
123685
  "kind": "method",
123510
- "name": "_checkOrientation",
123511
- "privacy": "private",
123686
+ "name": "removeValidityFlag",
123687
+ "privacy": "protected",
123512
123688
  "return": {
123513
123689
  "type": {
123514
123690
  "text": "void"
123515
123691
  }
123692
+ },
123693
+ "parameters": [
123694
+ {
123695
+ "name": "flag",
123696
+ "type": {
123697
+ "text": "T"
123698
+ }
123699
+ }
123700
+ ],
123701
+ "description": "Removes the validity state flag entry and updates validity state.",
123702
+ "inheritedFrom": {
123703
+ "name": "SbbFormAssociatedMixin",
123704
+ "module": "core/mixins/form-associated-mixin.js"
123516
123705
  }
123517
123706
  },
123518
123707
  {
123519
- "kind": "field",
123520
- "name": "_onStepperResize",
123521
- "privacy": "private"
123708
+ "kind": "method",
123709
+ "name": "validate",
123710
+ "privacy": "protected",
123711
+ "return": {
123712
+ "type": {
123713
+ "text": "void"
123714
+ }
123715
+ },
123716
+ "description": "To be called whenever the current element needs to be validated.",
123717
+ "inheritedFrom": {
123718
+ "name": "SbbFormAssociatedMixin",
123719
+ "module": "core/mixins/form-associated-mixin.js"
123720
+ }
123522
123721
  },
123523
123722
  {
123524
123723
  "kind": "method",
123525
- "name": "_configureLinearMode",
123526
- "privacy": "private",
123724
+ "name": "shouldValidate",
123725
+ "privacy": "protected",
123527
123726
  "return": {
123528
123727
  "type": {
123529
- "text": "void"
123728
+ "text": "boolean"
123729
+ }
123730
+ },
123731
+ "parameters": [
123732
+ {
123733
+ "name": "name",
123734
+ "type": {
123735
+ "text": "PropertyKey | undefined"
123736
+ }
123530
123737
  }
123738
+ ],
123739
+ "description": "Whether validation should be run on a property change with the given name.",
123740
+ "inheritedFrom": {
123741
+ "name": "SbbFormAssociatedMixin",
123742
+ "module": "core/mixins/form-associated-mixin.js"
123531
123743
  }
123532
123744
  },
123533
123745
  {
123534
123746
  "kind": "method",
123535
- "name": "_handleKeyDown",
123747
+ "name": "_setInternalValidity",
123536
123748
  "privacy": "private",
123537
123749
  "return": {
123538
123750
  "type": {
123539
123751
  "text": "void"
123540
123752
  }
123541
123753
  },
123754
+ "inheritedFrom": {
123755
+ "name": "SbbFormAssociatedMixin",
123756
+ "module": "core/mixins/form-associated-mixin.js"
123757
+ }
123758
+ },
123759
+ {
123760
+ "kind": "field",
123761
+ "name": "_preventScrollOnSpaceKeydown",
123762
+ "privacy": "private",
123763
+ "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
123542
123764
  "parameters": [
123543
123765
  {
123544
- "name": "evt",
123545
- "type": {
123546
- "text": "KeyboardEvent"
123547
- }
123766
+ "description": "The origin event.",
123767
+ "name": "event"
123548
123768
  }
123549
- ]
123769
+ ],
123770
+ "inheritedFrom": {
123771
+ "name": "SbbButtonLikeBaseElement",
123772
+ "module": "core/base-elements/button-base-element.js"
123773
+ }
123774
+ },
123775
+ {
123776
+ "kind": "field",
123777
+ "name": "_removeActiveMarker",
123778
+ "privacy": "private",
123779
+ "inheritedFrom": {
123780
+ "name": "SbbButtonLikeBaseElement",
123781
+ "module": "core/base-elements/button-base-element.js"
123782
+ }
123783
+ },
123784
+ {
123785
+ "kind": "field",
123786
+ "name": "_dispatchClickEventOnSpaceKeyup",
123787
+ "privacy": "private",
123788
+ "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.",
123789
+ "parameters": [
123790
+ {
123791
+ "description": "The origin event.",
123792
+ "name": "event"
123793
+ }
123794
+ ],
123795
+ "inheritedFrom": {
123796
+ "name": "SbbButtonLikeBaseElement",
123797
+ "module": "core/base-elements/button-base-element.js"
123798
+ }
123799
+ },
123800
+ {
123801
+ "kind": "field",
123802
+ "name": "_dispatchClickEvent",
123803
+ "privacy": "private",
123804
+ "inheritedFrom": {
123805
+ "name": "SbbButtonLikeBaseElement",
123806
+ "module": "core/base-elements/button-base-element.js"
123807
+ }
123808
+ },
123809
+ {
123810
+ "kind": "field",
123811
+ "name": "maybeDisabled",
123812
+ "type": {
123813
+ "text": "boolean | undefined"
123814
+ },
123815
+ "privacy": "protected",
123816
+ "readonly": true,
123817
+ "inheritedFrom": {
123818
+ "name": "SbbActionBaseElement",
123819
+ "module": "core/base-elements/action-base-element.js"
123820
+ }
123821
+ },
123822
+ {
123823
+ "kind": "field",
123824
+ "name": "maybeDisabledInteractive",
123825
+ "type": {
123826
+ "text": "boolean | undefined"
123827
+ },
123828
+ "privacy": "protected",
123829
+ "readonly": true,
123830
+ "inheritedFrom": {
123831
+ "name": "SbbActionBaseElement",
123832
+ "module": "core/base-elements/action-base-element.js"
123833
+ }
123834
+ },
123835
+ {
123836
+ "kind": "method",
123837
+ "name": "setupBaseEventHandlers",
123838
+ "privacy": "protected",
123839
+ "return": {
123840
+ "type": {
123841
+ "text": "void"
123842
+ }
123843
+ },
123844
+ "inheritedFrom": {
123845
+ "name": "SbbActionBaseElement",
123846
+ "module": "core/base-elements/action-base-element.js"
123847
+ }
123848
+ },
123849
+ {
123850
+ "kind": "method",
123851
+ "name": "renderTemplate",
123852
+ "privacy": "protected",
123853
+ "return": {
123854
+ "type": {
123855
+ "text": "TemplateResult"
123856
+ }
123857
+ },
123858
+ "description": "Override this method to render the component template.",
123859
+ "inheritedFrom": {
123860
+ "name": "SbbActionBaseElement",
123861
+ "module": "core/base-elements/action-base-element.js"
123862
+ }
123550
123863
  },
123551
123864
  {
123552
123865
  "kind": "field",
@@ -123654,668 +123967,415 @@
123654
123967
  }
123655
123968
  }
123656
123969
  ],
123657
- "events": [
123970
+ "mixins": [
123658
123971
  {
123659
- "type": {
123660
- "text": "SbbStepChangeEvent"
123661
- },
123662
- "description": "Emits whenever a step was changed.",
123663
- "name": "stepchange"
123972
+ "name": "SbbIconNameMixin",
123973
+ "module": "icon.js"
123974
+ },
123975
+ {
123976
+ "name": "SbbDisabledMixin",
123977
+ "module": "core/mixins.js"
123664
123978
  }
123665
123979
  ],
123980
+ "superclass": {
123981
+ "name": "SbbButtonBaseElement",
123982
+ "module": "core/base-elements.js"
123983
+ },
123984
+ "tagName": "sbb-step-label",
123985
+ "customElement": true,
123666
123986
  "attributes": [
123667
123987
  {
123668
- "name": "linear",
123988
+ "name": "icon-name",
123669
123989
  "type": {
123670
- "text": "boolean"
123990
+ "text": "string"
123671
123991
  },
123672
- "default": "false",
123673
- "description": "If set to true, only the current and previous labels can be clicked and selected.",
123674
- "fieldName": "linear"
123992
+ "default": "''",
123993
+ "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.",
123994
+ "fieldName": "iconName",
123995
+ "inheritedFrom": {
123996
+ "name": "SbbIconNameMixin",
123997
+ "module": "icon/icon-name-mixin.js"
123998
+ }
123675
123999
  },
123676
124000
  {
123677
- "name": "horizontal-from",
123678
- "description": "Overrides the behavior of `orientation` property.",
124001
+ "name": "disabled",
124002
+ "description": "Whether the component is disabled.",
124003
+ "default": "false",
123679
124004
  "type": {
123680
- "text": "SbbHorizontalFrom | null"
124005
+ "text": "boolean"
123681
124006
  },
123682
- "fieldName": "horizontalFrom"
123683
- },
123684
- {
123685
- "name": "orientation",
123686
- "type": {
123687
- "text": "SbbOrientation"
124007
+ "fieldName": "disabled",
124008
+ "inheritedFrom": {
124009
+ "name": "SbbDisabledMixin",
124010
+ "module": "core/mixins/disabled-mixin.js"
124011
+ }
124012
+ },
124013
+ {
124014
+ "name": "value",
124015
+ "type": {
124016
+ "text": "string"
123688
124017
  },
123689
- "default": "'horizontal'",
123690
- "description": "Steps orientation, either horizontal or vertical.",
123691
- "fieldName": "orientation"
124018
+ "default": "''",
124019
+ "description": "Value of the form element.",
124020
+ "fieldName": "value",
124021
+ "inheritedFrom": {
124022
+ "name": "SbbButtonBaseElement",
124023
+ "module": "core/base-elements/button-base-element.js"
124024
+ }
123692
124025
  },
123693
124026
  {
123694
- "name": "size",
124027
+ "name": "type",
124028
+ "description": "The type attribute to use for the button.",
124029
+ "default": "'button'",
123695
124030
  "type": {
123696
- "text": "'s' | 'm'"
124031
+ "text": "SbbButtonType"
123697
124032
  },
123698
- "description": "Size variant, either s or m.",
123699
- "default": "'m' / 's' (lean)",
123700
- "fieldName": "size"
124033
+ "fieldName": "type",
124034
+ "inheritedFrom": {
124035
+ "name": "SbbButtonBaseElement",
124036
+ "module": "core/base-elements/button-base-element.js"
124037
+ }
123701
124038
  },
123702
124039
  {
123703
- "name": "selected-index",
123704
- "description": "The currently selected step index.",
124040
+ "name": "form",
124041
+ "description": "The `<form>` element to associate the button with.",
123705
124042
  "type": {
123706
- "text": "number | null"
124043
+ "text": "HTMLFormElement | null"
123707
124044
  },
123708
- "fieldName": "selectedIndex"
124045
+ "fieldName": "form",
124046
+ "inheritedFrom": {
124047
+ "name": "SbbButtonBaseElement",
124048
+ "module": "core/base-elements/button-base-element.js"
124049
+ }
124050
+ },
124051
+ {
124052
+ "name": "name",
124053
+ "description": "Name of the form element. Will be read from name attribute.",
124054
+ "type": {
124055
+ "text": "string"
124056
+ },
124057
+ "fieldName": "name",
124058
+ "inheritedFrom": {
124059
+ "name": "SbbFormAssociatedMixin",
124060
+ "module": "core/mixins/form-associated-mixin.js"
124061
+ }
123709
124062
  }
123710
- ],
123711
- "superclass": {
123712
- "name": "SbbElement",
123713
- "module": "core/base-elements.js"
123714
- },
123715
- "tagName": "sbb-stepper",
123716
- "customElement": true
123717
- },
123718
- {
123719
- "kind": "variable",
123720
- "name": "currentIndex"
123721
- },
123722
- {
123723
- "kind": "variable",
123724
- "name": "currentStep"
124063
+ ]
123725
124064
  }
123726
124065
  ],
123727
124066
  "exports": [
123728
124067
  {
123729
124068
  "kind": "js",
123730
- "name": "SbbStepChangeEvent",
123731
- "declaration": {
123732
- "name": "SbbStepChangeEvent",
123733
- "module": "stepper/stepper/stepper.component.js"
123734
- }
123735
- },
123736
- {
123737
- "kind": "js",
123738
- "name": "SbbStepperElement",
124069
+ "name": "SbbStepLabelElement",
123739
124070
  "declaration": {
123740
- "name": "SbbStepperElement",
123741
- "module": "stepper/stepper/stepper.component.js"
124071
+ "name": "SbbStepLabelElement",
124072
+ "module": "stepper/step-label/step-label.component.js"
123742
124073
  }
123743
124074
  }
123744
124075
  ]
123745
124076
  },
123746
124077
  {
123747
124078
  "kind": "javascript-module",
123748
- "path": "stepper/step-label/step-label.component.js",
124079
+ "path": "stepper/stepper/stepper.component.js",
123749
124080
  "declarations": [
123750
124081
  {
123751
124082
  "kind": "class",
123752
- "description": "Combined with a `sbb-stepper`, it displays a step's label.",
123753
- "name": "SbbStepLabelElement",
123754
- "slots": [
123755
- {
123756
- "description": "Use the unnamed slot to provide a label.",
123757
- "name": ""
123758
- },
123759
- {
123760
- "description": "Use this to display an icon in the label bubble.",
123761
- "name": "icon"
123762
- }
123763
- ],
124083
+ "description": "",
124084
+ "name": "SbbStepChangeEvent",
123764
124085
  "members": [
123765
124086
  {
123766
124087
  "kind": "field",
123767
- "name": "elementName",
124088
+ "name": "selectedIndex",
123768
124089
  "type": {
123769
- "text": "string"
124090
+ "text": "number | null"
123770
124091
  },
123771
124092
  "privacy": "public",
123772
- "static": true,
123773
124093
  "readonly": true,
123774
- "inheritedFrom": {
123775
- "name": "SbbElement",
123776
- "module": "core/base-elements/element.js"
123777
- },
123778
- "default": "'sbb-step-label'"
124094
+ "description": "The index of the newly selected step.",
124095
+ "default": "selectedIndex"
123779
124096
  },
123780
124097
  {
123781
124098
  "kind": "field",
123782
- "name": "role",
124099
+ "name": "previousIndex",
123783
124100
  "type": {
123784
- "text": "string"
124101
+ "text": "number | null"
123785
124102
  },
123786
124103
  "privacy": "public",
123787
- "static": true,
123788
124104
  "readonly": true,
123789
- "default": "'tab'",
123790
- "inheritedFrom": {
123791
- "name": "SbbButtonLikeBaseElement",
123792
- "module": "core/base-elements/button-base-element.js"
123793
- }
124105
+ "description": "The index of the previously selected step.",
124106
+ "default": "previousIndex"
123794
124107
  },
123795
124108
  {
123796
124109
  "kind": "field",
123797
- "name": "step",
124110
+ "name": "selectedStep",
123798
124111
  "type": {
123799
124112
  "text": "SbbStepElement | null"
123800
124113
  },
123801
124114
  "privacy": "public",
123802
- "description": "The step controlled by the label.",
123803
124115
  "readonly": true,
123804
- "default": "null"
124116
+ "description": "The newly selected step element.",
124117
+ "default": "selectedStep"
123805
124118
  },
123806
124119
  {
123807
124120
  "kind": "field",
123808
- "name": "_step",
124121
+ "name": "previousStep",
123809
124122
  "type": {
123810
124123
  "text": "SbbStepElement | null"
123811
124124
  },
123812
- "privacy": "private",
123813
- "default": "null"
123814
- },
123815
- {
123816
- "kind": "field",
123817
- "name": "stepper",
123818
- "type": {
123819
- "text": "SbbStepperElement | null"
123820
- },
123821
124125
  "privacy": "public",
123822
- "readonly": true
123823
- },
123824
- {
123825
- "kind": "field",
123826
- "name": "disabled",
123827
- "privacy": "public",
123828
- "description": "Whether the component is disabled.",
123829
- "default": "false",
123830
- "type": {
123831
- "text": "boolean"
123832
- },
123833
- "attribute": "disabled",
123834
- "reflects": true,
123835
- "inheritedFrom": {
123836
- "name": "SbbDisabledMixin",
123837
- "module": "core/mixins/disabled-mixin.js"
123838
- }
123839
- },
123840
- {
123841
- "kind": "field",
123842
- "name": "_previousOrientation",
123843
- "type": {
123844
- "text": "string | undefined"
123845
- },
123846
- "privacy": "private"
123847
- },
124126
+ "readonly": true,
124127
+ "description": "The previously selected step element.",
124128
+ "default": "previousStep"
124129
+ }
124130
+ ],
124131
+ "superclass": {
124132
+ "name": "Event",
124133
+ "module": "stepper/stepper/stepper.component.js"
124134
+ }
124135
+ },
124136
+ {
124137
+ "kind": "class",
124138
+ "description": "Provides a structured, step-by-step workflow for user interactions.",
124139
+ "name": "SbbStepperElement",
124140
+ "slots": [
123848
124141
  {
123849
- "kind": "field",
123850
- "name": "_previousSize",
123851
- "type": {
123852
- "text": "string | undefined"
123853
- },
123854
- "privacy": "private"
124142
+ "description": "Provide a `sbb-expansion-panel-header` and a `sbb-expansion-panel-content` to the stepper.",
124143
+ "name": ""
123855
124144
  },
123856
124145
  {
123857
- "kind": "method",
123858
- "name": "_isNotDeactivatedByLinearMode",
123859
- "privacy": "private",
123860
- "return": {
123861
- "type": {
123862
- "text": "boolean"
123863
- }
123864
- },
123865
- "parameters": [
123866
- {
123867
- "name": "step",
123868
- "type": {
123869
- "text": "SbbStepElement"
123870
- }
123871
- }
123872
- ]
124146
+ "description": "Use this slot to provide an `sbb-step-label`.",
124147
+ "name": "step-label"
123873
124148
  },
123874
124149
  {
123875
- "kind": "method",
123876
- "name": "_assignStep",
123877
- "privacy": "private",
123878
- "return": {
123879
- "type": {
123880
- "text": "void"
123881
- }
123882
- }
123883
- },
124150
+ "description": "Use this slot to provide an `sbb-step`.",
124151
+ "name": "step"
124152
+ }
124153
+ ],
124154
+ "members": [
123884
124155
  {
123885
124156
  "kind": "field",
123886
- "name": "iconName",
124157
+ "name": "elementName",
123887
124158
  "type": {
123888
124159
  "text": "string"
123889
124160
  },
123890
124161
  "privacy": "public",
123891
- "default": "''",
123892
- "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.",
123893
- "attribute": "icon-name",
123894
- "inheritedFrom": {
123895
- "name": "SbbIconNameMixin",
123896
- "module": "icon/icon-name-mixin.js"
123897
- }
123898
- },
123899
- {
123900
- "kind": "method",
123901
- "name": "renderIconSlot",
123902
- "privacy": "protected",
123903
- "return": {
123904
- "type": {
123905
- "text": "TemplateResult"
123906
- }
123907
- },
123908
- "parameters": [
123909
- {
123910
- "name": "classname",
123911
- "optional": true,
123912
- "type": {
123913
- "text": "string"
123914
- }
123915
- }
123916
- ],
123917
- "inheritedFrom": {
123918
- "name": "SbbIconNameMixin",
123919
- "module": "icon/icon-name-mixin.js"
123920
- }
123921
- },
123922
- {
123923
- "kind": "method",
123924
- "name": "renderIconName",
123925
- "privacy": "protected",
123926
- "return": {
123927
- "type": {
123928
- "text": "string"
123929
- }
123930
- },
123931
- "inheritedFrom": {
123932
- "name": "SbbIconNameMixin",
123933
- "module": "icon/icon-name-mixin.js"
123934
- }
123935
- },
123936
- {
123937
- "kind": "method",
123938
- "name": "_renderIconName",
123939
- "privacy": "private",
123940
- "return": {
123941
- "type": {
123942
- "text": "string"
123943
- }
123944
- },
124162
+ "static": true,
124163
+ "readonly": true,
124164
+ "default": "'sbb-stepper'",
123945
124165
  "inheritedFrom": {
123946
- "name": "SbbIconNameMixin",
123947
- "module": "icon/icon-name-mixin.js"
124166
+ "name": "SbbElement",
124167
+ "module": "core/base-elements/element.js"
123948
124168
  }
123949
124169
  },
123950
124170
  {
123951
124171
  "kind": "field",
123952
- "name": "#disabled",
123953
- "privacy": "private",
124172
+ "name": "events",
124173
+ "privacy": "public",
124174
+ "static": true,
124175
+ "readonly": true,
124176
+ "default": "{ stepchange: 'stepchange', }",
123954
124177
  "type": {
123955
- "text": "boolean"
123956
- },
123957
- "default": "false",
123958
- "inheritedFrom": {
123959
- "name": "SbbDisabledMixin",
123960
- "module": "core/mixins/disabled-mixin.js"
123961
- }
123962
- },
123963
- {
123964
- "kind": "method",
123965
- "name": "isDisabledExternally",
123966
- "privacy": "protected",
123967
- "return": {
123968
- "type": {
123969
- "text": "boolean"
123970
- }
123971
- },
123972
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
123973
- "inheritedFrom": {
123974
- "name": "SbbDisabledMixin",
123975
- "module": "core/mixins/disabled-mixin.js"
124178
+ "text": "{\n stepchange: 'stepchange',\n }"
123976
124179
  }
123977
124180
  },
123978
124181
  {
123979
124182
  "kind": "field",
123980
- "name": "_elementsOnWhichEnterPressTriggersSubmit",
123981
- "type": {
123982
- "text": "array"
123983
- },
124183
+ "name": "_observer",
123984
124184
  "privacy": "private",
123985
- "readonly": true,
123986
- "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
123987
- "inheritedFrom": {
123988
- "name": "SbbButtonBaseElement",
123989
- "module": "core/base-elements/button-base-element.js"
123990
- }
124185
+ "default": "new IntersectionController(this, { target: null, callback: (entries) => { entries.forEach((e) => { if (e.intersectionRatio > 0) { this._setStepperHeight(this.selected); this._setMarkerSize(); } }); }, })",
124186
+ "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."
123991
124187
  },
123992
124188
  {
123993
124189
  "kind": "field",
123994
- "name": "value",
124190
+ "name": "linear",
123995
124191
  "type": {
123996
- "text": "string"
124192
+ "text": "boolean"
123997
124193
  },
123998
124194
  "privacy": "public",
123999
- "inheritedFrom": {
124000
- "name": "SbbButtonBaseElement",
124001
- "module": "core/base-elements/button-base-element.js"
124002
- },
124003
- "default": "''",
124004
- "description": "Value of the form element.",
124005
- "attribute": "value"
124195
+ "default": "false",
124196
+ "description": "If set to true, only the current and previous labels can be clicked and selected.",
124197
+ "attribute": "linear"
124006
124198
  },
124007
124199
  {
124008
124200
  "kind": "field",
124009
- "name": "type",
124201
+ "name": "horizontalFrom",
124010
124202
  "privacy": "public",
124011
- "description": "The type attribute to use for the button.",
124012
- "default": "'button'",
124013
- "type": {
124014
- "text": "SbbButtonType"
124015
- },
124016
- "attribute": "type",
124017
- "inheritedFrom": {
124018
- "name": "SbbButtonBaseElement",
124019
- "module": "core/base-elements/button-base-element.js"
124020
- }
124021
- },
124022
- {
124023
- "kind": "field",
124024
- "name": "form",
124203
+ "description": "Overrides the behavior of `orientation` property.",
124025
124204
  "type": {
124026
- "text": "HTMLFormElement | null"
124027
- },
124028
- "privacy": "public",
124029
- "description": "The `<form>` element to associate the button with.",
124030
- "inheritedFrom": {
124031
- "name": "SbbButtonBaseElement",
124032
- "module": "core/base-elements/button-base-element.js"
124205
+ "text": "SbbHorizontalFrom | null"
124033
124206
  },
124034
- "attribute": "form"
124207
+ "attribute": "horizontal-from",
124208
+ "reflects": true,
124209
+ "default": "null"
124035
124210
  },
124036
124211
  {
124037
124212
  "kind": "field",
124038
- "name": "_formId",
124213
+ "name": "_horizontalFrom",
124039
124214
  "type": {
124040
- "text": "string"
124041
- },
124042
- "privacy": "private",
124043
- "default": "''",
124044
- "inheritedFrom": {
124045
- "name": "SbbButtonBaseElement",
124046
- "module": "core/base-elements/button-base-element.js"
124047
- }
124048
- },
124049
- {
124050
- "kind": "field",
124051
- "name": "_handleButtonClick",
124052
- "privacy": "private",
124053
- "inheritedFrom": {
124054
- "name": "SbbButtonBaseElement",
124055
- "module": "core/base-elements/button-base-element.js"
124056
- }
124057
- },
124058
- {
124059
- "kind": "method",
124060
- "name": "_requestSubmit",
124061
- "privacy": "private",
124062
- "return": {
124063
- "type": {
124064
- "text": "void"
124065
- }
124215
+ "text": "SbbHorizontalFrom | null"
124066
124216
  },
124067
- "parameters": [
124068
- {
124069
- "name": "form",
124070
- "type": {
124071
- "text": "HTMLFormElement"
124072
- }
124073
- }
124074
- ],
124075
- "inheritedFrom": {
124076
- "name": "SbbButtonBaseElement",
124077
- "module": "core/base-elements/button-base-element.js"
124078
- }
124217
+ "privacy": "private",
124218
+ "default": "null"
124079
124219
  },
124080
124220
  {
124081
124221
  "kind": "field",
124082
- "name": "_formKeyDown",
124083
- "privacy": "private",
124084
- "inheritedFrom": {
124085
- "name": "SbbButtonBaseElement",
124086
- "module": "core/base-elements/button-base-element.js"
124087
- }
124222
+ "name": "orientation",
124223
+ "type": {
124224
+ "text": "SbbOrientation"
124225
+ },
124226
+ "privacy": "public",
124227
+ "default": "'horizontal'",
124228
+ "description": "Steps orientation, either horizontal or vertical.",
124229
+ "attribute": "orientation",
124230
+ "reflects": true
124088
124231
  },
124089
124232
  {
124090
124233
  "kind": "field",
124091
- "name": "formAssociated",
124234
+ "name": "size",
124092
124235
  "type": {
124093
- "text": "boolean"
124236
+ "text": "'s' | 'm'"
124094
124237
  },
124095
124238
  "privacy": "public",
124096
- "static": true,
124097
- "default": "true",
124098
- "inheritedFrom": {
124099
- "name": "SbbFormAssociatedMixin",
124100
- "module": "core/mixins/form-associated-mixin.js"
124101
- }
124239
+ "description": "Size variant, either s or m.",
124240
+ "default": "'m' / 's' (lean)",
124241
+ "attribute": "size",
124242
+ "reflects": true
124102
124243
  },
124103
124244
  {
124104
124245
  "kind": "field",
124105
- "name": "name",
124246
+ "name": "selected",
124106
124247
  "privacy": "public",
124107
- "description": "Name of the form element. Will be read from name attribute.",
124248
+ "description": "The currently selected step.",
124108
124249
  "type": {
124109
- "text": "string"
124110
- },
124111
- "attribute": "name",
124112
- "inheritedFrom": {
124113
- "name": "SbbFormAssociatedMixin",
124114
- "module": "core/mixins/form-associated-mixin.js"
124250
+ "text": "SbbStepElement | null"
124115
124251
  }
124116
124252
  },
124117
124253
  {
124118
124254
  "kind": "field",
124119
- "name": "validity",
124255
+ "name": "_requestedSelected",
124120
124256
  "type": {
124121
- "text": "ValidityState"
124257
+ "text": "SbbStepElement | null"
124122
124258
  },
124259
+ "privacy": "private",
124260
+ "default": "null"
124261
+ },
124262
+ {
124263
+ "kind": "field",
124264
+ "name": "selectedIndex",
124123
124265
  "privacy": "public",
124124
- "description": "Returns the ValidityState object for this element.",
124125
- "readonly": true,
124126
- "inheritedFrom": {
124127
- "name": "SbbFormAssociatedMixin",
124128
- "module": "core/mixins/form-associated-mixin.js"
124129
- }
124266
+ "description": "The currently selected step index.",
124267
+ "type": {
124268
+ "text": "number | null"
124269
+ },
124270
+ "attribute": "selected-index"
124130
124271
  },
124131
124272
  {
124132
124273
  "kind": "field",
124133
- "name": "validationMessage",
124274
+ "name": "_requestedSelectedIndex",
124134
124275
  "type": {
124135
- "text": "string"
124276
+ "text": "number | null"
124136
124277
  },
124137
- "privacy": "public",
124138
- "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.",
124139
- "readonly": true,
124140
- "inheritedFrom": {
124141
- "name": "SbbFormAssociatedMixin",
124142
- "module": "core/mixins/form-associated-mixin.js"
124143
- }
124278
+ "privacy": "private",
124279
+ "default": "null"
124144
124280
  },
124145
124281
  {
124146
124282
  "kind": "field",
124147
- "name": "willValidate",
124283
+ "name": "steps",
124148
124284
  "type": {
124149
- "text": "boolean"
124285
+ "text": "SbbStepElement[]"
124150
124286
  },
124151
124287
  "privacy": "public",
124152
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
124153
- "readonly": true,
124154
- "inheritedFrom": {
124155
- "name": "SbbFormAssociatedMixin",
124156
- "module": "core/mixins/form-associated-mixin.js"
124157
- }
124288
+ "description": "The steps of the stepper.",
124289
+ "readonly": true
124158
124290
  },
124159
124291
  {
124160
124292
  "kind": "field",
124161
- "name": "_validityStates",
124293
+ "name": "_enabledSteps",
124294
+ "type": {
124295
+ "text": "SbbStepElement[]"
124296
+ },
124162
124297
  "privacy": "private",
124163
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
124164
- "inheritedFrom": {
124165
- "name": "SbbFormAssociatedMixin",
124166
- "module": "core/mixins/form-associated-mixin.js"
124167
- }
124298
+ "readonly": true
124168
124299
  },
124169
124300
  {
124170
124301
  "kind": "field",
124171
- "name": "formDisabled",
124302
+ "name": "_loaded",
124172
124303
  "type": {
124173
124304
  "text": "boolean"
124174
124305
  },
124175
- "privacy": "protected",
124176
- "default": "false",
124177
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
124178
- "inheritedFrom": {
124179
- "name": "SbbFormAssociatedMixin",
124180
- "module": "core/mixins/form-associated-mixin.js"
124181
- }
124306
+ "privacy": "private",
124307
+ "default": "false"
124182
124308
  },
124183
124309
  {
124184
- "kind": "method",
124185
- "name": "checkValidity",
124186
- "privacy": "public",
124187
- "return": {
124188
- "type": {
124189
- "text": "boolean"
124190
- }
124310
+ "kind": "field",
124311
+ "name": "_resizeObserverTimeout",
124312
+ "type": {
124313
+ "text": "ReturnType<typeof setTimeout> | null"
124191
124314
  },
124192
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
124193
- "inheritedFrom": {
124194
- "name": "SbbFormAssociatedMixin",
124195
- "module": "core/mixins/form-associated-mixin.js"
124196
- }
124315
+ "privacy": "private",
124316
+ "default": "null"
124197
124317
  },
124198
124318
  {
124199
- "kind": "method",
124200
- "name": "reportValidity",
124201
- "privacy": "public",
124202
- "return": {
124203
- "type": {
124204
- "text": "boolean"
124205
- }
124206
- },
124207
- "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.",
124208
- "inheritedFrom": {
124209
- "name": "SbbFormAssociatedMixin",
124210
- "module": "core/mixins/form-associated-mixin.js"
124211
- }
124319
+ "kind": "field",
124320
+ "name": "_mediaMatcher",
124321
+ "privacy": "private",
124322
+ "default": "new SbbMediaMatcherController(this, {})"
124212
124323
  },
124213
124324
  {
124214
124325
  "kind": "method",
124215
- "name": "setCustomValidity",
124326
+ "name": "next",
124216
124327
  "privacy": "public",
124217
124328
  "return": {
124218
124329
  "type": {
124219
124330
  "text": "void"
124220
124331
  }
124221
124332
  },
124222
- "parameters": [
124223
- {
124224
- "name": "message",
124225
- "type": {
124226
- "text": "string"
124227
- }
124228
- }
124229
- ],
124230
- "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.",
124231
- "inheritedFrom": {
124232
- "name": "SbbFormAssociatedMixin",
124233
- "module": "core/mixins/form-associated-mixin.js"
124234
- }
124235
- },
124236
- {
124237
- "kind": "method",
124238
- "name": "_hasDisabledAncestor",
124239
- "privacy": "private",
124240
- "return": {
124241
- "type": {
124242
- "text": "boolean"
124243
- }
124244
- },
124245
- "inheritedFrom": {
124246
- "name": "SbbFormAssociatedMixin",
124247
- "module": "core/mixins/form-associated-mixin.js"
124248
- }
124333
+ "description": "Selects the next step."
124249
124334
  },
124250
124335
  {
124251
124336
  "kind": "method",
124252
- "name": "updateFormValue",
124253
- "privacy": "protected",
124337
+ "name": "previous",
124338
+ "privacy": "public",
124254
124339
  "return": {
124255
124340
  "type": {
124256
124341
  "text": "void"
124257
124342
  }
124258
124343
  },
124259
- "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",
124260
- "inheritedFrom": {
124261
- "name": "SbbFormAssociatedMixin",
124262
- "module": "core/mixins/form-associated-mixin.js"
124263
- }
124344
+ "description": "Selects the previous step."
124264
124345
  },
124265
124346
  {
124266
124347
  "kind": "method",
124267
- "name": "formState",
124268
- "privacy": "protected",
124348
+ "name": "reset",
124349
+ "privacy": "public",
124269
124350
  "return": {
124270
124351
  "type": {
124271
- "text": "FormRestoreState"
124352
+ "text": "void"
124272
124353
  }
124273
124354
  },
124274
- "inheritedFrom": {
124275
- "name": "SbbFormAssociatedMixin",
124276
- "module": "core/mixins/form-associated-mixin.js"
124277
- }
124355
+ "description": "Resets the form in which the stepper is nested or every form of each step, if any."
124278
124356
  },
124279
124357
  {
124280
124358
  "kind": "method",
124281
- "name": "setValidityFlag",
124282
- "privacy": "protected",
124359
+ "name": "_isSelectable",
124360
+ "privacy": "private",
124283
124361
  "return": {
124284
124362
  "type": {
124285
- "text": "void"
124363
+ "text": "step is SbbStepElement"
124286
124364
  }
124287
124365
  },
124288
124366
  "parameters": [
124289
124367
  {
124290
- "name": "flag",
124291
- "type": {
124292
- "text": "T"
124293
- }
124294
- },
124295
- {
124296
- "name": "message",
124297
- "type": {
124298
- "text": "string"
124299
- }
124300
- },
124301
- {
124302
- "name": "flagValue",
124303
- "optional": true,
124368
+ "name": "step",
124304
124369
  "type": {
124305
- "text": "ValidityStateFlags[T]"
124370
+ "text": "SbbStepElement | null"
124306
124371
  }
124307
124372
  }
124308
- ],
124309
- "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).",
124310
- "inheritedFrom": {
124311
- "name": "SbbFormAssociatedMixin",
124312
- "module": "core/mixins/form-associated-mixin.js"
124313
- }
124373
+ ]
124314
124374
  },
124315
124375
  {
124316
124376
  "kind": "method",
124317
- "name": "removeValidityFlag",
124318
- "privacy": "protected",
124377
+ "name": "_select",
124378
+ "privacy": "private",
124319
124379
  "return": {
124320
124380
  "type": {
124321
124381
  "text": "void"
@@ -124323,174 +124383,132 @@
124323
124383
  },
124324
124384
  "parameters": [
124325
124385
  {
124326
- "name": "flag",
124386
+ "name": "step",
124327
124387
  "type": {
124328
- "text": "T"
124388
+ "text": "SbbStepElement | null"
124329
124389
  }
124330
124390
  }
124331
- ],
124332
- "description": "Removes the validity state flag entry and updates validity state.",
124333
- "inheritedFrom": {
124334
- "name": "SbbFormAssociatedMixin",
124335
- "module": "core/mixins/form-associated-mixin.js"
124336
- }
124391
+ ]
124337
124392
  },
124338
124393
  {
124339
124394
  "kind": "method",
124340
- "name": "validate",
124341
- "privacy": "protected",
124395
+ "name": "_setMarkerSize",
124396
+ "privacy": "private",
124342
124397
  "return": {
124343
124398
  "type": {
124344
124399
  "text": "void"
124345
124400
  }
124346
- },
124347
- "description": "To be called whenever the current element needs to be validated.",
124348
- "inheritedFrom": {
124349
- "name": "SbbFormAssociatedMixin",
124350
- "module": "core/mixins/form-associated-mixin.js"
124351
124401
  }
124352
124402
  },
124353
124403
  {
124354
124404
  "kind": "method",
124355
- "name": "shouldValidate",
124356
- "privacy": "protected",
124405
+ "name": "_setStepperHeight",
124406
+ "privacy": "private",
124357
124407
  "return": {
124358
124408
  "type": {
124359
- "text": "boolean"
124409
+ "text": "void"
124360
124410
  }
124361
124411
  },
124362
124412
  "parameters": [
124363
124413
  {
124364
- "name": "name",
124414
+ "name": "step",
124365
124415
  "type": {
124366
- "text": "PropertyKey | undefined"
124416
+ "text": "SbbStepElement | null"
124367
124417
  }
124368
124418
  }
124369
124419
  ],
124370
- "description": "Whether validation should be run on a property change with the given name.",
124371
- "inheritedFrom": {
124372
- "name": "SbbFormAssociatedMixin",
124373
- "module": "core/mixins/form-associated-mixin.js"
124374
- }
124420
+ "description": "Sets the stepper height based on the height of the provided step."
124375
124421
  },
124376
124422
  {
124377
124423
  "kind": "method",
124378
- "name": "_setInternalValidity",
124424
+ "name": "_calculateLabelOffsetTop",
124379
124425
  "privacy": "private",
124380
124426
  "return": {
124381
124427
  "type": {
124382
- "text": "void"
124428
+ "text": "number | undefined"
124383
124429
  }
124384
- },
124385
- "inheritedFrom": {
124386
- "name": "SbbFormAssociatedMixin",
124387
- "module": "core/mixins/form-associated-mixin.js"
124388
124430
  }
124389
124431
  },
124390
124432
  {
124391
- "kind": "field",
124392
- "name": "_preventScrollOnSpaceKeydown",
124433
+ "kind": "method",
124434
+ "name": "_onSelectedStepResize",
124393
124435
  "privacy": "private",
124394
- "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
124436
+ "return": {
124437
+ "type": {
124438
+ "text": "void"
124439
+ }
124440
+ },
124395
124441
  "parameters": [
124396
124442
  {
124397
- "description": "The origin event.",
124398
- "name": "event"
124443
+ "name": "e",
124444
+ "type": {
124445
+ "text": "Event"
124446
+ }
124399
124447
  }
124400
- ],
124401
- "inheritedFrom": {
124402
- "name": "SbbButtonLikeBaseElement",
124403
- "module": "core/base-elements/button-base-element.js"
124404
- }
124448
+ ]
124405
124449
  },
124406
124450
  {
124407
- "kind": "field",
124408
- "name": "_removeActiveMarker",
124451
+ "kind": "method",
124452
+ "name": "_configure",
124409
124453
  "privacy": "private",
124410
- "inheritedFrom": {
124411
- "name": "SbbButtonLikeBaseElement",
124412
- "module": "core/base-elements/button-base-element.js"
124454
+ "return": {
124455
+ "type": {
124456
+ "text": "void"
124457
+ }
124413
124458
  }
124414
124459
  },
124415
124460
  {
124416
- "kind": "field",
124417
- "name": "_dispatchClickEventOnSpaceKeyup",
124461
+ "kind": "method",
124462
+ "name": "_updateLabels",
124418
124463
  "privacy": "private",
124419
- "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.",
124420
- "parameters": [
124421
- {
124422
- "description": "The origin event.",
124423
- "name": "event"
124464
+ "return": {
124465
+ "type": {
124466
+ "text": "void"
124424
124467
  }
124425
- ],
124426
- "inheritedFrom": {
124427
- "name": "SbbButtonLikeBaseElement",
124428
- "module": "core/base-elements/button-base-element.js"
124429
124468
  }
124430
124469
  },
124431
124470
  {
124432
- "kind": "field",
124433
- "name": "_dispatchClickEvent",
124471
+ "kind": "method",
124472
+ "name": "_checkOrientation",
124434
124473
  "privacy": "private",
124435
- "inheritedFrom": {
124436
- "name": "SbbButtonLikeBaseElement",
124437
- "module": "core/base-elements/button-base-element.js"
124438
- }
124439
- },
124440
- {
124441
- "kind": "field",
124442
- "name": "maybeDisabled",
124443
- "type": {
124444
- "text": "boolean | undefined"
124445
- },
124446
- "privacy": "protected",
124447
- "readonly": true,
124448
- "inheritedFrom": {
124449
- "name": "SbbActionBaseElement",
124450
- "module": "core/base-elements/action-base-element.js"
124474
+ "return": {
124475
+ "type": {
124476
+ "text": "void"
124477
+ }
124451
124478
  }
124452
124479
  },
124453
124480
  {
124454
124481
  "kind": "field",
124455
- "name": "maybeDisabledInteractive",
124456
- "type": {
124457
- "text": "boolean | undefined"
124458
- },
124459
- "privacy": "protected",
124460
- "readonly": true,
124461
- "inheritedFrom": {
124462
- "name": "SbbActionBaseElement",
124463
- "module": "core/base-elements/action-base-element.js"
124464
- }
124482
+ "name": "_onStepperResize",
124483
+ "privacy": "private"
124465
124484
  },
124466
124485
  {
124467
124486
  "kind": "method",
124468
- "name": "setupBaseEventHandlers",
124469
- "privacy": "protected",
124487
+ "name": "_configureLinearMode",
124488
+ "privacy": "private",
124470
124489
  "return": {
124471
124490
  "type": {
124472
124491
  "text": "void"
124473
124492
  }
124474
- },
124475
- "inheritedFrom": {
124476
- "name": "SbbActionBaseElement",
124477
- "module": "core/base-elements/action-base-element.js"
124478
124493
  }
124479
124494
  },
124480
124495
  {
124481
124496
  "kind": "method",
124482
- "name": "renderTemplate",
124483
- "privacy": "protected",
124497
+ "name": "_handleKeyDown",
124498
+ "privacy": "private",
124484
124499
  "return": {
124485
124500
  "type": {
124486
- "text": "TemplateResult"
124501
+ "text": "void"
124487
124502
  }
124488
124503
  },
124489
- "description": "Override this method to render the component template.",
124490
- "inheritedFrom": {
124491
- "name": "SbbActionBaseElement",
124492
- "module": "core/base-elements/action-base-element.js"
124493
- }
124504
+ "parameters": [
124505
+ {
124506
+ "name": "evt",
124507
+ "type": {
124508
+ "text": "KeyboardEvent"
124509
+ }
124510
+ }
124511
+ ]
124494
124512
  },
124495
124513
  {
124496
124514
  "kind": "field",
@@ -124598,109 +124616,91 @@
124598
124616
  }
124599
124617
  }
124600
124618
  ],
124601
- "mixins": [
124602
- {
124603
- "name": "SbbIconNameMixin",
124604
- "module": "icon.js"
124605
- },
124619
+ "events": [
124606
124620
  {
124607
- "name": "SbbDisabledMixin",
124608
- "module": "core/mixins.js"
124621
+ "type": {
124622
+ "text": "SbbStepChangeEvent"
124623
+ },
124624
+ "description": "Emits whenever a step was changed.",
124625
+ "name": "stepchange"
124609
124626
  }
124610
124627
  ],
124611
- "superclass": {
124612
- "name": "SbbButtonBaseElement",
124613
- "module": "core/base-elements.js"
124614
- },
124615
- "tagName": "sbb-step-label",
124616
- "customElement": true,
124617
124628
  "attributes": [
124618
124629
  {
124619
- "name": "icon-name",
124620
- "type": {
124621
- "text": "string"
124622
- },
124623
- "default": "''",
124624
- "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.",
124625
- "fieldName": "iconName",
124626
- "inheritedFrom": {
124627
- "name": "SbbIconNameMixin",
124628
- "module": "icon/icon-name-mixin.js"
124629
- }
124630
- },
124631
- {
124632
- "name": "disabled",
124633
- "description": "Whether the component is disabled.",
124634
- "default": "false",
124630
+ "name": "linear",
124635
124631
  "type": {
124636
124632
  "text": "boolean"
124637
124633
  },
124638
- "fieldName": "disabled",
124639
- "inheritedFrom": {
124640
- "name": "SbbDisabledMixin",
124641
- "module": "core/mixins/disabled-mixin.js"
124642
- }
124634
+ "default": "false",
124635
+ "description": "If set to true, only the current and previous labels can be clicked and selected.",
124636
+ "fieldName": "linear"
124643
124637
  },
124644
124638
  {
124645
- "name": "value",
124639
+ "name": "horizontal-from",
124640
+ "description": "Overrides the behavior of `orientation` property.",
124646
124641
  "type": {
124647
- "text": "string"
124642
+ "text": "SbbHorizontalFrom | null"
124648
124643
  },
124649
- "default": "''",
124650
- "description": "Value of the form element.",
124651
- "fieldName": "value",
124652
- "inheritedFrom": {
124653
- "name": "SbbButtonBaseElement",
124654
- "module": "core/base-elements/button-base-element.js"
124655
- }
124644
+ "fieldName": "horizontalFrom"
124656
124645
  },
124657
124646
  {
124658
- "name": "type",
124659
- "description": "The type attribute to use for the button.",
124660
- "default": "'button'",
124647
+ "name": "orientation",
124661
124648
  "type": {
124662
- "text": "SbbButtonType"
124649
+ "text": "SbbOrientation"
124663
124650
  },
124664
- "fieldName": "type",
124665
- "inheritedFrom": {
124666
- "name": "SbbButtonBaseElement",
124667
- "module": "core/base-elements/button-base-element.js"
124668
- }
124651
+ "default": "'horizontal'",
124652
+ "description": "Steps orientation, either horizontal or vertical.",
124653
+ "fieldName": "orientation"
124669
124654
  },
124670
124655
  {
124671
- "name": "form",
124672
- "description": "The `<form>` element to associate the button with.",
124656
+ "name": "size",
124673
124657
  "type": {
124674
- "text": "HTMLFormElement | null"
124658
+ "text": "'s' | 'm'"
124675
124659
  },
124676
- "fieldName": "form",
124677
- "inheritedFrom": {
124678
- "name": "SbbButtonBaseElement",
124679
- "module": "core/base-elements/button-base-element.js"
124680
- }
124660
+ "description": "Size variant, either s or m.",
124661
+ "default": "'m' / 's' (lean)",
124662
+ "fieldName": "size"
124681
124663
  },
124682
124664
  {
124683
- "name": "name",
124684
- "description": "Name of the form element. Will be read from name attribute.",
124665
+ "name": "selected-index",
124666
+ "description": "The currently selected step index.",
124685
124667
  "type": {
124686
- "text": "string"
124668
+ "text": "number | null"
124687
124669
  },
124688
- "fieldName": "name",
124689
- "inheritedFrom": {
124690
- "name": "SbbFormAssociatedMixin",
124691
- "module": "core/mixins/form-associated-mixin.js"
124692
- }
124670
+ "fieldName": "selectedIndex"
124693
124671
  }
124694
- ]
124672
+ ],
124673
+ "superclass": {
124674
+ "name": "SbbElement",
124675
+ "module": "core/base-elements.js"
124676
+ },
124677
+ "tagName": "sbb-stepper",
124678
+ "customElement": true
124679
+ },
124680
+ {
124681
+ "kind": "variable",
124682
+ "name": "currentIndex"
124683
+ },
124684
+ {
124685
+ "kind": "variable",
124686
+ "name": "currentStep"
124695
124687
  }
124696
124688
  ],
124697
124689
  "exports": [
124698
124690
  {
124699
124691
  "kind": "js",
124700
- "name": "SbbStepLabelElement",
124692
+ "name": "SbbStepChangeEvent",
124701
124693
  "declaration": {
124702
- "name": "SbbStepLabelElement",
124703
- "module": "stepper/step-label/step-label.component.js"
124694
+ "name": "SbbStepChangeEvent",
124695
+ "module": "stepper/stepper/stepper.component.js"
124696
+ }
124697
+ },
124698
+ {
124699
+ "kind": "js",
124700
+ "name": "SbbStepperElement",
124701
+ "declaration": {
124702
+ "name": "SbbStepperElement",
124703
+ "module": "stepper/stepper/stepper.component.js"
124704
124704
  }
124705
124705
  }
124706
124706
  ]