Skip to content

Twig Component follow ups #2792

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
wants to merge 2 commits into
base: 4.6
Choose a base branch
from
Open

Twig Component follow ups #2792

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a91c974
Added Priority for YAML configuration
mnocon Jun 17, 2025
b3f176a
Added doc for storefront groups
mnocon Jul 3, 2025
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
2 changes: 2 additions & 0 deletions code_samples/back_office/components/twig_components.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,12 @@ ibexa_twig_components:
admin-ui-user-menu:
custom-html-component:
type: html
priority: 0
arguments:
content: '<b>Hello world!</b>'
custom-template-component:
type: template
priority: 50
arguments:
template: '@ibexadesign/ui/component/user_thumbnail/user_thumbnail.html.twig'
parameters:
Expand Down
10 changes: 7 additions & 3 deletions docs/templating/components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,12 @@ month_change: true
Twig Components are widgets (for example, **My dashboard** blocks from Headless edition) and HTML code (for example, a tag for loading JS or CSS files) that you can inject into the existing templates to customize and extend the user interface.
They are combined into groups that are rendered in designated templates.

Built-in Twig Component groups are available for the [back office](custom_components.md), but you can create your own for use anywhere.
Twig Component groups are available for:

To learn which groups are available in a given view, use the [integration with Symfony Profiler](#symfony-profiler-integration).
- [back office](custom_components.md)
- [storefront](customize_storefront_layout.md)

To learn which groups are available in a given view, use the [integration Symfony Profiler](#symfony-profiler-integration).

## Create Twig Component

Expand Down Expand Up @@ -44,11 +47,12 @@ ibexa_twig_components:
# Component name
google_tag_manager:
type: script
priority: 50
arguments:
src: 'https://...'
```

The Component priority cannot be specified when using the YAML configuration, but it allows you to use the built-in components to quickly achieve common goals.
YAML configuration allows you to use the built-in components to quickly achieve common goals.

You can use an unique group name when creating a Twig Component to create your own group.

Expand Down
18 changes: 18 additions & 0 deletions docs/templating/layout/customize_storefront_layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,24 @@ To customize your shop, you can override either whole templates, or specific com
The built-in templates belong to the `storefront` [theme](design_engine.md).
To override any of them, copy its directory structure in your template directory.

## Customize with Twig Components

You can customize parts of the storefront by using [Twig components](components.md).
This allows you to inject your own widgets, extending the storefront behavior.

The available groups for the storefront are:

| Group name | Template file |
|---|---|
| `storefront-before-maincart` | `vendor/ibexa/storefront/src/bundle/Resources/views/themes/storefront/cart/component/maincart/maincart.html.twig` |
| `storefront-after-maincart` | `vendor/ibexa/storefront/src/bundle/Resources/views/themes/storefront/cart/component/maincart/maincart.html.twig` |
| `storefront-before-minicart` | `vendor/ibexa/storefront/src/bundle/Resources/views/themes/storefront/cart/component/minicart/minicart.html.twig` |
| `storefront-after-minicart` | `vendor/ibexa/storefront/src/bundle/Resources/views/themes/storefront/cart/component/minicart/minicart.html.twig` |
| `storefront-before-add-to-cart` | `vendor/ibexa/cart/src/bundle/Resources/views/themes/standard/cart/component/add_to_cart/add_to_cart.html.twig` |
| `storefront-after-add-to-cart` | `vendor/ibexa/cart/src/bundle/Resources/views/themes/standard/cart/component/add_to_cart/add_to_cart.html.twig` |
| `storefront-before-summary` | `vendor/ibexa/cart/src/bundle/Resources/views/themes/standard/cart/component/summary/summary.html.twig` |
| `storefront-after-summary` | `vendor/ibexa/cart/src/bundle/Resources/views/themes/standard/cart/component/summary/summary.html.twig` |

## Template customization example

As an example, to change the cart display when it contains no products, you need to override `vendor/ibexa/storefront/src/bundle/Resources/views/themes/storefront/cart/component/maincart/maincart_empty_cart.html.twig` template.
Expand Down
Loading