lightgallery 2.9.0 → 3.0.0-beta.3

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

@@ -1,13 +1,13 @@
-import { LgQuery } from '../../lgQuery';
-import { LightGallery } from '../../lightgallery';
-import { PagerSettings } from './lg-pager-settings';
-export default class Pager {
-    core: LightGallery;
-    settings: PagerSettings;
-    private $LG;
-    constructor(instance: LightGallery, $LG: LgQuery);
-    private getPagerHtml;
-    init(): void;
-    private manageActiveClass;
-    destroy(): void;
-}
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { PagerSettings } from './lg-pager-settings';
+export default class Pager {
+    core: LightGallery;
+    settings: PagerSettings;
+    private $LG;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    private getPagerHtml;
+    init(): void;
+    private manageActiveClass;
+    destroy(): void;
+}

package/{plugins → dist/types/plugins}/relativeCaption/lg-relative-caption-settings.d.ts

@@ -1,7 +1,7 @@
-export interface RelativeCaptionSettings {
-    /**
-     * Enable/Disable relative captions
-     */
-    relativeCaption: boolean;
-}
-export declare const relativeCaptionSettings: RelativeCaptionSettings;
+export interface RelativeCaptionSettings {
+    /**
+     * Enable/Disable relative captions
+     */
+    relativeCaption: boolean;
+}
+export declare const relativeCaptionSettings: RelativeCaptionSettings;

package/{plugins → dist/types/plugins}/relativeCaption/lg-relative-caption.d.ts

@@ -1,14 +1,14 @@
-/**
- * lightGallery caption for placing captions relative to the image
- */
-import { LightGallery } from '../../lightgallery';
-import { RelativeCaptionSettings } from './lg-relative-caption-settings';
-export default class RelativeCaption {
-    core: LightGallery;
-    settings: RelativeCaptionSettings;
-    constructor(instance: LightGallery);
-    init(): void;
-    private setCaptionStyle;
-    private setRelativeCaption;
-    destroy(): void;
-}
+/**
+ * lightGallery caption for placing captions relative to the image
+ */
+import { LightGallery } from '../../lightgallery';
+import { RelativeCaptionSettings } from './lg-relative-caption-settings';
+export default class RelativeCaption {
+    core: LightGallery;
+    settings: RelativeCaptionSettings;
+    constructor(instance: LightGallery);
+    init(): void;
+    private setCaptionStyle;
+    private setRelativeCaption;
+    destroy(): void;
+}

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

@@ -1,45 +1,47 @@
-export interface RotateStrings {
-    flipVertical: string;
-    flipHorizontal: string;
-    rotateLeft: string;
-    rotateRight: string;
-}
-export interface RotateSettings {
-    /**
-     * Enable/Disable rotate option
-     */
-    rotate: boolean;
-    /**
-     * Rotate speed in milliseconds
-     */
-    rotateSpeed: number;
-    /**
-     * Enable rotate left.
-     */
-    rotateLeft: boolean;
-    /**
-     * Enable rotate right.
-     */
-    rotateRight: boolean;
-    /**
-     * Enable flip horizontal.
-     */
-    flipHorizontal: boolean;
-    /**
-     * Enable flip vertical.
-     */
-    flipVertical: boolean;
-    /**
-     * Custom translation strings for aria-labels
-     */
-    rotatePluginStrings: RotateStrings;
-}
-export declare const rotateSettings: {
-    rotate: boolean;
-    rotateSpeed: number;
-    rotateLeft: boolean;
-    rotateRight: boolean;
-    flipHorizontal: boolean;
-    flipVertical: boolean;
-    rotatePluginStrings: RotateStrings;
-};
+export interface RotateStrings {
+    flipVertical: string;
+    flipHorizontal: string;
+    rotateLeft: string;
+    rotateRight: string;
+}
+export interface RotateSettings {
+    /**
+     * Enable/Disable rotate option
+     */
+    rotate: boolean;
+    /**
+     * Rotate speed in milliseconds
+     */
+    rotateSpeed: number;
+    /**
+     * Enable rotate left.
+     */
+    rotateLeft: boolean;
+    /**
+     * Enable rotate right.
+     */
+    rotateRight: boolean;
+    /**
+     * Enable flip horizontal.
+     */
+    flipHorizontal: boolean;
+    /**
+     * Enable flip vertical.
+     */
+    flipVertical: 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).
+     */
+    rotatePluginStrings?: Partial<RotateStrings>;
+}
+export declare const rotateSettings: {
+    rotate: boolean;
+    rotateSpeed: number;
+    rotateLeft: boolean;
+    rotateRight: boolean;
+    flipHorizontal: boolean;
+    flipVertical: boolean;
+};

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

