npm install @capgo/inappbrowser
npx cap sync

import { InAppBrowser } from '@capgo/inappbrowser'

InAppBrowser.open({ url: "YOUR_URL" });

Web platform is not supported. Use window.open instead.

if you need the Camera to work in Android, you need to add the following to your AndroidManifest.xml file:

<uses-permission android:name="android.permission.CAMERA" />

Then the permission will be asked when the camera is used.

• open(...)
• clearCookies(...)
• getCookies(...)
• close()
• openWebView(...)
• executeScript(...)
• setUrl(...)
• addListener('urlChangeEvent', ...)
• addListener('closeEvent', ...)
• addListener('confirmBtnClicked', ...)
• removeAllListeners()
• reload()
• Interfaces
• Type Aliases
• Enums

open(options: OpenOptions) => Promise<any>

Open url in a new window fullscreen

Returns: Promise<any>

Since: 0.1.0

clearCookies(options: ClearCookieOptions) => Promise<any>

Clear cookies of url

Returns: Promise<any>

Since: 0.5.0

getCookies(options: GetCookieOptions) => Promise<Record<string, string>>

Get cookies for a specific URL.

Returns: Promise<Record<string, string>>

close() => Promise<any>

Returns: Promise<any>

openWebView(options: OpenWebViewOptions) => Promise<any>

Open url in a new webview with toolbars

Returns: Promise<any>

Since: 0.1.0

executeScript({ code }: { code: string; }) => Promise<void>

Injects JavaScript code into the InAppBrowser window.

setUrl(options: { url: string; }) => Promise<any>

Returns: Promise<any>

addListener(eventName: "urlChangeEvent", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle>

Listen for url change, only for openWebView

Returns: Promise<PluginListenerHandle>

Since: 0.0.1

addListener(eventName: "closeEvent", listenerFunc: UrlChangeListener) => Promise<PluginListenerHandle>

Listen for close click only for openWebView

Returns: Promise<PluginListenerHandle>

Since: 0.4.0

addListener(eventName: "confirmBtnClicked", listenerFunc: ConfirmBtnListener) => Promise<PluginListenerHandle>

Will be triggered when user clicks on confirm button when disclaimer is required, works only on iOS

Returns: Promise<PluginListenerHandle>

Since: 0.0.1

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Since: 1.0.0

reload() => Promise<any>

Reload the current web page.

Returns: Promise<any>

Since: 1.0.0

Omit<HttpCookie, 'key' | 'value'>

Construct a type with the properties of T except for those in type K.

Pick<T, Exclude<keyof T, K>>

From T, pick a set of properties whose keys are in the union K

{ [P in K]: T[P]; }

Exclude from T those types that are assignable to U

T extends U ? never : T

Construct a type with a set of properties K of type T

{ [P in K]: T; }

Omit<HttpCookie, 'key' | 'value'>

(state: UrlEvent): void

(state: BtnEvent): void

Credits

• WKWebViewController - for iOS
• CapBrowser - For the base in capacitor v2