6.0.0 • Published 14 days ago

@capacitor/browser v6.0.0

Weekly downloads
331
License
MIT
Repository
github
Last release
14 days ago

@capacitor/browser

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

On iOS, this uses SFSafariViewController and is compliant with leading OAuth service in-app-browser requirements.

Install

npm install @capacitor/browser
npx cap sync

Android

Variables

This plugin will use the following project variables (defined in your app's variables.gradle file):

  • $androidxBrowserVersion: version of androidx.browser:browser (default: 1.4.0)

Example

import { Browser } from '@capacitor/browser';

const openCapacitorSite = async () => {
  await Browser.open({ url: 'http://capacitorjs.com/' });
};

API

open(...)

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

Open a page with the specified options.

ParamType
optionsOpenOptions

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('browserFinished', ...)

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

Android & iOS only: Listen for the browser finished event. It fires when the Browser is closed by the user.

ParamType
eventName'browserFinished'
listenerFunc() => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0


addListener('browserPageLoaded', ...)

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

Android & iOS only: Listen for the page loaded event. It's only fired when the URL passed to open method finish loading. It is not invoked for any subsequent page loads.

ParamType
eventName'browserPageLoaded'
listenerFunc() => void

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0


removeAllListeners()

removeAllListeners() => Promise<void>

Remove all native listeners for this plugin.

Since: 1.0.0


Interfaces

OpenOptions

Represents the options passed to open.

PropTypeDescriptionSince
urlstringThe URL to which the browser is opened.1.0.0
windowNamestringWeb only: Optional target for browser open. Follows the target property for window.open. Defaults to _blank. Ignored on other platforms.1.0.0
toolbarColorstringA 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

PropType
remove() => Promise<void>
6.0.0

25 days ago

6.0.0-rc.1

2 months ago

6.0.0-rc.0

3 months ago

5.2.0

3 months ago

6.0.0-beta.1

5 months ago

6.0.0-beta.0

5 months ago

6.0.0-alpha.1

6 months ago

6.0.0-alpha.2

6 months ago

5.0.6

10 months ago

5.0.5

11 months ago

5.1.0

8 months ago

5.0.3

11 months ago

5.0.2

1 year ago

5.0.1

1 year ago

5.0.0

1 year ago

5.0.0-beta.1

1 year ago

5.0.0-beta.0

1 year ago

5.0.0-alpha.1

1 year ago

4.1.1

1 year ago

4.1.0

1 year ago

4.0.0-beta.2

2 years ago

4.0.0-beta.0

2 years ago

4.0.1

2 years ago

4.0.0

2 years ago

1.0.7

2 years ago

1.0.6

3 years ago

1.0.5

3 years ago

1.0.4

3 years ago

1.0.3

3 years ago

1.0.2

3 years ago

1.0.1

3 years ago

0.4.10

3 years ago

1.0.0

3 years ago

0.4.9

3 years ago

0.4.8

3 years ago

0.4.7

3 years ago

0.4.6

3 years ago

0.4.5

3 years ago

0.4.3

3 years ago

0.4.2

3 years ago

0.4.1

3 years ago

0.4.0

3 years ago

0.3.0

3 years ago

0.2.4

3 years ago

0.2.3

3 years ago

0.2.2

3 years ago

0.2.1

3 years ago

0.2.0

3 years ago

0.1.0

4 years ago

0.0.1

4 years ago