0.02
Repository is archived
No commit activity in last 3 years
No release in over 3 years
Easy jQuery feature tours, based on ZURB's Joyride plugin (http://www.zurb.com/playground/jquery_joyride_feature_tour_plugin)
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
 Dependencies

Development

Runtime

~> 2.0
~> 3.1
~> 3.1
~> 3.1
 Project Readme

Joyride

Build easy feature tours, thanks to ZURB's joyride plugin

See a live demo here

Setup

You must include the proper script and style assets

    //= require joyride/joyride

and

    *= require joyride/joyride

Basic Usage

    = joyride :chooseID, :cookie => false do |j|
      = j.step :section1, "This is the first step"
      = j.step :section2, "This is the second step"

The :cookie option controls whether or not a cookie is checked before showing the tour (meaning if it is set to false, the tour will always run)

The first argument of each step must be the id of whatever element it should be anchored to

Customization

Look and feel

The tour steps can be customized by applying a CSS class to the tips. Included with the gem is a bootstrap_tour class that (sort of) matches the twitter bootstrap look and feel

    = joyride :chooseID, :tip_class => "bootstrap_tour" do |j|
      = j.step :section1, "This is the first step"
      = j.step :section2, "This is the second step", :html => {:class => "my_custom_tip"}

Additionally, an idividual tip can be customized using the :html argument, as shown above

Callbacks

Javascript callbacks can be added for each step (called as each tour step is rendered), or for the tour as whole (called when the entire tour is finished)

    = joyride :chooseID, 
              :after_step_callback => "alert('step')",
              :after_tour_callback => "alert('done!')" do |j|
      = j.step :section1, "This is the first step"

Animation

An :animation parameter can be applied to the tour as a whole; valid values are :pop (default) and :fade.

    = joyride :chooseID, :animation => :fade do |j|
      = j.step :section1, "This is the first step"