A Blade-based component library for Laravel Projects

This is package is very much WIP.

Installation

You can install the package via composer:

composer require building13/laravel-blackbird-ui

You can publish and run the migrations with:

php artisan vendor:publish --tag="laravel-blackbird-ui-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="laravel-blackbird-ui-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-blackbird-ui-views"

Requirements

This packages includes basic style classes based on TailwindCSS.

Make sure TailwindCSS is installed and make sure to render the tailwind classes in the package views. You can inlude the following in your tailwind.config.js:

content: [
    './vendor/building13/laravel-blackbird-ui/resources/views/**/*.blade.php',`
]

While this package is in early development and not on Packagist, add this repo to your composer file.

"repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/Building13/laravel-blackbird-ui"
        }
    ],

You can also clone and develop locally in a Laravel project. To do that, you can update the repositories to the following:

{
    "repositories": [
        {
            "type": "path",
            "url": "../laravel-blackbird-ui"
        },
    ]
}

If you are having issues with Tailwind CSS IntelliSense plugin, try ignoring this path:

{
    "tailwindCSS.files.exclude": [
        "**/testbench-core/**"
    ],
}

Tailwind CSS IntelliSense

Usage

$blackbird = new Building13\Blackbird();
echo $blackbird->echoPhrase('Hello, Building13!');

Testing

composer test

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

• Nathan Gross
• All Contributors

License

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