@gfazioli/mantine-text-animate/dist/types/use-text-animate.d.ts

The TextAnimate component allows you to animate text with various effects.

import type { TextAnimateAnimationDirection } from './TextAnimate';
export interface UseTextAnimateResult {
    /**
     * The current animation direction
     */
    animate: TextAnimateAnimationDirection;
    /**
     * Set the animation direction
     */
    setAnimate: (direction: TextAnimateAnimationDirection) => void;
    /**
     * Replay the animation by forcing a remount via key change
     */
    replay: () => void;
    /**
     * Whether the animation is currently running
     */
    isAnimating: boolean;
    /**
     * Key to pass to TextAnimate for remount-based replay
     */
    key: number;
    /**
     * Callback to pass to TextAnimate's onAnimationComplete prop
     */
    onAnimationComplete: (direction: 'in' | 'out') => void;
}
/**
 * Hook that provides control over TextAnimate component
 *
 * Returns state and controls for managing TextAnimate animation direction,
 * replay capability, and animation status tracking.
 *
 * @param initialDirection - The initial animation direction
 */
export declare function useTextAnimate(initialDirection?: TextAnimateAnimationDirection): UseTextAnimateResult;