This repository was archived by the owner on Nov 19, 2024. It is now read-only.
#8106 Clarify JS init component key #8609
Merged
Conversation
This file contains hidden or 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
Adding more information about component key in the Declarative notation section.
BarnyShergold
suggested changes
Feb 2, 2021
| <nav data-mage-init='{"tooltip": {"content": "<?= /* @noEscape */ $content ?>"}}'></nav> | ||
| ``` | ||
|
|
||
| Or a custom JS component, can be component path `Vendor_Module/js/component` or alias declareted in `requirejs-config.js`. |
There was a problem hiding this comment.
Suggested change
| Or a custom JS component, can be component path `Vendor_Module/js/component` or alias declareted in `requirejs-config.js`. | |
| Or a custom JS component, can be component path `Vendor_Module/js/component` or alias declared in `requirejs-config.js`. |
m2-community-project
bot
added
Progress: changes requested
and removed
Progress: ready for review
labels
dobooth
suggested changes
Feb 2, 2021
| @@ -111,6 +111,20 @@ On DOM ready, the `data-mage-init` attribute is parsed to extract component name | |||
| }; | |||
| ``` | |||
|
|
|||
| Where `<component_name>` native Magento JS component, for example: `menu`, `collapsible`, `tooltip` ... | |||
There was a problem hiding this comment.
Suggested change
| Where `<component_name>` native Magento JS component, for example: `menu`, `collapsible`, `tooltip` ... | |
| Where `<component_name>` is a native Magento JS component, for example: `menu`, `collapsible`, `tooltip` ... |
| <nav data-mage-init='{"tooltip": {"content": "<?= /* @noEscape */ $content ?>"}}'></nav> | ||
| ``` | ||
|
|
||
| Or a custom JS component, can be component path `Vendor_Module/js/component` or alias declareted in `requirejs-config.js`. |
There was a problem hiding this comment.
Suggested change
| Or a custom JS component, can be component path `Vendor_Module/js/component` or alias declareted in `requirejs-config.js`. | |
| Or a custom JS component, implemented with a component path: `Vendor_Module/js/component`, or as an alias declared in `requirejs-config.js`. |
If this suggestion is not accurate, than some kind of grammar fix is needed here.
| <nav data-mage-init='{"Vendor_Module/js/component": {"status":"<?= /* @noEscape */ $block->getStatus(); ?>"}}'></nav> | ||
| ``` | ||
|
|
||
| More about [locate JS components](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_debug.html). |
There was a problem hiding this comment.
Suggested change
| More about [locate JS components](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_debug.html). | |
| Read more about [locate JS components](https://devdocs.magento.com/guides/v2.4/javascript-dev-guide/javascript/js_debug.html). |
|
@BarnyShergold, @dobooth thanks for your help. I have fixed the review. |
BarnyShergold
approved these changes
Feb 3, 2021
m2-community-project
bot
added
Progress: approved
and removed
Progress: changes requested
labels
dobooth
approved these changes
Feb 3, 2021
|
running tests |
dobooth
added
2.3.x
|
Hi @DenisSaltanahmedov, thank you for your contribution! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
This pull request adds additional examples of the "component key" related to JS data-mage-init to this topic.
Affected DevDocs pages
Links to Magento source code