README.md

Tailwind Modal

Simple modal with ready-to-use Tailwind css's markup.

This is a small package ready to be dropped in into your pipeline. It simply adds a minimal modal functionality to your project.

It uses a simple es6 class, so you have to take care about transpile (if you need it). Hope this could save a bit of time to someone!

Install

$ npm install @marcomessa/tailwind-modal

Usage

HTML

<a href="#" data-open="exampleModal">Click me</a>
<div id="exampleModal" class="modal">
    <div class="modal__inner">
        Test Modal

        <button class="modal__button">
            close
        </button>
    </div>
</div>

JS

import Modals from "@marcomessa/tailwind-modal";

...

const modals = new Modals();
modals.init();

SCSS

@import '~@marcomessa/tailwind-modal/modal';