Interface

UseTimelineClipDragOptions

Options accepted by `useTimelineClipDrag`.

Usage notes

Pass renderer-aligned geometry so pointer Y coordinates resolve to the same track rows users see on screen. `canDropClipOnTrack` lets applications enforce domain rules such as preventing audio clips from moving to visual tracks unless a modifier key or tool mode allows it.

Signature

Type Definition
Interface UseTimelineClipDragOptions

Type parameters

NameConstraintDefaultDescription
TrackKindNonestringApp-defined track kind values carried by target tracks, such as `"visual" | "audio"`.

Properties

NameSignatureDescription
canDropClipOnTrack?canDropClipOnTrack?: TimelineTrackDropGuard<TrackKind>Optional app policy for accepting, rejecting, or expanding drop targets.
collapsedTrackHeight?collapsedTrackHeight?: numberCollapsed track height in pixels.
edgeThreshold?edgeThreshold?: numberMouse/pen edge hit threshold in pixels.
minVerticalSnapPixels?minVerticalSnapPixels?: numberMinimum vertical pixels required before snapping vertically. Defaults to 8.
rulerHeight?rulerHeight?: numberHeight of the top ruler region in pixels.
touchEdgeThreshold?touchEdgeThreshold?: numberTouch edge hit threshold in pixels.
trackHeight?trackHeight?: numberDefault expanded track height in pixels.
verticalSnapThreshold?verticalSnapThreshold?: numberPortion of another track the pointer must enter before snapping vertically. Defaults to 0.3.
viewportWidth?viewportWidth?: numberOptional viewport width used for track row geometry.