survos/tree-bundle

incorporate jstree, using twig and stimulus and api-platform

2.10.11 2026-06-17 12:11 UTC

Requires

• php: ^8.5
• doctrine/doctrine-bundle: ^3.0
• doctrine/orm: ^3.4
• doctrine/persistence: ^4.1
• stof/doctrine-extensions-bundle: ^1.14
• survos/js-twig-bundle: ^2.5
• survos/kit-bundle: ^2.5
• symfony/config: ^8.1
• symfony/dependency-injection: ^8.1
• symfony/http-kernel: ^8.1
• symfony/options-resolver: ^8.1
• symfony/stimulus-bundle: ^3
• symfony/ux-twig-component: ^3
• tacman/twig-tree-tag: ^3.0.1
• twig/twig: ^3.4

Requires (Dev)

• api-platform/core: ^3.2||^4.0
• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^13.0
• symfony/browser-kit: ^8.1
• symfony/framework-bundle: ^8.1
• symfony/phpunit-bridge: ^8.1
• symfony/twig-bundle: ^8.1
• symfony/var-dumper: ^8.1

MIT

• Tac Tacelosky

• hierarchical
• symfony-ux

README

Tree UI + API editing for Symfony UX Twig Components.

This bundle provides:

• apiTreeBrowser / api_tree Twig components (jsTree-backed)
• @survos/tree-bundle/api_tree Stimulus controller
• {% tree %} Twig tag for recursive rendering

Install

composer require survos/tree-bundle

Required JS modules (important)

apiTreeBrowser can render embedded Twig blocks in the browser. For this to work reliably, your importmap must include:

• @tacman1123/twig-browser
• @tacman1123/twig-browser/adapters/symfony
• @tacman1123/twig-browser/src/compat/compileTwigBlocks.js
• @survos/js-twig/generated/fos_routes.js (for path() in client-side twig)

If these are missing or incompatible, the controller now fails fast with a clear error instead of silently falling back.

Minimal Example

<twig:apiTreeBrowser
    :resourceClass="topicClass"
    :filter="{ tenantId: tenant.code }"
    :editable="true"
    :openAll="true"
    :caller="_self"
>
    <twig:block name="nodeLabel">
        {{ node.name ?? node.title ?? node.code ?? node.id }}
    </twig:block>

    <twig:block name="api_tree_content">
        {% set item = record ?? node %}
        <h5>{{ item.name ?? item.title ?? item.id }}</h5>
    </twig:block>
</twig:apiTreeBrowser>

Variables available inside client-side Twig blocks

Inside nodeLabel / api_tree_content, these render vars are available:

• node - selected jsTree node payload
• record - full fetched API record for selected node
• item - alias of record ?? node
• hydra - alias of item
• globals - values passed from component :globals="..."

If you pass tenant info via globals, reference globals.tenantId (not tenantId directly).

Example:

{% set params = { tenantId: globals.tenantId, instanceId: item.id } %}
<a href="{{ path('instance_browse', params) }}">Browse</a>

Styling hooks (Tabler/Bootstrap/custom)

Use component class options:

• browserClass
• treePaneClass
• contentPaneClass
• style="plain" to avoid the built-in bootstrap grid wrapper

Wrapper includes api-tree-browser--themeable for easy theming.

Example:

<twig:apiTreeBrowser
    style="plain"
    browserClass="my-tree-layout"
    treePaneClass="my-tree-column"
    contentPaneClass="my-content-column"
    ...
/>

Toolbar buttons

Built-in toolbar includes search and clear.

Optional slideshow button appears when you pass:

:globals="{ slideshowUrl: '/my/slideshow/url' }"

API controller defaults

Bundle config now supports separate controllers:

survos_tree:
  tree_stimulus_controller: '@survos/tree/tree'
  api_tree_stimulus_controller: '@survos/tree/api_tree'

Legacy stimulus_controller is deprecated.

Performance behavior

• Tree list loads from collection endpoint once.
• Full detail GET {id} fetch happens on explicit node selection.
• Label rendering uses already-loaded collection data.

Troubleshooting

• Error: Twig function path is not configured

  • Ensure @survos/js-twig/generated/fos_routes.js is mapped in importmap.
  • Ensure var/js_twig_bundle/generated/fos_routes.js exists (cache warmer).
  • Ensure @tacman1123/twig-browser, @tacman1123/twig-browser/adapters/symfony, and @tacman1123/twig-browser/src/compat/compileTwigBlocks.js are mapped.

• Detail block cannot see tenantId

  • Use globals.tenantId unless you explicitly flatten into top-level context.