Monday December 28, 2020 By David Quintanilla
A Dive Into React And Three.js Using react-three-fiber — Smashing Magazine

About The Creator

Fortune Ikechi is a Frontend Engineer primarily based in Rivers State Nigeria. He’s a scholar of the College of Port-Harcourt. He’s keen about group and …
More about

react-three-fiber is a robust Three.js renderer that helps render 3D fashions and animations for React and its native functions. On this tutorial, you’ll learn to configure and construct 3D fashions in a React utility.

Immediately, we’re going to learn to configure and use react-three-fiber for constructing and displaying 3D fashions and animations in React and React Native functions.

This tutorial is for builders who wish to study extra about 3D mannequin animations within the net utilizing React and for anybody who’s had limitations with Three.js like incapacity to create canvas, bind person occasions like click on occasions and begin a render loop, react-three-fiber comes with these strategies. We’ll be constructing a 3D mannequin to raised perceive the way to construct Three.js 3D fashions utilizing react-three-fiber.

Getting Began With react-three-fiber

Three.js is a library that makes it simpler to create 3D graphics within the browser, it makes use of a canvas + WebGL to show the 3D fashions and animations, you may study extra here.

react-three-fiber is a React renderer for Three.js on the internet and react-native, it’s a increase to the pace at which you create 3D fashions and animations with Three.js, some examples of websites with 3D fashions and animations will be discovered here. react-three-fiber reduces the time spent on animations due to its reusable elements, binding occasions and render loop, first let’s check out what’s Three.js.

react-three-fiber permits us to construct elements of threeJS code utilizing React state, hooks and props, it additionally comes with the next parts:

mesh A property that helps outline the form of our fashions
hooks react-three-fiber defines hooks that assist us write capabilities that assist outline person occasions resembling onClick and onPointOver
Part-based and render loop react-three-fiber is component-based and renders based on a change in state or the shop

How To Use react-three-fiber

To make use of react-three-fiber, you begin by utilizing the instructions beneath:


npm i three react-three-fiber


yarn add three react-three-fiber 

Word: For react-three-fiber to work, you’ll want to put in three (Three.js) as we did above.

Constructing A React 3D Ludo Cube Mannequin And Animation Challenge

Right here we’re going to construct a 3D ludo cube mannequin utilizing react-three-fiber like we now have within the video beneath.

We will probably be utilizing create-react-app to initialize our venture, to do this let’s execute the command beneath on our terminal.

create-react-app react-three-fiber-ludo-model

The command above initializes a React venture inside our native machine, subsequent let’s cd into the listing and set up our packages react-three-fiber and three.

cd react-three-fiber-ludo-model

npm i three react-three-fiber

As soon as, the packages are put in, let’s begin our growth server utilizing the command

npm begin

The above command ought to begin our venture growth server in our browser. Subsequent let’s open our venture in our textual content editor of alternative, inside our venture src folder, delete the next recordsdata: App.css, App.take a look at.js, serviceWorker.js and setupTests.js. Subsequent, let’s delete all code that references the deleted recordsdata on our App.js.

For this venture, we’ll want a Field element for our ludo dices and our App element that’s given by React.

Constructing The Field Part

The Field element will comprise the form for our ludo dices, a picture of a ludo cube and a state to all the time maintain it in rotation. First, let’s import all of the packages we want for our Field element beneath.

import React, { useRef, useState, useMemo } from "react";
import { Canvas, useFrame } from "react-three-fiber";
import * as THREE from "three";
import 5 from "./property/5.png";

Within the above code, we’re importing useRef, useState and useMemo. We’ll be utilizing the useRef hook to entry the mesh of the cube and the useState hook to verify for the lively state of the ludo cube. useMemo hook will probably be used to return the quantity on the cube. Subsequent, we’re importing Canvas and useFrame from react-three-fiber, the canvas is used to attract the graphics on the browser, whereas the useFrame permits elements to hook into the render-loop, this makes it attainable for one element to render over the content material of one other. Subsequent, we imported the three bundle after which we imported a static picture of a ludo cube.

Subsequent for us is to jot down logic for our Field element. First, we’ll begin with constructing a practical element and add state to our element, let’s try this beneath.

