jmf/grid-bundle

Grid bundle for Symfony

8.0.0 2026-06-13 02:43 UTC

Requires

• php: >=8.3
• jmf/rendering-preset-bundle: ^2.0
• jmf/template-rendering: ^2.0
• symfony/config: ^7.0|^8.0
• symfony/finder: ^7.0|^8.0
• symfony/framework-bundle: ^7.0|^8.0
• symfony/property-access: ^7.0|^8.0
• symfony/yaml: ^7.0|^8.0
• webmozart/assert: ^1.0|^2.0

Requires (Dev)

• overtrue/phplint: ^9
• phpstan/phpstan: ^2
• phpstan/phpstan-strict-rules: ^2
• phpunit/phpunit: ^12|^13
• rector/rector: ^2
• squizlabs/php_codesniffer: ^4

mit

README

A Symfony bundle for rendering HTML table grids from declarative YAML configuration and runtime data.

Requirements

• PHP >= 8.3
• Symfony 7 or 8

Installation

composer require jmf/grid-bundle

Register the bundle in config/bundles.php:

return [
    // ...
    Jmf\Grid\JmfGridBundle::class => ['all' => true],
];

Configuration

Create config/packages/jmf_grid.yaml:

jmf_grid:
    # template_path: '@JmfGrid/grid.html.twig'   # default
    # twig_functions_prefix: ''                  # default (e.g. set to 'jmf_' → jmf_grid())

    grids:
        articles:
            grid:
                variables:
                    entityType: 'article'
            rows:
                link: '{{ path("article.read", {"id": _item.id}) }}'
                variables:
                    entityId: '{{ _item.id }}'
            columns:
                -
                    label:  'Title'
                    source: 'title'
                -
                    preset: 'date'
                    source: 'publishedAt'
                -
                    preset: 'button_show'

Grid options

Key	Description
grid.variables	Key-value pairs available in all column/footer templates
grid.arguments	Required runtime arguments (passed when calling grid())
rows.link	Twig template for the row link URL. _item refers to the current data item
rows.variables	Key-value Twig templates evaluated per row. _item is available
columns	List of column definitions (see below)
footer	List of footer cell definitions

Column options

Key	Description
source	Property path on the data item (uses Symfony PropertyAccess)
label	Column header label
align	Cell alignment (left, center, right, start, end)
template	Twig template for cell content. _value holds the extracted value
preset	Preset ID from jmf/rendering-preset-bundle (provides defaults for the above)

Column-level settings override preset values when both are defined.

Usage

In a Twig template:

{{ grid('articles', articles) }}

{# With runtime arguments: #}
{{ grid('articles', articles, {someArgument: 'value'}) }}

{# With extra template parameters: #}
{{ grid('articles', articles, {}, {class: 'table-striped'}) }}

The grid() function signature:

grid(gridId, items, arguments = [], parameters = [])

• gridId — key from your jmf_grid.grids config
• items — array of objects or associative arrays
• arguments — runtime values for argument-gated grids
• parameters — extra variables passed to the grid template

Presets

Columns and footer cells support a preset key that references a named preset from jmf/rendering-preset-bundle. Presets define reusable defaults for align, label, source, and template.

Example preset configuration (config/packages/jmf_preset_rendering.yaml):

jmf_preset_rendering:
    properties:
        align:
            choices: [center, left, right, start, end]
            default: left
            required: false
        label:
            required: false

    presets:
        date:
            align:    'center'
            template: '{% if (_value is not null) %}{{ _value.format("Y-m-d") }}{% endif %}'

        button_show:
            align:    'end'
            template: '<a href="{{ path(entityType ~ ".show", {"id": entityId}) }}">Show</a>'

        button_edit:
            align:    'end'
            template: '<a href="{{ path(entityType ~ ".edit", {"id": entityId}) }}">Edit</a>'

License

MIT