跳到主要内容
版本:v3

Capacitor Web API

Capacitor 提供了一系列 JavaScript 实用工具,帮助开发者使用相同代码库确保应用能在多个平台上成功运行。要使用这些功能,需先导入 Capacitor 然后调用相应的工具函数:

Capacitor 对象

Capacitor 对象封装了多个实用函数。虽然可以通过 window.Capacitor 访问,但在现代 JavaScript 应用中推荐使用导入方式:

import { Capacitor } from '@capacitor/core';

convertFileSrc(...)

convertFileSrc: (filePath: string) => string;

将设备文件路径转换为适合 WebView 使用的路径。

由于 Capacitor 应用与设备文件使用不同的协议提供服务,为避免协议冲突,设备文件路径需要被重写。例如在 Android 平台,file:///path/to/device/file 必须转换为 http://localhost/_capacitor_file_/path/to/device/file 才能在 WebView 中使用。

// file:///path/to/device/photo.jpg
const savedPhotoFile = await Filesystem.writeFile({
path: "myFile.jpg",
data: base64Data,
directory: FilesystemDirectory.Data
});

// http://localhost/path/to/device/photo.jpg
const savedPhoto = Capacitor.convertFileSrc(savedPhotoFile.uri),
document.getElementById("savedPhoto").src = savedPhoto;
<img id="savedPhoto" />

getPlatform()

getPlatform: () => string;

获取当前应用运行平台的名称:webiosandroid

if (Capacitor.getPlatform() === 'ios') {
// iOS 平台专属逻辑
}

isNativePlatform()

isNativePlatform: () => boolean;

检测当前运行平台是否为原生平台(iosandroid)。

if (Capacitor.isNativePlatform()) {
// 原生平台专属逻辑
}

isPluginAvailable(...)

isPluginAvailable: (name: string) => boolean;

检查指定插件在当前平台是否可用。插件名称需使用在插件注册表中的名称,因此该方法也适用于自定义插件。

const isAvailable = Capacitor.isPluginAvailable('Camera');

if (!isAvailable) {
// 让用户改用文件上传方式
} else {
// 调用相机插件
const image = await Camera.getPhoto({
resultType: CameraResultType.Uri,
});
}