Events documentation

ryejs · Dec 25, 2012 · df7f661 · df7f661
1 parent 4e812f5
commit df7f661
Show file tree

Hide file tree

Showing 7 changed files with 395 additions and 282 deletions.
diff --git a/Cakefile b/Cakefile
@@ -20,8 +20,9 @@ api = [
     'collection'
     'manipulation'
     'style'
+    'event-emitter'
+    'dom-event-emitter'
     'events'
-    'dom-events'
     'touch-events'
     'util'
 ]
@@ -62,7 +63,7 @@ task 'build:readme', ->
         if weight is 1
             content += "\n### #{title}\n"
         else
-            content += "- [#{title}](http://ryejs.com##{id})\n"
+            content += "- [`#{title}`](http://ryejs.com##{id})\n"
 
     output = (get 'template/README.md')
         .replace('{{about}}', docs.get 'about')

diff --git a/README.md b/README.md
@@ -92,130 +92,134 @@ API
 
 
 ### Rye
-- [Constructor](http://ryejs.com#rye-constructor)
-- [Rye.define](http://ryejs.com#rye-ryedefine)
-- [Rye.require](http://ryejs.com#rye-ryerequire)
+- [`Constructor`](http://ryejs.com#rye-constructor)
+- [`Rye.define`](http://ryejs.com#rye-ryedefine)
+- [`Rye.require`](http://ryejs.com#rye-ryerequire)
 
 ### Data
-- [data](http://ryejs.com#data-data)
-- [@set](http://ryejs.com#data-@set)
-- [@get](http://ryejs.com#data-@get)
+- [`data`](http://ryejs.com#data-data)
+- [`@set`](http://ryejs.com#data-@set)
+- [`@get`](http://ryejs.com#data-@get)
 
 ### Traversal
-- [find](http://ryejs.com#traversal-find)
-- [index](http://ryejs.com#traversal-index)
-- [add](http://ryejs.com#traversal-add)
-- [pluckNode](http://ryejs.com#traversal-plucknode)
-- [next](http://ryejs.com#traversal-next)
-- [prev](http://ryejs.com#traversal-prev)
-- [siblings](http://ryejs.com#traversal-siblings)
-- [parent](http://ryejs.com#traversal-parent)
-- [parents](http://ryejs.com#traversal-parents)
-- [closest](http://ryejs.com#traversal-closest)
-- [children](http://ryejs.com#traversal-children)
+- [`find`](http://ryejs.com#traversal-find)
+- [`index`](http://ryejs.com#traversal-index)
+- [`add`](http://ryejs.com#traversal-add)
+- [`pluckNode`](http://ryejs.com#traversal-plucknode)
+- [`next`](http://ryejs.com#traversal-next)
+- [`prev`](http://ryejs.com#traversal-prev)
+- [`siblings`](http://ryejs.com#traversal-siblings)
+- [`parent`](http://ryejs.com#traversal-parent)
+- [`parents`](http://ryejs.com#traversal-parents)
+- [`closest`](http://ryejs.com#traversal-closest)
+- [`children`](http://ryejs.com#traversal-children)
 
 ### Filter
-- [filter](http://ryejs.com#filter-filter)
-- [has](http://ryejs.com#filter-has)
-- [is](http://ryejs.com#filter-is)
-- [not](http://ryejs.com#filter-not)
-- [first](http://ryejs.com#filter-first)
-- [last](http://ryejs.com#filter-last)
+- [`filter`](http://ryejs.com#filter-filter)
+- [`has`](http://ryejs.com#filter-has)
+- [`is`](http://ryejs.com#filter-is)
+- [`not`](http://ryejs.com#filter-not)
+- [`first`](http://ryejs.com#filter-first)
+- [`last`](http://ryejs.com#filter-last)
 
 ### Query
-- [@matches](http://ryejs.com#query-@matches)
-- [@qsa](http://ryejs.com#query-@qsa)
-- [@getClosestNode](http://ryejs.com#query-@getclosestnode)
+- [`@matches`](http://ryejs.com#query-@matches)
+- [`@qsa`](http://ryejs.com#query-@qsa)
+- [`@getClosestNode`](http://ryejs.com#query-@getclosestnode)
 
 ### Collection
-- [get](http://ryejs.com#collection-get)
-- [eq](http://ryejs.com#collection-eq)
-- [forEach](http://ryejs.com#collection-foreach)
-- [reduce](http://ryejs.com#collection-reduce)
-- [reduceRight](http://ryejs.com#collection-reduceright)
-- [indexOf](http://ryejs.com#collection-indexof)
-- [map](http://ryejs.com#collection-map)
-- [sort](http://ryejs.com#collection-sort)
-- [each](http://ryejs.com#collection-each)
-- [iterate](http://ryejs.com#collection-iterate)
-- [push](http://ryejs.com#collection-push)
-- [slice](http://ryejs.com#collection-slice)
-- [concat](http://ryejs.com#collection-concat)
-- [pluck](http://ryejs.com#collection-pluck)
-- [put](http://ryejs.com#collection-put)
+- [`get`](http://ryejs.com#collection-get)
+- [`eq`](http://ryejs.com#collection-eq)
+- [`forEach`](http://ryejs.com#collection-foreach)
+- [`reduce`](http://ryejs.com#collection-reduce)
+- [`reduceRight`](http://ryejs.com#collection-reduceright)
+- [`indexOf`](http://ryejs.com#collection-indexof)
+- [`map`](http://ryejs.com#collection-map)
+- [`sort`](http://ryejs.com#collection-sort)
+- [`each`](http://ryejs.com#collection-each)
+- [`iterate`](http://ryejs.com#collection-iterate)
+- [`push`](http://ryejs.com#collection-push)
+- [`slice`](http://ryejs.com#collection-slice)
+- [`concat`](http://ryejs.com#collection-concat)
+- [`pluck`](http://ryejs.com#collection-pluck)
+- [`put`](http://ryejs.com#collection-put)
 
 ### Manipulation
-- [text](http://ryejs.com#manipulation-text)
-- [html](http://ryejs.com#manipulation-html)
-- [empty](http://ryejs.com#manipulation-empty)
-- [append](http://ryejs.com#manipulation-append)
-- [prepend](http://ryejs.com#manipulation-prepend)
-- [after](http://ryejs.com#manipulation-after)
-- [before](http://ryejs.com#manipulation-before)
-- [clone](http://ryejs.com#manipulation-clone)
-- [val](http://ryejs.com#manipulation-val)
-- [attr](http://ryejs.com#manipulation-attr)
-- [prop](http://ryejs.com#manipulation-prop)
-- [@getValue](http://ryejs.com#manipulation-@getvalue)
-- [@getAttribute](http://ryejs.com#manipulation-@getattribute)
+- [`text`](http://ryejs.com#manipulation-text)
+- [`html`](http://ryejs.com#manipulation-html)
+- [`empty`](http://ryejs.com#manipulation-empty)
+- [`append`](http://ryejs.com#manipulation-append)
+- [`prepend`](http://ryejs.com#manipulation-prepend)
+- [`after`](http://ryejs.com#manipulation-after)
+- [`before`](http://ryejs.com#manipulation-before)
+- [`clone`](http://ryejs.com#manipulation-clone)
+- [`val`](http://ryejs.com#manipulation-val)
+- [`attr`](http://ryejs.com#manipulation-attr)
+- [`prop`](http://ryejs.com#manipulation-prop)
+- [`@getValue`](http://ryejs.com#manipulation-@getvalue)
+- [`@getAttribute`](http://ryejs.com#manipulation-@getattribute)
 
 ### Style
-- [show](http://ryejs.com#style-show)
-- [hide](http://ryejs.com#style-hide)
-- [css](http://ryejs.com#style-css)
-- [hasClass](http://ryejs.com#style-hasclass)
-- [addClass](http://ryejs.com#style-addclass)
-- [removeClass](http://ryejs.com#style-removeclass)
-- [toggleClass](http://ryejs.com#style-toggleclass)
-- [@getCSS](http://ryejs.com#style-@getcss)
-- [@setCSS](http://ryejs.com#style-@setcss)
-- [@hasClass](http://ryejs.com#style-@hasclass)
-- [@addClass](http://ryejs.com#style-@addclass)
-- [@removeClass](http://ryejs.com#style-@removeclass)
+- [`show`](http://ryejs.com#style-show)
+- [`hide`](http://ryejs.com#style-hide)
+- [`css`](http://ryejs.com#style-css)
+- [`hasClass`](http://ryejs.com#style-hasclass)
+- [`addClass`](http://ryejs.com#style-addclass)
+- [`removeClass`](http://ryejs.com#style-removeclass)
+- [`toggleClass`](http://ryejs.com#style-toggleclass)
+- [`@getCSS`](http://ryejs.com#style-@getcss)
+- [`@setCSS`](http://ryejs.com#style-@setcss)
+- [`@hasClass`](http://ryejs.com#style-@hasclass)
+- [`@addClass`](http://ryejs.com#style-@addclass)
+- [`@removeClass`](http://ryejs.com#style-@removeclass)
 
 ### Event Emitter
-- [addListener (on)](http://ryejs.com#eventemitter-addlisteneron)
-- [once](http://ryejs.com#eventemitter-once)
-- [removeListener](http://ryejs.com#eventemitter-removelistener)
-- [emit](http://ryejs.com#eventemitter-emit)
-- [proxy](http://ryejs.com#eventemitter-proxy)
-- [Rye.subscribe](http://ryejs.com#eventemitter-ryesubscribe)
-- [Rye.unsubscribe](http://ryejs.com#eventemitter-ryeunsubscribe)
-- [Rye.publish](http://ryejs.com#eventemitter-ryepublish)
+- [`addListener (on)`](http://ryejs.com#eventemitter-addlisteneron)
+- [`once`](http://ryejs.com#eventemitter-once)
+- [`removeListener`](http://ryejs.com#eventemitter-removelistener)
+- [`trigger`](http://ryejs.com#eventemitter-trigger)
+- [`proxy`](http://ryejs.com#eventemitter-proxy)
 
 ### DOM Event Emitter
-- [addListener (on)](http://ryejs.com#domeventemitter-addlisteneron)
-- [once (one)](http://ryejs.com#domeventemitter-onceone)
-- [removeListener (off)](http://ryejs.com#domeventemitter-removelisteneroff)
-- [trigger](http://ryejs.com#domeventemitter-trigger)
-- [prototype.addListener (on)](http://ryejs.com#domeventemitter-prototypeaddlisteneron)
-- [prototype.once (one)](http://ryejs.com#domeventemitter-prototypeonceone)
-- [prototype.removeListener (off)](http://ryejs.com#domeventemitter-prototyperemovelisteneroff)
-- [prototype.destroy](http://ryejs.com#domeventemitter-prototypedestroy)
-- [prototype.trigger](http://ryejs.com#domeventemitter-prototypetrigger)
-- [@addListener (on)](http://ryejs.com#domeventemitter-@addlisteneron)
-- [@once (one)](http://ryejs.com#domeventemitter-@onceone)
-- [@removeListener (off)](http://ryejs.com#domeventemitter-@removelisteneroff)
-- [@trigger](http://ryejs.com#domeventemitter-@trigger)
-- [@getEmitter](http://ryejs.com#domeventemitter-@getemitter)
-- [@createEvent](http://ryejs.com#domeventemitter-@createevent)
+- [`addListener (on)`](http://ryejs.com#domeventemitter-addlisteneron)
+- [`once (one)`](http://ryejs.com#domeventemitter-onceone)
+- [`removeListener (off)`](http://ryejs.com#domeventemitter-removelisteneroff)
+- [`destroy`](http://ryejs.com#domeventemitter-destroy)
+- [`trigger`](http://ryejs.com#domeventemitter-trigger)
+- [`emit`](http://ryejs.com#domeventemitter-emit)
+- [`proxy`](http://ryejs.com#domeventemitter-proxy)
+
+### Events
+- [`addListener (on)`](http://ryejs.com#events-addlisteneron)
+- [`once`](http://ryejs.com#events-once)
+- [`removeListener`](http://ryejs.com#events-removelistener)
+- [`trigger`](http://ryejs.com#events-trigger)
+- [`@getEmitter`](http://ryejs.com#events-@getemitter)
+- [`@createEvent`](http://ryejs.com#events-@createevent)
+- [`@addListener (@on)`](http://ryejs.com#events-@addlistener@on)
+- [`@once`](http://ryejs.com#events-@once)
+- [`@removeListener`](http://ryejs.com#events-@removelistener)
+- [`@trigger`](http://ryejs.com#events-@trigger)
+- [`Rye.subscribe`](http://ryejs.com#events-ryesubscribe)
+- [`Rye.unsubscribe`](http://ryejs.com#events-ryeunsubscribe)
+- [`Rye.publish`](http://ryejs.com#events-ryepublish)
 
 ### Touch Events
 
 ### Util
-- [@extend](http://ryejs.com#util-@extend)
-- [@inherits](http://ryejs.com#util-@inherits)
-- [@isElement](http://ryejs.com#util-@iselement)
-- [@isNodeList](http://ryejs.com#util-@isnodelist)
-- [@unique](http://ryejs.com#util-@unique)
-- [@pluck](http://ryejs.com#util-@pluck)
-- [@put](http://ryejs.com#util-@put)
-- [@prefix](http://ryejs.com#util-@prefix)
-- [@applier](http://ryejs.com#util-@applier)
-- [@curry](http://ryejs.com#util-@curry)
-- [@getUid](http://ryejs.com#util-@getuid)
-- [@type](http://ryejs.com#util-@type)
-- [@is](http://ryejs.com#util-@is)
+- [`@extend`](http://ryejs.com#util-@extend)
+- [`@inherits`](http://ryejs.com#util-@inherits)
+- [`@isElement`](http://ryejs.com#util-@iselement)
+- [`@isNodeList`](http://ryejs.com#util-@isnodelist)
+- [`@unique`](http://ryejs.com#util-@unique)
+- [`@pluck`](http://ryejs.com#util-@pluck)
+- [`@put`](http://ryejs.com#util-@put)
+- [`@prefix`](http://ryejs.com#util-@prefix)
+- [`@applier`](http://ryejs.com#util-@applier)
+- [`@curry`](http://ryejs.com#util-@curry)
+- [`@getUid`](http://ryejs.com#util-@getuid)
+- [`@type`](http://ryejs.com#util-@type)
+- [`@is`](http://ryejs.com#util-@is)
 
 
 <hr>

diff --git a/docs/dom-event-emitter.md b/docs/dom-event-emitter.md
@@ -0,0 +1,59 @@
+DOM Event Emitter
+==================
+
+One heritage of event emitter, this handler native DOM events. Use with `var DOMEventEmitter = Rye.require('Events').DOMEventEmitter`.
+
+To intanciate one emitter you do `var emitter = new DOMEventEmitter(element)`.
+
+
+addListener (on)
+------------------
+<div class="api">
+    emitter.addListener(name, fn) <span>⇒ self</span><br>
+    emitter.on(element, name, fn) <span>⇒ self</span>
+</div>
+
+
+once (one)
+------------------
+<div class="api">
+    emitter.once(name, fn) <span>⇒ self</span><br>
+    emitter.one(name, fn) <span>⇒ self</span>
+</div>
+
+
+removeListener (off)
+------------------
+<div class="api">
+    emitter.removeListener(name[, fn]) <span>⇒ self</span><br>
+    emitter.off(name[, fn]) <span>⇒ self</span>
+</div>
+
+
+destroy
+------------------
+<div class="api">
+    emitter.destroy() <span>⇒ self</span>
+</div>
+
+
+trigger
+------------------
+<div class="api">
+    emitter.trigger(name[, data]) <span>⇒ self</span>
+</div>
+
+
+emit
+------------------
+<div class="api">
+    emitter.trigger(name[, data]) <span>⇒ self</span>
+</div>
+
+
+proxy
+------------------
+<div class="api">
+    emitter.proxy(name) <span>⇒ function</span>
+</div>
+