Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekyna/uibundle
https://github.com/ekyna/uibundle
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ekyna/uibundle
- Owner: ekyna
- License: mit
- Created: 2021-12-22T10:47:40.000Z (almost 3 years ago)
- Default Branch: 0.8
- Last Pushed: 2024-10-17T14:00:02.000Z (about 1 month ago)
- Last Synced: 2024-10-19T19:46:12.783Z (28 days ago)
- Language: JavaScript
- Size: 3.05 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TableBundle
===========
Table component integration.
## Installation
Install this package through composer:
```
composer require ekyna/table-bundle:0.7.x-dev
```
Register the bundle in your AppKernel:
```php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// other bundles ...
new Ekyna\Bundle\TableBundle\EkynaTableBundle(),
);
return $bundles;
}
```
## Example
Given there is a __Brand__ doctrine entity configured in the AcmeDemoBundle with a title field.
Create the table type:
```php
// src/Acme/DemoBundle/Table/Type/BrandType.php
namespace Acme\DemoBundle\Table\Type;
use Acme\DemoBundle\Entity\Brand;
use Ekyna\Component\Table\AbstractTableType;
use Ekyna\Component\Table\Extension\Core\Type\Column;
use Ekyna\Component\Table\Extension\Core\Type\Filter;
use Ekyna\Component\Table\TableBuilderInterface;
use Ekyna\Component\Table\Bridge\Doctrine\ORM\Source\EntitySource;
use Symfony\Component\OptionsResolver\OptionsResolver;
class BrandType extends AbstractTableType
{
public function buildTable(TableBuilderInterface $tableBuilder)
{
$tableBuilder
->addColumn('id', Column\NumberType::class)
->addColumn('title', Column\TextType::class, [
'label' => 'Title',
])
->addFilter('id', Filter\NumberType::class)
->addFilter('title', Filter\TitleType::class, [
'label' => 'Titre'
])
;
}
public function configureOptions(OptionsResolver $resolver)
{
$resolver->setDefaults(array(
'source' => new EntitySource(Brand::class)
));
}
}
```
(optional) Register the table type as a service:
```xml
```
Usage in a controller:
```php
// src/Acme/DemoBundle/Controller/BrandController.php
namespace Acme\Demo\Controller;
use Acme\DemoBundle\Table\Type\BrandType;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
class ResourceController extends Controller
{
public function indexAction(Request $request)
{
$table = $this
->get('table.factory')
->createTable('brands', BrandType::class);
if (null !== $response = $table->handleRequest($request)) {
return $response;
}
return $this->render('@AcmeDemo/Brand/index.html.twig', array(
'brands' => $table->createView(),
));
}
}
```
Usage in a twig template:
```twig
# src/Acme/DemoBundle/Resources/views/Brand/index.html.twig
{% block stylesheets %}
{% endblock stylesheets %}
{{ ekyna_table_render(brands) }}
{% block javascripts %}
{% endjavascripts %}
```
## Customization
The default template used to render the table is `vendor/ekyna/table-bundle/Ekyna/Bundle/TableBundle/Resources/views/table.html.twig`.
It requires jQuery and Bootstrap 3.
You can create your own rendering template (where you will define all blocks of the default template) and use it this way
```twig
{{ ekyna_table_render(brands, {'template': '@AcmeDemo/Table/render.html.twig'}) }}
```
## What's next ?
- Templating engine with type/template hierarchy.
- Better export implementation.
- Tests.
- Demo repository.
- More doc.
- More sources.
- AJAX support.