Zepto.js – a minimalist JavaScript library
Zepto is a minimalist JavaScript library for modern browsers with a largely jQuery-compatible API. If you use jQuery, you already know how to use Zepto.
See zeptojs.com for an extended introduction, downloads and documentation.
Zepto.js is licensed under the terms of the MIT License.
Building
The official site offers a download of the default distribution of Zepto. This is good for starting out. However, at some point you might want to add some optional modules and remove some of the default ones you don't need, to keep the size at minimum. That's when you need to check out Zepto's source code and use the build commands.
You will need Node.js installed on your system.
$ npm install
$ npm run-script dist
The resulting files are:
dist/zepto.js
dist/zepto.min.js
If you install CoffeeScript globally, you can run make
directly:
$ coffee make dist
$ MODULES="zepto event data ..." ./make dist
Zepto modules
Zepto modules are individual files in the "src/" directory.
module | default | description |
---|---|---|
polyfill | Provides String.prototype.trim and Array.prototype.reduce methods if they are missing (required for iOS 3.x) | |
zepto | Core module; contains most methods | |
event | Event handling via on() & off() |
|
detect | Provides $.os and $.browser information |
|
fx | The animate() method |
|
fx_methods |
Animated show , hide , toggle ,
and fade*() methods.
|
|
ajax | XMLHttpRequest and JSONP functionality | |
form | Serialize & submit web forms | |
assets | Experimental support for cleaning up iOS memory after removing image elements from the DOM. | |
data |
A full-blown data() method, capable of storing arbitrary
objects in memory.
|
|
selector |
Experimental jQuery
CSS extensions support for functionality such as $('div:first') and
el.is(':visible') .
|
|
touch | Fires tap– and swipe–related events on touch devices | |
gesture | Fires pinch gesture events on touch devices | |
stack | Provides andSelf & end() chaining methods |
Contributing
Get in touch:
- IRC channel: #zepto on freenode.net
- @zeptojs
Write documentation
Zepto docs are written in Markdown and live in the "gh-pages" branch. They are published on zeptojs.com.
You can use GitHub's web interface to make quick changes to documentation for specific Zepto features (example: ajaxSettings). This will submit a pull request to us that we can review.
Report a bug
- Check if the bug is already fixed in the master branch since the last release.
- Check existing issues. Open a new one, including exact browser & platform information. For better formatting of your report, see GitHub-flavored Markdown.
Running tests
You will need to install PhantomJS. On OS X, that's easy:
$ brew install phantomjs
To run the test suite, these are all equivalent:
$ npm test
$ ./make test
$ script/test