jQuery 强大丰富的响应式弹出框插件 fancyBox3
fancyBox3 是一款优秀的弹出框Jquery插件,之前使用过很多 LightBOX 弹窗插件,功能都很强大,fancyBox3 相对来说,不论是设计和功能上都更胜一筹,所以萨龙网络所有主题需要弹出框的都有添加 fancyBox3 插件。
依赖
jQuery 3+ 是首选,但 fancyBox3 同样适用于jQuery 1.9.1+ 和 jQuery 2+。
兼容性
fancyBox3 包含对触摸手势的支持,甚至支持缩放手势,非常适合移动和桌面浏览器。
fancyBox3 已经在以下浏览器/设备上测试过:
- Chrome
- Firefox
- IE10/11
- Edge
- iOS Safari
- Nexus 7 Chrome
设置
可以通过链接.css
和.js
文件安装 fancyBox3 到html文件中,确保加载了 jQuery 库。以下是一个基本的HTML模板用作示例:
- <!DOCTYPE html>
- <html>
- <head>
- <meta charset="utf-8">
- <title>My page</title>
- <!-- CSS -->
- <link rel="stylesheet" type="text/css" href="jquery.fancybox.min.css">
- </head>
- <body>
- <!-- Your HTML content goes here -->
- <!-- JS -->
- <script src="//code.jquery.com/jquery-3.2.1.min.js"></script>
- <script src="jquery.fancybox.min.js"></script>
- </body>
- </html>
下载 fancyBox3
在 GitHub 上下载最新的 fancyBox3。
或者直接链接到cdnjs上的fancybox文件 - https://cdnjs.com/libraries/fancybox
包安装
fancyBox3 也可在npm和Bower上使用。
- # NPM
- npm install @fancyapps/fancybox --save
- # Bower
- bower install fancybox --save
注意
- 确保在 fancyBox3 JS文件之前添加了jQuery库
- 如果您的页面上已经有jQuery,则不应再次加载
- 不要同时包含 fancybox.js 和 fancybox.min.js 文件
- 当在浏览器上直接打开本地文件时,某些功能(ajax,iframe等)不起作用,代码必须在Web服务器上运行
如何使用
用数据属性初始化
使用fancyBox3 最基本的方法是通过添加 data-fancybox
属性到元素中。这会自动绑定并启动fancyBox3 的点击事件。使用href
或 data-src
属性来指定内容的来源。例:
- <a href="image.jpg" data-fancybox data-caption="Caption for single image">
- <img src="thumbnail.jpg" alt="" />
- </a>
如果有一组项目,则可使用data-fancybox
为每个项目使用相同的属性值来创建一个画廊,每个组都应该有一个独特的价值。例:
- <a href="image_1.jpg" data-fancybox="gallery" data-caption="Caption #1">
- <img src="thumbnail_1.jpg" alt="" />
- </a>
- <a href="image_2.jpg" data-fancybox="gallery" data-caption="Caption #2">
- <img src="thumbnail_2.jpg" alt="" />
- </a>
如果选择此方法,将应用默认设置。有关如何通过更改默认值或使用属性来定制示例的信息,请参阅 选项一节 data-options
有时有多个链接指向相同的来源,并在画廊中创建重复。为了避免这种情况,只需使用 data-trigger
属性中用于data-fancybox
其他链接的相同值的属性即可。可选地,使用 data-index
attribute来指定起始元素的索引:
- <a data-trigger="gallery" href="javascript:;">
- <img src="thumbnail_1.jpg" alt="" />
- </a>
使用JavaScript进行初始化
用jQuery选择器选择你的元素(你可以使用任何有效的选择器)并调用该 fancybox
方法:
- $('[data-fancybox="gallery"]').fancybox({
- // Options will go here
- });
在CodePen上查看演示
有时可能需要将fancybox绑定到动态添加的元素。使用 selector
选项为现在或将来存在的元素附加点击事件侦听器。例:
- $().fancybox({
- selector : '[data-fancybox="gallery"]',
- loop : true
- });
请记住,所选项目不会自动分组到图库中。您可以通过对data-fancybox
属性使用相同的值来创建一个或多个组 ,类似于上一节中的示例。
使用Javascript
您也可以编程方式打开并关闭fancybox。以下是一些示例,请访问 API部分获取更多信息和演示。
显示简单信息:
- $.fancybox.open('<div class="message"><h2>Hello!</h2><p>You are awesome!</p></div>');
在CodePen上查看演示
显示iframed页面:
- $s.fancybox.open({
- src : 'link-to-your-page.html',
- type : 'iframe',
- opts : {
- afterShow : function( instance, current ) {
- console.info( 'done!' );
- }
- }
- });
fancybox尝试根据给定的URL自动检测内容的类型。如果无法检测到,则也可以使用data-type
属性(或 type
选项)手动设置类型 。例:
- <a href="images.php?id=123" data-type="image" data-caption="Caption">
- 显示图片
- </a>
媒体类型
图片
使用fancybox的标准方式是使用链接到较大图像的许多缩略图:
- <a href="image.jpg" data-fancybox="images" data-caption="My caption">
- <img src="thumbnail.jpg" alt="" />
- </a>
默认情况下,fancybox会在显示图像之前完全预先载入图像。您可以选择立即显示图像。它将在接收数据时呈现并显示全尺寸图像。要做到这一点,一些属性是必要的:
data-width
- 图像的真实宽度data-height
- 图像的真实高度
- <a href="image.jpg" data-fancybox="images" data-width="2048" data-height="1365">
- <img src="thumbnail.jpg" />
- </a>
您还可以使用这些 width
和 height
属性来控制图像的大小。这可以用来使图像在视网膜显示器上更清晰。例:
- $('[data-fancybox="images"]').fancybox({
- afterLoad : function(instance, current) {
- var pixelRatio = window.devicePixelRatio || 1;
- if ( pixelRatio > 1.5 ) {
- current.width = current.width / pixelRatio;
- current.height = current.height / pixelRatio;
- }
- }
- });
fancybox支持“srcset”,因此它可以根据视口宽度显示不同的图像。您可以使用它来改善移动用户的下载时间,并随着时间的推移节省带宽。例:
- <a href="medium.jpg" data-fancybox="images" data-srcset="large.jpg 1600w, medium.jpg 1200w, small.jpg 640w">
- <img src="thumbnail.jpg" />
- </a>
在CodePen上查看演示
右键单击也可以保护图像免于下载。虽然这不能保护真正确定的用户,但它应该阻止绝大多数人将您的文件撕掉。可选地,将水印放在图像上。
- $('[data-fancybox]').fancybox({
- protect: true
- });
视频
YouTube和Vimeo视频只需提供页面URL即可与fancyBox一起使用。直接链接到MP4视频或使用触发元素显示隐藏的<video>
元素。
使用 data-width
和 data-height
属性来自定义视频尺寸和 data-ratio
宽高比。
- <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 data-width="640" data-height="360" href="video.mp4">
- Direct link to MP4 video
- </a>
- <a data-fancybox href="#myVideo">
- HTML5 video element
- </a>
- <video width="640" height="320" controls id="myVideo" style="display:none;">
- <source src="https://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.mp4" type="video/mp4">
- <source src="https://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.webm" type="video/webm">
- <source src="https://www.html5rocks.com/en/tutorials/video/basics/Chrome_ImF.ogv" type="video/ogg">
- Your browser doesn't support HTML5 video tag.
- </video>
在CodePen上查看演示
通过URL参数控制YouTube和Vimeo视频:
- <a data-fancybox href="https://www.youtube.com/watch?v=_sI_Ps7JSEk&autoplay=1&rel=0&controls=0&showinfo=0">
- YouTube video - hide controls and info
- </a>
- <a data-fancybox href="https://vimeo.com/191947042?color=f00">
- Vimeo video - custom color
- </a>
在CodePen上查看演示
通过JavaScript:
- $('[data-fancybox]').fancybox({
- youtube : {
- controls : 0,
- showinfo : 0
- },
- vimeo : {
- color : 'f00'
- }
- });
内联HTML
对于内联内容,使用唯一标识创建隐藏元素:
- <div style="display: none;" id="hidden-content">
- <h2>Hello</h2>
- <p>You are awesome.</p>
- </div>
然后简单地创建一个链接,该链接的 data-src
属性与您想要打开的元素的ID相匹配(前面有一个散列标记(#);在本例中 #hidden-content
):
- <a data-fancybox data-src="#hidden-content" href="javascript:;">
- Trigger the fancybox
- </a>
该脚本将附加小关闭按钮(如果您尚未禁用 smallBtn:false
),除了居中之外,不会应用任何样式。因此,您可以使用CSS轻松设置自定义尺寸。
AJAX
要通过AJAX加载内容,您需要为data-type="ajax"
链接添加一个 属性:
- <a data-fancybox data-type="ajax" data-src="my_page.com/path/to/ajax/" href="javascript:;">
- AJAX content
- </a>
此外,可以使用该data-filter
属性定义选择器以 仅显示响应的一部分。选择器可以是任何字符串,这是一个有效的jQuery选择器:
- <a data-fancybox data-type="ajax" data-src="my_page.com/path/to/ajax/" data-filter="#two" href="javascript:;">
- AJAX content
- </a>
IFRAME
如果内容可以显示在页面上,并且在iframe中的放置不会被该页面的脚本或安全配置阻止,则可以将其呈现在fancybox中:
- <a data-fancybox data-type="iframe" data-src="http://codepen.io/fancyapps/full/jyEGGG/" href="javascript:;">
- Webpage
- </a>
- <a data-fancybox data-type="iframe" data-src="https://mozilla.github.io/pdf.js/web/viewer.html" href="javascript:;">
- Sample PDF file
- </a>
在CodePen上查看演示
从iframe中访问和控制父窗口中的fancybox:
- // Adjust iframe height according to the contents
- parent.jQuery.fancybox.getInstance().update();
- // Close current fancybox instance
- parent.jQuery.fancybox.getInstance().close();
Iframe尺寸可以通过CSS控制:
- .fancybox-slide--iframe .fancybox-content {
- width : 800px;
- height : 600px;
- max-width : 80%;
- max-height : 80%;
- margin: 0;
- }
如果需要,这些CSS规则可以被JS覆盖。
- $("[data-fancybox]").fancybox({
- iframe : {
- css : {
- width : '600px'
- }
- }
- });
如果您还没有禁用iframe预加载(使用 preload
选项),那么脚本将尝试计算内容尺寸,并将调整iframe的宽度/高度以适应其中的内容。请记住,由于 相同的原产地政策,有一些限制。
此示例将禁用iframe预加载,并将显示iframe旁边的小关闭按钮而不是工具栏:
- $('[data-fancybox]').fancybox({
- toolbar : false,
- smallBtn : true,
- iframe : {
- preload : false
- }
- })