@ks89/angular-modal-gallery 13.0.0 → 15.0.0-alpha.1

package/lib/components/current-image/current-image.component.d.ts

@@ -1,282 +0,0 @@
-import { AfterContentInit, ChangeDetectorRef, EventEmitter, NgZone, OnChanges, OnDestroy, OnInit, SimpleChanges } from '@angular/core';
-import { AccessibleComponent } from '../accessible.component';
-import { AccessibilityConfig } from '../../model/accessibility.interface';
-import { Action } from '../../model/action.enum';
-import { Image, ImageModalEvent } from '../../model/image.class';
-import { InternalLibImage } from '../../model/image-internal.class';
-import { KeyboardConfig } from '../../model/keyboard-config.interface';
-import { SlideConfig } from '../../model/slide-config.interface';
-import { CurrentImageConfig } from '../../model/current-image-config.interface';
-import { ConfigService } from '../../services/config.service';
-import * as i0 from "@angular/core";
-/**
- * Interface to describe the Load Event, used to
- * emit an event when the image is finally loaded and the spinner has gone.
- */
-export interface ImageLoadEvent {
-    status: boolean;
-    index: number;
-    id: number;
-}
-/**
- * Component with the current image with some additional elements like arrows and side previews.
- */
-export declare class CurrentImageComponent extends AccessibleComponent implements OnInit, OnChanges, AfterContentInit, OnDestroy {
-    private platformId;
-    private ngZone;
-    ref: ChangeDetectorRef;
-    private configService;
-    /**
-     * Unique id (>=0) of the current instance of this library. This is useful when you are using
-     * the service to call modal gallery without open it manually.
-     */
-    id: number;
-    /**
-     * Object of type `InternalLibImage` that represent the visible image.
-     */
-    currentImage: InternalLibImage;
-    /**
-     * Array of `InternalLibImage` that represent the model of this library with all images,
-     * thumbs and so on.
-     */
-    images: InternalLibImage[];
-    /**
-     * Boolean that it is true if the modal gallery is visible.
-     * If yes, also this component should be visible.
-     */
-    isOpen: boolean;
-    /**
-     * Output to emit an event when images are loaded. The payload contains an `ImageLoadEvent`.
-     */
-    loadImage: EventEmitter<ImageLoadEvent>;
-    /**
-     * Output to emit any changes of the current image. The payload contains an `ImageModalEvent`.
-     */
-    changeImage: EventEmitter<ImageModalEvent>;
-    /**
-     * Output to emit an event when the modal gallery is closed. The payload contains an `ImageModalEvent`.
-     */
-    closeGallery: EventEmitter<ImageModalEvent>;
-    /**
-     * Subject to play modal-gallery.
-     */
-    private start$;
-    /**
-     * Subject to stop modal-gallery.
-     */
-    private stop$;
-    /**
-     * Enum of type `Action` that represents a normal action.
-     * Declared here to be used inside the template.
-     */
-    normalAction: Action;
-    /**
-     * Object of type `AccessibilityConfig` to init custom accessibility features.
-     * For instance, it contains titles, alt texts, aria-labels and so on.
-     */
-    accessibilityConfig: AccessibilityConfig | undefined;
-    /**
-     * Object of type `SlideConfig` to get `infinite sliding`.
-     */
-    slideConfig: SlideConfig | undefined;
-    /**
-     * Object to configure current image in modal-gallery.
-     * For instance you can disable navigation on click on current image (enabled by default).
-     */
-    currentImageConfig: CurrentImageConfig | undefined;
-    /**
-     * Object of type `KeyboardConfig` to assign custom keys to both ESC, RIGHT and LEFT keyboard's actions.
-     */
-    keyboardConfig: KeyboardConfig | undefined;
-    /**
-     * Enum of type `Action` that represents a mouse click on a button.
-     * Declared here to be used inside the template.
-     */
-    clickAction: Action;
-    /**
-     * Enum of type `Action` that represents a keyboard action.
-     * Declared here to be used inside the template.
-     */
-    keyboardAction: Action;
-    /**
-     * Boolean that it's true when you are watching the first image (currently visible).
-     * False by default
-     */
-    isFirstImage: boolean;
-    /**
-     * Boolean that it's true when you are watching the last image (currently visible).
-     * False by default
-     */
-    isLastImage: boolean;
-    /**
-     * Boolean that it's true if an image of the modal gallery is still loading.
-     * True by default
-     */
-    loading: boolean;
-    constructor(platformId: any, ngZone: NgZone, ref: ChangeDetectorRef, configService: ConfigService);
-    /**
-     * Listener to stop the gallery when the mouse pointer is over the current image.
-     */
-    onMouseEnter(): void;
-    /**
-     * Listener to play the gallery when the mouse pointer leave the current image.
-     */
-    onMouseLeave(): void;
-    /**
-     * Method ´ngOnInit´ to init configuration.
-     * This is an angular lifecycle hook, so its called automatically by Angular itself.
-     * In particular, it's called only one time!!!
-     */
-    ngOnInit(): void;
-    /**
-     * Method ´ngOnChanges´ to update `loading` status and emit events.
-     * If the gallery is open, then it will also manage boundary arrows and sliding.
-     * This is an angular lifecycle hook, so its called automatically by Angular itself.
-     * In particular, it's called when any data-bound property of a directive changes!!!
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * This is an angular lifecycle hook, so its called automatically by Angular itself.
-     */
-    ngAfterContentInit(): void;
-    /**
-     * Method to handle keypress based on the `keyboardConfig` input. It gets the code of
-     * the key that triggered the keypress event to navigate between images or to close the modal gallery.
-     * @param code string of the key that triggered the keypress event
-     */
-    onKeyPress(code: string): void;
-    /**
-     * Method to get the image description based on input params.
-     * If you provide a full description this will be the visible description, otherwise,
-     * it will be built using the `Description` object, concatenating its fields.
-     * @param Image image to get its description. If not provided it will be the current image
-     * @returns String description of the image (or the current image if not provided)
-     * @throws an Error if description isn't available
-     */
-    getDescriptionToDisplay(image?: Image): string;
-    /**
-     * Method to get `alt attribute`.
-     * `alt` specifies an alternate text for an image, if the image cannot be displayed.
-     * @param Image image to get its alt description. If not provided it will be the current image
-     * @returns String alt description of the image (or the current image if not provided)
-     */
-    getAltDescriptionByImage(image?: Image): string;
-    /**
-     * Method to get the title attributes based on descriptions.
-     * This is useful to prevent accessibility issues, because if DescriptionStrategy is ALWAYS_HIDDEN,
-     * it prevents an empty string as title.
-     * @param Image image to get its description. If not provided it will be the current image
-     * @returns String title of the image based on descriptions
-     * @throws an Error if description isn't available
-     */
-    getTitleToDisplay(image?: Image): string;
-    /**
-     * Method to get the left side preview image.
-     * @returns Image the image to show as size preview on the left
-     */
-    getLeftPreviewImage(): Image;
-    /**
-     * Method to get the right side preview image.
-     * @returns Image the image to show as size preview on the right
-     */
-    getRightPreviewImage(): Image;
-    /**
-     * Method called by events from both keyboard and mouse on an image.
-     * This will invoke the nextImage method.
-     * @param KeyboardEvent | MouseEvent event payload
-     * @param Action action that triggered the event or `Action.NORMAL` if not provided
-     */
-    onImageEvent(event: KeyboardEvent | MouseEvent, action?: Action): void;
-    /**
-     * Method called by events from both keyboard and mouse on a navigation arrow.
-     * @param string direction of the navigation that can be either 'next' or 'prev'
-     * @param KeyboardEvent | MouseEvent event payload
-     * @param Action action that triggered the event or `Action.NORMAL` if not provided
-     * @param boolean disable to disable navigation
-     */
-    onNavigationEvent(direction: string, event: KeyboardEvent | MouseEvent, action?: Action, disable?: boolean): void;
-    /**
-     * Method to go back to the previous image.
-     * @param action Enum of type `Action` that represents the source
-     *  action that moved back to the previous image. `Action.NORMAL` by default.
-     */
-    prevImage(action?: Action): void;
-    /**
-     * Method to go back to the previous image.
-     * @param action Enum of type `Action` that represents the source
-     *  action that moved to the next image. `Action.NORMAL` by default.
-     */
-    nextImage(action?: Action): void;
-    /**
-     * Method to emit an event as loadImage output to say that the requested image if loaded.
-     * This method is invoked by the javascript's 'load' event on an img tag.
-     * @param Event event that triggered the load
-     */
-    onImageLoad(event: Event): void;
-    /**
-     * Method used by SwipeDirective to support touch gestures (you can also invert the swipe direction with configCurrentImage.invertSwipe).
-     * @param action String that represent the direction of the swipe action. 'swiperight' by default.
-     */
-    swipe(action?: string): void;
-    /**
-     * Method used in `modal-gallery.component` to get the index of an image to delete.
-     * @param Image image to get the index, or the visible image, if not passed
-     * @returns number the index of the image
-     */
-    getIndexToDelete(image?: Image): number;
-    /**
-     * Method to play modal gallery.
-     */
-    playCarousel(): void;
-    /**
-     * Stops modal gallery from cycling through items.
-     */
-    stopCarousel(): void;
-    /**
-     * Method to cleanup resources. In fact, this will stop the modal gallery.
-     * This is an angular lifecycle hook that is called when this component is destroyed.
-     */
-    ngOnDestroy(): void;
-    /**
-     * Private method to update both `isFirstImage` and `isLastImage` based on
-     * the index of the current image.
-     * @param number currentIndex is the index of the current image
-     */
-    private handleBoundaries;
-    /**
-     * Private method to check if next/prev actions should be blocked.
-     * It checks if slideConfig.infinite === false and if the image index is equals to the input parameter.
-     * If yes, it returns true to say that sliding should be blocked, otherwise not.
-     * @param number boundaryIndex that could be either the beginning index (0) or the last index
-     *  of images (this.images.length - 1).
-     * @returns boolean true if slideConfig.infinite === false and the current index is
-     *  either the first or the last one.
-     */
-    private isPreventSliding;
-    /**
-     * Private method to get the next index.
-     * This is necessary because at the end, when you call next again, you'll go to the first image.
-     * That happens because all modal images are shown like in a circle.
-     */
-    private getNextImage;
-    /**
-     * Private method to get the previous index.
-     * This is necessary because at index 0, when you call prev again, you'll go to the last image.
-     * That happens because all modal images are shown like in a circle.
-     */
-    private getPrevImage;
-    /**
-     * Private method to build a text description.
-     * This is used also to create titles.
-     * @param Image image to get its description. If not provided it will be the current image.
-     * @param boolean imageWithoutDescription is a boolean that it's true if the image hasn't a 'modal' description.
-     * @returns String description built concatenating image fields with a specific logic.
-     */
-    private buildTextDescription;
-    /**
-     * Private method to call handleBoundaries when ngOnChanges is called.
-     */
-    private updateIndexes;
-    static ɵfac: i0.ɵɵFactoryDeclaration<CurrentImageComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CurrentImageComponent, "ks-current-image", never, { "id": { "alias": "id"; "required": false; }; "currentImage": { "alias": "currentImage"; "required": false; }; "images": { "alias": "images"; "required": false; }; "isOpen": { "alias": "isOpen"; "required": false; }; }, { "loadImage": "loadImage"; "changeImage": "changeImage"; "closeGallery": "closeGallery"; }, never, never, false, never>;
-}

