@lottiefiles/dotlottie-wc
Advanced tools
A web component for rendering and playing Lottie and DotLottie animations in web applications.
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".
npm install @lottiefiles/dotlottie-wc
After installation, you can use dotlottie-wc in your HTML file:
<dotlottie-wc src="https://lottie.host/4db68bbd-31f6-4cd8-84eb-189de081159a/IGmMCqhzpt.lottie" autoplay="true" loop="true"></dotlottie-wc>
And import it in your JavaScript or TypeScript module:
import '@lottiefiles/dotlottie-wc';
You can also use the component directly via a npm CDN:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>@lottiefiles/dotlottie-wc | Basic Example</title>
</head>
<body>
<dotlottie-wc src="https://lottie.host/4db68bbd-31f6-4cd8-84eb-189de081159a/IGmMCqhzpt.lottie" autoplay loop></dotlottie-wc>
<script type="module" src="https://unpkg.com/@lottiefiles/dotlottie-wc@latest/dist/dotlottie-wc.js"></script>
</body>
</html>
The dotlottie-wc component accepts all configuration attributes of DotLottie from @lottiefiles/dotlottie-web, allowing you to customize your animation as required.
| Attribute | Type | Description |
|---|---|---|
src | string | URL of the Lottie or DotLottie animation. |
autoplay | boolean | Automatically start the animation. |
loop | boolean | Loop the animation. |
speed | number | Playback speed. |
data | string | Animation data as a string or ArrayBuffer for .lottie animations. |
segment | Array | Animation segment as an array of two numbers (start frame and end frame). |
mode | string | Animation play mode (e.g., "forward", "bounce"). |
backgroundColor | string | Background color of the canvas. Accepts 6-digit or 8-digit hex color string (e.g., "#000000FF"). |
renderConfig | Object (RenderConfig) | Configuration for rendering the animation. |
The renderConfig object accepts the following properties:
| Property name | Type | Required | Default | Description |
|---|---|---|---|---|
devicePixelRatio | number | window.devicePixelRatio | 1 | The device pixel ratio. |
The dotlottie-wc exposes the following properties:
| Property name | Type | Description |
|---|---|---|
dotLottie | DotLottie | The dotLottie instance from DotLottie , allowing you to call methods and listen to events for more control over the animation. |
npm install
npm run dev
npm run build
FAQs
Web component wrapper around the dotlottie-web library
The npm package @lottiefiles/dotlottie-wc receives a total of 13,606 weekly downloads. As such, @lottiefiles/dotlottie-wc popularity was classified as popular.
We found that @lottiefiles/dotlottie-wc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.