Commit 83b6175

authored

Merge pull request #900 from mendelk/document-local-turbolinks

📝 Document integrating with Turbolinks when imported with Webpacker

2 parents 467cbd8 + 018812c commit 83b6175Copy full SHA for 83b6175

File tree

+13

-0

lines changed

+13

-0

lines changed

Lines changed: 13 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -310,6 +310,19 @@ ReactRailsUJS.detectEvents()`
`310`	`310`
`311`	`311`	For example, if `Turbolinks` is loaded _after_ `ReactRailsUJS`, you'll need to call this again. This function removes previous handlers before adding new ones, so it's safe to call as often as needed.
`312`	`312`
	`313`	+If `Turbolinks` is `import`ed via Webpacker (and thus not available globally), `ReactRailsUJS` will be unable to locate it. To fix this, you can temporarily add it to the global namespace:
	`314`	`+`
	`315`	+```js
	`316`	`+// Order is particular. First start Turbolinks:`
	`317`	`+Turbolinks.start();`
	`318`	`+// Add Turbolinks to the global namespace:`
	`319`	`+window.Turbolinks = Turbolinks;`
	`320`	`+// Remove previous event handlers and add new ones:`
	`321`	`+ReactRailsUJS.detectEvents();`
	`322`	`+// (Optional) Clean up global namespace:`
	`323`	`+delete window.Turbolinks;`
	`324`	+```
	`325`	`+`
`313`	`326`	### `getConstructor`
`314`	`327`
`315`	`328`	Components are loaded with `ReactRailsUJS.getConstructor(className)`. This function has two built-in implementations:

Comments

(0)