lightgallery 2.9.0 → 3.0.0-beta.2

package/{plugins → dist/types/plugins}/autoplay/lg-autoplay-settings.d.ts

@@ -1,38 +1,41 @@
-export interface AutoplayStrings {
-    toggleAutoplay: string;
-}
-export interface AutoplaySettings {
-    /**
-     * Enable autoplay plugin
-     */
-    autoplay: boolean;
-    /**
-     * Enable slideshow autoplay
-     */
-    slideShowAutoplay: boolean;
-    /**
-     * The time (in ms) between each auto transition.
-     */
-    slideShowInterval: number;
-    /**
-     * Show autoplay progressBar
-     */
-    progressBar: boolean;
-    /**
-     * If false autoplay will be stopped after first user action
-     */
-    forceSlideShowAutoplay: boolean;
-    /**
-     * Show/hide autoplay controls.
-     */
-    autoplayControls: boolean;
-    /**
-     * Specify where the autoplay controls should be appended.
-     */
-    appendAutoplayControlsTo: string;
-    /**
-     * Custom translation strings for aria-labels
-     */
-    autoplayPluginStrings: AutoplayStrings;
-}
-export declare const autoplaySettings: AutoplaySettings;
+export interface AutoplayStrings {
+    toggleAutoplay: string;
+}
+export interface AutoplaySettings {
+    /**
+     * Enable autoplay plugin
+     */
+    autoplay: boolean;
+    /**
+     * Enable slideshow autoplay
+     */
+    slideShowAutoplay: boolean;
+    /**
+     * The time (in ms) between each auto transition.
+     */
+    slideShowInterval: number;
+    /**
+     * Show autoplay progressBar
+     */
+    progressBar: boolean;
+    /**
+     * If false autoplay will be stopped after first user action
+     */
+    forceSlideShowAutoplay: boolean;
+    /**
+     * Show/hide autoplay controls.
+     */
+    autoplayControls: boolean;
+    /**
+     * Specify where the autoplay controls should be appended.
+     */
+    appendAutoplayControlsTo: string;
+    /**
+     * Custom translation strings for aria-labels
+     * @deprecated Set these labels on the core `strings` object instead,
+     * every user-facing string lives in that one contract. An explicitly set
+     * key here still wins (alias).
+     */
+    autoplayPluginStrings?: Partial<AutoplayStrings>;
+}
+export declare const autoplaySettings: AutoplaySettings;

package/{plugins → dist/types/plugins}/autoplay/lg-autoplay.d.ts

@@ -1,22 +1,22 @@
-import { LightGallery } from '../../lightgallery';
-import { AutoplaySettings } from './lg-autoplay-settings';
-/**
- * Creates the autoplay plugin.
- * @param {object} element - lightGallery element
- */
-export default class Autoplay {
-    core: LightGallery;
-    settings: AutoplaySettings;
-    interval: any;
-    fromAuto: boolean;
-    pausedOnTouchDrag: boolean;
-    pausedOnSlideChange: boolean;
-    constructor(instance: LightGallery);
-    init(): void;
-    private showProgressBar;
-    private controls;
-    startAutoPlay(): void;
-    stopAutoPlay(): void;
-    closeGallery(): void;
-    destroy(): void;
-}
+import { LightGallery } from '../../lightgallery';
+import { AutoplaySettings } from './lg-autoplay-settings';
+/**
+ * Creates the autoplay plugin.
+ * @param {object} element - lightGallery element
+ */
+export default class Autoplay {
+    core: LightGallery;
+    settings: AutoplaySettings;
+    interval: any;
+    fromAuto: boolean;
+    pausedOnTouchDrag: boolean;
+    pausedOnSlideChange: boolean;
+    constructor(instance: LightGallery);
+    init(): void;
+    private showProgressBar;
+    private controls;
+    startAutoPlay(): void;
+    stopAutoPlay(): void;
+    closeGallery(): void;
+    destroy(): void;
+}

package/{plugins → dist/types/plugins}/comment/lg-comment-settings.d.ts

