Tailwind CSS for Laravel
Introduction
This package wraps the standalone Tailwind CSS CLI tool. No Node.js required.
Inspiration
This package was inspired by the Tailwind CSS for Rails gem.
Installation
You can install the package via composer:
composer require tonysm/tailwindcss-laravel
Optionally, you can publish the config file with:
php artisan vendor:publish --tag="tailwindcss-config"
Usage
The package consists of 4 commands and a helper function.
Download the Tailwind CSS Standalone Binary
Since each OS/CPU needs its own version of the compiled binary, the first thing you need to do is run the download command:
php artisan tailwindcss:download
This will detect the correct version based on your OS and CPU architecture.
By default, it will place the binary at the root of your app. The binary will be called tailwindcss. You may want to add that line to your project's .gitignore file.
Alternatively, you may configure the location of this binary file in the config/tailwindcss.php (make sure you export the config file if you want to do that).
Installing the Scaffolding
There are some files needed for the setup to work. On a fresh Laravel application, you may run the install command, like so:
php artisan tailwindcss:install
This will ensure there's a tailwind.config.js file at the root of your project, as well as a resources/css/app.css file with the basic Tailwind CSS setup.
Building
To build the Tailwind CSS styles, you may use the build command:
php artisan tailwindcss:build
By default, that will read your resources/css/app.css file and generate the compiled CSS file at public/css/app.css.
You may want to generate the final CSS file with a digest on the file name for cache busting reasons (ideal for production). You may do so with the --digest flag:
php artisan tailwindcss:build --digest
You may also want to generate a minified version of the final CSS file (ideal for production). You may do so with the --minify flag:
php artisan tailwindcss:build --minify
These two flags will make the ideal production combo. Alternatively, you may prefer using a single --prod flag instead, which is essentially the same thing, but shorter:
php artisan tailwindcss:build --prod
Watching For File Changes
When developing locally, it's handy to run the watch command, which will keep an eye on your local files and run a build again whenever you make a change locally:
php artisan tailwindcss:watch
Note: the watch command is not meant to be used in combination with --digest or --minify flags.
Using the Compiled Asset
To use the compiled asset, you may use the tailwindcss helper function instead of the mix function like so:
- <link rel="stylesheet" href="{{ mix('css/app.css') }}" >
+ <link rel="stylesheet" href="{{ tailwindcss('css/app.css') }}" >
That should be all you need.
Deploying Your App
When deploying the app, make sure you add the ideal build combo to your deploy script:
php artisan tailwindcss:build --prod
If you're running on a "fresh" app (or an isolated environment, like Vapor), and you have added the binary to your .gitignore file, make sure you also add the download command to your deploy script before the build one. In these environments, your deploy script should have these two lines
php artisan tailwindcss:download
php artisan tailwindcss:build --prod
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.
10 Aug 29, 2022
616 Dec 17, 2022
1.8k Jan 7, 2023
228 Nov 11, 2022
1 Mar 6, 2022
3 Jul 19, 2022
6 Apr 2, 2022
118 Dec 21, 2022
0 Jul 20, 2022
1.7k Dec 28, 2022
3 Jul 27, 2022
5 Dec 12, 2021
0 Feb 10, 2022
4 Oct 5, 2022
2 Dec 21, 2021
811 Jan 2, 2023
686 Dec 28, 2022
931 Dec 24, 2022
1.7k Dec 31, 2022