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

原生加载器 Capacitor 插件

显示原生动画加载器、透明遮罩、Lottie 资产和 WebView 缩放加载状态,通过 JavaScript 或原生 code

安装

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中使用本机加载器

在设备上测试

下载Capgo应用,然后扫描code中的二维码。

原生加载器插件预览二维码code

使用@capgo/capacitor-native-loader

@capgo/capacitor-native-loader 通过原生iOS和Android视图渲染加载状态。使用它时WebView忙碌时,需要保持加载器流畅,CSS中透明全屏效果昂贵,或另一个原生插件需要在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边缘加载器

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

动画加载器

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

捆绑资产是最佳的启动加载器,因为它们在网络请求和JavaScript初始化之前可用。

原生插件调用

插件公开原生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 插件?

Run "bun add @capgo/capacitor-native-loader" (or "npm install @capgo/capacitor-native-loader"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-native-loader" in your app code.

@capgo/capacitor-native-loader 与 React、Vue 和 Angular 是否兼容?

是的。Native Loader 是一个 Capacitor 包,因此它与任何在 Capacitor 内部运行的 web 框架兼容,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

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

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 请求。

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

安装或升级插件会更改 native code,因此需要一个新的商店构建。之后,JavaScript、HTML 和 CSS 的更改可以立即通过 Capgo 实时更新发布。

不必等待应用审核即可将原生加载器更改

一旦插件在您的商店构建中,Capgo 即刻将 JavaScript、HTML 和 CSS 更改推送给用户。

开始使用 Capgo