@@ -1,33 +1,36 @@
-export interface CommentStrings {
-    toggleComments: string;
-}
-export interface CommentSettings {
-    /**
-     * Enable comment box
-     */
-    commentBox: boolean;
-    /**
-     * Enable facebook comment box
-     */
-    fbComments: boolean;
-    /**
-     * Enable disqus comment box
-     */
-    disqusComments: boolean;
-    /**
-     * Disqus comment config
-     */
-    disqusConfig: {
-        title?: string;
-        language: string;
-    };
-    /**
-     * Facebook comments default markup
-     */
-    commentsMarkup: string;
-    /**
-     * Custom translation strings for aria-labels
-     */
-    commentPluginStrings: CommentStrings;
-}
-export declare const commentSettings: CommentSettings;
+export interface CommentStrings {
+    toggleComments: string;
+}
+export interface CommentSettings {
+    /**
+     * Enable comment box
+     */
+    commentBox: boolean;
+    /**
+     * Enable facebook comment box
+     */
+    fbComments: boolean;
+    /**
+     * Enable disqus comment box
+     */
+    disqusComments: boolean;
+    /**
+     * Disqus comment config
+     */
+    disqusConfig: {
+        title?: string;
+        language: string;
+    };
+    /**
+     * Facebook comments default markup
+     */
+    commentsMarkup: string;
+    /**
+     * Custom translation strings for aria-labels
+     * @deprecated Set these labels on the core `strings` object instead,
+     * every user-facing string lives in that one contract. An explicitly set
+     * key here still wins (alias).
+     */
+    commentPluginStrings?: Partial<CommentStrings>;
+}
+export declare const commentSettings: CommentSettings;

package/{plugins → dist/types/plugins}/comment/lg-comment.d.ts

@@ -1,25 +1,25 @@
-/**
- * lightGallery comments module
- * Supports facebook and disqus comments
- *
- * @ref - https://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables
- * @ref - https://github.com/disqus/DISQUS-API-Recipes/blob/master/snippets/js/disqus-reset/disqus_reset.html
- * @ref - https://css-tricks.com/lazy-loading-disqus-comments/
- * @ref - https://developers.facebook.com/docs/plugins/comments/#comments-plugin
- *
- */
-import { LgQuery } from '../../lgQuery';
-import { LightGallery } from '../../lightgallery';
-import { CommentSettings } from './lg-comment-settings';
-export default class CommentBox {
-    core: LightGallery;
-    settings: CommentSettings;
-    private $LG;
-    constructor(instance: LightGallery, $LG: LgQuery);
-    init(): void;
-    private setMarkup;
-    toggleCommentBox(): void;
-    addFbComments(): void;
-    addDisqusComments(): void;
-    destroy(): void;
-}
+/**
+ * lightGallery comments module
+ * Supports facebook and disqus comments
+ *
+ * @ref - https://help.disqus.com/customer/portal/articles/472098-javascript-configuration-variables
+ * @ref - https://github.com/disqus/DISQUS-API-Recipes/blob/master/snippets/js/disqus-reset/disqus_reset.html
+ * @ref - https://css-tricks.com/lazy-loading-disqus-comments/
+ * @ref - https://developers.facebook.com/docs/plugins/comments/#comments-plugin
+ *
+ */
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { CommentSettings } from './lg-comment-settings';
+export default class CommentBox {
+    core: LightGallery;
+    settings: CommentSettings;
+    private $LG;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    init(): void;
+    private setMarkup;
+    toggleCommentBox(): void;
+    addFbComments(): void;
+    addDisqusComments(): void;
+    destroy(): void;
+}

package/{plugins → dist/types/plugins}/fullscreen/lg-fullscreen-settings.d.ts

@@ -1,14 +1,17 @@
-export interface FullscreenStrings {
-    toggleFullscreen: string;
-}
-export interface FullscreenSettings {
-    /**
-     * Enable/Disable fullscreen option
-     */
-    fullScreen: boolean;
-    /**
-     * Custom translation strings for aria-labels
-     */
-    fullscreenPluginStrings: FullscreenStrings;
-}
-export declare const fullscreenSettings: FullscreenSettings;
+export interface FullscreenStrings {
+    toggleFullscreen: string;
+}
+export interface FullscreenSettings {
+    /**
+     * Enable/Disable fullscreen option
+     */
+    fullScreen: boolean;
+    /**
+     * Custom translation strings for aria-labels
+     * @deprecated Set these labels on the core `strings` object instead,
+     * every user-facing string lives in that one contract. An explicitly set
+     * key here still wins (alias).
+     */
+    fullscreenPluginStrings?: Partial<FullscreenStrings>;
+}
+export declare const fullscreenSettings: FullscreenSettings;

package/{plugins → dist/types/plugins}/fullscreen/lg-fullscreen.d.ts

