@sbb-esta/lyne-elements 1.11.2 → 1.12.0

package/custom-elements.json

@@ -9201,6 +9201,483 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "paginator.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "description": "It displays a paginator component.",
+          "name": "SbbPaginatorElement",
+          "members": [
+            {
+              "kind": "field",
+              "name": "events",
+              "type": {
+                "text": "{\n    page: 'page',\n  }"
+              },
+              "privacy": "public",
+              "static": true,
+              "readonly": true,
+              "default": "{ page: 'page', }"
+            },
+            {
+              "kind": "field",
+              "name": "length",
+              "privacy": "public",
+              "description": "Total number of items.",
+              "type": {
+                "text": "number"
+              },
+              "attribute": "length",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "_length",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "pageSize",
+              "privacy": "public",
+              "description": "Number of items per page.",
+              "type": {
+                "text": "number"
+              },
+              "attribute": "page-size",
+              "default": "10"
+            },
+            {
+              "kind": "field",
+              "name": "_pageSize",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "10"
+            },
+            {
+              "kind": "field",
+              "name": "pageIndex",
+              "privacy": "public",
+              "description": "Current page index.",
+              "type": {
+                "text": "number"
+              },
+              "attribute": "page-index",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "_pageIndex",
+              "type": {
+                "text": "number"
+              },
+              "privacy": "private",
+              "default": "0"
+            },
+            {
+              "kind": "field",
+              "name": "pageSizeOptions",
+              "privacy": "public",
+              "description": "The available `pageSize` choices.",
+              "type": {
+                "text": "number[] | undefined"
+              },
+              "attribute": "page-size-options"
+            },
+            {
+              "kind": "field",
+              "name": "_pageSizeOptions",
+              "type": {
+                "text": "number[] | undefined"
+              },
+              "privacy": "private"
+            },
+            {
+              "kind": "field",
+              "name": "pagerPosition",
+              "type": {
+                "text": "'start' | 'end'"
+              },
+              "privacy": "public",
+              "default": "'start'",
+              "description": "Position of the prev/next buttons: if `pageSizeOptions` is set, the sbb-select for the pageSize change\nwill be positioned oppositely with the page numbers always in the center.",
+              "attribute": "pager-position",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "size",
+              "type": {
+                "text": "'m' | 's'"
+              },
+              "privacy": "public",
+              "default": "'m'",
+              "description": "Size variant, either m or s.",
+              "attribute": "size",
+              "reflects": true
+            },
+            {
+              "kind": "field",
+              "name": "_page",
+              "type": {
+                "text": "EventEmitter<SbbPaginatorPageEventDetails>"
+              },
+              "privacy": "private",
+              "default": "new EventEmitter( this, SbbPaginatorElement.events.page, { composed: true, bubbles: true }, )"
+            },
+            {
+              "kind": "field",
+              "name": "_paginatorOptionsLabel",
+              "privacy": "private",
+              "default": "`sbb-paginator-options-label-${++nextId}`"
+            },
+            {
+              "kind": "field",
+              "name": "_language",
+              "privacy": "private",
+              "default": "new SbbLanguageController(this)"
+            },
+            {
+              "kind": "field",
+              "name": "_markForFocus",
+              "type": {
+                "text": "number | null"
+              },
+              "privacy": "private",
+              "default": "null"
+            },
+            {
+              "kind": "field",
+              "name": "_updateSelectAriaLabelledBy",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "private",
+              "default": "false"
+            },
+            {
+              "kind": "method",
+              "name": "_numberOfPages",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "number"
+                }
+              },
+              "description": "Calculates the current number of pages based on the `length` and the `pageSize`;\nvalue must be rounded up (e.g. `length = 21` and `pageSize = 10` means 3 pages)."
+            },
+            {
+              "kind": "method",
+              "name": "_pageSizeChanged",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ],
+              "description": "If the `pageSize` changes due to user interaction with the `pageSizeOptions` select,\nemit the `page` event and then update the `pageSize` value."
+            },
+            {
+              "kind": "method",
+              "name": "_pageIndexChanged",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "value",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ],
+              "description": "If the `pageIndex` changes due to user interaction,\nemit the `page` event and then update the `pageIndex` value."
+            },
+            {
+              "kind": "method",
+              "name": "_emitPageEvent",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "previousPageIndex",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_getVisiblePages",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "Element[]"
+                }
+              },
+              "description": "Returns the displayed page elements."
+            },
+            {
+              "kind": "method",
+              "name": "_coercePageIndexInRange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "number"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "pageIndex",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ],
+              "description": "Evaluate `pageIndex` by excluding edge cases."
+            },
+            {
+              "kind": "method",
+              "name": "_getVisiblePagesIndex",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "(number | 'ellipsis')[]"
+                }
+              },
+              "description": "Calculate the pages set based on the following rules:\n - the first page must always be visible;\n - the last page must always be visible;\n - if there are more than `MAX_PAGE_NUMBERS_DISPLAYED` other pages, ellipsis button must be used."
+            },
+            {
+              "kind": "method",
+              "name": "_range",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "number[]"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "length",
+                  "type": {
+                    "text": "number"
+                  }
+                },
+                {
+                  "name": "offset",
+                  "default": "0",
+                  "type": {
+                    "text": "number"
+                  }
+                }
+              ],
+              "description": "Creates an array of consecutive numbers given the length and the starting value."
+            },
+            {
+              "kind": "method",
+              "name": "_handleKeyUp",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "event",
+                  "type": {
+                    "text": "KeyboardEvent"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "_currentPageLabel",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "string"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_renderPrevNextButtons",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_renderItemPerPageTemplate",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult | typeof nothing"
+                }
+              }
+            },
+            {
+              "kind": "method",
+              "name": "_renderPageNumbers",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              }
+            },
+            {
+              "kind": "field",
+              "name": "negative",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "default": "false",
+              "description": "Negative coloring variant flag.",
+              "attribute": "negative",
+              "reflects": true,
+              "inheritedFrom": {
+                "name": "SbbNegativeMixin",
+                "module": "core/mixins.js"
+              }
+            }
+          ],
+          "events": [
+            {
+              "type": {
+                "text": "CustomEvent<SbbPaginatorPageEventDetails>"
+              },
+              "description": "Emits when the pageIndex changes.",
+              "name": "page"
+            }
+          ],
+          "attributes": [
+            {
+              "name": "length",
+              "description": "Total number of items.",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "length"
+            },
+            {
+              "name": "page-size",
+              "description": "Number of items per page.",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "pageSize"
+            },
+            {
+              "name": "page-index",
+              "description": "Current page index.",
+              "type": {
+                "text": "number"
+              },
+              "fieldName": "pageIndex"
+            },
+            {
+              "name": "page-size-options",
+              "description": "The available `pageSize` choices.",
+              "type": {
+                "text": "number[] | undefined"
+              },
+              "fieldName": "pageSizeOptions"
+            },
+            {
+              "name": "pager-position",
+              "type": {
+                "text": "'start' | 'end'"
+              },
+              "default": "'start'",
+              "description": "Position of the prev/next buttons: if `pageSizeOptions` is set, the sbb-select for the pageSize change\nwill be positioned oppositely with the page numbers always in the center.",
+              "fieldName": "pagerPosition"
+            },
+            {
+              "name": "size",
+              "type": {
+                "text": "'m' | 's'"
+              },
+              "default": "'m'",
+              "description": "Size variant, either m or s.",
+              "fieldName": "size"
+            },
+            {
+              "name": "negative",
+              "type": {
+                "text": "boolean"
+              },
+              "default": "false",
+              "description": "Negative coloring variant flag.",
+              "fieldName": "negative",
+              "inheritedFrom": {
+                "name": "SbbNegativeMixin",
+                "module": "core/mixins.js"
+              }
+            }
+          ],
+          "mixins": [
+            {
+              "name": "SbbNegativeMixin",
+              "module": "core/mixins.js"
+            }
+          ],
+          "superclass": {
+            "name": "LitElement",
+            "package": "lit"
+          },
+          "tagName": "sbb-paginator",
+          "customElement": true
+        }
+      ],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "SbbPaginatorElement",
+          "declaration": {
+            "name": "SbbPaginatorElement",
+            "module": "paginator.js"
+          }
+        },
+        {
+          "kind": "custom-element-definition",
+          "name": "sbb-paginator",
+          "declaration": {
+            "name": "SbbPaginatorElement",
+            "module": "paginator.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "popover.js",
@@ -9537,6 +10014,25 @@
               "privacy": "private",
               "readonly": true
             },
+            {
+              "kind": "method",
+              "name": "_onSelectAttributesChange",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "mutationsList",
+                  "type": {
+                    "text": "MutationRecord[]"
+                  }
+                }
+              ],
+              "description": "TODO: Accessibility fix required to correctly read the label;\ncan be possibly removed after the merge of https://github.com/sbb-design-systems/lyne-components/issues/3062"
+            },
             {
               "kind": "method",
               "name": "open",
@@ -11283,67 +11779,67 @@
             {
               "kind": "field",
               "name": "value",
+              "privacy": "public",
+              "description": "Value of the form element.\nIf no value is provided, default is the middle point between min and max.",
               "type": {
-                "text": "string | undefined"
+                "text": "string | null"
               },
-              "privacy": "public",
-              "default": "''",
-              "description": "Value for the inner HTMLInputElement.",
-              "attribute": "value"
+              "attribute": "value",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              },
+              "default": "null"
             },
             {
               "kind": "field",
               "name": "valueAsNumber",
-              "type": {
-                "text": "number | undefined"
-              },
               "privacy": "public",
               "description": "Numeric value for the inner HTMLInputElement.",
+              "type": {
+                "text": "number | null"
+              },
               "attribute": "value-as-number"
             },
             {
               "kind": "field",
-              "name": "name",
+              "name": "min",
+              "privacy": "public",
+              "description": "Minimum acceptable value for the inner HTMLInputElement.",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "privacy": "public",
-              "default": "''",
-              "description": "Name of the inner HTMLInputElement.",
-              "attribute": "name",
-              "reflects": true
+              "attribute": "min",
+              "default": "'0'"
             },
             {
               "kind": "field",
-              "name": "form",
+              "name": "_min",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "privacy": "public",
-              "description": "The <form> element to associate the inner HTMLInputElement with.",
-              "attribute": "form"
+              "privacy": "private",
+              "default": "'0'"
             },
             {
               "kind": "field",
-              "name": "min",
+              "name": "max",
+              "privacy": "public",
+              "description": "Maximum acceptable value for the inner HTMLInputElement.",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "privacy": "public",
-              "default": "'0'",
-              "description": "Minimum acceptable value for the inner HTMLInputElement.",
-              "attribute": "min"
+              "attribute": "max",
+              "default": "'100'"
             },
             {
               "kind": "field",
-              "name": "max",
+              "name": "_max",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "privacy": "public",
-              "default": "'100'",
-              "description": "Maximum acceptable value for the inner HTMLInputElement.",
-              "attribute": "max"
+              "privacy": "private",
+              "default": "'100'"
             },
             {
               "kind": "field",
@@ -11413,41 +11909,61 @@
             },
             {
               "kind": "method",
-              "name": "_syncValues",
+              "name": "_getDefaultValue",
               "privacy": "private",
               "return": {
                 "type": {
-                  "text": "void"
+                  "text": "string"
+                }
+              },
+              "description": "If no value is provided, default is the middle point between min and max\n(see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#value)"
+            },
+            {
+              "kind": "method",
+              "name": "_isValidNumber",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "boolean"
                 }
               },
               "parameters": [
                 {
-                  "name": "newValue",
+                  "name": "value",
                   "type": {
-                    "text": "string | number"
+                    "text": "string | null"
                   }
                 }
               ]
             },
             {
               "kind": "method",
-              "name": "_handleChange",
+              "name": "_boundBetweenMinMax",
               "privacy": "private",
               "return": {
                 "type": {
-                  "text": "void"
+                  "text": "string"
                 }
               },
               "parameters": [
                 {
                   "name": "value",
-                  "default": "this._rangeInput?.valueAsNumber",
                   "type": {
-                    "text": "number"
+                    "text": "string"
                   }
                 }
               ],
-              "description": "Recalculates the `_valueFraction` on change to correctly display the slider knob and lines.\nThe first calculation happens in connectedCallback(...), so since `_rangeInput` is not yet available,\nthe `min` and `max` values are used; if `value` is not provided, the default value is halfway between min and max\n(see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/range#value)."
+              "description": "Restrains the value between the min and max"
+            },
+            {
+              "kind": "method",
+              "name": "_calculateValueFraction",
+              "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              }
             },
             {
               "kind": "method",
@@ -11529,15 +12045,93 @@
                 "name": "SbbDisabledMixin",
                 "module": "core/mixins.js"
               }
