Types

These excerpts come from the types exported at the package root. Imports and dependency types are omitted; this is not a standalone module to copy.

The public navigation callback returns boolean | Promise<boolean>. Read props, methods, and events for behavior, lifecycle, and platform restrictions.

NitroWebViewProps

export interface NitroWebViewProps extends Omit<NativeNitroWebViewProps, 'onShouldStartLoadWithRequest'> {
    onShouldStartLoadWithRequest?: OnShouldStartLoadWithRequest;
}

NitroWebViewType

export type NitroWebViewType = Readonly<HybridView<HybridViewProps, NitroWebViewMethods>>;

HtmlSource

export interface HtmlSource {
    html: string;
    baseUrl?: string;
}

UriSource

export interface UriSource {
    uri: string;
    headers?: Record<string, string>;
    method?: WebViewSourceMethod;
    body?: string;
}

WebViewSource

export type WebViewSource = UriSource | HtmlSource;

WebViewSourceMethod

export type WebViewSourceMethod = 'GET' | 'POST';

NitroWebViewMethods

export interface NitroWebViewMethods extends HybridViewMethods {
    goBack(): void;
    goForward(): void;
    reload(): void;
    stopLoading(): void;
    evaluateJavaScript(code: string): Promise<string>;
    injectJavaScript(code: string): void;
    postMessage(data: string): void;
    getCookies(url: string): Promise<Cookie[]>;
    setCookie(url: string, cookie: Cookie): Promise<void>;
    clearCookies(): Promise<void>;
    clearCache(): Promise<void>;
    clearHistory(): Promise<void>;
    requestFocus(): Promise<void>;
}

WebViewLoadEvent

export interface WebViewLoadEvent {
    nativeEvent: WebViewNavigationState;
}

WebViewLoadProgressEvent

export interface WebViewLoadProgressEvent {
    nativeEvent: WebViewLoadProgressNativeEvent;
}

WebViewLoadProgressNativeEvent

export interface WebViewLoadProgressNativeEvent extends WebViewNavigationState {
    progress: number;
}

WebViewMessageEvent

export interface WebViewMessageEvent {
    nativeEvent: WebViewMessageNativeEvent;
}

WebViewMessageNativeEvent

export interface WebViewMessageNativeEvent {
    data: string;
    url: string;
    sourceOrigin?: string;
    isMainFrame?: boolean;
}

WebViewNavigationState

export interface WebViewNavigationState {
    url: string;
    title: string;
    loading: boolean;
    canGoBack: boolean;
    canGoForward: boolean;
}

WebViewNavigationType

export type WebViewNavigationType = 'click' | 'formsubmit' | 'backforward' | 'reload' | 'formresubmit' | 'other';

ShouldStartLoadRequest

export interface ShouldStartLoadRequest {
    url: string;
    navigationType: WebViewNavigationType;
    mainDocumentURL?: string;
    isTopFrame?: boolean;
    hasTargetFrame?: boolean;
}

NitroWebViewErrorEvent

export interface NitroWebViewErrorEvent {
    nativeEvent: NitroWebViewErrorNativeEvent;
}

NitroWebViewErrorNativeEvent

export interface NitroWebViewErrorNativeEvent {
    code: number;
    description: string;
    url: string;
    domain: string;
}

WebViewErrorEvent

export type WebViewErrorEvent = NitroWebViewErrorEvent;

NitroWebViewHttpErrorEvent

export interface NitroWebViewHttpErrorEvent {
    nativeEvent: NitroWebViewHttpErrorNativeEvent;
}

NitroWebViewHttpErrorNativeEvent

export interface NitroWebViewHttpErrorNativeEvent {
    statusCode: number;
    url: string;
    description: string;
}

NitroWebViewRenderProcessGoneEvent

export interface NitroWebViewRenderProcessGoneEvent {
    nativeEvent: NitroWebViewRenderProcessGoneNativeEvent;
}

NitroWebViewRenderProcessGoneNativeEvent

export interface NitroWebViewRenderProcessGoneNativeEvent {
    didCrash?: boolean;
}

NitroWebViewScrollEvent

export interface NitroWebViewScrollEvent {
    nativeEvent: NitroWebViewScrollNativeEvent;
}

NitroWebViewScrollNativeEvent

