@lottiefiles/dotlottie-react/dist/index.d.ts

React wrapper around the dotlottie-web library

import { Config, DotLottie, DotLottieWorker } from "@lottiefiles/dotlottie-web";
import { ComponentProps, ReactNode, RefCallback } from "react";
export * from "@lottiefiles/dotlottie-web";

//#region src/base-dotlottie-react.d.ts
type BaseDotLottieProps<T extends DotLottie | DotLottieWorker> = Omit<Config, 'canvas'> & ComponentProps<'canvas'> & {
  animationId?: string;
  /**
   * A function that creates a `DotLottie` or `DotLottieWorker` instance.
   */
  createDotLottie: (config: T extends DotLottieWorker ? Config & {
    workerId?: string;
  } : Config) => T;
  /**
   * A callback function that receives the `DotLottie` or `DotLottieWorker` instance.
   *
   * @example
   * ```tsx
   * const [dotLottie, setDotLottie] = useState<DotLottie | null>(null);
   *
   * <DotLottieReact
   *   dotLottieRefCallback={setDotLottie}
   * />
   * ```
   */
  dotLottieRefCallback?: RefCallback<T | null>;
  /**
   * @deprecated The `playOnHover` property is deprecated.
   * Instead, use the `onMouseEnter` and `onMouseLeave` events to control animation playback.
   * Utilize the `dotLottieRefCallback` to access the `DotLottie` instance and invoke the `play` and `pause` methods.
   *
   * Example usage:
   * ```tsx
   * const [dotLottie, setDotLottie] = useState<DotLottie | null>(null);
   *
   * <DotLottieReact
   *   dotLottieRefCallback={setDotLottie}
   *   onMouseEnter={() => dotLottie?.play()}
   *   onMouseLeave={() => dotLottie?.pause()}
   * />
   * ```
   */
  playOnHover?: boolean;
  themeData?: string;
  workerId?: T extends DotLottieWorker ? string : undefined;
};
//#endregion
//#region src/dotlottie.d.ts
type DotLottieReactProps = Omit<BaseDotLottieProps<DotLottie>, 'createDotLottie'>;
declare const DotLottieReact: (props: DotLottieReactProps) => ReactNode;
//#endregion
//#region src/dotlottie-worker.d.ts
type DotLottieWorkerReactProps = Omit<BaseDotLottieProps<DotLottieWorker>, 'createDotLottie'>;
declare const DotLottieWorkerReact: (props: DotLottieWorkerReactProps) => ReactNode;
//#endregion
//#region src/index.d.ts
declare const setWasmUrl: (url: string) => void;
//#endregion
export { DotLottieReact, DotLottieReactProps, DotLottieWorkerReact, DotLottieWorkerReactProps, setWasmUrl };
//# sourceMappingURL=index.d.ts.map