Atelier UI®

Read the docsGithub
Docs 1.0.0

Getting started

  • Browse Catalog
  • Installation
  • How to contribute
  • Code of conduct
  • Fluid Scene

Components (28)

  • Clip Reveal
  • Stripe Wipe
  • Sweep Exit
  • Dither Flow
    pro
  • Glowing Fog
    pro
  • Halftone Glow
    pro
  • Fluid Distortion
  • Image Trail
  • Lens Media
  • Liquid Media
  • Magnetic Dot Grid
  • Pixel Media
  • Pixel Trail
  • Pixelated Text
  • Text Bounce
  • Text Fluid
  • Text Roll
  • Text Scramble
  • Curve Media
  • Elastic Stick
    pro
  • Infinite Gallery
  • Infinite Parallax
  • Infinite Zoom
  • Scattered Scroll
  • Text Split
  • WebGL Image
  • WebGL Text
  • WebGL Video
Atelier UI 1.0.0 ©2026
Star on githubBuy me a coffeellms.txt
  1. Docs
  2. /
  3. Getting Started
  4. /
  5. Installation

Installation

How to start using Atelier UI, not much.

License key

Only required for pro components: see step 3.

Sign in to view your license key.
1

Set up Tailwind CSS

This library is built on Tailwind CSS v4. If your project doesn't already use it, follow the Tailwind CSS installation guide before continuing.

2

Set up React Three Fiber

You only need one <Canvas> for the whole app. Place it at your app's root with <WebglPortal /> inside. It connects components like CurveMedia to the Canvas so they can render their effects from anywhere in your React tree.

npx atelier-ui add webgl-portal
Root layout
import { Canvas } from "@react-three/fiber";
import { WebglPortal } from "./webgl-portal";

// The canvas must cover the full viewport
<Canvas style={{ position: "fixed", inset: 0, pointerEvents: "none" }}>
  {/* required for components used elsewhere in your tree */}
  <WebglPortal />

  {/* components that live inside the Canvas go here */}
</Canvas>;
3

Set up pro license

Pro components require a license. Copy your key from the panel at the top of this page and add it to .env.local.

.env.local
ATELIER_PRO_KEY=<your-license-key>

Restart your dev server after adding the key.

4

Install a component

Pick a component from the docs, then install it:

  • CLI — installs the source and any shared dependencies.
  • Manual — copy each file by hand from the component page.
CLI example
npx atelier-ui add fluid-distortion
  • Set up Tailwind CSS
  • Set up React Three Fiber
  • Set up pro license
  • Install a component
Star on githubBuy me a coffeellms.txt