Zum Hauptinhalt springen
Zurück zu Plugins
@capgo/capacitor-native-navigation
Tutorial
von github.com/Cap-go

Native Navigation

Nativnavigation, Tabbar und Übergangshüllen über einem vollbildschirmigen Capacitor WebView rendern

Demo

Animierte WebP-Demos

Nativnavigation, Chrome, Tabauswahl, SVG-Icons und Stiloptionen werden als animierte WebP-Demos gerendert.

Quellenassets
Animierte nativnavigation-Shell-Demo zeigt nativen Navbar, Tabs und WebView-Inhalt
Native Shell
Animierte native Navigationstapfluss zeigt die Auswahl von Tabs, Push-Übergang und native Zurück
Tap-Fluss
Animierte native SVG-Ikonendemo zeigt inline SVG-Ikonen, native Tönung, Beschriftungen und Tab-Auswahl
SVG-Ikonen
Animierte native Navigationsoptionen-Demo zeigt dynamische Farben, ausgewählte Beschriftungen, Badges und Zoom-Übergänge
Styling-Optionen

Richtlinie

Tutorial zu Native Navigation

Mit @capgo/capacitor-native-navigation wird native Ober- und Unter-Navigation, Routen-Übergang und -Chrome über eine einzelne Vollbildschirm-capgo-Ansicht gerendert. Ihre Webframework besitzt immer noch Routen und Inhalte, während native die App-Frame besitzt.

@capgo/capacitor-native-navigation renders native top navigation, bottom tab chrome, and route transition shells over a single full-screen Capacitor WebView. Your web framework still owns routes and content, while native owns the app frame.

Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-native-navigation

npm install @capgo/capacitor-native-navigation
npx cap sync

Konfigurieren Sie das native Frame

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

await NativeNavigation.configure({
  contentInsetMode: 'css',
  animationDuration: 360,
  colors: {
    tint: '#0f172a',
    inactiveTint: '#64748b',
  },
});

Rendern Sie ein natives Navbar

await NativeNavigation.setNavbar({
  title: 'Inbox',
  subtitle: 'Native chrome',
  transparent: true,
  backButton: { visible: false },
  rightItems: [
    {
      id: 'compose',
      title: 'Compose',
      icon: {
        svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M12 20h9"/><path d="M16.5 3.5a2.12 2.12 0 0 1 3 3L7 19l-4 1 1-4Z"/></svg>',
      },
    },
  ],
});

Rendern Sie ein natives Tabbar

await NativeNavigation.setTabbar({
  selectedId: 'inbox',
  labelVisibilityMode: 'selected',
  icons: true,
  colors: {
    dynamic: true,
    tint: '#0f172a',
    inactiveTint: '#64748b',
  },
  tabs: [
    {
      id: 'inbox',
      title: 'Inbox',
      icon: {
        svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M4 4h16v16H4z"/><path d="m4 13 4 4h8l4-4"/></svg>',
      },
    },
    {
      id: 'search',
      title: 'Search',
      icon: {
        svg: '<svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="11" cy="11" r="7"/><path d="m20 20-3-3"/></svg>',
      },
    },
  ],
});

Verbinden Sie native Ereignisse mit Ihrem Router

Native Balken senden eine Absicht. Ihr Router führt den Routenwechsel immer noch durch:

await NativeNavigation.addListener('navbarBack', () => {
  router.back();
});

await NativeNavigation.addListener('navbarItemTap', ({ id }) => {
  if (id === 'compose') router.push('/compose');
});

await NativeNavigation.addListener('tabSelect', ({ id }) => {
  router.push(`/${id}`);
});

Animate Routenwechsel

Verwenden Sie eine Übergangstransaktion um Ihre normale Web-Routenaktualisierung herum:

const transition = await NativeNavigation.beginTransition({
  direction: 'forward',
});

router.push('/message/42');
await router.ready?.();

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

await NativeNavigation.finishTransition({
  id: transition.id,
  direction: 'forward',
});

Fügen Sie eine Zoom-Übergang hinzu

