跳过主要内容
@capgo/capacitor-native-导航 UI & 系统 开源

原生导航 Capacitor 插件

渲染原生导航栏、标签栏和过渡壳覆盖全屏 Capacitor WebView

安装

bun add @capgo/capacitor-native-navigation bunx cap sync
npm, pnpm 或 yarn
  • npm install @capgo/capacitor-native-navigation
  • pnpm add @capgo/capacitor-native-navigation
  • yarn add @capgo/capacitor-native-navigation

演示

原生导航演示

原生导航演示,展示了原生导航栏、选项卡、SVG图标和样式选项的动画WebP演示。

源资产
原生导航演示,展示了原生导航栏、选项卡和WebView内容的动画演示。
原生壳
动态原生导航点击流,展示选项卡选择、推送转换和原生后退
点击流
动态原生SVG图标演示,展示内联SVG图标、原生颜色、标签和选项卡选择
SVG图标
动态原生导航选项演示,展示动态颜色、选中标签、徽章和缩放转换
样式选项

指南

如何在Capacitor中使用原生导航

在设备上测试

下载Capgo应用程序,然后扫描QRcode。

原生导航插件预览二维码 code

使用 @capgo/capacitor-native-navigation

@capgo/capacitor-native-navigation 渲染原生顶部导航、底部标签栏和路由转换壳,所有这些都在一个全屏 Capacitor WebView 上。您的 Web 框架仍然拥有路由和内容,而原生则拥有应用框架。

安装并同步

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

配置原生框架

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

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

渲染原生导航栏

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

渲染原生标签栏

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

连接原生事件到您的路由器

原生栏发射意图。您的路由器仍然执行路由更改:

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

动画路由变化

在您的正常Web路由更新周围使用一个过渡事务:

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

添加一个缩放过渡

使用缩放助手来处理从卡片、网格项或媒体预览打开的路由:

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

用原生边距填充内容

当 contentInsetMode 是 css,该插件将为原生栏写入CSS变量:

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

图标选择

图标是原生描述符,而不是React或Vue节点。使用SVG时不想打包原生资产时使用SVG:

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

内联SVG支持 path, line, polyline, polygon, circle,和 rect,涵盖常见的图标集,如Lucide和Feather。

与@capgo/capacitor-transitions结合使用

使用Native Navigation来处理原生导航栏、标签栏、安全区域内边距和原生意图事件。使用 @capgo/capacitor-transitions 为原生导航栏下方的WebView页面堆栈。

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

初始化两包一次:

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

保持转场动画的焦点在页面上,而不是重复的web导航栏:

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

从同一个路由动作驱动两包:

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

每次路由变化选择一个动画层。让 @capgo/capacitor-transitions 正常页面推入时进行动画,仅在共享元素或缩放路由时使用Native Navigation的缩放辅助工具。

完整参考文档

继续使用 @capgo/capacitor-native-navigation

如果您正在使用 使用 @capgo/capacitor-native-navigation 来规划原生媒体和界面行为,连接它与 @capgo/capacitor-native-navigation 实现细节在 @capgo/capacitor-native-navigation, 开始使用 获取开始 使用@capgo/capacitor-live-activities 为使用@capgo/capacitor-live-activities的原生能力 使用 @capgo/capacitor-live-activities 为了 @capgo/capacitor-live-activities 的实现细节, 使用 @capgo/capacitor-video-player 为了在 @capgo/capacitor-video-player 中使用原生能力

常见问题

原生导航插件常见问题

如何在Capacitor应用中安装原生导航插件?

运行"bun add @capgo/capacitor-原生导航" (或 "npm install @capgo/capacitor-原生导航" ),然后运行 "bunx cap sync" 以便 iOS 和 Android 项目捕获原生code。从 "@capgo/capacitor-原生导航" 中导入它,然后在应用code中使用。

原生导航@capgo/capacitor是否支持React、Vue和Angular?

是。原生导航是一个Capacitor包,因此它可以与任何在Capacitor中运行的网页框架一起使用,包括Ionic、React、Vue、Angular、Svelte和普通JavaScript。

Which Capacitor version does @capgo/capacitor-native-navigation support?

Capgo 插件遵循 Capacitor 的主要版本:使用与 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。在 GitHub README 中的兼容性表格列出了维护的版本。

Capgo @capgo/capacitor-native-navigation 是否免费和开源?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-native-navigation/ and the package is free to install from npm. Bug reports and pull requests are welcome.

是否可以在不经过 App Store 审核的情况下更新使用 Native Navigation 的 code?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

不必等待应用审核就可以将Native Navigation的更改推送到商店

一旦插件在您的商店构建中,Capgo实时更新将推送您的JavaScript、HTML和CSS更改到用户中,仅需几分钟

从Capgo开始