@liquid-state/docviewer

@liquid-state/docviewer

Liquid State Docviewer Plugin

Install

npm install @liquid-state/docviewer
npx cap sync

API

• echo(...)
• launchNamedDocument(...)
• launchDocument(...)
• closeViewerIfAny()

echo(...)

echo(options: { value: string; }) => Promise<{ value: string; }>

Useless api that can be used to test the plugin

Param	Type	Description
options	{ value: string; }	value to echo back (no ui)

Returns: Promise<{ value: string; }>

---

launchNamedDocument(...)

launchNamedDocument(options: { name: string; page_slug?: string; config?: {}; }) => Promise<{ viewer_id: string; }>

Launch a built-in document using it's base file name (note: this is just the file name, not path)

Param	Type	Description
options	{ name: string; page_slug?: string; config?: {}; }	name, page_slug and config

Returns: Promise<{ viewer_id: string; }>

---

launchDocument(...)

launchDocument(options: { url: string; page_slug?: string; config?: {}; }) => Promise<{ viewer_id: string; }>

Launch a document using a local (on ios: file, on android: content) url

Param	Type	Description
options	{ url: string; page_slug?: string; config?: {}; }	url, page_slug and config

Returns: Promise<{ viewer_id: string; }>

---

closeViewerIfAny()

closeViewerIfAny() => Promise<void>

Close any currently open document viewer

---