pixeldev/uxmodal-bundle

A Ux Modal bundle for Twig width Tailwind CSS and Alpine JS

dev-develop 2024-11-24 17:34 UTC

Requires

• php: ^8.2
• twig/twig: ^2.7 || ^3.0

Requires (Dev)

• symplify/easy-coding-standard: ^11.1

MIT

README

Presentation

A modal component with Tailwind and Alpine JS for Twig from the Penguin UI site : https://www.penguinui.com/components/modal

Requirements

• PHP >= 8.0
• Twig >= 2.7
• Tailwind CSS >= 3.4
• Alpine JS >= 3
• Composer

Installation

Install the bundle

Execute the following composer command to add the bundle to the dependencies of your project:

composer require pixeldev/uxmodal-bundle

Enable the bundle

Enable the bundle by adding it to the list of registered bundles in the config/bundles.php file of your project:

return [
    /* ... */
    Pixel\UxModalBundle\UxModalBundle::class => ['all' => true],
];

Install Tailwind CSS and Alpine JS

See this documentation : https://www.penguinui.com/docs/getting-started

Add bundle directory for Tailwind compilation

Open tailwind.config.js and add the following line to the content table

'./vendor/pixeldev/uxmodal-bundle/src/Resources/views/**/*.html.twig'

Use

General use

Here's an example of how to add a modal to your site:

{% embed '@UxModal/modal.html.twig' with {isFooterModal: true} %}
    {# Label for this button #}
    {% block buttonLabel %}Open Modal{% endblock %}
    {# Title for Modal #}
    {% block titleModal %}Title Modal{% endblock %}
    {# Body text for Modal #}
    {% block bodyModal %}
        Body text description
    {% endblock %}
    {# Add a button on a footer Modal #}
    {% block footerModal %}
        <button @click="modalIsOpen = false" type="button"
                class="{{ primaryButtonClass }} bg-black text-white hover:bg-primary-dark">
           Purchase
        </button>
    {% endblock %}
{% endembed %}

Configurations

Todo