fritzmg / contao-nivo-lightbox
Nivo Lightbox for Contao
Installs: 1 983
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Language:CSS
Type:contao-module
Requires
- php: >=5.2
- contao-community-alliance/composer-plugin: ^2.4|^3.0
- contao/core-bundle: ^3.0|^4.4
Replaces
- contao-legacy/nivo_lightbox: 1.3.0
README
Contao Nivo Lightbox
Contao extension to integrate the Nivo Lightbox overlay.
Usage
Simply activate the j_nivo_lightbox
template in your page layout under jQuery. Do not activate j_colorbox
or moo_mediabox
as well! The overlay will work with all links that use the data-lightbox="..."
parameter.
Customizing
If you want to use your own custom parameters, simply create your own j_nivo_lightbox
template and insert your custom options at this line:
// init nivo lightbox $links.nivoLightbox();
Refer to the Nivo Lightbox documentation for all available parameters.
Types
By default, Nivo Lightbox acts as an image overlay. Nivo Lightbox also lets you open an URL via AJAX or iframe. Or you can display existing HTML in the overlay by referencing the id of the HTML element. This extension provides an initiation mechanic, so that most use cases can still be controlled via the data-lightbox
parameter, as it is common in Contao.
Show a page via iframe:
<a href="page.html" data-lightbox="iframe">...</a>
Load a page via AJAX:
<a href="page.html" data-lightbox="ajax">...</a>
Display some HTML element in the overlay:
<a href="#some-element" data-lightbox="inline">...</a>
In some cases you might need to force a href to be displayed as an image, e.g. if the href simply does not end with jpeg
, jpg
, gif
or png
:
<a href="http://placehold.it/350x150" data-lightbox="image">...</a> <a href="http://placehold.it/350x150" data-lightbox-type="image">...</a>
All regular parameters mentioned in the Nivo Lightbox documentation should still work as well. If you do not provide any of this in your HTML source, the extension will open any non-image URLs in an iframe by default.