Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
jQuery plugin for drop-in fix binded events problem caused by Turbolinks
CoffeeScript Ruby

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
spec
src
vendor/assets/javascripts
.gitignore
Gemfile
Guardfile
LICENSE.md
README.md
Rakefile
jquery-turbolinks.gemspec
package.json

README.md

jQuery Turbolinks

Do you like Turbolinks? It's easy and fast way to improve user experience of surfing on your website.

But if you have a large codebase with lots of $(el).bind(...) Turbolinks will surprise you. Most part of your JavaScripts will stop working in usual way. It's because the nodes on which you bind events no longer exist.

I wrote jquery.turbolinks to solve this problem in my project. It's easy to use: just require it after jquery.js and tubrolinks.js, but before other scripts.

Sponsored by Evil Martians.

Usage

Gemfile:

gem 'jquery-turbolinks'

JavaScript manifest file:

//= require jquery.turbolinks

And it just works!

$.setReadyEvent

By default ready function is binded to page:load event.

If you want to change it use $.setReadyEvent function:

$.setReadyEvent('page:change');

$.setFetchEvent

By default right after trigger page:fetch $.isReady is set to false. And after page:load is set to true.

If you want to change default behaviour you can use $.setFetchEvent:

$.setReadyEvent('custom_loading_event');

Changelog

This project uses Semantic Versioning for release numbering.

1.0.0-rc1 (November 28, 2012)

  • Set $.isReady to false after page:fetch #6;
  • add $.setFetchEvent function;
  • remove all delegated events after trigger fetch event #8;

1.0.0-rc (November 8, 2012)

  • Add turbolinks as dependency (kudos to @gbchaosmaster);
  • run callback after adding to waiting list if $.isReady #6.

0.2.1 (October 15, 2012)

  • Pass jQuery object to each callback #4

0.2.0 (October 10, 2012)

  • Change event: page:change -> page:load (kudos to @davydotcom);
  • added ability to change ready event via $.setReadyEvent

0.1.0 (October 3, 2012)

  • First, initial release

Contributors

Idea and code by @kossnocorp.

The MIT License

Something went wrong with that request. Please try again.