[React] Mention Webpack Encoure bundle should be installed first #2523
Conversation
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
…led first If not working with AssetManager. This will help newcomers not have to remove the UX React bundle if they wanted it to modify what is created through the Webpack Encore bundle.
carsonbot
added
Bug
dukeofgaming
changed the title
smnandre
reviewed
Jan 23, 2025
| @@ -14,6 +14,7 @@ Symfony UX React supports React 18+. | |||
|
|
|||
| Installation | |||
| ------------ | |||
| Make sure you have WebpackEncore if you are not working with AssetMapper. You can install and configure Webpack Encore through the `Symfony Encore bundle`_. This will modify your ``base.html.twig`` template and create ``assets/app.js``, in addition to adding and modifying other configuration, which will in turn help you get started faster with the UX React bundle. | |||
There was a problem hiding this comment.
There is a note just below, stating "works best with Webpack Encore. If AssetMapper... "
I'd rather keep it on top. I think we should add a simple sentence here, with a link to either the WebpackEncore documentation, or a section lower in the page.
Something like
. note::
This package works best with WebpackEncore (see :ref:`Install and configure WebpackEncore`_)
To use it with AssetMapper, see :ref:`Using with AssetMapper <using-with-asset-mapper>`. That would make this visible, while keeping the top of the page focused on ux/react
There was a problem hiding this comment.
Totally, a simple sentence is enough, no need to duplicate what's written on Webpack Encore setup page.
smnandre
changed the title
smnandre
added
Status: Reviewing
smnandre
added
Status: Needs Work
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If not working with AssetMapper.
This will help newcomers not have to remove the UX React bundle if they wanted it to modify what is created through the Webpack Encore bundle.