https://github.com/developit/puredom-sync
Synchronous chaining plugin for puredom.
https://github.com/developit/puredom-sync
Last synced: 3 months ago
JSON representation
Synchronous chaining plugin for puredom.
- Host: GitHub
- URL: https://github.com/developit/puredom-sync
- Owner: developit
- License: bsd-3-clause
- Created: 2013-02-24T23:52:41.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2017-05-17T06:32:05.000Z (over 8 years ago)
- Last Synced: 2025-09-12T00:45:40.379Z (4 months ago)
- Language: JavaScript
- Homepage: http://puredom.org/plugins/sync
- Size: 11.7 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
puredom-sync [](https://www.npmjs.org/package/puredom-sync) ⎔ [](https://travis-ci.org/developit/puredom-sync)
=============
A [puredom](http://puredom.org) plugin that lets you chain sequential asynchronous functions.
---
What it Does
------------
Normally, puredom's chained selection functions run in parallel (asynchronously). They
do not wait for pending operations to finish before moving on to the next chained call.
This is ideal for many cases, but it can become cumbersome when chaining animation callbacks.
To solve this problem, puredom.async adds a few selector functions: `sync()`, `async()` and `then()`.
`.sync()`: Run everything in the order I say
--------------------------------------------
`.sync()` switches the chain into "sync" mode. In this mode,
all chained selection functions you call will run **in order**.
```JavaScript
puredom('.foo') // anything that returns a selection
.sync() // switch the chain to sync mode
.fadeOut('slow') // fade out the selection
.fadeIn('fast') // `-> fade the selection back in
.hide(); // `-> finally, hide the selection
```
`.async()`: Run everything at once
----------------------------------
`.async()` reverts the chain back to puredom's normal (asynchronous) mode.
```JavaScript
// selection in sync mode:
var sel = puredom('.foo').sync();
// these animations run sequentially:
sel.fadeIn().fadeOut();
// back to async: (this runs prior to the animations!)
console.log(sel.async().width());
```
`.then()`: Let me know when sync() is done
------------------------------------------
`.then()` lets you specify a function to call once the synchronous
chain's current operations have finished executing:
```JavaScript
puredom('.foo').sync().fadeIn().fadeOut().then(function() {
alert("fade in and out have completed");
});
```
---
License
=======
BSD 3-Clause, see `LICENSE`.