- Docs
- Components
- Backgrounds
- Aurora Beam
Aurora Beam
A sweeping aurora beam built from layered sheets of light
Customize
Props
33| Name | Type | Default | Description |
|---|---|---|---|
speed | number | 1 | How fast the curtains travel. |
sheets | number | 5 | Number of stacked light sheets. The main cost knob. |
amplitude | number | 0.12 | Height of the travelling wave that shapes each sheet. |
frequency | number | 3.2 | Spatial frequency of that wave. |
thickness | number | 0.05 | Half height of a sheet at full brightness. |
tail | number | 0.22 | Vertical softness of the upward streak. |
position | number | 0 | Vertical centre of the beam, -0.5 to 0.5. |
slant | number | 0.1 | Diagonal lean applied across the beam. |
spread | number | 0.16 | Vertical separation between consecutive sheets. |
rays | number | 0.45 | Strength of the vertical striations, 0 to 1. |
rayScale | number | 26 | Spatial frequency of the striations. |
rayDrift | number | 0.8 | How fast the striations drift sideways. |
reactivity | number | 0.7 | How strongly the envelope model modulates the beam, 0 to 1. |
gain | number | 1.5 | Overall brightness before tone mapping. |
exposure | number | 2.4 | Tone mapping headroom. Higher keeps more of the falloff. |
contrast | number | 1 | Tone response curve. Above 1 deepens the shadows. |
color | string | "#34d399" | First palette colour. |
midColor | string | "#22d3ee" | Second palette colour. |
deepColor | string | "#a78bfa" | Third palette colour. |
hueDrift | number | 1 | How fast the palette travels through the sheets. |
grain | number | 0.05 | Film grain strength, 0 to 1. |
grainSize | number | 1 | Grain cell size in CSS pixels. |
grainRate | number | 24 | Grain refreshes per second. |
backgroundColor | string | "#0a0a0a" | Panel backdrop, or "transparent" to show the page through. |
opacity | number | 1 | Master alpha. |
cursorInteraction | boolean | true | Let the pointer sway the curtains. |
cursorSway | number | 0.5 | How far the pointer sways the curtains, 0 to 1. |
paused | boolean | false | Freeze the animation. |
adaptiveQuality | boolean | true | Scale back resolution when the frame budget slips. |
targetFps | number | 60 | Frame rate the quality meter aims to hold. |
dpr | number | 1.75 | Upper device pixel ratio bound. |
className | string | - | Optional className applied to the root. |
children | ReactNode | - | Content layered above the beam. |
speednumberHow fast the curtains travel.
1sheetsnumberNumber of stacked light sheets. The main cost knob.
5amplitudenumberHeight of the travelling wave that shapes each sheet.
0.12frequencynumberSpatial frequency of that wave.
3.2thicknessnumberHalf height of a sheet at full brightness.
0.05tailnumberVertical softness of the upward streak.
0.22positionnumberVertical centre of the beam, -0.5 to 0.5.
0slantnumberDiagonal lean applied across the beam.
0.1spreadnumberVertical separation between consecutive sheets.
0.16raysnumberStrength of the vertical striations, 0 to 1.
0.45rayScalenumberSpatial frequency of the striations.
26rayDriftnumberHow fast the striations drift sideways.
0.8reactivitynumberHow strongly the envelope model modulates the beam, 0 to 1.
0.7gainnumberOverall brightness before tone mapping.
1.5exposurenumberTone mapping headroom. Higher keeps more of the falloff.
2.4contrastnumberTone response curve. Above 1 deepens the shadows.
1colorstringFirst palette colour.
"#34d399"midColorstringSecond palette colour.
"#22d3ee"deepColorstringThird palette colour.
"#a78bfa"hueDriftnumberHow fast the palette travels through the sheets.
1grainnumberFilm grain strength, 0 to 1.
0.05grainSizenumberGrain cell size in CSS pixels.
1grainRatenumberGrain refreshes per second.
24backgroundColorstringPanel backdrop, or "transparent" to show the page through.
"#0a0a0a"opacitynumberMaster alpha.
1cursorInteractionbooleanLet the pointer sway the curtains.
truecursorSwaynumberHow far the pointer sways the curtains, 0 to 1.
0.5pausedbooleanFreeze the animation.
falseadaptiveQualitybooleanScale back resolution when the frame budget slips.
truetargetFpsnumberFrame rate the quality meter aims to hold.
60dprnumberUpper device pixel ratio bound.
1.75classNamestringOptional className applied to the root.
-childrenReactNodeContent layered above the beam.
-