跳到主要内容
版本：v5

@capacitor/browser

Browser API 提供了打开应用内浏览器和订阅浏览器事件的能力。

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

安装​

npm install @capacitor/browser@latest-5
npx cap sync

Android​

变量配置​

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

  • androidxBrowserVersion: androidx.browser:browser 的版本（默认值：1.5.0）

示例​

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

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

API 文档​

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 完成加载时才会触发。 后续页面加载不会触发此事件。

参数Type
eventName'browserPageLoaded'
listenerFunc() => void

返回值: 

Promise<PluginListenerHandle> & PluginListenerHandle

自版本: 1.0.0

removeAllListeners()​

removeAllListeners() => Promise<void>

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

自版本: 1.0.0

Interfaces​

OpenOptions​

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

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

PluginListenerHandle​

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

Contents

编辑此页