React SDK

Payve React SDK 集成指南,提供 React 组件和 Hooks 来简化加密货币支付集成

9 分钟阅读
更新于 2025/8/13
SDKReact组件Hooks

Payve React SDK 专为 React 应用程序设计,提供了声明式组件和自定义 Hooks,让加密货币支付集成变得简单直观。

特性概览

React 原生

专为 React 设计的组件和 Hooks

高度可定制

支持主题定制和自定义样式

响应式

完美适配移动端和桌面端

安装

npm install @payve/react-sdk

或者使用 yarn:

yarn add @payve/react-sdk

快速开始

1. 配置 Provider

首先在应用的根组件包装 PayveProvider

2. 使用支付按钮组件

组件 API

PayveProvider

用于提供全局配置的 Context Provider。

Props:

属性类型必填默认值说明
apiKeystring-API 密钥
environmentstring'production'环境
currencystring'USDT'默认币种
networkstring'TRON'默认网络
localestring'zh'界面语言
themeobject-主题配置

PayveButton

快速集成的支付按钮组件。

Props:

属性类型必填说明
amountstring支付金额
currencystring币种,覆盖 Provider 设置
networkstring网络,覆盖 Provider 设置
descriptionstring订单描述
metadataobject自定义元数据
disabledboolean是否禁用
loadingboolean是否显示加载状态
childrenReactNode按钮文本
classNamestring自定义样式类
styleobject内联样式
onSuccessfunction支付成功回调
onErrorfunction支付失败回调
onCancelfunction支付取消回调
onExpirefunction支付过期回调

PayveModal

弹窗式支付组件。

PayveForm

完整的支付表单组件。

Hooks API

usePayve

获取 Payve 实例和支付方法。

usePayment

管理单个支付的状态。

usePaymentStatus

实时监听支付状态变化。

完整示例

电商产品页

自定义支付流程

主题定制

预设主题

自定义主题

TypeScript 支持

SDK 完全支持 TypeScript,提供完整的类型定义:

性能优化

代码分割

记忆化组件

测试

单元测试示例

相关文档