# vue-tailwind-lightbox

> A simple TailwindCSS Lightbox, written in Vue.js 3.

Latest version **1.0.5** (published 2024-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-tailwind-lightbox
pnpm add vue-tailwind-lightbox
yarn add vue-tailwind-lightbox
bun add vue-tailwind-lightbox
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5 |
| Published | 2024-02-08 |
| First published | 2023-12-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 28 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | cn-2k |
| Keywords | vue3, lightbox, tailwind, vue, vuejs |

## Links

- npm: https://www.npmjs.com/package/vue-tailwind-lightbox
- Repository: https://github.com/cn-2k/vue-tailwind-lightbox
- Homepage: https://github.com/cn-2k/vue-tailwind-lightbox#readme
- Issues: https://github.com/cn-2k/vue-tailwind-lightbox/issues
- npm.io page: https://npm.io/package/vue-tailwind-lightbox

## Dependencies (1)

- [@vueuse/core](https://npm.io/package/@vueuse/core.md) ^10.7.0

## Alternatives

- [@sveltejs/kit](https://npm.io/package/@sveltejs/kit.md) — 2.2M weekly downloads
- [@atlaskit/theme](https://npm.io/package/@atlaskit/theme.md) — 402.0K weekly downloads
- [@tangle-network/brand](https://npm.io/package/@tangle-network/brand.md) — 10.0K weekly downloads
- [seneca](https://npm.io/package/seneca.md) — 7.4K weekly downloads
- [@bsb/base](https://npm.io/package/@bsb/base.md) — 7.2K weekly downloads

## Recent versions

- 1.0.5 (latest) — 2024-02-08
- 1.0.4 — 2024-01-11
- 1.0.3 — 2023-12-26
- 1.0.2 — 2023-12-20
- 1.0.1 — 2023-12-07
- 1.0.0 — 2023-12-07

## README

<div align="center">

![ezgif-2-e81342282f](https://github.com/cn-2k/vue-tailwind-lightbox/assets/59366705/f6b3f948-2d8a-4886-bb8d-b8b6c786bab0)


</div>

<h1 align=center>Vue Tailwind Lightbox ✨</h1>
<p align=center>A Gallery/Lightbox component styled with TailwindCSS for Vue 3 (Typescript included!).</p>
<p align=center>Based on <a href="https://www.frontendmentor.io/challenges/ecommerce-product-page-UPsZ9MJp6" target="_blank">Frontend Mentor E-commerce product page</a> Lightbox.</p>

## 📺 Demo

https://vue-tailwind-lightbox-demo.vercel.app/

## 🚀 Installation

1. Install using your package manager of choice:

```bash
npm i vue-tailwind-lightbox
```

2. Add the source files of Nuxt Tailwind Lightbox to the ```tailwind.config.js``` template path:

```js
module.exports = {
  content: [
    // other files...
    './node_modules/vue-tailwind-lightbox/**/*.{js,ts,vue}',
  ],
}
```

## ⚙️ Usage

Import the component locally or define it globally:

```vue
<template>
  <vue-tailwind-lightbox :image-list="imageList" />
</template>

<script setup lang="ts">
import { ref } from 'vue'
import { VueTailwindLightbox } from 'vue-tailwind-lightbox'
import "vue-tailwind-lightbox/dist/style.css"; // Import CSS needed!

import image1 from '@/assets/images/image-product-1.jpg'
import image2 from '@/assets/images/image-product-2.jpg'
import image3 from '@/assets/images/image-product-3.jpg'
import image4 from '@/assets/images/image-product-4.jpg'

const imageList = ref([image1, image2, image3, image4])
</script>
```

<strong>Note:</strong> don't worry about the thumbnails images, they are automatically compressed to improve and maintain performance! 😉

## 📃 Props

| Name       | Type               | Default | Description                        |
| ---------- | ------------------ | ------- | ---------------------------------- |
| `image-list` | `Array`          |   ---   | Array of images to fill the gallery |

---
_Source: https://npm.io/package/vue-tailwind-lightbox · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._