@dremchee/uframe / UframeEditorHandle

Interface: UframeEditorHandle

Defined in: embed/client.ts:71

Properties

destroy

destroy: () => void;

Defined in: embed/client.ts:105

Returns

void

---

iframe

iframe: HTMLIFrameElement;

Defined in: embed/client.ts:72

---

loadPlugins

loadPlugins: (urls) => void;

Defined in: embed/client.ts:97

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

Parameters

urls

string[]

Returns

void

---

openAddBreakpoint

openAddBreakpoint: () => void;

Defined in: embed/client.ts:95

Open the Settings panel with the New breakpoint form.

Returns

void

---

requestSave

requestSave: () => void;

Defined in: embed/client.ts:104

Returns

void

---

setActivePage

setActivePage: (pageId) => void;

Defined in: embed/client.ts:77

Switch the active page from the host.

Parameters

pageId

string

Returns

void

---

setAsset

setAsset: (requestId, asset) => void;

Defined in: embed/client.ts:103

Reply to an onRequestAsset with the chosen asset (or null if cancelled).

Parameters

requestId

string

asset

AssetPick | null

Returns

void

---

setDataContext

setDataContext: (context) => void;

Defined in: embed/client.ts:101

Push sample data used to preview bound / repeated blocks.

Parameters

context

ResolveContext

Returns

void

---

setDocument

setDocument: (document) => void;

Defined in: embed/client.ts:73

Parameters

document

PageDocument

Returns

void

---

setEditBreakpoint

setEditBreakpoint: (breakpoint) => void;

Defined in: embed/client.ts:88

Select a responsive breakpoint by its document-defined ID.

Parameters

breakpoint

string

Returns

void

---

setGlobals

setGlobals: (globals) => void;

Defined in: embed/client.ts:79

Push the shared context (or null for single-document mode).

Parameters

globals

GlobalSettings | null

Returns

void

---

setLocale

setLocale: (locale) => void;

Defined in: embed/client.ts:90

Parameters

locale

string

Returns

void

---

setMessages

setMessages: (messages) => void;

Defined in: embed/client.ts:91

Parameters

messages

UframeMessages

Returns

void

---

setPages

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

Defined in: embed/client.ts:75

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

Parameters

pages

PageDocument[]

activePageId?

string

Returns

void

---

setReadonly

setReadonly: (readonly) => void;

Defined in: embed/client.ts:80

Parameters

readonly

boolean

Returns

void

---

setSchema

setSchema: (schema) => void;

Defined in: embed/client.ts:99

Push the collection schema for the binding picker.

Parameters

schema

NormalizedSchema

Returns

void

---

setState

setState: (state) => void;

Defined in: embed/client.ts:82

Update one or more public editor UI-state fields.

Parameters

state

Partial<UframeEditorState>

Returns

void

---

setStyleTokens

setStyleTokens: (tokens) => void;

Defined in: embed/client.ts:93

Parameters

tokens

EditorStyleTokens

Returns

void

---

setTheme

setTheme: (theme) => void;

Defined in: embed/client.ts:89

Parameters

theme

UframeTheme

Returns

void

---

setToolbarVisible

setToolbarVisible: (visible) => void;

Defined in: embed/client.ts:84

Show or hide the editor's built-in toolbar.

Parameters

visible

boolean

Returns

void

---

setUiTheme

setUiTheme: (theme) => void;

Defined in: embed/client.ts:92

Parameters

theme

EditorUiTheme

Returns

void

---

setViewport

setViewport: (viewport) => void;

Defined in: embed/client.ts:86

Change the canvas viewport without showing the editor toolbar.

Parameters

viewport

PageViewport

Returns

void