Skip to main content
Home
Works with
It is unknown whether this package works with Cloudflare Workers, Node.js, Deno, Bun, Browsers
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
It is unknown whether this package works with Deno
It is unknown whether this package works with Bun
It is unknown whether this package works with Browsers
JSR Score17%
Downloads132/wk
Published2 years ago (0.0.4)
v
_roots
No documentation available
v
act

Safely flush async effects when testing, simulating a legacy root.

f
addAfterEffect

Adds a global after-render callback which is called each frame.

f
addEffect

Adds a global render callback which is called each frame.

f
addTail

Adds a global callback which is called when rendering stops.

f
advance

Advances the frameloop and runs render effects, useful for when manually rendering via frameloop="never".

f
applyProps
No documentation available
f
buildGraph
No documentation available
v
Canvas

A DOM canvas which accepts threejs elements as children.

v
context
No documentation available
f
createEvents
No documentation available
f
createPortal
No documentation available
f
createRoot
No documentation available
f
dispose
No documentation available
f
events

Default R3F event manager for web

f
extend
No documentation available
f
flushGlobalEffects
No documentation available
f
getRootState

Returns instance root state

f
invalidate

Invalidates the view, requesting a frame to be rendered. Will globally invalidate unless passed a root's state.

v
ReactThreeFiber
No documentation available
v
reconciler
No documentation available
f
render
No documentation available
f
unmountComponentAtNode
No documentation available
f
useFrame

Executes a callback before render in a shared frame loop. Can order effects with render priority or manually render with a positive priority.

f
useGraph

Returns a node graph of an object with named nodes & materials.

f
useInstanceHandle

Exposes an object's Instance.

f
N
useLoader

Synchronously loads and caches assets with a three loader.

v
useLoader.clear

Removes a loaded asset from cache.

v
useLoader.preload

Preloads an asset into cache as a side-effect.

f
useStore

Returns the R3F Canvas' Zustand store. Useful for transient updates.

f
useThree

Accesses R3F's internal state, containing renderer, canvas, scene, etc.

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.