Skip to content
This repository

Add jquery.turbolinks note to README #163

Merged
merged 1 commit into from over 1 year ago

2 participants

Ry Walker David Heinemeier Hansson
Ry Walker
ryw commented

No description provided.

David Heinemeier Hansson dhh merged commit 2a0ea30 into from
David Heinemeier Hansson dhh closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Showing 1 unique commit by 1 author.

Jan 11, 2013
Ry Walker Add jquery.turbolinks note to README 6bbf10e
This page is out of date. Refresh to see the latest.

Showing 1 changed file with 14 additions and 1 deletion. Show diff stats Hide diff stats

  1. 15  README.md
15  README.md
Source Rendered
@@ -62,6 +62,19 @@ Note that internal links to files not ending in .html, or having no extension, w
62 62
 Also, Turbolinks is installed as the last click handler for links. So if you install another handler that calls event.preventDefault(), Turbolinks will not run. This ensures that you can safely use Turbolinks with stuff like `data-method`, `data-remote`, or `data-confirm` from Rails.
63 63
 
64 64
 
  65
+jquery.turbolinks
  66
+-----------------
  67
+
  68
+If you have a lot of existing JavaScript that binds elements on jQuery.ready(), you can pull the [jquery.turbolinks](https://github.com/kossnocorp/jquery.turbolinks) library into your project that will trigger ready() when Turbolinks triggers the the `page:load` event. It may restore functionality of some libraries.
  69
+
  70
+Add the gem to your project, then add the following line to your JavaScript manifest file, after `jquery.js` but before `turbolinks.js`:
  71
+
  72
+``` js
  73
+//= require jquery.turbolinks
  74
+```
  75
+
  76
+Additional details and configuration options can be found in the [jquery.turbolinks README](https://github.com/kossnocorp/jquery.turbolinks/blob/master/README.md).
  77
+
65 78
 Asset change detection
66 79
 ----------------------
67 80
 
@@ -112,4 +125,4 @@ Installation
112 125
 Credits
113 126
 -------
114 127
 
115  
-Thanks to Chris Wanstrath for his original work on Pjax. Thanks to Sam Stephenson and Josh Peek for their additional work on Pjax and Stacker and their help with getting Turbolinks released. Thanks to David Estes for handling the lion's share of post-release issues and feature requests. And thanks to everyone else who's fixed or reported an issue!
  128
+Thanks to Chris Wanstrath for his original work on Pjax. Thanks to Sam Stephenson and Josh Peek for their additional work on Pjax and Stacker and their help with getting Turbolinks released. Thanks to David Estes for handling the lion's share of post-release issues and feature requests. And thanks to everyone else who's fixed or reported an issue!
Commit_comment_tip

Tip: You can add notes to lines in a file. Hover to the left of a line to make a note

Something went wrong with that request. Please try again.