指南
关于过渡的教程
使用 @capgo/capacitor-transitions
@capgo/capacitor-transitions 添加 Ionic 风格的路由过渡到 Capacitor 应用程序中,而不需要采用 Ionic UI。它在 web 层运行,保持您的现有路由,并且可以自动启用一个 iOS 边缘滑动返回手势,只在本机 Capacitor iOS 中有效。
安装
npm install @capgo/capacitor-transitions
There is no native sync step because the package does not add native plugin code.
注册元素
import '@capgo/capacitor-transitions';
包裹你的页面
<cap-router-outlet platform="auto" swipe-gesture="auto">
<cap-page>
<cap-header slot="header">
<h1>Inbox</h1>
</cap-header>
<cap-content slot="content">
<button>Open message</button>
</cap-content>
<cap-footer slot="footer">
<nav>Tabs</nav>
</cap-footer>
</cap-page>
</cap-router-outlet>
连接到路由器
在正常路由更新之前设置过渡方向:
import { setDirection } from '@capgo/capacitor-transitions/react';
setDirection('forward');
router.push('/message/42');
setDirection('back');
router.back();
React 示例
import { useEffect, useRef } from 'react';
import { useNavigate } from 'react-router-dom';
import { initTransitions, setDirection, setupPage, setupRouterOutlet } from '@capgo/capacitor-transitions/react';
import '@capgo/capacitor-transitions';
initTransitions({ platform: 'auto' });
export function AppShell() {
const outletRef = useRef<HTMLElement>(null);
useEffect(() => {
if (!outletRef.current) return;
setupRouterOutlet(outletRef.current, { platform: 'auto', swipeGesture: 'auto' });
}, []);
return <cap-router-outlet ref={outletRef}>{/* routes */}</cap-router-outlet>;
}
export function InboxPage() {
const navigate = useNavigate();
const pageRef = useRef<HTMLElement>(null);
useEffect(() => {
if (!pageRef.current) return;
return setupPage(pageRef.current);
}, []);
return (
<cap-page ref={pageRef}>
<cap-header slot="header">
<h1>Inbox</h1>
</cap-header>
<cap-content slot="content">
<button
onClick={() => {
setDirection('forward');
navigate('/message/42');
}}
>
Open message
</button>
</cap-content>
</cap-page>
);
}
React 子路径包含 JSX 类型定义用于自定义元素。如果 TypeScript 还报告说 cap-router-outlet 不存在于 JSX.IntrinsicElements,请添加这个文件:
// src/capgo-transitions.d.ts
import '@capgo/capacitor-transitions/react';
对于 Vite、Create React App 和大多数 webpack React 应用,保持该文件在 src/ 下面即可。对于 Next.js 或自定义 TypeScript 设置,请确保它被包含 tsconfig.json:
{
"include": ["src", "src/capgo-transitions.d.ts"]
}
启用滑动返回
使用 swipe-gesture="auto" 仅在Capacitor报告本机iOS运行时才启用手势:
<cap-router-outlet swipe-gesture="auto"></cap-router-outlet>
您也可以从JavaScript强制它:
const outlet = document.querySelector('cap-router-outlet');
outlet?.setSwipeGesture(true);
outlet?.setSwipeGesture(false);
outlet?.setSwipeGesture('auto');
手势在过渡期间跟随指针,然后在用户释放时完成或取消。添加 data-swipe-gesture-ignore 到按钮、滑块或抽屉中,不应启动边缘手势。
与本机导航一起使用
安装 @capgo/native-navigation 当本机层应拥有导航栏或标签栏时:
npm install @capgo/native-navigation
npx cap sync
配置本机浏览器,然后将过渡聚焦在WebView页面上:
import { NativeNavigation } from '@capgo/native-navigation';
import { setDirection } from '@capgo/capacitor-transitions/react';
import { router } from './router';
await NativeNavigation.configure({
contentInsetMode: 'css',
});
await NativeNavigation.setNavbar({
title: 'Inbox',
backButton: { visible: false },
});
await NativeNavigation.addListener('navbarBack', () => {
setDirection('back');
router.back();
});
async function openMessage(id: string) {
setDirection('forward');
router.push(`/message/${id}`);
await NativeNavigation.setNavbar({
title: 'Message',
backButton: { visible: true, title: 'Inbox' },
});
}
使用 cap-content 为动画页面主体和本机导航CSS变量进行边距:
<cap-router-outlet platform="auto" swipe-gesture="auto">
<cap-page>
<cap-content slot="content" fullscreen>
<main class="native-page">Inbox content</main>
</cap-content>
</cap-page>
</cap-router-outlet>
.native-page {
padding-top: var(--cap-native-navigation-top);
padding-bottom: var(--cap-native-navigation-bottom);
}
请勿重复原生导航栏作为移动网页头部。 @capgo/native-navigation 保持原生导航栏; @capgo/capacitor-transitions 动画页面内容在其下方。
全局参考
- GitHub: https://github.com/Cap-go/capacitor-transitions/
- 文档:/docs/plugins/transitions/
继续使用@capgo/capacitor-transitions
如果您正在使用 使用@capgo/capacitor-transitions 来规划原生媒体和界面行为,连接它与 @capgo/capacitor-transitions 为 @capgo/capacitor 过渡的实现细节, 开始使用 为开始使用的实现细节, 使用 @capgo/capacitor 实时活动 为使用 @capgo/capacitor 实时活动的本机能力, @capgo/capacitor 实时活动 为 @capgo/capacitor 实时活动的实现细节, 和 使用 @capgo/capacitor 视频播放器 为使用 @capgo/capacitor 视频播放器的本机能力,