Fancybox 2 не только плагин галерей, но и модальных окон, рассмотрим подробнее.
Сайт разработчика, скачать архив (2.1.7).
Подключение:
Inline
Контент модального окна находится на этой-же странице в срытом
В href ссылки указывается id скрытого блока с контентом.
Размер окна можно указать в процентах:
Кнопку «закрыть» можно заменить своей, добавив параметр closeBtn: false и ссылку с методом $.fancybox.close() .
Также можно отключить закрытие кликом по фону параметром modal: true .
Чтобы текст окна постоянно не висел в коде страницы, можно получать его через AJAX, с отдельного URL.
Контент отдельной страницы
Вызов без ссылки
iFrame
Подходит для форм, т.к. при отправки формы обновиться только iFrame. Но контент окна должен быть со своей HTML разметкой и стилями.
Код страницы в iFrame
Вызов без ссылки
Чтобы закрыть окно своей кнопкой, нужно обращаться к Fancybox через родителя parent .
Ссылки в будут открываться в нём, для перехода в основном окне к ссылке потребуется добавить атрибут target="_top" .
fancyBox is a tool that offers a nice and elegant way to add zooming functionality for images, html content and multi-media on your webpages. It is built on the top of the popular JavaScript framework jQuery and is both easy to implement and a snap to customize.
Instructions
Download the plugin, unzip it, copy files and include fancyBox script and stylesheet in your document (you will need to make sure the css and js files are on your server, and adjust the paths in the script and link tag). Make sure you also load the jQuery library. Example:
Create link elements whose href attributes will contain the path of the element you wish to open within the fancyBox.
Attach fancyBox when the document is loaded. If you are not familiar with jQuery, please, read this tutorial for beginners.
Tips & tricks
A collection of the demos created in response to questions
Examples
You can also go straight into action and open a standalone version of demo and view its source code.
Note: ID’s are single use and are only applied to one element.
Galleries are created from elements who have the same "data-fancybox-group" or "rel" attribute value.
Script uses the `href` or `data-fancybox-href` attribute of the matched elements to obtain the location of the content and to figure out content type you want to display. You can specify type directly by adding classname (fancybox.image, fancybox.iframe, etc) or `data-fancybox-type` attribute. Use `title` or `data-fancybox-title` attribute to specify item caption.
Lorem ipsum dolor sit amet
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
Alternatively, you can set content type as an option: $(".open_ajax").fancybox(); .
Note, ajax requests are subject to the same origin policy. If fancyBox will not be able to get content type, it will try to guess based on ‘href’ and will quit silently if would not succeed (this is different from previous versions where ‘ajax’ was used as default type or an error message was displayed).
Extended functionality
Remember to include the necessary files! Each helper is located in separate files.
- Youtube
- Vimeo
- Metacafe
- Dailymotion
- Twitvid
- Twitpic
- Google maps
- Search results
- Direct link
- Street view
License / Download
fancyBox licensed under Creative Commons Attribution-NonCommercial 3.0 license.
You are free to use fancyBox for your personal or non-profit website projects.
You can get the author’s permission to use fancyBox for commercial websites by paying a fee.
The latest source code is available on GitHub.
Documentation
You can pass these options as key/value object to fancybox() method. It is also possible to modify defaults directly at fancyBox JS file or $.fancybox.defaults
Name | Description |
---|---|
padding | Space inside fancyBox around content. Can be set as array — [top, right, bottom, left]. Integer, Array; Default value: 15 |
margin | Minimum space between viewport and fancyBox. Can be set as array — [top, right, bottom, left]. Right and bottom margins are ignored if content dimensions exceeds viewport Integer, Array; Default value: 20 |
width | Default width for ‘iframe’ and ‘swf’ content. Also for ‘inline’, ‘ajax’ and ‘html’ if ‘autoSize’ is set to ‘false’. Can be numeric or ‘auto’. Number, String; Default value: 800 |
height | Default height for ‘iframe’ and ‘swf’ content. Also for ‘inline’, ‘ajax’ and ‘html’ if ‘autoSize’ is set to ‘false’. Can be numeric or ‘auto’ Number, String; Default value: 600 |
minWidth | Minimum width fancyBox should be allowed to resize to Number; Default value: 100 |
minHeight | Minimum height fancyBox should be allowed to resize to Number; Default value: 100 |
maxWidth | Maximum width fancyBox should be allowed to resize to Number; Default value: 9999 |
maxHeight | Maximum height fancyBox should be allowed to resize to Number; Default value: 9999 |
autoSize | If true, then sets both autoHeight and autoWidth to true Boolean; Default value: true |
autoHeight | If set to true, for ‘inline’, ‘ajax’ and ‘html’ type content height is auto determined. If no dimensions set this may give unexpected results Boolean; Default value: false |
autoWidth | If set to true, for ‘inline’, ‘ajax’ and ‘html’ type content width is auto determined. If no dimensions set this may give unexpected results Boolean; Default value: false |
autoResize | If set to true, the content will be resized after window resize event Boolean; Default value: !isTouch |
autoCenter | If set to true, the content will always be centered Boolean; Default value: !isTouch |
fitToView | If set to true, fancyBox is resized to fit inside viewport before opening Boolean; Default value: true |
aspectRatio | If set to true, resizing is constrained by the original aspect ratio (images always keep ratio; see this example — if you want to change ratio for other media) Boolean; Default value: false |
topRatio | Top space ratio for vertical centering. If set to 0.5, then vertical and bottom space will be equal. If 0 — fancyBox will be at the viewport top Number; Default value: 0.5 |
leftRatio | Left space ratio for horizontal centering. If set to 0.5, then left and right space will be equal. If 0 — fancyBox will be at the viewport left Number; Default value: 0.5 |
scrolling | Set the overflow CSS property to create or hide scrollbars. Can be set to ‘auto’, ‘yes’, ‘no’ or ‘visible’ String; Default value: ‘auto’ |
wrapCSS | Customizable CSS class for wrapping element (useful for custom styling) string; Default value: |
arrows | If set to true, navigation arrows will be displayed Boolean; Default value: true |
closeBtn | If set to true, close button will be displayed Boolean; Default value: true |
closeClick | If set to true, fancyBox will be closed when user clicks the content Boolean; Default value: false |
nextClick | If set to true, will navigate to next gallery item when user clicks the content Boolean; Default value: false |
mouseWheel | If set to true, you will be able to navigate gallery using the mouse wheel Boolean; Default value: true |
autoPlay | If set to true, slideshow will start after opening the first gallery item Boolean; Default value: false |
playSpeed | Slideshow speed in milliseconds Integer; Default value: 3000 |
preload | Number of gallery images to preload Integer; Default value: 3 |
modal | If set to true, will disable navigation and closing Boolean; Default value: false |
loop | If set to true, enables cyclic navigation. This means, if you click "next" after you reach the last element, first element will be displayed (and vice versa). Boolean; Default value: true |
ajax | Options for ajax request Object; Default value: |
iframe | Options for content type "iframe" Object; Default value: |
swf | Options for content type "swf" Object; Default value: |
keys | Define keyboard keys for gallery navigation, closing and slideshow Object; Default value: |
direction | Default navigation direction (for navigation arrows, too) Object; Default value: |
scrollOutside | If true, the script will try to avoid horizontal scrolling for iframes and html content Boolean; Default value: true |
index | Overrides group start index Integer; Default value: 0 |
type | Overrides type for content. Supported types are ‘image’, ‘inline’, ‘ajax’, ‘iframe’, ‘swf’ and ‘html’ String; Default value: null |
href | Overrides content source link String; Default value: null |
content | Overrides content to be displayed String; Default value: null |
title | Overrides title content, accepts any HTML String; Default value: null |
tpl | Object containing various templates Object; Default value: |
openEffect / closeEffect / nextEffect / prevEffect | Animation effect (‘elastic’, ‘fade’ or ‘none’) for each transition type String; Default value: ‘fade’, ‘fade’, ‘elastic’, ‘elastic’ |
openSpeed / closeSpeed / nextSpeed / prevSpeed | The time it takes (in ms, or "slow", "normal", "fast") to complete transition Integer; Default value: 250 |
openEasing / closeEasing / nextEasing / prevEasing | Easing method for each transition type. You have numerous choices if easing plugin is included String; Default value: ‘swing’ |
openOpacity / closeOpacity | If set to true, transparency is changed for elastic transitions Boolean; Default value: true |
openMethod / closeMethod / nextMethod / prevMethod | Method from $.fancybox.transitions() that handles transition (you can add custom effects there) String; Default value: ‘zoomIn’ / ‘zoomOut’ / ‘changeIn’ / ‘changeOut’ |
helpers | Object containing enabled helpers and options for each of them Object; Default value: |
live | If set to true, fancyBox uses "live" to assign click event. Set to "false", if you need to apply only to current collection, e.g., if using something like — Boolean; Default value: true |
parent | Parent element of the container. This is useful for ASP.NET where the top element is "form" — String; Default value: body |
The plugin comes with a number of public functions to help you utilize the plugin in a number of different scenarios. Each of these functions can be called as a property of the $.fancybox object.
To use from inside the iframe — Close me
Name | Description |
---|---|
open |
$.fancybox.open( [group], [options] )
Launch fancyBox, the same as $.fancybox([group], [options])
First parameter can be in various types, examples:
$.fancybox([
$.fancybox(
$.fancybox( [‘image.jpg’, ‘image.jpg’] ); — array containing links as strings
$.fancybox( ‘image.jpg’ ); — string as source link
$.fancybox( [jQuery object] );
$.fancybox( ‘
‘ );
Cancel loading image or abort ajax request
If fancyBox is fully opened (open animation has ended) then start closing animation. If not or closing is forced (e.g. called like $.fancybox.close( true ) ) than fancyBox is removed immediatly
Start or stop (if already running) slideshow
Navigate to next gallery item
Navigate to previous gallery item
Navigate to gallery item by index. Item counting starts from 0, e.g. $.fancybox.jumpto( 0 ); will open the first, e.g. $.fancybox.jumpto( 1 ); will second, etc
Will center fancyBox inside viewport and toggle position type to fixed or absolute if needed
Auto-sizes fancyBox height to match height of content
If content is resized to fit inside viewport than it will be expanded to full size (and vice verse)
Shows loading animation
Hides loading animation
Also available are event driven callback methods, allowing you to extend functionality:
Name | Description |
---|---|
onCancel | Called after user triggers canceling. Note: If false is returned by the callback, the canceling will be halted |
beforeLoad | Called before starting to load content. Note: If false is returned by the callback, the loading will be halted |
afterLoad | Called after content is loaded. Receives two arguments — upcoming and current object — http://jsfiddle.net/xW5gs/ Note: If false is returned by the callback, the content will not be shown. |
beforeShow | Called right before open animations has started |
afterShow | Called after open animations has ended |
beforeClose | Called right after closing has been triggered but not yet started Note: If false is returned by the callback, the closing will be halted. |
afterClose | Called after closing animation has ended |
onUpdate | Called after window resize, scroll or orientation change events are triggered |
onPlayStart | Called after slideshdow has started |
onPlayEnd | Called after slideshdow has stoped |
Helpers
Helpers provide a simple mechanism to extend the capabilities of fancyBox. There are two built-in helpers — ‘overlay’ and ‘title’. You can disable them, set custom options or enable other helpers. Examples:
Options for thumbnail helper
Name | Description |
---|---|
width | Thumbnail width |
height | Thumbnail height |
source | Function to obtain the URL of the thumbnail image. By default, it uses the first image inside anchor or loads destination url instead. |
Examples: http://jsfiddle.net/PFVxK/, http://jsfiddle.net/2k8EP/
Options for button helper
Name | Description |
---|---|
tpl | HTML template |
position | ‘top’ or ‘bottom’ |
Support
You can ask a questions using the StackOverflow site where you are most likely to get answer quickly as many Javascript experts spend time on the site. Make sure you add the tags "jquery" and "fancybox" when posting.
If you run into an issue and need to report a bug, please create an issue on GitHub issues and I will investigate. But do not forget to check FAQ, first!
Follow @thefancyapps for the latest updates.
1. It doesn’t work at all. The image opens up in a new page. What’s wrong?
Check if you have included all files and set up FancyBox correctly.
Look for JavaScript error messages, they might help you to locate the problem.
If you see something like Uncaught TypeError: undefined is not a function:
1) Check if fancybox.js file is indeed loaded
2) Check if you have not included jQuery library more than once
2. Can a FancyBox appear over the top of my Flash content?
3. Can the script be called from an iframe?
If all necessary files are included in the parent window, then you can, like:
Open something
4. How can I close FancyBox from other element? ?
Just call $.fancybox.close() on your onClick event
5. I`m using custom urls for images (for example, PHP created images — index.php?action=image& >
FancyBox gueses content type from url but sometimes it can be wrong. The solution is to force your type, like so — $(".selector").fancybox(<‘type’ : ‘image’>);
6. FancyBox is not working on all images, only first one opens. What’s wrong?
If you are using ID as selector $("#selector").fancybox(); then switch to classes — $(".selector").fancybox();
jQuery lightbox script for displaying images, videos and more. Touch enabled, responsive and fully customizable.
See the project page for documentation and a demonstration.
Follow @thefancyapps for updates.
1. Add latest jQuery and fancyBox files
fancyBox is licensed under the GPLv3 license for all open source applications. A commercial license is required for all commercial applications (including sites, themes and apps you plan to sell).
Bugs and feature requests
If you find a bug, please report it here on Github.
Guidelines for bug reports:
- Use the GitHub issue search — check if the issue has already been reported.
- Check if the issue has been fixed — try to reproduce it using the latest master or development branch in the repository.
- Isolate the problem — create a reduced test case and a live example. You can use CodePen to fork any demo found on documentation to use it as a template.
A good bug report shouldn’t leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.
Feature requests are welcome. Please look for existing ones and use GitHub’s "reactions" feature to vote.
Please do not use the issue tracker for personal support requests — use Stack Overflow (fancybox-3 tag) instead.