Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-text-proofreader) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Vue Text Proofreader
Vue.js 文本校对组件,支持智能错误检测和修正建议。
安装
npm install vue-text-proofreader
使用
全局注册
import Vue from "vue";
import VueTextProofreader from "vue-text-proofreader";
import "vue-text-proofreader/dist/vue-text-proofreader.css";
Vue.use(VueTextProofreader);
局部注册
import { TextProofreader } from "vue-text-proofreader";
import "vue-text-proofreader/dist/vue-text-proofreader.css";
export default {
components: {
TextProofreader,
},
};
基本用法
<template>
<div>
<TextProofreader
:content="textContent"
:api-config="apiConfig"
@confirmed="handleConfirmed"
@error="handleError"
/>
</div>
</template>
<script>
export default {
data() {
return {
textContent: "需要校对的文本内容",
apiConfig: {
checkUrl: "/api/text/check",
progressUrl: "/api/text/progress",
resultUrl: "/api/text/result",
},
};
},
methods: {
handleConfirmed(correctedText) {
console.log("校对完成:", correctedText);
},
handleError(error) {
console.error("校对错误:", error);
},
},
};
</script>
API 配置
参数 | 类型 | 必需 | 说明 |
---|---|---|---|
content | String | 是 | 需要校对的文本内容 |
apiConfig | Object | 是 | API 接口配置 |
title | String | 否 | 对话框标题 |
triggerText | String | 否 | 触发按钮文本 |
autoStart | Boolean | 否 | 是否自动开始校验 |
事件
事件名 | 参数 | 说明 |
---|---|---|
confirmed | correctedText | 确认修改时触发 |
cancelled | - | 取消修改时触发 |
error | errorMessage | 出现错误时触发 |
completed | { errorCount, errors } | 校验完成时触发 |
开发
# 克隆项目
git clone https://github.com/yourusername/vue-text-proofreader.git
# 安装依赖
npm install
# 开发模式
npm run dev
# 构建
npm run build
License
MIT