@ks89/angular-modal-gallery 8.0.0-rc.1 → 9.0.1

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

@@ -15,13 +15,13 @@ export declare class AccessibleComponent {
     handleNavigationEvent(direction: string, event: KeyboardEvent | MouseEvent): number;
     /**
      * Method to handle events over an image, for instance a keypress with the Keyboard or a Mouse click.
-     * @param KeyboardEvent | MouseEvent event payload
+     * @param event KeyboardEvent | MouseEvent payload
      * @returns number 1 for NEXT and 0 for NOTHING
      */
     handleImageEvent(event: KeyboardEvent | MouseEvent): number;
     /**
      * Private method to handle keyboard events over an image.
-     * @param KeyboardEvent event payload
+     * @param event KeyboardEvent payload
      * @returns number 1 for NEXT and 0 for NOTHING
      */
     private handleImageKeyboardEvent;

package/lib/components/carousel/carousel-previews/carousel-previews.component.d.ts

@@ -156,13 +156,6 @@ export declare class CarouselPreviewsComponent extends AccessibleComponent imple
      * @returns a SafeStyle object that can be used in template without problems.
      */
     sanitizeUrlBgStyle(unsafeStyle: string | SafeResourceUrl, unsafeStyleFallback: string | SafeResourceUrl): SafeStyle;
-    /**
-     * Method to get the background-size value when IE11LegacyMode is enabled.
-     * This prevent weired behaviour on IE11 when previews are really small, but original images (.png/.jgp/...) are big.
-     * Using 'cover' it's not enough, because it's causing empty background in some cases.
-     * After some experiments, I decided to use the double of the height and auto as width.
-     */
-    getIE11LegacyBgSize(): string;
     /**
      * Method to cleanup resources. In fact, it cleans breakpointSubscription.
      * This is an Angular's lifecycle hook that is called when this component is destroyed.

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

@@ -4,13 +4,11 @@ import { AccessibilityConfig } from '../../model/accessibility.interface';
 import { Image, ImageEvent } from '../../model/image.class';
 import { Action } from '../../model/action.enum';
 import { DotsConfig } from '../../model/dots-config.interface';
-import { PlayConfig } from '../../model/play-config.interface';
 import { CarouselConfig } from '../../model/carousel-config.interface';
 import { CarouselImageConfig } from '../../model/carousel-image-config.interface';
-import { DomSanitizer, SafeStyle } from '@angular/platform-browser';
-import { CarouselPreviewConfig } from '../../model/carousel-preview-config.interface';
 import { ConfigService } from '../../services/config.service';
 import { ModalGalleryService } from '../modal-gallery/modal-gallery.service';
+import { CarouselLibConfig } from '../../model/lib-config.interface';
 import * as i0 from "@angular/core";
 /**
  * Component with configurable inline/plain carousel.
@@ -21,7 +19,6 @@ export declare class CarouselComponent extends AccessibleComponent implements On
     private modalGalleryService;
     private configService;
     private ref;
-    private sanitizer;
     /**
      * Attribute to set ariaLabel of the host component
      */
@@ -37,47 +34,17 @@ export declare class CarouselComponent extends AccessibleComponent implements On
      */
     images: Image[];
     /**
-     * Object of type `CarouselConfig` to init CarouselComponent's features.
-     * For instance, it contains parameters to change the style, how it navigates and so on.
-     */
-    carouselConfig: CarouselConfig | undefined;
-    /**
-     * Object of type `PlayConfig` to init CarouselComponent's features about auto-play.
-     * For instance, it contains parameters to enable/disable autoPlay, interval and so on.
-     */
-    playConfig: PlayConfig | undefined;
-    /**
-     * Interface to configure current image in carousel.
-     * For instance you can change the description.
-     */
-    carouselImageConfig: CarouselImageConfig | undefined;
-    /**
-     * Object of type `CarouselPreviewConfig` to init PreviewsComponent's features.
-     * For instance, it contains a param to show/hide previews, change sizes and so on.
-     */
-    previewConfig: CarouselPreviewConfig | undefined;
-    /**
-     * Object of type `DotsConfig` to init DotsComponent's features.
-     * For instance, it contains a param to show/hide this component.
-     */
-    dotsConfig: DotsConfig | undefined;
-    /**
-     * boolean to enable/disable infinite sliding. Enabled by default.
-     */
-    infinite: boolean;
-    /**
-     * TODO add description
+     * CarouselLibConfig object to configure carousel.
      */
-    disableSsrWorkaround: boolean;
+    config: CarouselLibConfig | undefined;
     /**
-     * Object of type `AccessibilityConfig` to init custom accessibility features.
-     * For instance, it contains titles, alt texts, aria-labels and so on.
+     * Output to emit an event when an image is clicked.
      */
-    accessibilityConfig: AccessibilityConfig | undefined;
+    clickImage: EventEmitter<number>;
     /**
-     * Output to emit an event when an image is changed.
+     * Output to emit an event when current image is changed.
      */
-    showImage: EventEmitter<ImageEvent>;
+    changeImage: EventEmitter<ImageEvent>;
     /**
      * Output to emit an event when the current image is the first one.
      */
@@ -87,29 +54,28 @@ export declare class CarouselComponent extends AccessibleComponent implements On
      */
     lastImage: EventEmitter<ImageEvent>;
     /**
-     * Object use in template
-     */
-    configCarousel: CarouselConfig | undefined;
-    /**
-     * Object use in template
+     * Object of type `CarouselConfig` to init CarouselComponent's features.
+     * For instance, it contains parameters to change the style, how it navigates and so on.
      */
-    configPlay: PlayConfig | undefined;
+    carouselConfig: CarouselConfig | undefined;
     /**
-     * Object use in template
+     * Object of type `DotsConfig` to init DotsComponent's features.
+     * For instance, it contains a param to show/hide this component.
      */
-    configCarouselImage: CarouselImageConfig | undefined;
+    carouselDotsConfig: DotsConfig | undefined;
     /**
-     * Object use in template
+     * Object of type `AccessibilityConfig` to init custom accessibility features.
+     * For instance, it contains titles, alt texts, aria-labels and so on.
      */
-    configPreview: CarouselPreviewConfig | undefined;
+    accessibilityConfig: AccessibilityConfig | undefined;
     /**
-     * Object use in template
+     * Object of type `CarouselImageConfig` to configure the current image of the carousel.
      */
-    configDots: DotsConfig | undefined;
+    carouselImageConfig: CarouselImageConfig | undefined;
     /**
-     * Object use in template
+     * Enable/disable infinite sliding.
      */
-    configAccessibility: AccessibilityConfig;
+    carouselSlideInfinite: boolean | undefined;
     /**
      * Enum of type `Action` that represents a mouse click on a button.
      * Declared here to be used inside the template.
@@ -162,18 +128,10 @@ export declare class CarouselComponent extends AccessibleComponent implements On
      * Listener to navigate carousel images with keyboard (right).
      */
     onKeyDownLRight(): void;
-    constructor(platformId: any, ngZone: NgZone, modalGalleryService: ModalGalleryService, configService: ConfigService, ref: ChangeDetectorRef, sanitizer: DomSanitizer);
-    ngOnChanges(changes: SimpleChanges): void;
+    constructor(platformId: any, ngZone: NgZone, modalGalleryService: ModalGalleryService, configService: ConfigService, ref: ChangeDetectorRef);
     ngOnInit(): void;
+    ngOnChanges(changes: SimpleChanges): void;
     ngAfterContentInit(): void;
-    /**
-     * Method used in template to sanitize an url when you need legacyIE11Mode.
-     * In this way you can set an url as background of a div.
-     * @param unsafeStyle is a string and represents the url to sanitize.
-     * @param unsafeStyleFallback is a string and represents the fallback url to sanitize.
-     * @returns a SafeStyle object that can be used in template without problems.
-     */
-    sanitizeUrlBgStyle(unsafeStyle: string, unsafeStyleFallback: string): SafeStyle;
     /**
      * Method called when a dot is clicked and used to update the current image.
      * @param number index of the clicked dot
@@ -308,14 +266,14 @@ export declare class CarouselComponent extends AccessibleComponent implements On
     private emitBoundaryEvent;
     /**
      * 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.
+     * It checks if carouselSlideInfinite === 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
+     * @returns boolean true if carouselSlideInfinite === false and the current index is
      *  either the first or the last one.
      */
     private isPreventSliding;
     static ɵfac: i0.ɵɵFactoryDeclaration<CarouselComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<CarouselComponent, "ks-carousel", never, { "id": "id"; "images": "images"; "carouselConfig": "carouselConfig"; "playConfig": "playConfig"; "carouselImageConfig": "carouselImageConfig"; "previewConfig": "previewConfig"; "dotsConfig": "dotsConfig"; "infinite": "infinite"; "disableSsrWorkaround": "disableSsrWorkaround"; "accessibilityConfig": "accessibilityConfig"; }, { "showImage": "showImage"; "firstImage": "firstImage"; "lastImage": "lastImage"; }, never, ["*"]>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<CarouselComponent, "ks-carousel", never, { "id": "id"; "images": "images"; "config": "config"; }, { "clickImage": "clickImage"; "changeImage": "changeImage"; "firstImage": "firstImage"; "lastImage": "lastImage"; }, never, ["*"]>;
 }

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

