swup
Version:
Complete, flexible, extensible and easy to use page transition library for your web.
39 lines (31 loc) • 2.25 kB
Markdown
<p align="center"><img width="420" alt="swup" src="https://swup.js.org/assets/images/swup-logo.svg"></p>
<p align="center">
Complete, flexible, extensible and easy to use page transition library for your web.
</p>
<p align="center">
<a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/v/swup.svg" alt="npm version"></a>
<img src="https://img.shields.io/bundlephobia/minzip/swup.svg" alt="Gzip Size">
<a href="https://github.com/gmrchk/swup/blob/master/LICENSE"><img src="https://img.shields.io/github/license/gmrchk/swup.svg" alt="License"></a>
<a href="https://www.npmjs.com/package/swup"><img src="https://img.shields.io/npm/dt/swup.svg" alt="npm downloads"></a>
</p>
Looking for **what's new in v2**? Head over [here](https://medium.com/@gmarcuk/introducing-swup-v2-814e40316dee).
Still wanna check v1? Get it from npm with `npm install swup@1.9.0` or check old docs [here](https://github.com/swup/swup/tree/33367a1072f8b5ebc646d7e0ca338a811b53a41d).
- [Docs](https://swup.js.org/getting-started)
- [Example](https://swup.js.org/getting-started/example)
- [Demo](https://swup.js.org/getting-started/demo)
- [Reloading javascript](https://swup.js.org/getting-started/reloading-javascript)
- [Options](https://swup.js.org/options)
- [Events](https://swup.js.org/events)
- [Plugins](https://swup.js.org/plugins)
- [Themes](https://swup.js.org/themes)
- [CLI](https://swup.js.org/cli)
- [Contributions](https://swup.js.org/contributions)
If you're having trouble implementing swup, checkout [Common Issues](https://swup.js.org/common-issues), [Closed Issues](https://github.com/gmrchk/swup/issues?q=is%3Aissue+is%3Aclosed) or open a [new one](https://github.com/gmrchk/swup/issues/new).
In case you'd like to checkout some of the code, all the repositories can be found under [swup organization](https://github.com/swup).
[Become a backer or sponsor on Open Collective](https://opencollective.com/swup)
<p>
<a href="https://opencollective.com/swup/donate">
<img src="https://opencollective.com/swup/donate/button@2x.png?color=blue" width=300 />
</a>
</p>
<img src="https://user-images.githubusercontent.com/9338324/49190360-50125480-f372-11e8-89e9-d2fb091a2240.gif" width="100%">