animated-fluent-emojis
Version:
Animated Fluent Emojis is a React component library that brings Microsoft's Fluent emojis to life in your web applications. This library offers an easy way to integrate expressive and engaging animated emojis, enhancing user experience and visual appeal i
23 lines • 1.42 kB
TypeScript
import { EmojiManifest } from '../utils';
/**
* Custom hook for managing emoji animation.
* @param {EmojiManifest | null} emoji - The emoji manifest data or null if not loaded.
* @param {boolean} playOnHover - Whether to play the animation on hover.
* @param {number | 'infinite'} animationIterations - The number of animation iterations.
* @param {boolean} autoPlay - Whether to autoplay the animation.
* @param {number} size - The size of the emoji in pixels.
* @returns {Object} An object containing animation-related states and handlers.
* @returns {boolean} .isInitialAnimationComplete - Whether the initial animation has completed.
* @returns {React.CSSProperties} .animationStyle - The CSS properties for the animation.
* @returns {() => void} .handleMouseEnter - Handler for mouse enter event.
* @returns {() => void} .handleMouseLeave - Handler for mouse leave event.
* @returns {React.RefObject<HTMLImageElement>} .imageRef - Ref for the image element.
*/
export declare const useEmojiAnimation: (emoji: EmojiManifest | null, playOnHover: boolean, animationIterations: number | "infinite", autoPlay: boolean, size: number) => {
isInitialAnimationComplete: boolean;
animationStyle: import('react').CSSProperties;
handleMouseEnter: () => void;
handleMouseLeave: () => void;
imageRef: import('react').RefObject<HTMLImageElement>;
};
//# sourceMappingURL=useEmojiAnimation.d.ts.map