God Rays

Soft shafts of light falling through haze from a high window.

god-rays-demo.tsx

import { GodRays } from "@/components/god-rays";

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

Installation

pnpm dlx shadcn@latest add @gradients-pro/god-rays

Needs a Pro account and the Pro registry setup.

Usage

import { GodRays } from "@/components/god-rays";

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

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

Props

Prop	Type	Default	Description
`palette`	`"cathedral"`, `"canopy"`, `"ultramarine"`	`"cathedral"`	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.
`rays`	`number`	`0.55`	0 to 1. Shaft contrast: low is a soft wash, high is crisp beams.
`density`	`number`	`1`	0.25 to 4. More, narrower shafts.
`softness`	`number`	`0.45`	0 to 1. Longer, softer shafts that reach further before fading.
`grain`	`number`	`0.14`	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.