npmpackage.info

Gathering detailed insights and metrics for @lottiefiles/lottie-player

Other packages similar to @lottiefiles/lottie-player

@lottiefiles/react-lottie-player

3.6.0

Lottie web player wrapper for React

@lottiefiles/dotlottie-web

0.48.0

Lottie and DotLottie player for the web

@lottiefiles/vue-lottie-player

1.1.0

Lottie player wrapper for Vue.js by LottieFiles

@lottiefiles/dotlottie-react

0.14.3

React wrapper around the dotlottie-web library

Gathering detailed insights and metrics for @lottiefiles/lottie-player

@lottiefiles/lottie-player - 2.0.12 | npmpackage.info

@lottiefiles/lottie-player

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

2.0.12

1,620

MIT

TypeScript

6.61 MB

3.6

Installations

npm install @lottiefiles/lottie-player

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.18.0

NPM Version

10.8.2 Pull Requests

Open

23

Total

100

Closed

35

Merged

42

Issues

Open

54

Total

165

Closed

111

Releases

v2.0.1

Updated on Jun 08, 2023

v2.0.0

Updated on Jun 08, 2023

v1.6.0

Updated on Dec 01, 2022

v1.5.8

Updated on Oct 24, 2022

v1.5.7

Updated on Apr 25, 2022

v1.5.6

Updated on Mar 23, 2022

View All 16 releases

Languages

TypeScript

JavaScript

HTML

TypeScript (44.52%)

JavaScript (32.71%)

HTML (22.77%)

Developer

LottieFiles

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1,620 Stars

225 Commits

187 Forks

32 Watchers

48 Branches

20 Contributors

Updated on Jul 10, 2025

Maintainers

View All 20 Contributors

Package Meta Information

Latest Version

2.0.12

Package Id

@lottiefiles/lottie-player@2.0.12

Unpacked Size

6.61 MB

Size

1.61 MB

File Count

NPM Version

10.8.2

Node Version

20.18.0

Published on

Nov 04, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/pako lit lottie-web pako resize-observer-polyfill

Dev Dependencies

@babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-decorators @babel/preset-env @babel/preset-typescript @commitlint/cli @commitlint/config-conventional @cypress/code-coverage @istanbuljs/nyc-config-typescript @rollup/plugin-babel @rollup/plugin-commonjs @rollup/plugin-json @rollup/plugin-node-resolve @semantic-release/changelog @semantic-release/commit-analyzer @semantic-release/git @semantic-release/github @semantic-release/npm @semantic-release/release-notes-generator babel-eslint babel-plugin-istanbul cypress cypress-real-events eslint eslint-plugin-only-warn fastify fastify-static husky lerna lint-staged parcel-bundler prettier rollup rollup-plugin-copy rollup-plugin-filesize rollup-plugin-serve rollup-plugin-terser rollup-plugin-typescript2 rollup-plugin-uglify rollup-plugin-visualizer semantic-release shx source-map-support ts-node typescript unicode-canonical-property-names-ecmascript

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.

Demo

screencast

Basic usage examples

Documentation

For full documentation, visit docs.lottiefiles.com/lottie-player

Installation

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

Lottie Player:

Import from CDN.

1<script src="https://unpkg.com/@lottiefiles/lottie-player@latest/dist/lottie-player.js"></script>

Import from local node_modules directory.

1<script src="/node_modules/@lottiefiles/lottie-player/dist/lottie-player.js"></script>

Telegram Sticker (TGS) Player:

Import from CDN.

1<script src="https://unpkg.com/@lottiefiles/lottie-player@latest/dist/tgs-player.js"></script>

Import from local node_modules directory.

1<script src="/node_modules/@lottiefiles/lottie-player/dist/tgs-player.js"></script>

In Javascript or TypeScript:

Install package using npm or yarn.

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

Import package in your code.

1import "@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.

1<lottie-player
2  autoplay
3  controls
4  loop
5  mode="normal"
6  src="https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json"
7  style="width: 320px"
8>
9</lottie-player>

You may set and load animations programatically as well.

1<lottie-player autoplay controls loop mode="normal" style="width: 320px">
2</lottie-player>

1const player = document.querySelector("lottie-player");
2player.addEventListener("rendered", (e) => {
3  //Load via URL
4  player.load("https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json");
5  // or load via a Bodymovin JSON string/object
6  player.load(
7    '{"v":"5.3.4","fr":30,"ip":0,"op":38,"w":315,"h":600,"nm":"new", ... }'
8  );
9});

