Skip to content

Commit 3a2299d

Browse files
committed
docs: update events docs
1 parent d20ef70 commit 3a2299d

2 files changed

Lines changed: 14 additions & 0 deletions

File tree

README-zh.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@
2929
- [Vue2](#Vue2)
3030
- [在线演示](#Demo)
3131
- [组件属性](#组件属性)
32+
- [组件事件](#组件事件)
3233
- [拓展高亮语言](#拓展高亮语言)
3334
- [从 0.x 版本迁移](#从-0x-版本迁移)
3435

@@ -122,6 +123,12 @@ Vue.use(CodeDiff)
122123
| maxHeight | 组件最大高度,例如 300px | number | - | undefined |
123124
| filename | 文件名 | string | - | undefined |
124125

126+
## 组件事件
127+
| Name | Description | Type |
128+
|------|-------------|---------------------------------------------------------------------------------|
129+
| diff | diff 完成后触发 | (result: {stat: { isChanged: boolean, addNum: number, delNum: number}}) => void |
130+
131+
125132
## 拓展高亮语言
126133

127134
为了减小打包后的体积,系统默认仅支持以下常用语言

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ This project references the following projects, and I would like to express my g
2828
- [Vue3](#Vue3)
2929
- [Vue2](#Vue2)
3030
- [Props](#Props)
31+
- [Events](#Events)
3132
- [Demo](#Demo)
3233
- [Extend languages](#extend-languages)
3334
- [Migrate from 0.x version](#Migrate-from-0x-version)
@@ -122,6 +123,12 @@ Not recommended, but the relevant capabilities are retained to facilitate migrat
122123
| maxHeight | Maximum height of component, for example: 300px | string | - | undefined |
123124
| filename | Filename | string | - | undefined |
124125

126+
## Events
127+
| Name | Description | Type |
128+
|------|------------------------------|---------------------------------------------------------------------------------|
129+
| diff | triggers when diff finished | (result: {stat: { isChanged: boolean, addNum: number, delNum: number}}) => void |
130+
131+
125132
## Extend languages
126133

127134
In order to reduce the size of the packaged file, the system only supports the following commonly used languages by

0 commit comments

Comments
 (0)