export interface NitroWebViewScrollNativeEvent {
    contentOffset: WebViewPoint;
    contentSize: WebViewPoint;
    contentInset?: WebViewPoint;
    layoutMeasurement?: WebViewPoint;
    zoomScale?: number;
}

WebViewPoint

export interface WebViewPoint {
    x: number;
    y: number;
}

OpenWindowEvent

export interface OpenWindowEvent {
    nativeEvent: OpenWindowNativeEvent;
}

OpenWindowNativeEvent

export interface OpenWindowNativeEvent {
    url: string;
}

Cookie

export interface Cookie {
    name: string;
    value: string;
    domain?: string;
    path?: string;
    expires?: number;
    secure?: boolean;
    httpOnly?: boolean;
}

FileDownload

export interface FileDownload {
    url: string;
    mimeType?: string;
    fileName?: string;
    contentLength?: number;
    userAgent?: string;
}

FileDownloadEvent

export interface FileDownloadEvent {
    nativeEvent: FileDownload;
}

OriginWhitelistGuard

export type OriginWhitelistGuard = (event: ShouldStartLoadRequest) => Promise<boolean>;

OnShouldStartLoadWithRequest

export type OnShouldStartLoadWithRequest = (event: ShouldStartLoadRequest) => boolean | Promise<boolean>;

LoadHtmlCommand

export interface LoadHtmlCommand {
    type: 'loadHtml';
    html: string;
    baseUrl?: string;
}

LoadUrlCommand

export interface LoadUrlCommand {
    type: 'loadUrl';
    url: string;
    method?: 'GET' | 'POST';
    body?: string;
}

NativeViewCommand

export type NativeViewCommand = LoadUrlCommand | LoadHtmlCommand;

LoadStartDispatcher

export type LoadStartDispatcher = (payload: NativeLoadStartPayload) => void;

NativeLoadStartPayload

export interface NativeLoadStartPayload {
    navigationId: number;
    url: string;
    title: string;
    loading: true;
    canGoBack: boolean;
    canGoForward: boolean;
}

OnLoadStart

export type OnLoadStart = NonNullable<NitroWebViewProps['onLoadStart']>;

LoadDispatcher

export type LoadDispatcher = (payload: NativeLoadPayload) => void;

NativeLoadPayload

export interface NativeLoadPayload {
    navigationId: number;
    url: string;
    title: string;
    loading: false;
    canGoBack: boolean;
    canGoForward: boolean;
}

OnLoad

export type OnLoad = NonNullable<NitroWebViewProps['onLoad']>;

LoadEndDispatcher

export type LoadEndDispatcher = (payload: NativeLoadEndPayload) => void;

LoadEndOutcome

export type LoadEndOutcome = 'success' | 'failure';

NativeLoadEndPayload

export interface NativeLoadEndPayload {
    navigationId: number;
    outcome: LoadEndOutcome;
    url: string;
    title: string;
    loading: false;
    canGoBack: boolean;
    canGoForward: boolean;
}

OnLoadEnd

export type OnLoadEnd = NonNullable<NitroWebViewProps['onLoadEnd']>;

BlobDownloadRequest

export interface BlobDownloadRequest {
    requestId: string;
    url: string;
    fileName: string;
}

BlobDownloadResult

export type BlobDownloadResult = BlobDownloadPayload | (BlobDownloadRequest & {
    error: string;
});

AndroidBridgeSandbox

export interface AndroidBridgeSandbox {
    [ANDROID_NATIVE_BRIDGE_NAME]?: AndroidNativeBridge;
    [BRIDGE_NAME]?: {
        postMessage?: (data: unknown) => void;
        [key: string]: unknown;
    };
}

AndroidNativeBridge

export interface AndroidNativeBridge {
    postMessage(data: string): void;
}

BridgePlatform

export type BridgePlatform = 'ios' | 'android';

IosBridgeSandbox

export interface IosBridgeSandbox {
    webkit?: {
        messageHandlers?: {
            [BRIDGE_NAME]?: WebKitMessageHandler;
        };
    };
    [BRIDGE_NAME]?: {
        postMessage?: (data: unknown) => void;
        [key: string]: unknown;
    };
}

WebKitMessageHandler

export interface WebKitMessageHandler {
    postMessage(data: unknown): void;
}