Přejít k obsahu

Vlastní doplňky

Zobrazit jako Markdown Upravit na GitHub Dokumentace na 3843abd

Vlastní doplněk je třída PHP implementující TailwindPHP\Plugin\PluginInterface. Dostane instanci PluginAPI a pomocí ní registruje statické a funkční utility, komponenty a varianty. Po registraci pomocí registerPlugin() se doplněk vyhledá podle názvu v direktivě @plugin — stejným způsobem jako vestavěné doplňky pro typografii a formuláře.

PluginInterface

Implementujte tři metody:

PHP
namespace TailwindPHP\Plugin;

interface PluginInterface
{
    public function getName(): string;
    public function __invoke(PluginAPI $api, array $options = []): void;
    public function getThemeExtensions(array $options = []): array;
}
  • getName() vrací identifikátor používaný v @plugin "...".
  • __invoke() spustí doplněk a zaregistruje vše pomocí $api. Pole $options obsahuje hodnoty z bloku @plugin CSS.
  • getThemeExtensions() vrací jmenné prostory motivu, které se sloučí před vygenerováním utilit (pokud žádné nejsou, vraťte []).

Příklad

PHP
use TailwindPHP\Plugin\PluginInterface;
use TailwindPHP\Plugin\PluginAPI;

class MyCustomPlugin implements PluginInterface
{
    public function getName(): string
    {
        return 'my-custom-plugin';
    }

    public function __invoke(PluginAPI $api, array $options = []): void
    {
        // Static utilities
        $api->addUtilities([
            '.btn' => [
                'padding' => '0.5rem 1rem',
                'border-radius' => '0.25rem',
                'font-weight' => '600',
            ],
            '.btn-primary' => [
                'background-color' => 'blue',
                'color' => 'white',
            ],
        ]);

        // Functional utilities (generates .gutter-sm, .gutter-md, .gutter-lg)
        $api->matchUtilities(
            [
                'gutter' => fn ($value) => ['padding-inline' => $value],
            ],
            ['values' => ['sm' => '1rem', 'md' => '2rem', 'lg' => '3rem']]
        );

        // Component classes (sorted into the components layer)
        $api->addComponents([
            '.card' => [
                'background-color' => 'white',
                'border-radius' => '0.5rem',
                'padding' => '1rem',
            ],
        ]);

        // Custom variant (see the note below the API reference)
        $api->addVariant('hocus', '&:hover, &:focus');

        // Read a theme value
        $primary = $api->theme('colors.blue.500', '#3b82f6');
    }

    public function getThemeExtensions(array $options = []): array
    {
        return []; // Return theme additions if needed
    }
}

Přehled PluginAPI

API kopíruje TailwindCSS API doplňku:

Metoda Signatura Účel
addBase addBase(array $css): void Přidá styly základní vrstvy.
addUtilities addUtilities(array $utilities, array $options = []): void Zaregistruje statické třídy utilit podle selektoru.
matchUtilities matchUtilities(array $utilities, array $options = []): void Zaregistruje funkční utility; $options['values'] poskytuje mapu hodnot a $options['supportsNegativeValues'] povoluje záporné hodnoty.
addComponents addComponents(array $components, array $options = []): void Zaregistruje třídy komponent (vrstva komponent).
matchComponents matchComponents(array $components, array $options = []): void Zaregistruje funkční komponenty s mapou hodnot.
addVariant addVariant(string $name, string|array $variant): void Zaregistruje statickou variantu ze selektoru.
matchVariant matchVariant(string $name, callable $callback, array $options = []): void Zaregistruje funkční variantu; $options['values'] poskytuje mapu hodnot.
theme theme(string $path, mixed $defaultValue = null): mixed Načte hodnotu motivu podle cesty s tečkami (e.g. colors.blue.500).
config config(?string $path = null, mixed $defaultValue = null): mixed Načte hodnotu konfigurace podle cesty s tečkami, nebo celou konfiguraci, pokud je $path null.
prefix prefix(string $className): string Použije nakonfigurovaný prefix na název třídy.

Zpětné volání předané metodám matchUtilities, matchComponents a matchVariant dostane hodnotu a pole druhého argumentu obsahující klíč modifier.

Vybírejte názvy utilit, které jádro Tailwind již nepoužívá. Pokud má utilita doplňku stejný název jako utilita jádra (například tab-*, který jádro Tailwind používá pro tab-size od verze v4.3), obě deklarace se ocitnou ve stejném pravidle a deklarace jádra bude poslední, takže zvítězí: utilita doplňku tab-4 namapovaná na 7 přesto vytvoří tab-size: 4.

Známý problém: Varianty registrované pomocí addVariant() a varianty pro jednotlivé hodnoty registrované pomocí matchVariant() se v aktuálním vydání nepoužijí. hocus:flex z výše uvedeného příkladu se zkompiluje na .hocus\:flex { display: flex; } bez selektoru :hover/:focus (#10). Do opravy definujte variantu v CSS pomocí @custom-variant; tento postup funguje: @custom-variant hocus (&:hover, &:focus);.

Registrace a použití

Zaregistrujte instanci doplňku a potom na něj odkazujte názvem z getName():

PHP
use TailwindPHP\tw;
use function TailwindPHP\registerPlugin;

registerPlugin(new MyCustomPlugin());

$css = tw::generate(
    '<div class="btn btn-primary card gutter-md">…</div>',
    '@plugin "my-custom-plugin"; @import "tailwindcss/utilities.css";'
);

Direktivu @plugin najdete v části Doplňky a hodnoty zpřístupněné přes $api->theme() v části Motiv.