festive-effects 1.0.0

package/dist/effects/index.d.ts

@@ -0,0 +1,15 @@
+export { ChristmasEffect, generateChristmasParticles, CHRISTMAS_CONFIG } from './ChristmasEffect';
+export { NewYearEffect, generateNewYearParticles, NEWYEAR_CONFIG } from './NewYearEffect';
+export { ValentineEffect, generateValentineParticles, VALENTINE_CONFIG } from './ValentineEffect';
+export { EasterEffect, generateEasterParticles, EASTER_CONFIG } from './EasterEffect';
+export { HalloweenEffect, generateHalloweenParticles, HALLOWEEN_CONFIG } from './HalloweenEffect';
+export { ThanksgivingEffect, generateThanksgivingParticles, THANKSGIVING_CONFIG } from './ThanksgivingEffect';
+export { DiwaliEffect, generateDiwaliParticles, DIWALI_CONFIG } from './DiwaliEffect';
+export { ChineseNewYearEffect, generateChineseNewYearParticles, CHINESENEWYEAR_CONFIG } from './ChineseNewYearEffect';
+export { HoliEffect, generateHoliParticles, HOLI_CONFIG } from './HoliEffect';
+export { EidEffect, generateEidParticles, EID_CONFIG } from './EidEffect';
+export { StPatricksEffect, generateStPatricksParticles, STPATRICKS_CONFIG } from './StPatricksEffect';
+export { IndependenceEffect, generateIndependenceParticles, INDEPENDENCE_CONFIG } from './IndependenceEffect';
+import type { FestivalType, ParticleData, Viewport } from '../types';
+export type EffectGenerator = (count: number, viewport: Viewport, colors?: string[]) => ParticleData[];
+export declare const EFFECT_GENERATORS: Record<FestivalType, EffectGenerator>;

package/dist/hooks/index.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Hook to detect if the user prefers reduced motion
+ * Listens to the prefers-reduced-motion media query
+ *
+ * @returns boolean - true if user prefers reduced motion, false otherwise
+ *
+ * @example
+ * ```tsx
+ * const prefersReducedMotion = useReducedMotion();
+ * if (prefersReducedMotion) {
+ *   // Don't render animations
+ *   return null;
+ * }
+ * ```
+ */
+export declare function useReducedMotion(): boolean;
+/**
+ * Hook to detect document visibility changes
+ * Returns true when the document is visible, false when hidden
+ *
+ * This is useful for pausing animations when the user switches tabs
+ * to save resources and improve performance.
+ *
+ * @returns boolean - true if document is visible, false if hidden
+ *
+ * @example
+ * ```tsx
+ * const isVisible = useDocumentVisibility();
+ * if (!isVisible) {
+ *   // Pause animations
+ * }
+ * ```
+ */
+export declare function useDocumentVisibility(): boolean;
+/**
+ * Hook to manage cleanup of timeouts
+ * Returns a function to set a timeout that will be automatically cleared on unmount
+ *
+ * @returns Object with setTimeout and clearAllTimeouts functions
+ *
+ * @example
+ * ```tsx
+ * const { setTimeout: setManagedTimeout, clearAllTimeouts } = useTimeoutManager();
+ * setManagedTimeout(() => console.log('done'), 1000);
+ * // Timeout will be automatically cleared on unmount
+ * ```
+ */
+export declare function useTimeoutManager(): {
+    setTimeout: (callback: () => void, delay: number) => NodeJS.Timeout;
+    clearTimeout: (timeoutId: ReturnType<typeof setTimeout>) => void;
+    clearAllTimeouts: () => void;
+};
+/**
+ * Hook to manage cleanup of animation frame requests
+ * Returns a function to request animation frame that will be automatically cancelled on unmount
+ *
+ * @returns Object with requestAnimationFrame and cancelAllAnimationFrames functions
+ *
+ * @example
+ * ```tsx
+ * const { requestAnimationFrame: requestFrame, cancelAllAnimationFrames } = useAnimationFrameManager();
+ * requestFrame(() => console.log('frame'));
+ * // Animation frame will be automatically cancelled on unmount
+ * ```
+ */
+export declare function useAnimationFrameManager(): {
+    requestAnimationFrame: (callback: FrameRequestCallback) => number;
+    cancelAnimationFrame: (frameId: number) => void;
+    cancelAllAnimationFrames: () => void;
+};