survos/tree-bundle

incorporate jstree, using twig and stimulus and api-platform

1.5.208 2024-04-25 14:05 UTC

Requires

• php: ^8.1
• api-platform/core: ^3.2.1
• doctrine/doctrine-bundle: ^2.10.2
• doctrine/orm: ^2.16.2
• doctrine/persistence: ^2.0 || ^3.2
• stof/doctrine-extensions-bundle: ^1.8
• survos/core-bundle: ^1.5.208
• survos/inspection-bundle: ^1.5.208
• symfony/config: ^7.0 || ^6.3.2
• symfony/dependency-injection: ^7.0 || ^6.3.5
• symfony/http-kernel: ^7.0 || ^6.3.5
• symfony/options-resolver: ^7.0 || ^6.3
• symfony/stimulus-bundle: ^2.12
• symfony/ux-twig-component: ^2.12
• tacman/twig-tree-tag: ^3.0.1
• twig/twig: ^3.7.1

Requires (Dev)

• phpstan/phpstan: ^1.10.39
• symfony/browser-kit: ^7.0 || ^6.3.2
• symfony/framework-bundle: ^7.0 || ^6.3.5
• symfony/phpunit-bridge: ^7.0 || ^6.3.2
• symfony/twig-bundle: ^6.3 || ^7.0
• symfony/var-dumper: ^7.0 || ^6.3.5

MIT

• Tac Tacelosky

• symfony-ux
• symfony6

README

Working with hierarchical data can get complex quickly. Fortunately, there are tools to help. This bundle wraps 3 amazing tools together.

• a {% tree %} twig tag for recursively displaying a tree without writing a twig macro Wrapper for jstree using ApiPlatform. Also includes a {% tree %} twig tag.
• A stimulus controller that calls the jstree javascript library
• Some helpers to integrate with ApiPlatform for editing and creating tree nodes.

In addition to the above, the has a dependency on stof/doctrine-extensions-bundle to make doctrine entities hierarchical.

composer req survos/tree-bundle

Tree Tag

The {% tree %} tag works almost like {% for %}, but inside a {% tree %} you can call {% subtree var %} See more details at tacman/tree-tag.

{% tree item in menu %}
  {% if treeloop.first %}<ul>{% endif %}
    <li>
        <a href="{{ item.url }}">{{ item.name }}</a>
        {% subtree item.children %}
    </li>
  {% if treeloop.last %}</ul>{% endif %}
{% endtree %}

symfony new tree-demo --webapp --version=next --php=8.2 && cd tree-demo
composer config minimum-stability dev
composer config extra.symfony.allow-contrib true
composer req symfony/asset-mapper:^6.4 symfony/stimulus-bundle:2.x-dev survos/tree-bundle

bin/console make:controller Tree -i
cat > templates/tree.html.twig <<END
{% extends 'base.html.twig' %}
{% block body %}
    {% set food = [
        {name: 'fruit', children: [
            {name: 'apple', children: [
                {name: 'Granny Smith'},
                {name: 'Gala'},
                {name: 'Fuji'},
            ]},
            {name: 'banana'}
        ]},
        {name: 'veggies', children: [
            {name: 'peas'},
            {name: 'carrots'},
            {name: 'beets'}
        ]},

    ] %}

    <h2>Food Tree</h2>
    {% set _sc = '@survos/tree-bundle/tree' %}
<div {{ stimulus_controller(_sc) }} {{ stimulus_target(_sc, 'html') }}>
    {% tree item in food %}
        {% if treeloop.first %}<ul>{% endif %}
        <li>
            {{ item.name }}
            {% subtree item.children|default([]) %}
        </li>
        {% if treeloop.last %}</ul>{% endif %}
    {% endtree %}
</div>
{% endblock %}

END
symfony server:start -d
symfony open:local --path=/tree

Issue with AutoImport

    "controllers": {
      "tree": {
        "main": "src/controllers/tree_controller.js",
        "webpackMode": "eager",
        "fetch": "lazy",
        "enabled": true,
        "autoimport": {
          "jstree/dist/themes/default/style.min.css": true
        }
      },