@@ -1,24 +1,25 @@
-import { LgQuery } from '../../lgQuery';
-import { LightGallery } from '../../lightgallery';
-import { RotateSettings } from './lg-rotate-settings';
-export default class Rotate {
-    core: LightGallery;
-    settings: RotateSettings;
-    rotateValuesList: {
-        [key: string]: any;
-    };
-    private $LG;
-    constructor(instance: LightGallery, $LG: LgQuery);
-    buildTemplates(): void;
-    init(): void;
-    applyStyles(): void;
-    rotateLeft(): void;
-    rotateRight(): void;
-    getCurrentRotation(el: HTMLElement): number;
-    flipHorizontal(): void;
-    flipVertical(): void;
-    triggerEvents(event: string, detail: any): void;
-    isImageOrientationChanged(): boolean;
-    closeGallery(): void;
-    destroy(): void;
-}
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { RotateSettings } from './lg-rotate-settings';
+export default class Rotate {
+    core: LightGallery;
+    settings: RotateSettings;
+    rotateValuesList: {
+        [key: string]: any;
+    };
+    private $LG;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    buildTemplates(): void;
+    init(): void;
+    getFitScale(): number;
+    applyStyles(): void;
+    rotateLeft(): void;
+    rotateRight(): void;
+    getCurrentRotation(el: HTMLElement): number;
+    flipHorizontal(): void;
+    flipVertical(): void;
+    triggerEvents(event: string, detail: any): void;
+    isImageOrientationChanged(): boolean;
+    closeGallery(): void;
+    destroy(): void;
+}

package/{plugins → dist/types/plugins}/share/lg-fb-share-utils.d.ts

@@ -1,2 +1,2 @@
-import { GalleryItem } from '../../lg-utils';
-export declare function getFacebookShareLink(galleryItem: GalleryItem): string;
+import { GalleryItem } from '../../lg-utils';
+export declare function getFacebookShareLink(galleryItem: GalleryItem): string;

package/{plugins → dist/types/plugins}/share/lg-pinterest-share-utils.d.ts

@@ -1,2 +1,2 @@
-import { GalleryItem } from '../../lg-utils';
-export declare function getPinterestShareLink(galleryItem: GalleryItem): string;
+import { GalleryItem } from '../../lg-utils';
+export declare function getPinterestShareLink(galleryItem: GalleryItem): string;

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

