Browse Source

Update docs and CHANGELOG

master^2
dustinlarimer 7 years ago
parent
commit
a4fc37427f
  1. 6
      CHANGELOG.md
  2. 2
      docs/auto-tracking.md

6
CHANGELOG.md

@ -11,10 +11,14 @@
# 1.3.0 Automated Event Tracking (browser-only)
**NEW:**
* Ported functionality from the Web Auto Collector into this SDK: The interface and behaviors of this feature are a little different, but the data models produced are backward compatible
* Ported functionality from the Web Auto Collector into this SDK: The interface and behaviors of this feature are a little different, but the data models produced are backward compatible (#83)
* New helper: `Keen.helpers.getScrollState()`: Return an object of properties profiling the current scroll state, and optionally pass this object back into the helper again to receive a new object with updated `pixel_max` and `ratio_max` values
* New helper: `Keen.helper.getDomNodeProfile(<ELEMENT>)`: Return an object containing properties profiling a given DOM node
* New utility: `Keen.utils.serializeForm(<FORM>, OPTIONS)`: Serialize the data of a form, with the option to ignore certain input types by passing in a `{ ignoreTypes: ['password'] }` option
**FIXED:**
* Wrap `JSON.parse()` in a `try/catch` block to mitigate error impact when the API returns un-parsable contents (#88)
**UPDATED:**
* Description meta tag content is now part of the `Keen.helpers.getBrowserProfile()` output when present

2
docs/auto-tracking.md

@ -38,6 +38,8 @@ client.initAutoTracking({
});
```
Scroll state tracking powered by the `getScrollState()` helper and a `window` scroll listener. This scroll listener can be removed by calling `Keen.utils.listener('window').off('scroll');`.
### Customization
Add additional properties to any or all events with [`extendEvent` or `extendEvents` methods](./extend-events.md):

Loading…
Cancel
Save