uframe

Appearance

uframe / UframeEditorHandle

Interface: UframeEditorHandle ​

Defined in: client.ts:42

Properties ​

destroy ​

ts
destroy: () => void;

Defined in: client.ts:54

Returns ​

void

iframe ​

ts
iframe: HTMLIFrameElement;

Defined in: client.ts:43

loadPlugins ​

ts
loadPlugins: (urls) => void;

Defined in: client.ts:52

Dynamically load + register plugin dist modules by URL at runtime.

Parameters ​

urls ​

string[]

Returns ​

void

requestSave ​

ts
requestSave: () => void;

Defined in: client.ts:53

Returns ​

void

setActivePage ​

ts
setActivePage: (pageId) => void;

Defined in: client.ts:48

Switch the active page from the host.

Parameters ​

pageId ​

string

Returns ​

void

setDocument ​

ts
setDocument: (document) => void;

Defined in: client.ts:44

Parameters ​

document ​

PageDocument

Returns ​

void

setPages ​

ts
setPages: (pages, activePageId?) => void;

Defined in: client.ts:46

Replace the whole page set (multi-page mode).

Parameters ​

pages ​

PageDocument[]

activePageId? ​

string

Returns ​

void

setReadonly ​

ts
setReadonly: (readonly) => void;

Defined in: client.ts:49

Parameters ​

readonly ​

boolean

Returns ​

void

setTheme ​

ts
setTheme: (theme) => void;

Defined in: client.ts:50

Parameters ​

theme ​

UframeTheme

Returns ​

void