@sbb-esta/lyne-elements-experimental 2.10.0 → 2.11.0

package/development/seat-reservation/seat-reservation/seat-reservation-base-element.d.ts

@@ -0,0 +1,156 @@
+import { EventEmitter } from '@sbb-esta/lyne-elements/core/eventing.js';
+import { LitElement, PropertyValues } from 'lit';
+import { ElementDimension, ElementPosition, Place, PlaceSelection, SeatReservation, SeatReservationCoachSelection, SeatReservationPlaceSelection } from '../seat-reservation.js';
+declare enum ScrollDirection {
+    right = "right",
+    left = "left"
+}
+interface CoachScrollTriggerPoint {
+    start: number;
+    end: number;
+    width: number;
+}
+export declare class SeatReservationBaseElement extends LitElement {
+    static readonly events: {
+        readonly selectedPlaces: "selectedPlaces";
+        readonly selectedCoach: "selectedCoach";
+    };
+    /** The seat reservation object which contains all coaches and places */
+    accessor seatReservation: SeatReservation;
+    /** The seat resvervation navigation can be toggled by this property */
+    accessor hasNavigation: boolean;
+    /** The seat reservation area is aligned vertically */
+    accessor alignVertical: boolean;
+    /** The seat reservation area's base grid size */
+    accessor baseGridSize: number;
+    /** The seat reservation area's width */
+    accessor height: number;
+    /** Maximal number of possible clickable seats */
+    accessor maxReservations: number;
+    /** Any click functionality is prevented */
+    accessor preventPlaceClick: boolean;
+    protected accessor selectedCoachIndex: number;
+    protected accessor focusedCoachIndex: number;
+    /** Emits when a place was selected by user. */
+    protected selectedPlaces: EventEmitter<SeatReservationPlaceSelection[]>;
+    /** Emits when a coach was selected by user. */
+    protected selectedCoach: EventEmitter<SeatReservationCoachSelection>;
+    protected coachBorderPadding: number;
+    protected coachBorderOffset: number;
+    protected currScrollDirection: ScrollDirection;
+    protected maxCalcCoachsWidth: number;
+    protected scrollCoachsAreaWidth: number;
+    protected triggerCoachPositionsCollection: CoachScrollTriggerPoint[];
+    protected firstTabElement: HTMLElement;
+    protected lastTabElement: HTMLElement;
+    protected coachScrollArea: HTMLElement;
+    protected currSelectedPlace: Place | null;
+    protected currSelectedPlaceElementId: string | null;
+    protected currSelectedCoachIndex: number;
+    protected preventCoachScrollByPlaceClick: boolean;
+    protected selectedSeatReservationPlaces: SeatReservationPlaceSelection[];
+    protected seatReservationWithoutNavigationHasFocus: boolean;
+    protected isCochGridFocusable: boolean;
+    protected isAutoScrolling: boolean;
+    protected isKeyboardNavigation: boolean;
+    protected keyboardNavigationEvents: {
+        readonly ArrowLeft: "ArrowLeft";
+        readonly ArrowRight: "ArrowRight";
+        readonly ArrowUp: "ArrowUp";
+        readonly ArrowDown: "ArrowDown";
+        readonly Tab: "Tab";
+        readonly Enter: "Enter";
+    };
+    protected willUpdate(changedProperties: PropertyValues<this>): void;
+    protected initNavigationSelectionByScrollEvent(): void;
+    /**
+     * If no navigation exists (property setting -> hasNavigation) and a table coach gets the focus,
+     * the first place in the coach must be automatically preselected to control the place navigation via keyboard
+     *
+     * @param focusCoachIndex
+     */
+    protected onFocusTableCoachAndPreselectPlace(focusCoachIndex: number): void;
+    /**
+     * Initialisation of Keyboard event handling to navigation between each places inside a selected coach by using [arrow] keys.
+     * With the [TAB] key the user navigation goes to the next coach navigation element and the currently selected place is automatically reset.
+     */
+    protected handleKeyboardEvent(event: KeyboardEvent): void;
+    /**
+     * Selects a place inside the coach if navigated via keyboard,
+     * otherwise the coach grid is selected (necessary for ScreenReader)
+     */
+    protected preselectPlaceInCoach(): void;
+    protected scrollToSelectedNavCoach(selectedNavCoachIndex: number): void;
+    /**
+     * Sets the new ScrollDirection by the new given target coach index.
+     */
+    private _setScrollDirectionByCoachIndex;
+    /**
+     * Returns the scroll start or end position X from the selected coach.
+     * In case the user is curretnly navigate throught places by keyboard and goes to previous coach,
+     * then we return the end position of the coach to get clostest next scroll position of the next focus place.
+     * @returns number
+     */
+    private _getCoachScrollPositionX;
+    /**
+     * Sets the focus on the HTML table (grid) caption element so that the heading is read out when using a ScreenReader.
+     */
+    private _setFocusToSelectedCoachGrid;
+    /**
+     * Returns whether the current scrolled position can be used to scroll to the selected wagon
+     * @returns boolean
+     */
+    private _isScrollableToSelectedCoach;
+    /**
+     * Returns the coach index which is currently visible in the scroll area
+     * @returns number
+     */
+    private _getCoachIndexByScrollTriggerPosition;
+    /**
+     * Get the first place of current selected coach by table cell coordinate 0-0 id.
+     * @returns Place or null
+     */
+    private _getFirstPlaceInSelecedCoach;
+    /**
+     * To get the correct closest place of current pressed key and the current selected place,
+     * we have to investigate the coordinates of each place to find the closest place of the currSelectedPlaceElementId.
+     * @param pressedKey
+     * @returns Place or null
+     */
+    private _getClosestPlaceByKeyDirection;
+    protected focusPlaceElement(place: Place | null, coachIndex?: number): void;
+    protected unfocusPlaceElement(): void;
+    protected getCalculatedDimension(elementDimension: ElementDimension, coachDimension?: ElementDimension, isOriginHeight?: boolean, isStretchHeight?: boolean): ElementDimension;
+    protected getCalculatedPosition(elementPosition: ElementPosition, elementDimension?: ElementDimension, coachDimension?: ElementDimension, isOriginHeight?: boolean): ElementPosition;
+    private _navigateCoachNavigationByKeyboard;
+    private _navigateToPlaceByKeyboard;
+    protected getNextAvailableCoachIndex(currentIndex?: number): number;
+    protected getPrevAvailableCoachIndex(currentIndex?: number): number;
+    protected updateSelectedSeatReservationPlaces(placeSelection: PlaceSelection): void;
+    protected updateCurrentSelectedPlaceInCoach(placeSelection: PlaceSelection): void;
+    protected updateCurrentSelectedCoach(): void;
+    /**
+     * Initialization of SeatReservationPlaceSelection Array based on the transferred places
+     * that have the state SELECTED within the seatReservation object
+     */
+    private _initSeatReservationPlaceSelection;
+    /**
+     * All selected places will be reset or the currentSelectedPlace was given, then we reset all except currentSelectedPlace
+     * @param currSelectedPlace
+     */
+    private _resetAllPlaceSelections;
+    private _getSeatReservationPlaceSelection;
+    private _getSeatReservationCoachSelection;
+    private _setCurrSelectedPlaceElementId;
+    /**
+     * Returns the current selected place HTML element by given placeNumber and coachIndex.
+     * If both doesnt exist, we try to return the place HTML element by the _currentSelectedPlaceElementId
+     * @param placeNumber optional as string
+     * @param coachIndex optional as string
+     * @returns HTMLElement or null
+     */
+    private _getPlaceHtmlElement;
+    private _setVerticalAlignmentOffset;
+}
+export {};
+//# sourceMappingURL=seat-reservation-base-element.d.ts.map

