Custom-caption-vue-image-lightbox NPM

vue-image-lightbox

A simple image lightbox component for Vuejs
NPM Package

I use CSS style from react-images

Development (NPM / Yarn)

npm run dev
yarn dev

Install

NPM / Yarn

Install the package:

npm install custom-caption-vue-image-lightbox vue-lazyload
yarn add vue-image-lightbox vue-lazyload

Then import it in your project At your entry point (main.js normally)

import Vue from 'vue'
import VueLazyLoad from 'vue-lazyload'
...
Vue.use(VueLazyLoad)

and use the lightbox:

import LightBox from 'custom-caption-vue-image-lightbox'

export default {
  components: {
    LightBox,
  },
}

Browser global

<script src="path/to/vue.js"></script>
<script src="path/to/dist/vue-image-lightbox.js"></script>

Usage

You can simply view App.vue to see how to use vue-image-lightbox

Import CSS style

require('custom-caption-vue-image-lightbox/dist/vue-image-lightbox.min.css')
// Use only when you are using Webpack

How to use:

<LightBox :images="images"></LightBox>

images has the structure:

[
  {
    thumb: 'http://example.com/thumb.jpg',
    src: 'http://example.com/image.jpg',
    caption: 'caption to display. receive <html> <b>tag</b>', // Optional
    srcset: '...' // Optional for displaying responsive images
  }
]

Options

Properties

Methods

Slots

close

The content of the close button.

footer

The content of the footer under the image.

slot-scopes

The previous button on the main image.

The next button on the main image.

previousThumb

The previous button on the thumbs list.

nextThumb

The next button on the thumbs list.

Events

onOpened(value): true to emit when the lightbox is opened and false when it is closed.
onLastIndex: Emit when the current image is the last one of the list.
onFirstIndex: Emit when the current image is the first one of the list.
onStartIndex: Emit when the current image is at the startAt index (specified in the properties).
onLoad: Emit when there are lengthToLoadMore images left in the array (specified in the properties). For example, if lengthToLoadMore = 2 and there are 7 images in your array, when you reach index 4 (which means there are 2 images left which are not discovered yet), this event will be emitted. After that, if the image array are updated and there are totally 15 images, the event will be emitted at index 12.

CREDITS

Most of the CSS belongs to react-images

Contributors:

vue vuejs lightbox gallery image gallery image lightbox

@babel/runtime babel-loader hammerjs vue-lazyload

@infinitebrahmanuniverse/nolb-custom-c @everything-registry/sub-chunk-1427

6.3.2

5 years ago

6.3.1

5 years ago