reactbits-animation/README.md

A comprehensive collection of beautiful, performant React animation components including bounce effects, click sparks, star borders, scroll-triggered animations, and fade transitions.

# @aadviklabs/reactbits-animation

A comprehensive collection of beautiful, performant React animation components for the Reactbits NPM Package.

## About

This package provides a set of ready-to-use animation components for React. It's designed to be easy to use and highly customizable.

- **Author:** Aadviklabs
- **Website:** [www.aadviklabs.com](https://www.aadviklabs.com)
- **Repository:** [https://github.com/AadvikLabs/reactbits-animation](https://github.com/AadvikLabs/reactbits-animation)

## Installation

```bash
npm install reactbits-animation
```

### Peer Dependencies

This package requires the following peer dependencies to be installed in your project:

```bash
# Core dependencies (required)
npm install react react-dom

# Animation libraries (install as needed)
npm install framer-motion gsap

# For 3D components (optional)
npm install three @react-three/fiber @react-three/drei

# For UI components (optional)
npm install @chakra-ui/react @emotion/react @emotion/styled
```

## Usage

```jsx
import { Bounce } from 'reactbits-animation';

function App() {
  return (
    <Bounce>
      <h1>Hello, World!</h1>
    </Bounce>
  );
}
```

## Components

This package includes a variety of animation components. Here are a few examples:

*   `AnimatedContent`
*   `AnimatedList`
*   `Bounce`
*   `FadeContent`
*   ... and many more!

Check out `examples.md` for more examples.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.