@sbb-esta/lyne-elements 3.12.0 → 3.13.0

package/custom-elements.json

@@ -6539,7 +6539,8 @@
                     "text": "T"
                   }
                 }
-              ]
+              ],
+              "description": "Creates the table in orientation='vertical'."
             },
             {
               "kind": "method",
@@ -8364,6 +8365,7 @@
               "kind": "field",
               "name": "valueAsDate",
               "privacy": "public",
+              "description": "Formats the current input's value as date.",
               "type": {
                 "text": "T | null"
               }
@@ -8777,6 +8779,64 @@
                 "module": "core/mixins/form-associated-input-mixin.js"
               }
             },
+            {
+              "kind": "method",
+              "name": "_requiresEmptyPatch",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedInputMixin",
+                "module": "core/mixins/form-associated-input-mixin.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_assignValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedInputMixin",
+                "module": "core/mixins/form-associated-input-mixin.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_setCursorAt",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "position",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ],
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedInputMixin",
+                "module": "core/mixins/form-associated-input-mixin.js"
+              }
+            },
             {
               "kind": "method",
               "name": "_cleanText",
@@ -9372,6 +9432,7 @@
               "type": {
                 "text": "InputEvent"
               },
+              "description": "The input event fires when the value has been changed as a direct result of a user action.",
               "inheritedFrom": {
                 "name": "SbbFormAssociatedInputMixin",
                 "module": "core/mixins/form-associated-input-mixin.js"
@@ -9382,6 +9443,7 @@
               "type": {
                 "text": "Event"
               },
+              "description": "The change event is fired when the user modifies the element's value. Unlike the input event, the change event is not necessarily fired for each alteration to an element's value.",
               "inheritedFrom": {
                 "name": "SbbFormAssociatedInputMixin",
                 "module": "core/mixins/form-associated-input-mixin.js"
@@ -14729,13 +14791,22 @@
                 "text": "(T = string | string[]) | null"
               },
               "privacy": "public",
-              "default": "null",
               "description": "Value of the form element.",
               "attribute": "value",
               "inheritedFrom": {
                 "name": "SbbFormAssociatedMixin",
                 "module": "core/mixins/form-associated-mixin.js"
-              }
+              },
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "_value",
+              "type": {
+                "text": "T | T[] | null"
+              },
+              "privacy": "private",
+              "default": "null"
             },
             {
               "kind": "field",
@@ -14880,21 +14951,21 @@
             },
             {
               "kind": "field",
-              "name": "_options",
+              "name": "_isValueManuallyAssigned",
               "type": {
-                "text": "SbbOptionElement<T>[]"
+                "text": "boolean"
               },
               "privacy": "private",
-              "description": "Gets all the SbbOptionElement projected in the select.",
-              "readonly": true
+              "default": "false"
             },
             {
               "kind": "field",
-              "name": "_filteredOptions",
+              "name": "options",
               "type": {
                 "text": "SbbOptionElement<T>[]"
               },
-              "privacy": "private",
+              "privacy": "public",
+              "description": "Returns all SbbOptionElements from this sbb-select instance.",
               "readonly": true
             },
             {
@@ -14958,6 +15029,16 @@
               },
               "description": "Gets the current displayed value."
             },
+            {
+              "kind": "method",
+              "name": "_selectableOptions",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "SbbOptionElement<T>[]"
+                }
+              }
+            },
             {
               "kind": "method",
               "name": "_onOptionChanged",
@@ -15004,15 +15085,7 @@
                 "type": {
                   "text": "void"
                 }
-              },
-              "parameters": [
-                {
-                  "name": "selected",
-                  "type": {
-                    "text": "SbbOptionElement<T> | SbbOptionElement<T>[] | null"
-                  }
-                }
-              ]
+              }
             },
             {
               "kind": "method",
@@ -15054,40 +15127,17 @@
             },
             {
               "kind": "method",
-              "name": "_onValueChanged",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "newValue",
-                  "type": {
-                    "text": "T | T[]"
-                  }
-                }
-              ],
-              "description": "Sets the _displayValue by checking the internal sbb-options and setting the correct `selected` value on them."
-            },
-            {
-              "kind": "method",
-              "name": "_readFormData",
-              "privacy": "private",
+              "name": "formState",
+              "privacy": "protected",
               "return": {
                 "type": {
-                  "text": "Promise<T[]>"
+                  "text": "FormRestoreState"
                 }
               },
-              "parameters": [
-                {
-                  "name": "formData",
-                  "type": {
-                    "text": "FormData"
-                  }
-                }
-              ]
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins/form-associated-mixin.js"
+              }
             },
             {
               "kind": "method",
@@ -15228,7 +15278,7 @@
               },
               "parameters": [
                 {
-                  "name": "optionSelectionChange",
+                  "name": "option",
                   "type": {
                     "text": "SbbOptionElement<T>"
                   }
@@ -15475,7 +15525,27 @@
             },
             {
               "kind": "method",
-              "name": "_setValueFromSelected",
+              "name": "_updateOptionsFromValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_updateValueFromOptions",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_updateValueOptionState",
               "privacy": "private",
               "return": {
                 "type": {
@@ -15955,20 +16025,6 @@
                 "module": "core/mixins/form-associated-mixin.js"
               }
             },
-            {
-              "kind": "method",
-              "name": "formState",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "FormRestoreState"
-                }
-              },
-              "inheritedFrom": {
-                "name": "SbbFormAssociatedMixin",
-                "module": "core/mixins/form-associated-mixin.js"
-              }
-            },
             {
               "kind": "method",
               "name": "setValidityFlag",
@@ -16264,11 +16320,10 @@
             },
             {
               "name": "value",
+              "description": "Value of the form element.",
               "type": {
-                "text": "T | T[] | null"
+                "text": "T[] | T | null"
               },
-              "default": "null",
-              "description": "Value of the form element.",
               "fieldName": "value"
             },
             {
@@ -20220,6 +20275,64 @@
                 "module": "core/mixins/form-associated-input-mixin.js"
               }
             },
