Joyride Tour guide doesn't explain autoStart:true

[ddgromit]

Following the zurb.com guide steps that this repo references leads to the plugin not starting, because it doesn't mention any kind of start method or using the autoStart:true.

It would be very helpful for first-timers trying to integrate this plugin if either that guide was updated to include autoStart:true, or the readme informed the user about this requirement.

[serkanyersen]

Oh god, I've been trying to figure this out for an hour. Thanks.

$('#walk-through').joyride({
    autoStart: true
});

[explorigin]

Along these lines, the README says "Comprehensive documentation is on the website listed above." There is a guide, but their version of comprehensive is similar to the NSA's version of online privacy (not there).

[j0hnsmith]

+1 the most important instruction is missing

[EdwardHinkle]

+1 most important instruction... although is it just me or does it seem that Joyride has been left to die on it's own and that it is now only in the Foundation 5 framework. It doesn't seem like there have been any commits since Foundation 5 came out.

[bearded-avenger]

I just spent hours on this. PLEASE update your documentation.

http://zurb.com/playground/jquery-joyride-feature-tour-plugin

[KnightYoshi]

Using Foundation 5, something I found is that you can use something like

$(document).foundation({
    topbar: {...},
    joyride: 'start',
    ...
})

Though I'm not sure how to pass the object of options to it. So that may have to be defined in the data-options

[btbjosh]

+1 Doc instruction update needed.

[bencappello]

Yes clearly they don't care about this glaring hole in the documentation. I wonder if there is another way to start the tour without autostart

[filtoid]

I don't know if this is the "right" way of doing things but if you do the following it might work (mine is at least).

On window load:

$(window).load(function() {
  $("#joyRideTipContent").joyride({
    autoStart : false
  });
});

Then when you want to kick off the joyride you simply call it like this:

$("#my_button").click( function(){
   $("#joyRideTipContent").joyride({
      modal:true,
      expose: true
  });
});

Hope that helps.