SurfaceHover

What useSurfaceHover returns.

@internote/canvas-sdk/reactInterface
On this page
import { SurfaceHover } from '@internote/canvas-sdk/react';

#Fields

bindRequired
The props for the surface, reading what is under the pointer through pick.
SurfaceHoverProps
clearRequired
Clears whatever is hovered or pinned.
() => void
hoveredRequired
What is hovered or pinned now, or null.
T | null
itemRequired
The props for one element, which is value while it is pointed at.
(value: T) => SurfaceHoverProps
pinnedRequired
Whether hovered is a finger's pin rather than a mouse's hover.
boolean

Declared in packages/canvas-sdk/src/react/use-surface-hover.ts:66.

Last updated