Add maxScale to rrwebPlayer types and add docs to others (#1014)

This commit is contained in:
Justin Halsall
2026-04-01 12:00:00 +08:00
committed by GitHub
parent d809c6b9f7
commit 06dad675e5

View File

@@ -5,13 +5,50 @@ import { SvelteComponent } from 'svelte';
export type RRwebPlayerOptions = {
target: HTMLElement;
props: {
/**
* The events to replay.
* @default `[]`
*/
events: eventWithTime[];
/**
* The width of the replayer
* @defaultValue `1024`
*/
width?: number;
/**
* The height of the replayer
* @defaultValue `576`
*/
height?: number;
/**
* The maximum scale of the replayer (1 = 100%). Set to 0 for unlimited
* @defaultValue `1`
*/
maxScale?: number;
/**
* Whether to autoplay
* @defaultValue `true`
*/
autoPlay?: boolean;
/**
* The default speed to play at
* @defaultValue `1`
*/
speed?: number;
/**
* Speed options in UI
* @defaultValue `[1, 2, 4, 8]`
*/
speedOption?: number[];
/**
* Whether to show the controller UI
* @defaultValue `true`
*/
showController?: boolean;
/**
* Customize the custom events style with a key-value map
* @defaultValue `{}`
*/
tags?: Record<string, string>;
} & Partial<playerConfig>;
};