Usage notes
Use these options when a canvas timeline needs keyboard navigation without
rendering one DOM button per clip. `selectOnNavigate` is useful for inspector
workflows; leave it disabled when navigation should move a virtual cursor
without mutating timeline selection.
Signature
Interface TimelineClipNavigationOptionsType parameters
| Name | Constraint | Default | Description |
|---|---|---|---|
TrackKind | None | string | App-defined track kind values passed to custom label and description formatters. |
Properties
| Name | Signature | Description |
|---|---|---|
getClipAriaDescription? | (clip: Clip, track: Track<TrackKind>): string | Optional accessible description formatter for a canvas-rendered clip. |
getClipAriaLabel? | (clip: Clip, track: Track<TrackKind>): string | Optional accessible label formatter for a canvas-rendered clip. |
initialClipId? | initialClipId?: string | null | Initial active clip id. Defaults to selected clip, then the first clip. |
selectOnNavigate? | selectOnNavigate?: boolean | Whether navigation also selects the active clip in the engine. Defaults to false. |
wrap? | wrap?: boolean | Whether next/previous navigation wraps around the clip list. Defaults to true. |