You are browsing the latest version of the documentation which is not released yet. See the current stable version instead.

Grid Rendering Customization

Default Twig template for rendering of each grid can be found in src/Resources/views/Admin/Grid/Grid.html.twig. The template is composed of a set of Twig blocks and you are able to override any of them when there is a need for customization of the default appearance.

To customize your grid, you just need to create a new template extending the original one, override appropriate blocks and then set the template as a theme of your grid using Grid::setTheme method.

Blocks that are being overridden at most

  • grid_title_cell_id_<column_id>
    • <column_id> stands for the ID of the column that is defined during the grid creation by the first argument of Grid::addColumn method
    • handy when you need to override a column title in a grid defined in the framework without overriding the grid factory
  • grid_value_cell_id_<column_id>
    • <column_id> stands for the ID of the column that is defined during the grid creation by the first argument of Grid::addColumn method
    • used when you need to change the appearance of values in a particular column
    • the original value is available as value variable
  • grid_no_data
    • the block contains a message that is displayed when there are no data in the grid
    • the default (translatable) value is "No records found"

Rendering type Money in administration

When creating grid containing prices in administration you can provide ID of the domain as domainId in the datasource. Money will format to given domain default currency and in case domainId is not available it will fallback to default administration currency.

Example

Let's say we have a grid of salesmen (in fact, such a grid is created in "Create basic grid" cookbook) and we want to display all their names bold, and also, we want to be more specific when there are no salesmen in our database.

  1. Create a new template that extends to original one and override the blocks you need:

    {# templates/Admin/Content/Salesman/listGrid.html.twig #}
    {% extends '@ShopsysFramework/Admin/Grid/Grid.html.twig' %}
    
    {% block grid_no_data %}
        {{ 'There are no salesmen in your database.' }}
    {% endblock %}
    
    {% block grid_value_cell_id_name %}
        <strong>{{ value }}</strong>
    {% endblock %}
    
  2. Set the new theme for your grid:

    $grid->setTheme('Admin/Content/Salesman/listGrid.html.twig');