https://github.com/optixsolutions/vue-lightbox
https://github.com/optixsolutions/vue-lightbox
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/optixsolutions/vue-lightbox
- Owner: optixsolutions
- License: mit
- Created: 2018-09-13T16:23:14.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-12T15:52:13.000Z (almost 8 years ago)
- Last Synced: 2026-04-08T20:53:44.956Z (4 months ago)
- Language: CSS
- Size: 75.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Vue Lightbox
A simple lightbox image gallery plugin.
## Installation
```bash
npm install @optix/vue-lightbox --save
yarn add @optix/vue-lightbox
```
```js
import Vue from 'vue';
import VueLightbox from '@optix/vue-lightbox';
Vue.use(VueLightbox);
```
```scss
@import "@optix/vue-lightbox/src/sass/_index";
```
## Usage
// TODO
Accessing the lightbox object:
```js
// Globally
Vue.lightbox.open();
// On an instance
this.$lightbox.open();
```
### Methods
* open() - id
* onOpen() - callback
* close()
* onClose() - callback
* destroy() - callback
```vue
```
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.