[Doc] Add resolve condition names to UX Svelte documentation #1689
Conversation
src/Svelte/doc/index.rst
Outdated
| @@ -51,6 +51,19 @@ Next, install a package to help Svelte: | |||
| That's it! Any files inside ``assets/svelte/controllers/`` can now be rendered as | |||
| Svelte components. | |||
|
|
|||
| To make internal functions work in Svelte, such as ``onMount``, ``onDestroy``, etc, | |||
There was a problem hiding this comment.
Could you add a link to the documentation you mention?
There was a problem hiding this comment.
Yes, sure! I got this link:
https://svelte.dev/docs/v4-migration-guide#browser-conditions-for-bundlers
Should I add it to the documentation?
There was a problem hiding this comment.
Great. I will do it tomorrow. 👍
src/Svelte/doc/index.rst
Outdated
| @@ -51,6 +51,19 @@ Next, install a package to help Svelte: | |||
| That's it! Any files inside ``assets/svelte/controllers/`` can now be rendered as | |||
| Svelte components. | |||
|
|
|||
| To make internal functions work in Svelte, such as ``onMount``, ``onDestroy``, etc, | |||
There was a problem hiding this comment.
Maybe we should mention those steps are needed when you want to use svelte 4? You don't have this kind of issue in version 3?
There was a problem hiding this comment.
Yes, you are right. I will mention this.
src/Svelte/doc/index.rst
Outdated
|
|
||
| // module.exports = Encore.getWebpackConfig(); | ||
| const config = Encore.getWebpackConfig(); | ||
| config.resolve.conditionNames = ['browser', 'svelte']; |
There was a problem hiding this comment.
In the documentation you send, they motion also an import item. Do you think we should added to?
conditionNames: ['svelte', 'browser', 'import']
src/Svelte/doc/index.rst
Outdated
| @@ -51,6 +51,19 @@ Next, install a package to help Svelte: | |||
| That's it! Any files inside ``assets/svelte/controllers/`` can now be rendered as | |||
| Svelte components. | |||
|
|
|||
| To make internal functions work in Svelte, such as ``onMount``, ``onDestroy``, etc, | |||
|
@WebMamba I think we need to consider one more thing: When I create a new Symfony app, install the UX Svelte bundle, install all the necessary NPM dependencies and type
That's how it came to my attentien that when you use Svelte 4, you will have to do a bit more configuration where you will have to add Should I add this too? |
|
Hummm I think it's fine, the error message is really good. Just specify in the doc that this config is needed for svelte 4 |
javiereguiluz
force-pushed
the
doc-ux-svelte-resolve-condition-names
branch
from
6e1a0c4 to
400deee
Compare
|
Kasper, thanks for this nice contribution and for your patience during the review process (thanks also to Matheo for the nice review). Your contribution was perfectly correct, but while merging I changed the code example to show a |
|
@javiereguiluz you are welcome! And using the |
This PR will enhance the UX Svelte documentation. As of yet, some internal functionality will not work in Svelte unless you add
browserandsvelteto theconditionNames. I think it is valuable to mention this in the documentaiton.