Eclipse

A total eclipse with a diamond-ring bead and a slowly turning corona.

eclipse-demo.tsx

import { Eclipse } from "@/components/eclipse";

export function Hero() {
  return (
    <Eclipse className="flex h-[560px] items-end p-10" palette="solar-blue">
      <h1 className="text-5xl font-semibold tracking-tight text-white">
        Your headline
      </h1>
    </Eclipse>
  );
}

Installation

pnpm dlx shadcn@latest add @gradients-pro/eclipse

Needs a Pro account and the Pro registry setup.

Usage

import { Eclipse } from "@/components/eclipse";

<Eclipse className="h-[560px]">{children}</Eclipse>;

It fills its box, so give it a height. Children render on top.

Props

Prop	Type	Default	Description
`palette`	`"corona"`, `"solar-blue"`, `"ember"`	`"corona"`	One of the curated palettes.
`appearance`	`"auto"`, `"dark"`, `"light"`	`"auto"`	Which version of the palette to use. `auto` follows a `dark` or `light` class (or `data-theme`) on `<html>`, then the OS setting.
`colors`	`string[]`	palette	2 to 6 CSS colours, `var(--x)` included. Replaces the palette's colours.
`background`	`string`	palette	Replaces the palette's background.
`size`	`number`	`1`	0.25 to 4. Size of the eclipse.
`streamers`	`number`	`0.5`	0 to 1. Streamer contrast: low is a smooth glow, high is fine filaments.
`reach`	`number`	`0.4`	0 to 1. How far the corona reaches.
`grain`	`number`	`0.12`	0 to 1. Film grain.
`speed`	`number`	`0.6`	0 to 2. How fast it moves; 0 holds a still frame.
`params`	`Partial<GradientParams>`	none	Any other engine param, applied last.
`className`	`string`	none	Classes for the outer box. Give it a size, for example `h-[560px]`.
`style`	`CSSProperties`	none	Inline styles for the outer box.
`children`	`ReactNode`	none	Content drawn above the background.