@@ -139,13 +139,16 @@ export declare class CurrentImageComponent extends AccessibleComponent implement
      * In particular, it's called when any data-bound property of a directive changes!!!
      */
     ngOnChanges(changes: SimpleChanges): void;
+    /**
+     * This is an Angular's lifecycle hook, so its called automatically by Angular itself.
+     */
     ngAfterContentInit(): void;
     /**
-     * Method to handle keypress based on the `keyboardConfig` input. It gets the keyCode of
+     * 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 number keyCode of the key that triggered the keypress event
+     * @param code string of the key that triggered the keypress event
      */
-    onKeyPress(keyCode: number): void;
+    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,

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

@@ -11,6 +11,10 @@ import * as i0 from "@angular/core";
  */
 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 | undefined;
     /**
      * Object of type `InternalLibImage` that represent the visible image.

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

@@ -1,6 +1,10 @@
 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;
@@ -18,12 +22,43 @@ export declare class ModalGalleryRef {
     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;
 }

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

@@ -85,7 +85,7 @@ export declare class ModalGalleryComponent implements OnInit, OnDestroy {
      */
     showGallery: boolean;
     /**
-     * TODO write doc
+     * Object to configure this component.
      */
     libConfig: LibConfig | undefined;
     private updateImagesSubscription;
