Class Clearing

Clearing creates responsive lightboxes with any size image

CWidget

foundation\widgets\Clearing

Namespace: foundation\widgets
Package: foundation\widgets
Author: Antonio Ramirez <amigo.cobos@gmail.com>
See: http://foundation.zurb.com/docs/components/clearing.html
Located at widgets/Clearing.php

Methods summary

`public`	# `init( )` Initializes the widget Initializes the widget Overrides `foundation\widgets\base\Widget::init`
`public`	# `run( )` Renders the widget Renders the widget
`public boolean\|string`	# `renderClearing( )` Renders the clearing widget Renders the clearing widget Returns `boolean\|string` the resulting element
`public string`	# `renderItem( array $item )` Renders a clearing (lightbox) item Renders a clearing (lightbox) item Parameters `$item` `array` $item Returns `string` the resulting LI tag item

Methods inherited from foundation\widgets\base\Widget

display(), registerAssets(), registerEvents(), registerPlugin()

Magic methods summary

Properties summary


				public  
				array

$items

$items the items to be displayed on the gallery. The syntax is the following:

'items' => array(
     array(
         'img' => 'large image source',
         'th' => 'thumbnail image',
         'featured' => true, // whether is featured image or not
         'caption' => 'caption of the image',
         'options' => array(...)
     )
)

$items the items to be displayed on the gallery. The syntax is the following:

'items' => array(
     array(
         'img' => 'large image source',
         'th' => 'thumbnail image',
         'featured' => true, // whether is featured image or not
         'caption' => 'caption of the image',
         'options' => array(...)
     )
)

Properties inherited from foundation\widgets\base\Widget

$assets, $htmlOptions, $links

Namespaces

Classes