@mhmmt/react-dotlottie-player 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -2,30 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
Play Lottie animations in React — supports both `.json` and `.lottie` files.
|
|
4
4
|
|
|
5
|
-
## Features
|
|
6
|
-
|
|
7
|
-
- Play `.json` Lottie animations
|
|
8
|
-
- Play `.lottie` animations (automatically unzips)
|
|
9
|
-
- SSR-safe with dynamic import
|
|
10
|
-
- Full TypeScript support
|
|
11
|
-
- Tree-shakeable exports
|
|
12
|
-
|
|
13
5
|
## Installation
|
|
14
6
|
|
|
15
7
|
```bash
|
|
16
|
-
npm install react-dotlottie-player
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## Peer Dependencies
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
npm install react react-dom
|
|
8
|
+
npm install @mhmmt/react-dotlottie-player
|
|
23
9
|
```
|
|
24
10
|
|
|
25
11
|
## Usage
|
|
26
12
|
|
|
27
13
|
```tsx
|
|
28
|
-
import { DotLottiePlayer } from 'react-dotlottie-player';
|
|
14
|
+
import { DotLottiePlayer } from '@mhmmt/react-dotlottie-player';
|
|
29
15
|
|
|
30
16
|
function App() {
|
|
31
17
|
return (
|
|
@@ -26,7 +26,7 @@ interface UseDotLottieReturn {
|
|
|
26
26
|
isLoaded: boolean;
|
|
27
27
|
isPlaying: boolean;
|
|
28
28
|
currentFrame: number;
|
|
29
|
-
containerRef: React.RefObject<HTMLDivElement>;
|
|
29
|
+
containerRef: React.RefObject<HTMLDivElement | null>;
|
|
30
30
|
animationData: AnimationItem | null;
|
|
31
31
|
}
|
|
32
32
|
export declare function useDotLottie({ src, loop, autoplay, speed, direction, backgroundColor, onLoad, onError, onComplete, onLoopComplete, onFrame, onEnterFrame, }: UseDotLottieOptions): UseDotLottieReturn;
|