+            {
+              "kind": "method",
+              "name": "_requiresEmptyPatch",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              },
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedInputMixin",
+                "module": "core/mixins/form-associated-input-mixin.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_assignValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ],
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedInputMixin",
+                "module": "core/mixins/form-associated-input-mixin.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_setCursorAt",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "position",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ],
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedInputMixin",
+                "module": "core/mixins/form-associated-input-mixin.js"
+              }
+            },
             {
               "kind": "method",
               "name": "_cleanText",
@@ -20787,6 +20900,7 @@
               "type": {
                 "text": "InputEvent"
               },
+              "description": "The input event fires when the value has been changed as a direct result of a user action.",
               "inheritedFrom": {
                 "name": "SbbFormAssociatedInputMixin",
                 "module": "core/mixins/form-associated-input-mixin.js"
@@ -20797,6 +20911,7 @@
               "type": {
                 "text": "Event"
               },
+              "description": "The change event is fired when the user modifies the element's value. Unlike the input event, the change event is not necessarily fired for each alteration to an element's value.",
               "inheritedFrom": {
                 "name": "SbbFormAssociatedInputMixin",
                 "module": "core/mixins/form-associated-input-mixin.js"
@@ -28123,6 +28238,7 @@
               "kind": "field",
               "name": "_state",
               "privacy": "private",
+              "description": "The state of the breadcrumb group.",
               "type": {
                 "text": "'collapsed' | 'manually-expanded' | null"
               }
@@ -49106,7 +49222,7 @@
                   "text": "number"
                 }
               },
-              "description": "Get the first day of the week (0: sunday; 1: monday; etc.).",
+              "description": "Defines which is the first day of the week (0: sunday; 1: monday; etc.).",
               "inheritedFrom": {
                 "name": "DateAdapter",
                 "module": "core/datetime/date-adapter.js"
@@ -55150,6 +55266,52 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "_requiresEmptyPatch",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_assignValue",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "string"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_setCursorAt",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "position",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ]
+            },
             {
               "kind": "method",
               "name": "_cleanText",
@@ -55630,13 +55792,15 @@
               "name": "input",
               "type": {
                 "text": "InputEvent"
-              }
+              },
+              "description": "The input event fires when the value has been changed as a direct result of a user action."
             },
             {
               "name": "change",
               "type": {
                 "text": "Event"
-              }
+              },
+              "description": "The change event is fired when the user modifies the element's value. Unlike the input event, the change event is not necessarily fired for each alteration to an element's value."
             }
           ],
           "attributes": [
@@ -91123,24 +91287,6 @@
                 }
               }
             },
-            {
-              "kind": "method",
-              "name": "changeAndEmitPage",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "pageIndex",
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ]
-            },
             {
               "kind": "method",
               "name": "nextPage",
@@ -91239,32 +91385,7 @@
             },
             {
               "kind": "method",
-              "name": "emitPageEvent",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "previousPageIndex",
-                  "type": {
-                    "text": "number"
-                  }
-                },
-                {
-                  "name": "pageIndex",
-                  "optional": true,
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ]
-            },
-            {
-              "kind": "method",
-              "name": "_emitPrivatePageEvent",
+              "name": "_emitPageEvent",
               "privacy": "private",
               "return": {
                 "type": {
@@ -91386,7 +91507,7 @@
               "type": {
                 "text": "CustomEvent<SbbPaginatorPageEventDetails>"
               },
-              "description": "The page event is dispatched whenever the user changes the page."
+              "description": "The page event is dispatched when the page index, length or page size changes."
             }
           ],
           "attributes": [
@@ -91545,12 +91666,12 @@
               "kind": "field",
               "name": "events",
               "type": {
-                "text": "{\n    page: 'page',\n    ɵpage: 'ɵpage',\n  }"
+                "text": "{\n    page: 'page',\n  }"
               },
               "privacy": "public",
               "static": true,
               "readonly": true,
-              "default": "{ page: 'page', ɵpage: 'ɵpage', }"
+              "default": "{ page: 'page', }"
             },
             {
               "kind": "method",
@@ -91759,28 +91880,6 @@
                 "module": "paginator/common/paginator-common.js"
               }
             },
