UseTimelineTrackHeaderResult (react) API

Usage notes

This result extends UseTimelineTrackResult with a computed display label and DOM root props. It is the hook behind `Timeline.TrackHeader` and is useful when building custom shadcn-like header rows.

Signature

Interface UseTimelineTrackHeaderResult

Properties

Name	Signature	Description
`collapsed`	`collapsed: boolean`	Whether the track row is collapsed.
`exists`	`exists: boolean`	Whether the requested track exists.
`groupId`	`groupId: string \| undefined`	Optional track group id.
`height`	`height: number`	Expanded row height in pixels, matching canvas geometry.
`kind`	`kind: string \| null`	App-defined track kind, or null when the track is missing.
`label`	`label: string`	Human-readable label for the header row.
`locked`	`locked: boolean`	Whether the track is locked for editing.
`moveTrack`	`(toIndex: number): TimelineCommandResult`	Moves this track to a final zero-based row index.
`muted`	`muted: boolean`	Whether the track is muted.
`name`	`name: string \| undefined`	User-facing track name, when set.
`rect`	`rect: Readonly<TimelineTrackRect> \| null`	Viewport row rectangle matching canvas track geometry.
`renameTrack`	`(name: string \| undefined): TimelineCommandResult`	Renames this track, or clears its app-defined name.
`rootProps`	`rootProps: TimelineTrackHeaderRootProps`	Props for the root track header row element.
`selected`	`selected: boolean`	Whether the track itself is selected.
`selectTrack`	`(): TimelineCommandResult`	Selects this track.
`setCollapsed`	`(collapsed: boolean): TimelineCommandResult`	Sets this row's collapsed state.
`setLocked`	`(locked: boolean): TimelineCommandResult`	Sets this track's locked state.
`setMuted`	`(muted: boolean): TimelineCommandResult`	Sets this track's muted state.
`setTrackGroup`	`(groupId: string \| undefined): TimelineCommandResult`	Assigns this track to a group, or clears its group.
`setTrackHeight`	`(height: number): TimelineCommandResult`	Sets this track's expanded display height in pixels.
`setTrackTarget`	`(targeted: boolean): TimelineCommandResult`	Sets this track's edit-targeted state.
`setVisible`	`(visible: boolean): TimelineCommandResult`	Sets this track's output visibility.
`targeted`	`targeted: boolean`	Whether the track is targeted for edit operations.
`toggleCollapse`	`(): TimelineCommandResult`	Toggles this row's collapsed state.
`toggleLock`	`(): TimelineCommandResult`	Toggles this track's locked state.
`toggleMute`	`(): TimelineCommandResult`	Toggles this track's muted state.
`toggleTrackTarget`	`(): TimelineCommandResult`	Toggles this track's edit-targeted state.
`toggleVisibility`	`(): TimelineCommandResult`	Toggles this track's output visibility.
`track`	`track: object \| null`	Current track, or null when the id is missing.
`trackId`	`trackId: string`	Requested track id.
`trackIndex`	`trackIndex: number`	Zero-based track index, or -1 when the track is missing.
`visible`	`visible: boolean`	Whether the track participates in active layer and media lookup.