# @csvbox/vuejs3 中文文档

规范地址：https://npmcn.com/package/%40csvbox/vuejs3/

版本：2\.0\.0
npm 元数据更新时间：2026-10-26T12:59:43.019Z
中文译文更新时间：2026-11-11T03:57:53.267Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40csvbox/vuejs3
原文对照：https://npmcn.com/package/%40csvbox/vuejs3/?lang=original

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

- 包体积（解压后）：89.2 kB，7 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12
- 运行依赖：1 个
- peer 依赖：vue ^3\.0\.5
- 首次发布：2022-05-09T11:50:30.463Z
- 最新版本发布：2026-10-26T12:59:42.717Z
- 近 30 天下载量：5386（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 4 个）

## 中文简介

Vue 适配器 (Vue Version 3) 用于 csvbox.io

## 安装

```sh
npm install @csvbox/vuejs3
```

也可以使用：`pnpm add @csvbox/vuejs3`、`yarn add @csvbox/vuejs3`、`bun add @csvbox/vuejs3`

## README

# @csvbox/vuejs3 (中文(简体) )

> Csvbox.io 的 Vue 适配器

[![NPM](https://img.shields.io/npm/v/@csvbox/vuejs3.svg)](https://www.npmjs.com/package/@csvbox/vuejs3) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com/)

## 贝壳

```bash
npm install @csvbox/vuejs3
```

## 使用量

```jsx

<template>
  <div>
    <CSVBoxButton
      :licenseKey="licenseKey"
      :user="user"      
      :onImport="onImport">
      Upload File
    </CSVBoxButton>
  </div>
</template>

<script>
import CSVBoxButton from '@csvbox/vuejs3';

export default {
  name: 'App',
  components: {
    CSVBoxButton,
  },
  data: () => ({
    licenseKey: 'Sheet license key',
    user: {
      user_id: 'default123',
    },
  }),
  methods: {    
    onImport: function (result, data) {    
       if(result) {
          console.log("success");
          console.log(data.row_success + " rows uploaded");
          //custom code
      } else {
          console.log("fail");
          //custom code
      }
    }
  }
}
</script>

```

## 导入您已有的文件

`openModalWithFile(file)` 在 `File` 自己的页面是持有—— 从您的 自己的投放目标,你自己的文件输入,任何东西——而不是进口商的文件取取器. 这个 文件仍然通过导入者的扩展名、工作表和大小检查 picker, 不是验证.

通过模板参考调用:

```jsx
<template>
  <div>
    <CSVBoxButton ref="importer" :licenseKey="licenseKey" :user="user" :onImport="onImport">
      Import
    </CSVBoxButton>

    <input type="file" @change="onFileChosen" />
  </div>
</template>

<script>
export default {
  // ...
  methods: {
    onFileChosen(e) {
      this.$refs.importer.openModalWithFile(e.target.files[0]);
    }
  }
}
</script>
```

进口商可以拒绝交给的文件 并说为什么在控制台警告中 (单位:千美元)`[csvbox] importer declined the supplied file: <reason>`:

-   `import-in-progress` - 进口商已打开其上传步骤,或仍在读 早先的文件 。 已经打开的导入仍然打开 .
-   `modal-closing` ——文件到达时进口商关门.
-   `import-file-url-configured` ——工作表的设置是为了从URL上加载自己的文件.

传出 a `File`,而不是一个 `Blob`(单位:千美元) `Blob` 没有名字可以读取扩展, 和任何 不是一个 `File` 被忽略.

当输入方重定向到另一个主机时( 数据定位表做此操作), 文件会被发送到主机, 输入方实际上最终会打开, 只要主机是您的输入域或 `<region>-<your domain>` (例如 `eu-app.csvbox.io` 页:1 `app.csvbox.io`) (中文(简体) ). 文件从不会发送给其他主机 .

如果进口商在大约8秒内(例如,由于它重定向到一个没有遵循该命名的主机,或者它太老了,无法知道消息)不回答所提供的文件,则进口商被收起,其他按钮再次被启用,控制台说 `[csvbox] the importer did not respond to the supplied file`。 。 。 .

## 一页上的几个进口商

当一个进口商打开(或仍在装入以打开)时,页面上其他每个 CSVBox 实例的按钮被禁用直到关闭,因此两个进口商不会意外打开. 在反应中 `render` 道具( r)`isLoading`) 也为 `true` 在那种状态下,所以自定义触发器可以同样的方式自禁.

从代码中开设第二个进口商(`openModal()` 或者说 `openModalWithFile()`)仍然有可能。 最后一个打开的进口商显示在其他进口商的上方,关闭后显示下面的进口商.

## 进口时关闭进口商

如果您的用户提交文件, 然后在导入完成前关闭导入者, 则导入继续, 并且您 `onImport` 调用完成后仍随结果调用. 进口商下次打开时会重新装入.

## 读取

关于用法,请参见指南 [https://help.csvbox.io/getting-started #2-install-code 互联网档案馆的存檔,存档日期2013-12-2](https://help.csvbox.io/getting-started#2-install-code)

## 许可证

麻省理工学院 [csvbox-io (英语)](https://github.com/csvbox-io)

## 常见问题

### @csvbox/vuejs3 是什么？

Vue 适配器 \(Vue Version 3\) 用于 csvbox\.io

### 如何安装 @csvbox/vuejs3？

在项目目录运行 npm install @csvbox/vuejs3，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：vue（^3\.0\.5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @csvbox/vuejs3 支持 TypeScript 吗？

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

### @csvbox/vuejs3 支持 ESM 还是 CommonJS？

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

### @csvbox/vuejs3 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=12。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @csvbox/vuejs3 可以商用吗？

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

### @csvbox/vuejs3 的下载量有多少？

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

### @csvbox/vuejs3 还在维护吗？

最新版本 2\.0\.0 发布于 2026/10/26（15 天前）；至今共发布 25 个版本，其中过去 12 个月发布了 4 个；首次发布于 2022/05/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。