vue-lottie-player-stoponlastframe

This component has been modified to include an option to stop at the last frame of an animation when not looping. The behaviour of the original component is to reset to the first frame.

Original package: https://www.npmjs.com/package/@lottiefiles/vue-lottie-player

LottiePlayer Vue Component

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

In Javascript or TypeScript:

Install package using npm or yarn.

npm i vue-lottie-player-stoponlastframe

Import package in your code.

import LottieVuePlayer from "vue-lottie-player-stoponlastframe";

Add the player as a plugin to Vue

Vue.use(LottieVuePlayer);

With Nuxt:

Install package using npm or yarn.

npm i vue-lottie-player-stoponlastframe

Create a folder called 'plugins' at the root of your project
Create a file named 'lottie-vue-player.client.js' inside the 'plugins' directory
Inside this file put :

import Vue from 'vue';

import LottieVuePlayer from "vue-lottie-player-stoponlastframe";

Vue.use(LottieVuePlayer);

Add to nuxt.config.js:

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

Example/Development

Clone repo
run yarn install

Usage

Player component

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>

Props

Prop	Description	Type	Default
`autoplay`	Autoplay animation on load.	`boolean`	`false`
`backgroundColor`	Background color.	`string`	`undefined`
`playerControls`	Show controls.	`boolean`	`false`
`showColorPicker`	Show color picker	`boolean`	`false`
`playerSize`	Player set size (hide, minimal, standard)	`string`	`standard`
`loop`	Whether to loop animation.	`boolean`	`false`
`stopOnLastFrame`	Whether to stop the animation on its last frame. Only applicable when `loop` is `false`.	`boolean`	`false`
`speed`	Animation speed.	`number`	`1`
`style`	The style for the container.	`object`	`undefined`
`src` (required)	Bodymovin JSON data or URL to JSON.	`object`	`string`

Methods

`togglePlayPause() => void`

Toggle animation play pause.

Returns

Type: void

`toggleFullscreen() => void`

Toggle full screen player.

Returns

Type: void

`toggleLoop() => void`

Toggle animation loop.

Returns

Type: void

`setPlayerSpeed(speed?: number) => void`

Sets animation play speed.

Parameters

Name	Type	Description
`value`	`number`	Playback speed.

Returns

Type: void

`stop() => void`

Stops animation play.

Returns

Type: void

`setBackgroundColor(color: string) => void`

set background color.

Returns

Type: void