diff --git a/README.cn.md b/README.cn.md new file mode 100644 index 0000000..78b3770 --- /dev/null +++ b/README.cn.md @@ -0,0 +1,110 @@ +# img-vuer + +> 一个移动端优先的 Vue2 图片预览插件 + +:ok_woman: 极速使用 + +:point_right: 滑动手势 + +:mag: 缩放手势 + +V0.11.0 可以使用缩略图啦~ + +V0.13.0 返回键退出浏览(安卓手机) + +V0.15.0 使用 scale() 修复放大模糊问题 + +:computer: v0.17.1 支持桌面浏览器啦!! + +**[点击查看使用实例](https://ssshooter.github.io/img-vuer/index.html)**或扫描二维码 + + + +## 安装 + +```bash +npm i img-vuer --save +``` + +## 使用 + +```javascript +// 引入 img-vuer,安装插件 +import gallery from 'img-vuer' +Vue.use(gallery, { + swipeThreshold: 150, // 滑动阈值,默认值 100 +}) +``` + +```html + + + + + + + + + + + + + + + + +``` + +## API + +| api | arg | description | +| ----------------- | ----- | ----------------------------------------------------------------- | +| close() | / | 退出浏览 | +| onIndexChange() | cb | `$imgVuer.onIndexChange((newVal, oldVal)=>{...})` | +| onToggle() | cb | 退出或进入浏览时触发 `$imgVuer.onToggle((newVal, oldVal)=>{...})` | +| changeBGColor() | color | 修改浏览器背景 `$imgVuer.changeBGColor('#fff')` | +| next() | / | 下一幅图 `$imgVuer.next()` | +| prev() | / | 上一幅图 `$imgVuer.prev()` | +| getCurrentIndex() | / | / | + +## 开发 + +```bash +# development environment node v6.15.1 + +# install dependencies +npm install + +# serve with hot reload at localhost:8080 +npm run dev + +# build for production with minification +npm run build +``` + +## 问题处理 + +### 页面大小不对 + +添加 meta + +```html + +``` + +### 大量大图 + +如果你把大量大图分到一组,img-vuer 会在你预览这组的任意图片时加载该组所有图片。这会耗费用户大量流量和拖慢页面。 + +你可以使用 v0.17.2 解决这个问题,这个版本只会加载你浏览过的图片。 + +### key + +不能使用 index 作 `v-gallery` 图片的循环 key. + +## License + +MIT diff --git a/README.md b/README.md index a551bd9..3897989 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ # img-vuer -> An image viewer base on Vue.js for mobile +> An Mobile-First image viewer for Vue2 -:ok_woman: Easy to use +:ok_woman: Easy to use -:point_right: Swipe gesture +:point_right: Swipe gesture -:mag: Zoom gesture +:mag: Zoom gesture -V0.11.0 Now you can use thumbnail~ +V0.11.0 Now you can use thumbnail~ V0.13.0 Gallery hide when the physical back button is pressed (android device only) @@ -16,56 +16,64 @@ V0.15.0 Fix blurry after using scale() :computer: v0.17.1 compatible with PC -**Now you can use both Mobile and PC Browser** :satisfied: +**Now you can use both Mobile and PC Browser** :satisfied: -**[live demo](https://ssshooter.github.io/img-vuer/index.html)** +**[live demo](https://ssshooter.github.io/img-vuer/index.html)** -or scan the QRcode +or scan the QRcode - + ## Install -``` bash + +```bash npm i img-vuer --save ``` + ## Usage + ```javascript // import img-vuer and install import gallery from 'img-vuer' -Vue.use(gallery, { - swipeThreshold: 150 // default 100 ,new in 0.12.0 +Vue.use(gallery, { + swipeThreshold: 150, // default 100 ,new in 0.12.0 }) ``` + ```html - + - - - + + + - - + + - + ``` + ## API -|api | arg | description | -| ------------- | ----- | ----- | -| close() | / | close the viwer | -| onIndexChange() | cb | `$imgVuer.onIndexChange((newVal, oldVal)=>{...})` | -| onToggle() | cb | on close or on open `$imgVuer.onToggle((newVal, oldVal)=>{...})` | -| changeBGColor() | color | change the background color of viwer `$imgVuer.changeBGColor('#fff')` | -| next() | / | switch to next image `$imgVuer.next()` | -| prev() | / | switch to previous image `$imgVuer.prev()` | -| getCurrentIndex() | / | / | + +| api | arg | description | +| ----------------- | ----- | --------------------------------------------------------------------- | +| close() | / | close the viwer | +| onIndexChange() | cb | `$imgVuer.onIndexChange((newVal, oldVal)=>{...})` | +| onToggle() | cb | on close or on open `$imgVuer.onToggle((newVal, oldVal)=>{...})` | +| changeBGColor() | color | change the background color of viwer `$imgVuer.changeBGColor('#fff')` | +| next() | / | switch to next image `$imgVuer.next()` | +| prev() | / | switch to previous image `$imgVuer.prev()` | +| getCurrentIndex() | / | / | + ## Development -``` bash + +```bash # development environment node v6.15.1 # install dependencies @@ -77,12 +85,30 @@ npm run dev # build for production with minification npm run build ``` + ## Troubleshooting -### Abnormal with page scale -Add meta + +### Abnormal with page scale + +Add meta + ```html - + ``` -### Should not use index as key for the component which is added `v-gallery`. + +### for a large number of large images + +If you group a large number of large images, img-vuer will load all image in the same group, so it will cause unnecessary mobile data traffic and slow the page down. + +You can use (only)v0.17.2 in this situation and img-vuer will only load the image you watched. + +### key + +Should not use index as key for the component which is added `v-gallery`. + ## License -MIT + +MIT