Skip to content

[Docs] Action templates #339

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
loic425 wants to merge 1 commit into
base: main
Choose a base branch
from
+41 −6
Open

[Docs] Action templates #339

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 41 additions & 6 deletions docs/grid/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,10 @@ final class SpeakerGrid extends AbstractGrid
->addActionGroup(
MainActionGroup::create(
// Add the "create" action into the "main" action group
CreateAction::create(),
CreateAction::create()
// Optional, you can configure this globally instead.
->setTemplate('path/to/your/action/template.html.twig')
,
),
)
;
Expand Down Expand Up @@ -91,7 +94,10 @@ final class SpeakerGrid extends AbstractGrid
->addActionGroup(
ItemActionGroup::create(
// Add the "update" action into the "item" action group
UpdateAction::create(),
UpdateAction::create()
// Optional, you can configure this globally instead.
->setTemplate('path/to/your/action/template.html.twig')
,
),
)
;
Expand Down Expand Up @@ -128,13 +134,19 @@ final class SpeakerGrid extends AbstractGrid
->addActionGroup(
ItemActionGroup::create(
// Add the "delete" action into the "item" action group
DeleteAction::create(),
DeleteAction::create()
// Optional, you can configure this globally instead.
->setTemplate('path/to/your/action/template.html.twig')
,
),
)
->addActionGroup(
BulkActionGroup::create(
// Add the "delete" action into the "bulk" action group
DeleteAction::create(),
DeleteAction::create()
// Optional, you can configure this globally instead.
->setTemplate('path/to/your/action/template.html.twig')
,
),
)
;
Expand Down Expand Up @@ -170,14 +182,37 @@ final class SpeakerGrid extends AbstractGrid
->addActionGroup(
ItemActionGroup::create(
// Add the "show" action into the "item" action group
ShowAction::create(),
ShowAction::create()
// Optional, you can configure this globally instead.
->setTemplate('path/to/your/action/template.html.twig')
,
),
)
;
}
}
```

## Configuring your action templates globally

```yaml
sylius_grid:
templates:
action:
create: path/to/your/create.html.twig
delete: path/to/your/delete.html.twig
show: path/to/your/show.html.twig
update: path/to/your/update.html.twig
bulk_action:
delete: path/to/your/delete.html.twig
```

{% hint style="info" %}
The BootstrapAdminUi package will configure that for you automatically.

[BootstrapAdminUi configuration files](https://github.com/Sylius/Stack/blob/main/src/BootstrapAdminUi/config/app/grid/templates.php)
{% endhint %}

## Creating a custom Action

There are certain cases when built-in action types are not enough.
Expand Down Expand Up @@ -385,7 +420,7 @@ ids. Now, you can configure the grid action:
sylius_grid:
grids:
app_admin_product:
...
# ...
actions:
bulk:
export:
Expand Down