const Field = (props) => {
  const mesh = useRef();

  const [active, setActive] = useState(false);

  useFrame(() => {
    mesh.present.rotation.x = mesh.present.rotation.y += 0.01;

  const texture = useMemo(() => new THREE.TextureLoader().load(5), []);
  return (
    <Field />

Within the code above, we’re making a Field element with props, subsequent we create a ref referred to as mesh utilizing the useRef hook, we did this in order that we will all the time return the identical mesh every time.

A mesh is a visible component in a scene, its a 3D object that make up a triangular polygon, it’s normally constructed utilizing a Geometry, which is used to outline the form of the mannequin and Materials which defines the looks of the mannequin, you may find out about a Mesh here, You can even study extra in regards to the useRef hook here.

After initializing a mesh, we have to initialize a state for our utility utilizing the useState hook, right here we arrange the hovered and lively state of the applying to false.

Subsequent, we use the useFrame hook from react-three-fiber to rotate the mesh (ludo cube), utilizing the code beneath

mesh.present.rotation.x = mesh.present.rotation.y += 0.01;

Right here, we’re rotating the present place of the mesh each 0.01 seconds, that is completed to provide the rotation animation.

const texture = useMemo(() => new THREE.TextureLoader().load(5), []);

Within the code above, we’re creating a continuing referred to as texture and passing in a react useMemo hook as a operate to load a brand new cube roll, right here the useMemo to memorize the cube picture and its quantity. You possibly can study in regards to the useMemo hook here.

Subsequent, we wish to render the Field element on the browser and add our occasions, we try this beneath

const Field = (props) => {
return (
    scale={lively ? [2, 2, 2] : [1.5, 1.5, 1.5]}
    onClick={(e) => setActive(!lively)}
      <boxBufferGeometry args={[1, 1, 1]} />
      <meshBasicMaterial connect="materials" clear aspect={THREE.DoubleSide}>
        <primitive connect="map" object={texture} />

Within the code above, we’re returning our Field element and wrapping it within the mesh we handed all of the properties of the Field element utilizing the unfold operator, after which we referenced the mesh utilizing the useRef hook. Subsequent, we use the scale property from Three.js to set the scale of the cube field when it’s lively to 2 and 1.5 when it’s not. Final however not least, we added an onClick occasion to set state to lively if it’s not set on default.

<boxBufferGeometry args={[1, 1, 1]} />

In an effort to render the cube field, we rendered the boxBufferGeometry element from Three.js, boxBufferGeometry helps us draw strains and level resembling containers, we used the args argument to move constructors resembling the scale of field geometry.

<meshBasicMaterial connect="materials" clear aspect={THREE.DoubleSide}>

The meshBasicMaterial from Three.js, is used to attract geometries in a easy type. Right here we handed the connect attribute and passing a THREE.DoubleSideprops to the aspect attribute. The THREE.DoubleSide defines the perimeters or areas that must be rendered by react-three-fiber.

<primitive connect="map" object={texture} />

The primitive element from Three.js is used to attract 3D graphs. We connected the map property as a way to preserve the unique form of the ludo cube. Subsequent, we’re going to render our Field element within the App.js file and full our 3d ludo cube field. Your element ought to look much like the picture beneath.

Box component for ludo 3D box

Rendering 3D Ludo Cube Field

On this part, we’re going to render our Field element in our App.js and full our 3d ludo field, to do this first, let’s create an App element and wrap it with a Canvas tag, that is to render our 3D fashions, let’s try this beneath.

const App = () => {
  return (
export default App;

Subsequent, let’s add a lightweight to the containers, react-three-fiber gives us with three elements to mild our fashions, they’re as follows

  • ambientLight
    That is used to mild all objects in a scene or mannequin equally, it accepts props such because the depth of the sunshine, it will mild the physique of the ludo cube.
  • spotLight
    This mild is emitted from a single path, and it will increase as the scale of the thing will increase, it will mild the factors of the ludo cube.
  • pointLight
    This works much like the sunshine of a lightweight bulb, mild is emitted from a single level to all instructions, this will probably be obligatory for the lively state of our utility.

Let’s implement the above on our utility beneath.

const App = () => {
  return (
      <ambientLight depth={0.5} />
      <spotLight place={[10, 10, 10]} angle={0.15} penumbra={1} />
      <pointLight place={[-10, -10, -10]} />
export default App;

Within the above code, we imported the ambientLight element from react-three-fiber and added an depth of 0.5 to it, subsequent we added a place and angle to our spotLight and pointLight element. The ultimate step to our utility is to render our field element and add a place to the ludo cube containers, we’d try this within the code beneath

<Field place={[-1.2, 0, 0]} />
<Field place={[2.5, 0, 0]} />

When completed, your ludo 3D cube ought to look much like the picture beneath:

3D ludo dice box

A working demo is out there on CodeSandbox.


react-three-fiber has made rendering 3D fashions and animations simpler to create for React and React Native functions. By constructing our 3D ludo cube field, we’ve realized in regards to the fundamentals of Three.js alongside its elements and advantages of react-three-fiber in addition to the way to use it.

You possibly can take this additional by constructing 3D fashions and animations in your React and Native functions by utilizing react-three-fiber by yourself. I’d like to see what new stuff you provide you with!

You possibly can learn extra on Three.js and react-three-fiber within the references beneath.

Smashing Editorial
(ks, ra, il)

Source link