@ks89/angular-modal-gallery 13.0.0 → 14.0.0

package/lib/model/carousel-config.interface.d.ts

@@ -1,11 +0,0 @@
-/**
- * Interface `CarouselConfig` to change the style of the carousel and some additional features.
- */
-export interface CarouselConfig {
-    maxWidth: string;
-    maxHeight: string;
-    showArrows: boolean;
-    objectFit: string;
-    keyboardEnable: boolean;
-    modalGalleryEnable: boolean;
-}

package/lib/model/carousel-image-config.interface.d.ts

@@ -1,8 +0,0 @@
-import { Description } from './description.interface';
-/**
- * Interface `CarouselImageConfig` to change current image behaviour in carousel.
- */
-export interface CarouselImageConfig {
-    description?: Description;
-    invertSwipe?: boolean;
-}

package/lib/model/carousel-preview-config.interface.d.ts

@@ -1,22 +0,0 @@
-/**
- * Interface `BreakpointsConfig` to configure responsive breakpoints as numbers to express pixels
- */
-export interface BreakpointsConfig {
-    xSmall: number;
-    small: number;
-    medium: number;
-    large: number;
-    xLarge: number;
-}
-/**
- * Interface `CarouselPreviewConfig` to configure carousel's previews
- */
-export interface CarouselPreviewConfig {
-    visible: boolean;
-    number?: number;
-    arrows?: boolean;
-    clickable?: boolean;
-    width?: string;
-    maxHeight?: string;
-    breakpoints?: BreakpointsConfig;
-}

package/lib/model/current-image-config.interface.d.ts

@@ -1,12 +0,0 @@
-import { LoadingConfig } from './loading-config.interface';
-import { Description } from './description.interface';
-/**
- * Interface `CurrentImageConfig` to change current image behaviour in modal-gallery.
- */
-export interface CurrentImageConfig {
-    navigateOnClick?: boolean;
-    downloadable?: boolean;
-    loadingConfig?: LoadingConfig;
-    description?: Description;
-    invertSwipe?: boolean;
-}

package/lib/model/description.interface.d.ts

@@ -1,39 +0,0 @@
-/**
- * Interface `Description` to change the description, either with a full custom
- * description or with a small and simple customization.
- * Also, you could change margins, background style and so on.
- */
-export interface Description {
-    strategy: DescriptionStrategy;
-    customFullDescription?: string;
-    imageText?: string;
-    numberSeparator?: string;
-    beforeTextDescription?: string;
-    style?: DescriptionStyle;
-}
-/**
- * Enum `DescriptionStrategy` with keys and their relative key codes.
- */
-export declare enum DescriptionStrategy {
-    ALWAYS_HIDDEN = 1,
-    ALWAYS_VISIBLE = 2,
-    HIDE_IF_EMPTY = 3
-}
-/**
- * Interface to change css properties.
- */
-export interface DescriptionStyle {
-    bgColor?: string;
-    textColor?: string;
-    width?: string;
-    height?: string;
-    position?: string;
-    top?: string;
-    bottom?: string;
-    left?: string;
-    right?: string;
-    marginTop?: string;
-    marginBottom?: string;
-    marginRight?: string;
-    marginLeft?: string;
-}

package/lib/model/dots-config.interface.d.ts

@@ -1,6 +0,0 @@
-/**
- * Interface `DotsConfig` to show/hide dots.
- */
-export interface DotsConfig {
-    visible: boolean;
-}

package/lib/model/image-internal.class.d.ts

@@ -1,9 +0,0 @@
-import { Image, ModalImage, PlainImage } from './image.class';
-/**
- * Internal representation of an image adding other fields
- * to the public `Image` class.
- */
-export declare class InternalLibImage extends Image {
-    previouslyLoaded: boolean;
-    constructor(id: number, modal: ModalImage, plain?: PlainImage, previouslyLoaded?: boolean);
-}

package/lib/model/image.class.d.ts

