Getting Started

复制一个包含安装步骤和完整 Markdown 指南的配置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-transitions`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/transitions/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

__CAPGO_KEEP_0__

npm install @capgo/capacitor-transitions

注册 Web 组件
```
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}>
      {/* 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, 和 cap-footer。在大多数 React 项目中，导入这些文件使自定义元素在 TSX 中自动有效。

如果 TypeScript 还报告 Property 'cap-router-outlet' does not exist on type 'JSX.IntrinsicElements'，请添加项目声明文件：

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

对于 Vite、Create React App 和大多数 webpack React 应用程序，仅将该文件放在 src/ 对于 Next.js，将其放在 src/ 或项目根目录，并确保 tsconfig.json 包含它：

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

对于自定义 TypeScript 或 webpack 设置，使用单独的 types/ 文件夹，请包含该文件夹：

{
  "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 在本机应该拥有顶部和底部栏时，使用 @capgo/native-navigation 本机应拥有顶部和底部栏，而 Web 内容保持 Ionic 风格的页面运动。

安装并同步原生导航包：

npm install @capgo/native-navigation
npx cap sync

配置本机浏览器:

import { NativeNavigation } from '@capgo/native-navigation';

await NativeNavigation.configure({
  contentInsetMode: 'css',
});

await NativeNavigation.setNavbar({
  title: 'Inbox',
  backButton: { visible: false },
});

仅将网页过渡出口保留为页面负责:

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

从同一路由事件驱动两种系统:

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

不要再次渲染本机顶栏作为移动的 <cap-header>让 @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_KEEP_0__/__CAPGO_KEEP_1__-transitions 为native能力在使用 @capgo/capacitor-transitions for the native capability in Using @capgo/capacitor-transitions, Capgo 企业版为 Capgo 企业版中的产品工作流程 Ionic 企业插件替代品为 Ionic 企业插件替代品中的产品工作流程 Capgo 替代品为 Capgo 替代品中的产品工作流程，以及 Capgo 咨询为 Capgo 咨询中的产品工作流程。