Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

react-lottie-loader

davidkhierl1.8kMIT1.1.0TypeScript support: included

Lottie loader for React

lottie, animation, canvas, svg, after effects, react, react-library

readme

React Lottie Loader.

Lottie loader for React.

Introduction

Lottie made animations for web sleek and beautiful and of course let designers to have their boundless creativity and use them in your project, just download or create your own Lottie Files.

Install

via npm

npm i react-lottie-loader

via yarn

yarn add react-lottie-loader

Usage

Create your own or download Lottie files from here Lottie Files.

Import animation data and LottieLoader component.

import React from "react";
import catAnimationData 'src/animation/cat-animation.json';
import LottieLoader 'react-lottie-loader';

function App() {
  return (
    <div>
      <LottieLoader animationData={catAnimationData} />
    </div>
  );
}

export default App;

Props

  • animationData: an Object with the exported animation data.
  • autoplay: true / false it will start playing as soon as it is ready
  • className: css class name to pass the animation container.
  • loop: true / false / number
  • name: animation name for future reference
  • path: the relative path to the animation object. (animationData and path are mutually exclusive)
  • renderer: 'svg' / 'canvas' / 'html' to set the renderer

Contributing

Contributions, issues and feature request are welcome! 💜

Fell free to check the issues page


Authors

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

1.1.0 (2023-02-08)

Features

Docs

Chore

1.0.0 (2021-01-17)

Docs