YiiFoundation
  • Namespace
  • Class
  • Tree

Namespaces

  • foundation
    • enum
    • exception
    • helpers
    • widgets
      • base
  • PHP

Classes

  • Alert
  • Breadcrumbs
  • Clearing
  • Dropdown
  • FlexVideo
  • Interchange
  • JoyRide
  • Magellan
  • Orbit
  • Pager
  • Reveal
  • Section
  • SwitchButton
  • Tooltip
  • TopBar

Class JoyRide

JoyRide renders a foundation tour plugin.

CWidget
Extended by foundation\widgets\base\Widget
Extended by foundation\widgets\JoyRide
Namespace: foundation\widgets
Package: foundation\widgets
Author: Antonio Ramirez <amigo.cobos@gmail.com>
See: http://foundation.zurb.com/docs/components/joyride.html
Located at widgets/JoyRide.php

Methods summary

public
# init( )

Initializes the widget

Initializes the widget

Overrides

foundation\widgets\base\Widget::init
public
# run( )

Initializes the widget

Initializes the widget

public
# renderJoyRide( )
public string
# renderStop( array $stop )

Renders a single stop

Renders a single stop

Parameters

$stop
array
$stop the stop configuration

Returns

string
the resulting li tag
public boolean
# registerClientScript( )

Starts joyride if [[autostart]] has been set to true.

Starts joyride if [[autostart]] has been set to true.

Returns

boolean

Methods inherited from foundation\widgets\base\Widget

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

Magic methods summary

Properties summary

public array $pluginOptions
#

plugin initialization options. The following are available:

 array(
     'tipLocation'           => 'bottom',            // 'top' or 'bottom' in relation to parent
     'nubPosition'           => 'auto',              // override on a per tooltip bases
     'scrollSpeed'           => '300',               // Page scrolling speed in milliseconds
     'timer'                 => '0',                 // 0 = no timer , all other numbers = timer in milliseconds
     'startTimerOnClick      => 'true',              // true or false - true requires clicking the first button start the timer
     'startOffset'           => '0',                 // the index of the tooltip you want to start on (index of the li)
     'nextButton'            => 'true',              // true or false to control whether a next button is used
     'tipAnimation'          => 'fade',              // 'pop' or 'fade' in each tip
     'pauseAfter'            => array(),             // array of indexes where to pause the tour after
     'tipAnimationFadeSpeed' => '300',               // when tipAnimation = 'fade' this is speed in milliseconds for the transition
     'cookieMonster'         => 'false',             // true or false to control whether cookies are used
     'cookieName'            => 'joyride',           // Name the cookie you'll use
     'cookieDomain'          => 'false',             // Will this cookie be attached to a domain, ie. '.notableapp.com'
     'cookieExpires'         => '365',               // set when you would like the cookie to expire.
     'tipContainer'          => 'body',              // Where will the tip be attached
     'postRideCallback'      => 'js:function (){},   // A method to call once the tour closes (canceled or complete)
     'postStepCallback'      => 'js:function (){},   // A method to call after each step
     'template' => array( // HTML segments for tip layout
         'link' => '<a href="#close" class="joyride-close-tip">&times;</a>',
         'timer' => '<div class="joyride-timer-indicator-wrap"><span class="joyride-timer-indicator"></span></div>',
         'tip' => '<div class="joyride-tip-guide"><span class="joyride-nub"></span></div>',
         'wrapper' => '<div class="joyride-content-wrapper"></div>',
         'button' => '<a href="#" class="small button joyride-next-tip"></a>'
     ),
 )

plugin initialization options. The following are available:

 array(
     'tipLocation'           => 'bottom',            // 'top' or 'bottom' in relation to parent
     'nubPosition'           => 'auto',              // override on a per tooltip bases
     'scrollSpeed'           => '300',               // Page scrolling speed in milliseconds
     'timer'                 => '0',                 // 0 = no timer , all other numbers = timer in milliseconds
     'startTimerOnClick      => 'true',              // true or false - true requires clicking the first button start the timer
     'startOffset'           => '0',                 // the index of the tooltip you want to start on (index of the li)
     'nextButton'            => 'true',              // true or false to control whether a next button is used
     'tipAnimation'          => 'fade',              // 'pop' or 'fade' in each tip
     'pauseAfter'            => array(),             // array of indexes where to pause the tour after
     'tipAnimationFadeSpeed' => '300',               // when tipAnimation = 'fade' this is speed in milliseconds for the transition
     'cookieMonster'         => 'false',             // true or false to control whether cookies are used
     'cookieName'            => 'joyride',           // Name the cookie you'll use
     'cookieDomain'          => 'false',             // Will this cookie be attached to a domain, ie. '.notableapp.com'
     'cookieExpires'         => '365',               // set when you would like the cookie to expire.
     'tipContainer'          => 'body',              // Where will the tip be attached
     'postRideCallback'      => 'js:function (){},   // A method to call once the tour closes (canceled or complete)
     'postStepCallback'      => 'js:function (){},   // A method to call after each step
     'template' => array( // HTML segments for tip layout
         'link' => '<a href="#close" class="joyride-close-tip">&times;</a>',
         'timer' => '<div class="joyride-timer-indicator-wrap"><span class="joyride-timer-indicator"></span></div>',
         'tip' => '<div class="joyride-tip-guide"><span class="joyride-nub"></span></div>',
         'wrapper' => '<div class="joyride-content-wrapper"></div>',
         'button' => '<a href="#" class="small button joyride-next-tip"></a>'
     ),
 )
public array $stops
#

The tour stops. Each stop has the following syntax

The tour stops. Each stop has the following syntax

'stops' => array(
     array(
         'id' => 'id-of-element', // if null will be displayed as a modal
         'title' => 'title of the box',
         'body' => 'content of the box',
         'text' => 'Next', // button text,
         'button' => 'Next', // button text,
         'class' => 'custom css class',
         'options' => array(...), // optional joyride options for the element
     )
)
public boolean $autoStart
#

whether to autostart joyride plugin or not

whether to autostart joyride plugin or not

Properties inherited from foundation\widgets\base\Widget

$assets, $htmlOptions, $links

YiiFoundation API documentation generated by ApiGen 2.8.0