-            }
-          ],
-          "events": [
+            },
             {
-              "name": "input",
+              "kind": "field",
+              "name": "formAssociated",
               "type": {
-                "text": "InputEvent"
+                "text": "boolean"
+              },
+              "privacy": "public",
+              "static": true,
+              "default": "true",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
               }
             },
+            {
+              "kind": "field",
+              "name": "form",
+              "type": {
+                "text": "HTMLFormElement | null"
+              },
+              "privacy": "public",
+              "description": "Returns the form owner of internals target element.",
+              "readonly": true,
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "name",
+              "privacy": "public",
+              "description": "Name of the form element. Will be read from name attribute.",
+              "type": {
+                "text": "string"
+              },
+              "attribute": "name",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "_value",
+              "type": {
+                "text": "string | null"
+              },
+              "privacy": "private",
+              "default": "null",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
+            },
+            {
+              "kind": "field",
+              "name": "formDisabled",
+              "type": {
+                "text": "boolean"
+              },
+              "privacy": "protected",
+              "default": "false",
+              "description": "Whenever a surrounding form or fieldset is changing its disabled state.",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
+            },
+            {
+              "kind": "method",
+              "name": "updateFormValue",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Should be called when form value is changed.",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
+            }
+          ],
+          "events": [
             {
               "type": {
                 "text": "CustomEvent<void>"
@@ -11549,54 +12143,38 @@
           "attributes": [
             {
               "name": "value",
+              "description": "Value of the form element.\nIf no value is provided, default is the middle point between min and max.",
               "type": {
-                "text": "string | undefined"
+                "text": "string | null"
               },
-              "default": "''",
-              "description": "Value for the inner HTMLInputElement.",
-              "fieldName": "value"
+              "fieldName": "value",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
             },
             {
               "name": "value-as-number",
-              "type": {
-                "text": "number | undefined"
-              },
               "description": "Numeric value for the inner HTMLInputElement.",
-              "fieldName": "valueAsNumber"
-            },
-            {
-              "name": "name",
-              "type": {
-                "text": "string | undefined"
-              },
-              "default": "''",
-              "description": "Name of the inner HTMLInputElement.",
-              "fieldName": "name"
-            },
-            {
-              "name": "form",
               "type": {
-                "text": "string | undefined"
+                "text": "number | null"
               },
-              "description": "The <form> element to associate the inner HTMLInputElement with.",
-              "fieldName": "form"
+              "fieldName": "valueAsNumber"
             },
             {
               "name": "min",
+              "description": "Minimum acceptable value for the inner HTMLInputElement.",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "default": "'0'",
-              "description": "Minimum acceptable value for the inner HTMLInputElement.",
               "fieldName": "min"
             },
             {
               "name": "max",
+              "description": "Maximum acceptable value for the inner HTMLInputElement.",
               "type": {
-                "text": "string | undefined"
+                "text": "string"
               },
-              "default": "'100'",
-              "description": "Maximum acceptable value for the inner HTMLInputElement.",
               "fieldName": "max"
             },
             {
@@ -11635,12 +12213,28 @@
                 "name": "SbbDisabledMixin",
                 "module": "core/mixins.js"
               }
+            },
+            {
+              "name": "name",
+              "description": "Name of the form element. Will be read from name attribute.",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "name",
+              "inheritedFrom": {
+                "name": "SbbFormAssociatedMixin",
+                "module": "core/mixins.js"
+              }
             }
           ],
           "mixins": [
             {
               "name": "SbbDisabledMixin",
               "module": "core/mixins.js"
+            },
+            {
+              "name": "SbbFormAssociatedMixin",
+              "module": "core/mixins.js"
             }
           ],
           "superclass": {
@@ -32041,6 +32635,55 @@
               }
             }
           ]
