Usage

Parent Previous Next

It is necessary to enter a plugin code in a content where you want to use the extension. A plugin code looks like:


{arisexylightbox activeType="imglist" thumbWidth="100" dir="images/photos"}{/arisexylightbox}


It contains {arisexylightbox} tag which accepts different attributes to specify lightbox parameters and etc. activeType and thumbWidth attributes are used in sample code above. If you use a WYSIWYG editor, switch it to plain text mode before inserting a plugin code. WYSIWYG editors can add extra HTML code or encode inserting code in design mode. By default the plugin is used parameters from "Plugin Parameters" section from plugin settings page on Joomla! backend. If you want to override parameter(s), add necessary attributes(s) to {arisexylightbox} plugin tag in the following format:


parameterName="parameterValue"


For example if you set "Show duration" parameter to "1000" in "Plugin Parameters" section and want to override it, use the following code:


{arisexylightbox activeType="imglist" thumbWidth="100" dir="images/photos" opt_showDuration="2500"}{/arisexylightbox}



Settings


A lot of parameters on plugin settings page are the same as parameters for ARI Sexy Lightbox module. The plugin contains the following unique parameters:


Mode is used to specify if the plugin should work as a content plugin and work only in Joomla! articles (set the parameter to "Content") or if it should work in any content (set the parameter to "Anywhere").


Attributes of {arisexylightbox} tag


includeJQuery indicates if the extension should load jQuery library or not. The lightbox uses jQuery library, but if jQuery library is loaded on your site by a site template or a 3rd party extension, you can set the parameter to 0 to improve performance. We recommend to define this parameter in plugin settings. Values: 1 or 0.


noConflict indicates if the extension should call jQuery.noConflict() method to avoid conflicts with other javascript libraries or not. We recommend to define this parameter in plugin settings. Values: 1 or 0.


autoShow indicates if the lightbox should be opened when a page is loaded or not. If you always want to open the lightbox when a page is opened, set the parameter to 1. If you want to open the lightbox when a user opens a page at the first time, set the parameter to first value.. Values: 1, 0, first.


unique is an unique key. This parameter is required only if you set "autoShow" parameter to first value. Values: a string.


opt_zIndex is used to specify z-Index CSS property for lightbox container. It can be used if lightbox is overlapped with other element(s) on a page. Values: an integer value.


opt_color indicates lightbox theme. Values: black, white, blanco, negro, blanc, noir, fancy_white, fancy_black, old_white, old_black.


opt_emergefrom indicates a position on which the lightbox starts to appear. Values: top, bottom, left, right.


opt_showDuration is a duration in milliseconds of showing animation. Values: an integer number starts from 1.


opt_closeDuration is a duration in milliseconds of closing animation. Values: an integer number starts from 1.


opt_moveDuration is a duration in milliseconds of moving animation. Values: an integer number starts from 1.


opt_moveEffect is an animation effect which is used when the lightbox is moving. Values: an effect name.


opt_resizeDuration is an animation effect which is used when the lightbox is resizing. Values: an integer number starts from 1.


opt_resizeEffect is an animation effect which is used when the lightbox is resizing. Values: an effect name.


opt_shake_distance is a "distance" of shake effect. Values: an integer number.


opt_shake_duration is a duration in milliseconds of shake effect. Values: an integer number.


opt_shake_loops is a quantity of repetition of shake effect. Values: an integer number.


opt_shake_transition is an animation effect which is used when the lightbox is shaking. Values: an effect name.


modal is used to active modal mode. A user can close the lightbox only by clicking "Close" button in modal mode otherwise s/he can click anywhere on overlay  and the lightobx will be closed. Values: 1 or 0.


groupName is used to specify a group name for lightbox items. It is possible to navigate between Items from one group using ligtbox navigation buttons. Use this parameter if you want to join items from several plugin (module) instances and provide navigation between them into the lightbox. Values: a string.