Skip to content

Commit

Permalink
Add info where to add values to config (#1292)
Browse files Browse the repository at this point in the history
  • Loading branch information
Isengo1989 authored Feb 14, 2024
1 parent fa7a863 commit 7c38bf4
Showing 1 changed file with 10 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Please make sure to specify the `xsi:noNamespaceSchemaLocation` as shown above a

### Card Titles

A `<card>` `<title>` is translatable, this is managed via the `lang` attribute. By default the `lang` attribute is set to `en-GB`, to change the locale of a `<title>` just add the attribute as follows:
A `<card>` `<title>` is translatable, this is managed via the `lang` attribute. By default, the `lang` attribute is set to `en-GB`, to change the locale of a `<title>` just add the attribute as follows:

```html
...
Expand Down Expand Up @@ -95,7 +95,7 @@ Your `<input-field>` can be of different types, this is managed via the `type` a

### Input field settings

These settings are used to configure your `<input-field>`. **Every `<input-field>` has to start with the `<name>` element.** After the `<name>` element you can configure any of the other settings mentioned above. Beside these settings, they have the followings in common: [label](add-plugin-configuration#label-placeholder-and-help-text), [helpText](add-plugin-configuration#label-placeholder-and-help-text), [defaultValue](add-plugin-configuration#defaultvalue) and [disabled](add-plugin-configuration#disabled).
These settings are used to configure your `<input-field>`. **Every `<input-field>` has to start with the `<name>` element.** After the `<name>` element you can configure any of the other settings mentioned above. Besides these settings, they have the followings in common: [label](add-plugin-configuration#label-placeholder-and-help-text), [helpText](add-plugin-configuration#label-placeholder-and-help-text), [defaultValue](add-plugin-configuration#defaultvalue) and [disabled](add-plugin-configuration#disabled).

#### Label, placeholder and help text

Expand All @@ -105,7 +105,7 @@ The settings `<label>`, `<placeholder>` and `<helpText>` are used to label and e

Add the `defaultValue` setting to your `<input-field>` to define a default value for it. This value will be imported into the database on installing and updating the plugin. We use [Symfony\Component\Config\Util\XmlUtils](https://github.com/symfony/config/blob/master/Util/XmlUtils.php#L215) for casting the values into the correct PHP types.

Below you'll find an example how to use this setting.
Below, you'll find an example of how to use this setting.

```html
<input-field type="text">
Expand All @@ -119,7 +119,7 @@ Below you'll find an example how to use this setting.

You can add the `<disabled>` setting to any of your `<input-field>` elements to disable it.

Below you'll find an example how to use this setting.
Below, you'll find an example of how to use this setting.

```html
<input-field>
Expand All @@ -134,7 +134,7 @@ _Please note, `<disabled>` only takes boolean values._

You can add the `<copyable>` setting to your `<input-field>` which are of type `text` or extensions of it. This will add a button at the right, which on click copies the content of your `<input-field>` into the clipboard.

Below you'll find an example how to use this setting.
Below, you'll find an example of how to use this setting.

```html
<input-field>
Expand Down Expand Up @@ -291,6 +291,10 @@ Now all that's left to do is to present you a working example `config.xml` and s
</config>
```

## Add values to your configuration

After adding your input fields to the `config.xml`, you can add values to your configuration. To do so, navigate from the sidebar to the `Settings` > `System` > `Plugins` and click on your plugin's `...` button. Now you can see the `Config` tab and fill in the values for your input fields.

## Next steps

Now you've added your own plugin configuration. But how do you actually read which configurations the shop owner used? This will be covered in our guide about [Using the plugin configuration](use-plugin-configuration).
Now you've added your own plugin configuration. But how do you actually read which configurations the shop owner used? This will be covered in our guide about [Using the plugin configuration](use-plugin-configuration).

0 comments on commit 7c38bf4

Please sign in to comment.