gully

0.2.1 • Public • Published

Gully

DOM event handler based on sewer, perfect to use as directive with you favorite MV* library.

Gully has been built for brick and wall. However, Gully is agnostic and trivial enough to be reused seperately or with other directive-like libraries.

Installation

with component:

$ component install bredele/gully

with browserify:

$ npm install gully

Standalone

Gully can be used as a standalone library (see API).

You can merge an object with gully (aka gullying):

var events = require('gully');
var obj = {
  handler : function() {
    // do something on click
  },
  other : function() {
    // do something else
  }
};
 
events(obj);
obj.attach(document.body, 'click', 'handler');

or return a new object:

var handler = events(obj, false);
 
// execute other in obj
handler.attach(document.body, 'mousedown', 'other');
 
handler.attach(el, 'keypress', function() {
  // do something outside of obj
});

Gully also supports event delegation, filtering, chaining and touch mapping. See sewer for more details.

Brick

Gully can be used as a plugin for brick and allows you to declaratively attach event listeners to your dom:

JavaScript:

var events = require('gully');
brick(el)
  .use(events.brick(obj));

HTML:

<div on-click="handler"></div>

Note: Gully automatically map desktop events (such as click, mousedown/up/move) with touch events (such as touchstart/end/move) if you are on a mobile device.

Wall

Gully can be composed with wall to attach event listeners programatically.

JavaScript:

var events = require('gully');
var app = wall();
 
app.use(events);
app.attach(el, 'click', function() {
  // do something on click
});

License

The MIT License (MIT)

Copyright (c) 2014 Olivier Wietrich olivier.wietrich@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i gully

Weekly Downloads

0

Version

0.2.1

License

MIT

Last publish

Collaborators

  • bredele