@@ -1,64 +0,0 @@
-import { Action } from './action.enum';
-import { Size } from './size.interface';
-import { SafeResourceUrl } from '@angular/platform-browser';
-/**
- * Class `Image` that represents an image with both `modal` and `plain` configurations.
- * Both image `id` and `modal` are mandatory, instead `plain` is optional.
- */
-export declare class Image {
-    id: number;
-    loading: 'eager' | 'lazy';
-    fetchpriority: 'high' | 'low' | 'auto';
-    modal: ModalImage;
-    plain?: PlainImage;
-    constructor(id: number, modal: ModalImage, plain?: PlainImage, loading?: 'eager' | 'lazy', fetchpriority?: 'high' | 'low' | 'auto');
-}
-/**
- * Interface `ImageData` to configure an image, but it isn't used directly.
- * Please, refers to `PlainImage` or `ModalImage`.
- */
-export interface ImageData {
-    img: string | SafeResourceUrl;
-    description?: string;
-    title?: string;
-    alt?: string;
-    ariaLabel?: string;
-    fallbackImg?: string | SafeResourceUrl;
-}
-/**
- * Interface `ModalImage` to configure the modal image.
- */
-export interface ModalImage extends ImageData {
-    extUrl?: string;
-    downloadFileName?: string;
-    sources?: Source[];
-}
-/**
- * Interface `PlainImage` to configure the plain image.
- */
-export interface PlainImage extends ImageData {
-    size?: Size;
-}
-/**
- * Class `ImageEvent` that represents the event payload with the result and the triggered action.
- * It also contains the source id of the gallery that emitted this event
- */
-export declare class ImageEvent {
-    galleryId: number;
-    action: Action;
-    result: number | boolean;
-    constructor(galleryId: number, action: Action, result: number | boolean);
-}
-/**
- * Class `ImageModalEvent` that represents the event payload with galleryId, result and the triggered action.
- */
-export declare class ImageModalEvent extends ImageEvent {
-    constructor(galleryId: number, action: Action, result: number | boolean);
-}
-/**
- * Interface `Source` to configure sources of picture element.
- */
-export interface Source {
-    srcset: string;
-    media: string;
-}

package/lib/model/interaction-event.interface.d.ts

@@ -1,6 +0,0 @@
-import { Action } from './action.enum';
-export interface InteractionEvent {
-    source: string;
-    action: Action;
-    payload: any;
-}

package/lib/model/keyboard-config.interface.d.ts

@@ -1,8 +0,0 @@
-/**
- * Interface `KeyboardConfig` to assign custom codes to ESC, RIGHT and LEFT keyboard's actions.
- */
-export interface KeyboardConfig {
-    esc?: string;
-    right?: string;
-    left?: string;
-}

package/lib/model/keyboard.enum.d.ts

@@ -1,13 +0,0 @@
-/**
- * Enum `Keyboard` with keys and their relative codes.
- */
-import { DOWN_ARROW_CODE, ESC_CODE, LEFT_ARROW_CODE, RIGHT_ARROW_CODE, UP_ARROW_CODE } from '../utils/user-input.util';
-type Keyboard = Readonly<{
-    ESC: typeof ESC_CODE;
-    LEFT_ARROW: typeof LEFT_ARROW_CODE;
-    RIGHT_ARROW: typeof RIGHT_ARROW_CODE;
-    UP_ARROW: typeof UP_ARROW_CODE;
-    DOWN_ARROW: typeof DOWN_ARROW_CODE;
-}>;
-export declare const Keyboard: Keyboard;
-export {};

package/lib/model/lib-config.interface.d.ts

