Installation

Prérequis

1 Déclarer le repository

Ajouter le repository privé Gitlab dans le composer.json de votre projet.

{
    "repositories": [
        {
            "type": "vcs",
            "url": "ssh://git@gitlab.sudalys-services.fr:2224/easy-solutions/ds-bundle.git"
        }
    ]
}
            

2 Installer le bundle

Lancer la commande Composer depuis la racine de votre projet.

composer require sudalys/ds-bundle:^0.0.10
            

3 Configurer Twig

Déclarer le chemin des templates du bundle dans config/packages/twig.yaml.

twig:
    paths:
        '%kernel.project_dir%/vendor/sudalys/ds-bundle/templates': ~
            

4 Configurer les composants Twig

Déclarer le namespace du bundle dans config/packages/twig_component.yaml.

twig_component:
    defaults:
        Sudalys\DSBundle\Twig\Components\:
            template_directory: 'components/'
            

5 Importer les assets

Ajouter les imports dans assets/styles/app.css. Tailwind scannera automatiquement les templates du bundle.

@import "../../vendor/sudalys/ds-bundle/assets/ds-bundle.css";
@source "../../vendor/sudalys/ds-bundle/templates/components/";
            

Vérification

Vider le cache, rebuilder Tailwind, puis tester un composant dans n'importe quel template.

php bin/console cache:clear
php bin/console tailwind:build
            

Test rapide

<twig:Button>Ça marche !</twig:Button>
                

Problèmes fréquents

Unable to find template "components/Button.html.twig"

Le chemin des templates n'est pas déclaré dans Twig.

twig:
    paths:
        '%kernel.project_dir%/vendor/sudalys/ds-bundle/templates': ~
            

Unknown "tailwind_merge" filter

La recipe Symfony Flex n'a pas été installée.

composer recipes:install tales-from-a-dev/twig-tailwind-extra --force
            

Les styles ne s'appliquent pas

Tailwind ne scanne pas les templates du bundle ou le CSS n'est pas importé. Rebuilder Tailwind et vérifier que @source et @import ds-bundle.css sont bien présents dans assets/styles/app.css.

php bin/console tailwind:build