Usage

Embed a hosted help page

This type is used by WebView

tsx
import { WebView } from 'kuito';

export default function Help() {
  return <WebView flex={1} src="https://example.com/help" />;
}

Type declaration

ts
export type WebViewMethods = {
  goBack(): Promise<void>;
  goForward(): Promise<void>;
  reload(): Promise<void>;
  stop(): Promise<void>;
  /** Runs `script` in the main frame; its result and errors stay in the page. */
  injectJavaScript(script: string): Promise<void>;
  /** Dispatches a `message` event on the page's `window`, with `data` as `event.data`. */
  postMessage(data: string): Promise<void>;
};

Members 6

NameTypeRequiredDescription
goBack() => Promise<void>Yes—
goForward() => Promise<void>Yes—
reload() => Promise<void>Yes—
stop() => Promise<void>Yes—
injectJavaScript(script: string) => Promise<void>YesRuns script in the main frame; its result and errors stay in the page.
postMessage(data: string) => Promise<void>YesDispatches a message event on the page's window, with data as event.data.
goBack — method signatures

Signatures

ts
(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

goForward — method signatures

Signatures

ts
(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

reload — method signatures

Signatures

ts
(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

stop — method signatures

Signatures

ts
(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

injectJavaScript — method signatures

Signatures

ts
(script: string): Promise<void>

Parameters

NameTypeRequiredDescription
scriptstringYes—

Returns

Promise<void>

postMessage — method signatures

Signatures

ts
(data: string): Promise<void>

Parameters

NameTypeRequiredDescription
datastringYes—

Returns

Promise<void>

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.