FancyBox3 中文文档

2.1 下载fancyBox

可以在GIthub下载最新的版本。

或者直接引用 cdnjs —cdnjs.com/libraries/f…。

2.2 包管理工具

fancyBox 还可以通多 npm 和 Bower安装。

$('[data-fancybox]').fancybox({
	toolbar  : false,
	smallBtn : true,
	iframe : {
		preload : false
	}
})

5. 嵌入

支持的网站可以展示在 fancyBox 中，只需要提供页面的地址即可：

<a data-fancybox href="https://www.youtube.com/watch?v=_sI_Ps7JSEk">
  YouTube video
</a>

<a data-fancybox href="https://vimeo.com/191947042">
  Vimeo video
</a>

<a data-fancybox href="https://www.google.com/maps/search/Empire+State+Building/">
	Google Map
</a>

<a data-fancybox href="https://www.instagram.com/p/BNXYW8-goPI/?taken-by=jamesrelfdyer" data-caption="<span title=&quot;Edited&quot;>balloon rides at dawn ✨?<br>was such a magical experience floating over napa valley as the golden light hit the hills.<br><a href=&quot;https://www.instagram.com/jamesrelfdyer/&quot;>@jamesrelfdyer</a></span>">
	Instagram photo
</a>

5.1 视频尺寸

通过 CSS 调整视频的显示大小：

.fancybox-slide--video .fancybox-content {
	width  : 800px;
	height : 600px;
	max-width  : 80%;
	max-height : 80%;
}

5.2 视频参数

通过 url 中的参数控制视频

<a data-fancybox href="https://www.youtube.com/watch?v=_sI_Ps7JSEk&amp;autoplay=1&amp;rel=0&amp;controls=0&amp;showinfo=0">
  YouTube video - hide controls and info
</a>

<a data-fancybox href="https://vimeo.com/191947042?color=f00">
  Vimeo video - custom color
</a>

通过 JavaScript 控制视频：

$('[data-fancybox]').fancybox({
	youtube : {
		controls : 0,
		showinfo : 0
	},
	vimeo : {
		color : 'f00'
	}
});

6. 选项

默认选项值快速参考：

