# etherpad-vue
**Repository Path**: cbydpi_admin/etherpad-vue
## Basic Information
- **Project Name**: etherpad-vue
- **Description**: 基于github上开源项目etherpad封装的VUE组件
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 6
- **Forks**: 1
- **Created**: 2020-07-03
- **Last Updated**: 2025-06-20
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
### 下载安装
```
npm install --save etherpad-vue
或
cnpm install --save etherpad-vue
```
### 功能描述
此版本基于github上开源项目etherpad进行vue组件的封装，主要实现功能配置，内容获取等功能
### 配置说明
```
config: {
ETHERPAD_APIKEY: 'asdgsfg', // API密钥，在node服务根目录下APIKEY.txt 必选
id: 'toke', // 文档ID 必选
host: 'http://192.168.10.150', // node服务地址 必选
userName: '匿名', // 用户名 必选
baseUrl: '/p/', // 路径
showControls: true, // 是否显示控件
showChat: true, // 是否显示聊天按钮
showLineNumbers: false, // 是否显示行号
useMonospaceFont: false, // 使用等宽字体
noColors: false, // 禁用用户的文本背景色
userColor: false, // 当前用户的文本背景色,eg. #f00f00
hideQRCode: true, // 隐藏二维码
alwaysShowChat: false, // 始终显示聊天框
plugins: { }, // 与插件相关的选项，与基本的Etherpad配置无关
rtl: false, // 从右向左显示文本
}
width: '100%' // 可选，默认100%，可写成px等单位
height: '600px' // 可选，默认600px，可写成%等单位
border: 'none' // 可选，默认none
```
### 内置方法
```
setContent: 设置当前便笺文本内容
setHtml: 设置当前便笺HTML内容
appendContent: 向当前便笺末尾插入内容，注：会清除原有格式
getContent：获取当前便笺文本内容，返回一个promise对象，具体使用方法看下例
getHtml: 获取当前便笺html内容，返回一个promise对象，具体使用方法看下例
getDownloadUrl: 获取PDF下载地址
```
### 使用示例
```
```