@@ -1,39 +0,0 @@
-import { SlideConfig } from './slide-config.interface';
-import { AccessibilityConfig } from './accessibility.interface';
-import { PreviewConfig } from './preview-config.interface';
-import { ButtonsConfig } from './buttons-config.interface';
-import { DotsConfig } from './dots-config.interface';
-import { PlainGalleryConfig } from './plain-gallery-config.interface';
-import { CurrentImageConfig } from './current-image-config.interface';
-import { KeyboardConfig } from './keyboard-config.interface';
-import { CarouselConfig } from './carousel-config.interface';
-import { CarouselImageConfig } from './carousel-image-config.interface';
-import { CarouselPreviewConfig } from './carousel-preview-config.interface';
-import { PlayConfig } from './play-config.interface';
-export interface AccessibleLibConfig {
-    accessibilityConfig?: AccessibilityConfig;
-}
-export interface CommonLibConfig {
-    previewConfig?: PreviewConfig;
-    dotsConfig?: DotsConfig;
-    slideConfig?: SlideConfig;
-}
-export interface CarouselLibConfig extends CommonLibConfig, AccessibleLibConfig {
-    carouselConfig?: CarouselConfig;
-    carouselImageConfig?: CarouselImageConfig;
-    carouselPreviewsConfig?: CarouselPreviewConfig;
-    carouselPlayConfig?: PlayConfig;
-    carouselDotsConfig?: DotsConfig;
-    carouselSlideInfinite?: boolean;
-}
-export interface ModalLibConfig extends CommonLibConfig, AccessibleLibConfig {
-    enableCloseOutside?: boolean;
-    keyboardConfig?: KeyboardConfig;
-    currentImageConfig?: CurrentImageConfig;
-    buttonsConfig?: ButtonsConfig;
-}
-export interface PlainLibConfig extends AccessibleLibConfig {
-    plainGalleryConfig?: PlainGalleryConfig;
-}
-export interface LibConfig extends ModalLibConfig, PlainLibConfig, CarouselLibConfig {
-}

package/lib/model/loading-config.interface.d.ts

@@ -1,19 +0,0 @@
-/**
- * Interface `LoadingConfig` to configure loading icon.
- */
-export interface LoadingConfig {
-    enable: boolean;
-    type: LoadingType;
-}
-/**
- * Enum `LoadingType` with a list of possible types.
- */
-export declare enum LoadingType {
-    STANDARD = 1,
-    CIRCULAR = 2,
-    BARS = 3,
-    DOTS = 4,
-    CUBE_FLIPPING = 5,
-    CIRCLES = 6,
-    EXPLOSING_SQUARES = 7
-}

package/lib/model/max-size.interface.d.ts

@@ -1,8 +0,0 @@
-/**
- * Interface `MaxSize` to configure the size based on max-width and max-height.
- * They can be pixels, percentages.
- */
-export interface MaxSize {
-    maxWidth?: string;
-    maxHeight?: string;
-}

package/lib/model/modal-gallery-config.interface.d.ts

@@ -1,16 +0,0 @@
-import { TemplateRef } from '@angular/core';
-import { Image } from './image.class';
-import { ModalLibConfig } from './lib-config.interface';
-export interface ModalGalleryConfig {
-    id: number;
-    images: Image[];
-    currentImage: Image;
-    libConfig?: ModalLibConfig;
-    /**
-     * Optional template reference for the rendering of previews.
-     * Template may access following context variables:
-     * - "preview": the `Image` object of the preview
-     * - "defaultTemplate": the template used by default to render the preview (in case the need is to augment it)
-     */
-    previewsTemplate?: TemplateRef<HTMLElement>;
-}

package/lib/model/plain-gallery-config.interface.d.ts

@@ -1,57 +0,0 @@
-import { Size } from './size.interface';
-/**
- * Interface `PlainGalleryConfig` to configure plain-gallery features.
- */
-export interface PlainGalleryConfig {
-    strategy: PlainGalleryStrategy;
-    layout: PlainGalleryLayout;
-    advanced?: AdvancedConfig;
-}
-/**
- * Interface `PlainGalleryLayout` to configure the layout. This interface isn't used directly, instead
- * refers to either `LineLayout`, `GridLayout`.
- */
-export interface PlainGalleryLayout {
-}
-/**
- * Class `LineLayout` to configure a linear plain gallery.
- */
-export declare class LineLayout implements PlainGalleryLayout {
-    breakConfig: BreakConfig;
-    justify: string;
-    size: Size;
-    constructor(size: Size, breakConfig: BreakConfig, justify: string);
-}
-/**
- * Class `GridLayout` to configure a grid plain gallery.
- */
-export declare class GridLayout implements PlainGalleryLayout {
-    breakConfig: BreakConfig;
-    size: Size;
-    constructor(size: Size, breakConfig: BreakConfig);
-}
-/**
- * Enum `PlainGalleryStrategy` to choose the behaviour of the plain gallery.
- */
-export declare enum PlainGalleryStrategy {
-    ROW = 1,
-    COLUMN = 2,
-    GRID = 3,
-    CUSTOM = 4
-}
-/**
- * Interface `BreakConfig` to limit the number of items of the plain gallery or to force it to fill other lines.
- */
-export interface BreakConfig {
-    length: number;
-    wrap: boolean;
-}
-/**
- * Interface `AdvancedConfig` to use `<a>` tags instead of `<img>`.
- * It also contains a string property to customize the css background property.
- * For more info check here https://www.w3schools.com/cssref/css3_pr_background.asp
- */
-export interface AdvancedConfig {
-    aTags: boolean;
-    additionalBackground: string;
-}

