Skip to content

Add entity single select for mail templates sample showing label-property usage #2233

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

Merged
Micha Hobert (Isengo1989) merged 7 commits into from
Apr 28, 2026
Merged

Add entity single select for mail templates sample showing label-property usage #2233

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fe98bc8
Add entity single select for mail templates sample showing label-prop…
Timothylul Apr 10, 2026
3221015
Update add-plugin-configuration.md with mail template info
Timothylul Apr 10, 2026
1f966fd
Update documentation to reflect product selection change
Timothylul Apr 10, 2026
fa3ce17
Update guides/plugins/plugins/plugin-fundamentals/add-plugin-configur…
Isengo1989 Apr 10, 2026
48c84bb
add/info-about-label-usage
Isengo1989 Apr 28, 2026
49cc175
edit/xml-view
Isengo1989 Apr 28, 2026
bf3cdf2
fix/md
Isengo1989 Apr 28, 2026
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
63 changes: 42 additions & 21 deletions guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
├── src
│ ├── Resources
│ │ └── config
│ │ └── config.xml
│ │ └── config.xml
│ └── SwagBasicExample.php
└── composer.json
```
Expand All @@ -48,8 +48,9 @@
Every `config.xml` must contain a minimum of one `<card>` element and each `<card>` must contain one `<title>` and at least one `<input-field>`.
See the minimum `config.xml` below:

```xml
<!--<plugin root>/src/Resources/config/config.xml-->
::: code-group

Check warning on line 51 in guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md

View workflow job for this annotation

GitHub Actions / Runner 

[LanguageTool] reported by reviewdog 🐶
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: `XML`
URL: https://languagetool.org/insights/post/spelling-capital-letters/ 
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING

Raw Output:
guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md:51:11: File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
 Suggestions: `XML`
 URL: https://languagetool.org/insights/post/spelling-capital-letters/ 
 Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
 Category: CASING

```xml [PLUGIN_ROOT/src/Resources/config/config.xml]
<?xml version="1.0" encoding="UTF-8"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/shopware/shopware/trunk/src/Core/System/SystemConfig/Schema/config.xsd">
Expand All @@ -62,6 +63,8 @@
</config>
```

:::

Please make sure to specify the `xsi:noNamespaceSchemaLocation` as shown above and fetch the external resource into your IDE if possible.
This enables auto-completion and suggestions for this XML file and will therefore help you to prevent issues and bugs.

Expand Down Expand Up @@ -92,23 +95,23 @@
Unless defined otherwise, your `<input-field>` will be a text field.
Below you'll find a list of all available `<input-field type="?">`.

