Skip to content

React API overview

Choose components or hooks to find their API.

Edge.Styles

Edge.Provider → Edge.Styles

Edge.Provider

Edge.Provider → Edge.Provider

Edge.Surface

Edge.Surface → Edge.Surface

useLight(options?)

useLight → useLight(options?)

light.refresh()

useLight → light.refresh()

useSurface(options?)

useSurface → useSurface(options?)

Rendering and cleanup

Content can be rendered on the server. Lighting starts after client mounting or hydration. Static HTML without client JavaScript has no lighting. Cleanup restores owned inline CSS variables, removes listeners and cancels pending frames; setup can restart in React StrictMode.

Edge.Surface includes appearance classes and variables in server HTML. useSurface leaves your markup unchanged until hydration. Geometry, fixed direction and pointer tracking require client code.

In Server Component frameworks, use Edge inside a client module marked with "use client".

bolerish/edge · React