LottieFiles/lottie-vue

This is a Vue component for the Lottie Web Player. This library is a vue wrapper around the LottieFiles Lottie Web Player

1. Install package using npm or yarn.

npm install --save @lottiefiles/vue-lottie-player

2. Import package in your code.

import LottieVuePlayer from "@lottiefiles/vue-lottie-player";

3. Add the player as a plugin to Vue

Vue.use(LottieVuePlayer);

1. Install package using npm or yarn.

npm install --save @lottiefiles/vue-lottie-player

2. Create a folder called 'plugins' at the root of your project

3. Create a file named 'lottie-vue-player.client.js' inside the 'plugins' directory

4. Inside this file put :

import Vue from 'vue';

import LottieVuePlayer from "@lottiefiles/vue-lottie-player";

Vue.use(LottieVuePlayer);

5. Add to nuxt.config.js:

 plugins: [
    "~/plugins/lottie-vue-player.client.js"
  ]

1. Clone repo

2. run yarn install

Add the element lottie-vue-player and set the src prop to a URL pointing to a valid Lottie JSON. Full example of an App.vue file is shown below.

<template>
    <div id="app">
        <lottie-vue-player :src="`https://assets10.lottiefiles.com/packages/lf20_tzjfwgud.json`"
                           :theme="options.theme"
                           :player-size="options.playerSize"
                           :player-controls="true"
                           style="width: 100%; height:400px">
        </lottie-vue-player>
    </div>
</template>

<script>

    export default {
        name: 'App',
        data() {
            return {
                options: {
                    minimizable: false,
                    playerSize: "standard",
                    backgroundColor: '#fff',
                    backgroundStyle: 'color',
                    theme: {
                        controlsView: "standard",
                        active: "light",
                        light: {
                            color: '#3D4852',
                            backgroundColor: '#fff',
                            opacity: '0.7',
                        },
                        dark: {
                            color: '#fff',
                            backgroundColor: '#202020',
                            opacity: '0.7',
                        }
                    }
                }
            }
        }
    }
</script>

Toggle animation play pause.

Type: void

Toggle full screen player.

Type: void

Toggle animation loop.

Type: void

Sets animation play speed.

Type: void

Stops animation play.

Type: void

set background color.

Type: void

We use changesets to maintain a changelog for this repository. When making any change to the codebase that impacts functionality or performance we require a changeset to be present.

To add a changeset run:

yarn run changeset

And select the type of version bump you'd like (major, minor, path).

You can document the change in detail and format it properly using Markdown by opening the ".md" file that the "yarn changeset" command created in the ".changeset" folder. Open the file, it should look something like this:

---
"@lottiefiles/pkg1": minor
"@lottiefiles/pkg2": major
---

This is where you document your **changes** using Markdown.

- You can write
- However you'd like
- In as much detail as you'd like

Aim to provide enough details so that team mates and future you can understand the changes and the context of the change.

You can commit your changes and the changeset to your branch and then create a pull request on the develop branch.

MIT License © LottieFiles.com