tobya/tailwind-trumpet

A Package to trumpet or expose Tailwind css classes that are set in code.

Fund package maintenance!
Tobya

v0.4 2024-05-29 19:30 UTC

This package is auto-updated.

Last update: 2024-10-25 06:11:37 UTC


README

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

Tailwind Trumpet, Trumpets(!) your hidden tailwind classes. Expose those hidden css classes used in your php objects so they will always be available in your blades

Sometimes you might find that you have a set of colors or other styles that you assign in your php code eg you have a list of courses of specific type and you want each type to be the same tailwind color when displayed on your front end, but because tailwind compiles away unused classes and does not scan php code, you need to move this code to the front end usually.

Tailwind Trumpet solves this problem by allowing you to register any tailwind classes you php code uses and then these are published to your views directory so that tailwinds build process will find them.

Installation

You can install the package via composer:

composer require tobya/tailwind-trumpet

You can publish the config file with:

php artisan vendor:publish --tag="tailwind-trumpet-config"

This will output the following file.

config\trumpet.php

| A list of  classes here that will return a list of classes that need to be exposed.
| classes must have a function trumpetTailwindClasses() that returns a String or array of Strings 
return [
        \App\Services\CourseTypeLookupService::class,
];

Usage

 > php artisan trumpet:expose

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

License

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