| Type | Configuration settings | Renders | Default value example |
|:--------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:----------------------------------------|
| Type | Configuration settings | Renders | Default value example |
|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------|:----------------------------------------|
| text | [copyable](add-plugin-configuration.md#copyable), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text), [length](add-plugin-configuration.md#text-length-restrictions) | Text field | Some text |
| textarea | [copyable](add-plugin-configuration.md#copyable), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | Text area | Some more text |
| text-editor | [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | HTML editor | Some text with HTML `<div>`tags`</div>` |
| url | [copyable](add-plugin-configuration.md#copyable), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text), [length](add-plugin-configuration.md#text-length-restrictions) | URL field | <https://example.com> |
| password | [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text), [length](add-plugin-configuration.md#text-length-restrictions) | Password field | ******** |
| int | [length](add-plugin-configuration.md#number-length-restrictions) | Number field | 42 |
| float | [length](add-plugin-configuration.md#number-length-restrictions) | Number field | 42.42 |
| bool | | Switch | `true` or `false` |
| checkbox | | Checkbox | `true` or `false` |
| datetime | | Date-time picker | 2024-04-04T12:00:00.000Z |
| date | | Date picker | 2024-04-05T00:00:00 |
| time | | Time picker | 11:00:00 |
| colorpicker | | Color picker | #189EFF |
| single-select | [options](add-plugin-configuration.md#options), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | Single-Select box | option_id |
| multi-select | [options](add-plugin-configuration.md#options), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | Multi-Select box | [option_id1, option_id2] |
| textarea | [copyable](add-plugin-configuration.md#copyable), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | Text area | Some more text |
| text-editor | [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | HTML editor | Some text with HTML `<div>`tags`</div>` |
| url | [copyable](add-plugin-configuration.md#copyable), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text), [length](add-plugin-configuration.md#text-length-restrictions) | URL field | <https://example.com> |
| password | [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text), [length](add-plugin-configuration.md#text-length-restrictions) | Password field | ******** |
| int | [length](add-plugin-configuration.md#number-length-restrictions) | Number field | 42 |
| float | [length](add-plugin-configuration.md#number-length-restrictions) | Number field | 42.42 |
| bool | | Switch | `true` or `false` |
| checkbox | | Checkbox | `true` or `false` |
| datetime | | Date-time picker | 2024-04-04T12:00:00.000Z |
| date | | Date picker | 2024-04-05T00:00:00 |
| time | | Time picker | 11:00:00 |
| colorpicker | | Color picker | #189EFF |
| single-select | [options](add-plugin-configuration.md#options), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | Single-Select box | option_id |
| multi-select | [options](add-plugin-configuration.md#options), [placeholder](add-plugin-configuration.md#label-placeholder-and-help-text) | Multi-Select box | [option_id1, option_id2] |

### Input field settings

Expand Down Expand Up @@ -317,6 +320,21 @@
This component does not store values in the system config, but changes the translations for the snippet key.
**Note: This field is only available from 6.3.4.0 onward.**

### Entity selects without a name field

Some entities do not have a `name` field, which is used per default in the select components. For example, the `mail_template` entity does not have a name field, but you can still use `description` as a `label-property` to select mail templates in your plugin configuration. Without it, the select field would be empty and not usable. You can check available properties for an entity in the `EntityDefinition` of the entity (in this case `Shopware\Core\Content\MailTemplate\MailTemplateDefinition`).

Check warning on line 325 in guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md

View workflow job for this annotation

GitHub Actions / Runner 

[LanguageTool] reported by reviewdog 🐶
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: `HTML`
URL: https://languagetool.org/insights/post/spelling-capital-letters/ 
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING

Raw Output:
guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md:325:444: File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
 Suggestions: `HTML`
 URL: https://languagetool.org/insights/post/spelling-capital-letters/ 
 Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
 Category: CASING

```html
<component name="sw-entity-single-select">
<name>exampleMailTemplate</name>
<entity>mail_template</entity>
<label-property>description</label-property>
<label>Choose a mail template for the plugin configuration</label>
</component>
```

Stores the ID of the selected mail template into the system config.

### Supported component types

Please Note: It is impossible to allow every component in the `config.xml`, due to their complexities.
Expand All @@ -336,8 +354,9 @@
<details>
<summary>Full example <code>config.xml</code></summary>

```xml
<!--<plugin root>/src/Resources/config/config.xml-->
::: code-group

Check warning on line 357 in guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md

View workflow job for this annotation

GitHub Actions / Runner 

[LanguageTool] reported by reviewdog 🐶
File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
Suggestions: `XML`
URL: https://languagetool.org/insights/post/spelling-capital-letters/ 
Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
Category: CASING

Raw Output:
guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md:357:11: File types are normally capitalized. (FILE_EXTENSIONS_CASE[1])
 Suggestions: `XML`
 URL: https://languagetool.org/insights/post/spelling-capital-letters/ 
 Rule: https://community.languagetool.org/rule/show/FILE_EXTENSIONS_CASE?lang=en-US&subId=1
 Category: CASING

```xml [PLUGIN_ROOT/src/Resources/config/config.xml]
<?xml version="1.0" encoding="UTF-8"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/shopware/shopware/trunk/src/Core/System/SystemConfig/Schema/config.xsd">
Expand Down Expand Up @@ -392,6 +411,8 @@
</config>
```

:::

</details>

## Add values to your configuration
Expand Down
Loading