Verwenden Sie die Zoom-Hilfsmittel für Routen, die von einem Karten-Element, einem Grid-Element oder einem Medien-Vorschau-Element geöffnet werden.

import { beginZoomTransition, finishZoomTransition } from '@capgo/capacitor-native-navigation';

const card = document.querySelector('[data-message-card]');
if (card) {
  const transition = await beginZoomTransition(card, { cornerRadius: 18 });

  router.push('/message/42');
  await router.ready?.();

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

  await finishZoomTransition(undefined, {
    id: transition.id,
    cornerRadius: 18,
  });
}

Füllen Sie Inhalte mit native Einstellungen

Wenn contentInsetMode __CAPGO_KEEP_0__ cssSchreibt die CSS-Variablen für die native Balken:

.page {
  padding-top: var(--cap-native-navigation-top);
  padding-bottom: var(--cap-native-navigation-bottom);
}

Symbolauswahl

Icons sind native Beschreibungen, nicht React- oder Vue-Knoten. Verwenden Sie SVG, wenn Sie native Assets nicht bundeln möchten:

const icon = {
  svg: '<svg viewBox="0 0 24 24"><path d="M3 10.5 12 3l9 7.5"/></svg>',
  template: true,
  ios: { sfSymbol: 'house.fill' },
  android: { resource: 'ic_menu_view' },
};

Inline SVG unterstützt path, line, polyline, polygon, circleund rect, die die gängigen Icon-Sets wie Lucide und Feather abdeckt.

Combine with @capgo/capacitor-Übergänge

Verwenden Sie Native Navigation für die native Navbar, Tabbar, safe-Area-Einrückungen und native Intent-Ereignisse. Verwenden Sie @capgo/capacitor-transitions für die WebView-Seitenspindel unterhalb der native Chrome.

npm install @capgo/capacitor-native-navigation @capgo/capacitor-transitions
npx cap sync

Initialisieren Sie beide Pakete einmal:

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

initTransitions({ platform: 'auto' });

const outlet = document.querySelector('cap-router-outlet');
if (outlet) {
  setupRouterOutlet(outlet, { platform: 'auto', swipeGesture: 'auto' });
}

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

Halten Sie die Übergangsausgabe auf den Seiten, nicht auf duplizierte Web-Balken:

<cap-router-outlet platform="auto" swipe-gesture="auto">
  <cap-page>
    <cap-content slot="content" fullscreen>
      <main class="page">Inbox content</main>
    </cap-content>
  </cap-page>
</cap-router-outlet>

Steueren Sie beide Pakete von denselben Router-Aktionen:

async function openMessage(id: string) {
  setDirection('forward');
  await router.push(`/messages/${id}`);
  await NativeNavigation.setNavbar({
    title: 'Message',
    backButton: { visible: true, title: 'Inbox' },
  });
}

await NativeNavigation.addListener('navbarBack', () => {
  setDirection('back');
  router.back();
});

await NativeNavigation.addListener('tabSelect', ({ id }) => {
  setDirection('root');
  router.push(`/${id}`);
});

Wählen Sie eine Animationsschicht pro Routenänderung. Lassen Sie @capgo/capacitor-transitions normale Seitenwechsel animieren und verwenden Sie die Zoom-Hilfen von Native Navigation nur für gemeinsame-Element- oder Zoom-Routen.

Vollständige Referenz

Weitermachen von Using @capgo/capacitor-native-navigation

Wenn Sie Native Navigation verwenden Mit @capgo/capacitor-native-navigation planen Sie native Medien und Schnittstellenverhalten, verbinden Sie es mit @capgo/capacitor-native-navigation für die Implementierungsdetails in @capgo/capacitor-native-navigation, Zum Starten zur Implementierungsdetail in Zum Starten, Mit @capgo/capacitor-live-aktivitäten zur nativen Fähigkeit in Mit @capgo/capacitor-live-aktivitäten, @capgo/capacitor-live-aktivitäten zur Implementierungsdetail in @capgo/capacitor-live-aktivitäten, und Mit @capgo/capacitor-video-player zur nativen Fähigkeit in Mit @capgo/capacitor-video-player.