doc : Document new attributes, AsGrid and AsFilter #267
Conversation
vasilvestre
force-pushed
the
doc/as-grid
branch
3 times, most recently
from
4d1a866 to
22e9c0d
Compare
|
|
||
| Now we can configure our first grid: | ||
|
|
||
| {% tabs %} |
There was a problem hiding this comment.
Are we sure it's not too early to entirely remove these two tabs ? Couldn't we just mark them as "YAML (Legacy)" and "PHP (Legacy)" ?
There was a problem hiding this comment.
As discussed with @loic425 , "your first grid" is king of a "get started" and should promote best practice
There was a problem hiding this comment.
Cannot we just put php service grid in the first place? Yaml/Php configs aren't event officially deprecated yet
There was a problem hiding this comment.
yeah, good idea, just put in on the first position.
|
Just a general note on how the page is structured: since we’re showing both the attribute-based and the legacy (configuration-based) approaches, I think it would be helpful to add a sentence at the very top of the page or just below each section title to make it clear that this is an either/or situation. Attributes`To create your custom filter, you can leverage Sylius’s #[AsFilter] attribute which provides a convenient, native way to configure filters directly in your code. Legacy wayThe legacy service-based approach is still documented below in case you're maintaining an older setup. |
|
Kindly ask for your insights @diimpp 🙏🏻 |
|
|
||
| Now we can configure our first grid: | ||
|
|
||
| {% tabs %} |
There was a problem hiding this comment.
Cannot we just put php service grid in the first place? Yaml/Php configs aren't event officially deprecated yet
|
|
||
| {% code title="templates/Grid/Filter/suppliers_statistics.html.twig" lineNumbers="true" %} | ||
| ```twig | ||
| {% form_theme form '@SyliusUi/Form/theme.html.twig' %} |
There was a problem hiding this comment.
That's a sylius v1 code, stack has it's own bootstrap form theme.
This one I think
https://github.com/Sylius/Stack/blob/main/src/BootstrapAdminUi/templates/shared/form_theme.html.twig
There was a problem hiding this comment.
wdyt @loic425 ?
There was a problem hiding this comment.
yes, this code is outdated. @diimpp is right.
| public function buildForm(FormBuilderInterface $builder, array $options): void | ||
| { | ||
| $builder->add( | ||
| 'stats', |
There was a problem hiding this comment.
I understand stats existed in the examples before, but it's hard to read. Does it mean days, count, limit? A thought for future to improve it somehow.
Adds a new tab to the documentation showcasing how to define a grid using attributes. doc: adds a custom filter for Sylius Grid Adds a new custom filter for Sylius Grid, demonstrating how to create a filter class and its associated form type. Co-authored-by: Estelle Gaits <[email protected]> Co-authored-by: Dmitri Perunov <[email protected]> Update
| use Sylius\Bundle\GridBundle\Grid\AbstractGrid; | ||
| use Sylius\Bundle\GridBundle\Grid\ResourceAwareGridInterface; | ||
|
|
||
| #[AsGrid('app_tournament', Tournament::class)] |
loic425
changed the title
|
I'm rewriting this doc PR in Gitbook, I will split it into at least 2 separate PRs for clarity. |
stlgaits
added
documentation
|
PArt 2 of GitBook rewrite has been merged too : https://app.gitbook.com/o/fmYDcx6GlpT1jw8tUL38/s/RNAi9oQYTWFv4Vn5yZFm/~/preview/~/changes/27/grid/index/your_first_grid |
4 participants
No description provided.