Skip to content
Effects / Glass / Shaders

AnimatedGradient

server25.25 kB
@stellaria/nebula-webAnimatedGradientProps

Preview

Props

7
PropTypeDefault

children

ReactNode

—

className

Composes with the classes `Box` computes instead of replacing them.

string

—

component

(ElementType & C)

—

gradient

{ from: ColorExtended; to: ColorExtended; deg?: number; animate?: boolean; } | GradientRole

—

reveal

Animates the element in when it first scrolls into view. `true` takes the catalogue entrance; an object tunes it — `preset`, `distance`, `spring`, `duration`, `once`, `amount`, `rootMargin` and `index` for a stagger. It lives here rather than on each surface so that `Card`, `Paper`, `GradientBorder`, `Section` and anything else built on `Box` inherit one implementation. Without it `Box` stays a server component; with it the root swaps for a client shell and the children keep rendering on the server. The entrance is a CSS transition, not a JavaScript animation: it is the only motion in the catalogue that fires WHILE the user scrolls, and the compositor should own it.

boolean | UseRevealOptions

—

scrim

number

—

speed

AnimatedGradientSpeed

—

Slot props

1

Each one spreads over an inner element, so you can restyle a region without forking the component.

PropTypeDefault

scrimProps

The veil that dims the gradient. Only rendered with `scrim` greater than 0, which is where its opacity comes from; the slot is what lets you tint it another colour without forking. The drifting layer has no slot: it is the mechanism of the animation.

BoxSlotProps

—

Also accepts

On top of its own props, this component forwards these groups.

Style props · 128