Class Orbit

Orbit generates a foundation orbits.

CWidget

foundation\widgets\Orbit

Namespace: foundation\widgets
Package: foundation\widgets
Author: Antonio Ramirez <amigo.cobos@gmail.com>
See: http://foundation.zurb.com/docs/components/orbit.html
Located at widgets/Orbit.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 string`	# `renderOrbit( )` Renders the orbit plugin Renders the orbit plugin Returns `string` the generated HTML string
`public string`	# `renderItem( array $item )` Returns a generated LI tag item Returns a generated LI tag item Parameters `$item` `array` $item the item configuration Returns `string` the resulting li tag
`public`	# `registerClientScript( )` Registers the plugin script Registers the plugin script

Methods inherited from foundation\widgets\base\Widget

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

Magic methods summary

Properties summary

`public array`	`$items`	# the items to render in the orbit. The syntax is as follows: 'items' => array( array('content', 'caption') ) the items to render in the orbit. The syntax is as follows: 'items' => array( array('content', 'caption') )
`public array`	`$pluginOptions`	# the orbit plugin options. The options are (option: default value): animation: 'fade' timer_speed: 10000 pause_on_hover: true resume_on_mouseout: false animation_speed: 500 stack_on_small: true navigation_arrows: true slide_number: true container_class: 'orbit-container' stack_on_small_class: 'orbit-stack-on-small' next_class: 'orbit-next' prev_class: 'orbit-prev' timer_container_class: 'orbit-timer' timer_paused_class: 'paused' timer_progress_class: 'orbit-progress' slides_container_class: 'orbit-slides-container' bullets_container_class: 'orbit-bullets' bullets_active_class: 'active' slide_number_class: 'orbit-slide-number' caption_class: 'orbit-caption' active_slide_class: 'active' orbit_transition_class: 'orbit-transitioning' bullets: true timer: true variable_height: false before_slide_change: function(){} after_slide_change: function(){} the orbit plugin options. The options are (option: default value): animation: 'fade' timer_speed: 10000 pause_on_hover: true resume_on_mouseout: false animation_speed: 500 stack_on_small: true navigation_arrows: true slide_number: true container_class: 'orbit-container' stack_on_small_class: 'orbit-stack-on-small' next_class: 'orbit-next' prev_class: 'orbit-prev' timer_container_class: 'orbit-timer' timer_paused_class: 'paused' timer_progress_class: 'orbit-progress' slides_container_class: 'orbit-slides-container' bullets_container_class: 'orbit-bullets' bullets_active_class: 'active' slide_number_class: 'orbit-slide-number' caption_class: 'orbit-caption' active_slide_class: 'active' orbit_transition_class: 'orbit-transitioning' bullets: true timer: true variable_height: false before_slide_change: function(){} after_slide_change: function(){}
`public string[]`	`$events`	# the JavaScript event configuration (name=>handler). The following list shows the available ones: orbit:ready, param: event, Fires when the slider has loaded orbit:before-slide-change, param: event, Fires before a slide changes orbit:after-slide-change, param: event, Fires after a slide transition animation has finished. The orbit parameter contains slide_number and total_slides. orbit:timer-started, param: event, Fires each time the timer is started/resumed orbit:timer-stopped, param: event, Fires each time the timer is paused/stopped the JavaScript event configuration (name=>handler). The following list shows the available ones: orbit:ready, param: event, Fires when the slider has loaded orbit:before-slide-change, param: event, Fires before a slide changes orbit:after-slide-change, param: event, Fires after a slide transition animation has finished. The orbit parameter contains slide_number and total_slides. orbit:timer-started, param: event, Fires each time the timer is started/resumed orbit:timer-stopped, param: event, Fires each time the timer is paused/stopped
`public boolean`	`$showPreloader`	# whether to display the preloader or not whether to display the preloader or not

Properties inherited from foundation\widgets\base\Widget

$assets, $htmlOptions, $links

Namespaces

Classes