add-grid

Add an admin Grid for a Sylius Resource

Ask the user for the ModelName if not provided. Read src/**/Entity/{ModelName}/{ModelName}.php to detect the entity's fields and relations.

Prerequisite: the model must already exist as a Sylius Resource (run /sylius-app:add-model first). To customize an existing Sylius core grid (e.g. sylius_admin_product), use /sylius-app:extends-grid instead.

1. Setup (one-time per project)

One grid file per resource at a unified path: config/packages/grids/{model_snake}.yaml.

Add (or extend) an imports: block at the top of config/packages/_sylius.yaml (shipped by Sylius-Standard, user-editable) so the split files are loaded:

imports:
    - { resource: "grids/*.yaml" }
    # and "twig_hooks/**/*.yaml" if twig hooks are used by this project

sylius_addressing:
    # ... existing content untouched

2. Ask the user

Based on the entity, ask:

• Which properties to display as columns
• Which filters to include
• Whether to include a show action (requires a show route — run /sylius-app:add-routes with a show operation if missing)

3. Grid skeleton

Grid name convention: app_admin_{model_snake}.

sylius_grid:
    grids:
        app_admin_{model_snake}:
            driver:
                name: doctrine/orm
                options:
                    class: "%app.model.{model_snake}.class%"
            sorting:
                # Must reference a field declared under `fields:` (the sort key is resolved against field names, not entity columns).
                # If you want to sort by id but not display it, declare the `id` field and set `enabled: false`.
            limits: [10, 25, 50]
            fields:
                # see §4
            filters:
                # see §5
            actions:
                # see §6

Translatable resource? Extend driver.options so the grid query joins translations under alias translation (the custom repository from /sylius-app:add-translatable-model is consumed only when you ask for it explicitly — same pattern as sylius_admin_product_option):