Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/LottieFiles/lottie-player

Lottie viewer/player as an easy to use web component! https://lottiefiles.com/web-player
https://github.com/LottieFiles/lottie-player

bodymovin lit-element lottie lottie-web web-component

Last synced: 2 months ago
JSON representation

Lottie viewer/player as an easy to use web component! https://lottiefiles.com/web-player

Awesome Lists containing this project

README 

        
## lottie-player Web Component



This is a Web Component for easily embedding and playing Lottie animations and the Lottie-based Telegram Sticker (tgs) animations in websites.



[![npm](https://img.shields.io/npm/v/@lottiefiles/lottie-player.svg)](https://www.npmjs.com/package/@lottiefiles/lottie-player)

[![webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/@lottiefiles/lottie-player)



## Demo



![screencast](https://i.imgur.com/miLzIkJ.gif)



[Basic usage examples](https://codesandbox.io/s/y2nxyvomyj)



## Documentation



For full documentation, visit [docs.lottiefiles.com/lottie-player](https://docs.lottiefiles.com/lottie-player/)



## Installation



#### In HTML, import from CDN or from the local Installation:



##### Lottie Player:



- Import from CDN.



```html



```



- Import from local node_modules directory.



```html



```



##### Telegram Sticker (TGS) Player:



- Import from CDN.



```html



```



- Import from local node_modules directory.



```html



```



#### In Javascript or TypeScript:



1. Install package using npm or yarn.



```shell

npm install --save @lottiefiles/lottie-player

```



2. Import package in your code.



```javascript

import "@lottiefiles/lottie-player";

```



## Usage



### Lottie-Player



Add the element `lottie-player` and set the `src` property to a URL pointing to a valid Bodymovin JSON.



```html



```



You may set and load animations programatically as well.



```html



```



```js

const player = document.querySelector("lottie-player");

player.addEventListener("rendered", (e) => {

  //Load via URL

  player.load("https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json");

  // or load via a Bodymovin JSON string/object

  player.load(

    '{"v":"5.3.4","fr":30,"ip":0,"op":38,"w":315,"h":600,"nm":"new", ... }'

  );

});

```



### TGS-Player



Add the element `tgs-player` and set the `src` property to a URL pointing to a valid TGS JSON.



```html



```



### ReactJS & VueJS



Import the player either as



```js

import * as LottiePlayer from "@lottiefiles/lottie-player";

```



or



```js

require("@lottiefiles/lottie-player");

```



Use as follows



```html



```



### Typescript ReactJS



Import the player either as



```js

import * as LottiePlayer from "@lottiefiles/lottie-player";

```



or



```js

require("@lottiefiles/lottie-player");

```



Use as follows



```html



```



For typescript projects an added step is required. The component must be declared as a JSX intrinsic element. Create a file 'declarations.d.ts' in the root of your project and add the code below to the file.



```js

declare namespace JSX {

  interface IntrinsicElements {

    "lottie-player": any;

  }

}

```



### Nuxt 2



Create a `lottie-player.js` file inside the `/plugins` folder and add the below code to the file:



```js

import * as LottiePlayer from "@lottiefiles/lottie-player";

```  

\

Open `nuxt.config.js` file and add the following entry to register the newly created plugin:



```js

export default {

  plugins: [{ src: "~/plugins/lottie-player.js", mode: "client" }]

}

```



This is because the player script needs to be rendered on the browser/client side and we must configure Nuxt to load the script on the client side only.  

\

You would then be able to use the player as follows inside any component:



```html



```



### Nuxt 3



The process for Nuxt 3 is slightly different.  

Create a `lottie-player.client.ts` file inside the `/plugins` folder and add the below code to the file:



```js

import * as LottiePlayer from "@lottiefiles/lottie-player";



export default defineNuxtPlugin(() => LottiePlayer);

```

\

Your plugin will be automatically available throughout your Nuxt application thanks to the [plugin auto-registration](https://v3.nuxtjs.org/guide/directory-structure/plugins). Note the `client` suffix in the name of the plugin - this tells Nuxt to load it only on the client side, as the Lottie Player script can only be rendered in the browser.



You would then be able to use the player as follows inside any component:



```html



```



### NextJS



The process to import in NextJS is similar to Nuxt in the sense that on SSR mode, the library must be declared as a client side module. To do this, import the library within a react useEffect hook.



```javascript

import React, { useRef } from "react";



export default function Home() {

  const ref = useRef(null);

  React.useEffect(() => {

    import("@lottiefiles/lottie-player");

  });

  return (

    


      

        

      

    


  );

}

```



Do add a declaration file named declaration.d.ts to the root of the project as well



```javascript

declare namespace JSX {

  interface IntrinsicElements {

    "lottie-player": any;

  }

}

```



Full documentation on player properties, methods, events and styling for the Lottie-player are available [here](https://docs.lottiefiles.com/lottie-player).



## Community & Support



- [Github issues.](https://github.com/LottieFiles/lottie-player/issues) For bugs and errors you encounter using this player.

- [Discord.](https://lottiefiles.com/discord) For hanging out with the community and sharing your awesome Lottie animations!



## Our other Lottie related libraries



  

    Project

    Description

  

  

  

  

    lottie-react

    

    A React component for the Lottie Web player.

    

  

  

    lottie-vue

    

    A Vue component for the Lottie player.

    

  

  

    svelte-lottie-player

    

    Lottie player component for use with Svelte.

    

  

  

    jLottie

    

    jLottie is suitable as a general purpose lottie player, though implements a subset of the features in the core player - this approach leads to a tiny footprint and great performance.

    

  

  

    lottie-interactivity

    

    This is a small library to add scrolling, cursor interactivity and interaction chaining to your Lottie Animations.

    

  

  

    dotLottie

    

    dotLottie is an open-source file format that aggregates one or more Lottie files and their associated resources into a single file. They are ZIP archives compressed with the Deflate compression method and carry the file extension of ".lottie".

    

  

  

    lottie-js

    

    The library consists of methods to map the Lottie JSON to the object model and interact with properties as well as manipulate them.

    

  

  

    lottie-theming

    

    A library to extract themable properties and apply different themes to a given Lottie

    

  



## License



MIT License © LottieFiles.com