docs(compiler): add type docs for esmLoaderPath
#1364
Conversation
christian-bromann
requested review from
rwaskiewicz and
tanner-reits
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
| *default: `/dist/loader`* | ||
|
|
||
| Provide a custom path for the ESM loader directory, containing files you can import in an initiation script within your application to register all your components for lazy loading. | ||
|
|
There was a problem hiding this comment.
Can we expand on this? I'm not sure that as a user, I'd know enough here to start using this flag. To start, it might be worthwhile to include an example directory structure, setting with a custom value for esmLoaderPath, and explaining how setting esmLoaderPath affects the output of Stencil.
There was a problem hiding this comment.
Agree. Maybe we need an additional section that talks about lazy loading and what the loader does? We could pull some of this out of the "How is this different from "dist-custom-elements" output target?" section.
There was a problem hiding this comment.
I added a section to the loader script and also added an example how modifying the option has an impact on the user of a stencil library.
| *default: `/dist/loader`* | ||
|
|
||
| Provide a custom path for the ESM loader directory, containing files you can import in an initiation script within your application to register all your components for lazy loading. | ||
|
|
There was a problem hiding this comment.
Agree. Maybe we need an additional section that talks about lazy loading and what the loader does? We could pull some of this out of the "How is this different from "dist-custom-elements" output target?" section.
Co-authored-by: Ryan Waskiewicz <[email protected]>
Co-authored-by: Tanner Reits <[email protected]>
|
Thanks for the review folks, I applied the changes to all other docs versions (except v2). |
Adding docs for
esmLoaderPath.See also ionic-team/stencil#5418