Props Reference
Required Props
| Prop | Type | Description |
|---|---|---|
lesson | TeachariumLessonExport | The lesson data in export format |
You must provide either widgets or puckConfig:
| Prop | Type | Description |
|---|---|---|
widgets | TeachariumWidget[] | List of widgets (recommended for most cases) |
puckConfig | Config | Pre-built Puck config for advanced use cases |
Optional Props
| Prop | Type | Default | Description |
|---|---|---|---|
config | Partial<PlayerConfig> | {} | Player configuration options |
mode | "player" | "review" | "player" | Playback mode (review disables interactions) |
initialSessionState | SessionState | undefined | Resume from saved session state |
mediaResolvers | MediaResolverConfig | No-op | Hooks for resolving media URLs |
onStepChange | (state: SessionState) => void | undefined | Called at step boundaries for auto-saving |
onComplete | (result: CompletionResult) => void | undefined | Called when lesson completes |
additionalComponents | Record<string, ComponentConfig> | undefined | Extra Puck components (when using widgets) |
className | string | undefined | CSS class for container |
showStartButton | boolean | true | Show start button overlay |
startButtonText | string | "Start" | Custom start button text |
headerContent | React.ReactNode | undefined | Content above the player |
sideContent | React.ReactNode | undefined | Content alongside the player (e.g., debug panel) |