API Reference

Fresh

The complete React Three Fiber API reference. All APIs are built on top of three.js — when in doubt, consult the three.js documentation alongside these pages.

In This Section

• Canvas - The root component that sets up your scene, camera, renderer, and render loop
• Objects - How to declare three.js objects, constructor arguments, shortcuts, and attach
• Events - Pointer events, clicks, scroll, event propagation and bubbling
• Hooks - useFrame, useThree, useLoader, useGraph and more
• Additional Exports - Utility exports like addEffect, extend, createPortal, invalidate
• TypeScript - Typing refs, props, custom elements, and extending ThreeElements
• Testing - Unit testing R3F scenes with @react-three/test-renderer