Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Adding the widget available options #5989

Merged
merged 2 commits into from
Nov 13, 2019
Merged

Adding the widget available options #5989

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e27ca2a
Adding the widget available options
eduard13 Nov 13, 2019
7e4b4c4
Merge branch 'master' into widget-options
dobooth Nov 13, 2019
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
14 changes: 13 additions & 1 deletion guides/v2.2/ext-best-practices/tutorials/custom-widget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ Here are the widgets that are available by default:
- Recently Compared Products
- Recently Viewed Products

## Configuration options

| Option | Description | Type | Required |
| -------- | --------------------- | --------------------- | ---- |
| `label` | The name of the widget | String | `Yes` |
| `description` | Contains a concise explanation of the widget's purpose | String | `Yes` |
| `parameters` | A list of widget's options | Object | `No` |
| `containers` | A list of layout containers, where the widget may be injected | Object | `No` |

This tutorial shows you how to create and insert your own widget on the frontend.

## Step 1. Declaring the widget
Expand All @@ -33,6 +42,9 @@ This tutorial shows you how to create and insert your own widget on the frontend
<parameters>
...
</parameters>
<containers>
...
</containers>
</widget>
</widgets>
```
Expand Down Expand Up @@ -127,7 +139,7 @@ And finally, create the template that will be used for showing the widget's data

```php
<?php
/** \Learning\GreetingMessage\Block\Widget\Tests $block */
/** \OrangeCompany\Learning\Block\Widget\Test $block */
?>
<h3><?= $block->escapeHtml($block->getData('label')) ?></h3>
<h3><?= $block->escapeHtml(__('Size:')) ?> <?= $block->escapeHtml($block->getData('size')) ?></h3>
Expand Down