Skip to content

Commit f7173a6

Browse files
committed
Update Admin Notification ReadMe
1 parent e67ce21 commit f7173a6

File tree

1 file changed

+28
-3
lines changed

1 file changed

+28
-3
lines changed
Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
1-
# Admin Notification
1+
# Magento_AdminNotification module
22

3-
**Admin Notification** provides the ability to alert administrators via
4-
system messages and provides a message inbox for surveys and notifications.
3+
The Magento_AdminNotification module provides the ability to alert administrators via system messages and provides a message inbox for surveys and notifications.
4+
5+
## Installation details
6+
7+
Before disable or uninstall this module, please note that Magento_Indexer module depends on this module.
8+
9+
For information about a module installation in Magento 2, see [Enable or disable modules](http://devdocs.magento.com/guides/v2.3/install-gde/install/cli/install-cli-subcommands-enable.html).
10+
11+
### Events
12+
13+
This module observes the following events:
14+
15+
- `controller_action_predispatch` event in `Magento\AdminNotification\Observer\PredispatchAdminActionControllerObserver`
16+
17+
### Layouts
18+
19+
This module introduces the following layouts handle in the `view/adminhtml/layout` directory:
20+
21+
- `adminhtml_notification_index`
22+
23+
For more information about a layout in Magento 2, see the [Layout documentation](http://devdocs.magento.com/guides/v2.3/frontend-dev-guide/layouts/layout-overview.html).
24+
25+
### UI components
26+
27+
You can extend admin notifications using the configuration file in `view/adminhtml/ui_component/notification_area.xml`
28+
29+
For information about a UI component in Magento 2, see [Overview of UI components](http://devdocs.magento.com/guides/v2.3/ui_comp_guide/bk-ui_comps.html).

0 commit comments

Comments
 (0)