Lightbox

Lightbox, using transitions, shows and hides different renderables. Lightbox can essentially be thought of as RenderController with a stateful implementation and interface.

Overview

Options
inTransform
outTransform
showTransform
inOpacity
outOpacity
showOpacity
inOrigin
outOrigin
showOrigin
inAlign
outAlign
showAlign
inTransition
outTransition
overlap
Methods
setOptions
show
hide
Constructor Parameters

options

Options

An object of configurable options.

inTransform
Transform
The transform at the start of transitioning in a shown renderable.
outTransform
Transform
The transform at the end of transitioning out a renderable.
showTransform
Transform
The transform applied to your shown renderable in its state of equilibrium.
inOpacity
Number
A number between one and zero that defines the state of a shown renderables opacity upon initially being transitioned in.
outOpacity
Number
A number between one and zero that defines the state of a shown renderables opacity upon being fully transitioned out.
showOpacity
Number
A number between one and zero that defines the state of a shown renderables opacity once succesfully transitioned in.
inOrigin
Array<Number>
A two value array of numbers between one and zero that defines the state of a shown renderables origin upon intially being transitioned in.
outOrigin
Array<Number>
A two value array of numbers between one and zero that defines the state of a shown renderable origin once fully hidden.
showOrigin
Array<Number>
A two value array of numbers between one and zero that defines the state of a shown renderables origin upon succesfully being shown.
inAlign
Array<Number>
A two value array of numbers between one and zero that defines the state of a shown renderables align upon intially being transitioned in.
outAlign
Array<Number>
A two value array of numbers between one and zero that defines the state of a shown renderable align once fully hidden.
showAlign
Array<Number>
A two value array of numbers between one and zero that defines the state of a shown renderables align upon succesfully being shown.
inTransition
Transition
The transition in charge of showing a renderable.
outTransition
Transition
The transition in charge of removing your previous renderable when you show a new one, or hiding your current renderable.
overlap
Boolean
When showing a new renderable, overlap determines if the out transition of the old one executes concurrently with the in transition of the new one, or synchronously beforehand.
Methods

setOptions(options)

Patches the Lightbox instance's options with the passed-in ones.

Parameters
options
Options
An object of configurable options for the Lightbox instance.

show(renderable, transition, callback)

Show displays the targeted renderable with a transition and an optional callback to execute afterwards.

Parameters
renderable
Object
The renderable you want to show.
transition
Transition
Overwrites the default transition in to display the passed-in renderable.
callback
Function
Executes after transitioning in the renderable.

hide(transition, callback)

Hide hides the currently displayed renderable with an out transition.

Parameters
transition
Transition
Overwrites the default transition in to hide the currently controlled renderable.
callback
Function
Executes after transitioning out the renderable.