datagrid-bundle

KO | EN

gitlite — search

#python #llm #go #android #docker #macos #windows #awesome #cli #awesome-list #vue #security #mcp #open-source

datagrid-bundle

(★ 14)

Datagrid bundle for Symfony

datagrid-bundle Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Kibatic Datagrid Bundle
=======================

Datagrid bundle for Symfony with the following design philosophy : less magic for more flexibility.

It's not the usual one line datagrid generator, it's a more verbose one but we think it's worth it.

Features
--------

- Your entities in a table
- Pagination
- Sortable
- Filterable
- Actions (single & batch)
- Customizable templates
- Only supports Doctrine ORM
- Theme support (Bootstrap 5 included)

Quick start
-----------

### Install the bundle

```bash
composer require kibatic/datagrid-bundle
```

Add this to your `assets/controllers.json` :

```json
{
    "controllers": {
        "@kibatic/datagrid-bundle": {
            "checker": {
                "enabled": true,
                "fetch": "eager"
            }
        }
}
```

You'll most likely also need to enable this twig function : https://twig.symfony.com/doc/2.x/functions/template_from_string.html

It's not a hard dependency but some features shown here also requires you to install `kibatic/ux-bundle` :

```bash
composer require kibatic/ux-bundle
```

If you want to use the default templates styles and you don't have bootstrap css loaded yet, you will need to.
If you're using AssetMapper, you can simply add this to your `assets/app.js` :
```javascript
import 'bootstrap/dist/css/bootstrap.min.css';
```

### Basic usage

You can simply generate a specialized datagrid builder class skeleton using the make command :

```
bin/console make:datagrid
```

Or do everything manually, for example in your controller :

```php
<?php

namespace App\Controller;

use App\Entity\Project;
use App\Repository\ProjectRepository;
use Kibatic\DatagridBundle\Grid\GridBuilder;
use Kibatic\DatagridBundle\Grid\Template;
use Kibatic\DatagridBundle\Grid\Theme;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class ProjectController extends AbstractController
{
    #[Route('/', name: 'app_project_index', methods: ['GET'])]
    public function index(
        ProjectRepository $projectRepository,
        GridBuilder $gridBuilder,
    ): Response {
        // get current user
        $user = $this->getUser();
        
        // create query builder filtered by current user
        $queryBuilder = $projectRepository->createQueryBuilder('p')
            ->where('p.owner = :user')
            ->setParameter('user', $user)
            ->orderBy('p.createdAt', 'DESC');
        ;
        $grid = $gridBuilder
            ->initialize(queryBuilder: $queryBuilder)
            ->addColumn('Name', 'name')
            ->addColumn(
                'Created at',
                'createdAt',
                Template::DATETIME,
                sortable: 'createdAt'
            )
            ->getGrid()
        ;

return $this->render('project/index.html.twig', [
            'grid' => $grid
        ]);
    }
}
```

Then with Symfony UX handy twig components :

```twig
{% extends 'base.html.twig' %}

{% block body %}
    <h1>Project list</h1>

<twig:datagrid :grid="grid" />
{% endblock %}
```

Or a more classic twig approach :

```twig
{% extends 'base.html.twig' %}

{% block body %}
    <h1>Project list</h1>

{% include grid.theme ~ '/datagrid.html.twig' %}
{% endblock %}
```

Documentation
-------------

[Fonctionnement du bundle](docs/fonctionnement.md) : vue d'ensemble (lecture rapide) et référence détaillée (colonnes, filtres, thèmes, actions, rendu).

[Architecture interne](docs/internals.md) : guide du contributeur pour intervenir dans le bundle (pipeline de rendu, invariants, checklists d'intervention).

You can find a more advanced example on [how to generate your datagrid](docs/advanced-example.md).

If you want to customize the pagination, use the knp paginator configuration.

```
# config/packages/knp_paginator.yaml
knp_paginator:
    page_limit: 20   
```

If you're using a datagrid inside a live component (symfony ux), [you'll need to do this](docs/advanced-example.md).

Requirements
------------

- Symfony 6
- PHP 8.2
- Doctrine ORM

Roadmap
-------

- Adding a Flex recipe

datagrid-bundle

datagrid-bundle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

datagrid-bundle

datagrid-bundle Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README