react-three-flex

Flexbox for react-three-fiber

3DReact
pmndrs/react-three-flexreact-three-flex

README

@react-three/flex

Build Status Version Downloads Discord Shield

Placing content in THREE.js is hard. @react-three/flex brings the webs flexbox spec to react-three-fiber.
It is based on Yoga, Facebook's open source layout engine for react-native.

  1. ``` sh
  2. npm install @react-three/flex
  3. ```

These demos are real, you can click them! They contain the full code, too.


Table of contents


- Usage
  - Anchors
  - Stretching
  - Invalidation and Reflow
  - Sizing
  - Axis Orientation
  - Margin and Padding
  - Nesting
  - Measuring the Container
- API
  - Flexbox props

Usage


Simply create layouts by wrapping your 3D objects in different `` instances inside a `` container. This way they will be automatically placed in the 3D space following the flexbox specification just like in the DOM.

  1. ``` js
  2. import { Flex, Box } from '@react-three/flex'

  4. const Layout = () => (
  5.   <Flex justifyContent="center" alignItems="center">
  6.     <Box centerAnchor>
  7.       <mesh geometry={box} />
  8.     </Box>
  9.     <Box centerAnchor flexGrow={1}>
  10.       <mesh geometry={torus} />
  11.     </Box>
  12.   </Flex>
  13. )
  14. ```

You can tweak the container and the boxes using standard CSS flex properties, like flexDirection or justifyContent for the container and flexGrow for the boxes. There are also _shorthands_, like align and justify. See the props docs below for more info.

Anchors


When positioning items, react-three-flex needs to know where the object anchor is: Yoga Layout expects the object position to be relative to the upper left corner, which is the same as the DOM expects.

Most THREE.js geometries, though, are positioned relative to the object center. To tell `react-three-flex` that your `` positioning is relative to the center you need to set the `centerAnchor` prop to true.

  1. ``` js
  2. <Box centerAnchor>
  3.   <mesh geometry={sphere} />
  4. </Box>
  5. ```

