Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
..
Failed to load latest commit information.
test
README.md
pilotfish-blower.js

README.md

About

Pilotfish quality rating: 1 fish

This is a core plugin for the Pilotfish user experience toolkit, that aims to figure out when a user is having problems, and report that as a javascript event. In other words, blower makes your application suck less. When combined with recorder, can feed into your analytics platform!

Events:

  • hash_change_no_pointer - The hash of the page changed, but the recent click wasn't a pointer
  • url_change_no_pointer - The user left the page, but the last element they clicked on wasn't a pointer
  • click_js_error - a user click resulted in a javascript error
  • multiple_reload - User has reloaded the current page 3 times
  • click_pause_click - user clicked on something, waited, and then clicked again
    • default settings are 1 and 15 seconds for the min/max amount of time between clicks, to change this: Pilotfish('recorder', 'init', {click_pause_click:

Usage

This plugin is a core plugin of pilotfish, and as such these instructions assume you already have pilotfish on your page.

Pilotfish('require', 'blower');
Pilotfish('on', 'plugins:blower', function(evt, data){
    // data.name will be the event
});

To record the activity using Pilotfish recorder and have it feed into your analytics platform:

Pilotfish('require', 'blower');
Pilotfish('require', 'recorder');
Pilotfish('recorder', 'init', {
    backends: {
        'google-analytics': {"accountid": "UA-XXXXXXX-1"},
        'quantcast': {"accountid": "p-XXXXXXX-1"},
        'mixpanel': {"accountid": "aaaaaaaaaaaaaaaaaaaaaaa"}
    }
});

To disable any specific event, you can set it to false in the init:

Pilotfish('recorder', 'init', {click_pause_click: false});

Download/hosting

The source is hosted on a CDN for your convenience. You may point your script tag there (which will also give you the latest stable updates as we release them), or you may download it and host it yourself.

http://cdn.pilotfish.io/client/plugins/blower/pilotfish-blower.js

Issues/Requests/Support

We want you to have a good experience, too. :)

Please check out the existing issues, and if you don't see that your problem is already being worked on, please file an issue

History

0.6.0
  • Pass additional data to the recorder plugin
    • pathname
    • click target, serialized with Pilotfish('selector')
  • New event: click_pause_click
0.5.3
  • The great whitespace cleanup of 2012
0.5.2
  • Fix for extension of default settings
0.5.1

0.5.0

  • Use built in serialization via Pilotfish('selector')
  • Much improved test coverage

0.4.0

  • Rename from 'unstuck', to be more positive and a verb
  • Rewrite to use latest Pilotfish plugin API
  • Tests with casperjs (much improved)

0.3.0

  • click_js_error event
  • multiple_reload event

0.2.0

  • Update for Pilotfish 0.5.0 (unload event)
  • url_change_no_pointer event

0.1.0

  • MVP
  • hash_change_no_pointer event

Contributing

Would you like to help out? We need:

Development

See the pilotfish development guide

License

All core plugins for Pilotfish are licensed under the same license as Pilotfish (MIT) see LICENSE