Skip to main content

Interface: TimelineProviderProps

Props for the TimelineProvider component. Defines the configuration options for timeline context initialization.

Example

<TimelineProvider
contextId="my-timeline"
initialData={{ tracks: [], version: 1 }}
undoRedoPersistenceKey="timeline-state"
maxHistorySize={50}
>
<YourApp />
</TimelineProvider>

Table of contents

Properties

Properties

children

children: ReactNode

React children to wrap with timeline context

Defined in

context/timeline-context.tsx:111


contextId

contextId: string

Unique identifier for this timeline context

Defined in

context/timeline-context.tsx:113


resolution

Optional resolution: Size

resolution of the video

Defined in

context/timeline-context.tsx:115


initialData

Optional initialData: ProjectJSON

Initial timeline data to load

Defined in

context/timeline-context.tsx:117


undoRedoPersistenceKey

Optional undoRedoPersistenceKey: string

Key for persisting undo/redo state

Defined in

context/timeline-context.tsx:119


maxHistorySize

Optional maxHistorySize: number

Maximum number of history states to keep

Defined in

context/timeline-context.tsx:121


analytics

Optional analytics: AnalyticsConfig

Analytics configuration. Set to { enabled: false } to disable tracking.

Defined in

context/timeline-context.tsx:126