Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/defunkt/facebox
Facebook-style lightbox, built in jQuery
https://github.com/defunkt/facebox
Last synced: 28 days ago
JSON representation
Facebook-style lightbox, built in jQuery
- Host: GitHub
- URL: https://github.com/defunkt/facebox
- Owner: defunkt
- License: mit
- Created: 2008-02-11T22:49:27.000Z (over 16 years ago)
- Default Branch: master
- Last Pushed: 2024-02-22T17:44:06.000Z (9 months ago)
- Last Synced: 2024-10-01T15:22:14.699Z (about 1 month ago)
- Language: JavaScript
- Homepage: http://defunkt.io/facebox/
- Size: 1.12 MB
- Stars: 1,927
- Watchers: 69
- Forks: 385
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Facebox
Facebox is a jQuery-based, Facebook-style lightbox which can display images, divs, or entire remote pages.
[See it in action](http://defunkt.github.com/facebox/).
[Download the latest release](http://github.com/defunkt/facebox/zipball/master)
## Compatibility
This release relies on a lot of advanced CSS techniques (box-shadow, border-radius, RGBA). That being said, it's compatible with many browsers.
* **Safari 4**
* **Webkit Nightlies** (Chromium, Chrome) as of 4/17/10
* **Firefox 3.5**
* **IE8** (degraded experience)
* **IE7** (degraded experience)
* IE6 - I just don't care
* Opera - I just don't care
## Usage
Include jQuery, `src/facebox.js` and `src/facebox.css`. Then tell facebox where you've put `src/loading.gif` and `src/closelabel.png`
$.facebox.settings.closeImage = '/images/facebox/closelabel.png'
$.facebox.settings.loadingImage = '/images/facebox/loading.gif'
Calling facebox() on any anchor tag will do the trick, it's easier to give your Faceboxy links a rel="facebox" and hit them all onDomReady.
jQuery(document).ready(function($) {
$('a[rel*=facebox]').facebox()
})
Any anchor links with `rel="facebox"` with now automatically use facebox:
Terms
Loads the #terms div in the box
Terms
Loads the terms.html page in the box
Terms
Loads the terms.png image in the box
### Using facebox programmatically
jQuery.facebox('some html')
jQuery.facebox('some html', 'my-groovy-style')
The above will open a facebox with "some html" as the content.
jQuery.facebox(function($) {
$.get('blah.html', function(data) { $.facebox(data) })
})
The above will show a loading screen before the passed function is called,
allowing for a better ajaxy experience.
The facebox function can also display an ajax page, an image, or the contents of a div:
jQuery.facebox({ ajax: 'remote.html' })
jQuery.facebox({ ajax: 'remote.html' }, 'my-groovy-style')
jQuery.facebox({ image: 'stairs.jpg' })
jQuery.facebox({ image: 'stairs.jpg' }, 'my-groovy-style')
jQuery.facebox({ div: '#box' })
jQuery.facebox({ div: '#box' }, 'my-groovy-style')
### Events
Want to close the facebox? Trigger the `close.facebox` document event:
jQuery(document).trigger('close.facebox')
Facebox also has a bunch of other hooks:
* `loading.facebox`
* `beforeReveal.facebox`
* `reveal.facebox` (aliased as `afterReveal.facebox`)
* `init.facebox`
* `afterClose.facebox` (callback after closing `facebox`)
Simply bind a function to any of these hooks:
$(document).bind('reveal.facebox', function() { ...stuff to do after the facebox and contents are revealed... })
### Customization
You can give the facebox container an extra class (to fine-tune the display of the facebox) with the facebox[.class] rel syntax.
## Contact & Help
If you have questions, feel free to ask on the [Google Groups Mailing List](http://groups.google.com/group/facebox/). Alternatively if you find a bug, you can [open an issue](http://github.com/defunkt/facebox/issues).
