Usage with Nuxt 3
If you upgrading from v2 to v3, please remove the
dist/style.css import from your app.vue file. This css is now imported automatically by the plugin.Register the component globally
- Create a folder called
pluginsat the root of your project. - Create a file named
Vue3Lottie.client.tsinside thepluginsdirectory. - Add the following code to the file:
import { Vue3Lottie } from 'vue3-lottie'export default defineNuxtPlugin((nuxtApp) => { nuxtApp.vueApp.component('Vue3Lottie', Vue3Lottie)})✨ Well done! This should register a global component that you can call anywhere in your app under the<Vue3Lottie>tag. You can also change the name of the component by changing thenameproperty in the plugin file.
Register the component locally
The component can also simply be imported locally.
<script setup lang="ts">import { Vue3Lottie } from 'vue3-lottie'</script>Use the component
Now you can use the component. Here is an example of how to use it in a page.
Using the
<client-only> tag is recommended to prevent any hydration errors.<template> ... <client-only> <Vue3Lottie animationLink="https://assets10.lottiefiles.com/packages/lf20_soCRuE.json" :height="200" :width="200" /> </client-only> ...</template>