auto-animate README

The project's README from github.com/formkit/auto-animate. As one markdown file: README.md.

AutoAnimate Logo

Latest Build GitHub Sponsors

Add motion to your apps with a single line of code.

AutoAnimate is a zero-config, drop-in animation utility that adds smooth transitions to your web app. You can use it with Vue, React, Solid or any other JavaScript application.

Examples & Docs

With one line of code, you can improve your interfaces, for example:

Simple example of AutoAnimation motion

Installation

Install using your package manager of choice.

# yarn
yarn add @formkit/auto-animate
# npm
npm install @formkit/auto-animate
# pnpm
pnpm add @formkit/auto-animate

Boom! Done. That was fast! ๐Ÿ‡

Usage

๐Ÿ“– View the documentation site for usage instructions.

Examples

๐Ÿ“– View the documentation site for examples.

Plugins

๐Ÿ“– View the documentation site for plugin instructions.

Support us

Is AutoAnimate saving you time?

Please consider supporting us with a recurring or one-time donation! ๐Ÿ™

Contributing

Thank you for your willingness to contribute to this free and open source project! When contributing, consider first discussing your desired change with the core team via GitHub issues, Discord, or other method.

auto-animate (formkit/auto-animate)

Searching Databaseโ€ฆ

13.9K ยทGitHub
What is this?AutoAnimate is a zero-config, drop-in animation utility that adds smooth transitions to your web app with a single line of code.
Is this a big animation framework, or a small library I drop into an existing app?It is a small drop-in library, not a framework: you add it to an existing app, and it ships with no dependencies of its own.
How do I add it to my project?Install it with your package manager of choice, then enable it with a single line of code in your app; the documentation site walks through the exact usage.
Do I have to be using a particular framework for it to work?No. It works with Vue, React, and Solid, and with any other JavaScript application, so framework-less projects are fine too.
Does this live in my browser code, or do I run something on a server?It lives entirely in your front-end code: it animates the web app's interface in the browser, so there is nothing to install or run server-side.
What does 'zero-config' mean in practice?You don't configure anything: install the package, add one line of code, and your interfaces get smooth transitions out of the box.
Where do I find usage examples and plugin instructions?The README itself stays minimal and points to the documentation site, which covers usage instructions, examples, and plugin setup.
Is AutoAnimate free, and how is it supported?It is a free and open source project; the team asks users who find it saves them time to support it with a recurring or one-time donation.
Creator
formkit
Size
68.9 MB
Stars
13.9K
Age
4y
Commits ยท 90 Days