var defaults = {

    // 相册循环浏览
    loop : false,

    // 图片周围的margin，如果视口（viewport）宽度小于800px则忽略
    margin : [44, 0],

    // Horizontal space between slides
    gutter : 50,

    // 键盘浏览
    keyboard : true,

    // 是否在屏幕边缘显示箭头
    arrows : true,

    // 是否显示infobar (顶部的counter and arrows)
    infobar : true,

    // 是否显示顶部的toolbar
    toolbar : true,

    // 控制顶部toolbar里显示的图表
  	// 通过`btnTpl`选项的模板创建按钮，并被放置在toolbar(class="fancybox-toolbar"`的元素)中
    buttons : [
        'slideShow',
        'fullScreen',
        'thumbs',
        'share',
        //'download',
        //'zoom',
        'close'
    ],

    // 探测"idle"的时间(秒)
    idleTime : 3,

    // 是否在右上角显示关闭按钮
  	// 如果设置为'auto',遇到内容类型为html,inline,ajax时显示
    // Use template from `btnTpl.smallBtn` for customization
    smallBtn : 'auto',

    // 保护文件，禁止右键下载
    protect : false,

    // Shortcut to make content "modal" - 禁止键盘浏览，隐藏按钮等
    modal : false,

    image : {
      	// 预加载
      	// 需要预定义图片的尺寸
      	// 设置为'auto'，自动在预览图中缩放
        preload : "auto"

    },

    ajax : {

        // 请求 ajax 的配置
        settings : {
          	// 表明请求是从模态框中发起，名字可改
            data : {
                fancybox : true
            }
        }

    },

    iframe : {

        // Iframe 模板
        tpl : '<iframe id="fancybox-frame{rnd}" name="fancybox-frame{rnd}" class="fancybox-iframe" frameborder="0" vspace="0" hspace="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen allowtransparency="true" src=""></iframe>',

        // 预加载
        // 由于同源策略，不能加载跨域数据
        preload : true,

      	// 自定义包裹 iframe 的元素的 CSS 样式
      	// 这样就可以自定义 iframe 的尺寸
        css : {},

        // iframe 标签属性
        attr : {
            scrolling : 'auto'
        }

    },

    // 如果内容类型不能自动检测出来，默认值为'image'
    defaultType : 'image',

    // 打开/关闭动画类型
    // 可用的值:
    //   false            - disable
    //   "zoom"           - zoom images from/to thumbnail
    //   "fade"
    //   "zoom-in-out"
    //
    animationEffect : "zoom",

    // 打开/关闭动画使用的时间，ms
    animationDuration : 500,

    // 图片缩放时是够改变透明度
  	// 如果透明度为'auto'，那么图片和缩略图比例不一致时透明度将会发生改变
    zoomOpacity : "auto",

    // 滑块动画
    //
    // 可用的值:
    //   false            - disable
    //   "fade'
    //   "slide'
    //   "circular'
    //   "tube'
    //   "zoom-in-out'
    //   "rotate'
    //
    transitionEffect : "fade",

    // 动画持续时间，ms
    transitionDuration : 366,

    // 自定义的滑块的 class 值
    slideClass : '',

    // 自定义的布局的 class 值
    baseClass : '',

    // 布局的模板
    baseTpl	:
        '<div class="fancybox-container" role="dialog" tabindex="-1">' +
            '<div class="fancybox-bg"></div>' +
            '<div class="fancybox-inner">' +
                '<div class="fancybox-infobar">' +
                    '<span data-fancybox-index></span>&nbsp;/&nbsp;<span data-fancybox-count></span>' +
                '</div>' +
                '<div class="fancybox-toolbar">{{buttons}}</div>' +
                '<div class="fancybox-navigation">{{arrows}}</div>' +
                '<div class="fancybox-stage"></div>' +
                '<div class="fancybox-caption-wrap"><div class="fancybox-caption"></div></div>' +
            '</div>' +
        '</div>',

    // 加载中时的模板
    spinnerTpl : '<div class="fancybox-loading"></div>',

    // 错误时的模板
    errorTpl : '<div class="fancybox-error"><p>{{ERROR}}<p></div>',

    btnTpl : {

        download : '<a download data-fancybox-download class="fancybox-button fancybox-button--download" title="{{DOWNLOAD}}">' +
                    '<svg viewBox="0 0 40 40">' +
                        '<path d="M20,23 L20,8 L20,23 L13,16 L20,23 L27,16 L20,23 M26,28 L13,28 L27,28 L14,28" />' +
                    '</svg>' +
                '</a>',

        zoom : '<button data-fancybox-zoom class="fancybox-button fancybox-button--zoom" title="{{ZOOM}}">' +
                    '<svg viewBox="0 0 40 40">' +
                        '<path d="M 18,17 m-8,0 a 8,8 0 1,0 16,0 a 8,8 0 1,0 -16,0 M25,23 L31,29 L25,23" />' +
                    '</svg>' +
                '</button>',

        close : '<button data-fancybox-close class="fancybox-button fancybox-button--close" title="{{CLOSE}}">' +
                    '<svg viewBox="0 0 40 40">' +
                        '<path d="M10,10 L30,30 M30,10 L10,30" />' +
                    '</svg>' +
                '</button>',

      	// 如果'smallBtn'没有设置为 false，默认关闭按钮将会被放置在你的 html/inline/ajax 内容中
        smallBtn   : '<button data-fancybox-close class="fancybox-close-small" title="{{CLOSE}}"></button>',

        // 箭头
        arrowLeft : '<button data-fancybox-prev class="fancybox-button fancybox-button--arrow_left" title="{{PREV}}">' +
                        '<svg viewBox="0 0 40 40">' +
                          '<path d="M10,20 L30,20 L10,20 L18,28 L10,20 L18,12 L10,20"></path>' +
                        '</svg>' +
                      '</button>',

        arrowRight : '<button data-fancybox-next class="fancybox-button fancybox-button--arrow_right" title="{{NEXT}}">' +
                      '<svg viewBox="0 0 40 40">' +
                        '<path d="M30,20 L10,20 L30,20 L22,28 L30,20 L22,12 L30,20"></path>' +
                      '</svg>' +
                    '</button>'
    },

    // 模态框放置在哪个节点中
    parentEl : 'body',


    // 焦点处理
    // ==============

    // 打开后焦点在第一个支持焦点的元素上
    autoFocus : false,

    // 关闭后焦点回到 active 的元素上
    backFocus : true,

    // 不让用户焦点放在模态框外的内容中
    trapFocus : true,


    // 模态框配置
    // =======================

    fullScreen : {
        autoStart : false,
    },

    // 设置 `touch: false` 来禁止拖拽/手指滑动
    touch : {
        vertical : true,  // 允许垂直方向拖拽
        momentum : true   // Continue movement after releasing mouse/touch when panning
    },

    // 手动初始化时的 hash 值,
    // 设为 `false` 不改变 hash 
    hash : null,

    // 自定义或者添加媒体类型
    // 例如:
    /*
    media : {
        youtube : {
            params : {
                autoplay : 0
            }
        }
    }
    */
    media : {},

    slideShow : {
        autoStart : false,
        speed     : 4000
    },

    thumbs : {
        autoStart   : false,                  // 打开的时候展示缩略图
        hideOnClose : true,                   // 关闭动画开始时隐藏缩略图轮廓
        parentEl    : '.fancybox-container',  // Container is injected into this element
        axis        : 'y'                     // 垂直 (y) or 水平 (x) 滚动
    },

    // 使用鼠标滚轮来浏览相册
    // 设为 'auto' - 只对图片启用
    wheel : 'auto',

    // 毁掉函数
    //==========

    // 更多信息请查看 API
    // 例如:
    /*
        afterShow: function( instance, current ) {
             console.info( 'Clicked element:' );
             console.info( current.opts.$orig );
        }
    */

    onInit       : $.noop,  // 实例初始化完成

    beforeLoad   : $.noop,  // 侧栏的内容正在被加载
    afterLoad    : $.noop,  // 侧栏的内容加载完成后

    beforeShow   : $.noop,  // 打开动画开始前
    afterShow    : $.noop,  // 内容加载完成，进行动画的时候

    beforeClose  : $.noop,  // 实例准备关闭的时候，返回 false 值取消关闭
    afterClose   : $.noop,  // 实例关闭后

    onActivate   : $.noop,  // 实例激活的时候
    onDeactivate : $.noop,  // 其他实例被激活的时候


    // 交互
    // ===========

    // 使用一下选项自定义用户单击双击等事件
    // 每个选项可以是字符串，或者有返回值的方法
    //
    // 可用的值:
    //   "close"           - close instance
    //   "next"            - move to next gallery item
    //   "nextOrClose"     - move to next gallery item or close if gallery has only one item
    //   "toggleControls"  - show/hide controls
    //   "zoom"            - zoom image (if loaded)
    //   false             - do nothing

    // 内容被点击
    clickContent : function( current, event ) {
        return current.type === 'image' ? 'zoom' : false;
    },

    // 侧边栏被点击
    clickSlide : 'close',

    // 点击模态框外的北京时
    clickOutside : 'close',

    // 同之前的两个一样，只是是双击的时候
    dblclickContent : false,
    dblclickSlide   : false,
    dblclickOutside : false,


    // 移动端事件
    // =============================================

    mobile : {
        idleTime : false,
        margin   : 0,

        clickContent : function( current, event ) {
            return current.type === 'image' ? 'toggleControls' : false;
        },
        clickSlide : function( current, event ) {
            return current.type === 'image' ? 'toggleControls' : 'close';
        },
        dblclickContent : function( current, event ) {
            return current.type === 'image' ? 'zoom' : false;
        },
        dblclickSlide : function( current, event ) {
            return current.type === 'image' ? 'zoom' : false;
        }
    },


    // 国际化
    // ============

    lang : 'en',
    i18n : {
        'en' : {
            CLOSE       : 'Close',
            NEXT        : 'Next',
            PREV        : 'Previous',
            ERROR       : 'The requested content cannot be loaded. <br/> Please try again later.',
            PLAY_START  : 'Start slideshow',
            PLAY_STOP   : 'Pause slideshow',
            FULL_SCREEN : 'Full screen',
            THUMBS      : 'Thumbnails',
            DOWNLOAD    : 'Download',
            SHARE       : 'Share',
            ZOOM        : 'Zoom'
        },
        'de' : {
            CLOSE       : 'Schliessen',
            NEXT        : 'Weiter',
            PREV        : 'Zurück',
            ERROR       : 'Die angeforderten Daten konnten nicht geladen werden. <br/> Bitte versuchen Sie es später nochmal.',
            PLAY_START  : 'Diaschau starten',
            PLAY_STOP   : 'Diaschau beenden',
            FULL_SCREEN : 'Vollbild',
            THUMBS      : 'Vorschaubilder',
            DOWNLOAD    : 'Herunterladen',
            SHARE       : 'Teilen',
            ZOOM        : 'Maßstab'
        }
    }

};

