Skip to content
This repository has been archived by the owner on Jul 1, 2024. It is now read-only.

Latest commit

 

History

History
38 lines (27 loc) · 949 Bytes

README.md

File metadata and controls

38 lines (27 loc) · 949 Bytes

This package only supports Alpine v3.x
This package needs TailwindCSS
This package currently does not work fantastic with the JIT compiler

Alpine Lightbox

Add a dynamic lightbox to your Alpine 3.x components with a custom directive.

About

This plugin adds a new x-lightbox to Alpine.

Installation

NPM

npm install @edsardio/alpine-lightbox

JS

Register your x-lightbox directive to Alpine.

import Alpine from "alpinejs";
import Lightbox from "@edsardio/alpine-lightbox";

Alpine.plugin(Lightbox);

window.Alpine = Alpine;
window.Alpine.start();

Usage

HTML

To create a lightbox add the directive to the element as following, this will register a click event that opens the lightbox.

<img x-lightbox="https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png" src="https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png">