package/development/seat-reservation/seat-reservation/seat-reservation-base-element.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"seat-reservation-base-element.d.ts","sourceRoot":"","sources":["../../../../../src/elements-experimental/seat-reservation/seat-reservation/seat-reservation-base-element.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,0CAA0C,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,KAAK,CAAC;AAStD,OAAO,KAAK,EAEV,gBAAgB,EAChB,eAAe,EACf,KAAK,EACL,cAAc,EACd,eAAe,EACf,6BAA6B,EAC7B,6BAA6B,EAC9B,MAAM,wBAAwB,CAAC;AAIhC,aAAK,eAAe;IAClB,KAAK,UAAU;IACf,IAAI,SAAS;CACd;AAED,UAAU,uBAAuB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,qBAAa,0BAA2B,SAAQ,UAAU;IACxD,gBAAuB,MAAM;;;MAGlB;IAEX,wEAAwE;IACxE,SACgB,eAAe,EAAE,eAAe,CAAS;IAEzD,uEAAuE;IACvE,SAEgB,aAAa,EAAE,OAAO,CAAQ;IAE9C,sDAAsD;IACtD,SAEgB,aAAa,EAAE,OAAO,CAAS;IAE/C,iDAAiD;IACjD,SAEgB,YAAY,EAAE,MAAM,CAAM;IAE1C,wCAAwC;IACxC,SAEgB,MAAM,EAAE,MAAM,CAAS;IAEvC,iDAAiD;IACjD,SAEgB,eAAe,EAAE,MAAM,CAAS;IAEhD,2CAA2C;IAC3C,SAEgB,iBAAiB,EAAE,OAAO,CAAS;IAE1C,SAAS,CAAC,QAAQ,CAAC,kBAAkB,EAAE,MAAM,CAAM;IACnD,SAAS,CAAC,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAM;IAE3D,+CAA+C;IAC/C,SAAS,CAAC,cAAc,EAAE,YAAY,CAAC,6BAA6B,EAAE,CAAC,CAGrE;IAEF,+CAA+C;IAC/C,SAAS,CAAC,aAAa,EAAE,YAAY,CAAC,6BAA6B,CAAC,CAGlE;IAEF,SAAS,CAAC,kBAAkB,SAAK;IACjC,SAAS,CAAC,iBAAiB,SAA+C;IAC1E,SAAS,CAAC,mBAAmB,EAAE,eAAe,CAAyB;IACvE,SAAS,CAAC,kBAAkB,EAAE,MAAM,CAAK;IACzC,SAAS,CAAC,qBAAqB,EAAE,MAAM,CAAK;IAC5C,SAAS,CAAC,+BAA+B,EAAE,uBAAuB,EAAE,CAAM;IAC1E,SAAS,CAAC,eAAe,EAAE,WAAW,CAAS;IAC/C,SAAS,CAAC,cAAc,EAAE,WAAW,CAAS;IAC9C,SAAS,CAAC,eAAe,EAAE,WAAW,CAAS;IAC/C,SAAS,CAAC,iBAAiB,EAAE,KAAK,GAAG,IAAI,CAAQ;IACjD,SAAS,CAAC,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC3D,SAAS,CAAC,sBAAsB,EAAE,MAAM,CAAM;IAC9C,SAAS,CAAC,8BAA8B,EAAE,OAAO,CAAS;IAC1D,SAAS,CAAC,6BAA6B,EAAE,6BAA6B,EAAE,CAAM;IAC9E,SAAS,CAAC,wCAAwC,UAAS;IAC3D,SAAS,CAAC,mBAAmB,UAAS;IACtC,SAAS,CAAC,eAAe,UAAS;IAClC,SAAS,CAAC,oBAAoB,UAAS;IACvC,SAAS,CAAC,wBAAwB;;;;;;;MAOvB;cAEQ,UAAU,CAAC,iBAAiB,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAmC5E,SAAS,CAAC,oCAAoC,IAAI,IAAI;IAuDtD;;;;;OAKG;IACH,SAAS,CAAC,kCAAkC,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI;IAW3E;;;OAGG;IACH,SAAS,CAAC,mBAAmB,CAAC,KAAK,EAAE,aAAa,GAAG,IAAI;IA8DzD;;;OAGG;IACH,SAAS,CAAC,qBAAqB,IAAI,IAAI;IAuBvC,SAAS,CAAC,wBAAwB,CAAC,qBAAqB,EAAE,MAAM,GAAG,IAAI;IAwBvE;;OAEG;IACH,OAAO,CAAC,+BAA+B;IAOvC;;;;;OAKG;IACH,OAAO,CAAC,wBAAwB;IAWhC;;OAEG;IACH,OAAO,CAAC,4BAA4B;IAapC;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAcpC;;;OAGG;IACH,OAAO,CAAC,qCAAqC;IAO7C;;;OAGG;IACH,OAAO,CAAC,4BAA4B;IAgBpC;;;;;OAKG;IACH,OAAO,CAAC,8BAA8B;IA+EtC,SAAS,CAAC,iBAAiB,CAAC,KAAK,EAAE,KAAK,GAAG,IAAI,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI;IAiB3E,SAAS,CAAC,mBAAmB,IAAI,IAAI;IASrC,SAAS,CAAC,sBAAsB,CAC9B,gBAAgB,EAAE,gBAAgB,EAClC,cAAc,CAAC,EAAE,gBAAgB,EACjC,cAAc,CAAC,EAAE,OAAO,EACxB,eAAe,CAAC,EAAE,OAAO,GACxB,gBAAgB;IAenB,SAAS,CAAC,qBAAqB,CAC7B,eAAe,EAAE,eAAe,EAChC,gBAAgB,CAAC,EAAE,gBAAgB,EACnC,cAAc,CAAC,EAAE,gBAAgB,EACjC,cAAc,CAAC,EAAE,OAAO,GACvB,eAAe;IAsBlB,OAAO,CAAC,kCAAkC;IAiE1C,OAAO,CAAC,0BAA0B;IAkClC,SAAS,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM;IAKnE,SAAS,CAAC,0BAA0B,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM;IAKnE,SAAS,CAAC,mCAAmC,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI;IAwBnF,SAAS,CAAC,iCAAiC,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI;IAgBjF,SAAS,CAAC,0BAA0B,IAAI,IAAI;IAS5C;;;OAGG;IACH,OAAO,CAAC,kCAAkC;IAiB1C;;;OAGG;IACH,OAAO,CAAC,wBAAwB;IAkBhC,OAAO,CAAC,iCAAiC;IAWzC,OAAO,CAAC,iCAAiC;IASzC,OAAO,CAAC,8BAA8B;IAStC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAS5B,OAAO,CAAC,2BAA2B;CAepC"}