Usage

Give an embedded help page a reload action.

This type is used by webViewRef

tsx
// Give an embedded help page a reload action.
import { Button, WebView, VStack, webViewRef } from 'kuito';

export function Help() {
  const page = webViewRef();
  return (
    <VStack flex={1}>
      <Button
        disabled={page.loading.value}
        onPress={() => void page.current?.reload().catch(console.error)}
      >
        Reload help
      </Button>
      <WebView
        ref={page}
        src="https://example.com/help"
        allowedOrigins={['https://example.com']}
        flex={1}
      />
    </VStack>
  );
}

Type declaration

ts
export type WebViewRef = ElementRef<WebViewHandle> & {
  readonly url: ReadonlySignal<string>;
  readonly title: ReadonlySignal<string>;
  readonly loading: ReadonlySignal<boolean>;
  readonly canGoBack: ReadonlySignal<boolean>;
  readonly canGoForward: ReadonlySignal<boolean>;
};

Members 6

NameTypeRequiredDescription
currentWebViewHandleYes—
urlreadonlyReadonlySignal<string>Yes—
titlereadonlyReadonlySignal<string>Yes—
loadingreadonlyReadonlySignal<boolean>Yes—
canGoBackreadonlyReadonlySignal<boolean>Yes—
canGoForwardreadonlyReadonlySignal<boolean>Yes—
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.