ink-motion 0.1.0 → 1.0.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
  * Colour value as hex (#ff0000), rgb (rgb(255,0,0)), or named (red, blue, etc.)
@@ -43,6 +43,93 @@ interface BaseEffectProps {
     onComplete?: () => void;
 }
 
+interface FadeProps extends BaseEffectProps {
+    /**
+     * Text colour
+     * @default '#ffffff'
+     * @example 'yellow'
+     */
+    color?: Colour;
+    /**
+     * Starting opacity (0-1)
+     * @default 0
+     */
+    from?: number;
+    /**
+     * Ending opacity (0-1)
+     * @default 1
+     */
+    to?: number;
+    /**
+     * Duration in milliseconds
+     * @default 1000
+     */
+    duration?: number;
+    /**
+     * Easing function
+     * @default 'ease-out'
+     */
+    easing?: EasingName;
+    /**
+     * Loop animation continuously
+     * @default false
+     */
+    loop?: boolean;
+}
+/**
+ * Fade effect component that smoothly transitions text opacity
+ *
+ * Animates text from one opacity to another using configurable easing functions.
+ * Can loop continuously or run once.
+ *
+ * @example
+ * ```tsx
+ * <Fade color="yellow" from={0} to={1} duration={500} easing="ease-in">
+ *   Success!
+ * </Fade>
+ * ```
+ */
+declare function Fade({ children, color, from, to, duration, easing, loop, speed, enabled, onComplete, }: FadeProps): react_jsx_runtime.JSX.Element;
+
+interface FlashProps extends BaseEffectProps {
+    /**
+     * Text colour
+     * @default '#ffffff'
+     * @example 'cyan'
+     */
+    color?: Colour;
+    /**
+     * Minimum brightness (0-1)
+     * @default 0.3
+     */
+    minIntensity?: number;
+    /**
+     * Maximum brightness (0-1)
+     * @default 1
+     */
+    maxIntensity?: number;
+    /**
+     * Flash cycle duration in milliseconds
+     * @default 1000
+     */
+    duration?: number;
+}
+/**
+ * Flash effect component that creates a pulsing neon-like glow
+ *
+ * Animates text with a continuous brightness pulse that oscillates
+ * between minimum and maximum intensity levels, creating a flashing
+ * or glowing neon effect.
+ *
+ * @example
+ * ```tsx
+ * <Flash color="cyan" minIntensity={0.3} maxIntensity={1} duration={800}>
+ *   ⚡ NEON GLOW ⚡
+ * </Flash>
+ * ```
+ */
+declare function Flash({ children, color, minIntensity, maxIntensity, duration, speed, enabled, }: FlashProps): react_jsx_runtime.JSX.Element;
+
 type ShimmerDirection = 'left' | 'right';
 interface ShimmerProps extends BaseEffectProps {
     /**
@@ -80,7 +167,7 @@ interface ShimmerProps extends BaseEffectProps {
  * </Shimmer>
  * ```
  */
-declare function Shimmer({ children, colors, width, intensity, direction, speed, enabled, onComplete, }: ShimmerProps): React.JSX.Element;
+declare function Shimmer({ children, colors, width, intensity, direction, speed, enabled, onComplete, }: ShimmerProps): react_jsx_runtime.JSX.Element;
 
 interface TypewriterProps extends BaseEffectProps {
     /**
@@ -125,55 +212,7 @@ interface TypewriterProps extends BaseEffectProps {
  * </Typewriter>
  * ```
  */
-declare function Typewriter({ children, color, cursor, cursorColor, variance, delay, speed, enabled, onComplete, }: TypewriterProps): React.JSX.Element;
-
-interface FadeProps extends BaseEffectProps {
-    /**
-     * Text colour
-     * @default '#ffffff'
-     * @example 'yellow'
-     */
-    color?: Colour;
-    /**
-     * Starting opacity (0-1)
-     * @default 0
-     */
-    from?: number;
-    /**
-     * Ending opacity (0-1)
-     * @default 1
-     */
-    to?: number;
-    /**
-     * Duration in milliseconds
-     * @default 1000
-     */
-    duration?: number;
-    /**
-     * Easing function
-     * @default 'ease-out'
-     */
-    easing?: EasingName;
-    /**
-     * Loop animation continuously
-     * @default false
-     */
-    loop?: boolean;
-}
-/**
- * Fade effect component that smoothly transitions text opacity
- *
- * Animates text from one opacity to another using configurable easing functions.
- * Can loop continuously or run once.
- *
- * @example
- * ```tsx
- * <Fade color="yellow" from={0} to={1} duration={500} easing="ease-in">
- *   Success!
- * </Fade>
- * ```
- */
-declare function Fade({ children, color, from, to, duration, easing, loop, speed, enabled, onComplete, }: FadeProps): React.JSX.Element;
+declare function Typewriter({ children, color, cursor, cursorColor, variance, delay, speed, enabled, onComplete, }: TypewriterProps): react_jsx_runtime.JSX.Element;
 
 type WaveType = 'brightness' | 'vertical';
 interface WaveProps extends BaseEffectProps {
@@ -212,7 +251,7 @@ interface WaveProps extends BaseEffectProps {
  * </Wave>
  * ```
  */
-declare function Wave({ children, colors, amplitude, frequency, type, speed, enabled, }: WaveProps): React.JSX.Element;
+declare function Wave({ children, colors, amplitude, frequency, type, speed, enabled, }: WaveProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Runs a callback on every animation frame using setInterval
@@ -222,15 +261,6 @@ declare function Wave({ children, colors, amplitude, frequency, type, speed, ena
  */
 declare function useAnimationFrame(callback: (deltaTime: number) => void, enabled?: boolean): void;
 
-/**
- * Hook that tracks elapsed time since mount or last reset
- *
- * @param enabled - Whether to track time
- * @param speed - Speed multiplier (default: 1)
- * @returns Elapsed time in milliseconds
- */
-declare function useElapsedTime(enabled?: boolean, speed?: number): number;
-
 interface UseCursorBlinkOptions {
     enabled: boolean;
     isComplete: boolean;
@@ -239,10 +269,21 @@ interface UseCursorBlinkOptions {
  * Hook that manages cursor blinking state
  *
  * @param options - Configuration for cursor blink
+ * @param options.enabled - Whether cursor blinking is enabled
+ * @param options.isComplete - Whether typing is complete
  * @returns Whether cursor should be visible
  */
 declare function useCursorBlink({ enabled, isComplete, }: UseCursorBlinkOptions): boolean;
 
+/**
+ * Hook that tracks elapsed time since mount or last reset
+ *
+ * @param enabled - Whether to track time
+ * @param speed - Speed multiplier (default: 1)
+ * @returns Elapsed time in milliseconds
+ */
+declare function useElapsedTime(enabled?: boolean, speed?: number): number;
+
 interface UseTypewriterProgressOptions {
     totalCharacters: number;
     speed: number;
@@ -255,8 +296,14 @@ interface UseTypewriterProgressOptions {
  * Hook that manages typewriter character reveal timing
  *
  * @param options - Configuration for typewriter progress
+ * @param options.totalCharacters - Total number of characters to reveal
+ * @param options.speed - Animation speed multiplier
+ * @param options.variance - Typing variance for human-like timing (0-1)
+ * @param options.initialDelay - Delay before typing starts in milliseconds
+ * @param options.enabled - Whether the animation is enabled
+ * @param options.onComplete - Callback when typing completes
  * @returns Number of characters to display
  */
 declare function useTypewriterProgress({ totalCharacters, speed, variance, initialDelay, enabled, onComplete, }: UseTypewriterProgressOptions): number;
 
-export { type BaseEffectProps, type Color, type Colour, type EasingFunction, type EasingName, Fade, Shimmer, Typewriter, Wave, useAnimationFrame, useCursorBlink, useElapsedTime, useTypewriterProgress };
+export { type BaseEffectProps, type Color, type Colour, type EasingFunction, type EasingName, Fade, Flash, Shimmer, Typewriter, Wave, useAnimationFrame, useCursorBlink, useElapsedTime, useTypewriterProgress };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 
 /**
  * Colour value as hex (#ff0000), rgb (rgb(255,0,0)), or named (red, blue, etc.)
@@ -43,6 +43,93 @@ interface BaseEffectProps {
     onComplete?: () => void;
 }
 
+interface FadeProps extends BaseEffectProps {
+    /**
+     * Text colour
+     * @default '#ffffff'
+     * @example 'yellow'
+     */
+    color?: Colour;
+    /**
+     * Starting opacity (0-1)
+     * @default 0
+     */
+    from?: number;
+    /**
+     * Ending opacity (0-1)
+     * @default 1
+     */
+    to?: number;
+    /**
+     * Duration in milliseconds
+     * @default 1000
+     */
+    duration?: number;
+    /**
+     * Easing function
+     * @default 'ease-out'
+     */
+    easing?: EasingName;
+    /**
+     * Loop animation continuously
+     * @default false
+     */
+    loop?: boolean;
+}
+/**
+ * Fade effect component that smoothly transitions text opacity
+ *
+ * Animates text from one opacity to another using configurable easing functions.
+ * Can loop continuously or run once.
+ *
+ * @example
+ * ```tsx
+ * <Fade color="yellow" from={0} to={1} duration={500} easing="ease-in">
+ *   Success!
+ * </Fade>
+ * ```
+ */
+declare function Fade({ children, color, from, to, duration, easing, loop, speed, enabled, onComplete, }: FadeProps): react_jsx_runtime.JSX.Element;
+
+interface FlashProps extends BaseEffectProps {
+    /**
+     * Text colour
+     * @default '#ffffff'
+     * @example 'cyan'
+     */
+    color?: Colour;
+    /**
+     * Minimum brightness (0-1)
+     * @default 0.3
+     */
+    minIntensity?: number;
+    /**
+     * Maximum brightness (0-1)
+     * @default 1
+     */
+    maxIntensity?: number;
+    /**
+     * Flash cycle duration in milliseconds
+     * @default 1000
+     */
+    duration?: number;
+}
+/**
+ * Flash effect component that creates a pulsing neon-like glow
+ *
+ * Animates text with a continuous brightness pulse that oscillates
+ * between minimum and maximum intensity levels, creating a flashing
+ * or glowing neon effect.
+ *
+ * @example
+ * ```tsx
+ * <Flash color="cyan" minIntensity={0.3} maxIntensity={1} duration={800}>
+ *   ⚡ NEON GLOW ⚡
+ * </Flash>
+ * ```
+ */
+declare function Flash({ children, color, minIntensity, maxIntensity, duration, speed, enabled, }: FlashProps): react_jsx_runtime.JSX.Element;
+
 type ShimmerDirection = 'left' | 'right';
 interface ShimmerProps extends BaseEffectProps {
     /**
@@ -80,7 +167,7 @@ interface ShimmerProps extends BaseEffectProps {
  * </Shimmer>
  * ```
  */
-declare function Shimmer({ children, colors, width, intensity, direction, speed, enabled, onComplete, }: ShimmerProps): React.JSX.Element;
+declare function Shimmer({ children, colors, width, intensity, direction, speed, enabled, onComplete, }: ShimmerProps): react_jsx_runtime.JSX.Element;
 
 interface TypewriterProps extends BaseEffectProps {
     /**
@@ -125,55 +212,7 @@ interface TypewriterProps extends BaseEffectProps {
  * </Typewriter>
  * ```
  */
-declare function Typewriter({ children, color, cursor, cursorColor, variance, delay, speed, enabled, onComplete, }: TypewriterProps): React.JSX.Element;
-
-interface FadeProps extends BaseEffectProps {
-    /**
-     * Text colour
-     * @default '#ffffff'
-     * @example 'yellow'
-     */
-    color?: Colour;
-    /**
-     * Starting opacity (0-1)
-     * @default 0
-     */
-    from?: number;
-    /**
-     * Ending opacity (0-1)
-     * @default 1
-     */
-    to?: number;
-    /**
-     * Duration in milliseconds
-     * @default 1000
-     */
-    duration?: number;
-    /**
-     * Easing function
-     * @default 'ease-out'
-     */
-    easing?: EasingName;
-    /**
-     * Loop animation continuously
-     * @default false
-     */
-    loop?: boolean;
-}
-/**
- * Fade effect component that smoothly transitions text opacity
- *
- * Animates text from one opacity to another using configurable easing functions.
- * Can loop continuously or run once.
- *
- * @example
- * ```tsx
- * <Fade color="yellow" from={0} to={1} duration={500} easing="ease-in">
- *   Success!
- * </Fade>
- * ```
- */
-declare function Fade({ children, color, from, to, duration, easing, loop, speed, enabled, onComplete, }: FadeProps): React.JSX.Element;
+declare function Typewriter({ children, color, cursor, cursorColor, variance, delay, speed, enabled, onComplete, }: TypewriterProps): react_jsx_runtime.JSX.Element;
 
 type WaveType = 'brightness' | 'vertical';
 interface WaveProps extends BaseEffectProps {
@@ -212,7 +251,7 @@ interface WaveProps extends BaseEffectProps {
  * </Wave>
  * ```
  */
-declare function Wave({ children, colors, amplitude, frequency, type, speed, enabled, }: WaveProps): React.JSX.Element;
+declare function Wave({ children, colors, amplitude, frequency, type, speed, enabled, }: WaveProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Runs a callback on every animation frame using setInterval
@@ -222,15 +261,6 @@ declare function Wave({ children, colors, amplitude, frequency, type, speed, ena
  */
 declare function useAnimationFrame(callback: (deltaTime: number) => void, enabled?: boolean): void;
 
-/**
- * Hook that tracks elapsed time since mount or last reset
- *
- * @param enabled - Whether to track time
- * @param speed - Speed multiplier (default: 1)
- * @returns Elapsed time in milliseconds
- */
-declare function useElapsedTime(enabled?: boolean, speed?: number): number;
-
 interface UseCursorBlinkOptions {
     enabled: boolean;
     isComplete: boolean;
@@ -239,10 +269,21 @@ interface UseCursorBlinkOptions {
  * Hook that manages cursor blinking state
  *
  * @param options - Configuration for cursor blink
+ * @param options.enabled - Whether cursor blinking is enabled
+ * @param options.isComplete - Whether typing is complete
  * @returns Whether cursor should be visible
  */
 declare function useCursorBlink({ enabled, isComplete, }: UseCursorBlinkOptions): boolean;
 
+/**
+ * Hook that tracks elapsed time since mount or last reset
+ *
+ * @param enabled - Whether to track time
+ * @param speed - Speed multiplier (default: 1)
+ * @returns Elapsed time in milliseconds
+ */
+declare function useElapsedTime(enabled?: boolean, speed?: number): number;
+
 interface UseTypewriterProgressOptions {
     totalCharacters: number;
     speed: number;
@@ -255,8 +296,14 @@ interface UseTypewriterProgressOptions {
  * Hook that manages typewriter character reveal timing
  *
  * @param options - Configuration for typewriter progress
+ * @param options.totalCharacters - Total number of characters to reveal
+ * @param options.speed - Animation speed multiplier
+ * @param options.variance - Typing variance for human-like timing (0-1)
+ * @param options.initialDelay - Delay before typing starts in milliseconds
+ * @param options.enabled - Whether the animation is enabled
+ * @param options.onComplete - Callback when typing completes
  * @returns Number of characters to display
  */
 declare function useTypewriterProgress({ totalCharacters, speed, variance, initialDelay, enabled, onComplete, }: UseTypewriterProgressOptions): number;
 
-export { type BaseEffectProps, type Color, type Colour, type EasingFunction, type EasingName, Fade, Shimmer, Typewriter, Wave, useAnimationFrame, useCursorBlink, useElapsedTime, useTypewriterProgress };
+export { type BaseEffectProps, type Color, type Colour, type EasingFunction, type EasingName, Fade, Flash, Shimmer, Typewriter, Wave, useAnimationFrame, useCursorBlink, useElapsedTime, useTypewriterProgress };