@sigx/lynx-webview

Native WebView component for sigx-lynx. WKWebView on iOS, android.webkit.WebView on Android.

Use for: OAuth fallback flows, embedded help / TOS / changelog pages, hybrid screens during an incremental migration to native.

Not Lynx's <webview>. ByteDance's Lynx team has confirmed they ship a <webview> element internally, but it isn't open-sourced (lynx-family/lynx#627). This package registers a sigx-flavored <sigx-webview> so apps can ship today.

📚 Documentation

Full prop reference, imperative methods, page↔app messaging, security notes and live examples → sigx.dev/lynx/modules/webview/overview

Install

pnpm add @sigx/lynx-webview

sigx prebuild auto-discovers the package and registers the <sigx-webview> UI on both platforms. No app-side wiring required.

A taste

import { WebView } from '@sigx/lynx-webview';

<WebView
    src="https://example.com"
    onLoad={(e) => console.log('loaded', e.detail.url)}
    onError={(e) => console.warn('failed', e.detail.message)}
    onMessage={(e) => console.log('page said', e.detail.data)}
/>

// Inline HTML works too — no network:
<WebView html="<h1>Hello from sigx-lynx</h1>" />

The native side injects window.sigx.postMessage(payload) for page→app messaging, and exposes imperative methods (goBack, reload, injectJavaScript, …) via a MainThreadRef or Lynx's SelectorQuery. Security defaults (http(s)-only src, sandboxed inline HTML, per-instance cookie stores), the full prop table and platform gotchas are documented on the docs site.

Web

Not supported on web. <sigx-webview> is a native UI element that sigx prebuild registers on iOS and Android only; the web build has its own registry of sigx custom elements (resolveWebElements in @sigx/lynx-cli's web-server.ts), and it carries exactly two — <sigx-richtext> and <sigx-touch-guard>. Nothing registers <sigx-webview> there, so on a sigx run:web build the tag has no implementation behind it and the component renders nothing.

A web implementation is possible — an <iframe>-backed custom element following @sigx/lynx-richtext's src/web/element.ts pattern, added to that registry — but it doesn't exist today. Until it does, keep web builds off this component (e.g. a .web.tsx sibling that links out via @sigx/lynx-linking's Linking.openURL, which the page bridge maps to window.open).

License

MIT