https://github.com/chenqingspring/react-lottie

Render After Effects animations on React based on lottie-web
https://github.com/chenqingspring/react-lottie

after-effects bodymovin lottie-animation lottie-web react react-component

Last synced: 4 days ago
JSON representation

Render After Effects animations on React based on lottie-web

• Host: GitHub
• URL: https://github.com/chenqingspring/react-lottie
• Owner: chenqingspring
• License: mit
• Created: 2017-04-21T08:42:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-30T08:10:15.000Z (22 days ago)
• Last Synced: 2024-12-05T16:09:28.155Z (17 days ago)
• Topics: after-effects, bodymovin, lottie-animation, lottie-web, react, react-component
• Language: JavaScript
• Homepage:
• Size: 2.61 MB
• Stars: 1,690
• Watchers: 12
• Forks: 362
• Open Issues: 98
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - react-lottie - web | chenqingspring | 1241 | (JavaScript)
• awesome-icons - React Lottie - A React wrapper for Lottie animations, allowing easy integration of Lottie animations into React applications. (Animated Icon Libraries)
• awesome-icons - React Lottie - A React wrapper for Lottie animations, allowing easy integration of Lottie animations into React applications. (Animated Icon Libraries)

README

        
# Lottie Animation View for React ([Angular](https://github.com/chenqingspring/ng-lottie), [Vue](https://github.com/chenqingspring/vue-lottie))

[![npm version](https://badge.fury.io/js/react-lottie.svg)](http://badge.fury.io/js/react-lottie)

## Demo

https://chenqingspring.github.io/react-lottie

## Wapper of bodymovin.js

[bodymovin](https://github.com/bodymovin/bodymovin) is [Adobe After Effects](http://www.adobe.com/products/aftereffects.html) plugin for exporting animations as JSON, also it provide bodymovin.js for render them as svg/canvas/html.

## Why Lottie?

#### Flexible After Effects features

We currently support solids, shape layers, masks, alpha mattes, trim paths, and dash patterns. And we’ll be adding new features on a regular basis.

#### Manipulate your animation any way you like

You can go forward, backward, and most importantly you can program your animation to respond to any interaction.

#### Small file sizes

Bundle vector animations within your app without having to worry about multiple dimensions or large file sizes. Alternatively, you can decouple animation files from your app’s code entirely by loading them from a JSON API.

[Learn more](http://airbnb.design/introducing-lottie/) › http://airbnb.design/lottie/

Looking for lottie files › https://www.lottiefiles.com/

## Installation

Install through npm:

```

npm install --save react-lottie

```

## Usage

Import pinjump.json as animation data

```jsx

import React from 'react'

import Lottie from 'react-lottie';

import * as animationData from './pinjump.json'

export default class LottieControl extends React.Component {

  constructor(props) {

    super(props);

    this.state = {isStopped: false, isPaused: false};

  }

  render() {

    const buttonStyle = {

      display: 'block',

      margin: '10px auto'

    };

    const defaultOptions = {

      loop: true,

      autoplay: true, 

      animationData: animationData,

      rendererSettings: {

        preserveAspectRatio: 'xMidYMid slice'

      }

    };

    return 


      

       this.setState({isStopped: true})}>stop

       this.setState({isStopped: false})}>play

       this.setState({isPaused: !this.state.isPaused})}>pause

    

  }

}


```

### props

The `` Component supports the following components:

**options** *required*

the object representing the animation settings that will be instantiated by bodymovin. Currently a subset of the bodymovin options are supported:

>**loop** *options* [default: `false`]

>

>**autoplay** *options* [default: `false`]

>

>**animationData** *required*

>

>**rendererSettings** *required* 

**width** *optional* [default: `100%`]

pixel value for containers width.

**height** *optional* [default: `100%`]

pixel value for containers height.

**eventListeners** *optional* [default: `[]`]

This is an array of objects containing a `eventName` and `callback` function that will be registered as  eventlisteners on the animation object. refer to [bodymovin#events](https://github.com/bodymovin/bodymovin#events) where the mention using addEventListener, for a list of available custom events.

example:

```jsx

eventListeners=[

  {

    eventName: 'complete',

    callback: () => console.log('the animation completed:'),

  },

]

```

**isClickToPauseDisabled** *optional* [default: `false`]

When this props is left unspecified or is set to `false` animations are paused or resumed when a user clicks or taps them. If you do not want this behaviour set this prop to `true`.

## Related Projects

* [Bodymovin](https://github.com/bodymovin/bodymovin) react-lottie is a wrapper of bodymovin

* [Angular Lottie](https://github.com/chenqingspring/ng-lottie) angular implementation

* [Vue Lottie](https://github.com/chenqingspring/vue-lottie) vue implementation

* [React Native Lottie](https://github.com/airbnb/lottie-react-native) react native implementation by airbnb

* [IOS Lottie](https://github.com/airbnb/lottie-ios) ios implementation by airbnb

* [Android Lottie](https://github.com/airbnb/lottie-android) android implementation by airbnb

## Contribution

Your contributions and suggestions are heartily welcome.

## License

MIT