glodrei
Version:
useful add-ons for react-three-fiber
29 lines (21 loc) • 732 B
text/mdx
title: Helper / useHelper
sourcecode: src/core/Helper.tsx
[](https://drei.vercel.app/?path=/story/gizmos-helper)
A hook for a quick way to add helpers to existing nodes in the scene. It handles removal of the helper on unmount and auto-updates it by default.
```jsx
const mesh = useRef()
useHelper(mesh, BoxHelper, 'cyan')
useHelper(condition && mesh, BoxHelper, 'red') // you can pass false instead of the object ref to hide the helper
<mesh ref={mesh} ... />
```
or with `Helper`:
```jsx
<mesh>
<boxGeometry />
<meshBasicMaterial />
<Helper type={BoxHelper} args={['royalblue']} />
<Helper type={VertexNormalsHelper} args={[1, 0xff0000]} />
</mesh>
```