package/lib/components/current-image/loading-spinner/loading-spinner.component.d.ts

@@ -1,55 +0,0 @@
-import { AccessibilityConfig } from '../../../model/accessibility.interface';
-import { LoadingConfig, LoadingType } from '../../../model/loading-config.interface';
-import * as i0 from "@angular/core";
-/**
- * Component with the loading spinner
- */
-export declare class LoadingSpinnerComponent {
-    /**
-     * Object of type `LoadingConfig` exposed to the template.
-     * It contains a field to choose a loading spinner.
-     */
-    loadingConfig: LoadingConfig;
-    /**
-     * Object of type `AccessibilityConfig` to init custom accessibility features.
-     * For instance, it contains titles, alt texts, aria-labels and so on.
-     */
-    accessibilityConfig: AccessibilityConfig;
-    /**
-     * Enum of type `LoadingType` to choose the standard loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingStandard: LoadingType;
-    /**
-     * Enum of type `LoadingType` to choose the bars loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingBars: LoadingType;
-    /**
-     * Enum of type `LoadingType` to choose the circular loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingCircular: LoadingType;
-    /**
-     * Enum of type `LoadingType` to choose the dots loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingDots: LoadingType;
-    /**
-     * Enum of type `LoadingType` to choose the cube flipping loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingCubeFlipping: LoadingType;
-    /**
-     * Enum of type `LoadingType` to choose the circles loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingCircles: LoadingType;
-    /**
-     * Enum of type `LoadingType` to choose the explosing squares loading spinner.
-     * Declared here to be used inside the template.
-     */
-    loadingExplosingSquares: LoadingType;
-    static ɵfac: i0.ɵɵFactoryDeclaration<LoadingSpinnerComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<LoadingSpinnerComponent, "ks-loading-spinner", never, { "loadingConfig": { "alias": "loadingConfig"; "required": false; }; "accessibilityConfig": { "alias": "accessibilityConfig"; "required": false; }; }, {}, never, never, false, never>;
-}