@@ -1,57 +1,72 @@
-import { ShareOption } from './types';
-export interface ShareStrings {
-    share: string;
-}
-export interface ShareSettings {
-    /**
-     * Enable/Disable share options
-     */
-    share: boolean;
-    /**
-     * Enable Facebook share.
-     */
-    facebook: boolean;
-    /**
-     * Facebook dropdown text.
-     */
-    facebookDropdownText: string;
-    /**
-     * Enable twitter share.
-     */
-    twitter: boolean;
-    /**
-     * Twitter dropdown text
-     */
-    twitterDropdownText: string;
-    /**
-     * Enable pinterest share.
-     */
-    pinterest: boolean;
-    /**
-     * Pinterest dropdown text
+import { ShareOption } from './types';
+export interface ShareStrings {
+    share: string;
+}
+export interface ShareSettings {
+    /**
+     * Enable/Disable share options
+     */
+    share: boolean;
+    /**
+     * Prefer the OS share sheet (`navigator.share`) over the dropdown menu
+     * when the browser supports it. The share button then opens the native
+     * sheet with the slide's URL (per-item `shareUrl`, falling back to the
+     * network share URLs, then the page URL); the dropdown remains as the
+     * automatic fallback. URL-sharing only, the image file itself is never
+     * attached.
+     * @description Defaults to true on touch devices and false on desktop,
+     * where the branded dropdown is kept for consistency.
+     * See <a href="/docs/web-share/">Web Share</a>.
+     * @version V3.0.0
+     */
+    preferNativeShare?: boolean;
+    /**
+     * Enable Facebook share.
+     */
+    facebook: boolean;
+    /**
+     * Facebook dropdown text.
+     */
+    facebookDropdownText: string;
+    /**
+     * Enable twitter share.
+     */
+    twitter: boolean;
+    /**
+     * Twitter dropdown text
+     */
+    twitterDropdownText: string;
+    /**
+     * Enable pinterest share.
+     */
+    pinterest: boolean;
+    /**
+     * Pinterest dropdown text
 
-     */
-    pinterestDropdownText: string;
-    /**
-     * Array of additional share options
-     *
-     * This can be used to build additional share options.
-     * <a href="/demos/share/">Demo</a>
-     */
-    additionalShareOptions: ShareOption[];
-    /**
-     * Custom translation strings for aria-labels
-     */
-    sharePluginStrings: ShareStrings;
-}
-export declare const shareSettings: {
-    share: boolean;
-    facebook: boolean;
-    facebookDropdownText: string;
-    twitter: boolean;
-    twitterDropdownText: string;
-    pinterest: boolean;
-    pinterestDropdownText: string;
-    additionalShareOptions: never[];
-    sharePluginStrings: ShareStrings;
-};
+     */
+    pinterestDropdownText: string;
+    /**
+     * Array of additional share options
+     *
+     * This can be used to build additional share options.
+     * <a href="/demos/share/">Demo</a>
+     */
+    additionalShareOptions: ShareOption[];
+    /**
+     * 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).
+     */
+    sharePluginStrings?: Partial<ShareStrings>;
+}
+export declare const shareSettings: {
+    share: boolean;
+    facebook: boolean;
+    facebookDropdownText: string;
+    twitter: boolean;
+    twitterDropdownText: string;
+    pinterest: boolean;
+    pinterestDropdownText: string;
+    additionalShareOptions: never[];
+};

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

@@ -0,0 +1,33 @@
+import { ShareSettings } from './lg-share-settings';
+import { LightGallery } from '../../lightgallery';
+export default class Share {
+    core: LightGallery;
+    settings: ShareSettings;
+    private shareOptions;
+    private listening;
+    constructor(instance: LightGallery);
+    init(): void;
+    private getShareListHtml;
+    /**
+     * True when the button should try the OS share sheet first. The
+     * dropdown stays rendered as the automatic fallback (a `canShare`
+     * veto or share failure at click time falls back to the menu).
+     */
+    private prefersNativeShare;
+    setLgShareMarkup(): void;
+    /**
+     * Open state lives on the outer element, which outlives a close, so an
+     * open dropdown would still be open on the next open. While open, the
+     * dropdown dismisses like the More options menu: on a press anywhere
+     * outside it, on Escape (the gallery stays open) and when focus tabs
+     * out of it.
+     */
+    private setDropdownOpen;
+    private listenOutside;
+    private readonly onDocumentPointerDown;
+    private readonly onDocumentKeydown;
+    private onAfterSlide;
+    private getShareListItemHTML;
+    private getDefaultShareOptions;
+    destroy(): void;
+}

package/dist/types/plugins/share/lg-twitter-share-utils.d.ts

@@ -0,0 +1,4 @@
+import { GalleryItem } from '../../lg-utils';
+/** X (formerly Twitter) intent link; the file name is kept for 2.x import
+ * compatibility, `tweetText`/`twitterShareUrl` fields keep working. */
+export declare function getTwitterShareLink(galleryItem: GalleryItem): string;

package/{plugins → dist/types/plugins}/share/types.d.ts

@@ -1,6 +1,6 @@
-import { GalleryItem } from '../../lg-utils';
-export interface ShareOption {
-    selector: string;
-    dropdownHTML: string;
-    generateLink: (galleryItem: GalleryItem) => string;
-}
+import { GalleryItem } from '../../lg-utils';
+export interface ShareOption {
+    selector: string;
+    dropdownHTML: string;
+    generateLink: (galleryItem: GalleryItem) => string;
+}

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

