开始入门

1. Install the package

   npm install @capgo/capacitor-transitions

2. Register the web components

   import '@capgo/capacitor-transitions';

3. Wrap routed pages

   <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>

4. 在路由器改变路由之前设置方向

   import { setDirection } from '@capgo/capacitor-transitions/react';
   
   setDirection('forward');
   router.push('/message/42');
   
   setDirection('back');
   router.back();

注意

本包没有原生同步步骤。它在您的Capacitor应用的Web层中运行。

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}>
      {/* Your router renders cap-page children here. */}
    </cap-router-outlet>
  );
}

export function InboxPage() {
  const navigate = useNavigate();
  const pageRef = useRef<HTMLElement>(null);

  useEffect(() => {
    if (!pageRef.current) return;

    return setupPage(pageRef.current, {
      onDidEnter: () => console.log('Inbox visible'),
    });
  }, []);

  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

从中导入 @capgo/capacitor-transitions/react 包括 JSX 类型定义 cap-router-outlet, cap-page, cap-header, cap-content在大多数 React 项目中，导入使自定义元素在 TSX 中自动有效。 cap-footer如果 TypeScript 还报告错误，请添加项目声明文件：

src/__CAPGO_KEEP_0__-transitions.d.ts Property 'cap-router-outlet' does not exist on type 'JSX.IntrinsicElements'复制到剪贴板

src/capgo-transitions.d.ts

import '@capgo/capacitor-transitions/react';

或项目根目录，并确保 src/ 包含它： src/ 复制到剪贴板 tsconfig.json 对于自定义 TypeScript 或 webpack 设置，使用单独的

{
  "include": ["src", "src/capgo-transitions.d.ts"]
}

需要额外的步骤。 types/ folder, include该文件夹：

{
  "include": ["src", "types"]
}

返回

从标记中启用或禁用 iOS 边缘手势：

<cap-router-outlet swipe-gesture="auto"></cap-router-outlet>
<cap-router-outlet swipe-gesture="true"></cap-router-outlet>
<cap-router-outlet swipe-gesture="false"></cap-router-outlet>

或从 JavaScript：

const outlet = document.querySelector('cap-router-outlet');

outlet?.setSwipeGesture('auto');
outlet?.setSwipeGesture(true);
outlet?.setSwipeGesture(false);

auto 仅在Capacitor报告本机 iOS 运行时才启用手势。在手势期间，页面转换跟随手指。当用户释放时，转换要么完成并要求浏览器历史记录向后移动，要么取消并恢复当前页面。

要防止元素开始手势，请添加： data-swipe-gesture-ignore:

<button data-swipe-gesture-ignore>Open drawer</button>

使用原生导航

使用 @capgo/capacitor-transitions 在native应该拥有顶部和底部导航栏，而web内容保持Ionic样式的页面动画时 @capgo/native-navigation 安装并同步native导航包：

1. 终端窗口

   npm install @capgo/native-navigation
   npx cap sync

2. 复制到剪贴板

   import { NativeNavigation } from '@capgo/native-navigation';
   
   await NativeNavigation.configure({
     contentInsetMode: 'css',
   });
   
   await NativeNavigation.setNavbar({
     title: 'Inbox',
     backButton: { visible: false },
   });

3. 复制到剪贴板

   <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);
   }

4. Drive both systems from the same router events:

   import { NativeNavigation } from '@capgo/native-navigation';
   import { setDirection } from '@capgo/capacitor-transitions/react';
   import { router } from './router';
   
   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' },
     });
   }

Do not render the native top bar again as a moving <cap-header>. Let @capgo/native-navigation 保留原生顶栏并使用 @capgo/capacitor-transitions 为 WebView 页面内容

组件

<cap-router-outlet>

属性	类型	默认值	描述
platform	'ios' | 'android' | 'auto'	'auto'	动画风格
duration	number	平台默认	动画持续时间（毫秒）
keep-in-dom	boolean	true	保持不活跃页面在 DOM 中
max-cached	number	10	最大缓存页面
swipe-gesture	boolean | 'auto'	'auto'	启用、禁用或原生检测 iOS 边缘手势

方法：

• push(element, config?)
• pop(config?)
• setRoot(element, config?)
• setSwipeGesture(true | false | 'auto')

<cap-page>

包裹一个页面并发出生命周期事件：

• cap-will-enter
• cap-did-enter
• cap-will-leave
• cap-did-leave

<cap-content>

属性	类型	默认	描述
fullscreen	boolean	false	让内容滚动在头部后面
scroll-x	boolean	true	启用水平滚动
scroll-y	boolean	true	启用垂直滚动

框架助手

框架入口点暴露相同的核心助手：

import { initTransitions, setDirection, setupPage, setupRouterOutlet } from '@capgo/capacitor-transitions/react';

initTransitions({ platform: 'auto' });
setDirection('forward');
setupRouterOutlet(element, { platform: 'auto', swipeGesture: 'auto' });
setupPage(element, { onWillEnter, onDidEnter, onWillLeave, onDidLeave });

可用入口点：

• @capgo/capacitor-transitions/react
• @capgo/capacitor-transitions/vue
• @capgo/capacitor-transitions/angular
• @capgo/capacitor-transitions/svelte
• @capgo/capacitor-transitions/solid

从 Getting Started 继续

如果您正在使用 Getting Started 来规划迁移和企业运营，连接它与 使用 @capgo/capacitor-transitions 为 native 能力在使用 @capgo/capacitor-transitions 中 Capgo 企业 为产品工作流程在 Capgo 企业中 Ionic 企业插件替代品 为产品工作流程在 Ionic 企业插件替代品中 Capgo 替代品 为产品工作流程在 Capgo 替代品中 Capgo 咨询 为产品工作流程在 Capgo 咨询中