Skip to Content
HooksuseViewerHover

useViewerHover

Tracks which mesh the user is currently hovering in the viewer.

Usage

import { useViewerHover } from "@liveroom/react-immersive"; const { hoveredObjectBinding, handleHoveredObject } = useViewerHover(); <ModelViewer onObjectHover={handleHoveredObject} ... /> // hoveredObjectBinding is the currently hovered binding or null

Returns

NameTypeDescription
hoveredObjectBindingObjectBinding | nullThe currently hovered binding, or null
handleHoveredObject(binding: ObjectBinding | null) => voidCallback to pass to onObjectHover