+        },
+        {
+          "kind": "variable",
+          "name": "i18nNextPage",
+          "type": {
+            "text": "Record<string, string>"
+          },
+          "default": "{ de: 'Nächste Seite', en: 'Next page', fr: 'Prochaine page', it: 'Pagina successiva', }"
+        },
+        {
+          "kind": "variable",
+          "name": "i18nPreviousPage",
+          "type": {
+            "text": "Record<string, string>"
+          },
+          "default": "{ de: 'Vorherige Seite', en: 'Previous page', fr: 'Page précédente', it: 'Pagina precedente', }"
+        },
+        {
+          "kind": "variable",
+          "name": "i18nPage",
+          "type": {
+            "text": "Record<string, string>"
+          },
+          "default": "{ de: 'Seite', en: 'Page', fr: 'Page', it: 'Pagina', }"
+        },
+        {
+          "kind": "variable",
+          "name": "i18nItemsPerPage",
+          "type": {
+            "text": "Record<string, string>"
+          },
+          "default": "{ de: 'Einträge pro Seite', en: 'Items per page', fr: 'Entrées par page', it: 'Elementi per pagina', }"
+        },
+        {
+          "kind": "function",
+          "name": "i18nSelectedPage",
+          "return": {
+            "type": {
+              "text": "Record<string, string>"
+            }
+          },
+          "parameters": [
+            {
+              "name": "pageNumber",
+              "type": {
+                "text": "number"
+              }
+            }
+          ]
         }
       ],
       "exports": [
@@ -32611,6 +33254,46 @@
             "name": "i18nFileSelectorCurrentlySelected",
             "module": "core/i18n.js"
           }
