lightgallery 2.9.0 → 3.0.0-beta.2

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

@@ -1,71 +1,94 @@
-import { PlayerParams } from './lg-video-utils';
-export interface VideoSettings {
-    /**
-     * Enable/DIsable first video autoplay.
-     * @description Autoplay has to be managed using this setting.
-     * Autoplay in PlayerParams doesn't have any effect.
-     */
-    autoplayFirstVideo: boolean;
-    /**
-     * Change YouTube player parameters.
-     * You can find the list of YouTube player parameters from the following link
-     * <a href="https://developers.google.com/youtube/player_parameters">YouTube player parameters</a>
-     * @example
-     * lightGallery(document.getElementById('lightGallery'), {
-     *     youTubePlayerParams: {
-     *         modestbranding : 1,
-     *         showinfo : 0,
-     *         controls : 0
-     *     }
-     * })
-     */
-    youTubePlayerParams: any;
-    /**
-     * Change Vimeo player parameters.
-     * You can find the list of vimeo player parameters from the following link
-     * <a href="https://developer.vimeo.com/player/embedding#universal-parameters">Vimeo player parameters</a>
-     * @example
-     * lightGallery(document.getElementById('lightGallery'), {
-     *     vimeoPlayerParams: {
-     *         byline : 0,
-     *         portrait : 0,
-     *         color : 'CCCCCC'
-     *     }
-     * })
-     */
-    vimeoPlayerParams: PlayerParams;
-    /**
-     * Change Wistia player parameters.
-     * You can find the list of Wistia player parameters from the following link
-     * <a href="https://wistia.com/support/developers/embed-options#using-embed-options">Vimeo player parameters</a>
-     */
-    wistiaPlayerParams: any;
-    /**
-     * Go to next slide when video is ended
-     * Note - this doesn't work with YouTube videos at the moment
-     */
-    gotoNextSlideOnVideoEnd: boolean;
-    /**
-     * Autoplay video on slide change
-     * @description Make sure you set preload:"none"
-     */
-    autoplayVideoOnSlide: boolean;
-    /**
-     * Enbale videojs custom video player
-     * <div class="alert alert-info" role="alert">
-     *     <b>Dependency</b> - You need to include <a href="https://videojs.com/">videoJs</a> on your document to enable videojs player
-     * </div>
-     */
-    videojs: boolean;
-    /**
-     * Class name of the videojs theme
-     * You need to include the theme stylesheet on your document. <a href="https://videojs.com/getting-started/#home-page-themes" target="_blank">More info</a>
-     * @version V2.5.0
-     */
-    videojsTheme: string;
-    /**
-     * Videojs player options
-     */
-    videojsOptions: any;
-}
-export declare const videoSettings: VideoSettings;
+import { PlayerParams } from '@lightgallery/headless';
+export interface VideoSettings {
+    /**
+     * Enable/DIsable first video autoplay.
+     * @description Autoplay has to be managed using this setting.
+     * Autoplay in PlayerParams doesn't have any effect.
+     */
+    autoplayFirstVideo: boolean;
+    /**
+     * Render provider video slides (YouTube/Vimeo/Wistia) as lite facades:
+     * a poster with a play button, with the provider iframe created only
+     * when the user presses play.
+     * @description The facade poster falls back from the item poster to
+     * the YouTube thumbnail endpoint (see loadYouTubePoster) to the item
+     * thumb; a slide with no resolvable poster keeps the previous
+     * eager-iframe behavior. Note autoplayFirstVideo/autoplayVideoOnSlide
+     * force an immediate materialize by design. Set false for 2.x
+     * eager-iframe behavior on all provider slides.
+     * See <a href="/docs/video-facades/">Video facades</a>.
+     * @version V3.0.0
+     */
+    videoFacade: boolean;
+    /**
+     * Embed YouTube videos through the privacy-enhanced
+     * youtube-nocookie.com host.
+     * @description Set false to embed through youtube.com instead. Slide
+     * URLs that already point at youtube-nocookie.com always keep it.
+     * See <a href="/docs/video-facades/">Video facades</a>.
+     * @version V3.0.0
+     */
+    youTubeNoCookie: boolean;
+    /**
+     * Change YouTube player parameters.
+     * You can find the list of YouTube player parameters from the following link
+     * <a href="https://developers.google.com/youtube/player_parameters">YouTube player parameters</a>
+     * @example
+     * lightGallery(document.getElementById('lightGallery'), {
+     *     youTubePlayerParams: {
+     *         modestbranding : 1,
+     *         showinfo : 0,
+     *         controls : 0
+     *     }
+     * })
+     */
+    youTubePlayerParams: any;
+    /**
+     * Change Vimeo player parameters.
+     * You can find the list of vimeo player parameters from the following link
+     * <a href="https://developer.vimeo.com/player/embedding#universal-parameters">Vimeo player parameters</a>
+     * @example
+     * lightGallery(document.getElementById('lightGallery'), {
+     *     vimeoPlayerParams: {
+     *         byline : 0,
+     *         portrait : 0,
+     *         color : 'CCCCCC'
+     *     }
+     * })
+     */
+    vimeoPlayerParams: PlayerParams;
+    /**
+     * Change Wistia player parameters.
+     * You can find the list of Wistia player parameters from the following link
+     * <a href="https://wistia.com/support/developers/embed-options#using-embed-options">Vimeo player parameters</a>
+     */
+    wistiaPlayerParams: any;
+    /**
+     * Go to next slide when video is ended
+     * Note - this doesn't work with YouTube videos at the moment
+     */
+    gotoNextSlideOnVideoEnd: boolean;
+    /**
+     * Autoplay video on slide change
+     * @description Make sure you set preload:"none"
+     */
+    autoplayVideoOnSlide: boolean;
+    /**
+     * Enbale videojs custom video player
+     * <div class="alert alert-info" role="alert">
+     *     <b>Dependency</b> - You need to include <a href="https://videojs.com/">videoJs</a> on your document to enable videojs player
+     * </div>
+     */
+    videojs: boolean;
+    /**
+     * Class name of the videojs theme
+     * You need to include the theme stylesheet on your document. <a href="https://videojs.com/getting-started/#home-page-themes" target="_blank">More info</a>
+     * @version V2.5.0
+     */
+    videojsTheme: string;
+    /**
+     * Videojs player options
+     */
+    videojsOptions: any;
+}
+export declare const videoSettings: VideoSettings;

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