通过传入 fancybox 方法一个对象来设置一个实例：

$("[data-fancybox]").fancybox({
	thumbs : {
		autoStart : true
	}
});

可以通过 $.fancybox.defaults 命名空间修改 fancyBox 的默认选项：

$.fancybox.defaults.animationEffect = "fade";

对于单独的元素可以通过 data-options 属性进行自定义。这个属性值要求JSON格式的对象：

<a data-fancybox data-options='{"caption" : "My caption", "src" : "https://codepen.io/about/", "type" : "iframe"}' href="javascript:;" class="btn">
	Open external page
</a>

7. API

API 提供了一系列的方法来控制 fancyBox。这些方法帮助你扩展插件，整合到其他的 web 应用中。

7.1 核心方法

操作实例的核心方法：

// 只关闭当前 active 状态或者所有的 fancyBox 实例
$.fancybox.close( true );

// 打开 fancyBox
$.fancybox.open( items, opts, index );

通过 jQuery 将相册中的元素变为 jQuery 对象或者包含纯对象的数组，进行更多操作如创建定义点击事件。

var $links = $('.fancybox');

$links.on('click', function() {

	$.fancybox.open( $links, {
		// 自定义内容
	}, $links.index( this ) );

	return false;
});

手动创建一组对象时，组内元素应该遵循以下规则：

