@capacitor/browser

Browser API 提供打开应用内浏览器及订阅浏览器事件的功能。

在 iOS 平台，该 API 使用 SFSafariViewController，符合主流 OAuth 服务对应用内浏览器的要求。

安装

npm install @capacitor/browser
npx cap sync

Android 配置

变量配置

本插件会使用以下项目变量（需在应用的 variables.gradle 文件中定义）：

• $androidxBrowserVersion: androidx.browser:browser 的版本号（默认值：1.4.0）

示例

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

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

API 文档

• open(...)
• close()
• addListener('browserFinished', ...)
• addListener('browserPageLoaded', ...)
• removeAllListeners()
• 接口定义

open(...)

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

使用指定选项打开页面。

参数	类型
options	OpenOptions

自版本： 1.0.0

---

close()

close() => Promise<void>

仅限 Web & iOS 平台：关闭已打开的浏览器窗口。

在其他平台无操作。

自版本： 1.0.0

---

addListener('browserFinished', ...)

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

仅限 Android & iOS 平台：监听浏览器完成事件。 当用户关闭浏览器时触发。

参数	类型
eventName	'browserFinished'
listenerFunc	() => void

返回值：

Promise<PluginListenerHandle> & PluginListenerHandle

自版本： 1.0.0

---

addListener('browserPageLoaded', ...)

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

仅限 Android & iOS 平台：监听页面加载完成事件。 仅当通过 open 方法传入的 URL 完成加载时触发。 不触发后续页面加载事件。

参数	类型
eventName	'browserPageLoaded'
listenerFunc	() => void

返回值：

Promise<PluginListenerHandle> & PluginListenerHandle

自版本： 1.0.0

---

removeAllListeners()

removeAllListeners() => Promise<void>

移除该插件所有原生事件监听器。

自版本： 1.0.0

---

Interfaces

OpenOptions

表示传递给 open 方法的选项。

属性	类型	描述	版本
url	string	要打开的浏览器 URL	1.0.0
windowName	string	仅限 Web 平台：可选浏览器打开目标。遵循 window.open 的 target 属性。默认为 _blank。其他平台忽略此选项。	1.0.0
toolbarColor	string	设置工具栏颜色的十六进制值	1.0.0
presentationStyle	'fullscreen' | 'popover'	仅限 iOS 平台：浏览器呈现样式。默认为全屏。其他平台忽略此选项。	1.0.0
width	number	仅限 iOS 平台：当在 iPad 上使用 'popover' 呈现样式时的浏览器宽度。其他平台忽略此选项。	4.0.0
height	number	仅限 iOS 平台：当在 iPad 上使用 'popover' 呈现样式时的浏览器高度。其他平台忽略此选项。	4.0.0

PluginListenerHandle

属性	类型
remove	() => Promise<void>