# @gaviti/vue-turnstile 中文文档

规范地址：https://npmcn.com/package/%40gaviti/vue-turnstile/

版本：1\.1\.4
npm 元数据更新时间：2025-01-09T15:09:20.478Z
中文译文更新时间：2026-11-16T00:25:11.548Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：51 kB，9 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：^14\.18\.0 \|\| \>= 16\.0\.0
- 运行依赖：1 个
- 首次发布：2023-08-23T12:01:13.123Z
- 最新版本发布：2024-12-31T10:58:42.894Z
- 近 30 天下载量：2048（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：50（近 12 个月 0 个）

## 中文简介

用于 Cloudflare 转弯的 Vue 3.3.x 组件包装器

## 安装

```sh
npm install @gaviti/vue-turnstile
```

也可以使用：`pnpm add @gaviti/vue-turnstile`、`yarn add @gaviti/vue-turnstile`、`bun add @gaviti/vue-turnstile`

## README

# 转弯

Vue 3.3.x 组件包装 [云花的转弯](https://developers.cloudflare.com/turnstile/)

## 安装

### 国家预防机制

```bash
npm install @gaviti/vue-turnstile
```

### 雅伦

```bash
yarn add @gaviti/vue-turnstile
```

## Vue 2.7.x安装

对于 Vue 2.7.x 支持,您应当安装一个低于 1.0.0 的版本。 请参考"主"分行的相关代码.

## 使用量

```javascript
<template>
  <div>
    <vue-turnstile @verified="token = $event" />
    <div>Token: {{ token }}</div>
  </div>
</template>

<script>
import VueTurnstile from '@gaviti/vue-turnstile';

export default {
  components: {
    VueTurnstile
  },
  data() {
    return {
      token: null,
    };
  },
};
</script>
```

## 自定义选项

| Prop | 类型 | 说明 | 需求 | 默认 |
| --- | --- | --- | --- | --- |
| 站点密钥 | `String` | 您的旋转站台钥匙 [文档](https://developers.cloudflare.com/turnstile/get-started/) | 对 | 不详 |
| 主题 | `'light' | 'dark' | 'auto'` | 部件主题 | 没有 | `'auto'` |
| 大小 | `'normal' | 'compact'` | 部件大小 | 没有 | `'normal'` |
| 自动重置 | `Boolean` | 允许在一段时间后刷新符号( 毫秒) | 没有 | `false` |
| 重新设置超时 | `Number` | 在某段时间( 毫秒) \* 后刷新符号需要自动重置为真 | 没有 | `295000` |
| 重现- compat | `Boolean` | 添加复选相容层 | 没有 | `false` |
| 明确放弃 | `Boolean` | 明确渲染部件 | 没有 | `false` |
| 外观 | `'always' | 'execute' | 'interaction-only'` | 当部件可见时的外观控制 - [文档](https://developers.cloudflare.com/turnstile/get-started/client-side-rendering/#appearance-modes) | 没有 | `always` |
| 语言 | `String` | 要显示的语言 - ISO 639-1 二字母语言代码 - [支持的语言](https://developers.cloudflare.com/turnstile/reference/supported-languages/) | 没有 | `auto` |

## 方法

| 方法 | 说明 |
| --- | --- |
| `render()` | 渲染部件 |
| `reset()` | 重置部件 |
| `remove()` | 删除部件 |
| `getToken()` | 生成新符号 |

## 活动

| 名称 | 参数 | 说明 |
| --- | --- | --- |
| `@verified` |  | 返回符号 |
| `@rendering` |  | 上载(无返回) |
| `@rendered` |  | 最终释放(无结果) |
| `@error` | `code` | 当出现错误(例如网络出错或挑战失败)时引用回调 . |

## 槽数

| 名称 | 说明 |
| --- | --- |
| `default` | 默认槽 |

## 许可证

MIT 许可证

版权 (c) 2024 Gaviti

## 常见问题

### @gaviti/vue-turnstile 是什么？

用于 Cloudflare 转弯的 Vue 3\.3\.x 组件包装器

### 如何安装 @gaviti/vue-turnstile？

在项目目录运行 npm install @gaviti/vue-turnstile，或使用 pnpm add / yarn add / bun add。

### @gaviti/vue-turnstile 支持 TypeScript 吗？

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

### @gaviti/vue-turnstile 支持 ESM 还是 CommonJS？

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

### @gaviti/vue-turnstile 需要什么版本的 Node\.js？

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

### @gaviti/vue-turnstile 可以商用吗？

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

### @gaviti/vue-turnstile 的下载量有多少？

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

### @gaviti/vue-turnstile 还在维护吗？

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