@@ -1,104 +1,116 @@
-/**
- * Video module for lightGallery
- * Supports HTML5, YouTube, Vimeo, wistia videos
- *
- *
- * @ref Wistia
- * https://wistia.com/support/integrations/wordpress(How to get url)
- * https://wistia.com/support/developers/embed-options#using-embed-options
- * https://wistia.com/support/developers/player-api
- * https://wistia.com/support/developers/construct-an-embed-code
- * http://jsfiddle.net/xvnm7xLm/
- * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video
- * https://wistia.com/support/embed-and-share/sharing-videos
- * https://private-sharing.wistia.com/medias/mwhrulrucj
- *
- * @ref Youtube
- * https://developers.google.com/youtube/player_parameters#enablejsapi
- * https://developers.google.com/youtube/iframe_api_reference
- * https://developer.chrome.com/blog/autoplay/#iframe-delegation
- *
- * @ref Vimeo
- * https://stackoverflow.com/questions/10488943/easy-way-to-get-vimeo-id-from-a-vimeo-url
- * https://vimeo.zendesk.com/hc/en-us/articles/360000121668-Starting-playback-at-a-specific-timecode
- * https://vimeo.zendesk.com/hc/en-us/articles/360001494447-Using-Player-Parameters
- */
-import { LightGallery } from '../../lightgallery';
-import { lgQuery } from '../../lgQuery';
-import { CustomEventAfterSlide, CustomEventHasVideo, CustomEventSlideItemLoad } from '../../types';
-import { VideoSource } from './types';
-declare global {
-    interface Window {
-        _wq: any;
-        Vimeo: any;
-    }
-}
-export default class Video {
-    private core;
-    private settings;
-    constructor(instance: LightGallery);
-    init(): void;
-    /**
-     * @desc Event triggered when a slide is completely loaded
-     *
-     * @param {Event} event - lightGalley custom event
-     */
-    onSlideItemLoad(event: CustomEventSlideItemLoad): void;
-    /**
-     * @desc Event triggered when video url or poster found
-     * Append video HTML is poster is not given
-     * Play if autoplayFirstVideo is true
-     *
-     * @param {Event} event - Javascript Event object.
-     */
-    onHasVideo(event: CustomEventHasVideo): void;
-    /**
-     * @desc fired immediately before each slide transition.
-     * Pause the previous video
-     * Hide the download button if the slide contains YouTube, Vimeo, or Wistia videos.
-     *
-     * @param {Event} event - Javascript Event object.
-     * @param {number} prevIndex - Previous index of the slide.
-     * @param {number} index - Current index of the slide
-     */
-    onBeforeSlide(event: CustomEvent): void;
-    /**
-     * @desc fired immediately after each slide transition.
-     * Play video if autoplayVideoOnSlide option is enabled.
-     *
-     * @param {Event} event - Javascript Event object.
-     * @param {number} prevIndex - Previous index of the slide.
-     * @param {number} index - Current index of the slide
-     * @todo should check on onSlideLoad as well if video is not loaded on after slide
-     */
-    onAfterSlide(event: CustomEventAfterSlide): void;
-    loadAndPlayVideo(index: number): void;
-    /**
-     * Play HTML5, Youtube, Vimeo or Wistia videos in a particular slide.
-     * @param {number} index - Index of the slide
-     */
-    playVideo(index: number): void;
-    /**
-     * Pause HTML5, Youtube, Vimeo or Wistia videos in a particular slide.
-     * @param {number} index - Index of the slide
-     */
-    pauseVideo(index: number): void;
-    getVideoHtml(src: any, addClass: any, index: number, html5Video: VideoSource): string;
-    /**
-     * @desc - Append videos to the slide
-     *
-     * @param {HTMLElement} el - slide element
-     * @param {Object} videoParams - Video parameters, Contains src, class, index, htmlVideo
-     */
-    appendVideos(el: lgQuery, videoParams: {
-        src: string;
-        addClass: string;
-        index: number;
-        html5Video: any;
-    }): any;
-    gotoNextSlideOnVideoEnd(src: any, index: number): void;
-    controlVideo(index: number, action: string): void;
-    loadVideoOnPosterClick($el: lgQuery, forcePlay?: boolean): void;
-    onVideoLoadAfterPosterClick($el: lgQuery, index: number): void;
-    destroy(): void;
-}
+/**
+ * Video module for lightGallery
+ * Supports HTML5, YouTube, Vimeo, wistia videos
+ *
+ *
+ * @ref Wistia
+ * https://wistia.com/support/integrations/wordpress(How to get url)
+ * https://wistia.com/support/developers/embed-options#using-embed-options
+ * https://wistia.com/support/developers/player-api
+ * https://wistia.com/support/developers/construct-an-embed-code
+ * http://jsfiddle.net/xvnm7xLm/
+ * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video
+ * https://wistia.com/support/embed-and-share/sharing-videos
+ * https://private-sharing.wistia.com/medias/mwhrulrucj
+ *
+ * @ref Youtube
+ * https://developers.google.com/youtube/player_parameters#enablejsapi
+ * https://developers.google.com/youtube/iframe_api_reference
+ * https://developer.chrome.com/blog/autoplay/#iframe-delegation
+ *
+ * @ref Vimeo
+ * https://stackoverflow.com/questions/10488943/easy-way-to-get-vimeo-id-from-a-vimeo-url
+ * https://vimeo.zendesk.com/hc/en-us/articles/360000121668-Starting-playback-at-a-specific-timecode
+ * https://vimeo.zendesk.com/hc/en-us/articles/360001494447-Using-Player-Parameters
+ */
+import { LightGallery } from '../../lightgallery';
+import { lgQuery } from '../../lgQuery';
+import { CustomEventAfterSlide, CustomEventHasVideo, CustomEventSlideItemLoad } from '../../types';
+import { VideoSource } from './types';
+declare global {
+    interface Window {
+        _wq: any;
+        Vimeo: any;
+        Wistia: any;
+    }
+}
+export default class Video {
+    private core;
+    private settings;
+    constructor(instance: LightGallery);
+    init(): void;
+    /**
+     * @desc Event triggered when a slide is completely loaded
+     *
+     * @param {Event} event - lightGalley custom event
+     */
+    onSlideItemLoad(event: CustomEventSlideItemLoad): void;
+    /**
+     * @desc Event triggered when video url or poster found
+     * Append video HTML is poster is not given
+     * Play if autoplayFirstVideo is true
+     *
+     * @param {Event} event - Javascript Event object.
+     */
+    onHasVideo(event: CustomEventHasVideo): void;
+    /**
+     * @desc fired immediately before each slide transition.
+     * Pause the previous video
+     * Hide the download button if the slide contains YouTube, Vimeo, or Wistia videos.
+     *
+     * @param {Event} event - Javascript Event object.
+     * @param {number} prevIndex - Previous index of the slide.
+     * @param {number} index - Current index of the slide
+     */
+    onBeforeSlide(event: CustomEvent): void;
+    /**
+     * @desc fired immediately after each slide transition.
+     * Play video if autoplayVideoOnSlide option is enabled.
+     *
+     * @param {Event} event - Javascript Event object.
+     * @param {number} prevIndex - Previous index of the slide.
+     * @param {number} index - Current index of the slide
+     * @todo should check on onSlideLoad as well if video is not loaded on after slide
+     */
+    onAfterSlide(event: CustomEventAfterSlide): void;
+    loadAndPlayVideo(index: number): void;
+    /**
+     * Play HTML5, Youtube, Vimeo or Wistia videos in a particular slide.
+     * @param {number} index - Index of the slide
+     */
+    playVideo(index: number): void;
+    /**
+     * Pause HTML5, Youtube, Vimeo or Wistia videos in a particular slide.
+     * @param {number} index - Index of the slide
+     */
+    pauseVideo(index: number): void;
+    getVideoHtml(src: any, addClass: any, index: number, html5Video: VideoSource): string;
+    /**
+     * @desc - Append videos to the slide
+     *
+     * @param {HTMLElement} el - slide element
+     * @param {Object} videoParams - Video parameters, Contains src, class, index, htmlVideo
+     */
+    appendVideos(el: lgQuery, videoParams: {
+        src: string;
+        addClass: string;
+        index: number;
+        html5Video: any;
+    }): any;
+    gotoNextSlideOnVideoEnd(src: any, index: number): void;
+    /**
+     * Run a callback with the Vimeo player API available, loading
+     * player.js on demand at first use (lite-embed: no provider script
+     * before user intent). Errors keep the 2.x console message.
+     */
+    private withVimeoApi;
+    /**
+     * Queue a Wistia command and load E-v1.js on demand, `_wq` is
+     * Wistia's own pre-load command queue, drained when the script lands.
+     */
+    private pushWistiaCommand;
+    controlVideo(index: number, action: string): void;
+    loadVideoOnPosterClick($el: lgQuery, forcePlay?: boolean): void;
+    onVideoLoadAfterPosterClick($el: lgQuery, index: number): void;
+    destroy(): void;
+}

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

