Skip to content

feat: add path support to LottieOptions #133

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MorlaxAR wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: add path support to LottieOptions #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/hooks/useLottie.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const useLottie = <T extends RendererType = "svg">(
): { View: ReactElement } & LottieRefCurrentProps => {
const {
animationData,
path,
loop,
autoplay,
initialSegment,
Expand Down Expand Up @@ -202,7 +203,7 @@ const useLottie = <T extends RendererType = "svg">(
// Clean up on unmount
return () => onUnmount?.();
// eslint-disable-next-line react-hooks/exhaustive-deps
}, [animationData, loop]);
}, [animationData, path, loop]);

// Update the autoplay state
useEffect(() => {
Expand Down
13 changes: 10 additions & 3 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ export type LottieOptions<T extends RendererType = "svg"> = Omit<
AnimationConfigWithData<T>,
"container" | "animationData"
> & {
animationData: unknown;
lottieRef?: LottieRef;
onComplete?: AnimationEventCallback<
AnimationEvents[AnimationEventName]
Expand Down Expand Up @@ -68,10 +67,18 @@ export type LottieOptions<T extends RendererType = "svg"> = Omit<
onDestroy?: AnimationEventCallback<
AnimationEvents[AnimationEventName]
> | null;
} & Omit<React.HTMLProps<HTMLDivElement>, "loop">;
} & Omit<React.HTMLProps<HTMLDivElement>, "loop"> &
(
| { animationData: unknown; path?: never }
| { path: string; animationData?: never }
);

export type PartialLottieOptions = Omit<LottieOptions, "animationData"> & {
export type PartialLottieOptions = Omit<
LottieOptions,
"animationData" | "path"
> & {
animationData?: LottieOptions["animationData"];
path?: string;
};

// Interactivity
Expand Down