Skip to content

Latest commit

 

History

History
121 lines (88 loc) · 4.5 KB

README.md

File metadata and controls

121 lines (88 loc) · 4.5 KB

License


BladewindUI is a collection of UI components written purely using TailwindCSS, Laravel blade templates and Vanilla Javascript. These components are super simple to use and come with different levels of customization.

Installation

The full installation guide is available on https://bladewindui.com/install.

BladewindUI is very specific to Laravel since all components are written purely using blade syntax. To install in your Laravel project simply run this command in the terminal at the root of your project.

composer require mkocansey/bladewind

Next you need to publish the package assets by running this command, still in the terminal at the root of your Laravel project.


php artisan vendor:publish --provider="Mkocansey\Bladewind\BladewindServiceProvider" --tag=bladewind-public --force

Now include the BladewindUI css file in the <head> of your pages. This should ideally be done in the layouts file your app pages extend from. You will also need to include the css used for animating the modals and other elements.


<link href="{{ asset('vendor/bladewind/css/animate.min.css') }}" rel="stylesheet" />
<link href="{{ asset('vendor/bladewind/css/bladewind-ui.min.css') }}" rel="stylesheet" />

Finally, include the BladewindUI javascript file anywhere before the closing of the </body> tag of your pages. Again, this should ideally be done in the layouts file your app's pages extend from.


<script src="{{ asset('vendor/bladewind/js/helpers.js') }}" type="text/javascript"></script>

You are now ready to start using any of the BladewindUI components in your application


<x-bladewind::button>Save User</x-bladewind::button>



Components Include



Check out the full documentation on https://bladewindui.com.



Questions and General Info

If you want to ask anything at all or report a security vulnerability, please e-mail [email protected] or tweet @bladewindui


License

BladewindUI is an open-sourced library licensed under the MIT license.