跳转至正文

原生加载器 Capacitor 插件

通过 JavaScript 或原生 code 显示原生动画加载器、透明遮罩、Lottie 资源以及 WebView 调整大小时的加载状态

安装

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

指南

如何在 Capacitor 中使用 Native Loader

使用 @capgo/capacitor-native-loader

@capgo/capacitor-native-loader 通过 iOS 和 Android 原生视图渲染加载状态。当 WebView 繁忙时需要保持加载动画流畅、CSS 实现全屏透明效果性能开销过大,或者其他原生 plugin 需要在 JavaScript 就绪前显示加载 UI 时,请使用它。

安装

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

全屏原生加载器

import { NativeLoader } from '@capgo/capacitor-native-loader';

const { id } = await NativeLoader.show({
  style: 'siri',
  placement: 'fullscreen',
  message: 'Preparing your session',
  colors: ['#71f6ff', '#8b5cf6', '#ff4ecd', '#fff7ad'],
  scrimColor: 'rgba(3, 7, 18, 0.42)',
  interactionMode: 'block',
});

await initializeAppData();
await NativeLoader.hide({ id });

WebView 调整尺寸时的边缘加载器

await NativeLoader.setWebViewLayout({
  mode: 'inset',
  insets: { top: 96 },
  animated: true,
});

await NativeLoader.show({
  style: 'wave',
  placement: 'top',
  message: 'Syncing changes',
  interactionMode: 'passThrough',
});

加载完成后,恢复 WebView:

await NativeLoader.hideAll({ restoreWebView: true });

Chrome 风格顶部进度条

当您希望在 WebView 上方显示类似浏览器的进度条,且不想在执行繁重任务时让 CSS 参与动画时,请使用原生顶部进度加载器。

const { id } = await NativeLoader.show({
  style: 'chrome',
  placement: 'top',
  colors: ['#4285f4', '#34a853', '#fbbc05', '#ea4335'],
  thickness: 4,
  interactionMode: 'passThrough',
  webView: {
    mode: 'resize',
    insets: { top: 12 },
    restoreOnHide: true,
  },
});

await NativeLoader.hide({ id, restoreWebView: true });

Siri V2 Edge Loader

使用 siri-v2 用于实现原生全屏加载器,在 WebView 可见的同时,让颜色在屏幕边缘流动。

const { id } = await NativeLoader.show({
  style: 'siri-v2',
  placement: 'fullscreen',
  colors: ['#71f6ff', '#8b5cf6', '#ff4ecd', '#fff7ad'],
  thickness: 10,
  scrimColor: 'rgba(3, 7, 18, 0.10)',
  interactionMode: 'passThrough',
});

await NativeLoader.hide({ id });

Lottie 加载器

await NativeLoader.show({
  style: 'lottie',
  placement: 'center',
  asset: {
    type: 'lottie',
    source: 'loader.json',
    loop: true,
  },
});

Bundled assets 最适合作为启动加载器,因为它们在网络请求和 JavaScript 初始化之前即可使用。

Native Plugin 调用

该插件暴露了公共原生 API,以便其他插件可以直接显示或隐藏加载器。

Swift:

import CapgoCapacitorNativeLoader

let id = NativeLoader.shared.show(options: [
  "style": "orbit",
  "placement": "fullscreen",
  "message": "Opening secure session"
])

NativeLoader.shared.hide(id: id)

Kotlin:

import app.capgo.nativeloader.NativeLoader

val id = NativeLoader.show(
  activity = activity,
  options = mapOf(
    "style" to "orbit",
    "placement" to "fullscreen",
    "message" to "Loading profile",
  ),
  webView = bridge.webView,
)

NativeLoader.hide(id)

继续阅读:使用 @capgo/capacitor-native-loader

如果你正在使用 使用 @capgo/capacitor-native-loader 来规划原生媒体和界面行为,并将其与 @capgo/capacitor-native-loader 了解实现细节, 快速入门 用于配置, 使用 @capgo/capacitor-native-navigation 用于原生界面外壳和 WebView 布局,以及 使用 @capgo/capacitor-transitions 用于 WebView 路由动效。

常见问题

Native Loader 插件常见问题

如何在 Capacitor 应用中安装 Native Loader 插件?

运行 "bun add @capgo/capacitor-native-loader"(或 "npm install @capgo/capacitor-native-loader"),然后运行 "bunx cap sync",让 iOS 和 Android 项目加载到 native code。之后在你的应用 code 中从 "@capgo/capacitor-native-loader" 导入。

@capgo/capacitor-native-loader 是否支持 React、Vue 和 Angular?

支持。Native Loader 是一个 Capacitor 包,因此任何运行在 Capacitor 中的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-native-loader 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-native-loader 是免费开源的吗?

是的。code 的源码已在 GitHub 公开,地址为 https://github.com/Cap-go/capacitor-native-loader/,也可以直接从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

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

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待 App 审核,即可发布 Native Loader 更新

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo