Capacitor Web API
Capacitor 提供了一系列 JavaScript 工具函数,帮助开发者使用同一套代码库确保应用能在多个平台上成功运行。要使用它们,请先导入 Capacitor,然后调用所需的工具函数:
Capacitor 对象
Capacitor 对象是多个工具函数的容器。它可以通过 window.Capacitor 访问,但对于现代 JavaScript 应用,建议使用导入方式:
import { Capacitor } from '@capacitor/core';
convertFileSrc(...)
convertFileSrc: (filePath: string) => string;
将设备文件路径转换为 Web 视图友好的路径。
Capacitor 应用使用的协议与设备文件协议不同。为了避免这些协议之间的冲突,指向设备文件的路径必须被重写。例如在 Android 上,file:///path/to/device/file 在 Web 视图中使用前必须重写为 http://localhost/_capacitor_file_/path/to/device/file。
// 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;
获取应用当前运行平台的名称:web、ios 或 android。
if (Capacitor.getPlatform() === 'ios') {
// 执行特定操作
}
isNativePlatform()
isNativePlatform: () => boolean;
检查当前运行平台是否为原生平台(ios 或 android)。
if (Capacitor.isNativePlatform()) {
// 执行特定操作
}
isPluginAvailable(...)
isPluginAvailable: (name: string) => boolean;
检查指定插件在当前运行平台上是否可用。插件名称使用插件注册表中的名称,这意味着它也适用于自定义插件。
const isAvailable = Capacitor.isPluginAvailable('Camera');
if (!isAvailable) {
// 让用户改为上传文件
} else {
// 否则,调用插件:
const image = await Camera.getPhoto({
resultType: CameraResultType.Uri,
});
}