Skip to main content

​
Prerequisites

Before installing RGBirdflop, ensure you have:
  • Node.js version 24.13.0 or higher
  • A package manager: npm, yarn, or pnpm

​
Install the Package

Choose your preferred package manager: 
npm install @birdflop/rgbirdflop

​
Verify Installation

After installation, verify that the package is correctly installed: 
npm list @birdflop/rgbirdflop
You should see output similar to: 
@birdflop/[email protected]

​
TypeScript Configuration

If you’re using TypeScript, the package includes type definitions. No additional setup is required. The package exports types from: 
./lib-types/index.d.ts

​
Package Exports

The package provides the following exports:

​
Main Entry Point

import { rgbDefaults, generateOutput } from '@birdflop/rgbirdflop';

​
All Available Exports

// Core functions
import { 
  generateOutput,
  disperseColors,
  sortColors,
  swapItems,
  getShadowColors
} from '@birdflop/rgbirdflop';

// Defaults and types
import {
  rgbDefaults,
  animTABDefaults,
  combinedDefaults,
  formats,
  animationStyles
} from '@birdflop/rgbirdflop';

// Color utilities
import {
  ColorGradient,
  ColorAnimatedGradient,
  GRADIENT_TYPES
} from '@birdflop/rgbirdflop';

// Color space utilities
import {
  hexToRGB,
  rgbToHex,
  rgbToHsl,
  hslToRgb,
  rgbToOklab,
  oklabToRgb,
  rgbToOklch,
  oklchToRgb,
  rgbToCielab,
  cielabToRgb
} from '@birdflop/rgbirdflop';

// Animation utilities
import {
  generateTAB,
  generateAnimatedFrames
} from '@birdflop/rgbirdflop';

​
Next Steps

Quick Start

Learn how to use RGBirdflop with a working example

Build docs developers (and LLMs) love

Get started for freeTalk to us