跳过主要内容

WeChat Capacitor插件

WeChat SDK for Capacitor - 支持身份验证、分享、支付和小程序

安装

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

指南

如何在Capacitor中使用微信

使用 @capgo/capacitor-wechat

Capacitor WeChat 插件 - WeChat SDK 整合,用于身份验证、分享、支付和小程序。

安装

bun add @capgo/capacitor-wechat
bunx cap sync

bunx cap sync 将插件的本机 code 复制到您的本机项目中。每次升级插件后,请重新运行它。

导入

import { CapacitorWechat } from '@capgo/capacitor-wechat';

API 简介

方法 描述
initialize 初始化 WeChat SDK 以使用您的应用程序凭据。
isInstalled 检查设备上是否安装了 WeChat 应用程序。
auth 使用 WeChat OAuth 进行用户身份验证。
share 分享内容到微信。
sendPaymentRequest 向微信支付发送付款请求。
openMiniProgram 打开微信小程序。
chooseInvoice 从微信中选择发票。

示例

initialize()

初始化微信SDK并使用您的应用凭证。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

await CapacitorWechat.initialize({
  appId: 'wx1234567890',
  universalLink: 'https://example.com/app/'
});

isInstalled()

使用您的应用凭据初始化微信__CAPGO_KEEP_0__。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

const { installed } = await CapacitorWechat.isInstalled();
if (installed) {
  console.log('WeChat is installed');
}

auth()

检查设备上是否安装了微信应用。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

const { code, state } = await CapacitorWechat.auth({
  scope: 'snsapi_userinfo',
  state: 'my_state'
});
// Use code to get access token from your server

share()

分享内容到微信。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

// Share text
await CapacitorWechat.share({
  scene: 0, // 0 = Session, 1 = Timeline, 2 = Favorite
  type: 'text',
  text: 'Hello WeChat!'
});

// Share link
await CapacitorWechat.share({
  scene: 1,
  type: 'link',
  title: 'My Website',
  description: 'Check out my website',
  link: 'https://example.com',
  imageUrl: 'https://example.com/image.jpg'
});

sendPaymentRequest()

向微信支付发送付款请求。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

// Get payment params from your server first
const paymentParams = await fetchPaymentParamsFromServer();

await CapacitorWechat.sendPaymentRequest({
  partnerId: paymentParams.partnerId,
  prepayId: paymentParams.prepayId,
  nonceStr: paymentParams.nonceStr,
  timeStamp: paymentParams.timeStamp,
  package: paymentParams.package,
  sign: paymentParams.sign
});

openMiniProgram()

打开微信小程序。

import { CapacitorWechat } from '@capgo/capacitor-wechat';

const { extMsg } = await CapacitorWechat.openMiniProgram({
  username: 'gh_xxxxxxxxxxxxx',
  path: 'pages/index/index',
  type: 0 // 0 = Release, 1 = Test, 2 = Preview
});

使用微信 OAuth 进行用户身份验证。 GitHub 仓库.

全局参考

继续使用 @capgo/capacitor-wechat

如果您正在使用 使用 @capgo/capacitor-wechat 来规划身份验证和帐号流程,连接它与 @capgo/capacitor-wechat 实现细节在 @capgo/capacitor-wechat 中 开始使用 为《开始使用》中的实现细节 @capgo/capacitor-社交登录 为《开始使用》中的@capgo/capacitor-social-login实现细节 @capgo/capacitor-passkey 为@capgo/capacitor-passkey的实现细节,以及 @capgo/capacitor原生生物识别 为@capgo/capacitor-native-biometric的实现细节。

常见问题

微信插件常见问题

如何在 Capacitor 应用中安装微信插件?

运行 "bun add @capgo/capacitor-wechat" (或 "npm install @capgo/capacitor-wechat"), 然后运行 "bunx cap sync" 以便 iOS 和 Android 项目能够接收到本地 code。然后从 "@capgo/capacitor-wechat" 导入到您的应用 code。

Does @capgo/capacitor-wechat work with React, Vue and Angular?

是。微信是一个 Capacitor 包,因此它可以与任何在 Capacitor 内部运行的 web 框架一起使用,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

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

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

是否@capgo/capacitor-wechat 免费且开源?

是。code 的源代码在 GitHub 上公开,https://github.com/Cap-go/capacitor-wechat/,并且可以从 npm 免费安装。欢迎提交bug报告和pull请求。

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

安装或升级插件会更改本机code,因此需要新建一个商店构建。之后,使用Capgo实时更新的JavaScript、HTML和CSS更改可以立即部署。

不用等待应用程序审核就可以将微信更新

一旦插件添加到你的应用程序构建中,Capgo即刻将你的JavaScript、HTML和CSS更新推送给用户

开始使用Capgo