README

Notice: Since I started this project, I've started using Filament, and as a result don't really have a need for this anymore. No further changes will be committed to this package.

Notice: This package is still under development and is not production ready. Available components and api may change at any time without a major version change; use at your own risk.

blade

Blade is a package that provides blade components for common elements you may need in an application. The components are built and optimized for Tailwind CSS, Laravel Livewire, and Alpine.js, however they can be styled and used differently.

Installation

You can install the package via composer:

composer require rawilk/blade

You can publish the config file with:

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

You can view the default configuration here: https://github.com/rawilk/blade/blob/main/config/blade.php

Usage

Here is an example of how you can render a button element using the button component:

<x-blade::button.button color="blue" wire:click="update">
    Click me
</x-blade::button.button>

This will render a button with a background color of blue. Since a wire:click is specified, our button component will automatically add a loading indicator inside the button that will be shown when while waiting for the server to finish the request.

Note: The button component, along with may other components, can also be referenced with its alias defined in the config file. For example, you can use x-button instead of x-blade::button.button.

Further documentation will be coming in the future for further usage on each of the components.

Scripts

Setup

For convenience, you can run the setup bin script for easy installation for local development.

./bin/setup.sh

Formatting

Although formatting is done automatically via workflow, you can format php code locally before committing with a composer script:

composer format

Testing

composer test

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

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

Credits

License

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

rawilk / blade

Maintainers

Details