0.1.0 • Published 2 years ago
zheshiyigeceshi v0.1.0
DocumentAnnotator
Introduction
Summary
文档批注前端组件，提供预览文档和编辑批注的能力
Features
- 文档的预览
- 加载文档批注信息
- 获取文档批注信息
Requirements - 必要条件（环境，对所有项目，和所有子模块和库的描述。）
Configuration - 配置（配置信息。）
Installation - 安装（如何安装。）
Usage - 用法（用法。）
Development - 开发（关于怎样开发的文档信息。（API 等。））
Attributes
| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| dataSource | 数据源 | object | —— | —— |
| dataSource.url | 文档地址 | string | —— | —— |
| dataSource.annotations | 文档附带注解，内容为json数组字符串 | string | —— | —— |
| operator | 操作人 | string | —— | —— |
| access | 用户访问权限 | string | READ / WRITE | READ |
Methods
| 方法名 | 说明 | 参数 |
|---|---|---|
| saveAnnotations | 保存批注 | —— |
Events
| 事件名称 | 说明 | 回调参数 |
|---|---|---|
| onSaveAnnotations | 在点击保存批注按钮时触发 | (annotations: string) |
Changelog - 更新日志（一个简短的历史记录（更改，替换或者其他）。）
FAQ - 常见问题（常见问题。）
Support - 支持
Docs - 文档（更多文档。）
Contact - 联系（其他联系信息（电子邮件地址，网站，公司名称，地址等）。提交bug，功能要求，提交补丁，加入邮件列表，得到通知，或加入用户或开发开发区群的介绍。）
0.1.0
2 years ago