+        },
+        {
+          "kind": "js",
+          "name": "i18nNextPage",
+          "declaration": {
+            "name": "i18nNextPage",
+            "module": "core/i18n.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "i18nPreviousPage",
+          "declaration": {
+            "name": "i18nPreviousPage",
+            "module": "core/i18n.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "i18nPage",
+          "declaration": {
+            "name": "i18nPage",
+            "module": "core/i18n.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "i18nItemsPerPage",
+          "declaration": {
+            "name": "i18nItemsPerPage",
+            "module": "core/i18n.js"
+          }
+        },
+        {
+          "kind": "js",
+          "name": "i18nSelectedPage",
+          "declaration": {
+            "name": "i18nSelectedPage",
+            "module": "core/i18n.js"
+          }
         }
       ]
     },
@@ -52928,6 +53611,21 @@
         }
       ]
     },
+    {
+      "kind": "javascript-module",
+      "path": "paginator/index.js",
+      "declarations": [],
+      "exports": [
+        {
+          "kind": "js",
+          "name": "*",
+          "declaration": {
+            "name": "*",
+            "package": "./paginator.js"
+          }
+        }
+      ]
+    },
     {
       "kind": "javascript-module",
       "path": "popover/popover-trigger.js",
@@ -54219,7 +54917,7 @@
             },
             {
               "kind": "method",
-              "name": "_onRadioButtonSelect",
+              "name": "_onRadioButtonChange",
               "privacy": "private",
               "return": {
                 "type": {