package/lib/model/play-config.interface.d.ts

@@ -1,8 +0,0 @@
-/**
- * Interface `PlayConfig` to change the behaviour about auto-navigation for both modal gallery and carousel.
- */
-export interface PlayConfig {
-    autoPlay: boolean;
-    interval: number;
-    pauseOnHover: boolean;
-}

package/lib/model/preview-config.interface.d.ts

@@ -1,12 +0,0 @@
-import { Size } from './size.interface';
-/**
- * Interface `PreviewConfig` to configure previews in modal gallery.
- */
-export interface PreviewConfig {
-    visible: boolean;
-    mobileVisible?: boolean;
-    number?: number;
-    arrows?: boolean;
-    clickable?: boolean;
-    size?: Size;
-}

package/lib/model/size.interface.d.ts

@@ -1,8 +0,0 @@
-/**
- * Interface `Size` to configure the size based on width and height.
- * They can be pixels, percentages or also 'auto'.
- */
-export interface Size {
-    width: string;
-    height: string;
-}

package/lib/model/slide-config.interface.d.ts

@@ -1,17 +0,0 @@
-import { Size } from './size.interface';
-import { PlayConfig } from './play-config.interface';
-/**
- * Interface `SlideConfig` to configure sliding features of modal gallery.
- */
-export interface SlideConfig {
-    infinite?: boolean;
-    playConfig?: PlayConfig;
-    sidePreviews?: SidePreviewsConfig;
-}
-/**
- * Interface `SidePreviewsConfig` to configure sliding features of previews in modal gallery.
- */
-export interface SidePreviewsConfig {
-    show: boolean;
-    size: Size;
-}

package/lib/services/config.service.d.ts

@@ -1,39 +0,0 @@
-import { SlideConfig } from '../model/slide-config.interface';
-import { PlayConfig } from '../model/play-config.interface';
-import { PreviewConfig } from '../model/preview-config.interface';
-import { Size } from '../model/size.interface';
-import { LineLayout, PlainGalleryConfig } from '../model/plain-gallery-config.interface';
-import { CurrentImageConfig } from '../model/current-image-config.interface';
-import { LoadingConfig } from '../model/loading-config.interface';
-import { Description, DescriptionStyle } from '../model/description.interface';
-import { CarouselConfig } from '../model/carousel-config.interface';
-import { CarouselImageConfig } from '../model/carousel-image-config.interface';
-import { BreakpointsConfig, CarouselPreviewConfig } from '../model/carousel-preview-config.interface';
-import { LibConfig } from '../model/lib-config.interface';
-import * as i0 from "@angular/core";
-export declare const DEFAULT_PREVIEW_SIZE: Size;
-export declare const DEFAULT_LAYOUT: LineLayout;
-export declare const DEFAULT_PLAIN_CONFIG: PlainGalleryConfig;
-export declare const DEFAULT_LOADING: LoadingConfig;
-export declare const DEFAULT_DESCRIPTION_STYLE: DescriptionStyle;
-export declare const DEFAULT_DESCRIPTION: Description;
-export declare const DEFAULT_CAROUSEL_DESCRIPTION: Description;
-export declare const DEFAULT_CURRENT_IMAGE_CONFIG: CurrentImageConfig;
-export declare const DEFAULT_CAROUSEL_IMAGE_CONFIG: CarouselImageConfig;
-export declare const DEFAULT_CURRENT_CAROUSEL_CONFIG: CarouselConfig;
-export declare const DEFAULT_CURRENT_CAROUSEL_PLAY: PlayConfig;
-export declare const DEFAULT_CAROUSEL_BREAKPOINTS: BreakpointsConfig;
-export declare const DEFAULT_CAROUSEL_PREVIEWS_CONFIG: CarouselPreviewConfig;
-export declare const DEFAULT_SLIDE_CONFIG: SlideConfig;
-export declare const DEFAULT_PREVIEW_CONFIG: PreviewConfig;
-/**
- * Service to handle library configuration in a unique place
- */
-export declare class ConfigService {
-    configMap: Map<number, LibConfig>;
-    getConfig(id: number): LibConfig | undefined;
-    setConfig(id: number, obj: LibConfig | undefined): void;
-    private initIfNotExists;
-    static ɵfac: i0.ɵɵFactoryDeclaration<ConfigService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<ConfigService>;
-}