{
  	src  : '' // 资源
	type : '' // 类型: image|inline|ajax|iframe|html (optional)
	opts : {} // 选项 (optional)
}

下面是一个通过 JavaScrip t打开相册的例子：

$.fancybox.open([
	{
		src  : '1_b.jpg',
		opts : {
			caption : 'First caption'
		}
	},
	{
		src  : '2_b.jpg',
		opts : {
			caption : 'Second caption'
		}
	}
], {
	loop : false
});

fancyBox 允许只传一个对象。打开行内元素的例子：

$.fancybox.open({
	src  : '#hidden-content',
	type : 'inline',
	opts : {
		afterShow : function( instance, current ) {
			console.info( 'done!' );
		}
	}
});
// 译者注：行内元素如下
<div id="#hidden-content">
  <p>...content</p>
</div>

7.2 实例的方法

你需要定义一个实例来使用实例的方法。

var instance = $.fancybox.open(
	// 内容和选项
);

从当前 active 的实例中获取信息：

var instance = $.fancybox.getInstance();

回调函数的第一个参数返回实例信息：

$("[data-fancybox]").fancybox({
	afterShow : function( instance, current ) {
		console.info( instance );
	}
});

实例可以调用以下方法：

// 跳到下一个相册元素
instance.next( duration );