@@ -1,70 +1,85 @@
-interface ThumbnailStrings {
-    toggleThumbnails: string;
-}
-export interface ThumbnailsSettings {
-    /**
-     * Enable thumbnails for the gallery
-     */
-    thumbnail: boolean;
-    animateThumb: boolean;
-    /**
-     * Position of selected thumbnail.
-     */
-    currentPagerPosition: 'left' | 'middle' | 'right';
-    /**
-     * Position of thumbnails when the width of all thumbnails combined is less than the gallery's width.
-     *
-     */
-    alignThumbnails: 'left' | 'middle' | 'right';
-    /**
-     * Width of each thumbnails.
-     */
-    thumbWidth: number;
-    /**
-     * Height of each thumbnails.
-     */
-    thumbHeight: string;
-    /**
-     * Spacing between each thumbnails
-     */
-    thumbMargin: number;
-    /**
-     * control where the thumbnails should be appended.
-     * By default, thumbnails are appended to '.lg-components' which has inbuilt open close transitions
-     * If you don't want initial thumbnails transitions, or want to do more customization,
-     * you can append thumbnails to the lightGalley outer div -
-     * <a href="/demos/thumbnails/#static-thumbnails">Demo</a>
-     */
-    appendThumbnailsTo: '.lg-outer' | '.lg-components';
-    /**
-     * Enable toggle captions and thumbnails.
-     * @description not applicable if allowMediaOverlap is false
-     */
-    toggleThumb: boolean;
-    /**
-     * Enables desktop mouse drag support for thumbnails.
-     */
-    enableThumbDrag: boolean;
-    /**
-     * Enables thumbnail touch/swipe support for touch devices
-     */
-    enableThumbSwipe: boolean;
-    /**
-     * By setting the thumbnailSwipeThreshold (in px) you can set how far the user must swipe for the next/prev slide.
-     */
-    thumbnailSwipeThreshold: number;
-    /**
-     * You can automatically load thumbnails for YouTube videos from YouTube by setting loadYouTubeThumbnail true
-     */
-    loadYouTubeThumbnail: boolean;
-    /**
-     * You can specify the thumbnail size by setting respective number.
-     */
-    youTubeThumbSize: number;
-    /**
-     * Custom translation strings for aria-labels
-     */
-    thumbnailPluginStrings: ThumbnailStrings;
-}
-export declare const thumbnailsSettings: ThumbnailsSettings;
-export {};
+interface ThumbnailStrings {
+    toggleThumbnails: string;
+}
+export interface ThumbnailsSettings {
+    /**
+     * Enable thumbnails for the gallery
+     */
+    thumbnail: boolean;
+    animateThumb: boolean;
+    /**
+     * Position of selected thumbnail.
+     */
+    currentPagerPosition: 'left' | 'middle' | 'right';
+    /**
+     * Position of thumbnails when the width of all thumbnails combined is less than the gallery's width.
+     *
+     */
+    alignThumbnails: 'left' | 'middle' | 'right';
+    /**
+     * Width of each thumbnails.
+     */
+    thumbWidth: number;
+    /**
+     * Height of each thumbnails.
+     */
+    thumbHeight: string;
+    /**
+     * Spacing between each thumbnails
+     */
+    thumbMargin: number;
+    /**
+     * control where the thumbnails should be appended.
+     * By default, thumbnails are appended to '.lg-components' which has inbuilt open close transitions
+     * If you don't want initial thumbnails transitions, or want to do more customization,
+     * you can append thumbnails to the lightGalley outer div -
+     * <a href="/demos/thumbnails/#static-thumbnails">Demo</a>
+     */
+    appendThumbnailsTo: '.lg-outer' | '.lg-components';
+    /**
+     * Enable toggle captions and thumbnails.
+     * @description not applicable if allowMediaOverlap is false
+     */
+    toggleThumb: boolean;
+    /**
+     * Enables desktop mouse drag support for thumbnails.
+     */
+    enableThumbDrag: boolean;
+    /**
+     * Enables thumbnail touch/swipe support for touch devices
+     */
+    enableThumbSwipe: boolean;
+    /**
+     * By setting the thumbnailSwipeThreshold (in px) you can set how far the user must swipe for the next/prev slide.
+     */
+    thumbnailSwipeThreshold: number;
+    /**
+     * Scrub the gallery with the thumbnail strip: while the strip is
+     * dragged (or gliding after a fling), the slide under the strip's
+     * travel position becomes current immediately, without slide
+     * transitions, the strip works like a scrubber instead of an
+     * independent scroll area. The full strip travel spans the whole
+     * gallery, so the first and last slides are always reachable.
+     * Requires `animateThumb`; taps still navigate normally.
+     * See <a href="/docs/thumbnail-scrubbing/">Thumbnail scrubbing</a>.
+     * @version V3.0.0
+     */
+    scrubThumbnails: boolean;
+    /**
+     * You can automatically load thumbnails for YouTube videos from YouTube by setting loadYouTubeThumbnail true
+     */
+    loadYouTubeThumbnail: boolean;
+    /**
+     * You can specify the thumbnail size by setting respective number.
+     */
+    youTubeThumbSize: number;
+    /**
+     * 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).
+     */
+    thumbnailPluginStrings?: Partial<ThumbnailStrings>;
+}
+export declare const thumbnailsSettings: ThumbnailsSettings;
+export {};

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