@@ -1,8 +1,8 @@
-export interface VideoSource {
-    source: {
-        src: string;
-        type: string;
-    }[];
-    tracks: HTMLTrackElement[];
-    attributes: HTMLVideoElement;
-}
+export interface VideoSource {
+    source: {
+        src: string;
+        type: string;
+    }[];
+    tracks: HTMLTrackElement[];
+    attributes: HTMLVideoElement;
+}

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

@@ -1,11 +1,11 @@
-export interface VimeoThumbnailSettings {
-    /**
-     * Auto load thumbnails for Vimeo videos
-     */
-    showVimeoThumbnails: boolean;
-    /**
-     * Show thumbnails with play button
-     */
-    showThumbnailWithPlayButton: boolean;
-}
-export declare const vimeoSettings: VimeoThumbnailSettings;
+export interface VimeoThumbnailSettings {
+    /**
+     * Auto load thumbnails for Vimeo videos
+     */
+    showVimeoThumbnails: boolean;
+    /**
+     * Show thumbnails with play button
+     */
+    showThumbnailWithPlayButton: boolean;
+}
+export declare const vimeoSettings: VimeoThumbnailSettings;

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

@@ -1,14 +1,14 @@
-import { LightGallery } from '../../lightgallery';
-import { VimeoThumbnailSettings } from './lg-vimeo-thumbnail-settings';
-/**
- * Creates the vimeo thumbnails plugin.
- * @param {object} element - lightGallery element
- */
-export default class VimeoThumbnail {
-    core: LightGallery;
-    settings: VimeoThumbnailSettings;
-    constructor(instance: LightGallery);
-    init(): void;
-    setVimeoThumbnails(dynamicGallery: LightGallery): Promise<void>;
-    destroy(): void;
-}
+import { LightGallery } from '../../lightgallery';
+import { VimeoThumbnailSettings } from './lg-vimeo-thumbnail-settings';
+/**
+ * Creates the vimeo thumbnails plugin.
+ * @param {object} element - lightGallery element
+ */
+export default class VimeoThumbnail {
+    core: LightGallery;
+    settings: VimeoThumbnailSettings;
+    constructor(instance: LightGallery);
+    init(): void;
+    setVimeoThumbnails(dynamicGallery: LightGallery): Promise<void>;
+    destroy(): void;
+}

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

