为 Web/PWAs 实现
在设计插件 API 时,我们发现 Web 平台已经支持屏幕方向功能(当然,移动设备除外)。你可能会问,为什么我们的插件还需要 Web 实现呢?难道不能通过编程方式检测用户是否在 Web 平台上,然后使用 屏幕方向 Web API,否则就使用插件吗?
Web Native 应用的理念是"一次编写,随处运行"。这同样适用于插件;使用 Capacitor 插件的开发者应该能够使用相同的插件类和方法,并让它们在所有平台上都有相应的实现。
因此,作为优秀的开发者,我们将把屏幕方向 Web API 封装在 ScreenOrientation 插件的 Web 实现中。
扩展 Capacitor 的 WebPlugin 类
打开一个新文件 src/plugins/screen-orientation/web.ts。我们将在这个文件中编写 ScreenOrientation 插件的 Web 实现。
首先声明 ScreenOrientationWeb 类,并让它扩展 WebPlugin:
import { WebPlugin } from '@capacitor/core';
import type { ScreenOrientationPlugin } from './definitions';
export class ScreenOrientationWeb extends WebPlugin {
constructor() {
super();
}
}
Capacitor 的 WebPlugin 类包含了通知插件监听器的逻辑,我们将用它来告知监听器屏幕方向何时发生了变化。让我们在屏幕方向 Web API 的 change 事件触发时通知所有监听器。更新构造函数如下:
constructor() {
super();
window.screen.orientation.addEventListener("change", () => {
const type = window.screen.orientation.type;
this.notifyListeners("screenOrientationChange", { type });
});
}
WebPlugin 类已经实现了 ScreenOrientationPlugin 接口中定义的 addListener() 和 removeAllListeners() 方法。使用这些方法不需要额外的工作。
实现剩余的方法
让我们完成 ScreenOrientationPlugin 接口的实现。首先调整类定义,使其 真正 实现该接口:
export class ScreenOrientationWeb
extends WebPlugin
implements ScreenOrientationPlugin
{
然后将剩余的方法作为 ScreenOrientationWeb 类的一部分实现:
async orientation(): Promise<{ type: OrientationType }> {
return { type: window.screen.orientation.type };
}
async lock(opts: { orientation: OrientationLockType }): Promise<void> {
await window.screen.orientation.lock(opts.orientation);
}
async unlock(): Promise<void> {
window.screen.orientation.unlock();
}
注册 Web 实现
要将 ScreenOrientationWeb 注册为我们插件的 Web 实现,我们需要使用 registerPlugin() 的第二个输入参数。打开 src/plugins/screen-orientation/index.ts,并更新 ScreenOrientation 变量的声明如下:
const ScreenOrientation = registerPlugin<ScreenOrientationPlugin>(
'ScreenOrientation',
{
web: () => import('./web').then(m => new m.ScreenOrientationWeb()),
},
);