README

A package that simplifies the creation of dynamic Laravel components using PHP classes.

Installation

Install the package via Composer:

composer require chat-agency/laravel-backend-component

To use the package’s Tailwind themes, configure Tailwind to scan the package's Blade files. The method differs slightly between Tailwind versions:

Tailwind CSS v3:

Add the package's view path to the content array in your tailwind.config.js file:

// tailwind.config.js
export default {
    content: [
        './vendor/chat-agency/laravel-backend-component/resources/views/**/*.blade.php', // <- this line
        // other paths
    ],
    // ...
};

Tailwind CSS v4:

In your main CSS file (e.g., resources/css/app.css), use the @source at-rule to include the package's view path:

@import 'tailwindcss';

/** Add the path using a source at rule */
@source '../../vendor/chat-agency/laravel-backend-component/resources/views/**/*.blade.php';

Basic use

Use the MainBackendComponent class to construct your component. Pass the component name/path as the first parameter:

use ChatAgency\BackendComponents\MainBackendComponent;

$button = new MainBackendComponent("inline.button");

Alternatively, builders and an enum are available to streamline instance creation:

use ChatAgency\BackendComponents\Enums\ComponentEnum;
use ChatAgency\BackendComponents\MainBackendComponent;

$button = ComponentBuilder::make(ComponentEnum::BUTTON);

Since the main component class implements Laravel’s Htmlable interface, you can output the component using simple Blade syntax—no escaping needed:

{{ $button }}

Theming

The package also supports theming, primarily for Tailwind classes.

All themes are stored inside resources/views/_themes/tailwind by default, ensuring seamless Tailwind class discovery

use ChatAgency\BackendComponents\Enums\ComponentEnum;
use ChatAgency\BackendComponents\MainBackendComponent;

$button = ComponentBuilder::make(ComponentEnum::BUTTON)
    ->setTheme('theme_file', 'theme_name');

Tests

Run tests using Composer:

composer test

If you're submitting a pull request, use the qa command—it runs phpstan, pint, and tests. These are the same checks performed in GitHub Actions

composer qa

License

This package is licensed under the MIT License.

chat-agency / laravel-backend-component

Maintainers

Details