Download the PHP package tobimori/kirby-tailwind-merge without Composer
On this page you can find all versions of the php package tobimori/kirby-tailwind-merge. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tobimori/kirby-tailwind-merge
More information about tobimori/kirby-tailwind-merge
Files in tobimori/kirby-tailwind-merge
Package kirby-tailwind-merge
Short Description Tailwind Merge for Kirby CMS
License MIT
Informations about the package kirby-tailwind-merge
Kirby Tailwind Merge
Intelligently merge Tailwind classes without style conflicts in your Kirby templates.
This plugin relies on tailwind-merge-php by Sandro Gehri for merging classes and only adapts it to work in the "Kirby ecosystem". Any issues related to merging classes should probably reported over there.
Installation
Manual installation
Download and copy this repository to /site/plugins/kirby-tailwind-merge
, or apply this repository as Git submodule.
Usage
This plugin provides two helper functions to use in your blueprints. Whether functions should be registered can be controlled in your config.php
, see Options.
attr()
This helper function works similar to the Kirby built-in attr()
function and overwrites it to support Tailwind Merge behaviour for the class
attribute.
You'll need to disable the built-in attr()
helper at the top-most location in your index.php
file - before Kirby is loaded.
Example
merge()
merge()
applies Tailwind Merge behaviour and outputs a class attribute.
Example
cls()
cls()
applies Tailwind Merge behaviour and outputs the contents of class attribute. This can be used to work better with the conditional merge syntax this plugin provides, and also for nesting.
Example
Conditional merging
This conditional merge syntax using arrays can be used with the merge()
and attr()
functions as well.
mod($modifier, $classes)
mod()
applies the specified modifier/variant to each class supplied in the $class
string. It also applies Tailwind Merge behaviour and outputs the contents of class attribute. This is useful when you have a bunch of classes and want them all to activate at the same modifier.
Example
"But Tailwind won't parse my classes then!"
I hear you, but thankfully Tailwind allows us to customize the parser to our needs. This is not a 100% perfect technique due to being reliant on regexing' the classes, but it works for most cases.
With a custom transformer function to scan for the mod()
function, your tailwind.config.js
could look like this:
For simplicity in parsing the function with Tailwind, the mod()
function doesn't support arrays. With this approach, you're also not aple to e.g. use a variable inside the function, but only direct strings.
If you still want to use variables, that e.g. come from the CMS directly, you can add the generated classes to your safelist
and they'll be generated to matter what.
Options
Option | Default | Description |
---|---|---|
prefix |
'' |
Set a prefix for your tailwind classes |
cache |
false |
Enable caching for tailwind merge using a Kirby Cache |
Options allow you to fine tune the behaviour of the plugin. You can set them in your config.php
file:
Support
This plugin is provided free of charge & published under the permissive MIT License. If you use it in a commercial project, please consider to sponsor me on GitHub to support further development and continued maintenance of my plugins.
License
MIT License Copyright © 2023 Tobias Möritz
All versions of kirby-tailwind-merge with dependencies
getkirby/composer-installer Version ^1.2
gehrisandro/tailwind-merge-php Version ^1.0