Download the PHP package gehrisandro/tailwind-merge-php without Composer
On this page you can find all versions of the php package gehrisandro/tailwind-merge-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gehrisandro/tailwind-merge-php
More information about gehrisandro/tailwind-merge-php
Files in gehrisandro/tailwind-merge-php
Package tailwind-merge-php
Short Description TailwindMerge for PHP merges multiple Tailwind CSS classes by automatically resolving conflicts between them
License MIT
Informations about the package tailwind-merge-php
TailwindMerge for PHP allows you to merge multiple Tailwind CSS classes and automatically resolves conflicts between classes by removing classes conflicting with a class defined later.
A PHP port of tailwind-merge by dcastil.
Supports Tailwind v3.0 up to v3.4.
If you find this package helpful, please consider sponsoring the maintainer:
- Sandro Gehri: github.com/sponsors/gehrisandro
If you are using Laravel, you can use the TailwindMerge for Laravel
Table of Contents
- Get Started
- Usage
- Cache
- Configuration
- Contributing
Get Started
Requires PHP 8.1+
First, install TailwindMerge via the Composer package manager:
Then, use the TailwindMerge
class to merge your Tailwind CSS classes:
You can adjust the configuration of TailwindMerge
by using the factory to create a new instance:
For more information on how to configure TailwindMerge
, see the Configuration section.
Usage
TailwindMerge
is not only capable of resolving conflicts between basic Tailwind CSS classes, but also handles more complex scenarios:
It's possible to pass the classes as a string, an array or a combination of both:
Cache
For a better performance, TailwindMerge
can cache the results of the merge operation.
To activate pass your cache instance to the withCache
method.
It accepts any PSR-16 compatible cache implementation.
When you are making changes to the configuration make sure to clear the cache.
Configuration
If you are using Tailwind CSS without any extra config, you can use TailwindMerge right away. And stop reading here.
If you're using a custom Tailwind config, you may need to configure TailwindMerge as well to merge classes properly.
By default TailwindMerge is configured in a way that you can still use it if all the following apply to your Tailwind config:
- Only using color names which don't clash with other Tailwind class names
- Only deviating by number values from number-based Tailwind classes
- Only using font-family classes which don't clash with default font-weight classes
- Sticking to default Tailwind config for everything else
If some of these points don't apply to you, you need to customize the configuration.
This is an example to add a custom font size of "very-large":
For a more detailed explanation of the configuration options, visit the original package documentation.
Contributing
Thank you for considering contributing to TailwindMerge for PHP
! The contribution guide can be found in the CONTRIBUTING.md file.
TailwindMerge for PHP is an open-sourced software licensed under the MIT license.