PHPackages                             jasonbrady/joyride - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. jasonbrady/joyride

ActiveLibrary

jasonbrady/joyride
==================

Joyride plugin for Foundation 6.

06JavaScript

Since Aug 8Pushed 8y agoCompare

[ Source](https://github.com/jasonbrady/joyride)[ Packagist](https://packagist.org/packages/jasonbrady/joyride)[ RSS](/packages/jasonbrady-joyride/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Joyride
=======

[](#joyride)

Joyride is an easy to configure site tour wizard for [Foundation for Sites](https://github.com/zurb/foundation-sites).

Demo
----

[](#demo)

You can try out Joyride on the [Demo Page](http://zurb.github.io/joyride/).

Installation
------------

[](#installation)

To install Joyride you can either use NPM ([NPM repository](https://www.npmjs.com/package/foundation-joyride)) or download the files directly.

- `npm start` - Calls the build process and opens the demo in your browser.
- `npm test` - Runs the JavaScript tests.
- `npm run test:javascript` - Runs tests for JavaScript with Mocha using PhantomJS.
- `npm run test:visual` - Runs visual tests/live demos.

Usage
-----

[](#usage)

All versions of joyride depend on jQuery and [what-input](https://github.com/ten1seven/what-input). While jQuery is mandatory, what-input is used for styling purposes and not necessary for joyride to work.

Regardless of the way you use Joyride, you need to initialize it like all Foundation plugins by calling:

```
$(document).foundation();
```

The following HTML is an example on how to use Joyride. You can also have a look at the visual test cases in the `test/visual/` folder.

```

    This is the default one without settings

    This one isn't closable

    If no target is specified, you create a modal.

    Your ride ends here!

      OK, thanks!

```

### Foundation plugin

[](#foundation-plugin)

Originally, Joyride is a plugin for Foundation for Sites and leaverages existing plugins and functionalities of the framework. To use Joyride with Foundation, just include the files into your page right after the Foundation files. Then follow the example above to create the ride.

### Standalone plugin

[](#standalone-plugin)

To make Joyride available for a broader amount of users, it is also available as a standalone plugin. All relevant Foundation functionalities are bundled with the Joyride files, so Joyride can still benefit from them. To use Joyride with Foundation, just include the files into your page right and follow the example above to create the ride.

### Using script loader

[](#using-script-loader)

Joyride can be used by including its files via HTML-tags and also the most popular script loaders, such as RequireJS. This is done by leveraging UMD.

Testing
-------

[](#testing)

- `npm run test:javascript` to run JavaScript tests with Mocha using PhantomJS.
- `npm run test:visual` to run visual regression tests.

Contributing
------------

[](#contributing)

Check out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to this plugin. You can also browse the [Help Wanted](https://github.com/zurb/joyride/labels/help%20wanted) tag in our issue tracker to find things to do.

###  Health Score

19

—

LowBetter than 10% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity4

Limited adoption so far

Community2

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/1c8a3004794e105a0cd974e3c04f6f7fa1fa2630b00bdf38e29e97be66ee1ae8?d=identicon)[jasonbrady](/maintainers/jasonbrady)

### Embed Badge

![Health badge](/badges/jasonbrady-joyride/health.svg)

```
[![Health](https://phpackages.com/badges/jasonbrady-joyride/health.svg)](https://phpackages.com/packages/jasonbrady-joyride)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)