@@ -104,141 +104,145 @@ export declare class ModalGalleryComponent implements OnInit, OnDestroy {
     ngOnInit(): void;
     /**
      * Method called by custom upper buttons.
-     * @param event ButtonEvent payload
+     * @param event ButtonEvent event payload
      */
     onCustomEmit(event: ButtonEvent): void;
     /**
      * Method called by the full-screen upper button.
-     * @param ButtonEvent event payload
+     * @param event ButtonEvent event payload
      */
     onFullScreen(event: ButtonEvent): void;
     /**
      * Method called by the delete upper button.
-     * @param ButtonEvent event payload
+     * @param event ButtonEvent event payload
      */
     onDelete(event: ButtonEvent): void;
     /**
      * Method called by the navigate upper button.
-     * @param ButtonEvent event payload
+     * @param event ButtonEvent event payload
      */
     onNavigate(event: ButtonEvent): void;
+    /**
+     * This method is defined to be spied and replaced in unit testing with a fake method call.
+     * It must be public to be able to use jasmine spyOn method.
+     * @param newHref string new url
+     */
+    updateLocationHref(newHref: string): void;
     /**
      * Method called by the download upper button.
-     * @param ButtonEvent event payload
+     * @param event ButtonEvent event payload
      */
     onDownload(event: ButtonEvent): void;
     /**
      * Method called by the close upper button.
-     * @param ButtonEvent event payload
-     * @param Action action that triggered the close method. `Action.NORMAL` by default
+     * @param event ButtonEvent event payload
+     * @param action Action that triggered the close method. `Action.NORMAL` by default
      */
     onCloseGalleryButton(event: ButtonEvent, action?: Action): void;
+    /**
+     * Method called by CurrentImageComponent and triggered via KeyboardService.
+     * @param event ImageModalEvent event payload
+     * @param action Action that triggered the close method. `Action.NORMAL` by default
+     */
     onCloseGallery(event: ImageModalEvent, action?: Action): void;
     /**
      * Method to close the modal gallery specifying the action.
      * It also reset the `keyboardService` to prevent multiple listeners.
-     * @param Action action type. `Action.NORMAL` by default
-     * @param boolean isCalledByService is true if called by gallery.service, otherwise false
-     */
-    closeGallery(action?: Action, clickOutside?: boolean, isCalledByService?: boolean): void;
-    /**
-     * Method to show the modal gallery displaying the image with
-     * the index specified as input parameter.
-     * It will also register a new `keyboardService` to catch keyboard's events to download the current
-     * image with keyboard's shortcuts. This service, will be removed either when modal gallery component
-     * will be destroyed or when the gallery is closed invoking the `closeGallery` method.
-     * @param number index of the image to show
+     * @param action Action action type. `Action.NORMAL` by default
+     * @param clickOutside boolean that is true if called clicking on the modal background. False by default.
      */
-    showModalGallery(): void;
+    closeGallery(action?: Action, clickOutside?: boolean): void;
     /**
      * Method called when the image changes and used to update the `currentImage` object.
-     * @param ImageModalEvent event payload
+     * @param event ImageModalEvent event payload
      */
     onChangeCurrentImage(event: ImageModalEvent): void;
     /**
      * Method called when you click 'outside' (i.e. on the semi-transparent background)
      * to close the modal gallery if `enableCloseOutside` is true.
-     * @param boolean event payload. True to close the modal gallery, false otherwise
+     * @param event boolean that is true to close the modal gallery, false otherwise
      */
     onClickOutside(event: boolean): void;
     /**
      * Method called when an image is loaded and the loading spinner has gone.
      * It sets the previouslyLoaded flag inside the Image to hide loading spinner when displayed again.
-     * @param ImageLoadEvent event payload
+     * @param event ImageLoadEvent event payload
      */
     onImageLoad(event: ImageLoadEvent): void;
     /**
      * Method called when a dot is clicked and used to update the current image.
-     * @param number index of the clicked dot
+     * @param index number index of the clicked dot
      */
     onClickDot(index: number): void;
     /**
      * Method called when an image preview is clicked and used to update the current image.
-     * @param Image preview image
+     * @param event ImageModalEvent preview image
      */
     onClickPreview(event: ImageModalEvent): void;
-    /**
-     * Method to download the current image, only if `downloadable` is true.
-     * It contains also a logic to enable downloading features also for IE11.
-     */
-    downloadImage(): void;
     /**
      * Method to cleanup resources. In fact, this will reset keyboard's service.
      * This is an Angular's lifecycle hook that is called when this component is destroyed.
      */
     ngOnDestroy(): void;
+    /**
+     * Method to show the modal gallery displaying the currentImage.
+     * It will also register a new `keyboardService` to catch keyboard's events to download the current
+     * image with keyboard's shortcuts. This service, will be removed either when modal gallery component
+     * will be destroyed or when the gallery is closed invoking the `closeGallery` method.
+     * @private
+     */
+    private registerKeyboardService;
+    /**
+     * Method to download the current image, only if `downloadable` is true.
+     * @private
+     */
+    private downloadImage;
     /**
      * Method to convert a base64 to a Blob
      * @param base64Data string with base64 data
      * @param contentType string with the MIME type
+     * @return Blob converted from the input base64Data
+     * @private
      */
     private base64toBlob;
     /**
-     * Private method to download the current image for all browsers except for IE11.
+     * Private method to download the current image for all browsers.
+     * @private
      */
     private downloadImageAllBrowsers;
-    /**
-     * Private method to download the current image only for IE11 using
-     * custom javascript's methods available only on IE.
-     */
-    private downloadImageOnlyIEorEdge;
     /**
      * Private method to get the `ButtonEvent` to emit, merging the input `ButtonEvent`
      * with the current image.
-     * @param ButtonEvent event payload to return
+     * @param event ButtonEvent event payload to return
      * @returns ButtonEvent event payload with the current image included
+     * @private
      */
     private getButtonEventToEmit;
     /**
      * Private method to get the file name from an input path.
      * This is used either to get the image's name from its path or from the Image itself,
      * if specified as 'downloadFileName' by the user.
-     * @param Image image to extract its file name
+     * @param image Image image to extract its file name
      * @param isBase64 boolean to set if the image is a base64 file or not. False by default.
      * @param base64Extension string to force the extension of the base64 image. Empty string by default.
      * @returns string string file name of the input image.
+     * @private
      */
     private getFileName;
     /**
      * Private method to initialize `images` as array of `Image`s.
-     * Also, it will emit ImageowmodaModalEvent to say that images are loaded.
+     * Also, it will emit ImageModalEvent to say that images are loaded.
+     * @private
      */
     private initImages;
     /**
      * Private method to emit events when either the last or the first image are visible.
-     * @param action Enum of type Action that represents the source of the event that changed the
+     * @param action Action Enum of type Action that represents the source of the event that changed the
      *  current image to the first one or the last one.
-     * @param indexToCheck is the index number of the image (the first or the last one).
+     * @param indexToCheck number is the index number of the image (the first or the last one).
+     * @private
      */
     private emitBoundaryEvent;
-    /**
-     * Private method to check if this library is running on
-     * Microsoft browsers or not (i.e. it detects both IE11 and Edge)
-     * supporting also Server-Side Rendering.
-     * Inspired by https://msdn.microsoft.com/it-it/library/hh779016(v=vs.85).aspx
-     * @returns any the result
-     */
-    private isIEorEdge;
     static ɵfac: i0.ɵɵFactoryDeclaration<ModalGalleryComponent, never>;
     static ɵcmp: i0.ɵɵComponentDeclaration<ModalGalleryComponent, "ks-modal-gallery", never, {}, {}, never, never>;
 }

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

