lity

Lity
====

Lity is a ultra-lightweight, accessible and responsive lightbox plugin which
supports images, iframes and inline content out of the box.

Minified and gzipped, its total footprint weights about 3kB.

It requires jQuery or Zepto
(with the callbacks,
deferred and
data
modules).

Installation
------------

All ready-to-use files are located in the dist/ directory.

Include the Lity javascript and css files and its dependencies in your HTML
document:

``html



`

Lity can also be installed via Bower or npm.

Usage
-----

$3

Add the data-lity attribute to elements for which you want the links to
be opened in a lightbox:

`html
Image
Inline
iFrame Youtube
iFrame Vimeo
Google Maps


`

If you want to open another URI than defined in the href attribute, just add
a data-lity-target with the URI:

`html
Image
`

$3

The lity function can be either used directly to open URLs (or HTML) in a
lightbox or as an event handler.

`
Lity lity(string target, [Object options, [, HTMLElement|$ opener]])
`

#### Arguments

* target: The URL or HTML to open.
* options: Options as an object of key-value pairs.
* opener: The element which triggered opening the lightbox (if used as a event
handler, this is automatically set to the element which triggered the event).

#### Return value

A Lity instance.

#### Example

`javascript
// Open a URL or HTML in a lightbox
lity('https://www.youtube.com/watch?v=XSGBVzeBUbk');
lity('

Some content to show...

');

// Bind as an event handler
$(document).on('click', '[data-my-lightbox]', lity);
`

The Lity instance
-----------------

If you open a lightbox programmatically, the lity function returns a Lity
instance you can use to interact with the lightbox.

The Lity instance is also passed as the second argument to the
event handlers.

`javascript
var instance = lity('https://www.youtube.com/watch?v=XSGBVzeBUbk');
`

$3

* Lity.close
* Lity.element
* Lity.opener
* Lity.options

#### Lity.close

Closes the lightbox and returns a promise which resolves once the closing
animation is finished.

`javascript
instance.close().then(function() {
console.log('Lightbox closed');
});
`

#### Lity.element

Returns the root HTML element.

`javascript
var element = instance.element();
`

#### Lity.opener

Returns the HTML element which triggered opening the lightbox.

`javascript
var opener = instance.opener();
`

Note: The value might be undefined if the lightbox has been opened
programmatically and not by a click event handler and no opener argument was
provided.

#### Lity.options

Sets or returns options of the instance.

`javascript
var allOptions = instance.options();

var template = instance.options('template');
instance.options('template', '

');

var closeOnEsc = instance.options('esc');
instance.options('esc', false);
`

Events
------

All events receive the Lity instance as the second
argument.

$3

* lity:open
* lity:ready
* lity:close
* lity:remove
* lity:resize

#### lity:open

Triggered before the lightbox is opened.

`javascript
$(document).on('lity:open', function(event, instance) {
console.log('Lightbox opened');
});
`

#### lity:ready

Triggered when the lightbox is ready.

`javascript
$(document).on('lity:ready', function(event, instance) {
console.log('Lightbox ready');
});
`

#### lity:close

Triggered before the lightbox is closed.

`javascript
$(document).on('lity:close', function(event, instance) {
console.log('Lightbox closed');
});
`

#### lity:remove

Triggered when the closing animation is finished and just before the lightbox
is removed from the DOM.

`javascript
$(document).on('lity:remove', function(event, instance) {
console.log('Lightbox removed');
});
`

#### lity:resize

Triggered when the instance is resized, usually when the user resizes the
window.

`javascript
$(document).on('lity:resize', function(event, instance) {
console.log('Lightbox resized');
});
``

License
-------

Copyright (c) 2015-2020 Jan Sorgalla.
Released under the MIT license.