# @gocardless/react-dropin 中文文档

规范地址：https://npmcn.com/package/%40gocardless/react-dropin/

版本：0\.3\.6
npm 元数据更新时间：2025-08-26T14:31:11.137Z
中文译文更新时间：2026-11-16T17:45:55.065Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40gocardless/react-dropin
原文对照：https://npmcn.com/package/%40gocardless/react-dropin/?lang=original
项目主页：https://github.com/gocardless/react-gocardless-dropin#readme
源码仓库：https://github.com/gocardless/react-dropin

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：95 kB，19 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：react ^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0，react-dom ^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0
- 首次发布：2021-07-23T17:17:08.174Z
- 最新版本发布：2025-08-26T14:31:10.858Z
- 近 30 天下载量：74378（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

对 GoCard 无故障检出流程的反绑

## 安装

```sh
npm install @gocardless/react-dropin
```

也可以使用：`pnpm add @gocardless/react-dropin`、`yarn add @gocardless/react-dropin`、`bun add @gocardless/react-dropin`

## README

# 无卡复出

[![npm version](https://badge.fury.io/js/%40gocardless%2Freact-dropin.svg)](https://badge.fury.io/js/%40gocardless%2Freact-dropin)

对GoCardless Droitin的取出流程进行反应绑定.

## 安装

以 npm 为单位 :

```console
npm install --save @gocardless/react-dropin
```

用纱线:

```console
yarn add @gocardless/react-dropin
```

## 实例

此库导出Resact chook 函数, 您可以用来触发 GoCardless Dropin的例子.

举个简单的例子 `App` 想要创建 Billing 请求流程 ID通过它的后端 API,然后提供 `DropinButton` 支付者可以点击 触发"滴滴".

> 见此行动 [GoCardless Dropin 按钮 故事](https://gocardless.github.io/react-dropin/?path=/story/dropin-gocardlessdropinbutton--base)

```typescript
import React, { useCallback, useState } from "react";
import {
  useGoCardlessDropin,
  GoCardlessDropinOptions,
  GoCardlessDropinOnSuccess,
} from "@gocardless/react-dropin";

// Display a button that opens the Dropin on click, starting a checkout
// flow for the specified Billing Request Flow.
const DropinButton = (options: GoCardlessDropinOptions) => {
  const { open } = useGoCardlessDropin({ ...options });

  return (
    <button type="button" onClick={() => open()}>
      Start Dropin for <code>{options.billingRequestFlowID}</code> in{" "}
      <code>{options.environment}</code>
    </button>
  );
};

// Example checkout flow, where we create a Billing Request Flow ID by talking
// with our backend API.
const App: FunctionComponent = () => {
  const [flowID, setFlowID] = useState<string | null>(null);

  // Build your backend with an API endpoint that:
  //
  //   1. Creates a Billing Request for the resources you wish to create
  //   2. Create a Billing Request Flow against (1)
  //   3. Return the ID from (2)
  //
  // See an example of this at Taking an Instant Bank Payment:
  // https://developer.gocardless.com/getting-started/billing-requests/taking-an-instant-bank-payment/
  React.useEffect(() => {
    async function createFlow() {
      // Expecting a JSON body like:
      // {
      //   "flow_id": "BRF123456"
      // }
      let response = await fetch("/api/flows", {
        method: "POST",
      });
      const { flow_id } = await response.json();
      setFlowID(flow_id);
    }
    createFlow();
  }, []);

  // Only show the button once we have a Billing Request Flow ID
  return flowID === null ? (
    <div className="loader"></div>
  ) : (
    <DropinButton billingRequestFlowID={flowID} environment={"live"} />
  );
};
```

## 故事书

查看故事书流以查看 `<GoCardlessDropinButton />` 行动中. 您可以使用"故事本"旋钮配置 Billing 请求流程ID,来自 您可以创建您的 Dropin 实例.

故事被运用到 `gh-pages` 该repo的分支,并托管于 [https://gocardless.github.io/ react-dropin/ 页面存档备份,存于互联网档案馆](https://gocardless.github.io/react-dropin/)。 。 。 .

## 出版

CircleCI的配置是为了为我们发布变化,通过构建的管道.

要触发新软件包版本 :

1.  更新 `package.json` 带有新版本编号( ie, v1. 0.0)
2.  推动这个承诺 `master`,则 [剪切新发行](https://github.com/gocardless/react-dropin/releases/new) 以 GitHub 为单位 带有匹配释放的标签名( ie, v1. 0.0)

这将触发 CI 管道,新的软件包版本将出现在 马上就好.

## 常见问题

### @gocardless/react-dropin 是什么？

对 GoCard 无故障检出流程的反绑

### 如何安装 @gocardless/react-dropin？

在项目目录运行 npm install @gocardless/react-dropin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0）、react-dom（^16\.8\.0 \|\| ^17\.0\.0 \|\| ^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @gocardless/react-dropin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @gocardless/react-dropin 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @gocardless/react-dropin 可以商用吗？

@gocardless/react-dropin 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @gocardless/react-dropin 的下载量有多少？

根据 npm 官方下载统计，@gocardless/react-dropin 在 2026/10/17 – 2026/11/15 这 30 天内被下载 74,378 次，日均约 2,479 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @gocardless/react-dropin 还在维护吗？

最新版本 0\.3\.6 发布于 2025/08/26（1\.2 年前）；至今共发布 8 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/07/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

