UNPKG

react-atmospheres

Version:

A lightweight wrapper to add seasonal, themed visual effects in your React app.

21 lines (20 loc) 844 B
import { ReactNode } from 'react'; export type AtmospheresType = 'snow' | 'hearts' | 'spooky' | 'none'; interface Props { /** Children to render inside the atmospheres */ children: ReactNode; /** Type of animation to use */ animation?: AtmospheresType; /** Disable the animation */ disabled?: boolean; /** Amount of animated objects, can not be higher then 100 */ particleAmount?: number; /** Color of the animated objects */ color?: string; /** Color of the outline of the animated objects */ outlineColor?: string; /** Speed factor for the animation, can not be higher then 2 */ speedFactor?: number; } export declare const Atmospheres: ({ children, animation, disabled, particleAmount, color, outlineColor, speedFactor, }: Props) => import("react/jsx-runtime").JSX.Element; export {};