Getting Started · 1 min read

Installation

How to install and set up dot-anime-react in your project

Installation

Get started with dot-anime-react in just a few steps.

Requirements

  • React 18 or higher
  • Node.js 16 or higher

Package Manager

Install dot-anime-react using your preferred package manager:

npm install dot-anime-react

Or with yarn:

yarn add dot-anime-react

Or with pnpm:

pnpm add dot-anime-react

Import Components

Once installed, you can import components directly:

import { DotMatrix, ScrambleText, DotFlow } from "dot-anime-react";

All components are tree-shakeable, so you only bundle what you use.

TypeScript Support

dot-anime-react is written in TypeScript and includes full type definitions. No additional @types packages are needed.

import type { DotMatrixConfig, ScrambleTextConfig } from "dot-anime-react";

Next Steps

Now that you have dot-anime-react installed, check out the Quick Start guide to create your first animation.