Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/crowdbotics/v-img


https://github.com/crowdbotics/v-img

gallery gallery-plugin images vue vue-image-gallery vuejs vuejs-image-gallery

Last synced: about 2 months ago
JSON representation

Lists

README 

        





  Version

  Downloads

  License






  Demonstration




v-img is a plugin for [Vue.js](https://vuejs.org/) that allows you to show images in full-screen gallery by adding only one directive to the `` tag.



[Demonstration page](https://v-img.review)



### Browser support

| Firefox | Chrome | Safari | Opera | Firefox (mobile)   | Chrome (mobile)    | Safari (mobile)    |

|:--:     |:--:    |:--:    |:--:   |:--:                |:--:                |:--:                |

| 32      | 44     | 9.1    | 32    | :white_check_mark: | :white_check_mark: | :white_check_mark: |



  big thanks to

  


  

    Demonstration

  




## Installation



#### via npm

```

npm install v-img --save

```



In your script entry point:



```javascript

import Vue from 'vue';

import VueImg from 'v-img';



Vue.use(VueImg);

```



#### via CDN

[![](https://data.jsdelivr.com/v1/package/npm/v-img/badge)](https://www.jsdelivr.com/package/npm/v-img)

* make sure to change `latest` to the number of latest version of the plugin to avoid compatibility problems.

```html



```



### Optional configurations

*in this snippet all settings has its default value. No need to specify them unless you want to change default behavior. Unfortunately if you used CDN way to include plugin you can't set up these options, but still can set them up inline.

```javascript

const vueImgConfig = {

  // Use `alt` attribute as gallery slide title

  altAsTitle: false,

  // Display 'download' button near 'close' that opens source image in new tab

  sourceButton: false,

  // Event listener to open gallery will be applied to  element

  openOn: 'click',

  // Show thumbnails for all groups with more than 1 image

  thumbnails: false,

}

Vue.use(VueImg, vueImgConfig);

```



## Usage



Add `v-img` directive to the image.

```vue



```



### Available options

Add similar directive arguments to place images to one gallery. (`:name` from the example below could be anything you want)

```vue





```



Options that could be specified in directive value



```vue



```



| Option | Description | Default value | Data type |

| :----: | :---------: | :-----------: | :-------: |

| group  | The same as directive argument, but could be set dynamically | directive argument or undefined | string |

| src    | Image source that will be displayed in gallery | src attribute value from html tag | string |

| title  | Caption that will be displayed | empty string or value of the `alt` attribute, if `altAsTitle` is true | string |

| openOn | Event listener to open gallery will be applied to ``. Available options are 'dblclick', 'mouseover' and all native JS events. | 'click' if another not stated when initializing plugin | string |

| sourceButton | Display 'download' button near 'close' that opens source image in new tab | `false` if `sourceButton` is not set to true when initializing plugin | boolean |

| thumbnails | When opening group by clicking (or other `openOn` event) on this image, thumbnails of images for this group will be visible | `false` if `thumbnails` is not set to true when initializing plugin | boolean |

| opened | Function that will be executed on gallery open | undefined | function |

| closed | Function that will be executed on gallery close | undefined | function |

| changed(imageIndex) | Function that will be executed when switching between images in gallery | undefined | function |

| cursor | Cursor when hovering original `` | 'pointer' | string |



* Any of these options except `opened`, `closed`, `changed` functions and `openOn` property could be changed at runtime.