Skip to content

Commit

Permalink
📃 docs: 优化文档
Browse files Browse the repository at this point in the history
  • Loading branch information
GuoJikun committed Jan 16, 2024
1 parent 325171f commit 514cbee
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 37 deletions.
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
README.md
84 changes: 49 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,91 +37,105 @@ Vue.use(foxPreviewImage)

## API

| 属性 | 说明 | 参数类型 | 默认值 |
| ---------------- | :--------------------------- | :----------- | :----- |
| src | 预览图片的地址 | String/Array | - |
| visiable/v-model | 是否显示预览窗口 | Boolean | false |
| initial-index | 默认显示图片的下标 | Number | 0 |
| z-index | 预览窗口的层级-css 的 zIndex | Number | 9000 |
| 属性 | 说明 | 参数类型 | 默认值 |
| ------------------ | :--------------------------- | :---------------- | :------ |
| src | 预览图片的地址 | `string/string[]` | - |
| modelValue/v-model | 是否显示预览窗口 | `boolean` | `false` |
| initial-index | 默认显示图片的下标 | `number` | `0` |
| z-index | 预览窗口的层级-css 的 zIndex | `number` | `9000` |
| showToolbar | 控制 toolbar 的显示和隐藏 | `boolean` | `true` |

## 更新日志

### v2.9.0

Feat:

- 增加 `showToolbar` 属性,用于控制工具栏的显示和隐藏
- 移除了容器的圆角属性

Refactor:

- 重构了代码,将重复代码替换为函数
- 移除了 console 语句

### v2.8.0

feat
Feat

- 更改打包后文件的格式,es 格式文件后缀改为 `.mjs`
- 更改打包后文件的格式,es 格式文件后缀改为 `.mjs`

### v2.6.0

feat:
Feat:

- 增加下载功能
- 统一 icon
- 增加下载功能
- 统一 icon

### v2.4.1

fix:
Fix:

- 修复 css 导入错误
- 修复 css 导入错误

### v2.4.0

feat:
Feat:

- 增加默认显示第几张图片的功能
- 增加默认显示第几张图片的功能

### v2.3.0

feat:
Feat:

- 增加显示当前图片下标的功能(仅在多图下显示)
- 增加显示当前图片下标的功能(仅在多图下显示)

### v2.0.0

feat:
Feat:

- 增加 vue3 支持(安装:npm i fox-preview-image@next)
- 增加 vue3 支持(安装:npm i fox-preview-image@next)

### v1.1.3

refactor:
Refactor:

- 删除冗余代码
- 删除冗余代码

### v1.1.2

fix
Fix

- 修复火狐浏览器拖拽失效的问题
- 修复火狐浏览器拖拽失效的问题

### v1.1.1

feat
Feat

- 支持鼠标滚轮放大缩小
- 支持鼠标滚轮放大缩小

### v1.1.0

- feat:
- 增加缩放倍数显示
feat:

- 增加缩放倍数显示

### v1.0.2

fix:
Fix:

- 修复当预览的图片为 1 张时扔显示左右切换按钮的问题
- 修复当预览的图片为 1 张时扔显示左右切换按钮的问题

### v1.0.1

fix:
Fix:

- 修复拖拽时图片未完全跟随鼠标的 bug
- 修复拖拽时图片未完全跟随鼠标的 bug

### v1.0.0

feat:
Feat:

- 旋转
- 放大,缩小(0.5-2)
- 多张图片可以传数组 eg:['http://xxxx.com/a.png','http://xxxx.com/b.png']
- 旋转
- 放大,缩小(0.5-2)
- 多张图片可以传数组 eg:['http://xxxx.com/a.png','http://xxxx.com/b.png']
2 changes: 1 addition & 1 deletion lib/style.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "fox-preview-image",
"description": "一个支持vue2和vue3的预览图片组件",
"version": "2.8.1",
"version": "2.9.0",
"main": "lib/preview-image.js",
"module": "lib/preview-image.mjs",
"browser": "lib/preview-image.js",
Expand Down

0 comments on commit 514cbee

Please sign in to comment.