Add events. Closes CodeByZach#44

Author: Zack Bloom

docs/intro.md

@@ -166,6 +166,23 @@ whenever `pushState` or `replaceState` is called by default.
 
 - `Pace.ignore`: Expliticly ignore one or more requests, see Tracking below
 
+Events
+------
+
+Pace fires the following events:
+
+- `start`: When pace is initially started, or as a part of a restart
+- `stop`: When pace is manually stopped, or as a part of a restart
+- `restart`: When pace is restarted (manually, or by a new AJAX request)
+- `done`: When pace is finished
+- `hide`: When the pace is hidden (can be later than `done`, based on `ghostTime` and `minTime`)
+
+You can bind onto events using the `on`, `off` and `once` methods:
+
+- `Pace.on(event, handler, [context])`: Call `handler` (optionally with context) when `event` is triggered
+- `Pace.off(event, [handler])`: Unbind the provided `event` and `handler` combination.
+- `Pace.once(event, handler, [context])`: Bind `handler` to the next (and only the next) incidence of `event`
+
 Tracking
 --------
 

pace.coffee

@@ -135,8 +135,45 @@ getFromDOM = (key='options', json=true) ->
   catch e
     console?.error "Error parsing inline pace options", e
 
+class Evented
+  on: (event, handler, ctx, once=false) ->
+    @bindings ?= {}
+    @bindings[event] ?= []
+    @bindings[event].push {handler, ctx, once}
+
+  once: (event, handler, ctx) ->
+    @on(event, handler, ctx, true)
+
+  off: (event, handler) ->
+    return unless @bindings?[event]?
+
+    if not handler?
+      delete @bindings[event]
+    else
+      i = 0
+      while i < @bindings[event].length
+        if @bindings[event][i].handler is handler
+          @bindings[event].splice i, 1
+        else
+          i++
+
+  trigger: (event, args...) ->
+    if @bindings?[event]
+      i = 0
+      while i < @bindings[event].length
+        {handler, ctx, once} = @bindings[event][i]
+
+        handler.apply(ctx ? @, args)
+
+        if once
+          @bindings[event].splice i, 1
+        else
+          i++
+
 window.Pace ?= {}
 
+extend Pace, Evented::
+
 options = Pace.options = extend defaultOptions, window.paceOptions, getFromDOM()
 
 class NoTargetError extends Error
@@ -572,6 +609,7 @@ do init = ->
   uniScaler = new Scaler
 
 Pace.stop = ->
+  Pace.trigger 'stop'
   Pace.running = false
 
   bar.destroy()
@@ -586,6 +624,7 @@ Pace.stop = ->
   init()
 
 Pace.restart = ->
+  Pace.trigger 'restart'
   Pace.stop()
   Pace.start()
 
@@ -632,10 +671,14 @@ Pace.go = ->
     if bar.done() or done or cancelAnimation
       bar.update 100
 
+      Pace.trigger 'done'
+
       setTimeout ->
         bar.finish()
 
         Pace.running = false
+
+        Pace.trigger 'hide'
       , Math.max(options.ghostTime, Math.min(options.minTime, now() - start))
     else
       enqueueNextFrame()
@@ -653,6 +696,7 @@ Pace.start = (_options) ->
   if not document.querySelector('.pace')
     setTimeout Pace.start, 50
   else
+    Pace.trigger 'start'
     Pace.go()
 
 if typeof define is 'function' and define.amd