__CAPGO_KEEP_0__ リポジトリへの移行

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-transitions` plugin in my project.

__CAPGO_KEEP_1__

1. __CAPGO_KEEP_2__

   npm install @capgo/capacitor-transitions

2. __CAPGO_KEEP_4__

   import '@capgo/capacitor-transitions';

3. __CAPGO_KEEP_0__

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

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

Note

There is no native sync step for this package. It runs in the web layer of your Capacitor app.

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'を追加します。

src/capgo-transitions.d.ts

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 with @capgo/native-navigation ネイティブがトップとボトムバーを所有し、ウェブコンテンツがアイオニックスタイルのページ動作を維持する場合。

1. ネイティブナビゲーション パッケージをインストールして同期する:

   npm install @capgo/native-navigation
   npx cap sync

2. ネイティブのChromeを設定:

   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. 両方のシステムを同じルーターエベントから動かす:

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

1 つのページをラップし、ライフサイクルイベントを発行します:

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

<cap-content>

属性	型	デフォルト	説明
fullscreen	boolean	false	Let content scroll behind the header
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から続けてください

Capgoを使用している場合 Getting Started マイグレーションとエンタープライズオペレーションを計画するには、を接続してください。 @capgo/capacitor-transitionsを使用します。 @capgo/capacitor-transitionsのネイティブ機能を使用します。 Capgo Enterprise Capgo Enterpriseの製品ワークフロー Ionic Enterprise Plugin Alternatives Ionic Enterprise Plugin Alternativesの製品ワークフロー Capgo Alternatives Capgo Alternativesの製品ワークフロー Capgo Consulting Capgo Consultingの製品ワークフロー