指南
关于过渡的教程
使用@capgo/capacitor-transitions
@capgo/capacitor-transitions 在不采用Ionic UI的情况下,添加Ionic风格的路由过渡到Capacitor应用。它在web层运行,保留您的现有路由,并且可以在原生Capacitor iOS中自动启用一个iOS边缘滑动返回手势。
安装
npm install @capgo/capacitor-transitions
由于该包不添加原生插件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>
);
}
The React 子路径包含 JSX 类型定义文件,用于自定义元素。如果 TypeScript 还报告 "does not exist on",请添加以下文件: cap-router-outlet 对于 Vite、Create React App 和大多数 webpack React 应用,仅将该文件放在 "src" 目录下即可。对于 Next.js 或自定义 TypeScript 设置,请确保它被包含在 "paths" 中: JSX.IntrinsicElements启用滑动返回
// src/capgo-transitions.d.ts
import '@capgo/capacitor-transitions/react';
使用 ""来启用手势,只有当 __CAPGO_KEEP_0__ 报告 Native iOS 运行时时: src/ 您也可以从 JavaScript 强制启用: tsconfig.json:
{
"include": ["src", "src/capgo-transitions.d.ts"]
}
手势在过渡期间跟随指针,完成或取消时用户释放。添加以下代码到按钮、滑块或抽屉上,防止它们触发边缘手势:
使用 Native 导航 swipe-gesture="auto" Capacitor
<cap-router-outlet swipe-gesture="auto"></cap-router-outlet>
__CAPGO_KEEP_0__
const outlet = document.querySelector('cap-router-outlet');
outlet?.setSwipeGesture(true);
outlet?.setSwipeGesture(false);
outlet?.setSwipeGesture('auto');
__CAPGO_KEEP_0__ data-swipe-gesture-ignore __CAPGO_KEEP_0__
__CAPGO_KEEP_0__
安装 @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-transitions, 入门指南 实现细节在入门指南, 使用 @capgo/capacitor-live-activities 原生能力在使用 @capgo/capacitor-live-activities, @capgo/capacitor-live-activities 在 @capgo/capacitor-live-activities 的实现细节,和 使用 @capgo/capacitor-视频播放器 为原生能力在使用 @capgo/capacitor-视频播放器。