package/lib/services/id-validator.service.d.ts

@@ -1,25 +0,0 @@
-import * as i0 from "@angular/core";
-/**
- * Service to check if the provided id is unique
- */
-export declare class IdValidatorService {
-    ids: Map<any, any>;
-    /**
-     * Method to check and reserve an id for the current instance of the library.
-     * In this way, no other instances can use the same id.
-     * @param galleryId number or undefined that represents the unique id of the gallery.
-     * @return boolean true if success. false is never returned, instead an exception is thrown
-     * @throws a error with a message if galleryId is neither unique, < 0 or an integer
-     */
-    checkAndAdd(galleryId: number | undefined): boolean;
-    /**
-     * Method to remove a reserved id. In this way you are able to use the id again for another instance of the library.
-     * @param galleryId number or undefined that represents the unique id of the gallery.
-     * @return boolean true if success. false is never returned, instead an exception is thrown*
-     * @throws a error with a message if galleryId is neither integer or < 0
-     * * this should be improved without return true, because it doesn't make sense! :(
-     */
-    remove(galleryId: number | undefined): boolean;
-    static ɵfac: i0.ɵɵFactoryDeclaration<IdValidatorService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<IdValidatorService>;
-}

package/lib/utils/image.util.d.ts

@@ -1,10 +0,0 @@
-import { Image } from '../model/image.class';
-/**
- * Utility function to get the index of the input `image` from `arrayOfImages`
- * @param image Image to get the index. The image 'id' must be a number >= 0
- * @param arrayOfImages Image[] to search the image within it
- * @returns number the index of the image. -1 if not found.
- * @throws an Error if either image or arrayOfImages are not valid,
- *  or if the input image doesn't contain an 'id', or the 'id' is < 0
- */
-export declare function getIndex(image: Image, arrayOfImages: Image[]): number;

package/lib/utils/user-input.util.d.ts

@@ -1,80 +0,0 @@
-/**
- * Key of the keyboard's key `enter`
- */
-export declare const ENTER_KEY: string;
-/**
- * Code of the keyboard's key `enter`
- */
-export declare const ENTER_CODE: string;
-/**
- * Key of the keyboard's key `esc`
- */
-export declare const ESC_KEY: string;
-/**
- * Code of the keyboard's key `esc`
- */
-export declare const ESC_CODE: string;
-/**
- * Key of the keyboard's key 'right arrow'
- */
-export declare const RIGHT_ARROW_KEY: string;
-/**
- * Code of the keyboard's key 'right arrow'
- */
-export declare const RIGHT_ARROW_CODE: string;
-/**
- * Key of the keyboard's key 'left arrow'
- */
-export declare const LEFT_ARROW_KEY: string;
-/**
- * Code of the keyboard's key 'left arrow'
- */
-export declare const LEFT_ARROW_CODE: string;
-/**
- * Key of the keyboard's key 'left arrow'
- */
-export declare const UP_ARROW_KEY: string;
-/**
- * Code of the keyboard's key 'left arrow'
- */
-export declare const UP_ARROW_CODE: string;
-/**
- * Key of the keyboard's key 'left arrow'
- */
-export declare const DOWN_ARROW_KEY: string;
-/**
- * Code of the keyboard's key 'left arrow'
- */
-export declare const DOWN_ARROW_CODE: string;
-/**
- * Key of the keyboard's key `space`
- */
-export declare const SPACE_KEY: string;
-/**
- * Code of the keyboard's key `space`
- */
-export declare const SPACE_CODE: string;
-/**
- * Const to represent the right direction
- */
-export declare const DIRECTION_RIGHT: string;
-/**
- * Const to represent the left direction
- */
-export declare const DIRECTION_LEFT: string;
-/**
- * Keycode of the main mouse button
- */
-export declare const MOUSE_MAIN_BUTTON_CLICK = 0;
-/**
- * Const NEXT
- */
-export declare const NEXT = 1;
-/**
- * Const PREV
- */
-export declare const PREV = -1;
-/**
- * Const NOTHING to represents a situation when it isn't both NEXT and PREV
- */
-export declare const NOTHING = 0;

