Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added more info about the different versions #13

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added more info about the different versions #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,19 @@ For more information about the FLIP technique, view the flipping slides:
npm install flipping@latest --save
```

- `flipping.js`: tiny and low-level; only emits events when element bounds change
- `flipping.web.js`: uses [WAAPI](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API) to animate transitions. _For older browsers a [Polyfill](https://github.com/web-animations/web-animations-js) might be needed._
- `flipping.gsap.js`: uses [GSAP](https://greensock.com/) to animate transitions
- _More adapters coming soon!_


Or grab the files directly:
- https://unpkg.com/flipping@latest/dist/flipping.js (core)
- https://unpkg.com/flipping@latest/dist/flipping.web.js (WAAPI adapter)
- https://unpkg.com/flipping@latest/dist/flipping.gsap.js (GASP adapter)
- 🔜 https://unpkg.com/flipping@latest/dist/flipping.css.js (CSS adapter - WIP!)


## Quick Start

In your HTML, add the `data-flip-key="..."` attribute to shared elements (see HTML example below).
Expand Down