If you nest `` elements, though, you need to set it to false. See [Nesting](#nesting).

Anchors

Stretching


By default @react-three/flex controls elements position only. In some cases you may want to control element sizing too. Since @react-three/flex has no information about how the inner content size works, you need to set your content size manually. To do so @react-three/flex provides you the container size in two ways:

- Using a children render function:

  1. ``` js
  2. <Flex>
  3.   <Box width="auto" height="auto" flexGrow={1} centerAnchor>
  4.     {(width, height) => <Plane args={[width, height]} />}
  5.   </Box>
  6. </Flex>
  7. ```

- Using a hook:

  1. ``` js
  2. function Inner() {
  3.   const [width, height] = useFlexSize()
  4.   return <Plane args={[width, height]} />
  5. }

  7. function Outer() {
  8.   return (
  9.     <Flex>
  10.       <Box width="auto" height="auto" flexGrow={1} centerAnchor>
  11.         <Inner />
  12. ```

Remember that the `useFlexSize` hook works **ONLY** if your `` is outside the component.

Invalidation and Reflow


While the DOM's Flexbox has full control over all the changes of the tree, @react-three/flex runs on React, hence it has no way to know if a children size or shape has changed. For performance reasons Flex layout calculation _does not run every frame_, and it has to be triggered manually in some cases.

What will trigger a reflow:

- `` props changes (alignItems, size, ...)- `` props changes (flexGrow, margin, ...)- `` and `` rerenders with children differences

  1. ``` js
  2. function AnimatedBox() {
  3.   // Since is inside the component, setting the state will rerender it, thus causing a reflow.
  4.   // ⚠️ If were outside this component, this would NOT cause a reflow!
  5.   const [state, setState] = useState(true)
  6.   useInterval(() => setState((s) => !s), 1000)
  7.   return (
  8.     <Box centerAnchor>
  9.       <mesh>
  10.         <boxBufferGeometry attach="geometry" args={[state ? 10 : 30, 10, 10]} />
  11. ```

This will NOT cause a reflow!

  1. ``` js
  2. function AnimatedBox() {
  3.   // ⚠️ Setting state does not rerender since it's in the parent
  4.   // ‼️ No Reflow!!
  5.   const [state, setState] = useState(true)
  6.   useInterval(() => setState((s) => !s), 1000)
  7.   return (
  8.     <mesh scale={[state ? 1 : 3, 1, 1]}>
  9.       <boxBufferGeometry attach="geometry" />
  10.     </mesh>
  11.   )
  12. }

  14. function Layout() {
  15.   return (
  16.     <Flex>
  17.       <Box centerAnchor>
  18.         <AnimatedBox />
  19. ```

For every other case (setting size with the `useFrame` hook, performing `react-spring` animation, or `` are not rerendered) you'll need to **manually cause a reflow**, using the `useReflow()` hook. Reflows requests are batched every frame so you can call it from hundreds of components without performance issues.

Animation with useFrame():

  1. ``` js
  2. function AnimatedBox() {
  3.   const ref = useRef()
  4.   const reflow = useReflow()
  5.   useFrame(({ clock }) => {
  6.     ref.current.scale.x = 1 + Math.sin(clock.getElapsed())
  7.     reflow()
  8.   })
  9.   return (
  10.     <Box centerAnchor>
  11.       <mesh ref={ref}>
  12. ```

**`` outside of component:**

  1. ``` js
  2. function AnimatedBox() {
  3.   const [state, setState] = useState(true)
  4.   useInterval(() => setState((s) => !s), 1000)
  5.   const reflow = useReflow()
  6.   useEffect(reflow, [state])
  7.   return (
  8.     <mesh ref={ref} scale={[state ? 1 : 3, 1, 1]}>
  9. ```

Sizing


@react-three/flex differs from DOM Flexbox in that it relies on a parent container for the root flex. It is required to specify its dimensions using size prop for wrapping and to be responsive.

  1. ``` js
  2. <Flex flexDirection="row" flexWrap="wrap" size={[300, 200, 0]}>
  3.   {/* ... */}
  4. </Flex>
  5. ```

⚠️ WATCH OUT! Yoga flexbox engine uses whole integer numbers to perform layout calculation to preserve precision - @react-three/flex multiplies every element size and flex prop by the scaleFactor of the root flex container. By default it's 100, and works well for small scenes. If you use a different scene scale, make sure to tweak it accordingly.

Bounds

Axis Orientation


Another important difference with DOM Flexbox is that you have to specify the plane of the container in 3D. The elements will be positioned in the 2D plane given by the two axes, using width and height calculated along the two axes.

The 2D flex container width and height will be calculated by looking at the size prop with respect of the chosen axes (100 for x and 200 for y in this example).

The default plane is xy, the other possibilites are yz and xz.

  1. ``` js
  2. <Flex plane="xy" size={[100, 200, 0]}>
  3.   {/* ... */}
  4. </Flex>
  5. ```

Axes Orientation

Margin and Padding


For every `` and `` component you can specify the margin and padding like in DOM elements.

  1. ``` js
  2. <Flex flexDirection="row" size={[300, 200, 0]} padding={30} margin={5}>
  3.   <Box padding={5} marginTop={5} centerAnchor>
  4.     <mesh geometry={sphere} />
  5.   </Box>
  6. </Flex>
  7. ```

Margin

Nesting


Since a `` component works the same way as a DOM one, you can easily make complex layouts by nesting flex containers.

  1. ``` js
  2. <Flex flexDirection="row" flexWrap="wrap" size={[50, 0, 0]}>
  3.   <Box centerAnchor>
  4.     <mesh geometry={sphere} />
  5.   </Box>
  6.   <Box flexDirection="column" flexWrap="no-wrap">
  7.     <Box centerAnchor>
  8.       <mesh geometry={sphere} />
  9.     </Box>
  10.     <Box centerAnchor>
  11.       <mesh geometry={box} />
  12.     </Box>
  13.   </Box>
  14. </Flex>
  15. ```

Measuring the container


When building responsive layouts you might need to synchronize the size of the 3D Flex container with the DOM, for example to synchronize scroll position or to modify the height of a scroll container.
To make it easier, you can use the `onReflow` prop on the root `` component that will be called every time the flex layout is recalculated - e.g. when any content changes.

  1. ``` js
  2. <Flex onReflow={(totalWidth, totalHeight) => ...}>
  3. {/* ... */}
  4. </Flex>
  5. ```

API


You can find a full list of props here.

  1. ``` js
  2. <Flex
  3.   size={[1, 1, 1]} // Total size of the flex container, see above
  4.   position={[0, 0, 0]} // Default - position for the flex container in the scene
  5.   direction="ltr" // Default - right to left or right to left
  6.   plane="xy" // Default - plane axes, see above
  7.   scaleFactor={100} // Default - integer scale factor, see above (Sizing)
  8.   onReflow={fn} // Called everytime the layout is recalculated
  9.   {...R3FlexProps} // Standard Flexbox props, described below
  10. >
  11.   <Box>{/* ... */}</Box>
  12. </Flex>
  13. ```

  1. ``` js
  2. <Box
  3.   centerAnchor // If the inner content position is relative to its center, see above (Anchors)
  4.   {...R3FlexProps} // Standard Flexbox props, described below
  5. >
  6.   <mesh geometry={box} />
  7. </Box>
  8. ```

Or you can pass a function as children:

  1. ``` js
  2. <Box>{(width, height) => <Model width={width} height={height} />}Box>
  3. ```

Flexbox props


Both `` and `` components share the same Flexbox props API from Yoga. The library also provides string and number inputs for convenience and shorthands.

Example:

  1. ``` js
  2. // Flex with padding top set to 10, alignItems to 'center', justifyContent to 'space-around' and flexWrap to 'wrap'
  3. <Flex pt={10} align="center" justify="space-around" wrap="wrap">
  4.   {/* ... */}
  5. </Flex>
  6. ```