react-three-fiber
react-three-fiber is a React reconciler for Threejs on the web and react-native.
npm install three react-three-fiber
These demos are real, you can click them! They contain the full code, too.
#### Why?
Building dynamic scene graphs declaratively with re-usable components makes dealing with Threejs easier and brings order and sanity to your codebase. These components react to state changes, are interactive out of the box and can tap into React's infinite ecosystem.
#### Does it have limitations?
None. Everything that works in Threejs will work here. In contrast to "bindings" where a library ships/maintains dozens of wrapper components, it just reconciles JSX to Threejs dynamically: `` simply is another expression for `new THREE.Mesh()`. It does not know or target a specific Threejs version nor does it need updates for modified, added or removed upstream features.
#### Is it slower than raw Threejs?
No. Rendering performance is up to Threejs and the GPU. Components may participate in the renderloop outside of React, without any additional overhead. React is otherwise very efficient in building and managing component-trees, it could potentially outperform manual/imperative apps at scale.
#### What does it look like?
| Let's make a re-usable component that has its own state, reacts to user-input and participates in the render-loop. (live demo). |
 |
```jsx
import ReactDOM from 'react-dom'
import React, { useRef, useState } from 'react'
import { Canvas, useFrame } from 'react-three-fiber'
function Box(props) {
// This reference will give us direct access to the mesh
const mesh = useRef()
// Set up state for the hovered and active state
const [hovered, setHover] = useState(false)
const [active, setActive] = useState(false)
// Rotate mesh every frame, this is outside of React without overhead
useFrame(() => (mesh.current.rotation.x = mesh.current.rotation.y += 0.01))
return (
setActive(!active)}
onPointerOver={(e) => setHover(true)}
onPointerOut={(e) => setHover(false)}>
)
}
ReactDOM.render(
,
document.getElementById('root')
)
```
---
# Fundamentals
1. Before you start, make sure you have a [basic grasp of Threejs](https://threejs.org/docs/index.html#manual/en/introduction/Creating-a-scene).
2. When you know what a scene is, a camera, mesh, geometry and material, more or less, fork the [demo sandbox on the frontpage](https://github.com/react-spring/react-three-fiber#what-does-it-look-like), try out some of the things you learn here.
3. Don't break your head, three-fiber is Threejs, it does not introduce new rules or assumptions. If you see a snippet somewhere and you don't know how to make it declarative yet, use it 1:1 as it is.
Some reading material:
- [Threejs-docs](https://threejs.org/docs)
- [Threejs-examples](https://threejs.org/examples)
- [Threejs-fundamentals](https://threejsfundamentals.org)
- [Discover Threejs](https://discoverthreejs.com)
- [Do's and don'ts](https://discoverthreejs.com/tips-and-tricks) for performance and best practices
- [react-three-fiber alligator.io tutorial](https://alligator.io/react/react-with-threejs) by [@dghez\_](https://twitter.com/dghez_)
# API
- [api.md](api.md)
- [pitfalls.md](pitfalls.md)
- [recipes.md](recipes.md)
# Ecosystem
- ๐ญ [drei](https://github.com/react-spring/drei), useful helpers for react-three-fiber
- ๐ฃ [use-cannon](https://github.com/react-spring/use-cannon), physics based hooks
- ๐คณ [react-xr](https://github.com/react-spring/react-xr), VR/AR controllers and events
- ๐ฎ [gltfjsx](https://github.com/react-spring/gltfjsx), turns GLTFs into JSX components
- ๐ป [zustand](https://github.com/react-spring/zustand), state management
- โ๏ธ [react-spring](https://github.com/react-spring/react-spring), a spring-physics-based animation library
- ๐ [react-use-gesture](https://github.com/react-spring/react-use-gesture), mouse/touch gestures
- ๐งช [react-three-gui](https://github.com/ueno-llc/react-three-gui), GUI/debug tools
# News, updates, community
- [@0xca0a](https://twitter.com/0xca0a)'s twitter
- [github discussions](https://github.com/react-spring/react-three-fiber/discussions)
# How to contribute
If you like this project, please consider helping out. All contributions are welcome as well as donations to [Opencollective](https://opencollective.com/react-three-fiber), or in crypto `BTC: 36fuguTPxGCNnYZSRdgdh6Ea94brCAjMbH`, `ETH: 0x6E3f79Ea1d0dcedeb33D3fC6c34d2B1f156F2682`.
#### Sponsors
#### Backers
Thank you to all our backers! ๐
##### Contributors
This project exists thanks to all the people who contribute.