TGS-Player

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

1<tgs-player autoplay loop mode="normal" src="https//domain/example.tgs">
2</tgs-player>

ReactJS & VueJS

Import the player either as

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

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

Use as follows

1<lottie-player
2  autoplay
3  controls
4  loop
5  mode="normal"
6  src="https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json"
7  style="width: 320px"
8></lottie-player>

Typescript ReactJS

Import the player either as

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

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

Use as follows

1<lottie-player
2  autoplay
3  controls
4  loop
5  mode="normal"
6  src="https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json"
7  style="width: 320px"
8></lottie-player>

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.

1declare namespace JSX {
2  interface IntrinsicElements {
3    "lottie-player": any;
4  }
5}

Nuxt 2

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

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

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

1export default {
2  plugins: [{ src: "~/plugins/lottie-player.js", mode: "client" }]
3}

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:

1<lottie-player
2  autoplay
3  controls
4  loop
5  style="width:400px"
6  src="https://assets3.lottiefiles.com/packages/lf20_RItkEz.json"
7  speed="1"
8  debug
9/>

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:

1import * as LottiePlayer from "@lottiefiles/lottie-player";
2
3export default defineNuxtPlugin(() => LottiePlayer);

Your plugin will be automatically available throughout your Nuxt application thanks to the plugin auto-registration. 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:

1<lottie-player
2  autoplay
3  controls
4  loop
5  style="width:400px"
6  src="https://assets3.lottiefiles.com/packages/lf20_RItkEz.json"
7  speed="1"
8  debug
9/>

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.

1import React, { useRef } from "react";
2
3export default function Home() {
4  const ref = useRef(null);
5  React.useEffect(() => {
6    import("@lottiefiles/lottie-player");
7  });
8  return (
9    <div className={styles.container}>
10      <main className={styles.main}>
11        <lottie-player
12          id="firstLottie"
13          ref={ref}
14          autoplay
15          controls
16          loop
17          mode="normal"
18          src="https://assets4.lottiefiles.com/packages/lf20_gb5bmwlm.json"
19          style={{ width: "300px", height: "300px" }}
20        ></lottie-player>
21      </main>
22    </div>
23  );
24}

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

1declare namespace JSX {
2  interface IntrinsicElements {
3    "lottie-player": any;
4  }
5}

Full documentation on player properties, methods, events and styling for the Lottie-player are available here.

Community & Support

Github issues. For bugs and errors you encounter using this player.
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

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

1

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Reason

66 existing vulnerabilities detected

Details

Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8
Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q
Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38
Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc
Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw
Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw
Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
Warn: Project is vulnerable to: GHSA-7gc6-qh9x-w6h8
Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq
Warn: Project is vulnerable to: GHSA-434g-2637-qmqr
Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m
Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw
Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p
Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh
Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
Warn: Project is vulnerable to: GHSA-896r-f27r-55mw
Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h
Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g
Warn: Project is vulnerable to: GHSA-5rrq-pxf6-6jx5
Warn: Project is vulnerable to: GHSA-8fr3-hfg3-gpgp
Warn: Project is vulnerable to: GHSA-gf8q-jrpm-jvxq
Warn: Project is vulnerable to: GHSA-2r2c-g63r-vccr
Warn: Project is vulnerable to: GHSA-cfm4-qjh2-4765
Warn: Project is vulnerable to: GHSA-x4jg-mjrx-434g
Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr
Warn: Project is vulnerable to: GHSA-3j8f-xvm3-ffx4
Warn: Project is vulnerable to: GHSA-j9fq-vwqv-2fm2
Warn: Project is vulnerable to: GHSA-pqw5-jmp5-px4v
Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6
Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59
Warn: Project is vulnerable to: GHSA-566m-qj78-rww5
Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
Warn: Project is vulnerable to: GHSA-hwj9-h5mp-3pm3
Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc
Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693
Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw
Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5
Warn: Project is vulnerable to: GHSA-3fjj-p79j-c9hh
Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h
Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
Warn: Project is vulnerable to: GHSA-hj9c-8jmm-8c52
Warn: Project is vulnerable to: GHSA-4p35-cfcx-8653
Warn: Project is vulnerable to: GHSA-7f3x-x4pr-wqhj
Warn: Project is vulnerable to: GHSA-jpp7-7chh-cf67
Warn: Project is vulnerable to: GHSA-q6wq-5p59-983w
Warn: Project is vulnerable to: GHSA-x2pg-mjhr-2m5x
Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch

Score

3.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More