Skip to content

Clarify documentation on sets #50

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
LukeTowers merged 1 commit into from
Jan 28, 2022
Merged

Clarify documentation on sets #50

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
20 changes: 16 additions & 4 deletions plugin-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,9 @@ To access the property from the Twig partials for the component, utilize the `__
<a name="dropdown-properties"></a>
### Dropdown and Set properties

The option list for dropdown and set properties can be static or dynamic. Static options are defined with the `options` element of the property definition. Example:
A `dropdown` allows you to select a single value from a series of options. A `set` allows you to select multiple values from a series of options.

The option list for `dropdown` and `set` properties can be static or dynamic. Static options are defined with the `options` property for dropdowns and the `items` property for sets. Example:

```php
public function defineProperties()
Expand All @@ -181,12 +183,22 @@ public function defineProperties()
'default' => 'imperial',
'placeholder' => 'Select units',
'options' => ['metric'=>'Metric', 'imperial'=>'Imperial']
]
],
'favoriteFruits' => [
'title' => 'Favorite fruits',
'type' => 'set',
'items' => [
'apples' => 'Apples',
'bananas' => 'Bananas',
'cantaloupes' => 'Cantaloupes',
],
'default' => ['bananas', 'cantaloupes'],
],
];
}
```

The list of options could be fetched dynamically from the server when the Inspector is displayed. If the `options` parameter is omitted in a dropdown or set property definition the option list is considered dynamic. The component class must define a method returning the option list. The method should have a name in the following format: `get*Property*Options`, where **Property** is the property name, for example: `getCountryOptions`. The method returns an array of options with the option values as keys and option labels as values. Example of a dynamic dropdown list definition:
The list of options or items could be fetched dynamically from the server when the Inspector is displayed. If the `options` parameter is omitted for dropdowns or the `items` parameter is omitted for sets, the list is considered dynamic. The component class must define a method returning this list. The method should have a name in the following format: `get*Property*Options`, where **Property** is the property name, for example: `getCountryOptions`. The method returns an array of options with the option values as keys and option labels as values. Example of a dynamic dropdown list definition:

```php
public function defineProperties()
Expand All @@ -206,7 +218,7 @@ public function getCountryOptions()
}
```

Dynamic dropdown and set lists can depend on other properties. For example, the state list could depend on the selected country. The dependencies are declared with the `depends` parameter in the property definition. The next example defines two dynamic dropdown properties and the state list depends on the country:
Dynamic `dropdown` and `set` lists can depend on other properties. For example, the state list could depend on the selected country. The dependencies are declared with the `depends` parameter in the property definition. The next example defines two dynamic dropdown properties and the state list depends on the country:

```php
public function defineProperties()
Expand Down