package/lib/components/dots/dots.component.d.ts

@@ -1,81 +0,0 @@
-import { EventEmitter, OnChanges, OnInit, SimpleChanges } from '@angular/core';
-import { AccessibleComponent } from '../accessible.component';
-import { AccessibilityConfig } from '../../model/accessibility.interface';
-import { Image } from '../../model/image.class';
-import { InternalLibImage } from '../../model/image-internal.class';
-import { DotsConfig } from '../../model/dots-config.interface';
-import { ConfigService } from '../../services/config.service';
-import * as i0 from "@angular/core";
-/**
- * Component with clickable dots (small circles) to navigate between images inside the modal gallery.
- */
-export declare class DotsComponent extends AccessibleComponent implements OnInit, OnChanges {
-    private configService;
-    /**
-     * Unique id (>=0) of the current instance of this library. This is required when you are using
-     * the service to call modal gallery.
-     */
-    id: number;
-    /**
-     * Object of type `InternalLibImage` that represent the visible image.
-     */
-    currentImage: InternalLibImage | undefined;
-    /**
-     * Array of `InternalLibImage` that represent the model of this library with all images,
-     * thumbs and so on.
-     */
-    images: InternalLibImage[] | undefined;
-    /**
-     * Object of type `DotsConfig` to init DotsComponent's features.
-     * For instance, it contains a param to show/hide this component.
-     */
-    dotsConfig: DotsConfig;
-    /**
-     * Output to emit clicks on dots. The payload contains a number that represent
-     * the index of the clicked dot.
-     */
-    clickDot: EventEmitter<number>;
-    /**
-     * Object of type `DotsConfig` used in template.
-     */
-    configDots: DotsConfig | undefined;
-    /**
-     * Object of type `AccessibilityConfig` to init custom accessibility features.
-     * For instance, it contains titles, alt texts, aria-labels and so on.
-     */
-    accessibilityConfig: AccessibilityConfig | undefined;
-    constructor(configService: ConfigService);
-    /**
-     * Method ´ngOnInit´ to build `configDots` applying a default value.
-     * This is an angular lifecycle hook, so its called automatically by Angular itself.
-     * In particular, it's called only one time!!!
-     */
-    ngOnInit(): void;
-    /**
-     * Method ´ngOnChanges´ to change `configDots` if the input dotsConfig is changed.
-     * This is an angular lifecycle hook, so its called automatically by Angular itself.
-     */
-    ngOnChanges(changes: SimpleChanges): void;
-    /**
-     * Method to check if an image is active (i.e. the current image).
-     * It checks currentImage and images to prevent errors.
-     * @param number index of the image to check if it's active or not
-     * @returns boolean true if is active (and input params are valid), false otherwise
-     */
-    isActive(index: number): boolean;
-    /**
-     * Method called by events from keyboard and mouse.
-     * @param number index of the dot
-     * @param KeyboardEvent | MouseEvent event payload
-     */
-    onDotEvent(index: number, event: KeyboardEvent | MouseEvent): void;
-    /**
-     * Method used in the template to track ids in ngFor.
-     * @param number index of the array
-     * @param Image item of the array
-     * @returns number the id of the item
-     */
-    trackById(index: number, item: Image): number;
-    static ɵfac: i0.ɵɵFactoryDeclaration<DotsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<DotsComponent, "ks-dots", never, { "id": { "alias": "id"; "required": false; }; "currentImage": { "alias": "currentImage"; "required": false; }; "images": { "alias": "images"; "required": false; }; "dotsConfig": { "alias": "dotsConfig"; "required": false; }; }, { "clickDot": "clickDot"; }, never, never, false, never>;
-}

