docclick

returns document click events to a function

npm install docclick
2 downloads in the last week
2 downloads in the last month

docclick

(c)Bumblehead, 2013 MIT-license

Overview:

docclick returns document click events to a function. You may want content-embedded links to render modals or page transitions. Attach a listener to the document, once, and return click events to a function handling this.

docclick only returns click events from <a> elements or elements that are childed to an <a> element.

docclick().filter(function (e, elem) {
    return elem.className.match(/popup/i);
}).onClick(function (e, elem) {
    doSomething();
    return e.preventDefault(); 
});

docclick does not use a popular library like jQuery to interface with the DOM. Instead, it uses purpose-built modules I've made -eventhook, domev, lsn. With the modules its minified size is ~5.2kb. Without the modules, its minified size is ~2.4kb. Modules are isolated on public docclick methods and may be redefined with methods using jQuery or any library.


Get Started:

  1. call a function if it passes a filter function

    docclick().filter(function (e, elem) {
     return elem.className.match(/popup/i);
    }).onClick(function (e, elem) {
     doSomething(e, elem);
    });
    

Install:

docclick may be downloaded directly or installed through npm.

  • npm

    $ npm install docclick
    
  • Direct Download

    $ git clone https://github.com/iambumblehead/docclick.git
    $ cd docclick && npm install
    

Test:

Tests are not automated and are performed by loading a document in the browser and using the browser console.

  1. build test files

    npm start

  2. load test/index.html in your browser and run tests from the console


License:

scrounge

(The MIT License)

Copyright (c) 2013 Bumblehead chris@bumblehead.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.

npm loves you