-            {
-              "kind": "method",
-              "name": "changeAndEmitPage",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "pageIndex",
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ],
-              "inheritedFrom": {
-                "name": "SbbPaginatorCommonElementMixin",
-                "module": "paginator/common/paginator-common.js"
-              }
-            },
             {
               "kind": "method",
               "name": "nextPage",
@@ -91911,36 +92010,7 @@
             },
             {
               "kind": "method",
-              "name": "emitPageEvent",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "previousPageIndex",
-                  "type": {
-                    "text": "number"
-                  }
-                },
-                {
-                  "name": "pageIndex",
-                  "optional": true,
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ],
-              "inheritedFrom": {
-                "name": "SbbPaginatorCommonElementMixin",
-                "module": "paginator/common/paginator-common.js"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "_emitPrivatePageEvent",
+              "name": "_emitPageEvent",
               "privacy": "private",
               "return": {
                 "type": {
@@ -92214,7 +92284,7 @@
               "type": {
                 "text": "CustomEvent<SbbPaginatorPageEventDetails>"
               },
-              "description": "The page event is dispatched whenever the user changes the page.",
+              "description": "The page event is dispatched when the page index, length or page size changes.",
               "inheritedFrom": {
                 "name": "SbbPaginatorCommonElementMixin",
                 "module": "paginator/common/paginator-common.js"
@@ -92255,12 +92325,12 @@
               "kind": "field",
               "name": "events",
               "type": {
-                "text": "{\n    page: 'page',\n    ɵpage: 'ɵpage',\n  }"
+                "text": "{\n    page: 'page',\n  }"
               },
               "privacy": "public",
               "static": true,
               "readonly": true,
-              "default": "{ page: 'page', ɵpage: 'ɵpage', }"
+              "default": "{ page: 'page', }"
             },
             {
               "kind": "field",
@@ -92375,25 +92445,6 @@
                 }
               ]
             },
-            {
-              "kind": "method",
-              "name": "_setPageSizeFromSizeOptionsSelect",
-              "privacy": "private",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "value",
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ],
-              "description": "A `pageSize` change would trigger a `pageIndex` change via `willUpdate`;\nthis triggers a `ɵpage` event, but it's late for the `page` event,\nso the checks on the `pageIndex` changes are done here, and possibly the event is emitted."
-            },
             {
               "kind": "method",
               "name": "_renderItemPerPageTemplate",
@@ -92595,28 +92646,6 @@
                 "module": "paginator/common/paginator-common.js"
               }
             },
-            {
-              "kind": "method",
-              "name": "changeAndEmitPage",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "pageIndex",
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ],
-              "inheritedFrom": {
-                "name": "SbbPaginatorCommonElementMixin",
-                "module": "paginator/common/paginator-common.js"
-              }
-            },
             {
               "kind": "method",
               "name": "nextPage",
@@ -92747,36 +92776,7 @@
             },
             {
               "kind": "method",
-              "name": "emitPageEvent",
-              "privacy": "protected",
-              "return": {
-                "type": {
-                  "text": "void"
-                }
-              },
-              "parameters": [
-                {
-                  "name": "previousPageIndex",
-                  "type": {
-                    "text": "number"
-                  }
-                },
-                {
-                  "name": "pageIndex",
-                  "optional": true,
-                  "type": {
-                    "text": "number"
-                  }
-                }
-              ],
-              "inheritedFrom": {
-                "name": "SbbPaginatorCommonElementMixin",
-                "module": "paginator/common/paginator-common.js"
-              }
-            },
-            {
-              "kind": "method",
-              "name": "_emitPrivatePageEvent",
+              "name": "_emitPageEvent",
               "privacy": "private",
               "return": {
                 "type": {
@@ -93068,7 +93068,7 @@
               "type": {
                 "text": "CustomEvent<SbbPaginatorPageEventDetails>"
               },
-              "description": "The page event is dispatched whenever the user changes the page.",
+              "description": "The page event is dispatched when the page index, length or page size changes.",
               "inheritedFrom": {
                 "name": "SbbPaginatorCommonElementMixin",
                 "module": "paginator/common/paginator-common.js"