@@ -1,16 +1,16 @@
-import { LgQuery } from '../../lgQuery';
-import { LightGallery } from '../../lightgallery';
-import { FullscreenSettings } from './lg-fullscreen-settings';
-export default class FullScreen {
-    core: LightGallery;
-    settings: FullscreenSettings;
-    private $LG;
-    constructor(instance: LightGallery, $LG: LgQuery);
-    init(): void;
-    private isFullScreen;
-    private requestFullscreen;
-    private exitFullscreen;
-    private fullScreen;
-    closeGallery(): void;
-    destroy(): void;
-}
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { FullscreenSettings } from './lg-fullscreen-settings';
+export default class FullScreen {
+    core: LightGallery;
+    settings: FullscreenSettings;
+    private $LG;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    init(): void;
+    private isFullScreen;
+    private requestFullscreen;
+    private exitFullscreen;
+    private fullScreen;
+    closeGallery(): void;
+    destroy(): void;
+}

package/dist/types/plugins/hash/lg-hash-settings.d.ts

@@ -0,0 +1,28 @@
+import { HashDriverPreference } from '@lightgallery/headless';
+export interface HashSettings {
+    /**
+     * Enable/Disable hash option
+     */
+    hash: boolean;
+    /**
+     * URL engine behind the hash syncing.
+     * @description 'auto' uses the Navigation API where the browser
+     * supports it and falls back to the History API everywhere else;
+     * 'history' and 'navigation' force an engine (an unsupported
+     * 'navigation' quietly falls back, the enhancement is never
+     * load-bearing). The deep-link URL format is identical either way.
+     * See <a href="/docs/hash-drivers/">Hash drivers</a>.
+     * @version V3.0.0
+     */
+    hashDriver: HashDriverPreference;
+    /**
+     * Unique id for each gallery.
+     * @description It is mandatory when you use hash plugin for multiple galleries on the same page.
+     */
+    galleryId: string;
+    /**
+     * Custom slide name to use in the url when hash plugin is enabled
+     */
+    customSlideName: boolean;
+}
+export declare const hashSettings: HashSettings;

package/{plugins → dist/types/plugins}/hash/lg-hash.d.ts

@@ -1,23 +1,25 @@
-import { LgQuery } from '../../lgQuery';
-import { LightGallery } from '../../lightgallery';
-import { HashSettings } from './lg-hash-settings';
-export default class Hash {
-    core: LightGallery;
-    settings: HashSettings;
-    oldHash: string;
-    private $LG;
-    constructor(instance: LightGallery, $LG: LgQuery);
-    init(): void;
-    private onAfterSlide;
-    /**
-     * Get index of the slide from custom slideName. Has to be a public method. Used in hash plugin
-     * @param {String} hash
-     * @returns {Number} Index of the slide.
-     */
-    getIndexFromUrl(hash?: string): number;
-    buildFromHash(): boolean | undefined;
-    private onCloseAfter;
-    private onHashchange;
-    closeGallery(): void;
-    destroy(): void;
-}
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { HashSettings } from './lg-hash-settings';
+export default class Hash {
+    core: LightGallery;
+    settings: HashSettings;
+    oldHash: string;
+    private $LG;
+    private driver;
+    private unsubscribeDriver?;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    init(): void;
+    private onAfterSlide;
+    /**
+     * Get index of the slide from custom slideName. Has to be a public method. Used in hash plugin
+     * @param {String} hash
+     * @returns {Number} Index of the slide.
+     */
+    getIndexFromUrl(hash?: string): number;
+    buildFromHash(): boolean | undefined;
+    private onCloseAfter;
+    private onHashchange;
+    closeGallery(): void;
+    destroy(): void;
+}

package/dist/types/plugins/justified/lg-justified-settings.d.ts

@@ -0,0 +1,42 @@
+export interface JustifiedSettings {
+    /**
+     * Enable the justified layout for the gallery's trigger thumbnails:
+     * rows of equal height and varying widths that fill the container
+     * edge to edge. Inline galleries only, dynamic mode has no trigger
+     * grid to lay out. Each box shows as a placeholder and its thumbnail
+     * fades in once loaded; put `class="lg-justified"` on the container
+     * markup so nothing shows unorganized before the script runs.
+     * See <a href="/docs/justified-layout/">Justified layout</a>.
+     */
+    justified: boolean;
+    /**
+     * Row height (px) the layout aims for; actual rows land as close to
+     * it as the aspect ratios allow.
+     */
+    justifiedRowHeight: number;
+    /**
+     * Gap between thumbnails and between rows (px).
+     */
+    justifiedGap: number;
+    /**
+     * Last-row policy: 'justify' scales the leftover row to fill the
+     * width like every other row, 'start' keeps the row height aligned
+     * to the reading start, 'hide' hides the leftover thumbnails.
+     */
+    justifiedLastRow: 'justify' | 'start' | 'hide';
+    /**
+     * Row-height clamp as a multiple of justifiedRowHeight, a sparse
+     * row never renders taller than this.
+     */
+    justifiedMaxScale: number;
+    /**
+     * How thumbnails appear as they load: 'row' reveals whole rows top
+     * to bottom, each once every thumbnail in it has loaded; 'image'
+     * reveals each thumbnail on its own as soon as it has loaded.
+     * Until a thumbnail is revealed its box shows as a placeholder.
+     * See <a href="/docs/justified-layout/">Justified layout</a>.
+     * @version V3.0.0
+     */
+    justifiedReveal: 'row' | 'image';
+}
+export declare const justifiedSettings: JustifiedSettings;

