Capacitor的JavaScript API

Capacitor提供多个JavaScript函数，确保应用能在跨平台环境下使用相同代码库成功运行。

全局Capacitor对象

可以通过以下代码导入全局Capacitor对象：

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

Capacitor对象包含多个实用函数，能帮助解决开发Capacitor应用时最常见的WebView与原生交互问题。

Capacitor.convertFileSrc

convertFileSrc: (filePath: string) => string;

将设备文件路径转换为Web View可识别的路径。

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

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

// http://localhost/path/to/device/photo.jpg
const fixedPhotoUri = Capacitor.convertFileSrc(rawPhotoUri.uri),

Capacitor.getPlatform

getPlatform: () => 'web' | 'ios' | 'android';

获取应用当前运行的平台名称。根据运行设备不同，会返回"web"、"ios"或"android"。

if (Capacitor.getPlatform() === 'ios') {
  console.log('iOS平台！');
} else if (Capacitor.getPlatform() === 'android') {
  console.log('Android平台！');
} else {
  console.log('Web平台！');
}

Capacitor.isNativePlatform

isNativePlatform: () => boolean;

检测当前运行平台是否为原生环境。如果应用作为原生安装的Capacitor应用运行则返回true，如果是通过浏览器访问或作为PWA安装则返回false。

if (Capacitor.isNativePlatform()) {
  console.log("这是原生应用！");
} else {
  console.log("这是PWA或网页应用！");
}

Capacitor.isPluginAvailable

isPluginAvailable: (name: string) => boolean;

检查指定插件在当前平台是否可用。插件名称使用插件注册表中的标识，因此也适用于自定义插件。

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

if (!isAvailable) {
  // 让用户改用文件上传
} else {
  // 否则直接调用：
  const image = await Camera.getPhoto({
    resultType: CameraResultType.Uri,
  });
}