package/lib/components/modal-gallery/attach-to-overlay.service.d.ts

@@ -1,20 +0,0 @@
-import { Injector } from '@angular/core';
-import { ModalGalleryService } from './modal-gallery.service';
-import * as i0 from "@angular/core";
-export declare class AttachToOverlayService {
-    private injector;
-    private modalGalleryService;
-    constructor(injector: Injector, modalGalleryService: ModalGalleryService);
-    /**
-     * To be called by a provider with the APP_INITIALIZER token.
-     */
-    initialize(): void;
-    /**
-     * Private method to attach ModalGalleryComponent to the overlay.
-     * @param payload {@link AttachToOverlayPayload} with all necessary information
-     * @private
-     */
-    private attachToOverlay;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AttachToOverlayService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AttachToOverlayService>;
-}

package/lib/components/modal-gallery/modal-gallery-ref.d.ts

@@ -1,64 +0,0 @@
-import { OverlayRef } from '@angular/cdk/overlay';
-import { ImageModalEvent } from '../../model/image.class';
-import { ButtonEvent } from '../../model/buttons-config.interface';
-/**
- * Class that represents the modal dialog instance.
- * It is returned by the open method.
- */
-export declare class ModalGalleryRef {
-    private overlayRef;
-    private close;
-    close$: import("rxjs").Observable<ImageModalEvent>;
-    private show;
-    show$: import("rxjs").Observable<ImageModalEvent>;
-    private firstImage;
-    firstImage$: import("rxjs").Observable<ImageModalEvent>;
-    private lastImage;
-    lastImage$: import("rxjs").Observable<ImageModalEvent>;
-    private hasData;
-    hasData$: import("rxjs").Observable<ImageModalEvent>;
-    private buttonBeforeHook;
-    buttonBeforeHook$: import("rxjs").Observable<ButtonEvent>;
-    private buttonAfterHook;
-    buttonAfterHook$: import("rxjs").Observable<ButtonEvent>;
-    constructor(overlayRef: OverlayRef);
-    /**
-     * Close modal dialog, disposing the Overlay.
-     */
-    closeModal(): void;
-    /**
-     * Method to emit close event.
-     * @param event ImageModalEvent event payload
-     */
-    emitClose(event: ImageModalEvent): void;
-    /**
-     * Method to emit show event.
-     * @param event ImageModalEvent event payload
-     */
-    emitShow(event: ImageModalEvent): void;
-    /**
-     * Method to emit firstImage event.
-     * @param event ImageModalEvent event payload
-     */
-    emitFirstImage(event: ImageModalEvent): void;
-    /**
-     * Method to emit lastImage event.
-     * @param event ImageModalEvent event payload
-     */
-    emitLastImage(event: ImageModalEvent): void;
-    /**
-     * Method to emit hasData event.
-     * @param event ImageModalEvent event payload
-     */
-    emitHasData(event: ImageModalEvent): void;
-    /**
-     * Method to emit buttonBeforeHook event.
-     * @param event ImageModalEvent event payload
-     */
-    emitButtonBeforeHook(event: ButtonEvent): void;
-    /**
-     * Method to emit buttonAfterHook event.
-     * @param event ImageModalEvent event payload
-     */
-    emitButtonAfterHook(event: ButtonEvent): void;
-}