@sbb-esta/lyne-elements-dev 4.9.0-dev.1775524055 → 4.9.0-dev.1775549122

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.
@@ -14467,6 +14467,7 @@
14467
14467
  "privacy": "public",
14468
14468
  "description": "Journey header size, either s, m or l.",
14469
14469
  "default": "'m' / 's' (lean)",
14470
+ "deprecated": "Use visualLevel instead.",
14470
14471
  "attribute": "size",
14471
14472
  "reflects": true
14472
14473
  },
@@ -14679,6 +14680,7 @@
14679
14680
  },
14680
14681
  "description": "Journey header size, either s, m or l.",
14681
14682
  "default": "'m' / 's' (lean)",
14683
+ "deprecated": "Use visualLevel instead.",
14682
14684
  "fieldName": "size"
14683
14685
  },
14684
14686
  {
@@ -120222,20 +120224,28 @@
120222
120224
  },
120223
120225
  {
120224
120226
  "kind": "javascript-module",
120225
- "path": "sidebar/sidebar/sidebar.component.js",
120227
+ "path": "sidebar/sidebar-close-button/sidebar-close-button.component.js",
120226
120228
  "declarations": [
120227
120229
  {
120228
120230
  "kind": "class",
120229
- "description": "This component corresponds to a sidebar that can be opened on the sidebar container.",
120230
- "name": "SbbSidebarElement",
120231
+ "description": "Sidebar close button, intended to be placed inside sbb-sidebar.",
120232
+ "name": "SbbSidebarCloseButtonElement",
120231
120233
  "slots": [
120232
120234
  {
120233
- "description": "Use the unnamed slot to slot any content into the sidebar.",
120234
- "name": ""
120235
+ "description": "Use the unnamed slot to add content to the sidebar-close-button. Not intended to be used in this context.",
120236
+ "name": "",
120237
+ "inheritedFrom": {
120238
+ "name": "SbbSecondaryButtonElement",
120239
+ "module": "button/secondary-button/secondary-button.component.js"
120240
+ }
120235
120241
  },
120236
120242
  {
120237
- "description": "Use the title slot to add an <sbb-title>.",
120238
- "name": "title"
120243
+ "description": "Slot used to display the icon, if one is set. Not intended to be used in this context.",
120244
+ "name": "icon",
120245
+ "inheritedFrom": {
120246
+ "name": "SbbSecondaryButtonElement",
120247
+ "module": "button/secondary-button/secondary-button.component.js"
120248
+ }
120239
120249
  }
120240
120250
  ],
120241
120251
  "members": [
@@ -120252,1247 +120262,1215 @@
120252
120262
  "name": "SbbElement",
120253
120263
  "module": "core/base-elements/element.js"
120254
120264
  },
120255
- "default": "'sbb-sidebar'"
120265
+ "default": "'sbb-sidebar-close-button'"
120256
120266
  },
120257
120267
  {
120258
120268
  "kind": "field",
120259
- "name": "color",
120260
- "type": {
120261
- "text": "'white' | 'milk'"
120269
+ "name": "_languageController",
120270
+ "privacy": "private",
120271
+ "default": "new SbbLanguageController(this)"
120272
+ },
120273
+ {
120274
+ "kind": "method",
120275
+ "name": "renderTemplate",
120276
+ "privacy": "protected",
120277
+ "return": {
120278
+ "type": {
120279
+ "text": "TemplateResult"
120280
+ }
120262
120281
  },
120263
- "privacy": "public",
120264
- "default": "'white'",
120265
- "description": "Background color of the sidebar. Either `white` or `milk`.",
120266
- "attribute": "color",
120267
- "reflects": true
120282
+ "description": "Override this method to render the component template.",
120283
+ "inheritedFrom": {
120284
+ "name": "SbbActionBaseElement",
120285
+ "module": "core/base-elements/action-base-element.js"
120286
+ }
120268
120287
  },
120269
120288
  {
120270
- "kind": "field",
120271
- "name": "mode",
120272
- "type": {
120273
- "text": "'side' | 'over'"
120289
+ "kind": "method",
120290
+ "name": "renderIconName",
120291
+ "privacy": "protected",
120292
+ "return": {
120293
+ "type": {
120294
+ "text": "string"
120295
+ }
120274
120296
  },
120275
- "privacy": "public",
120276
- "default": "'side'",
120277
- "description": "Mode of the sidebar; one of 'side' or 'over'.",
120278
- "attribute": "mode",
120279
- "reflects": true
120297
+ "inheritedFrom": {
120298
+ "name": "SbbIconNameMixin",
120299
+ "module": "icon/icon-name-mixin.js"
120300
+ }
120280
120301
  },
120281
120302
  {
120282
120303
  "kind": "field",
120283
- "name": "position",
120304
+ "name": "size",
120284
120305
  "type": {
120285
- "text": "'start' | 'end'"
120306
+ "text": "SbbButtonSize"
120286
120307
  },
120287
120308
  "privacy": "public",
120288
- "default": "'start'",
120289
- "description": "The side that the sidebar is attached to.",
120290
- "attribute": "position",
120291
- "reflects": true
120309
+ "description": "Size variant, either l, m or s.",
120310
+ "default": "'s'",
120311
+ "attribute": "size",
120312
+ "reflects": true,
120313
+ "inheritedFrom": {
120314
+ "name": "SbbButtonCommonElementMixin",
120315
+ "module": "button/common/button-common.js"
120316
+ }
120292
120317
  },
120293
120318
  {
120294
120319
  "kind": "field",
120295
- "name": "opened",
120320
+ "name": "loading",
120296
120321
  "type": {
120297
120322
  "text": "boolean"
120298
120323
  },
120299
120324
  "privacy": "public",
120300
120325
  "default": "false",
120301
- "description": "Whether the sidebar is opened or closed.\nCan be used to initially set the opened state, where\nthe animation will be skipped.",
120302
- "attribute": "opened",
120303
- "reflects": true
120326
+ "description": "Whether the button indicates a loading state.\nThe animation kicks in after a delay of 300ms, configurable with --sbb-button-loading-delay CSS variable.",
120327
+ "attribute": "loading",
120328
+ "reflects": true,
120329
+ "inheritedFrom": {
120330
+ "name": "SbbButtonCommonElementMixin",
120331
+ "module": "button/common/button-common.js"
120332
+ }
120304
120333
  },
120305
120334
  {
120306
120335
  "kind": "field",
120307
- "name": "focusOnOpen",
120336
+ "name": "negative",
120308
120337
  "type": {
120309
120338
  "text": "boolean"
120310
120339
  },
120311
120340
  "privacy": "public",
120312
120341
  "default": "false",
120313
- "description": "Whether the sidebar should focus the first focusable element automatically when opened.\nDefaults to false in when mode is set to `side`, otherwise defaults to true.\nIf explicitly enabled, focus will be moved into the sidebar in `side` mode as well.",
120314
- "attribute": "focus-on-open"
120342
+ "description": "Negative coloring variant flag.",
120343
+ "attribute": "negative",
120344
+ "reflects": true,
120345
+ "inheritedFrom": {
120346
+ "name": "SbbNegativeMixin",
120347
+ "module": "core/mixins/negative-mixin.js"
120348
+ }
120315
120349
  },
120316
120350
  {
120317
120351
  "kind": "field",
120318
- "name": "container",
120352
+ "name": "iconName",
120319
120353
  "type": {
120320
- "text": "SbbSidebarContainerElement | null"
120354
+ "text": "string"
120321
120355
  },
120322
120356
  "privacy": "public",
120323
- "description": "Returns the SbbSidebarContainerElement where this sidebar is contained.",
120324
- "readonly": true,
120325
- "default": "null"
120326
- },
120327
- {
120328
- "kind": "field",
120329
- "name": "_container",
120330
- "type": {
120331
- "text": "SbbSidebarContainerElement | null"
120332
- },
120333
- "privacy": "private",
120334
- "default": "null"
120335
- },
120336
- {
120337
- "kind": "field",
120338
- "name": "_lastFocusedElement",
120339
- "type": {
120340
- "text": "HTMLElement | null"
120341
- },
120342
- "privacy": "private",
120343
- "default": "null"
120344
- },
120345
- {
120346
- "kind": "field",
120347
- "name": "_focusTrapController",
120348
- "privacy": "private",
120349
- "default": "new SbbFocusTrapController(this)"
120350
- },
120351
- {
120352
- "kind": "field",
120353
- "name": "_escapableOverlayController",
120354
- "privacy": "private",
120355
- "default": "new SbbEscapableOverlayController(this)"
120357
+ "default": "''",
120358
+ "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.",
120359
+ "attribute": "icon-name",
120360
+ "inheritedFrom": {
120361
+ "name": "SbbIconNameMixin",
120362
+ "module": "icon/icon-name-mixin.js"
120363
+ }
120356
120364
  },
120357
120365
  {
120358
120366
  "kind": "method",
120359
- "name": "toggle",
120360
- "privacy": "public",
120367
+ "name": "renderIconSlot",
120368
+ "privacy": "protected",
120361
120369
  "return": {
120362
120370
  "type": {
120363
- "text": "void"
120371
+ "text": "TemplateResult"
120364
120372
  }
120365
120373
  },
120366
- "description": "Toggles the sidebar visibility."
120367
- },
120368
- {
120369
- "kind": "method",
120370
- "name": "open",
120371
- "privacy": "public",
120372
- "return": {
120373
- "type": {
120374
- "text": "void"
120374
+ "parameters": [
120375
+ {
120376
+ "name": "classname",
120377
+ "optional": true,
120378
+ "type": {
120379
+ "text": "string"
120380
+ }
120375
120381
  }
120376
- },
120377
- "description": "Opens the sidebar.",
120382
+ ],
120378
120383
  "inheritedFrom": {
120379
- "name": "SbbOpenCloseBaseElement",
120380
- "module": "core/base-elements/open-close-base-element.js"
120384
+ "name": "SbbIconNameMixin",
120385
+ "module": "icon/icon-name-mixin.js"
120381
120386
  }
120382
120387
  },
120383
120388
  {
120384
120389
  "kind": "method",
120385
- "name": "_isZeroAnimationDuration",
120390
+ "name": "_renderIconName",
120386
120391
  "privacy": "private",
120387
120392
  "return": {
120388
120393
  "type": {
120389
- "text": "boolean"
120394
+ "text": "string"
120390
120395
  }
120396
+ },
120397
+ "inheritedFrom": {
120398
+ "name": "SbbIconNameMixin",
120399
+ "module": "icon/icon-name-mixin.js"
120391
120400
  }
120392
120401
  },
120393
120402
  {
120394
- "kind": "method",
120395
- "name": "_handleOpening",
120396
- "privacy": "private",
120397
- "return": {
120398
- "type": {
120399
- "text": "void"
120400
- }
120403
+ "kind": "field",
120404
+ "name": "disabledInteractive",
120405
+ "type": {
120406
+ "text": "boolean"
120407
+ },
120408
+ "privacy": "public",
120409
+ "default": "false",
120410
+ "description": "Whether the button should be aria-disabled but stay interactive.",
120411
+ "attribute": "disabled-interactive",
120412
+ "reflects": true,
120413
+ "inheritedFrom": {
120414
+ "name": "SbbDisabledInteractiveMixin",
120415
+ "module": "core/mixins/disabled-mixin.js"
120401
120416
  }
120402
120417
  },
120403
120418
  {
120404
- "kind": "method",
120405
- "name": "close",
120419
+ "kind": "field",
120420
+ "name": "disabled",
120406
120421
  "privacy": "public",
120407
- "return": {
120408
- "type": {
120409
- "text": "void"
120410
- }
120422
+ "description": "Whether the component is disabled.",
120423
+ "default": "false",
120424
+ "type": {
120425
+ "text": "boolean"
120411
120426
  },
120412
- "description": "Closes the sidebar.",
120427
+ "attribute": "disabled",
120428
+ "reflects": true,
120413
120429
  "inheritedFrom": {
120414
- "name": "SbbOpenCloseBaseElement",
120415
- "module": "core/base-elements/open-close-base-element.js"
120416
- }
120417
- },
120418
- {
120419
- "kind": "method",
120420
- "name": "_handleClosing",
120421
- "privacy": "private",
120422
- "return": {
120423
- "type": {
120424
- "text": "void"
120425
- }
120430
+ "name": "SbbDisabledMixin",
120431
+ "module": "core/mixins/disabled-mixin.js"
120426
120432
  }
120427
120433
  },
120428
120434
  {
120429
- "kind": "method",
120430
- "name": "_takeFocus",
120435
+ "kind": "field",
120436
+ "name": "#disabled",
120431
120437
  "privacy": "private",
120432
- "return": {
120433
- "type": {
120434
- "text": "void"
120435
- }
120438
+ "type": {
120439
+ "text": "boolean"
120440
+ },
120441
+ "default": "false",
120442
+ "inheritedFrom": {
120443
+ "name": "SbbDisabledMixin",
120444
+ "module": "core/mixins/disabled-mixin.js"
120436
120445
  }
120437
120446
  },
120438
120447
  {
120439
120448
  "kind": "method",
120440
- "name": "cedeFocus",
120449
+ "name": "isDisabledExternally",
120441
120450
  "privacy": "protected",
120442
120451
  "return": {
120443
120452
  "type": {
120444
- "text": "void"
120445
- }
120446
- }
120447
- },
120448
- {
120449
- "kind": "method",
120450
- "name": "_updateSidebarWidth",
120451
- "privacy": "private",
120452
- "return": {
120453
- "type": {
120454
- "text": "void"
120453
+ "text": "boolean"
120455
120454
  }
120456
120455
  },
120457
- "parameters": [
120458
- {
120459
- "name": "oldPosition",
120460
- "optional": true,
120461
- "type": {
120462
- "text": "this['position']"
120463
- }
120464
- }
120465
- ]
120456
+ "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
120457
+ "inheritedFrom": {
120458
+ "name": "SbbDisabledMixin",
120459
+ "module": "core/mixins/disabled-mixin.js"
120460
+ }
120466
120461
  },
120467
120462
  {
120468
- "kind": "method",
120469
- "name": "_buildCssWidthVar",
120470
- "privacy": "private",
120471
- "return": {
120472
- "type": {
120473
- "text": "string"
120474
- }
120463
+ "kind": "field",
120464
+ "name": "_elementsOnWhichEnterPressTriggersSubmit",
120465
+ "type": {
120466
+ "text": "array"
120475
120467
  },
120476
- "parameters": [
120477
- {
120478
- "name": "position",
120479
- "default": "this.position"
120480
- }
120481
- ]
120482
- },
120483
- {
120484
- "kind": "method",
120485
- "name": "_isModeOver",
120486
120468
  "privacy": "private",
120487
- "return": {
120488
- "type": {
120489
- "text": "boolean"
120490
- }
120469
+ "readonly": true,
120470
+ "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
120471
+ "inheritedFrom": {
120472
+ "name": "SbbButtonBaseElement",
120473
+ "module": "core/base-elements/button-base-element.js"
120491
120474
  }
120492
120475
  },
120493
120476
  {
120494
- "kind": "method",
120495
- "name": "_onTransitionEnd",
120496
- "privacy": "private",
120497
- "return": {
120498
- "type": {
120499
- "text": "void"
120500
- }
120477
+ "kind": "field",
120478
+ "name": "value",
120479
+ "type": {
120480
+ "text": "string"
120501
120481
  },
120502
- "parameters": [
120503
- {
120504
- "name": "event",
120505
- "type": {
120506
- "text": "TransitionEvent"
120507
- }
120508
- }
120509
- ]
120510
- },
120511
- {
120512
- "kind": "method",
120513
- "name": "_detectScrolledState",
120514
- "privacy": "private",
120515
- "return": {
120516
- "type": {
120517
- "text": "void"
120518
- }
120519
- }
120482
+ "privacy": "public",
120483
+ "inheritedFrom": {
120484
+ "name": "SbbButtonBaseElement",
120485
+ "module": "core/base-elements/button-base-element.js"
120486
+ },
120487
+ "default": "''",
120488
+ "description": "Value of the form element.",
120489
+ "attribute": "value"
120520
120490
  },
120521
120491
  {
120522
120492
  "kind": "field",
120523
- "name": "isAnimating",
120493
+ "name": "type",
120494
+ "privacy": "public",
120495
+ "description": "The type attribute to use for the button.",
120496
+ "default": "'button'",
120524
120497
  "type": {
120525
- "text": "boolean"
120498
+ "text": "SbbButtonType"
120526
120499
  },
120527
- "privacy": "public",
120528
- "default": "false",
120529
- "description": "Whether the component is currently animating.",
120500
+ "attribute": "type",
120530
120501
  "inheritedFrom": {
120531
- "name": "SbbAnimationCompleteMixin",
120532
- "module": "core/mixins/animation-complete-mixin.js"
120502
+ "name": "SbbButtonBaseElement",
120503
+ "module": "core/base-elements/button-base-element.js"
120533
120504
  }
120534
120505
  },
120535
120506
  {
120536
120507
  "kind": "field",
120537
- "name": "animationComplete",
120508
+ "name": "form",
120538
120509
  "type": {
120539
- "text": "Promise<void>"
120510
+ "text": "HTMLFormElement | null"
120540
120511
  },
120541
120512
  "privacy": "public",
120542
- "description": "Returns a promise which completes whenever an animation ends.\nWhen a new animation starts, a new Promise is returned.",
120543
- "readonly": true,
120513
+ "description": "The `<form>` element to associate the button with.",
120544
120514
  "inheritedFrom": {
120545
- "name": "SbbAnimationCompleteMixin",
120546
- "module": "core/mixins/animation-complete-mixin.js"
120547
- }
120515
+ "name": "SbbButtonBaseElement",
120516
+ "module": "core/base-elements/button-base-element.js"
120517
+ },
120518
+ "attribute": "form"
120548
120519
  },
120549
120520
  {
120550
120521
  "kind": "field",
120551
- "name": "_animationPromise",
120522
+ "name": "_formId",
120552
120523
  "type": {
120553
- "text": "Promise<void>"
120524
+ "text": "string"
120554
120525
  },
120555
120526
  "privacy": "private",
120527
+ "default": "''",
120556
120528
  "inheritedFrom": {
120557
- "name": "SbbAnimationCompleteMixin",
120558
- "module": "core/mixins/animation-complete-mixin.js"
120529
+ "name": "SbbButtonBaseElement",
120530
+ "module": "core/base-elements/button-base-element.js"
120559
120531
  }
120560
120532
  },
120561
120533
  {
120562
- "kind": "method",
120563
- "name": "startAnimation",
120564
- "privacy": "protected",
120565
- "return": {
120566
- "type": {
120567
- "text": "void"
120568
- }
120569
- },
120534
+ "kind": "field",
120535
+ "name": "_handleButtonClick",
120536
+ "privacy": "private",
120570
120537
  "inheritedFrom": {
120571
- "name": "SbbAnimationCompleteMixin",
120572
- "module": "core/mixins/animation-complete-mixin.js"
120538
+ "name": "SbbButtonBaseElement",
120539
+ "module": "core/base-elements/button-base-element.js"
120573
120540
  }
120574
120541
  },
120575
120542
  {
120576
120543
  "kind": "method",
120577
- "name": "stopAnimation",
120578
- "privacy": "protected",
120544
+ "name": "_requestSubmit",
120545
+ "privacy": "private",
120579
120546
  "return": {
120580
120547
  "type": {
120581
120548
  "text": "void"
120582
120549
  }
120583
120550
  },
120584
- "description": "Overriding stopAnimation() breaks functionality.",
120551
+ "parameters": [
120552
+ {
120553
+ "name": "form",
120554
+ "type": {
120555
+ "text": "HTMLFormElement"
120556
+ }
120557
+ }
120558
+ ],
120585
120559
  "inheritedFrom": {
120586
- "name": "SbbAnimationCompleteMixin",
120587
- "module": "core/mixins/animation-complete-mixin.js"
120560
+ "name": "SbbButtonBaseElement",
120561
+ "module": "core/base-elements/button-base-element.js"
120588
120562
  }
120589
120563
  },
120590
120564
  {
120591
- "kind": "method",
120592
- "name": "_enqueueAnimation",
120565
+ "kind": "field",
120566
+ "name": "_formKeyDown",
120593
120567
  "privacy": "private",
120594
- "return": {
120595
- "type": {
120596
- "text": "Promise<void>"
120597
- }
120598
- },
120599
120568
  "inheritedFrom": {
120600
- "name": "SbbAnimationCompleteMixin",
120601
- "module": "core/mixins/animation-complete-mixin.js"
120569
+ "name": "SbbButtonBaseElement",
120570
+ "module": "core/base-elements/button-base-element.js"
120602
120571
  }
120603
120572
  },
120604
120573
  {
120605
120574
  "kind": "field",
120606
- "name": "events",
120575
+ "name": "formAssociated",
120576
+ "type": {
120577
+ "text": "boolean"
120578
+ },
120607
120579
  "privacy": "public",
120608
120580
  "static": true,
120609
- "readonly": true,
120610
- "default": "{ beforeopen: 'beforeopen', open: 'open', beforeclose: 'beforeclose', close: 'close', }",
120581
+ "default": "true",
120582
+ "inheritedFrom": {
120583
+ "name": "SbbFormAssociatedMixin",
120584
+ "module": "core/mixins/form-associated-mixin.js"
120585
+ }
120586
+ },
120587
+ {
120588
+ "kind": "field",
120589
+ "name": "name",
120590
+ "privacy": "public",
120591
+ "description": "Name of the form element. Will be read from name attribute.",
120611
120592
  "type": {
120612
- "text": "{\n beforeopen: 'beforeopen',\n open: 'open',\n beforeclose: 'beforeclose',\n close: 'close',\n }"
120593
+ "text": "string"
120613
120594
  },
120595
+ "attribute": "name",
120614
120596
  "inheritedFrom": {
120615
- "name": "SbbOpenCloseBaseElement",
120616
- "module": "core/base-elements/open-close-base-element.js"
120597
+ "name": "SbbFormAssociatedMixin",
120598
+ "module": "core/mixins/form-associated-mixin.js"
120617
120599
  }
120618
120600
  },
120619
120601
  {
120620
120602
  "kind": "field",
120621
- "name": "state",
120622
- "privacy": "protected",
120623
- "description": "The state of the component.",
120603
+ "name": "validity",
120624
120604
  "type": {
120625
- "text": "SbbOpenedClosedState"
120605
+ "text": "ValidityState"
120626
120606
  },
120627
- "default": "'closed'",
120607
+ "privacy": "public",
120608
+ "description": "Returns the ValidityState object for this element.",
120609
+ "readonly": true,
120628
120610
  "inheritedFrom": {
120629
- "name": "SbbOpenCloseBaseElement",
120630
- "module": "core/base-elements/open-close-base-element.js"
120611
+ "name": "SbbFormAssociatedMixin",
120612
+ "module": "core/mixins/form-associated-mixin.js"
120631
120613
  }
120632
120614
  },
120633
120615
  {
120634
120616
  "kind": "field",
120635
- "name": "_state",
120617
+ "name": "validationMessage",
120636
120618
  "type": {
120637
- "text": "SbbOpenedClosedState"
120619
+ "text": "string"
120638
120620
  },
120639
- "privacy": "private",
120621
+ "privacy": "public",
120622
+ "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.",
120623
+ "readonly": true,
120640
120624
  "inheritedFrom": {
120641
- "name": "SbbOpenCloseBaseElement",
120642
- "module": "core/base-elements/open-close-base-element.js"
120625
+ "name": "SbbFormAssociatedMixin",
120626
+ "module": "core/mixins/form-associated-mixin.js"
120643
120627
  }
120644
120628
  },
120645
120629
  {
120646
120630
  "kind": "field",
120647
- "name": "isOpen",
120631
+ "name": "willValidate",
120648
120632
  "type": {
120649
120633
  "text": "boolean"
120650
120634
  },
120651
120635
  "privacy": "public",
120652
- "description": "Whether the element is open.",
120636
+ "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
120653
120637
  "readonly": true,
120654
120638
  "inheritedFrom": {
120655
- "name": "SbbOpenCloseBaseElement",
120656
- "module": "core/base-elements/open-close-base-element.js"
120639
+ "name": "SbbFormAssociatedMixin",
120640
+ "module": "core/mixins/form-associated-mixin.js"
120641
+ }
120642
+ },
120643
+ {
120644
+ "kind": "field",
120645
+ "name": "_validityStates",
120646
+ "privacy": "private",
120647
+ "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
120648
+ "inheritedFrom": {
120649
+ "name": "SbbFormAssociatedMixin",
120650
+ "module": "core/mixins/form-associated-mixin.js"
120651
+ }
120652
+ },
120653
+ {
120654
+ "kind": "field",
120655
+ "name": "formDisabled",
120656
+ "type": {
120657
+ "text": "boolean"
120658
+ },
120659
+ "privacy": "protected",
120660
+ "default": "false",
120661
+ "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
120662
+ "inheritedFrom": {
120663
+ "name": "SbbFormAssociatedMixin",
120664
+ "module": "core/mixins/form-associated-mixin.js"
120657
120665
  }
120658
120666
  },
120659
120667
  {
120660
120668
  "kind": "method",
120661
- "name": "escapeStrategy",
120669
+ "name": "checkValidity",
120662
120670
  "privacy": "public",
120663
120671
  "return": {
120664
120672
  "type": {
120665
- "text": "void"
120673
+ "text": "boolean"
120666
120674
  }
120667
120675
  },
120668
- "description": "The method which is called on escape key press. Defaults to calling close()",
120676
+ "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
120669
120677
  "inheritedFrom": {
120670
- "name": "SbbOpenCloseBaseElement",
120671
- "module": "core/base-elements/open-close-base-element.js"
120678
+ "name": "SbbFormAssociatedMixin",
120679
+ "module": "core/mixins/form-associated-mixin.js"
120672
120680
  }
120673
120681
  },
120674
120682
  {
120675
120683
  "kind": "method",
120676
- "name": "dispatchBeforeOpenEvent",
120677
- "privacy": "protected",
120684
+ "name": "reportValidity",
120685
+ "privacy": "public",
120678
120686
  "return": {
120679
120687
  "type": {
120680
120688
  "text": "boolean"
120681
120689
  }
120682
120690
  },
120691
+ "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.",
120683
120692
  "inheritedFrom": {
120684
- "name": "SbbOpenCloseBaseElement",
120685
- "module": "core/base-elements/open-close-base-element.js"
120693
+ "name": "SbbFormAssociatedMixin",
120694
+ "module": "core/mixins/form-associated-mixin.js"
120686
120695
  }
120687
120696
  },
120688
120697
  {
120689
120698
  "kind": "method",
120690
- "name": "dispatchOpenEvent",
120691
- "privacy": "protected",
120699
+ "name": "setCustomValidity",
120700
+ "privacy": "public",
120692
120701
  "return": {
120693
120702
  "type": {
120694
- "text": "boolean"
120703
+ "text": "void"
120695
120704
  }
120696
120705
  },
120706
+ "parameters": [
120707
+ {
120708
+ "name": "message",
120709
+ "type": {
120710
+ "text": "string"
120711
+ }
120712
+ }
120713
+ ],
120714
+ "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.",
120697
120715
  "inheritedFrom": {
120698
- "name": "SbbOpenCloseBaseElement",
120699
- "module": "core/base-elements/open-close-base-element.js"
120716
+ "name": "SbbFormAssociatedMixin",
120717
+ "module": "core/mixins/form-associated-mixin.js"
120700
120718
  }
120701
120719
  },
120702
120720
  {
120703
120721
  "kind": "method",
120704
- "name": "dispatchBeforeCloseEvent",
120705
- "privacy": "protected",
120722
+ "name": "_hasDisabledAncestor",
120723
+ "privacy": "private",
120706
120724
  "return": {
120707
120725
  "type": {
120708
120726
  "text": "boolean"
120709
120727
  }
120710
120728
  },
120711
120729
  "inheritedFrom": {
120712
- "name": "SbbOpenCloseBaseElement",
120713
- "module": "core/base-elements/open-close-base-element.js"
120730
+ "name": "SbbFormAssociatedMixin",
120731
+ "module": "core/mixins/form-associated-mixin.js"
120714
120732
  }
120715
120733
  },
120716
120734
  {
120717
120735
  "kind": "method",
120718
- "name": "dispatchCloseEvent",
120736
+ "name": "updateFormValue",
120719
120737
  "privacy": "protected",
120720
120738
  "return": {
120721
120739
  "type": {
120722
- "text": "boolean"
120740
+ "text": "void"
120723
120741
  }
120724
120742
  },
120743
+ "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",
120725
120744
  "inheritedFrom": {
120726
- "name": "SbbOpenCloseBaseElement",
120727
- "module": "core/base-elements/open-close-base-element.js"
120745
+ "name": "SbbFormAssociatedMixin",
120746
+ "module": "core/mixins/form-associated-mixin.js"
120728
120747
  }
120729
120748
  },
120730
120749
  {
120731
- "kind": "field",
120732
- "name": "_hydrationRequired",
120733
- "type": {
120734
- "text": "boolean"
120750
+ "kind": "method",
120751
+ "name": "formState",
120752
+ "privacy": "protected",
120753
+ "return": {
120754
+ "type": {
120755
+ "text": "FormRestoreState"
120756
+ }
120735
120757
  },
120736
- "privacy": "private",
120737
- "default": "!!this.shadowRoot",
120738
120758
  "inheritedFrom": {
120739
- "name": "SbbElement",
120740
- "module": "core/base-elements/element.js"
120759
+ "name": "SbbFormAssociatedMixin",
120760
+ "module": "core/mixins/form-associated-mixin.js"
120741
120761
  }
120742
120762
  },
120743
120763
  {
120744
- "kind": "field",
120745
- "name": "_hydrationComplete",
120746
- "privacy": "private",
120747
- "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
120764
+ "kind": "method",
120765
+ "name": "setValidityFlag",
120766
+ "privacy": "protected",
120767
+ "return": {
120768
+ "type": {
120769
+ "text": "void"
120770
+ }
120771
+ },
120772
+ "parameters": [
120773
+ {
120774
+ "name": "flag",
120775
+ "type": {
120776
+ "text": "T"
120777
+ }
120778
+ },
120779
+ {
120780
+ "name": "message",
120781
+ "type": {
120782
+ "text": "string"
120783
+ }
120784
+ },
120785
+ {
120786
+ "name": "flagValue",
120787
+ "optional": true,
120788
+ "type": {
120789
+ "text": "ValidityStateFlags[T]"
120790
+ }
120791
+ }
120792
+ ],
120793
+ "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).",
120748
120794
  "inheritedFrom": {
120749
- "name": "SbbElement",
120750
- "module": "core/base-elements/element.js"
120795
+ "name": "SbbFormAssociatedMixin",
120796
+ "module": "core/mixins/form-associated-mixin.js"
120751
120797
  }
120752
120798
  },
120753
120799
  {
120754
- "kind": "field",
120755
- "name": "_resolveHydration",
120756
- "type": {
120757
- "text": "(hydrationRequired: boolean) => void"
120800
+ "kind": "method",
120801
+ "name": "removeValidityFlag",
120802
+ "privacy": "protected",
120803
+ "return": {
120804
+ "type": {
120805
+ "text": "void"
120806
+ }
120758
120807
  },
120759
- "privacy": "private",
120808
+ "parameters": [
120809
+ {
120810
+ "name": "flag",
120811
+ "type": {
120812
+ "text": "T"
120813
+ }
120814
+ }
120815
+ ],
120816
+ "description": "Removes the validity state flag entry and updates validity state.",
120760
120817
  "inheritedFrom": {
120761
- "name": "SbbElement",
120762
- "module": "core/base-elements/element.js"
120818
+ "name": "SbbFormAssociatedMixin",
120819
+ "module": "core/mixins/form-associated-mixin.js"
120763
120820
  }
120764
120821
  },
120765
120822
  {
120766
- "kind": "field",
120767
- "name": "hydrationRequired",
120768
- "type": {
120769
- "text": "boolean"
120770
- },
120823
+ "kind": "method",
120824
+ "name": "validate",
120771
120825
  "privacy": "protected",
120772
- "description": "Returns whether hydration is required and not completed.",
120773
- "readonly": true,
120774
- "inheritedFrom": {
120775
- "name": "SbbElement",
120776
- "module": "core/base-elements/element.js"
120826
+ "return": {
120827
+ "type": {
120828
+ "text": "void"
120829
+ }
120777
120830
  },
120778
- "default": "!!this.shadowRoot"
120831
+ "description": "To be called whenever the current element needs to be validated.",
120832
+ "inheritedFrom": {
120833
+ "name": "SbbFormAssociatedMixin",
120834
+ "module": "core/mixins/form-associated-mixin.js"
120835
+ }
120779
120836
  },
120780
120837
  {
120781
120838
  "kind": "method",
120782
- "name": "toggleState",
120839
+ "name": "shouldValidate",
120783
120840
  "privacy": "protected",
120784
120841
  "return": {
120785
120842
  "type": {
120786
- "text": "void"
120843
+ "text": "boolean"
120787
120844
  }
120788
120845
  },
120789
120846
  "parameters": [
120790
120847
  {
120791
- "name": "value",
120792
- "type": {
120793
- "text": "string"
120794
- }
120795
- },
120796
- {
120797
- "name": "force",
120798
- "optional": true,
120848
+ "name": "name",
120799
120849
  "type": {
120800
- "text": "boolean"
120850
+ "text": "PropertyKey | undefined"
120801
120851
  }
120802
120852
  }
120803
120853
  ],
120854
+ "description": "Whether validation should be run on a property change with the given name.",
120804
120855
  "inheritedFrom": {
120805
- "name": "SbbElement",
120806
- "module": "core/base-elements/element.js"
120856
+ "name": "SbbFormAssociatedMixin",
120857
+ "module": "core/mixins/form-associated-mixin.js"
120858
+ }
120859
+ },
120860
+ {
120861
+ "kind": "method",
120862
+ "name": "_setInternalValidity",
120863
+ "privacy": "private",
120864
+ "return": {
120865
+ "type": {
120866
+ "text": "void"
120867
+ }
120868
+ },
120869
+ "inheritedFrom": {
120870
+ "name": "SbbFormAssociatedMixin",
120871
+ "module": "core/mixins/form-associated-mixin.js"
120807
120872
  }
120808
120873
  },
120809
120874
  {
120810
120875
  "kind": "field",
120811
- "name": "['_$sbbElement$']",
120876
+ "name": "role",
120812
120877
  "type": {
120813
- "text": "boolean"
120878
+ "text": "ElementInternals['role']"
120814
120879
  },
120815
120880
  "privacy": "public",
120816
120881
  "static": true,
120817
- "default": "true",
120882
+ "readonly": true,
120883
+ "default": "'button'",
120818
120884
  "inheritedFrom": {
120819
- "name": "SbbElement",
120820
- "module": "core/base-elements/element.js"
120885
+ "name": "SbbButtonLikeBaseElement",
120886
+ "module": "core/base-elements/button-base-element.js"
120821
120887
  }
120822
120888
  },
120823
120889
  {
120824
120890
  "kind": "field",
120825
- "name": "_controllers",
120826
- "type": {
120827
- "text": "Set<SbbReactiveController> | undefined"
120828
- },
120891
+ "name": "_preventScrollOnSpaceKeydown",
120829
120892
  "privacy": "private",
120893
+ "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
120894
+ "parameters": [
120895
+ {
120896
+ "description": "The origin event.",
120897
+ "name": "event"
120898
+ }
120899
+ ],
120830
120900
  "inheritedFrom": {
120831
- "name": "SbbElement",
120832
- "module": "core/base-elements/element.js"
120901
+ "name": "SbbButtonLikeBaseElement",
120902
+ "module": "core/base-elements/button-base-element.js"
120833
120903
  }
120834
- }
120835
- ],
120836
- "attributes": [
120837
- {
120838
- "name": "color",
120839
- "type": {
120840
- "text": "'white' | 'milk'"
120841
- },
120842
- "default": "'white'",
120843
- "description": "Background color of the sidebar. Either `white` or `milk`.",
120844
- "fieldName": "color"
120845
120904
  },
120846
120905
  {
120847
- "name": "mode",
120848
- "type": {
120849
- "text": "'side' | 'over'"
120850
- },
120851
- "default": "'side'",
120852
- "description": "Mode of the sidebar; one of 'side' or 'over'.",
120853
- "fieldName": "mode"
120906
+ "kind": "field",
120907
+ "name": "_removeActiveMarker",
120908
+ "privacy": "private",
120909
+ "inheritedFrom": {
120910
+ "name": "SbbButtonLikeBaseElement",
120911
+ "module": "core/base-elements/button-base-element.js"
120912
+ }
120854
120913
  },
120855
120914
  {
120856
- "name": "position",
120857
- "type": {
120858
- "text": "'start' | 'end'"
120859
- },
120860
- "default": "'start'",
120861
- "description": "The side that the sidebar is attached to.",
120862
- "fieldName": "position"
120915
+ "kind": "field",
120916
+ "name": "_dispatchClickEventOnSpaceKeyup",
120917
+ "privacy": "private",
120918
+ "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.",
120919
+ "parameters": [
120920
+ {
120921
+ "description": "The origin event.",
120922
+ "name": "event"
120923
+ }
120924
+ ],
120925
+ "inheritedFrom": {
120926
+ "name": "SbbButtonLikeBaseElement",
120927
+ "module": "core/base-elements/button-base-element.js"
120928
+ }
120863
120929
  },
120864
120930
  {
120865
- "name": "opened",
120866
- "type": {
120867
- "text": "boolean"
120868
- },
120869
- "default": "false",
120870
- "description": "Whether the sidebar is opened or closed.\nCan be used to initially set the opened state, where\nthe animation will be skipped.",
120871
- "fieldName": "opened"
120931
+ "kind": "field",
120932
+ "name": "_dispatchClickEvent",
120933
+ "privacy": "private",
120934
+ "inheritedFrom": {
120935
+ "name": "SbbButtonLikeBaseElement",
120936
+ "module": "core/base-elements/button-base-element.js"
120937
+ }
120872
120938
  },
120873
120939
  {
120874
- "name": "focus-on-open",
120875
- "type": {
120876
- "text": "boolean"
120877
- },
120878
- "default": "false",
120879
- "description": "Whether the sidebar should focus the first focusable element automatically when opened.\nDefaults to false in when mode is set to `side`, otherwise defaults to true.\nIf explicitly enabled, focus will be moved into the sidebar in `side` mode as well.",
120880
- "fieldName": "focusOnOpen"
120881
- }
120882
- ],
120883
- "mixins": [
120884
- {
120885
- "name": "SbbAnimationCompleteMixin",
120886
- "module": "core/mixins.js"
120887
- }
120888
- ],
120889
- "superclass": {
120890
- "name": "SbbOpenCloseBaseElement",
120891
- "module": "core/base-elements.js"
120892
- },
120893
- "tagName": "sbb-sidebar",
120894
- "customElement": true,
120895
- "events": [
120896
- {
120897
- "name": "beforeopen",
120940
+ "kind": "field",
120941
+ "name": "maybeDisabled",
120898
120942
  "type": {
120899
- "text": "Event"
120943
+ "text": "boolean | undefined"
120900
120944
  },
120901
- "description": "Emits whenever the component starts the opening transition. Can be canceled.",
120945
+ "privacy": "protected",
120946
+ "readonly": true,
120902
120947
  "inheritedFrom": {
120903
- "name": "SbbOpenCloseBaseElement",
120904
- "module": "core/base-elements/open-close-base-element.js"
120948
+ "name": "SbbActionBaseElement",
120949
+ "module": "core/base-elements/action-base-element.js"
120905
120950
  }
120906
120951
  },
120907
120952
  {
120908
- "name": "open",
120953
+ "kind": "field",
120954
+ "name": "maybeDisabledInteractive",
120909
120955
  "type": {
120910
- "text": "Event"
120956
+ "text": "boolean | undefined"
120911
120957
  },
120912
- "description": "Emits whenever the component is opened.",
120958
+ "privacy": "protected",
120959
+ "readonly": true,
120913
120960
  "inheritedFrom": {
120914
- "name": "SbbOpenCloseBaseElement",
120915
- "module": "core/base-elements/open-close-base-element.js"
120961
+ "name": "SbbActionBaseElement",
120962
+ "module": "core/base-elements/action-base-element.js"
120916
120963
  }
120917
120964
  },
120918
120965
  {
120919
- "name": "beforeclose",
120920
- "type": {
120921
- "text": "Event"
120966
+ "kind": "method",
120967
+ "name": "setupBaseEventHandlers",
120968
+ "privacy": "protected",
120969
+ "return": {
120970
+ "type": {
120971
+ "text": "void"
120972
+ }
120922
120973
  },
120923
- "description": "Emits whenever the component begins the closing transition. Can be canceled.",
120924
120974
  "inheritedFrom": {
120925
- "name": "SbbOpenCloseBaseElement",
120926
- "module": "core/base-elements/open-close-base-element.js"
120975
+ "name": "SbbActionBaseElement",
120976
+ "module": "core/base-elements/action-base-element.js"
120927
120977
  }
120928
120978
  },
120929
120979
  {
120930
- "name": "close",
120980
+ "kind": "field",
120981
+ "name": "_hydrationRequired",
120931
120982
  "type": {
120932
- "text": "Event"
120983
+ "text": "boolean"
120933
120984
  },
120934
- "description": "Emits whenever the component is closed.",
120985
+ "privacy": "private",
120986
+ "default": "!!this.shadowRoot",
120935
120987
  "inheritedFrom": {
120936
- "name": "SbbOpenCloseBaseElement",
120937
- "module": "core/base-elements/open-close-base-element.js"
120988
+ "name": "SbbElement",
120989
+ "module": "core/base-elements/element.js"
120938
120990
  }
120939
- }
120940
- ]
120941
- }
120942
- ],
120943
- "exports": [
120944
- {
120945
- "kind": "js",
120946
- "name": "SbbSidebarElement",
120947
- "declaration": {
120948
- "name": "SbbSidebarElement",
120949
- "module": "sidebar/sidebar/sidebar.component.js"
120950
- }
120951
- }
120952
- ]
120953
- },
120954
- {
120955
- "kind": "javascript-module",
120956
- "path": "sidebar/sidebar-close-button/sidebar-close-button.component.js",
120957
- "declarations": [
120958
- {
120959
- "kind": "class",
120960
- "description": "Sidebar close button, intended to be placed inside sbb-sidebar.",
120961
- "name": "SbbSidebarCloseButtonElement",
120962
- "slots": [
120991
+ },
120963
120992
  {
120964
- "description": "Use the unnamed slot to add content to the sidebar-close-button. Not intended to be used in this context.",
120965
- "name": "",
120993
+ "kind": "field",
120994
+ "name": "_hydrationComplete",
120995
+ "privacy": "private",
120996
+ "default": "new Promise<boolean>( (resolve) => (this._resolveHydration = resolve), )",
120966
120997
  "inheritedFrom": {
120967
- "name": "SbbSecondaryButtonElement",
120968
- "module": "button/secondary-button/secondary-button.component.js"
120998
+ "name": "SbbElement",
120999
+ "module": "core/base-elements/element.js"
120969
121000
  }
120970
121001
  },
120971
121002
  {
120972
- "description": "Slot used to display the icon, if one is set. Not intended to be used in this context.",
120973
- "name": "icon",
121003
+ "kind": "field",
121004
+ "name": "_resolveHydration",
121005
+ "type": {
121006
+ "text": "(hydrationRequired: boolean) => void"
121007
+ },
121008
+ "privacy": "private",
120974
121009
  "inheritedFrom": {
120975
- "name": "SbbSecondaryButtonElement",
120976
- "module": "button/secondary-button/secondary-button.component.js"
121010
+ "name": "SbbElement",
121011
+ "module": "core/base-elements/element.js"
120977
121012
  }
120978
- }
120979
- ],
120980
- "members": [
121013
+ },
120981
121014
  {
120982
121015
  "kind": "field",
120983
- "name": "elementName",
121016
+ "name": "hydrationRequired",
120984
121017
  "type": {
120985
- "text": "string"
121018
+ "text": "boolean"
120986
121019
  },
120987
- "privacy": "public",
120988
- "static": true,
121020
+ "privacy": "protected",
121021
+ "description": "Returns whether hydration is required and not completed.",
120989
121022
  "readonly": true,
120990
121023
  "inheritedFrom": {
120991
121024
  "name": "SbbElement",
120992
121025
  "module": "core/base-elements/element.js"
120993
121026
  },
120994
- "default": "'sbb-sidebar-close-button'"
120995
- },
120996
- {
120997
- "kind": "field",
120998
- "name": "_languageController",
120999
- "privacy": "private",
121000
- "default": "new SbbLanguageController(this)"
121027
+ "default": "!!this.shadowRoot"
121001
121028
  },
121002
121029
  {
121003
121030
  "kind": "method",
121004
- "name": "renderTemplate",
121031
+ "name": "toggleState",
121005
121032
  "privacy": "protected",
121006
121033
  "return": {
121007
121034
  "type": {
121008
- "text": "TemplateResult"
121035
+ "text": "void"
121009
121036
  }
121010
121037
  },
121011
- "description": "Override this method to render the component template.",
121038
+ "parameters": [
121039
+ {
121040
+ "name": "value",
121041
+ "type": {
121042
+ "text": "string"
121043
+ }
121044
+ },
121045
+ {
121046
+ "name": "force",
121047
+ "optional": true,
121048
+ "type": {
121049
+ "text": "boolean"
121050
+ }
121051
+ }
121052
+ ],
121012
121053
  "inheritedFrom": {
121013
- "name": "SbbActionBaseElement",
121014
- "module": "core/base-elements/action-base-element.js"
121054
+ "name": "SbbElement",
121055
+ "module": "core/base-elements/element.js"
121015
121056
  }
121016
121057
  },
121017
121058
  {
121018
- "kind": "method",
121019
- "name": "renderIconName",
121020
- "privacy": "protected",
121021
- "return": {
121022
- "type": {
121023
- "text": "string"
121024
- }
121059
+ "kind": "field",
121060
+ "name": "['_$sbbElement$']",
121061
+ "type": {
121062
+ "text": "boolean"
121025
121063
  },
121064
+ "privacy": "public",
121065
+ "static": true,
121066
+ "default": "true",
121026
121067
  "inheritedFrom": {
121027
- "name": "SbbIconNameMixin",
121028
- "module": "icon/icon-name-mixin.js"
121068
+ "name": "SbbElement",
121069
+ "module": "core/base-elements/element.js"
121029
121070
  }
121030
121071
  },
121031
121072
  {
121032
121073
  "kind": "field",
121074
+ "name": "_controllers",
121075
+ "type": {
121076
+ "text": "Set<SbbReactiveController> | undefined"
121077
+ },
121078
+ "privacy": "private",
121079
+ "inheritedFrom": {
121080
+ "name": "SbbElement",
121081
+ "module": "core/base-elements/element.js"
121082
+ }
121083
+ }
121084
+ ],
121085
+ "superclass": {
121086
+ "name": "SbbSecondaryButtonElement",
121087
+ "module": "button.pure.js"
121088
+ },
121089
+ "tagName": "sbb-sidebar-close-button",
121090
+ "customElement": true,
121091
+ "attributes": [
121092
+ {
121033
121093
  "name": "size",
121034
121094
  "type": {
121035
121095
  "text": "SbbButtonSize"
121036
121096
  },
121037
- "privacy": "public",
121038
121097
  "description": "Size variant, either l, m or s.",
121039
- "default": "'s'",
121040
- "attribute": "size",
121041
- "reflects": true,
121098
+ "default": "'l' / 's' (lean)",
121099
+ "fieldName": "size",
121042
121100
  "inheritedFrom": {
121043
121101
  "name": "SbbButtonCommonElementMixin",
121044
121102
  "module": "button/common/button-common.js"
121045
121103
  }
121046
121104
  },
121047
121105
  {
121048
- "kind": "field",
121049
121106
  "name": "loading",
121050
121107
  "type": {
121051
121108
  "text": "boolean"
121052
121109
  },
121053
- "privacy": "public",
121054
121110
  "default": "false",
121055
121111
  "description": "Whether the button indicates a loading state.\nThe animation kicks in after a delay of 300ms, configurable with --sbb-button-loading-delay CSS variable.",
121056
- "attribute": "loading",
121057
- "reflects": true,
121112
+ "fieldName": "loading",
121058
121113
  "inheritedFrom": {
121059
121114
  "name": "SbbButtonCommonElementMixin",
121060
121115
  "module": "button/common/button-common.js"
121061
121116
  }
121062
121117
  },
121063
121118
  {
121064
- "kind": "field",
121065
121119
  "name": "negative",
121066
121120
  "type": {
121067
121121
  "text": "boolean"
121068
121122
  },
121069
- "privacy": "public",
121070
121123
  "default": "false",
121071
121124
  "description": "Negative coloring variant flag.",
121072
- "attribute": "negative",
121073
- "reflects": true,
121125
+ "fieldName": "negative",
121074
121126
  "inheritedFrom": {
121075
121127
  "name": "SbbNegativeMixin",
121076
121128
  "module": "core/mixins/negative-mixin.js"
121077
121129
  }
121078
121130
  },
121079
121131
  {
121080
- "kind": "field",
121081
- "name": "iconName",
121132
+ "name": "icon-name",
121082
121133
  "type": {
121083
121134
  "text": "string"
121084
121135
  },
121085
- "privacy": "public",
121086
121136
  "default": "''",
121087
121137
  "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.",
121088
- "attribute": "icon-name",
121089
- "inheritedFrom": {
121090
- "name": "SbbIconNameMixin",
121091
- "module": "icon/icon-name-mixin.js"
121092
- }
121093
- },
121094
- {
121095
- "kind": "method",
121096
- "name": "renderIconSlot",
121097
- "privacy": "protected",
121098
- "return": {
121099
- "type": {
121100
- "text": "TemplateResult"
121101
- }
121102
- },
121103
- "parameters": [
121104
- {
121105
- "name": "classname",
121106
- "optional": true,
121107
- "type": {
121108
- "text": "string"
121109
- }
121110
- }
121111
- ],
121112
- "inheritedFrom": {
121113
- "name": "SbbIconNameMixin",
121114
- "module": "icon/icon-name-mixin.js"
121115
- }
121116
- },
121117
- {
121118
- "kind": "method",
121119
- "name": "_renderIconName",
121120
- "privacy": "private",
121121
- "return": {
121122
- "type": {
121123
- "text": "string"
121124
- }
121125
- },
121138
+ "fieldName": "iconName",
121126
121139
  "inheritedFrom": {
121127
121140
  "name": "SbbIconNameMixin",
121128
121141
  "module": "icon/icon-name-mixin.js"
121129
121142
  }
121130
121143
  },
121131
121144
  {
121132
- "kind": "field",
121133
- "name": "disabledInteractive",
121145
+ "name": "disabled-interactive",
121134
121146
  "type": {
121135
121147
  "text": "boolean"
121136
121148
  },
121137
- "privacy": "public",
121138
121149
  "default": "false",
121139
121150
  "description": "Whether the button should be aria-disabled but stay interactive.",
121140
- "attribute": "disabled-interactive",
121141
- "reflects": true,
121151
+ "fieldName": "disabledInteractive",
121142
121152
  "inheritedFrom": {
121143
121153
  "name": "SbbDisabledInteractiveMixin",
121144
121154
  "module": "core/mixins/disabled-mixin.js"
121145
121155
  }
121146
121156
  },
121147
121157
  {
121148
- "kind": "field",
121149
121158
  "name": "disabled",
121150
- "privacy": "public",
121151
121159
  "description": "Whether the component is disabled.",
121152
121160
  "default": "false",
121153
121161
  "type": {
121154
121162
  "text": "boolean"
121155
121163
  },
121156
- "attribute": "disabled",
121157
- "reflects": true,
121158
- "inheritedFrom": {
121159
- "name": "SbbDisabledMixin",
121160
- "module": "core/mixins/disabled-mixin.js"
121161
- }
121162
- },
121163
- {
121164
- "kind": "field",
121165
- "name": "#disabled",
121166
- "privacy": "private",
121167
- "type": {
121168
- "text": "boolean"
121169
- },
121170
- "default": "false",
121171
- "inheritedFrom": {
121172
- "name": "SbbDisabledMixin",
121173
- "module": "core/mixins/disabled-mixin.js"
121174
- }
121175
- },
121176
- {
121177
- "kind": "method",
121178
- "name": "isDisabledExternally",
121179
- "privacy": "protected",
121180
- "return": {
121181
- "type": {
121182
- "text": "boolean"
121183
- }
121184
- },
121185
- "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.",
121164
+ "fieldName": "disabled",
121186
121165
  "inheritedFrom": {
121187
121166
  "name": "SbbDisabledMixin",
121188
121167
  "module": "core/mixins/disabled-mixin.js"
121189
121168
  }
121190
121169
  },
121191
121170
  {
121192
- "kind": "field",
121193
- "name": "_elementsOnWhichEnterPressTriggersSubmit",
121194
- "type": {
121195
- "text": "array"
121196
- },
121197
- "privacy": "private",
121198
- "readonly": true,
121199
- "default": "[ 'input', 'sbb-date-input', 'sbb-time-input', ]",
121200
- "inheritedFrom": {
121201
- "name": "SbbButtonBaseElement",
121202
- "module": "core/base-elements/button-base-element.js"
121203
- }
121204
- },
121205
- {
121206
- "kind": "field",
121207
121171
  "name": "value",
121208
121172
  "type": {
121209
121173
  "text": "string"
121210
121174
  },
121211
- "privacy": "public",
121175
+ "default": "''",
121176
+ "description": "Value of the form element.",
121177
+ "fieldName": "value",
121212
121178
  "inheritedFrom": {
121213
121179
  "name": "SbbButtonBaseElement",
121214
121180
  "module": "core/base-elements/button-base-element.js"
121215
- },
121216
- "default": "''",
121217
- "description": "Value of the form element.",
121218
- "attribute": "value"
121181
+ }
121219
121182
  },
121220
121183
  {
121221
- "kind": "field",
121222
121184
  "name": "type",
121223
- "privacy": "public",
121224
121185
  "description": "The type attribute to use for the button.",
121225
121186
  "default": "'button'",
121226
121187
  "type": {
121227
121188
  "text": "SbbButtonType"
121228
121189
  },
121229
- "attribute": "type",
121190
+ "fieldName": "type",
121230
121191
  "inheritedFrom": {
121231
121192
  "name": "SbbButtonBaseElement",
121232
121193
  "module": "core/base-elements/button-base-element.js"
121233
121194
  }
121234
121195
  },
121235
121196
  {
121236
- "kind": "field",
121237
121197
  "name": "form",
121198
+ "description": "The `<form>` element to associate the button with.",
121238
121199
  "type": {
121239
121200
  "text": "HTMLFormElement | null"
121240
121201
  },
121241
- "privacy": "public",
121242
- "description": "The `<form>` element to associate the button with.",
121202
+ "fieldName": "form",
121243
121203
  "inheritedFrom": {
121244
121204
  "name": "SbbButtonBaseElement",
121245
121205
  "module": "core/base-elements/button-base-element.js"
121246
- },
121247
- "attribute": "form"
121206
+ }
121248
121207
  },
121249
121208
  {
121250
- "kind": "field",
121251
- "name": "_formId",
121209
+ "name": "name",
121210
+ "description": "Name of the form element. Will be read from name attribute.",
121252
121211
  "type": {
121253
121212
  "text": "string"
121254
121213
  },
121255
- "privacy": "private",
121256
- "default": "''",
121214
+ "fieldName": "name",
121257
121215
  "inheritedFrom": {
121258
- "name": "SbbButtonBaseElement",
121259
- "module": "core/base-elements/button-base-element.js"
121216
+ "name": "SbbFormAssociatedMixin",
121217
+ "module": "core/mixins/form-associated-mixin.js"
121260
121218
  }
121261
- },
121219
+ }
121220
+ ],
121221
+ "cssProperties": [
121262
121222
  {
121263
- "kind": "field",
121264
- "name": "_handleButtonClick",
121265
- "privacy": "private",
121223
+ "description": "The delay before the loading animation starts, when setting the button into loading state.",
121224
+ "name": "--sbb-button-loading-delay",
121225
+ "default": "300ms",
121266
121226
  "inheritedFrom": {
121267
- "name": "SbbButtonBaseElement",
121268
- "module": "core/base-elements/button-base-element.js"
121227
+ "name": "SbbSecondaryButtonElement",
121228
+ "module": "button/secondary-button/secondary-button.component.js"
121269
121229
  }
121230
+ }
121231
+ ]
121232
+ }
121233
+ ],
121234
+ "exports": [
121235
+ {
121236
+ "kind": "js",
121237
+ "name": "SbbSidebarCloseButtonElement",
121238
+ "declaration": {
121239
+ "name": "SbbSidebarCloseButtonElement",
121240
+ "module": "sidebar/sidebar-close-button/sidebar-close-button.component.js"
121241
+ }
121242
+ }
121243
+ ]
121244
+ },
121245
+ {
121246
+ "kind": "javascript-module",
121247
+ "path": "sidebar/sidebar/sidebar.component.js",
121248
+ "declarations": [
121249
+ {
121250
+ "kind": "class",
121251
+ "description": "This component corresponds to a sidebar that can be opened on the sidebar container.",
121252
+ "name": "SbbSidebarElement",
121253
+ "slots": [
121254
+ {
121255
+ "description": "Use the unnamed slot to slot any content into the sidebar.",
121256
+ "name": ""
121270
121257
  },
121271
121258
  {
121272
- "kind": "method",
121273
- "name": "_requestSubmit",
121274
- "privacy": "private",
121275
- "return": {
121276
- "type": {
121277
- "text": "void"
121278
- }
121259
+ "description": "Use the title slot to add an <sbb-title>.",
121260
+ "name": "title"
121261
+ }
121262
+ ],
121263
+ "members": [
121264
+ {
121265
+ "kind": "field",
121266
+ "name": "elementName",
121267
+ "type": {
121268
+ "text": "string"
121279
121269
  },
121280
- "parameters": [
121281
- {
121282
- "name": "form",
121283
- "type": {
121284
- "text": "HTMLFormElement"
121285
- }
121286
- }
121287
- ],
121270
+ "privacy": "public",
121271
+ "static": true,
121272
+ "readonly": true,
121288
121273
  "inheritedFrom": {
121289
- "name": "SbbButtonBaseElement",
121290
- "module": "core/base-elements/button-base-element.js"
121291
- }
121274
+ "name": "SbbElement",
121275
+ "module": "core/base-elements/element.js"
121276
+ },
121277
+ "default": "'sbb-sidebar'"
121292
121278
  },
121293
121279
  {
121294
121280
  "kind": "field",
121295
- "name": "_formKeyDown",
121296
- "privacy": "private",
121297
- "inheritedFrom": {
121298
- "name": "SbbButtonBaseElement",
121299
- "module": "core/base-elements/button-base-element.js"
121300
- }
121281
+ "name": "color",
121282
+ "type": {
121283
+ "text": "'white' | 'milk'"
121284
+ },
121285
+ "privacy": "public",
121286
+ "default": "'white'",
121287
+ "description": "Background color of the sidebar. Either `white` or `milk`.",
121288
+ "attribute": "color",
121289
+ "reflects": true
121301
121290
  },
121302
121291
  {
121303
121292
  "kind": "field",
121304
- "name": "formAssociated",
121293
+ "name": "mode",
121305
121294
  "type": {
121306
- "text": "boolean"
121295
+ "text": "'side' | 'over'"
121307
121296
  },
121308
121297
  "privacy": "public",
121309
- "static": true,
121310
- "default": "true",
121311
- "inheritedFrom": {
121312
- "name": "SbbFormAssociatedMixin",
121313
- "module": "core/mixins/form-associated-mixin.js"
121314
- }
121298
+ "default": "'side'",
121299
+ "description": "Mode of the sidebar; one of 'side' or 'over'.",
121300
+ "attribute": "mode",
121301
+ "reflects": true
121315
121302
  },
121316
121303
  {
121317
121304
  "kind": "field",
121318
- "name": "name",
121319
- "privacy": "public",
121320
- "description": "Name of the form element. Will be read from name attribute.",
121305
+ "name": "position",
121321
121306
  "type": {
121322
- "text": "string"
121307
+ "text": "'start' | 'end'"
121323
121308
  },
121324
- "attribute": "name",
121325
- "inheritedFrom": {
121326
- "name": "SbbFormAssociatedMixin",
121327
- "module": "core/mixins/form-associated-mixin.js"
121328
- }
121309
+ "privacy": "public",
121310
+ "default": "'start'",
121311
+ "description": "The side that the sidebar is attached to.",
121312
+ "attribute": "position",
121313
+ "reflects": true
121329
121314
  },
121330
121315
  {
121331
121316
  "kind": "field",
121332
- "name": "validity",
121317
+ "name": "opened",
121333
121318
  "type": {
121334
- "text": "ValidityState"
121319
+ "text": "boolean"
121335
121320
  },
121336
121321
  "privacy": "public",
121337
- "description": "Returns the ValidityState object for this element.",
121338
- "readonly": true,
121339
- "inheritedFrom": {
121340
- "name": "SbbFormAssociatedMixin",
121341
- "module": "core/mixins/form-associated-mixin.js"
121342
- }
121322
+ "default": "false",
121323
+ "description": "Whether the sidebar is opened or closed.\nCan be used to initially set the opened state, where\nthe animation will be skipped.",
121324
+ "attribute": "opened",
121325
+ "reflects": true
121343
121326
  },
121344
121327
  {
121345
121328
  "kind": "field",
121346
- "name": "validationMessage",
121329
+ "name": "focusOnOpen",
121347
121330
  "type": {
121348
- "text": "string"
121331
+ "text": "boolean"
121349
121332
  },
121350
121333
  "privacy": "public",
121351
- "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.",
121352
- "readonly": true,
121353
- "inheritedFrom": {
121354
- "name": "SbbFormAssociatedMixin",
121355
- "module": "core/mixins/form-associated-mixin.js"
121356
- }
121334
+ "default": "false",
121335
+ "description": "Whether the sidebar should focus the first focusable element automatically when opened.\nDefaults to false in when mode is set to `side`, otherwise defaults to true.\nIf explicitly enabled, focus will be moved into the sidebar in `side` mode as well.",
121336
+ "attribute": "focus-on-open"
121357
121337
  },
121358
121338
  {
121359
121339
  "kind": "field",
121360
- "name": "willValidate",
121340
+ "name": "container",
121361
121341
  "type": {
121362
- "text": "boolean"
121342
+ "text": "SbbSidebarContainerElement | null"
121363
121343
  },
121364
121344
  "privacy": "public",
121365
- "description": "Returns true if this element will be validated\nwhen the form is submitted; false otherwise.",
121345
+ "description": "Returns the SbbSidebarContainerElement where this sidebar is contained.",
121366
121346
  "readonly": true,
121367
- "inheritedFrom": {
121368
- "name": "SbbFormAssociatedMixin",
121369
- "module": "core/mixins/form-associated-mixin.js"
121370
- }
121347
+ "default": "null"
121371
121348
  },
121372
121349
  {
121373
121350
  "kind": "field",
121374
- "name": "_validityStates",
121351
+ "name": "_container",
121352
+ "type": {
121353
+ "text": "SbbSidebarContainerElement | null"
121354
+ },
121375
121355
  "privacy": "private",
121376
- "default": "new Map< keyof ValidityStateFlags, { flagValue: unknown; message: string } >()",
121377
- "inheritedFrom": {
121378
- "name": "SbbFormAssociatedMixin",
121379
- "module": "core/mixins/form-associated-mixin.js"
121380
- }
121356
+ "default": "null"
121381
121357
  },
121382
121358
  {
121383
121359
  "kind": "field",
121384
- "name": "formDisabled",
121360
+ "name": "_lastFocusedElement",
121385
121361
  "type": {
121386
- "text": "boolean"
121362
+ "text": "HTMLElement | null"
121387
121363
  },
121388
- "privacy": "protected",
121389
- "default": "false",
121390
- "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
121391
- "inheritedFrom": {
121392
- "name": "SbbFormAssociatedMixin",
121393
- "module": "core/mixins/form-associated-mixin.js"
121394
- }
121364
+ "privacy": "private",
121365
+ "default": "null"
121366
+ },
121367
+ {
121368
+ "kind": "field",
121369
+ "name": "_focusTrapController",
121370
+ "privacy": "private",
121371
+ "default": "new SbbFocusTrapController(this)"
121372
+ },
121373
+ {
121374
+ "kind": "field",
121375
+ "name": "_escapableOverlayController",
121376
+ "privacy": "private",
121377
+ "default": "new SbbEscapableOverlayController(this)"
121378
+ },
121379
+ {
121380
+ "kind": "method",
121381
+ "name": "toggle",
121382
+ "privacy": "public",
121383
+ "return": {
121384
+ "type": {
121385
+ "text": "void"
121386
+ }
121387
+ },
121388
+ "description": "Toggles the sidebar visibility."
121395
121389
  },
121396
121390
  {
121397
121391
  "kind": "method",
121398
- "name": "checkValidity",
121392
+ "name": "open",
121399
121393
  "privacy": "public",
121400
121394
  "return": {
121401
121395
  "type": {
121402
- "text": "boolean"
121396
+ "text": "void"
121403
121397
  }
121404
121398
  },
121405
- "description": "Returns true if this element has no validity problems; false otherwise.\nFires an invalid event at the element in the latter case.",
121399
+ "description": "Opens the sidebar.",
121406
121400
  "inheritedFrom": {
121407
- "name": "SbbFormAssociatedMixin",
121408
- "module": "core/mixins/form-associated-mixin.js"
121401
+ "name": "SbbOpenCloseBaseElement",
121402
+ "module": "core/base-elements/open-close-base-element.js"
121409
121403
  }
121410
121404
  },
121411
121405
  {
121412
121406
  "kind": "method",
121413
- "name": "reportValidity",
121414
- "privacy": "public",
121407
+ "name": "_isZeroAnimationDuration",
121408
+ "privacy": "private",
121415
121409
  "return": {
121416
121410
  "type": {
121417
121411
  "text": "boolean"
121418
121412
  }
121419
- },
121420
- "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.",
121421
- "inheritedFrom": {
121422
- "name": "SbbFormAssociatedMixin",
121423
- "module": "core/mixins/form-associated-mixin.js"
121424
121413
  }
121425
121414
  },
121426
121415
  {
121427
121416
  "kind": "method",
121428
- "name": "setCustomValidity",
121417
+ "name": "_handleOpening",
121418
+ "privacy": "private",
121419
+ "return": {
121420
+ "type": {
121421
+ "text": "void"
121422
+ }
121423
+ }
121424
+ },
121425
+ {
121426
+ "kind": "method",
121427
+ "name": "close",
121429
121428
  "privacy": "public",
121430
121429
  "return": {
121431
121430
  "type": {
121432
121431
  "text": "void"
121433
121432
  }
121434
121433
  },
121435
- "parameters": [
121436
- {
121437
- "name": "message",
121438
- "type": {
121439
- "text": "string"
121440
- }
121441
- }
121442
- ],
121443
- "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.",
121434
+ "description": "Closes the sidebar.",
121444
121435
  "inheritedFrom": {
121445
- "name": "SbbFormAssociatedMixin",
121446
- "module": "core/mixins/form-associated-mixin.js"
121436
+ "name": "SbbOpenCloseBaseElement",
121437
+ "module": "core/base-elements/open-close-base-element.js"
121447
121438
  }
121448
121439
  },
121449
121440
  {
121450
121441
  "kind": "method",
121451
- "name": "_hasDisabledAncestor",
121442
+ "name": "_handleClosing",
121452
121443
  "privacy": "private",
121453
121444
  "return": {
121454
121445
  "type": {
121455
- "text": "boolean"
121446
+ "text": "void"
121456
121447
  }
121457
- },
121458
- "inheritedFrom": {
121459
- "name": "SbbFormAssociatedMixin",
121460
- "module": "core/mixins/form-associated-mixin.js"
121461
121448
  }
121462
121449
  },
121463
121450
  {
121464
121451
  "kind": "method",
121465
- "name": "updateFormValue",
121466
- "privacy": "protected",
121452
+ "name": "_takeFocus",
121453
+ "privacy": "private",
121467
121454
  "return": {
121468
121455
  "type": {
121469
121456
  "text": "void"
121470
121457
  }
121471
- },
121472
- "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",
121473
- "inheritedFrom": {
121474
- "name": "SbbFormAssociatedMixin",
121475
- "module": "core/mixins/form-associated-mixin.js"
121476
121458
  }
121477
121459
  },
121478
121460
  {
121479
121461
  "kind": "method",
121480
- "name": "formState",
121462
+ "name": "cedeFocus",
121481
121463
  "privacy": "protected",
121482
121464
  "return": {
121483
121465
  "type": {
121484
- "text": "FormRestoreState"
121466
+ "text": "void"
121485
121467
  }
121486
- },
121487
- "inheritedFrom": {
121488
- "name": "SbbFormAssociatedMixin",
121489
- "module": "core/mixins/form-associated-mixin.js"
121490
121468
  }
121491
121469
  },
121492
121470
  {
121493
121471
  "kind": "method",
121494
- "name": "setValidityFlag",
121495
- "privacy": "protected",
121472
+ "name": "_updateSidebarWidth",
121473
+ "privacy": "private",
121496
121474
  "return": {
121497
121475
  "type": {
121498
121476
  "text": "void"
@@ -121500,209 +121478,275 @@
121500
121478
  },
121501
121479
  "parameters": [
121502
121480
  {
121503
- "name": "flag",
121504
- "type": {
121505
- "text": "T"
121506
- }
121507
- },
121508
- {
121509
- "name": "message",
121510
- "type": {
121511
- "text": "string"
121512
- }
121513
- },
121514
- {
121515
- "name": "flagValue",
121481
+ "name": "oldPosition",
121516
121482
  "optional": true,
121517
121483
  "type": {
121518
- "text": "ValidityStateFlags[T]"
121484
+ "text": "this['position']"
121519
121485
  }
121520
121486
  }
121521
- ],
121522
- "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).",
121523
- "inheritedFrom": {
121524
- "name": "SbbFormAssociatedMixin",
121525
- "module": "core/mixins/form-associated-mixin.js"
121526
- }
121487
+ ]
121527
121488
  },
121528
121489
  {
121529
121490
  "kind": "method",
121530
- "name": "removeValidityFlag",
121531
- "privacy": "protected",
121491
+ "name": "_buildCssWidthVar",
121492
+ "privacy": "private",
121532
121493
  "return": {
121533
121494
  "type": {
121534
- "text": "void"
121495
+ "text": "string"
121535
121496
  }
121536
121497
  },
121537
121498
  "parameters": [
121538
121499
  {
121539
- "name": "flag",
121540
- "type": {
121541
- "text": "T"
121542
- }
121500
+ "name": "position",
121501
+ "default": "this.position"
121543
121502
  }
121544
- ],
121545
- "description": "Removes the validity state flag entry and updates validity state.",
121546
- "inheritedFrom": {
121547
- "name": "SbbFormAssociatedMixin",
121548
- "module": "core/mixins/form-associated-mixin.js"
121549
- }
121503
+ ]
121550
121504
  },
121551
121505
  {
121552
121506
  "kind": "method",
121553
- "name": "validate",
121554
- "privacy": "protected",
121507
+ "name": "_isModeOver",
121508
+ "privacy": "private",
121555
121509
  "return": {
121556
121510
  "type": {
121557
- "text": "void"
121511
+ "text": "boolean"
121558
121512
  }
121559
- },
121560
- "description": "To be called whenever the current element needs to be validated.",
121561
- "inheritedFrom": {
121562
- "name": "SbbFormAssociatedMixin",
121563
- "module": "core/mixins/form-associated-mixin.js"
121564
121513
  }
121565
121514
  },
121566
121515
  {
121567
121516
  "kind": "method",
121568
- "name": "shouldValidate",
121569
- "privacy": "protected",
121517
+ "name": "_onTransitionEnd",
121518
+ "privacy": "private",
121570
121519
  "return": {
121571
121520
  "type": {
121572
- "text": "boolean"
121521
+ "text": "void"
121573
121522
  }
121574
121523
  },
121575
121524
  "parameters": [
121576
121525
  {
121577
- "name": "name",
121526
+ "name": "event",
121578
121527
  "type": {
121579
- "text": "PropertyKey | undefined"
121528
+ "text": "TransitionEvent"
121580
121529
  }
121581
121530
  }
121582
- ],
121583
- "description": "Whether validation should be run on a property change with the given name.",
121584
- "inheritedFrom": {
121585
- "name": "SbbFormAssociatedMixin",
121586
- "module": "core/mixins/form-associated-mixin.js"
121587
- }
121531
+ ]
121588
121532
  },
121589
121533
  {
121590
121534
  "kind": "method",
121591
- "name": "_setInternalValidity",
121535
+ "name": "_detectScrolledState",
121592
121536
  "privacy": "private",
121593
121537
  "return": {
121594
121538
  "type": {
121595
121539
  "text": "void"
121596
121540
  }
121541
+ }
121542
+ },
121543
+ {
121544
+ "kind": "field",
121545
+ "name": "isAnimating",
121546
+ "type": {
121547
+ "text": "boolean"
121597
121548
  },
121549
+ "privacy": "public",
121550
+ "default": "false",
121551
+ "description": "Whether the component is currently animating.",
121598
121552
  "inheritedFrom": {
121599
- "name": "SbbFormAssociatedMixin",
121600
- "module": "core/mixins/form-associated-mixin.js"
121553
+ "name": "SbbAnimationCompleteMixin",
121554
+ "module": "core/mixins/animation-complete-mixin.js"
121601
121555
  }
121602
121556
  },
121603
121557
  {
121604
121558
  "kind": "field",
121605
- "name": "role",
121559
+ "name": "animationComplete",
121606
121560
  "type": {
121607
- "text": "ElementInternals['role']"
121561
+ "text": "Promise<void>"
121608
121562
  },
121609
121563
  "privacy": "public",
121610
- "static": true,
121564
+ "description": "Returns a promise which completes whenever an animation ends.\nWhen a new animation starts, a new Promise is returned.",
121611
121565
  "readonly": true,
121612
- "default": "'button'",
121613
121566
  "inheritedFrom": {
121614
- "name": "SbbButtonLikeBaseElement",
121615
- "module": "core/base-elements/button-base-element.js"
121567
+ "name": "SbbAnimationCompleteMixin",
121568
+ "module": "core/mixins/animation-complete-mixin.js"
121616
121569
  }
121617
121570
  },
121618
121571
  {
121619
121572
  "kind": "field",
121620
- "name": "_preventScrollOnSpaceKeydown",
121573
+ "name": "_animationPromise",
121574
+ "type": {
121575
+ "text": "Promise<void>"
121576
+ },
121621
121577
  "privacy": "private",
121622
- "description": "Prevents scrolling from pressing Space, when the event target is an action element.\nAlso sets active state.",
121623
- "parameters": [
121624
- {
121625
- "description": "The origin event.",
121626
- "name": "event"
121578
+ "inheritedFrom": {
121579
+ "name": "SbbAnimationCompleteMixin",
121580
+ "module": "core/mixins/animation-complete-mixin.js"
121581
+ }
121582
+ },
121583
+ {
121584
+ "kind": "method",
121585
+ "name": "startAnimation",
121586
+ "privacy": "protected",
121587
+ "return": {
121588
+ "type": {
121589
+ "text": "void"
121627
121590
  }
121628
- ],
121591
+ },
121629
121592
  "inheritedFrom": {
121630
- "name": "SbbButtonLikeBaseElement",
121631
- "module": "core/base-elements/button-base-element.js"
121593
+ "name": "SbbAnimationCompleteMixin",
121594
+ "module": "core/mixins/animation-complete-mixin.js"
121632
121595
  }
121633
121596
  },
121634
121597
  {
121635
- "kind": "field",
121636
- "name": "_removeActiveMarker",
121637
- "privacy": "private",
121598
+ "kind": "method",
121599
+ "name": "stopAnimation",
121600
+ "privacy": "protected",
121601
+ "return": {
121602
+ "type": {
121603
+ "text": "void"
121604
+ }
121605
+ },
121606
+ "description": "Overriding stopAnimation() breaks functionality.",
121638
121607
  "inheritedFrom": {
121639
- "name": "SbbButtonLikeBaseElement",
121640
- "module": "core/base-elements/button-base-element.js"
121608
+ "name": "SbbAnimationCompleteMixin",
121609
+ "module": "core/mixins/animation-complete-mixin.js"
121641
121610
  }
121642
121611
  },
121643
121612
  {
121644
- "kind": "field",
121645
- "name": "_dispatchClickEventOnSpaceKeyup",
121613
+ "kind": "method",
121614
+ "name": "_enqueueAnimation",
121646
121615
  "privacy": "private",
121647
- "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.",
121648
- "parameters": [
121649
- {
121650
- "description": "The origin event.",
121651
- "name": "event"
121616
+ "return": {
121617
+ "type": {
121618
+ "text": "Promise<void>"
121652
121619
  }
121653
- ],
121620
+ },
121654
121621
  "inheritedFrom": {
121655
- "name": "SbbButtonLikeBaseElement",
121656
- "module": "core/base-elements/button-base-element.js"
121622
+ "name": "SbbAnimationCompleteMixin",
121623
+ "module": "core/mixins/animation-complete-mixin.js"
121657
121624
  }
121658
121625
  },
121659
121626
  {
121660
121627
  "kind": "field",
121661
- "name": "_dispatchClickEvent",
121662
- "privacy": "private",
121628
+ "name": "events",
121629
+ "privacy": "public",
121630
+ "static": true,
121631
+ "readonly": true,
121632
+ "default": "{ beforeopen: 'beforeopen', open: 'open', beforeclose: 'beforeclose', close: 'close', }",
121633
+ "type": {
121634
+ "text": "{\n beforeopen: 'beforeopen',\n open: 'open',\n beforeclose: 'beforeclose',\n close: 'close',\n }"
121635
+ },
121663
121636
  "inheritedFrom": {
121664
- "name": "SbbButtonLikeBaseElement",
121665
- "module": "core/base-elements/button-base-element.js"
121637
+ "name": "SbbOpenCloseBaseElement",
121638
+ "module": "core/base-elements/open-close-base-element.js"
121666
121639
  }
121667
121640
  },
121668
121641
  {
121669
121642
  "kind": "field",
121670
- "name": "maybeDisabled",
121643
+ "name": "state",
121644
+ "privacy": "protected",
121645
+ "description": "The state of the component.",
121671
121646
  "type": {
121672
- "text": "boolean | undefined"
121647
+ "text": "SbbOpenedClosedState"
121673
121648
  },
121674
- "privacy": "protected",
121675
- "readonly": true,
121649
+ "default": "'closed'",
121676
121650
  "inheritedFrom": {
121677
- "name": "SbbActionBaseElement",
121678
- "module": "core/base-elements/action-base-element.js"
121651
+ "name": "SbbOpenCloseBaseElement",
121652
+ "module": "core/base-elements/open-close-base-element.js"
121679
121653
  }
121680
121654
  },
121681
121655
  {
121682
121656
  "kind": "field",
121683
- "name": "maybeDisabledInteractive",
121657
+ "name": "_state",
121684
121658
  "type": {
121685
- "text": "boolean | undefined"
121659
+ "text": "SbbOpenedClosedState"
121686
121660
  },
121687
- "privacy": "protected",
121661
+ "privacy": "private",
121662
+ "inheritedFrom": {
121663
+ "name": "SbbOpenCloseBaseElement",
121664
+ "module": "core/base-elements/open-close-base-element.js"
121665
+ }
121666
+ },
121667
+ {
121668
+ "kind": "field",
121669
+ "name": "isOpen",
121670
+ "type": {
121671
+ "text": "boolean"
121672
+ },
121673
+ "privacy": "public",
121674
+ "description": "Whether the element is open.",
121688
121675
  "readonly": true,
121689
121676
  "inheritedFrom": {
121690
- "name": "SbbActionBaseElement",
121691
- "module": "core/base-elements/action-base-element.js"
121677
+ "name": "SbbOpenCloseBaseElement",
121678
+ "module": "core/base-elements/open-close-base-element.js"
121692
121679
  }
121693
121680
  },
121694
121681
  {
121695
121682
  "kind": "method",
121696
- "name": "setupBaseEventHandlers",
121697
- "privacy": "protected",
121683
+ "name": "escapeStrategy",
121684
+ "privacy": "public",
121698
121685
  "return": {
121699
121686
  "type": {
121700
121687
  "text": "void"
121701
121688
  }
121702
121689
  },
121690
+ "description": "The method which is called on escape key press. Defaults to calling close()",
121703
121691
  "inheritedFrom": {
121704
- "name": "SbbActionBaseElement",
121705
- "module": "core/base-elements/action-base-element.js"
121692
+ "name": "SbbOpenCloseBaseElement",
121693
+ "module": "core/base-elements/open-close-base-element.js"
121694
+ }
121695
+ },
121696
+ {
121697
+ "kind": "method",
121698
+ "name": "dispatchBeforeOpenEvent",
121699
+ "privacy": "protected",
121700
+ "return": {
121701
+ "type": {
121702
+ "text": "boolean"
121703
+ }
121704
+ },
121705
+ "inheritedFrom": {
121706
+ "name": "SbbOpenCloseBaseElement",
121707
+ "module": "core/base-elements/open-close-base-element.js"
121708
+ }
121709
+ },
121710
+ {
121711
+ "kind": "method",
121712
+ "name": "dispatchOpenEvent",
121713
+ "privacy": "protected",
121714
+ "return": {
121715
+ "type": {
121716
+ "text": "boolean"
121717
+ }
121718
+ },
121719
+ "inheritedFrom": {
121720
+ "name": "SbbOpenCloseBaseElement",
121721
+ "module": "core/base-elements/open-close-base-element.js"
121722
+ }
121723
+ },
121724
+ {
121725
+ "kind": "method",
121726
+ "name": "dispatchBeforeCloseEvent",
121727
+ "privacy": "protected",
121728
+ "return": {
121729
+ "type": {
121730
+ "text": "boolean"
121731
+ }
121732
+ },
121733
+ "inheritedFrom": {
121734
+ "name": "SbbOpenCloseBaseElement",
121735
+ "module": "core/base-elements/open-close-base-element.js"
121736
+ }
121737
+ },
121738
+ {
121739
+ "kind": "method",
121740
+ "name": "dispatchCloseEvent",
121741
+ "privacy": "protected",
121742
+ "return": {
121743
+ "type": {
121744
+ "text": "boolean"
121745
+ }
121746
+ },
121747
+ "inheritedFrom": {
121748
+ "name": "SbbOpenCloseBaseElement",
121749
+ "module": "core/base-elements/open-close-base-element.js"
121706
121750
  }
121707
121751
  },
121708
121752
  {
@@ -121811,150 +121855,108 @@
121811
121855
  }
121812
121856
  }
121813
121857
  ],
121814
- "superclass": {
121815
- "name": "SbbSecondaryButtonElement",
121816
- "module": "button.pure.js"
121817
- },
121818
- "tagName": "sbb-sidebar-close-button",
121819
- "customElement": true,
121820
121858
  "attributes": [
121821
121859
  {
121822
- "name": "size",
121823
- "type": {
121824
- "text": "SbbButtonSize"
121825
- },
121826
- "description": "Size variant, either l, m or s.",
121827
- "default": "'l' / 's' (lean)",
121828
- "fieldName": "size",
121829
- "inheritedFrom": {
121830
- "name": "SbbButtonCommonElementMixin",
121831
- "module": "button/common/button-common.js"
121832
- }
121833
- },
121834
- {
121835
- "name": "loading",
121860
+ "name": "color",
121836
121861
  "type": {
121837
- "text": "boolean"
121862
+ "text": "'white' | 'milk'"
121838
121863
  },
121839
- "default": "false",
121840
- "description": "Whether the button indicates a loading state.\nThe animation kicks in after a delay of 300ms, configurable with --sbb-button-loading-delay CSS variable.",
121841
- "fieldName": "loading",
121842
- "inheritedFrom": {
121843
- "name": "SbbButtonCommonElementMixin",
121844
- "module": "button/common/button-common.js"
121845
- }
121864
+ "default": "'white'",
121865
+ "description": "Background color of the sidebar. Either `white` or `milk`.",
121866
+ "fieldName": "color"
121846
121867
  },
121847
121868
  {
121848
- "name": "negative",
121869
+ "name": "mode",
121849
121870
  "type": {
121850
- "text": "boolean"
121871
+ "text": "'side' | 'over'"
121851
121872
  },
121852
- "default": "false",
121853
- "description": "Negative coloring variant flag.",
121854
- "fieldName": "negative",
121855
- "inheritedFrom": {
121856
- "name": "SbbNegativeMixin",
121857
- "module": "core/mixins/negative-mixin.js"
121858
- }
121873
+ "default": "'side'",
121874
+ "description": "Mode of the sidebar; one of 'side' or 'over'.",
121875
+ "fieldName": "mode"
121859
121876
  },
121860
121877
  {
121861
- "name": "icon-name",
121878
+ "name": "position",
121862
121879
  "type": {
121863
- "text": "string"
121880
+ "text": "'start' | 'end'"
121864
121881
  },
121865
- "default": "''",
121866
- "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.",
121867
- "fieldName": "iconName",
121868
- "inheritedFrom": {
121869
- "name": "SbbIconNameMixin",
121870
- "module": "icon/icon-name-mixin.js"
121871
- }
121882
+ "default": "'start'",
121883
+ "description": "The side that the sidebar is attached to.",
121884
+ "fieldName": "position"
121872
121885
  },
121873
121886
  {
121874
- "name": "disabled-interactive",
121887
+ "name": "opened",
121875
121888
  "type": {
121876
121889
  "text": "boolean"
121877
121890
  },
121878
121891
  "default": "false",
121879
- "description": "Whether the button should be aria-disabled but stay interactive.",
121880
- "fieldName": "disabledInteractive",
121881
- "inheritedFrom": {
121882
- "name": "SbbDisabledInteractiveMixin",
121883
- "module": "core/mixins/disabled-mixin.js"
121884
- }
121892
+ "description": "Whether the sidebar is opened or closed.\nCan be used to initially set the opened state, where\nthe animation will be skipped.",
121893
+ "fieldName": "opened"
121885
121894
  },
121886
121895
  {
121887
- "name": "disabled",
121888
- "description": "Whether the component is disabled.",
121889
- "default": "false",
121896
+ "name": "focus-on-open",
121890
121897
  "type": {
121891
121898
  "text": "boolean"
121892
121899
  },
121893
- "fieldName": "disabled",
121894
- "inheritedFrom": {
121895
- "name": "SbbDisabledMixin",
121896
- "module": "core/mixins/disabled-mixin.js"
121897
- }
121898
- },
121900
+ "default": "false",
121901
+ "description": "Whether the sidebar should focus the first focusable element automatically when opened.\nDefaults to false in when mode is set to `side`, otherwise defaults to true.\nIf explicitly enabled, focus will be moved into the sidebar in `side` mode as well.",
121902
+ "fieldName": "focusOnOpen"
121903
+ }
121904
+ ],
121905
+ "mixins": [
121899
121906
  {
121900
- "name": "value",
121907
+ "name": "SbbAnimationCompleteMixin",
121908
+ "module": "core/mixins.js"
121909
+ }
121910
+ ],
121911
+ "superclass": {
121912
+ "name": "SbbOpenCloseBaseElement",
121913
+ "module": "core/base-elements.js"
121914
+ },
121915
+ "tagName": "sbb-sidebar",
121916
+ "customElement": true,
121917
+ "events": [
121918
+ {
121919
+ "name": "beforeopen",
121901
121920
  "type": {
121902
- "text": "string"
121921
+ "text": "Event"
121903
121922
  },
121904
- "default": "''",
121905
- "description": "Value of the form element.",
121906
- "fieldName": "value",
121923
+ "description": "Emits whenever the component starts the opening transition. Can be canceled.",
121907
121924
  "inheritedFrom": {
121908
- "name": "SbbButtonBaseElement",
121909
- "module": "core/base-elements/button-base-element.js"
121925
+ "name": "SbbOpenCloseBaseElement",
121926
+ "module": "core/base-elements/open-close-base-element.js"
121910
121927
  }
121911
121928
  },
121912
121929
  {
121913
- "name": "type",
121914
- "description": "The type attribute to use for the button.",
121915
- "default": "'button'",
121930
+ "name": "open",
121916
121931
  "type": {
121917
- "text": "SbbButtonType"
121932
+ "text": "Event"
121918
121933
  },
121919
- "fieldName": "type",
121934
+ "description": "Emits whenever the component is opened.",
121920
121935
  "inheritedFrom": {
121921
- "name": "SbbButtonBaseElement",
121922
- "module": "core/base-elements/button-base-element.js"
121936
+ "name": "SbbOpenCloseBaseElement",
121937
+ "module": "core/base-elements/open-close-base-element.js"
121923
121938
  }
121924
121939
  },
121925
121940
  {
121926
- "name": "form",
121927
- "description": "The `<form>` element to associate the button with.",
121941
+ "name": "beforeclose",
121928
121942
  "type": {
121929
- "text": "HTMLFormElement | null"
121943
+ "text": "Event"
121930
121944
  },
121931
- "fieldName": "form",
121945
+ "description": "Emits whenever the component begins the closing transition. Can be canceled.",
121932
121946
  "inheritedFrom": {
121933
- "name": "SbbButtonBaseElement",
121934
- "module": "core/base-elements/button-base-element.js"
121947
+ "name": "SbbOpenCloseBaseElement",
121948
+ "module": "core/base-elements/open-close-base-element.js"
121935
121949
  }
121936
121950
  },
121937
121951
  {
121938
- "name": "name",
121939
- "description": "Name of the form element. Will be read from name attribute.",
121952
+ "name": "close",
121940
121953
  "type": {
121941
- "text": "string"
121954
+ "text": "Event"
121942
121955
  },
121943
- "fieldName": "name",
121944
- "inheritedFrom": {
121945
- "name": "SbbFormAssociatedMixin",
121946
- "module": "core/mixins/form-associated-mixin.js"
121947
- }
121948
- }
121949
- ],
121950
- "cssProperties": [
121951
- {
121952
- "description": "The delay before the loading animation starts, when setting the button into loading state.",
121953
- "name": "--sbb-button-loading-delay",
121954
- "default": "300ms",
121956
+ "description": "Emits whenever the component is closed.",
121955
121957
  "inheritedFrom": {
121956
- "name": "SbbSecondaryButtonElement",
121957
- "module": "button/secondary-button/secondary-button.component.js"
121958
+ "name": "SbbOpenCloseBaseElement",
121959
+ "module": "core/base-elements/open-close-base-element.js"
121958
121960
  }
121959
121961
  }
121960
121962
  ]
@@ -121963,10 +121965,10 @@
121963
121965
  "exports": [
121964
121966
  {
121965
121967
  "kind": "js",
121966
- "name": "SbbSidebarCloseButtonElement",
121968
+ "name": "SbbSidebarElement",
121967
121969
  "declaration": {
121968
- "name": "SbbSidebarCloseButtonElement",
121969
- "module": "sidebar/sidebar-close-button/sidebar-close-button.component.js"
121970
+ "name": "SbbSidebarElement",
121971
+ "module": "sidebar/sidebar/sidebar.component.js"
121970
121972
  }
121971
121973
  }
121972
121974
  ]