@@ -0,0 +1,88 @@
+import { LgQuery } from '../../lgQuery';
+import { LightGallery } from '../../lightgallery';
+import { GalleryItem } from '../../lg-utils';
+interface ThumbDragUtils {
+    cords: {
+        startX: number;
+        endX: number;
+    };
+    isMoved: boolean;
+    newTranslateX: number;
+    startTime: Date;
+    endTime: Date;
+    touchMoveTime: number;
+}
+interface ThumbnailGalleryItem extends GalleryItem {
+    thumb: string;
+}
+export default class Thumbnail {
+    private core;
+    private $thumbOuter;
+    private $lgThumb;
+    private thumbOuterWidth;
+    private thumbTotalWidth;
+    private translateX;
+    private thumbClickable;
+    private instantThumb;
+    private dragSamples;
+    private liveTranslateX;
+    private cancelThumbSpring?;
+    private renderedThumbWindow?;
+    private scrubActive;
+    private scrubIndex;
+    private scrubSavedSpeed?;
+    private settings;
+    private $LG;
+    constructor(instance: LightGallery, $LG: LgQuery);
+    init(): void;
+    build(): void;
+    setThumbMarkup(): void;
+    enableThumbDrag(): void;
+    enableThumbSwipe(): void;
+    rebuildThumbnails(): void;
+    setTranslate(value: number): void;
+    private isRtl;
+    getPossibleTransformX(left: number): number;
+    animateThumb(index: number): void;
+    private canScrub;
+    /**
+     * A scrub session starts on the first actual strip movement and
+     * ends when the release glide settles (or the plugin dies). While
+     * it runs: slide transitions are visually off (`lg-thumb-scrubbing`
+     * CSS), the core's transition timers collapse (`speed` 0) so the
+     * landed slide's content loads without the navigation lag, and the
+     * strip's own slide-change re-centering stands down.
+     */
+    private beginScrub;
+    private endScrub;
+    /** Live translate → slide, on drag frames and glide frames alike. */
+    private scrubTo;
+    /**
+     * Drag-start seam (plan 010 physics): a press mid-glide takes over
+     * from the live position, and the velocity window restarts.
+     */
+    private onThumbDragStart;
+    onThumbTouchMove(thumbDragUtils: ThumbDragUtils): ThumbDragUtils;
+    onThumbTouchEnd(thumbDragUtils: ThumbDragUtils): ThumbDragUtils;
+    getThumbHtml(thumb: string, index: number, alt?: string): HTMLElement;
+    /**
+     * True when the strip renders only a window of thumbs
+     * (virtualization.thumbs, plan 010).
+     */
+    private isThumbWindowed;
+    /**
+     * (Re)build the strip contents. Classic mode appends every thumb once;
+     * windowed mode renders the visible range plus overscan with spacers
+     * preserving the strip geometry, and re-runs at commit points only
+     * (open, slide change, drag release, resize, updateSlides), never per
+     * pointer move.
+     */
+    private renderThumbItems;
+    setThumbItemHtml(items: ThumbnailGalleryItem[]): void;
+    setAnimateThumbStyles(): void;
+    manageActiveClassOnSlideChange(): void;
+    toggleThumbBar(): void;
+    thumbKeyPress(): void;
+    destroy(): void;
+}
+export {};