vImage (Vue Image lightbox viewer)

v-image is a plugin for Vue.js that allows you to show images in full-screen gallery by adding only one directive to the tag. This project created and used for iSPA CMS, so if you used this package, please noted that we may not check your issue or request.

Table of contents

• Getting started
• Props
• Milestone
• Versioning
• License

Milestone

• srcSet attributes support
• Custom download buttons group for srcSet
• Custom Icons (Download, Arrows, Close)
• Video support
• Picture tag support
• Gallery Auto play
• Integrate with el-image (Element UI)

Getting started

Install

npm i @ispa.io/vimage     // npm

Usage

import Vue from 'vue';
import vImage from '@ispa.io/vimage';

Vue.use(vImage);

Optional configurations

In this snippet all settings has its default value. Don't specify them unless you want to change default behavior.

const vImageConfig = {
  //  Global title
  'title': null,
  //  Show download button
  'download': false,
  //  Show thumbnails
  'thumbnails': false,
  //  on Event to show image
  'openOn': 'click',
}
Vue.use(vImage, vImageConfig);

Example

Grouping images list

<div v-image data-thumbnails title="global title">
  <img data-group="group-1" data-download src="..." data-src="..." alt="image 1">
  <img data-group="group-1" data-download src="..." data-src="..." alt="image 2">
  <img data-group="group-2" src="..." data-src="..." alt="image 3">
  <img data-group="group-2" src="..." data-src="..." alt="image 4">
</div>

OR

<div v-image="{
  'group': 'group-name',
  'download': true,
  'thumbnails': true
}">
  <img src="..." data-src="..." alt="image 1">
  <img src="..." data-src="..." alt="image 2">
</div>

OR

<img v-image data-group="group-1" data-download src="..." data-src="..." alt="image 1">
<img v-image data-group="group-1" data-download src="..." data-src="..." alt="image 2">
<img v-image data-group="group-2" src="..." data-src="..." alt="image 3">
<img v-image data-group="group-2" src="..." data-src="..." alt="image 4">

Only one image

<img v-image data-download src="...">

OR

<img v-image src="..." data-src="...">

Options

Option	Description	Default value	Data type
group	Group name	null	String
data-src	Image source that will be displayed in gallery	data-src attribute	String
src	Image thumbnails	src attribute	String
title	Caption that will be displayed	empty String or value of the alt attribute	String
openOn	Event listener to open gallery will be applied to tagName. Available options are all native JS events.	click/dblclick/mouseover...	String
data-download	Download button show	false	Boolean
data-thumbnails	Small thumbnails show (this thumb will be show by the src attribute)	false	Boolean

This plugins has more options and will be available at next versions.

Versioning

Maintained under the Semantic Versioning guidelines.

License

MIT © Malayvuong

Invite me a cup of coffee

If you like this project and want to contribute us, then you can send us a cup of coffee by this ways below:

PAYPAL.ME	MOMO App (Vietnam)

⬆ back to top