@@ -1,51 +1,54 @@
-export interface ActualSizeIcons {
-    zoomIn: 'lg-zoom-in' | 'lg-actual-size';
-    zoomOut: 'lg-zoom-out' | 'lg-actual-size';
-}
-export interface ZoomStrings {
-    zoomIn: string;
-    zoomOut: string;
-    viewActualSize: string;
-}
-export interface ZoomSettings {
-    /**
-     * Value of zoom should be incremented/decremented
-     */
-    scale: number;
-    /**
-     * Enable/Disable zoom option
-     */
-    zoom: boolean;
-    /**
-     * Enable/Disable infinite zoom
-     * @description If you set this to true, you can zoom in more than the original size of the image.
-     */
-    infiniteZoom: boolean;
-    /**
-     * Enable actual size icon.
-     */
-    actualSize: boolean;
-    /**
-     * Once the slide transition is completed, how much time should take zoom plugin to activate
-     * @description Some css styles will be added to the images if zoom is enabled.
-     * So it might conflict if you add any custom styles to the images such as the initial transition while opening the gallery.
-     * So you can delay adding zoom related styles to the images by changing the value of enableZoomAfter.
-     */
-    enableZoomAfter: number;
-    /**
-     * Show zoom in, zoom out icons
-     */
-    showZoomInOutIcons: boolean;
-    /**
-     * Actual size icons classnames.
-     * Specify classnames for both ZoomIn and ZoomOut states
-     * You can use `actualSizeIcons: { zoomIn: 'lg-actual-size', zoomOut: 'lg-zoom-out' }`
-     * to show actual size icons instead of zoom in and zoom out icons.
-     */
-    actualSizeIcons: ActualSizeIcons;
-    /**
-     * Custom translation strings for aria-labels
-     */
-    zoomPluginStrings: ZoomStrings;
-}
-export declare const zoomSettings: ZoomSettings;
+export interface ActualSizeIcons {
+    zoomIn: 'lg-zoom-in' | 'lg-actual-size';
+    zoomOut: 'lg-zoom-out' | 'lg-actual-size';
+}
+export interface ZoomStrings {
+    zoomIn: string;
+    zoomOut: string;
+    viewActualSize: string;
+}
+export interface ZoomSettings {
+    /**
+     * Value of zoom should be incremented/decremented
+     */
+    scale: number;
+    /**
+     * Enable/Disable zoom option
+     */
+    zoom: boolean;
+    /**
+     * Enable/Disable infinite zoom
+     * @description If you set this to true, you can zoom in more than the original size of the image.
+     */
+    infiniteZoom: boolean;
+    /**
+     * Enable actual size icon.
+     */
+    actualSize: boolean;
+    /**
+     * Once the slide transition is completed, how much time should take zoom plugin to activate
+     * @description Some css styles will be added to the images if zoom is enabled.
+     * So it might conflict if you add any custom styles to the images such as the initial transition while opening the gallery.
+     * So you can delay adding zoom related styles to the images by changing the value of enableZoomAfter.
+     */
+    enableZoomAfter: number;
+    /**
+     * Show zoom in, zoom out icons
+     */
+    showZoomInOutIcons: boolean;
+    /**
+     * Actual size icons classnames.
+     * Specify classnames for both ZoomIn and ZoomOut states
+     * You can use `actualSizeIcons: { zoomIn: 'lg-actual-size', zoomOut: 'lg-zoom-out' }`
+     * to show actual size icons instead of zoom in and zoom out icons.
+     */
+    actualSizeIcons: ActualSizeIcons;
+    /**
+     * 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).
+     */
+    zoomPluginStrings?: Partial<ZoomStrings>;
+}
+export declare const zoomSettings: ZoomSettings;