Preserve ability to disable analytics behavior, explicitly document this option

This commit is contained in:
Robin North
2018-01-24 11:26:13 +00:00
parent cc384b9b16
commit f642eec047
3 changed files with 27 additions and 30 deletions

View File

@@ -371,12 +371,14 @@ Enable pushState. Only disable if you are crazy.
Internaly, this option is used when `popstate` is used (to not pushState again).
You should forget that option.
##### `analytics` (Function, default to a function that push `_gaq` `trackPageview` or send `ga` `pageview`
##### `analytics` (Function|Boolean, default to a function that pushes `_gaq` `_trackPageview` or sends `ga` `pageview`
Function that allow you to add behavior for analytics. By default it try to track
Function that allows you to add behavior for analytics. By default it tries to track
a pageview with Google Analytics.
It's called every time a page is switched, even for history buttons.
Set to `false` to disable this behavior.
##### `scrollTo` (Integer, default to 0)
Value (in px) to scrollTo when a page is switched.
@@ -543,4 +545,3 @@ Clone this repository and run `npm run example`, which will open the example app
## [CHANGELOG](CHANGELOG.md)
## [LICENSE](LICENSE)