使用插件 API
在实现屏幕方向功能之前,先构建一个用户界面来测试插件的 API 是很有必要的。本质上,我们需要搭建一个测试工具,以便快速验证跨平台的功能一致性。
本教程的重点是如何构建 Capacitor 插件,而不是如何构建 Ionic Framework 应用,因此您可以直接获取所需文件的最终版本,并将其内容复制粘贴到您的项目中:
复制完成后,使用 ionic serve 命令启动 Capacitor 应用。打开浏览器的开发者工具,您应该会看到以下错误:
Uncaught (in promise) ScreenOrientation does not have web implementation.
这个错误提示是合理的;我们还没有为任何平台实现代码。请保持浏览器打开状态。我们首先将实现 Web 平台的功能。在此之前,让我们先回顾一下 Home.tsx 中的相关代码。
插件是如何使用的?
跟踪屏幕方向:
const [orientation, setOrientation] = useState<string>('');
orientation 状态变量用于存储屏幕方向的值,可以通过调用 setOrientation 来更新。由于代码开始执行时我们不知道当前屏幕方向,因此默认设置为空字符串。使用字符串类型是为了方便告知 UI 显示哪种设计。
建立了一个事件监听器,当触发 screenOrientationChange 时更新 orientation。
ScreenOrientation.addListener('screenOrientationChange', res =>
setOrientation(res.type),
);
UI 加载时会获取当前屏幕方向,并且当 UI 从 DOM 中移除时,会移除所有已创建的监听器(例如上面的那个)。
useEffect(() => {
ScreenOrientation.orientation().then(res => setOrientation(res.type));
return () => {
ScreenOrientation.removeAllListeners();
};
}, []);
请不要过多解读 useEffect 和返回函数;这些是 React 特定的语法规则。
显示正确的设计:
OrientationType 为竖屏方向提供了两个值:portrait-primary 和 portrait-secondary。横屏方向也是如此。我们的 UI 不关心它们之间的区别,只关心是横屏还是竖屏。
{
orientation.includes('portrait') &&
{
/* 提供一个按钮,可以将屏幕方向旋转并锁定为横屏模式。 */
};
}
{
orientation.includes('landscape') &&
{
/* 允许用户通过确认按钮“签署”并解锁屏幕方向。 */
};
}
锁定和解锁屏幕方向:
竖屏设计中包含一个按钮,按下后将改变屏幕方向并锁定它。
onClick={() => ScreenOrientation.lock({ orientation: "landscape-primary" })}
相反,横屏设计中包含一个按钮,按下后将解锁屏幕方向。
onClick={() => ScreenOrientation.unlock()}
Home.tsx 和 Home.css 中的其余代码纯粹是装饰性的;我们无需深入探讨。运行 npm run build,以便在 iOS 或 Android 上运行应用时使用新的 UI。
现在我们有了一个可以测试插件 API 的用户界面,接下来让我们开始实现功能!下一步我们将首先针对 Web 平台:Web 实现。