package/public-api.d.ts

@@ -1,36 +0,0 @@
-/**
- * Index file to export all interfaces, enums, classes and so on.
- * This file represents the public apis.
- */
-export { GalleryModule } from './lib/modal-gallery.module';
-export { Action } from './lib/model/action.enum';
-export { Image, ImageEvent, ImageModalEvent } from './lib/model/image.class';
-export type { PlainImage, ModalImage } from './lib/model/image.class';
-export { DescriptionStrategy } from './lib/model/description.interface';
-export type { Description } from './lib/model/description.interface';
-export type { KeyboardConfig } from './lib/model/keyboard-config.interface';
-export type { DotsConfig } from './lib/model/dots-config.interface';
-export type { PreviewConfig } from './lib/model/preview-config.interface';
-export type { AccessibilityConfig } from './lib/model/accessibility.interface';
-export type { BreakpointsConfig, CarouselPreviewConfig } from './lib/model/carousel-preview-config.interface';
-export type { CarouselConfig } from './lib/model/carousel-config.interface';
-export type { PlayConfig } from './lib/model/play-config.interface';
-export type { CarouselImageConfig } from './lib/model/carousel-image-config.interface';
-export type { Size } from './lib/model/size.interface';
-export { ButtonsStrategy, ButtonType } from './lib/model/buttons-config.interface';
-export type { ButtonsConfig, ButtonEvent } from './lib/model/buttons-config.interface';
-export type { ModalLibConfig, PlainLibConfig, CarouselLibConfig } from './lib/model/lib-config.interface';
-export type { ModalGalleryConfig } from './lib/model/modal-gallery-config.interface';
-export type { CurrentImageConfig } from './lib/model/current-image-config.interface';
-export { LoadingType } from './lib/model/loading-config.interface';
-export type { LoadingConfig } from './lib/model/loading-config.interface';
-export type { InteractionEvent } from './lib/model/interaction-event.interface';
-export { KS_DEFAULT_ACCESSIBILITY_CONFIG } from './lib/components/accessibility-default';
-export { KS_DEFAULT_BTN_FULL_SCREEN, KS_DEFAULT_BTN_CLOSE, KS_DEFAULT_BTN_DELETE, KS_DEFAULT_BTN_DOWNLOAD, KS_DEFAULT_BTN_EXTURL, KS_DEFAULT_SIZE } from './lib/components/upper-buttons/upper-buttons-default';
-export { LineLayout, GridLayout, PlainGalleryStrategy } from './lib/model/plain-gallery-config.interface';
-export type { PlainGalleryConfig, PlainGalleryLayout, BreakConfig } from './lib/model/plain-gallery-config.interface';
-export { ModalGalleryComponent } from './lib/components/modal-gallery/modal-gallery.component';
-export { PlainGalleryComponent } from './lib/components/plain-gallery/plain-gallery.component';
-export { CarouselComponent } from './lib/components/carousel/carousel.component';
-export { ModalGalleryService } from './lib/components/modal-gallery/modal-gallery.service';
-export { ModalGalleryRef } from './lib/components/modal-gallery/modal-gallery-ref';