# @dansmaculotte/vue-zendesk 中文文档

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

版本：0\.4\.7
npm 元数据更新时间：2023-10-31T08:23:53.651Z
中文译文更新时间：2026-11-11T11:04:38.810Z
软件包许可：MIT

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

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

弃用说明：Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

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

- 包体积（解压后）：8.3 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2019-04-24T07:06:29.611Z
- 最新版本发布：2022-12-02T09:35:10.595Z
- 近 30 天下载量：6677（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：21（近 12 个月 0 个）

## 中文简介

Zendesk 网络部件的 Vue 插件

## 安装

```sh
npm install @dansmaculotte/vue-zendesk
```

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

## README

# veue-zen 办公桌

[![npm version](https://img.shields.io/npm/dt/@dansmaculotte/vue-zendesk.svg?style=flat-square)](https://npmjs.com/package/@dansmaculotte/vue-zendesk) [![npm downloads](https://img.shields.io/npm/v/@dansmaculotte/vue-zendesk/latest.svg?style=flat-square)](https://npmjs.com/package/@dansmaculotte/vue-zendesk) [![Dependencies](https://david-dm.org/dansmaculotte/vue-zendesk/status.svg?style=flat-square)](https://david-dm.org/dansmaculotte/vue-zendesk) [![Standard JS](https://img.shields.io/badge/code_style-standard-brightgreen.svg?style=flat-square)](https://standardjs.com/)

> Zendesk Web 部件的 Vue.js 插件

此插件允许您配置并添加 Zendesk Web 部件

[Zendesk 网络部件文档](https://developer.zendesk.com/embeddables/docs/widget/introduction)

## 设置

1.  添加数据 `@dansmaculotte/vue-zendesk` 依赖关系 `yarn` 或者说 `npm` 给您的项目
2.  配置它 :

```js
import Vue from 'vue'
import Zendesk from '@dansmaculotte/vue-zendesk'

Vue.use(Zendesk, {
  key: 'YOUR_ZENDESK_KEY',
  disabled: true,
  hideOnLoad: true,
  settings: {
    webWidget: {
      color: {
        theme: '#78a300'
      }
    }
  }
})
```

### 选项

#### `disabled`

`disabled` 选项允许您防止自动加载脚本,以遵守 GDPR.

你可以打电话手动装入 `this.$zendesk.load(YOUR_ZENDESK_KEY)`。 。 。 .

#### `hideOnLoad`

Zendesk Web 部件初始化后, 它会自动显示部件, 为了防止它, 您可以设置为 `true` 此选项可以让您在之后手动显示 .

#### `settings`

您可以查看 Zendesk 网络部件可用设置 [这里](https://developer.zendesk.com/embeddables/docs/widget/settings)。 。 。 .

## 使用量

您可以使用官方文档中的任何方法. 每一种方法都可以从 `$zendesk` 对象.

例如:

```js
Vue.$zendesk.hide()
// In a vue component
this.$zendesk.show()
```

你们也可以听 `loaded` 脚本加载时释放的事件, `open` 打开部件 `close` 关闭部件.

例如:

```js
this.$zendesk.$on('loaded', (event) => {
  this.$zendesk.identify({
    name: 'John'
  })
})

this.$zendesk.$on('open', () => {
  console.log('Widget is open')
})

this.$zendesk.$on('close', () => {
  console.log('Widget is closed')
})
```

您可以通过 Zendesk 网页部件实例访问 `this.$zendesk.zE` 或者说 `window.zE` 对象.

例如:

```js
this.$zendesk.zE('webWidget', 'hide')
window.zE('webWidget', 'hide')
```

## 发展

1.  克隆此寄存器
2.  使用 `yarn install` 或者说 `npm install`
3.  开始使用开发服务器 `npm run dev`

## 许可证

[MIT 许可证](https://npmcn.com/package/%40dansmaculotte/vue-zendesk/LICENSE.md)

## 常见问题

### @dansmaculotte/vue-zendesk 是什么？

Zendesk 网络部件的 Vue 插件注意：该包已被作者标记为弃用——Package no longer supported\. Contact Support at https://www\.npmjs\.com/support for more info\.

### 如何安装 @dansmaculotte/vue-zendesk？

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

### @dansmaculotte/vue-zendesk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/dansmaculotte\_\_vue-zendesk 是否存在。

### @dansmaculotte/vue-zendesk 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @dansmaculotte/vue-zendesk 可以商用吗？

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

### @dansmaculotte/vue-zendesk 的下载量有多少？

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

### @dansmaculotte/vue-zendesk 还在维护吗？

最新版本 0\.4\.7 发布于 2022/12/02（3 年前）；至今共发布 21 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/04/24。作者已将其标记为弃用，新项目建议寻找替代方案。

