wsssoftware/laravuewind

This is my package laravuewind

0.5.1 2024-03-14 15:55 UTC

README

Latest Version on Packagist npm GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Laravuewind is a package that provides a set of tools to integrate and improve the development of applications using Laravel with Vue and Tailwind.

Backend Installation

You can install the package via composer:

composer require wsssoftware/laravuewind

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravuewind-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravuewind-config"

This is the contents of the published config file:

return [
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravuewind-views"

Frontend Installation

On package.json file, add the following line to scripts config:

  "devDependencies": {
    "laravuewind": "latest",
  },

On tailwind.config.js file, add the following line to content config:

import laravuewind from './laravuewind/tailwind.ts';

export default {
    content: [
        //...
        './node_modules/laravuewind/resources/js/**/*.{vue,js,ts}',
    ],
    plugins: [
        //...
        laravuewind,
    ],
};

Note: If you use plugins that add primary and secondary colors as a non default pattern (100, 200, 300) like daisyui, you must call this plugin first.

Insert VueJS plugin

import Vue from 'vue';
import Laravuewind from 'laravuewind';

createInertiaApp({
    //...
    setup({ el, App, props, plugin }) {
        return createApp({ render: () => h(App, props) })
            .use(plugin)
            .use(Laravuewind) // <- this one
            .use(ZiggyVue, Ziggy)
            .mount(el);
    },
   //...
});

Form components

InputGroup

InputGroup is a component that allows you to group an input field with a label and/or feedback fields. To know more about it, please check it's implementation and Maskito if you want to use masks.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.