package/dist/types/plugins/justified/lg-justified.d.ts

@@ -0,0 +1,55 @@
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { JustifiedSettings } from './lg-justified-settings';
+/**
+ * lightGallery justified layout: lays the gallery's trigger thumbnails
+ * out in rows of equal height and varying widths that fill the
+ * container edge to edge. The row math is shared headless code; this
+ * plugin measures the container, sources the aspect ratios and writes
+ * the geometry.
+ *
+ * Aspect-ratio sources, in order: the trigger's `data-lg-size`
+ * attribute, the thumbnail's `width`/`height` attributes, and finally
+ * the loaded image's natural size (one relayout when the last unknown
+ * resolves).
+ *
+ * Triggers stay invisible (stylesheet) until they are positioned; each
+ * box then shows as a placeholder and the thumbnails fade in as they
+ * load, row by row in reading order or one by one (`justifiedReveal`),
+ * so the grid is never seen unorganized. Ship `class="lg-justified"`
+ * on the container markup to cover the time before the script runs.
+ */
+export default class Justified {
+    core: LightGallery;
+    settings: JustifiedSettings;
+    private $LG;
+    private triggers;
+    private ratios;
+    private resizeObserver?;
+    private layoutWidth;
+    private pendingLoads;
+    private rows;
+    private loaded;
+    private loadWatchers;
+    private originalContainerStyle;
+    private originalTriggerStyles;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    init(): void;
+    /** Adopt the core's current trigger list into the layout. */
+    private collectTriggers;
+    /** Best-known aspect ratio per trigger; unknowns resolve on load. */
+    private resolveRatios;
+    /** Relayout once when the last unknown thumbnail resolves. */
+    private watchImageLoad;
+    private layout;
+    /** Track when the trigger's thumbnail has settled (loaded or failed). */
+    private watchLoad;
+    /**
+     * Fade in what may show now (see `justifiedReveal`). Never re-hides:
+     * a relayout regroups the rows, already visible triggers stay.
+     */
+    private reveal;
+    private cancelLoadWatchers;
+    closeGallery(): void;
+    destroy(): void;
+}

package/{plugins → dist/types/plugins}/mediumZoom/lg-medium-zoom-settings.d.ts

@@ -1,16 +1,16 @@
-export interface MediumZoomSettings {
-    /**
-     * Enable/Disable medium like zoom experience
-     */
-    mediumZoom: boolean;
-    /**
-     * Space between the gallery outer area and images
-     */
-    margin: number;
-    /**
-     * Background color for the gallery
-     * This can be overwritten by passing background color via `lg-background-color` for each item
-     */
-    backgroundColor: string;
-}
-export declare const mediumZoomSettings: MediumZoomSettings;
+export interface MediumZoomSettings {
+    /**
+     * Enable/Disable medium like zoom experience
+     */
+    mediumZoom: boolean;
+    /**
+     * Space between the gallery outer area and images
+     */
+    margin: number;
+    /**
+     * Background color for the gallery
+     * This can be overwritten by passing background color via `lg-background-color` for each item
+     */
+    backgroundColor: string;
+}
+export declare const mediumZoomSettings: MediumZoomSettings;

package/{plugins → dist/types/plugins}/mediumZoom/lg-medium-zoom.d.ts

@@ -1,12 +1,12 @@
-import { LgQuery } from '../../lgQuery';
-import { LightGallery } from '../../lightgallery';
-import { MediumZoomSettings } from './lg-medium-zoom-settings';
-export default class MediumZoom {
-    core: LightGallery;
-    settings: MediumZoomSettings;
-    private $LG;
-    constructor(instance: LightGallery, $LG: LgQuery);
-    private toggleItemClass;
-    init(): void;
-    destroy(): void;
-}
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { MediumZoomSettings } from './lg-medium-zoom-settings';
+export default class MediumZoom {
+    core: LightGallery;
+    settings: MediumZoomSettings;
+    private $LG;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    private toggleItemClass;
+    init(): void;
+    destroy(): void;
+}

