Add maxScale to rrwebPlayer types and add docs to others (#1014)
This commit is contained in:
37
packages/rrweb-player/typings/index.d.ts
vendored
37
packages/rrweb-player/typings/index.d.ts
vendored
@@ -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>;
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user