@@ -14,19 +14,75 @@ export declare class ModalGalleryService {
     updateImages$: import("rxjs").Observable<Image[]>;
     private dialogRef;
     constructor(injector: Injector, overlay: Overlay, configService: ConfigService);
+    /**
+     * Method to open modal gallery passing the configuration
+     * @param config ModalGalleryConfig that contains: id, array of images, current image and optionally the configuration object
+     * @return ModalGalleryRef | undefined is the object used to listen for events.
+     */
     open(config: ModalGalleryConfig): ModalGalleryRef | undefined;
+    /**
+     * Method to close a modal gallery previously opened.
+     * @param id Unique identifier of the modal gallery
+     * @param clickOutside boolean is true if closed clicking on the modal backdrop, false otherwise.
+     */
     close(id: number, clickOutside: boolean): void;
+    /**
+     * Method to update images array.
+     * @param images Image[] updated array of images
+     */
     updateModalImages(images: Image[]): void;
+    /**
+     * Method to emit close event.
+     * @param event ImageModalEvent is the event payload
+     */
     emitClose(event: ImageModalEvent): void;
+    /**
+     * Method to emit show event.
+     * @param event ImageModalEvent is the event payload
+     */
     emitShow(event: ImageModalEvent): void;
+    /**
+     * Method to emit firstImage event.
+     * @param event ImageModalEvent is the event payload
+     */
     emitFirstImage(event: ImageModalEvent): void;
+    /**
+     * Method to emit lastImage event.
+     * @param event ImageModalEvent is the event payload
+     */
     emitLastImage(event: ImageModalEvent): void;
+    /**
+     * Method to emit hasData event.
+     * @param event ImageModalEvent is the event payload
+     */
     emitHasData(event: ImageModalEvent): void;
+    /**
+     * Method to emit buttonBeforeHook event.
+     * @param event ButtonEvent is the event payload
+     */
     emitButtonBeforeHook(event: ButtonEvent): void;
+    /**
+     * Method to emit buttonAfterHook event.
+     * @param event ButtonEvent is the event payload
+     */
     emitButtonAfterHook(event: ButtonEvent): void;
+    /**
+     * Private method to create an Overlay using Angular CDK APIs
+     * @private
+     */
     private createOverlay;
+    /**
+     * Private method to attach ModalGalleryComponent to the overlay.
+     * @param overlayRef OverlayRef is the Overlay object created using Angular CDK APIs
+     * @param config ModalGalleryConfig that contains: id, array of images, current image and optionally the configuration object
+     * @param dialogRef ModalGalleryRef is the object to control the dialog instance
+     * @private
+     */
     private attachDialogContainer;
-    private createInjector;
+    /**
+     * Private method to create an OverlayConfig instance
+     * @private
+     */
     private getOverlayConfig;
     static ɵfac: i0.ɵɵFactoryDeclaration<ModalGalleryService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ModalGalleryService>;

package/lib/components/plain-gallery/plain-gallery.component.d.ts

@@ -5,7 +5,7 @@ import { Size } from '../../model/size.interface';
 import { PlainGalleryConfig } from '../../model/plain-gallery-config.interface';
 import { ConfigService } from '../../services/config.service';
 import { AccessibleComponent } from '../accessible.component';
-import { LibConfig } from '../../model/lib-config.interface';
+import { PlainLibConfig } from '../../model/lib-config.interface';
 import * as i0 from "@angular/core";
 /**
  * Component with the gallery of thumbs.
@@ -16,23 +16,23 @@ import * as i0 from "@angular/core";
  */
 export declare class PlainGalleryComponent 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 | undefined;
     /**
      * Array of `Image` that represent the model of this library with all images, thumbs and so on.
      */
     images: Image[];
     /**
-     * Boolean to show/hide plain gallery. If true the plain gallery will be visible, false otherwise.
-     */
-    showGallery: boolean | undefined;
-    /**
-     * Array of `Image` that represent the model of this library with all images, thumbs and so on.
+     * PlainLibConfig object to configure plain-gallery.
      */
-    config: LibConfig | undefined;
+    config: PlainLibConfig | undefined;
     /**
-     * Output to emit an event when an image is changed.
+     * Output to emit an event when an image is clicked.
      */
-    showImage: EventEmitter<number>;
+    clickImage: EventEmitter<number>;
     /**
      * Object of type `PlainGalleryConfig` to configure the plain gallery.
      */
@@ -92,6 +92,12 @@ export declare class PlainGalleryComponent extends AccessibleComponent implement
      * @param Image img is the Image to show
      */
     showModalGalleryByImage(img: Image): void;
+    /**
+     * Method called when you navigate between images.
+     * This will emit the show event with the image as payload.
+     * @param KeyboardEvent event that triggered the navigation
+     * @param Image img is the Image to show
+     */
     onNavigationEvent(event: KeyboardEvent, img: Image): void;
     /**
      * Method to get `alt attribute`.
@@ -125,5 +131,5 @@ export declare class PlainGalleryComponent extends AccessibleComponent implement
      */
     private initImageGrid;
     static ɵfac: i0.ɵɵFactoryDeclaration<PlainGalleryComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<PlainGalleryComponent, "ks-plain-gallery", never, { "id": "id"; "images": "images"; "showGallery": "showGallery"; "config": "config"; }, { "showImage": "showImage"; }, never, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PlainGalleryComponent, "ks-plain-gallery", never, { "id": "id"; "images": "images"; "config": "config"; }, { "clickImage": "clickImage"; }, never, never>;
 }

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

@@ -14,6 +14,10 @@ import * as i0 from "@angular/core";
  */
 export declare class PreviewsComponent 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 | undefined;
     /**
      * Object of type `InternalLibImage` that represent the visible image.
@@ -92,6 +96,7 @@ export declare class PreviewsComponent extends AccessibleComponent implements On
      * This will trigger the `clickpreview` output with the input preview as its payload.
      * @param InternalLibImage preview that triggered this method
      * @param KeyboardEvent | MouseEvent event payload
+     * @param Action action that triggered the source event or `Action.NORMAL` if not specified
      */
     onImageEvent(preview: InternalLibImage, event: KeyboardEvent | MouseEvent, action?: Action): void;
     /**
@@ -99,6 +104,7 @@ export declare class PreviewsComponent extends AccessibleComponent implements On
      * It also emits an event to specify which 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 source event or `Action.NORMAL` if not specified
      */
     onNavigationEvent(direction: string, event: KeyboardEvent | MouseEvent, action?: Action): void;
     /**