You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-37Lines changed: 32 additions & 37 deletions
Original file line number
Diff line number
Diff line change
@@ -4,75 +4,66 @@
4
4
5
5
This project is meant to give developers full control over **[Lottie](https://airbnb.design/lottie/)** instance with minimal implementation by wrapping **[lottie-web](https://github.com/airbnb/lottie-web)** in a Component or Hook that can be easily used in **React** applications.
6
6
7
-
> 👩💻 `v3` is under development and is planning to bring a lot of features and improvements. But unfortunately, at the moment all the maintainers are super busy with work related projects. You can check out the progress under the `v3` branch. And of course, you are encouraged to contribute. :)
8
-
9
-
> 🙋♂️ Are you using `lottie-react` in production? Please send us a message with your website, feature requests and recommendations at: [contact@gamote.ro](mailto:contact@gamote.ro).
10
-
11
-
12
7
## Installation
13
8
14
-
Install **react**, **react-dom** if you don’t have them already:
9
+
1. Make sure you have the peer-dependencies installed: `react` and `react-dom`.
15
10
16
-
_**Note:** This library is using React hooks so the minimum version required for both react and react-dom is 16.8.0._
11
+
> _**Note:** This library is using React Hooks so the **minimum** version required for both **react** and **react-dom** is **v16.8.0**._
17
12
18
-
```shell
19
-
yarn add react@^16.8.0 react-dom@^16.8.0
20
-
```
13
+
2. Install `lottie-react` using **yarn**
21
14
22
-
Install **lottie-react** using npm:
15
+
```shell
16
+
yarn add lottie-react
17
+
```
18
+
19
+
or **npm**
23
20
24
-
```shell
25
-
yarn add lottie-react
26
-
```
21
+
```shell
22
+
npm i lottie-react
23
+
```
27
24
28
25
## Usage
29
26
30
-
### Component
27
+
### Using the component ([try it](https://codesandbox.io/s/lottie-react-component-2k13t))
31
28
32
29
```tsx
30
+
import React from "react";
33
31
import Lottie from "lottie-react";
34
32
import groovyWalkAnimation from "./groovyWalk.json";
Let us know if you have any suggestions or contributions. This package has the mission to help developers, so if you have any features that you think we should prioritize, reach out to us.
84
+
Any **questions** or **suggestions**? Use the [**Discussions**](https://github.com/github/docs/discussions) tab. Any **issues**? Don't hesitate to document it in the [**Issues**](https://github.com/Gamote/lottie-react/issues) tab, and we will do our best to investigate it and fix it. Any **solutions**? You are very welcomed to open a [**pull request**](https://github.com/Gamote/lottie-react/pulls).
85
+
86
+
> 👩💻 `v3` is under development and is planning to bring a lot of features and improvements. But unfortunately, at the moment all the maintainers are super busy with work related projects. You can check out the progress under the `v3` branch. And of course, you are encouraged to contribute. :)
87
+
88
+
Thank you for investing your time in contributing to our project! ✨
94
89
95
90
## Projects to check out
96
91
97
92
- [lottie-web](https://github.com/airbnb/lottie-web) - Lottie implementation for Web. Our project is based on it and you should check it because it will help you understand what's behind this package and it will give you a better understanding on what features should you expect to have in the future.
98
93
- [lottie-android](https://github.com/airbnb/lottie-android) - Lottie implementation for Android
99
94
- [lottie-ios](https://github.com/airbnb/lottie-ios) - Lottie implementation for iOS
100
95
- [lottie-react-native](https://github.com/react-native-community/lottie-react-native) - Lottie implementation for React Native
101
-
-[LottieFiles](https://lottiefiles.com/) - Are you looking for animations? LottieFiles is the way to go!
96
+
- [LottieFiles](https://lottiefiles.com/) - Are you looking for animations files? LottieFiles has a lot of them!
0 commit comments