Skip to content

Commit 8584f85

Browse files
author
CJ
committed
Updated widget readme file
1 parent 38d712e commit 8584f85

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

app/code/Magento/Widget/README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,41 @@
1-
The Widget module allows Magento application to be extended with custom widget blocks.
1+
# Magento_Widget module
2+
3+
The **Magento_Widget** module allows Magento application to be extended with custom widget blocks.
4+
5+
## Installation details
6+
7+
Before installing this module, note that the **Magento_Widget** is dependent on the following modules:
8+
9+
- Magento_Catalog
10+
- Magento_Cms
11+
- Magento_Store
12+
13+
Before disabling or uninstalling this module, please consider the following dependencies:
14+
15+
- Magento_CatalogWidget
16+
- Magento_CurrencySymbol
17+
- Magento_Newsletter
18+
19+
Please find here [how to enable or disable modules in Magento 2](https://devdocs.magento.com/guides/v2.4/install-gde/install/cli/install-cli-subcommands-enable.html).
20+
21+
## Extensibility
22+
23+
Extension developers can interact with the **Magento_Widget** module. For more information about the Magento extension mechanism, see [Magento plug-ins](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).
24+
25+
[The Magento dependency injection mechanism](http://devdocs.magento.com/guides/v2.4/extension-dev-guide/depend-inj.html) enables you to override the functionality of the **Magento_Widget** module.
26+
27+
### Layouts
28+
29+
This module introduces the following layouts and layout handles in the directories:
30+
31+
- `view/adminhtml/layout`:
32+
- `adminhtml_widget_index`
33+
- `adminhtml_widget_instance_block`
34+
- `adminhtml_widget_instance_edit`
35+
- `adminhtml_widget_instance_index`
36+
- `adminhtml_widget_loadoptions`
37+
- `view/frantend/layout`:
38+
- `default`
39+
- `print`
40+
41+
For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.4/frontend-dev-guide/layouts/layout-overview.html).

0 commit comments

Comments
 (0)