Interface

UseTimelineTimePositionOptions

Options for `useTimelineTimePosition`.

Usage notes

Use this primitive for a small number of DOM affordances that should move with timeline time without causing React renders on every scroll, scrub, or playback tick. The engine converts time to viewport X coordinates; the hook writes the transform directly to the referenced element.

Signature

Type Definition
Interface UseTimelineTimePositionOptions

Properties

NameSignatureDescription
engineengine: TimelineEngineTimeline engine that converts time to viewport-space pixels.
getTime?(): RationalTimeOptional resolver for imperative event-driven updates.
positionEvents?positionEvents?: TimelineTimePositionEvent[]Event names that should re-sync DOM position without a React render.
timetime: RationalTimeCurrent time represented by the positioned element.