See how Capacitor fits into the entire Ionic Ecosystem ->
Capacitor is part of the Ionic Ecosystem ->

@capacitor/browser

The Browser API provides the ability to open an in-app browser and subscribe to browser events.

Install

npm install @capacitor/browser
npx cap sync

API

open(…)

open(options: BrowserOpenOptions) => Promise<void>

Open a page with the specified options.

Param Type
options BrowserOpenOptions

Since: 1.0.0


close()

close() => Promise<void>

Web & iOS only: Close an open browser window.

No-op on other platforms.

Since: 1.0.0


addListener(…)

addListener(eventName: 'browserFinished', listenerFunc: () => void) => PluginListenerHandle

Android & iOS only: Listen for the loading finished event.

Param Type
eventName "browserFinished"
listenerFunc () => void

Returns: PluginListenerHandle

Since: 1.0.0


addListener(…)

addListener(eventName: 'browserPageLoaded', listenerFunc: () => void) => PluginListenerHandle

Android & iOS only: Listen for the page loaded event.

Param Type
eventName "browserPageLoaded"
listenerFunc () => void

Returns: PluginListenerHandle

Since: 1.0.0


removeAllListeners()

removeAllListeners() => void

Remove all native listeners for this plugin.

Since: 1.0.0


Interfaces

BrowserOpenOptions

Represents the options passed to open.

Prop Type Description Since
url string The URL to which the browser is opened. 1.0.0
windowName string Web only: Optional target for browser open. Follows the target property for window.open. Defaults to _blank. Ignored on other platforms. 1.0.0
toolbarColor string A hex color to which the toolbar color is set. 1.0.0
presentationStyle "fullscreen" | "popover" iOS only: The presentation style of the browser. Defaults to fullscreen. Ignored on other platforms. 1.0.0

PluginListenerHandle

Prop Type
remove () => void
Previous
<- App Launcher
Next
Clipboard ->