@flla/qwik-lottie
v0.2.0
Published
Lottie Animation View for Qwik
Downloads
56
Maintainers
Readme
- Wapper of bodymovin.js
- Demo
- Why Lottie?
- Installation
- Usage
- Lottie Files
- Configuration
- Related Projects
- Contributing
- License
- Netlify
Wapper of bodymovin.js
bodymovin is Adobe After Effects plugin for exporting animations as JSON, also it provide bodymovin.js for vender them as svg/canvas/html.
Demo
Why Lottie?
Flexible After Effects features
We currently support solids, shape layers, masks, alpha mattes, trim paths, and dash patterns. And we’ll be adding new features on a regular basis.
Manipulate your animation any way you like
You can go forward, backward, and most importantly you can program your animation to respond to any interaction.
Small file sizes
Bundle vector animations within your app without having to worry about multiple dimensions or large file sizes. Alternatively, you can decouple animation files from your app’s code entirely by loading them from a JSON API.
Learn more › http://airbnb.design/lottie/
Looking for lottie files › https://www.lottiefiles.com/
Installation
Install through npm:
npm install --save qwik-lottie
Usage
import { component$, useStore } from '@builder.io/qwik';
import { QwikLottie } from 'qwik-lottie';
export default component$(() => {
const store = useStore({
options: {
path: 'https://assets7.lottiefiles.com/packages/lf20_M6jA5UNDHa.json',
},
});
return (
<>
<div>
<QwikLottie options={store.options} />
</div>
</>
);
});
Lottie Files
Get free json files from LottieFiles.
Configuration
You can pass a configuration object through property:
- animationData: an Object with the exported animation data.
- path: the relative path to the animation object. (animationData and path are mutually exclusive)
- loop: true / false / number
- autoplay: true / false it will start playing as soon as it is ready
- name: animation name for future reference
- renderer: 'svg' / 'canvas' / 'html' to set the renderer
- container: the dom element on which to render the animation
More information on Bodymoving Documentation
Related Projects
- Bodymovin qwik-lottie is a wrapper of bodymovin
- Angular Lottie angular implementation
- React Lottie react implementation
- React Native Lottie react native implementation by airbnb
- IOS Lottie ios implementation by airbnb
- Android Lottie android implementation by airbnb
Contributing
Found an awesome package, article, blog, video etc.? Send me a pull request! Just follow the guidelines. Thank you!.
License
MIT
Netlify
This starter site is configured to deploy to Netlify Edge Functions, which means it will be rendered at an edge location near to your users.
Local development
The Netlify CLI can be used to preview a production build locally. To do so: First build your site, then to start a local server, run:
- install Netlify CLI globally
npm i -g netlify-cli
- Build your site both ssr and client
npm run build
. - Start a local server with
npm run serve
. In this project,npm run serve
uses thenetlify dev
command to spin up a server that can handle Netlify's Edge Functions locally. - Visit http://localhost:8888/ to check out your site.
Deployments
You can deploy your site to Netlify either via a Git provider integration or through the Netlify CLI. This starter site includes a netlify.toml
file to configure your build for deployment.
Deploying via Git
Once your site has been pushed to your Git provider, you can either link it in the Netlify UI or use the CLI. To link your site to a Git provider from the Netlify CLI, run the command:
netlify link
This sets up continuous deployment for your site's repo. Whenever you push new commits to your repo, Netlify starts the build process..
Deploying manually via the CLI
If you wish to deploy from the CLI rather than using Git, you can use the command:
netlify deploy --build
You must use the --build
flag whenever you deploy. This ensures that the Edge Functions that this starter site relies on are generated and available when you deploy your site.
Add --prod
flag to deploy to production.