Improve View Models documentation with best practices and clarification - #423
Open
mohaelmrabet wants to merge 4 commits into
Open
mohaelmrabet wants to merge 4 commits into
mohaelmrabet wants to merge 4 commits into
Conversation
I improved the View Models documentation to make it easier to understand and more useful for developers. What I added: - clearer explanation of blocks vs. view models - simple notes about SRP and why view models help keep code clean - tips on reusability and using multiple view models - a short section about cache behavior - naming guidelines - a small checklist for creating a view model Nothing technical was changed—just clearer wording and extra best practices to help developers.
meker12
approved these changes
May 15, 2026
github-project-automation
Bot
moved this from 📋 Needs Review
to 👍 Approved
in Commerce - Pull Requests
github-project-automation
Bot
moved this from 👍 Approved
to 🏁 Done
in Commerce - Pull Requests
github-project-automation
Bot
moved this from 🏁 Done
to 🧑💻 In Progress
in Commerce - Pull Requests
dshevtsov
requested changes
Sep 23, 2026
| <argument name="utility_view_model" xsi:type="object">Vendor\Module\ViewModel\Utility</argument> | ||
| </arguments> | ||
| ``` | ||
| Retrieve them in the template using $block->getViewModel() or custom accessors. |
Contributor
There was a problem hiding this comment.
Suggested change
| Retrieve them in the template using $block->getViewModel() or custom accessors. | |
| Retrieve them in the template using `$block->getViewModel()` or custom accessors. | |
| @@ -72,8 +72,9 @@ $viewModel = $block->getViewModel(); | |||
| ``` | |||
|
|
|||
| ## Examples | |||
Contributor
There was a problem hiding this comment.
Suggested change
| ## Examples | |
| ## Examples | |
This branch has not been deployed
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
I improved the View Models documentation to make it easier to understand and more useful for developers.
What I added:
Nothing technical was changed—just clearer wording and extra best practices to help developers.
Purpose of this pull request
This pull request (PR) ...
Affected pages