From 85e7d474c62cd89254fdad798a5482079679c5d3 Mon Sep 17 00:00:00 2001 From: Armel Larcier Date: Fri, 19 Jan 2018 11:06:39 +0100 Subject: [PATCH] Update README.md Fix #354 --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index fcfb0c5..6b429dc 100644 --- a/README.md +++ b/README.md @@ -237,6 +237,17 @@ Or, for the opposite effect, use something like @cihadturhan's [jQuery.aim](http $('#main').smoothState({ prefetchOn: 'aim' }); ``` +### `prefetchBubblesOn` + +The name of the events that are to bubble up to their parents when prefetching. + +```js +// Default +$('#main').smoothState({ prefetchBubblesOn: 'mouseover' }); +``` + +By default, `smoothState` will stop propagation of prefetch events. This allows you to customize events that will not be stopped by the prefetch handler. + ### `locationHeader` A field name to lookup among the headers from the HTTP response to alert smoothState.js of any redirected URL.