Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eduardo-matos/onx
Extensions to the dojo event system
https://github.com/eduardo-matos/onx
Last synced: about 1 month ago
JSON representation
Extensions to the dojo event system
- Host: GitHub
- URL: https://github.com/eduardo-matos/onx
- Owner: eduardo-matos
- Created: 2013-09-21T15:11:35.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2014-09-20T17:57:06.000Z (about 10 years ago)
- Last Synced: 2024-09-11T14:12:15.852Z (2 months ago)
- Language: JavaScript
- Size: 203 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ONX
_Buffer_ and _delay_ extensions to Dojo modules that handle events, like `dojo/on`, `dojo/topic`, `dojo/aspect` and `dojo/NodeList`.
## How to use
### onx/on/delay
Delays an event by a specific amount of time in milliseconds.
```javascript
require(['dojo/dom', 'onx/on/delay'], function (dom, delay) {
var element = dom.byId('some-id');
delay(element, 'click', function () {
// this function will be called 200ms
// after the actual click.
}, 200);
});
```
### onx/on/buffer
Buffers an event by a specific amount of time in milliseconds.
```javascript
require(['dojo/dom', 'onx/on/buffer'], function (dom, buffer) {
var element = dom.byId('some-id');
buffer(element, 'click', function () {
// this function will be called
// at most once every 200ms
}, 200);
});
```
### onx/topic/delay
Delays a topic callback by a specific amount of time in milliseconds.
```javascript
require(['dojo/topic', 'onx/topic/delay'], function (topic, delay) {
delay('/abc', function () {
// this function will be called 200ms
// after the actual topic publish.
}, 200);
topic.publish('/abc');
});
```
### onx/topic/buffer
Buffers a topic by a specific amount of time in milliseconds.
```javascript
require(['dojo/topic', 'onx/topic/buffer'], function (topic, buffer) {
buffer('/abc', function () {
// this function will be called
// at most once every 200ms
}, 200);
topic.publish('/abc');
topic.publish('/abc');
});
```
### onx/aspect/delay
Delays an aspect callback by a specific amount of time in milliseconds.
```javascript
require(['dojo/aspect', 'onx/aspect/delay'], function (aspect, delay) {
var foo = {
bar: function () {}
};
delay(foo, 'bar', function () {
// this function will be called 200ms
// after 'foo.bar' execution.
}, false, 200);
foo.bar();
});
```
### onx/aspect/buffer
Buffers an aspect by a specific amount of time in milliseconds.
```javascript
require(['dojo/aspect', 'onx/aspect/buffer'], function (aspect, buffer) {
var foo = {
bar: function () {}
};
buffer(foo, 'bar', function () {
// this function will be called
// at most once every 200ms
}, false, 200);
foo.bar();
foo.bar();
});
```
_Ps.: Both `onx/aspect/delay` and `onx/aspect/buffer` are attached to `aspect.after` method._
### onx/NodeList/delay
Adds `onx/on/delay` extension to `dojo/NodeList`.
```javascript
require(['dojo/query', 'onx/NodeList/delay'], function (query) {
query('#some-id').delay('click', function () {
// this function will be called 200ms
// after the actual click.
}, 200);
});
```
### onx/NodeList/buffer
Adds `onx/on/buffer` extension to `dojo/NodeList`.
```javascript
require(['dojo/query', 'onx/NodeList/buffer'], function (query) {
query('#some-id').buffer('click', function () {
// this function will be called
// at most once every 200ms
}, 200);
});
```
### Canceling callback execution
It's possible to cancel the callback execution on both _delay_ and _buffer_ modules.
You just need to call `handle.cancel` like the following example.
```javascript
require(['dojo/dom', 'onx/on/buffer'], function (dom, buffer) {
var element = dom.byId('some-id');
var handle = buffer(element, 'click', function () {
// this function will be called
// at most once every 200ms
}, 200);
// forcing event emission
on.emit(element, 'click', {bubbles: true});
// callback won't be called
handle.cancel();
});
```
### Function signatues
With the exception of the last parameter, all functions have the same signature as their "parents"
* `onx/on/delay` and `onx/on/buffer` signature === `dojo/on` signature + 1 parameter (delay or buffer)
* `onx/topic/delay` and `onx/topic/buffer` signature === `dojo/topic` signature + 1 parameter (delay or buffer)
* `onx/aspect/delay` and `onx/aspect/buffer` signature === `dojo/aspect::after` signature + 1 parameter (delay or buffer)
* `onx/NodeList/delay` and `onx/NodeList/buffer` signature === `dojo/NodeList::on` signature + 1 parameter (delay or buffer)
Things are done this way to keep it simple to swap modules.
## Unit testing
To run the unit tests, make sure you install all dependencies (`bower install && npm install`).
You must have a webserver running. It's ok to use Python (`python -m SimpleHTTPServer 8080`) or PHP (`PHP -S localhost:8080`) to create a development server. Then head to `http://localhost:8080/node_modules/intern/client.html?config=tests/intern` and take a look at your browser console.
All unit tests are located at the tests directory.
## License
Licensed under MIT.
Copyright (C) 2013 Eduardo de Matos [email protected]
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.