//跳到上一个相册元素
instance.previous( duration );

// 调到选中的相册元素
instance.jumpTo( index, duration );

// 检测当前尺寸是否小于实际尺寸
instance.isScaledDown();

// 缩放到实际尺寸
instance.scaleToActual( x, y, duration );

// 检测尺寸是否超过父元素
instance.canPan();

// 缩放适应父元素尺寸
instance.scaleToFit( duration );

// 更新滑块的内容和位置
instance.update();

// 更新侧边栏的位置， 缩放内容来适应
instance.updateSlide( slide );

// 更新 infobar 的值， 导航按钮的状态， 和展示标题
instance.updateControls( force );

// 在侧边栏中加载自定义内容
instance.setContent( slide, content );

// 在侧边栏中加载loading效果
instance.showLoading( slide );

// 从侧边栏中去除loading效果
instance.hideLoading( slide );

// 找到和把焦点放在第一个可以放置焦点的元素
instance.focus();

// 激活当前 active 的实例，显示在最前面
instance.activate();

// 关闭实例
instance.close();

7.3 事件

fancyBox 支持触发以下事件：

beforeLoad   : 滑块的内容加载前
afterLoad    : 滑块内容加载后

beforeShow   : 打开动画开始前
afterShow    : 内容或者动画加载完成

beforeClose  : 实例准备关闭前，染回`false`取消关闭
afterClose   : 实例关闭后

onInit       : 实例初始化完成
onActivate   : 实例active状态
onDeactivate : 其他实例变为active状态

事件可以作为一个对象的函数属性，该对象作为参数传入到 fancyBox 初始化方法中：

<script type="text/javascript">
	$("[data-fancybox]").fancybox({
		afterShow: function( instance, slide ) {

			// Tip: Each event passes useful information within the event object:

			// Object containing references to interface elements
			// (background, buttons, caption, etc)
			// console.info( instance.$refs );

			// Current slide options
			// console.info( slide.opts );

			// Clicked element
			// console.info( slide.opts.$orig );

			// Reference to DOM element of the slide
			// console.info( slide.$slide );

		}
	});
</script>

$(document).on('afterShow.fb', function( e, instance, slide ) {
	// Your code goes here
});

beforeClose : function( instance, current, e ) {
	if ( $('#my-field').val() == '' ) {
		return false;
	}
}

// 自定义、添加新的媒体类型
// 例如:
/*
media : {
	youtube : {
		params : {
			autoplay : 0
		}
	}
}
*/
media : {},

slideShow : {
	autoStart : false,
	speed     : 4000
},

thumbs : {
	autoStart   : false,                  // 打开时显示缩略图
	hideOnClose : true,                   // Hide thumbnail grid when closing animation starts
	parentEl    : '.fancybox-container',  // Container is injected into this element
	axis        : 'y'                     // Vertical (y) or horizontal (x) scrolling
}

Example (show thumbnails on start):

$('[data-fancybox="images"]').fancybox({
	thumbs : {
		autoStart : true
	}
})

$.fancybox.getInstance().Thumbs.$grid

$.fancybox.getInstance().Thumbs.toggle();

可使用的方法列表：

Thumbs.focus()
Thumbs.update();
Thumbs.hide();
Thumbs.show();
Thumbs.toggle();

FullScreen.request( elem );
FullScreen.exit();
FullScreen.toggle( elem );
FullScreen.isFullscreen();
FullScreen.enabled();

SlideShow.start();
SlideShow.stop();
SlideShow.toggle();

如果你想禁止 hash 模块，使用下面代码片段（引用 JS 之后）：