react-three-lite
v0.9.0
Published
Readme
English | 🇨🇳中文
React Three Lite
Documentation
Visit r3l.sunquakes.com.
Features
- Scene — Core 3D scene container with camera, renderer, lights, and controls
- Model Loaders —
GLTFLoader/FBXLoader/OBJLoadercomponents and async function loaders with Draco compression support - Bloom — Post-processing glow effect
- HeightFog — Screen-space exponential height fog
- Fireworks — Shader-driven firework launch with gravity-bent burst trails
- TextFireworks — Fireworks that assemble a text glyph from particles
- Rain / Snow — Particle effects with custom GLSL shaders
- Water — Cinematic shallow ocean with planar reflection and refraction, plus an optional irregular outline for lakes and shorelines
- WaterPool — Interactive ray-traced water pool you can ripple by dragging (water surface only; add
SkyDomefor the sky and sun) - SandyBeach — Walkable dawn beach island with footprints in the sand
- SkyBox — Skybox background support
- SkyDome — Gradient sky dome with a low sun
- Global Parameters — Shared sun direction that keeps
SkyDome,Water,WaterPoolandHeightFogin sync - SweepLight — Model sweep light animation
- LightGradient — Dynamic lighting gradient effect
- LightPillar — Vertical light pillar effect
- RadarSweep — Ground radar pulse ring
- SignalWave — Billboarded broadcast ping wave
- GlowSprite — Camera-facing halo sprite with optional pulse
- NebulaGalaxy — Particle nebula galaxy
- ForceShield — Hexagonal energy shield with impact rings and a dissolve animation
- Callout — Leader line annotation with auto-anchor camera tracking
- Popup — Interactive 3D popup dialogs
- Movable — Draggable scene elements
- Animation — Model animation playback
- ModelRotator — Automatic model rotation utility
- Picker — Hover and click picking for scene objects
- FitCamera — Coordinate-system agnostic camera framing
- WaveCircleMesh / FlowLineMesh — Custom visualization meshes
- GeoObject — Anchors an
Object3Dat a geographic coordinate - GeoJsonLayer — Renders GeoJSON features as 3D geometry
- TileLayer — XYZ / slippy-map raster tile layer
- GIS helpers — GeoReference, datum conversion (WGS84 / GCJ-02 / BD-09) and tile selection utilities
Renderer Support
react-three-lite works with both modern 3D renderers:
| Renderer | Default | Notes |
|----------|---------|-------|
| WebGPU | ✅ | WebGPURenderer from three/webgpu. The default renderer. Automatically falls back to the WebGL2 backend when WebGPU is unavailable. |
| WebGL | | Classic THREE.WebGLRenderer. TSL shaders are compiled to GLSL via WebGLNodesHandler. |
Switch renderers per scene with the rendererType prop:
import { Scene } from 'react-three-lite'
function App() {
// WebGPU (default)
return <Scene style={{ width: '100%', height: '300px' }} />
}
function AppWebGL() {
// WebGL
return <Scene rendererType="webgl" style={{ width: '100%', height: '300px' }} />
}The docs site shows every example under both renderers with a WebGPU / WebGL tab switch.
Install
Install Three.js
pnpm i threeInstall react-three-lite
pnpm i react-three-liteGetting Started
- Import the desired components from
react-three-liteinmain.js.
import { Scene } from 'react-three-lite'
function App() {
return <Scene style={{ width: '100%', height: '300px' }} />
}