WebViewHandle — Kuito Documentation

Usage

Reload and scroll an embedded page.

tsx

// Reload and scroll an embedded page.
import { Button, WebView, ref, type WebViewHandle } from 'kuito';

function Article() {
  const page = ref<WebViewHandle>();

  return (
    <>
      <WebView ref={page} src="https://example.com/article" flex={1} />
      <Button onPress={() => void page.current?.injectJavaScript('window.scrollTo(0, 0)')}>
        Top
      </Button>
      <Button onPress={() => void page.current?.reload()}>Reload</Button>
    </>
  );
}

Type declaration

export type WebViewHandle = NativeViewHandle<WebViewMethods>;

Members 15

Name	Type	Required	Description
`id`readonly	`string`	Yes	—
`parent`readonly	`ElementHandle`	Yes	—
`children`readonly	`ElementHandle[]`	Yes	—
`focus`	`() => void`	Yes	—
`blur`	`() => void`	Yes	—
`setProperty`	`<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] \| null) => void`	Yes	Sets a native prop on the view now, until its binding writes it again.
`addEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}) => void`	Yes	—
`removeEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean;}) => void`	Yes	—
`dispatchEvent`	`(event: { type: string; bubbles?: boolean; cancelable?: boolean;}) => boolean`	Yes	Sends an event through the tree, capture to bubble, as a native one travels: a `KuitoCustomEvent`, or any object with a `type`. False when a listener called `preventDefault()` on a cancelable event.
`goBack`	`() => Promise<void>`	Yes	—
`goForward`	`() => Promise<void>`	Yes	—
`reload`	`() => Promise<void>`	Yes	—
`stop`	`() => Promise<void>`	Yes	—
`injectJavaScript`	`(script: string) => Promise<void>`	Yes	Runs `script` in the main frame; its result and errors stay in the page.
`postMessage`	`(data: string) => Promise<void>`	Yes	Dispatches a `message` event on the page's `window`, with `data` as `event.data`.

focus — method signatures

Signatures

(): void

Parameters

No parameters.

Returns

void

blur — method signatures

Signatures

(): void

Parameters

No parameters.

Returns

void

setProperty — method signatures

Signatures

<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null): void

Type parameters

Name	Constraint	Default
`K`	`keyof ElementProperties`	—

Parameters

Name	Type	Required	Description
`key`	`K`	Yes	—
`value`	`ElementProperties[K]`	Yes	—

Returns

void

addEventListener — method signatures

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal; }): void

Parameters

Name	Type	Required	Description
`type`	`string`	Yes	—
`fn`	`(e: KuitoNativeEvent) => void`	Yes	—
`options`	`boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}`	No	—

Returns

void

removeEventListener — method signatures

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; }): void

Parameters

Name	Type	Required	Description
`type`	`string`	Yes	—
`fn`	`(e: KuitoNativeEvent) => void`	Yes	—
`options`	`boolean \| { capture?: boolean;}`	No	—

Returns

void

dispatchEvent — method signatures

Signatures

(event: { type: string; bubbles?: boolean; cancelable?: boolean; }): boolean

Parameters

Name	Type	Required	Description
`event`	`{ type: string; bubbles?: boolean; cancelable?: boolean;}`	Yes	—

Returns

boolean

goBack — method signatures

Signatures

(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

goForward — method signatures

Signatures

(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

reload — method signatures

Signatures

(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

stop — method signatures

Signatures

(): Promise<void>

Parameters

No parameters.

Returns

Promise<void>

injectJavaScript — method signatures

Signatures

(script: string): Promise<void>

Parameters

Name	Type	Required	Description
`script`	`string`	Yes	—

Returns

Promise<void>

postMessage — method signatures

Signatures

(data: string): Promise<void>

Parameters

Name	Type	Required	Description
`data`	`string`	Yes	—

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.