-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,53 @@ | ||
| # Better Layout Hints | ||
| Simple Magento 2 module to show better layout hints. | ||
| Magento 2 module to show better layout hints. | ||
|
|
||
| ## Why? | ||
| The default layout hints in M2 are horrible! They don't give enough information | ||
| about the block. There is no information about the containers or the | ||
| ui elements that are rendered. | ||
| The default layout hints in Magento 2 lack much of the needed information. | ||
| Because knowledge is key and information is primordial. | ||
|
|
||
| This is built to show more information about what is on the page and how it's rendered. | ||
| The goal is to provide all the additional information about the layout of the current page. | ||
|
|
||
| ## Screenshot | ||
|  | ||
| This module provides information about each Container, Block and uiElement on the page. It does this in a | ||
| non-intrusive manner. | ||
|
|
||
| ## Features | ||
|
|
||
| - [x] Admin panel control | ||
| - [x] Console command line control | ||
| - [x] Front-end hide/show function with `Shift + Ctrl + H` | ||
| - [x] Non-intrusive display | ||
| - [x] Additional layout information at the bottom of the page. | ||
|
|
||
| ## How to use it? | ||
|
|
||
| ### Frontend | ||
|
|
||
| You can use the `Shift + Ctrl + H` key combination on the frontend to toggle the display of the layout hints. | ||
|
|
||
| ### Enable/Disable | ||
| You can enable the hints from the console or the admin panel. | ||
|
|
||
| ### Console commands: | ||
| **Console:** | ||
| ``` | ||
| justinkase:hints:on | ||
| justinkase:hints:off | ||
| ``` | ||
| So to enable the hints simply run `magento justinkase:hints:on` and you | ||
| should probably run a `magento cache:flush` command if your caches are enabled. | ||
| *Note: Clear caches after!* `magento cache:flush` | ||
|
|
||
|  | ||
|
|
||
| ### Admin panel | ||
| Update the setting from the admin panel. | ||
| **Admin panel:** | ||
|
|
||
| `Stores > Configuration > JustinKase > Layout Hints` | ||
|
|
||
|  | ||
|
|
||
| ## Screens | ||
| Bottom additional information | ||
|  | ||
|
|
||
| Non-intrusive display | ||
|  | ||
|
|
||
| ## Author | ||
| [Alex Ghiban](mailto:drew7721@gmail.com) | ||
|
|