{ "schemaVersion": "1.0.0", "readme": "", "modules": [ { "kind": "javascript-module", "path": "accordion.js", "declarations": [ { "kind": "class", "description": "It can be used as a container for one or more `sbb-expansion-panel` component.", "name": "SbbAccordionElement", "slots": [ { "description": "Use the unnamed slot to add `sbb-expansion-panel` elements.", "name": "" } ], "members": [ { "kind": "field", "name": "titleLevel", "privacy": "public", "description": "The heading level for the sbb-expansion-panel-headers within the component.", "type": { "text": "SbbTitleLevel | null" }, "attribute": "title-level", "default": "null" }, { "kind": "field", "name": "_titleLevel", "type": { "text": "SbbTitleLevel | null" }, "privacy": "private", "default": "null" }, { "kind": "field", "name": "multi", "privacy": "public", "description": "Whether more than one sbb-expansion-panel can be open at the same time.", "type": { "text": "boolean" }, "attribute": "multi", "default": "false" }, { "kind": "field", "name": "_multi", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "size", "type": { "text": "'s' | 'l'" }, "privacy": "public", "default": "'l'", "description": "Size variant, either l or s; overrides the size on any projected `sbb-expansion-panel`. `", "attribute": "size", "reflects": true }, { "kind": "field", "name": "_abort", "privacy": "private", "default": "new SbbConnectedAbortController(this)" }, { "kind": "method", "name": "_closePanels", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "e", "type": { "text": "CustomEvent" } } ] }, { "kind": "method", "name": "_resetExpansionPanels", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "newValue", "type": { "text": "boolean" } }, { "name": "oldValue", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_setTitleLevelOnChildren", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_expansionPanels", "type": { "text": "SbbExpansionPanelElement[]" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "_handleSlotchange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_hydrationRequired", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "field", "name": "_hydrationComplete", "privacy": "private", "default": "new Promise( (resolve) => (this._resolveHydration = resolve), )", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "field", "name": "_resolveHydration", "type": { "text": "(hydrationRequired: boolean) => void" }, "privacy": "private", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "field", "name": "_handleBeforeHydrationSlotchange", "privacy": "private", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "method", "name": "recoverSsrState", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Called only if Declarative Shadow DOM is detected, during the initialization stage\nbut before the hydration stage.\nWhen using server side rendering, this is called in willUpdate.", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "method", "name": "getAndRemoveAttribute", "privacy": "protected", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "name", "type": { "text": "string" } } ], "description": "Reads and removes an attribute with the given name. Either returns the attributte value or null.", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } } ], "attributes": [ { "name": "title-level", "description": "The heading level for the sbb-expansion-panel-headers within the component.", "type": { "text": "SbbTitleLevel | null" }, "fieldName": "titleLevel" }, { "name": "multi", "description": "Whether more than one sbb-expansion-panel can be open at the same time.", "type": { "text": "boolean" }, "fieldName": "multi" }, { "name": "size", "type": { "text": "'s' | 'l'" }, "default": "'l'", "description": "Size variant, either l or s; overrides the size on any projected `sbb-expansion-panel`. `", "fieldName": "size" } ], "mixins": [ { "name": "SbbHydrationMixin", "module": "core/mixins.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-accordion", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbAccordionElement", "declaration": { "name": "SbbAccordionElement", "module": "accordion.js" } }, { "kind": "custom-element-definition", "name": "sbb-accordion", "declaration": { "name": "SbbAccordionElement", "module": "accordion.js" } } ] }, { "kind": "javascript-module", "path": "action-group.js", "declarations": [ { "kind": "class", "description": "It can be used as a container for one or more action element, like `sbb-button` or `sbb-block-link`.", "name": "SbbActionGroupElement", "slots": [ { "description": "Use the unnamed slot to add `sbb-block-link` or `sbb-button` elements to the `sbb-action-group`.", "name": "" } ], "members": [ { "kind": "field", "name": "alignGroup", "type": { "text": "'start' | 'center' | 'stretch' | 'end'" }, "privacy": "public", "default": "'start'", "description": "Set the slotted `` children's alignment.", "attribute": "align-group", "reflects": true }, { "kind": "field", "name": "horizontalFrom", "type": { "text": "SbbHorizontalFrom" }, "privacy": "public", "default": "'medium'", "description": "Overrides the behaviour of `orientation` property.", "attribute": "horizontal-from", "reflects": true }, { "kind": "field", "name": "orientation", "type": { "text": "SbbOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "Indicates the orientation of the components inside the ``.", "attribute": "orientation", "reflects": true }, { "kind": "field", "name": "buttonSize", "type": { "text": "SbbButtonSize" }, "privacy": "public", "default": "'l'", "description": "Size of the nested sbb-button instances. This will overwrite the size attribute of nested\nsbb-button instances.", "attribute": "button-size", "reflects": true }, { "kind": "field", "name": "linkSize", "type": { "text": "SbbLinkSize" }, "privacy": "public", "default": "'m'", "description": "Size of the nested sbb-block-link instances. This will overwrite the size attribute of nested\nsbb-block-link instances.", "attribute": "link-size", "reflects": true }, { "kind": "method", "name": "_syncButtons", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_syncLinks", "privacy": "private", "return": { "type": { "text": "void" } } } ], "attributes": [ { "name": "align-group", "type": { "text": "'start' | 'center' | 'stretch' | 'end'" }, "default": "'start'", "description": "Set the slotted `` children's alignment.", "fieldName": "alignGroup" }, { "name": "horizontal-from", "type": { "text": "SbbHorizontalFrom" }, "default": "'medium'", "description": "Overrides the behaviour of `orientation` property.", "fieldName": "horizontalFrom" }, { "name": "orientation", "type": { "text": "SbbOrientation" }, "default": "'horizontal'", "description": "Indicates the orientation of the components inside the ``.", "fieldName": "orientation" }, { "name": "button-size", "type": { "text": "SbbButtonSize" }, "default": "'l'", "description": "Size of the nested sbb-button instances. This will overwrite the size attribute of nested\nsbb-button instances.", "fieldName": "buttonSize" }, { "name": "link-size", "type": { "text": "SbbLinkSize" }, "default": "'m'", "description": "Size of the nested sbb-block-link instances. This will overwrite the size attribute of nested\nsbb-block-link instances.", "fieldName": "linkSize" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-action-group", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbActionGroupElement", "declaration": { "name": "SbbActionGroupElement", "module": "action-group.js" } }, { "kind": "custom-element-definition", "name": "sbb-action-group", "declaration": { "name": "SbbActionGroupElement", "module": "action-group.js" } } ] }, { "kind": "javascript-module", "path": "alert.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./alert/alert.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./alert/alert-group.js" } } ] }, { "kind": "javascript-module", "path": "autocomplete.js", "declarations": [ { "kind": "class", "description": "Combined with a native input, it displays a panel with a list of available options.", "name": "SbbAutocompleteElement", "cssProperties": [ { "description": "To specify a custom stack order, the `z-index` can be overridden by defining this CSS variable. The default `z-index` of the component is set to `var(--sbb-overlay-default-z-index)` with a value of `1000`.", "name": "--sbb-autocomplete-z-index", "default": "var(--sbb-overlay-default-z-index)" } ], "slots": [ { "description": "Use the unnamed slot to add `sbb-option` or `sbb-optgroup` elements to the `sbb-autocomplete`.", "name": "" } ], "members": [ { "kind": "field", "name": "events", "privacy": "public", "static": true, "readonly": true, "default": "{ willOpen: 'willOpen', didOpen: 'didOpen', willClose: 'willClose', didClose: 'didClose', }", "type": { "text": "{\n willOpen: 'willOpen',\n didOpen: 'didOpen',\n willClose: 'willClose',\n didClose: 'didClose',\n }" } }, { "kind": "field", "name": "origin", "type": { "text": "string | HTMLElement | undefined" }, "privacy": "public", "description": "The element where the autocomplete will attach; accepts both an element's id or an HTMLElement.\nIf not set, will search for the first 'sbb-form-field' ancestor.", "attribute": "origin" }, { "kind": "field", "name": "trigger", "type": { "text": "string | HTMLInputElement | undefined" }, "privacy": "public", "description": "The input element that will trigger the autocomplete opening; accepts both an element's id or an HTMLElement.\nBy default, the autocomplete will open on focus, click, input or `ArrowDown` keypress of the 'trigger' element.\nIf not set, will search for the first 'input' child of a 'sbb-form-field' ancestor.", "attribute": "trigger" }, { "kind": "field", "name": "preserveIconSpace", "type": { "text": "boolean | undefined" }, "privacy": "public", "description": "Whether the icon space is preserved when no icon is set.", "attribute": "preserve-icon-space", "reflects": true }, { "kind": "field", "name": "_state", "privacy": "private", "type": { "text": "SbbOpenedClosedState" } }, { "kind": "field", "name": "_willOpen", "type": { "text": "EventEmitter" }, "privacy": "private", "default": "new EventEmitter(this, SbbAutocompleteElement.events.willOpen)", "description": "Emits whenever the `sbb-autocomplete` starts the opening transition." }, { "kind": "field", "name": "_didOpen", "type": { "text": "EventEmitter" }, "privacy": "private", "default": "new EventEmitter(this, SbbAutocompleteElement.events.didOpen)", "description": "Emits whenever the `sbb-autocomplete` is opened." }, { "kind": "field", "name": "_willClose", "type": { "text": "EventEmitter" }, "privacy": "private", "default": "new EventEmitter( this, SbbAutocompleteElement.events.willClose, )", "description": "Emits whenever the `sbb-autocomplete` begins the closing transition." }, { "kind": "field", "name": "_didClose", "type": { "text": "EventEmitter" }, "privacy": "private", "default": "new EventEmitter(this, SbbAutocompleteElement.events.didClose)", "description": "Emits whenever the `sbb-autocomplete` is closed." }, { "kind": "field", "name": "_overlay", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "_optionContainer", "type": { "text": "HTMLElement" }, "privacy": "private" }, { "kind": "field", "name": "originElement", "type": { "text": "HTMLElement" }, "privacy": "public", "description": "Returns the element where autocomplete overlay is attached to.", "readonly": true }, { "kind": "field", "name": "_originElement", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "triggerElement", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "public", "description": "Returns the trigger element.", "readonly": true }, { "kind": "field", "name": "_triggerElement", "type": { "text": "HTMLInputElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_triggerEventsController", "type": { "text": "AbortController" }, "privacy": "private" }, { "kind": "field", "name": "_openPanelEventsController", "type": { "text": "AbortController" }, "privacy": "private" }, { "kind": "field", "name": "_overlayId", "privacy": "private", "default": "`sbb-autocomplete-${++nextId}`" }, { "kind": "field", "name": "_activeItemIndex", "type": { "text": "number" }, "privacy": "private", "default": "-1" }, { "kind": "field", "name": "_didLoad", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_isPointerDownEventOnMenu", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_abort", "privacy": "private", "default": "new SbbConnectedAbortController(this)" }, { "kind": "field", "name": "_readonly", "type": { "text": "boolean" }, "privacy": "private", "description": "The autocomplete should inherit 'readonly' state from the trigger.", "readonly": true }, { "kind": "field", "name": "_options", "type": { "text": "SbbOptionElement[]" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "open", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Opens the autocomplete." }, { "kind": "method", "name": "close", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Closes the autocomplete." }, { "kind": "method", "name": "_resetOriginClickListener", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "newValue", "optional": true, "type": { "text": "string | HTMLElement" } }, { "name": "oldValue", "optional": true, "type": { "text": "string | HTMLElement" } } ], "description": "Removes trigger click listener on trigger change." }, { "kind": "method", "name": "_resetTriggerClickListener", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "newValue", "optional": true, "type": { "text": "string | HTMLElement" } }, { "name": "oldValue", "optional": true, "type": { "text": "string | HTMLElement" } } ], "description": "Removes trigger click listener on trigger change." }, { "kind": "method", "name": "_onOptionSelected", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "CustomEvent" } } ], "description": "When an option is selected, update the input value and close the autocomplete." }, { "kind": "method", "name": "_onOptionClick", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "MouseEvent" } } ] }, { "kind": "method", "name": "_syncNegative", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_componentSetup", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_findOriginElement", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Retrieve the element where the autocomplete will be attached." }, { "kind": "method", "name": "_getTriggerElement", "privacy": "private", "return": { "type": { "text": "" } }, "description": "Retrieve the element that will trigger the autocomplete opening." }, { "kind": "method", "name": "_bindTo", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "triggerElem", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "method", "name": "_setupTriggerEvents", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setOverlayPosition", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_onAnimationEnd", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "AnimationEvent" } } ], "description": "On open/close animation end.\nIn rare cases it can be that the animationEnd event is triggered twice.\nTo avoid entering a corrupt state, exit when state is not expected." }, { "kind": "method", "name": "_onOpenAnimationEnd", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_onCloseAnimationEnd", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_attachOpenPanelEvents", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "field", "name": "_pointerDownListener", "privacy": "private" }, { "kind": "field", "name": "_closeOnBackdropClick", "privacy": "private" }, { "kind": "method", "name": "_closedPanelKeyboardInteraction", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_openedPanelKeyboardInteraction", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_selectByKeyboard", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setNextActiveOption", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } } ] }, { "kind": "method", "name": "_resetActiveElement", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_highlightOptions", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "searchTerm", "optional": true, "type": { "text": "string" } } ], "description": "Highlight the searched text on the options." }, { "kind": "method", "name": "_setTriggerAttributes", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "type": { "text": "HTMLInputElement" } } ] }, { "kind": "method", "name": "_removeTriggerAttributes", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "element", "optional": true, "type": { "text": "HTMLInputElement" } } ] }, { "kind": "method", "name": "_handleSlotchange", "privacy": "private", "return": { "type": { "text": "void" } } }, { "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" } }, { "kind": "field", "name": "_hydrationRequired", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "field", "name": "_hydrationComplete", "privacy": "private", "default": "new Promise( (resolve) => (this._resolveHydration = resolve), )", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "field", "name": "_resolveHydration", "type": { "text": "(hydrationRequired: boolean) => void" }, "privacy": "private", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "field", "name": "_handleBeforeHydrationSlotchange", "privacy": "private", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "method", "name": "recoverSsrState", "privacy": "protected", "return": { "type": { "text": "void" } }, "description": "Called only if Declarative Shadow DOM is detected, during the initialization stage\nbut before the hydration stage.\nWhen using server side rendering, this is called in willUpdate.", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } }, { "kind": "method", "name": "getAndRemoveAttribute", "privacy": "protected", "return": { "type": { "text": "string | null" } }, "parameters": [ { "name": "name", "type": { "text": "string" } } ], "description": "Reads and removes an attribute with the given name. Either returns the attributte value or null.", "inheritedFrom": { "name": "SbbHydrationMixin", "module": "core/mixins.js" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Emits whenever the `sbb-autocomplete` starts the opening transition. Can be canceled.", "name": "willOpen" }, { "type": { "text": "CustomEvent" }, "description": "Emits whenever the `sbb-autocomplete` is opened.", "name": "didOpen" }, { "type": { "text": "CustomEvent" }, "description": "Emits whenever the `sbb-autocomplete` begins the closing transition. Can be canceled.", "name": "willClose" }, { "type": { "text": "CustomEvent" }, "description": "Emits whenever the `sbb-autocomplete` is closed.", "name": "didClose" } ], "attributes": [ { "name": "origin", "type": { "text": "string | HTMLElement | undefined" }, "description": "The element where the autocomplete will attach; accepts both an element's id or an HTMLElement.\nIf not set, will search for the first 'sbb-form-field' ancestor.", "fieldName": "origin" }, { "name": "trigger", "type": { "text": "string | HTMLInputElement | undefined" }, "description": "The input element that will trigger the autocomplete opening; accepts both an element's id or an HTMLElement.\nBy default, the autocomplete will open on focus, click, input or `ArrowDown` keypress of the 'trigger' element.\nIf not set, will search for the first 'input' child of a 'sbb-form-field' ancestor.", "fieldName": "trigger" }, { "name": "preserve-icon-space", "type": { "text": "boolean | undefined" }, "description": "Whether the icon space is preserved when no icon is set.", "fieldName": "preserveIconSpace" }, { "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" }, { "name": "SbbHydrationMixin", "module": "core/mixins.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-autocomplete", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbAutocompleteElement", "declaration": { "name": "SbbAutocompleteElement", "module": "autocomplete.js" } }, { "kind": "custom-element-definition", "name": "sbb-autocomplete", "declaration": { "name": "SbbAutocompleteElement", "module": "autocomplete.js" } } ] }, { "kind": "javascript-module", "path": "breadcrumb.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb/breadcrumb.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./breadcrumb/breadcrumb-group.js" } } ] }, { "kind": "javascript-module", "path": "button.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./common/button-common.js", "module": "button.js" } }, { "kind": "js", "name": "buttonCommonStyle", "declaration": { "name": "default", "module": "button.js" } }, { "kind": "js", "name": "buttonPrimaryStyle", "declaration": { "name": "default", "module": "button.js" } }, { "kind": "js", "name": "buttonSecondaryStyle", "declaration": { "name": "default", "module": "button.js" } }, { "kind": "js", "name": "buttonTertiaryStyle", "declaration": { "name": "default", "module": "button.js" } }, { "kind": "js", "name": "buttonTransparentStyle", "declaration": { "name": "default", "module": "button.js" } } ] }, { "kind": "javascript-module", "path": "calendar.js", "declarations": [ { "kind": "class", "description": "It displays a calendar which allows to choose a date.", "name": "SbbCalendarElement", "members": [ { "kind": "field", "name": "events", "privacy": "public", "static": true, "readonly": true, "default": "{ dateSelected: 'dateSelected', }", "type": { "text": "{\n dateSelected: 'dateSelected',\n }" } }, { "kind": "field", "name": "wide", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "If set to true, two months are displayed", "attribute": "wide" }, { "kind": "field", "name": "min", "privacy": "public", "description": "The minimum valid date. Takes T Object, ISOString, and Unix Timestamp (number of seconds since Jan 1, 1970).", "type": { "text": "T | null" }, "attribute": "min" }, { "kind": "field", "name": "_min", "type": { "text": "T | null | undefined" }, "privacy": "private" }, { "kind": "field", "name": "max", "privacy": "public", "description": "The maximum valid date. Takes T Object, ISOString, and Unix Timestamp (number of seconds since Jan 1, 1970).", "type": { "text": "T | null" }, "attribute": "max" }, { "kind": "field", "name": "_max", "type": { "text": "T | null | undefined" }, "privacy": "private" }, { "kind": "field", "name": "selected", "privacy": "public", "description": "The selected date. Takes T Object, ISOString, and Unix Timestamp (number of seconds since Jan 1, 1970).", "type": { "text": "T | null" }, "attribute": "selected" }, { "kind": "field", "name": "_selectedDate", "type": { "text": "T | null | undefined" }, "privacy": "private" }, { "kind": "field", "name": "dateFilter", "type": { "text": "(date: T | null) => boolean | undefined" }, "privacy": "public", "description": "A function used to filter out dates.", "attribute": "date-filter" }, { "kind": "field", "name": "_dateAdapter", "type": { "text": "DateAdapter" }, "privacy": "private", "default": "defaultDateAdapter as unknown" }, { "kind": "field", "name": "_dateSelected", "type": { "text": "EventEmitter" }, "privacy": "private", "default": "new EventEmitter( this, SbbCalendarElement.events.dateSelected, )", "description": "Event emitted on date selection." }, { "kind": "field", "name": "_activeDate", "type": { "text": "T" }, "privacy": "private", "description": "The currently active date." }, { "kind": "field", "name": "_selected", "type": { "text": "string | undefined" }, "privacy": "private", "description": "The selected date as ISOString." }, { "kind": "field", "name": "_wide", "privacy": "private", "description": "The current wide property considering property value and breakpoints. From zero to small `wide` has always to be false.", "type": { "text": "boolean" } }, { "kind": "field", "name": "_calendarView", "type": { "text": "CalendarView" }, "privacy": "private", "default": "'day'" }, { "kind": "field", "name": "_nextCalendarView", "type": { "text": "CalendarView" }, "privacy": "private", "default": "'day'" }, { "kind": "field", "name": "_weekdays", "type": { "text": "Weekday[]" }, "privacy": "private", "description": "A list of days, in two formats (long and single char)." }, { "kind": "field", "name": "_weeks", "type": { "text": "Day[][]" }, "privacy": "private", "default": "[]", "description": "Grid of calendar cells representing the dates of the month." }, { "kind": "field", "name": "_months", "type": { "text": "Month[][]" }, "privacy": "private", "description": "Grid of calendar cells representing months." }, { "kind": "field", "name": "_years", "type": { "text": "number[][]" }, "privacy": "private", "description": "Grid of calendar cells representing years." }, { "kind": "field", "name": "_nextMonthYears", "type": { "text": "number[][]" }, "privacy": "private", "description": "Grid of calendar cells representing years for the wide view." }, { "kind": "field", "name": "_nextMonthWeeks", "type": { "text": "Day[][]" }, "privacy": "private", "description": "Grid of calendar cells representing the dates of the next month." }, { "kind": "field", "name": "_monthNames", "type": { "text": "string[]" }, "privacy": "private", "description": "An array containing all the month names in the current language." }, { "kind": "field", "name": "_cells", "type": { "text": "HTMLButtonElement[]" }, "privacy": "private", "description": "A list of buttons corresponding to days, months or years depending on the view.", "readonly": true }, { "kind": "field", "name": "_chosenYear", "type": { "text": "number | undefined" }, "privacy": "private", "description": "The chosen year in the year selection view." }, { "kind": "field", "name": "_chosenMonth", "type": { "text": "number | undefined" }, "privacy": "private", "description": "The chosen month in the year selection view." }, { "kind": "field", "name": "_resetFocus", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "description": "Whether the focus should be reset on focusCell." }, { "kind": "field", "name": "_initialized", "type": { "text": "boolean" }, "privacy": "private", "default": "false" }, { "kind": "field", "name": "_abort", "privacy": "private", "default": "new SbbConnectedAbortController(this)" }, { "kind": "field", "name": "_language", "privacy": "private" }, { "kind": "field", "name": "_dateFilter", "type": { "text": "(date: T) => boolean" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "resetPosition", "privacy": "public", "return": { "type": { "text": "void" } }, "description": "Resets the active month according to the new state of the calendar." }, { "kind": "method", "name": "_init", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "activeDate", "optional": true, "type": { "text": "T" } } ], "description": "Initializes the component." }, { "kind": "method", "name": "_focusCell", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Focuses on a day cell prioritizing the selected day, the current day, and lastly, the first selectable day." }, { "kind": "method", "name": "_setWeekdays", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Creates the array of weekdays." }, { "kind": "method", "name": "_createWeekRows", "privacy": "private", "return": { "type": { "text": "Day[][]" } }, "parameters": [ { "name": "value", "type": { "text": "T" } } ], "description": "Creates the rows for each week." }, { "kind": "method", "name": "_createMonthRows", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Creates the rows for the month selection view." }, { "kind": "method", "name": "_createYearRows", "privacy": "private", "return": { "type": { "text": "number[][]" } }, "parameters": [ { "name": "offset", "default": "0", "type": { "text": "number" } } ], "description": "Creates the rows for the year selection view." }, { "kind": "method", "name": "_getStartValueYearView", "privacy": "private", "return": { "type": { "text": "number" } }, "description": "Calculates the first year that will be shown in the year selection panel.\nIf `minDate` and `maxDate` are both null, the starting year is calculated as\nthe multiple of YEARS_PER_PAGE closest to and less than activeDate,\ne.g., with `YEARS_PER_PAGE` = 24 and `activeDate` = 2020, the function will return 2016 (24 * 83),\nwhile with `activeDate` = 2000, the function will return 1992 (24 * 82).\nIf `minDate` is not null, it returns the corresponding year; if `maxDate` is not null,\nit returns the corresponding year minus `YEARS_PER_PAGE`, so that the `maxDate` is the last rendered year.\nIf both are not null, `maxDate` has priority over `minDate`." }, { "kind": "method", "name": "_isDayInRange", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "date", "type": { "text": "string" } } ], "description": "Checks if date is within the min-max range." }, { "kind": "method", "name": "_isMonthInRange", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "month", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_isYearInRange", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "year", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_isMonthFilteredOut", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "month", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_isYearFilteredOut", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "year", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_selectDate", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "day", "type": { "text": "string" } } ], "description": "Emits the selected date and sets it internally." }, { "kind": "method", "name": "_assignActiveDate", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "date", "type": { "text": "T" } } ] }, { "kind": "method", "name": "_goToDifferentMonth", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "months", "type": { "text": "number" } } ], "description": "Goes to the month identified by the shift." }, { "kind": "method", "name": "_goToDifferentYear", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "years", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_goToDifferentYearRange", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "years", "type": { "text": "number" } } ] }, { "kind": "method", "name": "_prevDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "prevDate", "type": { "text": "T" } } ] }, { "kind": "method", "name": "_nextDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "nextDate", "type": { "text": "T" } } ] }, { "kind": "method", "name": "_previousMonthDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } }, "description": "Checks if the \"previous month\" button should be disabled." }, { "kind": "method", "name": "_nextMonthDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } }, "description": "Checks if the \"next month\" button should be disabled." }, { "kind": "method", "name": "_previousYearDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_nextYearDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_previousYearRangeDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_nextYearRangeDisabled", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_handleTableBlur", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "eventTarget", "type": { "text": "HTMLElement" } } ] }, { "kind": "method", "name": "_setTabIndex", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_getFirstFocusable", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } } }, { "kind": "method", "name": "_handleKeyboardEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "KeyboardEvent" } }, { "name": "day", "optional": true, "type": { "text": "Day" } } ] }, { "kind": "method", "name": "_navigateByKeyboard", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } }, "parameters": [ { "name": "evt", "type": { "text": "KeyboardEvent" } }, { "name": "index", "type": { "text": "number" } }, { "name": "cells", "type": { "text": "HTMLButtonElement[]" } }, { "name": "day", "optional": true, "type": { "text": "Day" } } ], "description": "Gets the index of the element to move to, based on a list of elements (which can be potentially disabled),\nthe keyboard input and the position of the current element in the list.\nIn the day view, the `day?: Day` parameter is mandatory for calculation,\nwhile in month and year view it's not due to the fixed amount of rendered cells." }, { "kind": "method", "name": "_calculateParametersForKeyboardNavigation", "privacy": "private", "return": { "type": { "text": "CalendarKeyboardNavigationParameters" } }, "parameters": [ { "name": "cells", "type": { "text": "HTMLButtonElement[]" }, "description": "The array of rendered table cells; they are buttons that can represent days, months or years." }, { "name": "index", "type": { "text": "number" }, "description": "The starting element's index in the cell array." }, { "name": "day", "optional": true, "type": { "text": "Day" }, "description": "(optional) Only in the day view, the day represented by the starting cell." } ], "description": "Calculates the parameter needed in keyboard navigation.\nSince three views are now available, the function creates and returns the correct parameters for each of them\nby considering the number of cells per each row and the correction for the wide mode." }, { "kind": "method", "name": "_findNext", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } }, "parameters": [ { "name": "days", "type": { "text": "HTMLButtonElement[]" } }, { "name": "index", "type": { "text": "number" } }, { "name": "delta", "type": { "text": "number" } } ], "description": "Gets the next element of the provided array starting from `index` by adding `delta`.\nIf the found element is disabled, it continues adding `delta` until it finds an enabled one in the array bounds." }, { "kind": "method", "name": "_findFirst", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } }, "parameters": [ { "name": "days", "type": { "text": "HTMLButtonElement[]" } }, { "name": "firstOfCurrentMonth", "type": { "text": "number" } } ], "description": "Find the first enabled element in the provided array." }, { "kind": "method", "name": "_findLast", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } }, "parameters": [ { "name": "days", "type": { "text": "HTMLButtonElement[]" } }, { "name": "lastOfCurrentMonth", "type": { "text": "number" } } ], "description": "Find the last enabled element in the provided array." }, { "kind": "method", "name": "_findFirstOnColumn", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } }, "parameters": [ { "name": "days", "type": { "text": "HTMLButtonElement[]" } }, { "name": "index", "type": { "text": "number" } }, { "name": "offset", "type": { "text": "number" } }, { "name": "verticalOffset", "type": { "text": "number" } } ], "description": "Find the first enabled element in the same column of the provided array." }, { "kind": "method", "name": "_findLastOnColumn", "privacy": "private", "return": { "type": { "text": "HTMLButtonElement" } }, "parameters": [ { "name": "days", "type": { "text": "HTMLButtonElement[]" } }, { "name": "index", "type": { "text": "number" } }, { "name": "offset", "type": { "text": "number" } }, { "name": "verticalOffset", "type": { "text": "number" } } ], "description": "Find the last enabled element in the same column of the provided array." }, { "kind": "method", "name": "_now", "privacy": "private", "return": { "type": { "text": "T" } } }, { "kind": "method", "name": "_resetToDayView", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_renderDayView", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "description": "Render the view for the day selection." }, { "kind": "method", "name": "_createLabelForDayView", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "d", "type": { "text": "T" } } ], "description": "Creates the label with the month for the daily view." }, { "kind": "method", "name": "_createAriaLabelForDayView", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "dates", "type": { "text": "T[]" } } ], "description": "Creates the aria-label for the daily view." }, { "kind": "method", "name": "_createDayTable", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "weeks", "type": { "text": "Day[][]" } } ], "description": "Creates the calendar table for the daily view." }, { "kind": "method", "name": "_createDayTableHeader", "privacy": "private", "return": { "type": { "text": "TemplateResult[]" } }, "description": "Creates the table header with the month header cells." }, { "kind": "method", "name": "_createDayTableBody", "privacy": "private", "return": { "type": { "text": "TemplateResult[]" } }, "parameters": [ { "name": "weeks", "type": { "text": "Day[][]" } } ], "description": "Creates the table body with the day cells. For the first row, it also considers the possible day's offset." }, { "kind": "method", "name": "_createDayCells", "privacy": "private", "return": { "type": { "text": "TemplateResult[]" } }, "parameters": [ { "name": "week", "type": { "text": "Day[]" } }, { "name": "today", "type": { "text": "string" } } ], "description": "Creates the cells for the daily view." }, { "kind": "method", "name": "_renderMonthView", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "description": "Render the view for the month selection." }, { "kind": "method", "name": "_createLabelForMonthView", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "description": "Creates the label with the year for the monthly view." }, { "kind": "method", "name": "_createMonthTable", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "months", "type": { "text": "Month[][]" } }, { "name": "year", "type": { "text": "number" } }, { "name": "shiftRight", "default": "false" } ], "description": "Creates the table for the month selection view." }, { "kind": "method", "name": "_onMonthSelection", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "month", "type": { "text": "number" } }, { "name": "year", "type": { "text": "number" } }, { "name": "shiftRight", "type": { "text": "boolean" } } ], "description": "Select the month and change the view to day selection." }, { "kind": "method", "name": "_renderYearView", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "description": "Render the view for the year selection." }, { "kind": "method", "name": "_getArrow", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "direction", "type": { "text": "'left' | 'right'" } }, { "name": "click", "type": { "text": "() => void" } }, { "name": "ariaLabel", "type": { "text": "string" } }, { "name": "disabled", "type": { "text": "boolean" } } ], "description": "Creates the button arrow for all the views." }, { "kind": "method", "name": "_createLabelForYearView", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "description": "Creates the label with the year range for the yearly view." }, { "kind": "method", "name": "_createYearTable", "privacy": "private", "return": { "type": { "text": "TemplateResult" } }, "parameters": [ { "name": "years", "type": { "text": "number[][]" } }, { "name": "shiftRight", "default": "false" } ], "description": "Creates the table for the year selection view." }, { "kind": "method", "name": "_onYearSelection", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "year", "type": { "text": "number" } }, { "name": "rightSide", "type": { "text": "boolean" } } ], "description": "Select the year and change the view to month selection." }, { "kind": "field", "name": "_getView", "type": { "text": "TemplateResult" }, "privacy": "private", "readonly": true }, { "kind": "method", "name": "_tableAnimationEnd", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "AnimationEvent" } } ] }, { "kind": "method", "name": "_removeTable", "privacy": "private", "return": { "type": { "text": "void" } } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "Event emitted on date selection.", "name": "dateSelected" } ], "attributes": [ { "name": "wide", "type": { "text": "boolean" }, "default": "false", "description": "If set to true, two months are displayed", "fieldName": "wide" }, { "name": "min", "description": "The minimum valid date. Takes T Object, ISOString, and Unix Timestamp (number of seconds since Jan 1, 1970).", "type": { "text": "T | null" }, "fieldName": "min" }, { "name": "max", "description": "The maximum valid date. Takes T Object, ISOString, and Unix Timestamp (number of seconds since Jan 1, 1970).", "type": { "text": "T | null" }, "fieldName": "max" }, { "name": "selected", "description": "The selected date. Takes T Object, ISOString, and Unix Timestamp (number of seconds since Jan 1, 1970).", "type": { "text": "T | null" }, "fieldName": "selected" }, { "name": "date-filter", "type": { "text": "(date: T | null) => boolean | undefined" }, "description": "A function used to filter out dates.", "fieldName": "dateFilter" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-calendar", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbCalendarElement", "declaration": { "name": "SbbCalendarElement", "module": "calendar.js" } }, { "kind": "custom-element-definition", "name": "sbb-calendar", "declaration": { "name": "SbbCalendarElement", "module": "calendar.js" } } ] }, { "kind": "javascript-module", "path": "card.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./card/card.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./card/card-badge.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./card/card-button.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./card/card-link.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./card/common.js" } } ] }, { "kind": "javascript-module", "path": "checkbox.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./checkbox/checkbox.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./checkbox/checkbox-group.js" } } ] }, { "kind": "javascript-module", "path": "chip.js", "declarations": [ { "kind": "class", "description": "It displays brief and compact information.", "name": "SbbChipElement", "slots": [ { "description": "Use the unnamed slot to add content to the `sbb-chip`.", "name": "" } ], "members": [ { "kind": "field", "name": "size", "type": { "text": "'xxs' | 'xs' | 's'" }, "privacy": "public", "default": "'xxs'", "description": "Size of the chip.", "attribute": "size", "reflects": true }, { "kind": "field", "name": "color", "type": { "text": "'milk' | 'charcoal' | 'white' | 'granite'" }, "privacy": "public", "default": "'milk'", "description": "Color of the chip.", "attribute": "color", "reflects": true } ], "attributes": [ { "name": "size", "type": { "text": "'xxs' | 'xs' | 's'" }, "default": "'xxs'", "description": "Size of the chip.", "fieldName": "size" }, { "name": "color", "type": { "text": "'milk' | 'charcoal' | 'white' | 'granite'" }, "default": "'milk'", "description": "Color of the chip.", "fieldName": "color" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-chip", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbChipElement", "declaration": { "name": "SbbChipElement", "module": "chip.js" } }, { "kind": "custom-element-definition", "name": "sbb-chip", "declaration": { "name": "SbbChipElement", "module": "chip.js" } } ] }, { "kind": "javascript-module", "path": "clock.js", "declarations": [ { "kind": "class", "description": "It displays an analog clock with the classic SBB face.", "name": "SbbClockElement", "members": [ { "kind": "field", "name": "_clockHandHours", "type": { "text": "HTMLElement" }, "privacy": "private", "description": "Reference to the hour hand." }, { "kind": "field", "name": "_clockHandMinutes", "type": { "text": "HTMLElement" }, "privacy": "private", "description": "Reference to the minute hand." }, { "kind": "field", "name": "_clockHandSeconds", "type": { "text": "HTMLElement" }, "privacy": "private", "description": "Reference to the second hand." }, { "kind": "field", "name": "_hours", "type": { "text": "number" }, "privacy": "private", "description": "Hours value for the current date." }, { "kind": "field", "name": "_minutes", "type": { "text": "number" }, "privacy": "private", "description": "Minutes value for the current date." }, { "kind": "field", "name": "_seconds", "type": { "text": "number" }, "privacy": "private", "description": "Seconds value for the current date." }, { "kind": "field", "name": "_moveHoursHandFn", "privacy": "private", "description": "Callback function for hours hand." }, { "kind": "field", "name": "_moveMinutesHandFn", "privacy": "private", "description": "Callback function for minutes hand." }, { "kind": "field", "name": "_handMovement", "type": { "text": "ReturnType | undefined" }, "privacy": "private", "description": "Move the minutes hand every minute." }, { "kind": "method", "name": "_handlePageVisibilityChange", "privacy": "private", "return": { "type": { "text": "Promise" } } }, { "kind": "method", "name": "_addEventListeners", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_removeEventListeners", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_removeHoursAnimationStyles", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_removeSecondsAnimationStyles", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_assignCurrentTime", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Given the current date, calculates the hh/mm/ss values and the hh/mm/ss left to the next midnight." }, { "kind": "method", "name": "_setHandsStartingPosition", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Set the starting position for the three hands on the clock face." }, { "kind": "method", "name": "_setMinutesHand", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Set the starting position for the minutes hand." }, { "kind": "method", "name": "_moveHoursHand", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Move the hours hand to the next value." }, { "kind": "method", "name": "_moveMinutesHand", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Move the minutes hand to the next value." }, { "kind": "method", "name": "_addMinutesAndSetHands", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_stopClock", "privacy": "private", "return": { "type": { "text": "void" } }, "description": "Stops the clock by removing all the animations." }, { "kind": "method", "name": "_startClock", "privacy": "private", "return": { "type": { "text": "Promise" } }, "description": "Starts the clock by defining the hands starting position then starting the animations." }, { "kind": "method", "name": "_hasDataNow", "privacy": "private", "return": { "type": { "text": "boolean" } } }, { "kind": "method", "name": "_now", "privacy": "private", "return": { "type": { "text": "Date" } } } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-clock", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbClockElement", "declaration": { "name": "SbbClockElement", "module": "clock.js" } }, { "kind": "custom-element-definition", "name": "sbb-clock", "declaration": { "name": "SbbClockElement", "module": "clock.js" } } ] }, { "kind": "javascript-module", "path": "container.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./container/container.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./container/sticky-bar.js" } } ] }, { "kind": "javascript-module", "path": "datepicker.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./datepicker/datepicker.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./datepicker/datepicker-next-day.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./datepicker/datepicker-previous-day.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./datepicker/datepicker-toggle.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./datepicker/common.js" } } ] }, { "kind": "javascript-module", "path": "dialog.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dialog/dialog-actions.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dialog/dialog-content.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dialog/dialog-title.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./dialog/dialog.js" } } ] }, { "kind": "javascript-module", "path": "divider.js", "declarations": [ { "kind": "class", "description": "It displays a divider between sections.", "name": "SbbDividerElement", "members": [ { "kind": "field", "name": "orientation", "type": { "text": "SbbOrientation" }, "privacy": "public", "default": "'horizontal'", "description": "Orientation property with possible values 'horizontal' | 'vertical'. Defaults to horizontal.", "attribute": "orientation", "reflects": true }, { "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" } } ], "attributes": [ { "name": "orientation", "type": { "text": "SbbOrientation" }, "default": "'horizontal'", "description": "Orientation property with possible values 'horizontal' | 'vertical'. Defaults to horizontal.", "fieldName": "orientation" }, { "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-divider", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbDividerElement", "declaration": { "name": "SbbDividerElement", "module": "divider.js" } }, { "kind": "custom-element-definition", "name": "sbb-divider", "declaration": { "name": "SbbDividerElement", "module": "divider.js" } } ] }, { "kind": "javascript-module", "path": "expansion-panel.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./expansion-panel/expansion-panel.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./expansion-panel/expansion-panel-content.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./expansion-panel/expansion-panel-header.js" } } ] }, { "kind": "javascript-module", "path": "file-selector.js", "declarations": [ { "kind": "class", "description": "It allows to select one or more file from storage devices and display them.", "name": "SbbFileSelectorElement", "slots": [ { "description": "Use this to provide a `sbb-form-error` to show an error message.", "name": "error" } ], "members": [ { "kind": "field", "name": "events", "privacy": "public", "static": true, "readonly": true, "default": "{ fileChangedEvent: 'fileChanged', }", "type": { "text": "{\n fileChangedEvent: 'fileChanged',\n }" } }, { "kind": "field", "name": "variant", "type": { "text": "'default' | 'dropzone'" }, "privacy": "public", "default": "'default'", "description": "Whether the component has a dropzone area or not.", "attribute": "variant" }, { "kind": "field", "name": "multiple", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether more than one file can be selected.", "attribute": "multiple" }, { "kind": "field", "name": "multipleMode", "type": { "text": "'default' | 'persistent'" }, "privacy": "public", "default": "'default'", "description": "Whether the newly added files should override the previously added ones.", "attribute": "multiple-mode" }, { "kind": "field", "name": "accept", "type": { "text": "string | undefined" }, "privacy": "public", "description": "A comma-separated list of allowed unique file type specifiers.", "attribute": "accept" }, { "kind": "field", "name": "titleContent", "type": { "text": "string | undefined" }, "privacy": "public", "description": "The title displayed in `dropzone` variant.", "attribute": "title-content" }, { "kind": "field", "name": "accessibilityLabel", "type": { "text": "string | undefined" }, "privacy": "public", "description": "This will be forwarded as aria-label to the native input element.", "attribute": "accessibility-label" }, { "kind": "field", "name": "_files", "type": { "text": "File[] | undefined" }, "privacy": "private", "description": "The list of selected files." }, { "kind": "field", "name": "_fileChangedEvent", "type": { "text": "EventEmitter" }, "privacy": "private", "default": "new EventEmitter( this, SbbFileSelectorElement.events.fileChangedEvent, )", "description": "An event which is emitted each time the file list changes." }, { "kind": "field", "name": "files", "type": { "text": "File[]" }, "privacy": "public", "description": "Gets the currently selected files.", "readonly": true }, { "kind": "method", "name": "getFiles", "privacy": "public", "return": { "type": { "text": "File[]" } }, "deprecated": "use 'files' property instead" }, { "kind": "field", "name": "_counter", "type": { "text": "number" }, "privacy": "private", "default": "0" }, { "kind": "field", "name": "_loadButton", "type": { "text": "SbbSecondaryButtonStaticElement" }, "privacy": "private" }, { "kind": "field", "name": "_dragTarget", "type": { "text": "HTMLElement | undefined" }, "privacy": "private" }, { "kind": "field", "name": "_hiddenInput", "type": { "text": "HTMLInputElement" }, "privacy": "private" }, { "kind": "field", "name": "_suffixes", "type": { "text": "string[]" }, "privacy": "private", "default": "['B', 'kB', 'MB', 'GB', 'TB']" }, { "kind": "field", "name": "_liveRegion", "type": { "text": "HTMLParagraphElement" }, "privacy": "private" }, { "kind": "field", "name": "_language", "privacy": "private", "default": "new SbbLanguageController(this)" }, { "kind": "method", "name": "_blockEvent", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_checkFileEquality", "privacy": "private", "return": { "type": { "text": "boolean" } }, "parameters": [ { "name": "file1", "type": { "text": "File" } }, { "name": "file2", "type": { "text": "File" } } ] }, { "kind": "method", "name": "_onDragEnter", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_onDragLeave", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_onFileDrop", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DragEvent" } } ] }, { "kind": "method", "name": "_onFocus", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_onBlur", "privacy": "private", "return": { "type": { "text": "void" } } }, { "kind": "method", "name": "_setDragState", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "dragTarget", "default": "undefined", "type": { "text": "HTMLElement | undefined" } }, { "name": "isDragEnter", "default": "false", "type": { "text": "boolean" } } ] }, { "kind": "method", "name": "_readFiles", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "event", "type": { "text": "DOMEvent" } } ] }, { "kind": "method", "name": "_createFileList", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "files", "type": { "text": "FileList" } } ] }, { "kind": "method", "name": "_removeFile", "privacy": "private", "return": { "type": { "text": "void" } }, "parameters": [ { "name": "file", "type": { "text": "File" } } ] }, { "kind": "method", "name": "_formatFileSize", "privacy": "private", "return": { "type": { "text": "string" } }, "parameters": [ { "name": "size", "type": { "text": "number" } } ], "description": "Calculates the correct unit for the file's size." }, { "kind": "method", "name": "_renderDefaultMode", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderDropzoneArea", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "method", "name": "_renderFileList", "privacy": "private", "return": { "type": { "text": "TemplateResult" } } }, { "kind": "field", "name": "disabled", "privacy": "public", "description": "Whether the component is disabled.", "type": { "text": "boolean" }, "attribute": "disabled", "reflects": true, "inheritedFrom": { "name": "SbbDisabledMixin", "module": "core/mixins.js" }, "default": "false" }, { "kind": "field", "name": "_disabled", "type": { "text": "boolean" }, "privacy": "private", "default": "false", "inheritedFrom": { "name": "SbbDisabledMixin", "module": "core/mixins.js" } }, { "kind": "method", "name": "isDisabledExternally", "privacy": "protected", "return": { "type": { "text": "boolean" } }, "description": "Will be used as 'or' check to the current disabled state.\nCan e.g. be used to read disabled state of a group.", "inheritedFrom": { "name": "SbbDisabledMixin", "module": "core/mixins.js" } } ], "events": [ { "type": { "text": "CustomEvent" }, "description": "An event which is emitted each time the file list changes.", "name": "fileChanged" } ], "attributes": [ { "name": "variant", "type": { "text": "'default' | 'dropzone'" }, "default": "'default'", "description": "Whether the component has a dropzone area or not.", "fieldName": "variant" }, { "name": "multiple", "type": { "text": "boolean" }, "default": "false", "description": "Whether more than one file can be selected.", "fieldName": "multiple" }, { "name": "multiple-mode", "type": { "text": "'default' | 'persistent'" }, "default": "'default'", "description": "Whether the newly added files should override the previously added ones.", "fieldName": "multipleMode" }, { "name": "accept", "type": { "text": "string | undefined" }, "description": "A comma-separated list of allowed unique file type specifiers.", "fieldName": "accept" }, { "name": "title-content", "type": { "text": "string | undefined" }, "description": "The title displayed in `dropzone` variant.", "fieldName": "titleContent" }, { "name": "accessibility-label", "type": { "text": "string | undefined" }, "description": "This will be forwarded as aria-label to the native input element.", "fieldName": "accessibilityLabel" }, { "name": "disabled", "description": "Whether the component is disabled.", "type": { "text": "boolean" }, "fieldName": "disabled", "inheritedFrom": { "name": "SbbDisabledMixin", "module": "core/mixins.js" } } ], "mixins": [ { "name": "SbbDisabledMixin", "module": "core/mixins.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-file-selector", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbFileSelectorElement", "declaration": { "name": "SbbFileSelectorElement", "module": "file-selector.js" } }, { "kind": "custom-element-definition", "name": "sbb-file-selector", "declaration": { "name": "SbbFileSelectorElement", "module": "file-selector.js" } } ] }, { "kind": "javascript-module", "path": "footer.js", "declarations": [ { "kind": "class", "description": "It displays a footer section for the page.", "name": "SbbFooterElement", "slots": [ { "description": "Use the unnamed slot to add elements like `sbb-block-link`, `sbb-link-list`, `sbb-divider` and so on.", "name": "" } ], "members": [ { "kind": "field", "name": "variant", "type": { "text": "'default' | 'clock-columns'" }, "privacy": "public", "default": "'default'", "description": "Variants to display the footer. The default, displays the content in regular block element\napproach. The clock-columns, used a css-grid for displaying the content over different\nbreakpoints.", "attribute": "variant", "reflects": true }, { "kind": "field", "name": "expanded", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "Whether to allow the footer content to stretch to full width.\nBy default, the content has the appropriate page size.", "attribute": "expanded", "reflects": true }, { "kind": "field", "name": "accessibilityTitle", "type": { "text": "string | undefined" }, "privacy": "public", "description": "Footer title text, visually hidden, necessary for screen readers.", "attribute": "accessibility-title" }, { "kind": "field", "name": "accessibilityTitleLevel", "type": { "text": "SbbTitleLevel" }, "privacy": "public", "default": "'1'", "description": "Level of the accessibility title, will be rendered as heading tag (e.g. h1). Defaults to level 1.", "attribute": "accessibility-title-level" }, { "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" } } ], "attributes": [ { "name": "variant", "type": { "text": "'default' | 'clock-columns'" }, "default": "'default'", "description": "Variants to display the footer. The default, displays the content in regular block element\napproach. The clock-columns, used a css-grid for displaying the content over different\nbreakpoints.", "fieldName": "variant" }, { "name": "expanded", "type": { "text": "boolean" }, "default": "false", "description": "Whether to allow the footer content to stretch to full width.\nBy default, the content has the appropriate page size.", "fieldName": "expanded" }, { "name": "accessibility-title", "type": { "text": "string | undefined" }, "description": "Footer title text, visually hidden, necessary for screen readers.", "fieldName": "accessibilityTitle" }, { "name": "accessibility-title-level", "type": { "text": "SbbTitleLevel" }, "default": "'1'", "description": "Level of the accessibility title, will be rendered as heading tag (e.g. h1). Defaults to level 1.", "fieldName": "accessibilityTitleLevel" }, { "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-footer", "customElement": true } ], "exports": [ { "kind": "js", "name": "SbbFooterElement", "declaration": { "name": "SbbFooterElement", "module": "footer.js" } }, { "kind": "custom-element-definition", "name": "sbb-footer", "declaration": { "name": "SbbFooterElement", "module": "footer.js" } } ] }, { "kind": "javascript-module", "path": "form-error.js", "declarations": [ { "kind": "class", "description": "It displays an error message in the `sbb-form-field`.", "name": "SbbFormErrorElement", "slots": [ { "description": "Use this slot to display the error message.", "name": "" }, { "description": "Use this slot to override the default error icon.", "name": "icon" } ], "members": [ { "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" } } ], "mixins": [ { "name": "SbbNegativeMixin", "module": "core/mixins.js" } ], "superclass": { "name": "LitElement", "package": "lit" }, "tagName": "sbb-form-error", "customElement": true, "attributes": [ { "name": "negative", "type": { "text": "boolean" }, "default": "false", "description": "Negative coloring variant flag.", "fieldName": "negative", "inheritedFrom": { "name": "SbbNegativeMixin", "module": "core/mixins.js" } } ] } ], "exports": [ { "kind": "js", "name": "SbbFormErrorElement", "declaration": { "name": "SbbFormErrorElement", "module": "form-error.js" } }, { "kind": "custom-element-definition", "name": "sbb-form-error", "declaration": { "name": "SbbFormErrorElement", "module": "form-error.js" } } ] }, { "kind": "javascript-module", "path": "form-field.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./form-field/form-field.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./form-field/form-field-clear.js" } } ] }, { "kind": "javascript-module", "path": "header.js", "declarations": [], "exports": [ { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./header/header.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./header/header-button.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./header/header-link.js" } }, { "kind": "js", "name": "*", "declaration": { "name": "*", "package": "./header/common.js" } } ] }, { "kind": "javascript-module", "path": "icon.js", "declarations": [ { "kind": "class", "description": "", "name": "SbbIconBase", "cssProperties": [ { "description": "Can be used to set a custom width.", "name": "--sbb-icon-svg-width", "default": "auto" }, { "description": "Can be used to set a custom height.", "name": "--sbb-icon-svg-height", "default": "auto" } ], "members": [ { "kind": "field", "name": "_defaultNamespace", "type": { "text": "string" }, "privacy": "private", "static": true, "readonly": true, "default": "'default'" }, { "kind": "field", "name": "_svgNamespace", "privacy": "private" }, { "kind": "field", "name": "_svgIcon", "type": { "text": "Promise> | undefined" }, "privacy": "private", "description": "The icon svg content rendered on the page: ...." }, { "kind": "field", "name": "noSanitize", "type": { "text": "boolean" }, "privacy": "public", "default": "false", "description": "When set to `true`, SVG content that is HTTP fetched will not be checked\nif the response SVG content has any `