package/dist/types/plugins/originCrop/lg-origin-crop-settings.d.ts

@@ -0,0 +1,12 @@
+export interface OriginCropSettings {
+    /**
+     * Enable/Disable the origin crop plugin: zoom-from-origin flights from
+     * cropped thumbnails (<code>object-fit: cover</code>,
+     * <code>background-size: cover</code>) start from the part of the image
+     * the thumbnail shows, at a uniform scale, and reveal the rest around it.
+     * See <a href="/demos/zoom-from-origin/">Zoom from origin</a>.
+     * @version 3.0.0
+     */
+    originCrop: boolean;
+}
+export declare const originCropSettings: OriginCropSettings;

package/dist/types/plugins/originCrop/lg-origin-crop.d.ts

@@ -0,0 +1,79 @@
+import { LightGallery } from '../../lightgallery';
+import { OriginCropSettings } from './lg-origin-crop-settings';
+/**
+ * Zoom-from-origin flights from cropped thumbnails. A grid tile cropped
+ * with `object-fit: cover` (or `background-size: cover`) shows a window of
+ * the image, and the built-in flight squashes the whole image into the
+ * tile. With this plugin the window grows from the tile at a uniform
+ * scale while two boxes around the slides crop the rest of the image,
+ * revealed as the flight lands; the close flies back the same way. The
+ * plugin reads the thumbnail's computed fit and position, so no markup is
+ * needed. Thumbnails the built-in flight lands exactly keep it.
+ *
+ * The core's flight is untouched: the plugin replaces the flight's
+ * transform through `getOriginTransform` and follows each of the core's
+ * flight steps with the crop, in the same task.
+ */
+export default class OriginCrop {
+    core: LightGallery;
+    settings: OriginCropSettings;
+    private outerBox?;
+    private innerBox?;
+    private flight?;
+    private closing;
+    private stageMoved;
+    private observer?;
+    private flipGrace?;
+    private restoreCore?;
+    constructor(instance: LightGallery);
+    init(): void;
+    destroy(): void;
+    /**
+     * Takes over the core's flight hooks: the flight's transform, and the
+     * dummy that flies in place of the loading image.
+     */
+    private patchCore;
+    /**
+     * The flight from (or back to) a trigger, when the built-in flight
+     * cannot land it exactly: a cropped thumbnail, one letterboxed in its
+     * box, or a background thumbnail. Undefined otherwise, and the core
+     * flies as it always does.
+     */
+    private getFlight;
+    /**
+     * The opening flight, whose transform the core has just asked for. For
+     * a cropped thumbnail the stage crops to the thumbnail before anything
+     * shows (the gallery is still transparent), then follows the slide.
+     */
+    private onBeforeOpen;
+    /**
+     * Follows the opening slide with the stage. Mutation records are
+     * delivered at the end of the task that made them, before the browser
+     * renders, so the stage moves in the same frame as each of the core's
+     * steps: when the core flips the slide to rest, the stage opens with it
+     * on the slide's duration and easing; when the core settles the flight,
+     * the stage lets go.
+     */
+    private followOpen;
+    private onBeforeClose;
+    /**
+     * The closing flight, whose transform the core has just asked for. The
+     * core puts the slide on it right after, in the same task; once it has,
+     * the stage follows on the slide's duration and easing: onto the
+     * thumbnail's box for a cropped thumbnail, else back to rest if an
+     * opening flight left it cropped.
+     */
+    private followClose;
+    private onAfterClose;
+    private getSlideTransition;
+    /**
+     * Crops the stage: both boxes hide their overflow and take their
+     * transforms, instantly or on a transition.
+     */
+    private setStage;
+    /** Lets go of the crop: the boxes are inert again. */
+    private resetStage;
+    private stopFollowing;
+    private wrapStage;
+    private unwrapStage;
+}

package/{plugins → dist/types/plugins}/pager/lg-pager-settings.d.ts

@@ -1,7 +1,7 @@
-export interface PagerSettings {
-    /**
-     * Enable/Disable pager option
-     */
-    pager: boolean;
-}
-export declare const pagerSettings: PagerSettings;
+export interface PagerSettings {
+    /**
+     * Enable/Disable pager option
+     */
+    pager: boolean;
+}
+export declare const pagerSettings: PagerSettings;