过渡动画 Capacitor 插件

使用 @capgo/capacitor-transitions

@capgo/capacitor-transitions 无需采用 Ionic UI，即可为 Capacitor 应用添加 Ionic 风格的路由转场。它运行在 Web 层，保留你现有的 router，并且仅在原生 Capacitor iOS 中自动启用 iOS 边缘侧滑返回手势。

安装

npm install @capgo/capacitor-transitions

无需原生同步步骤，因为该包不会添加原生 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>

将它连接到 router

在正常路由更新前设置转场方向：

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 当原生层需要接管 navbar 或 tabbar 时：

npm install @capgo/native-navigation
npx cap sync

配置原生 chrome，然后让转场专注于 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 用于页面主体动画，以及用于 insets 的 native-navigation 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);
}

不要把原生 navbar 再复制成一个会移动的 Web header。 @capgo/native-navigation 让导航栏保持原生； @capgo/capacitor-transitions 并为其下方的页面内容做动画。

完整参考

• GitHub: https://github.com/Cap-go/capacitor-transitions/
• 文档：/docs/plugins/transitions/

从 Using @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-video-player 有关“使用 @capgo/capacitor-video-player.”中的原生能力