Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dist-custom-elements): update documentation to reflect index.js changes #883

Merged
merged 4 commits into from
Jun 21, 2022

Conversation

alicewriteswrongs
Copy link
Contributor

@alicewriteswrongs alicewriteswrongs commented May 23, 2022

This adds documentation of the change to the dist-custom-elements
output target introduced in stenciljs/core#3368. That PR adds
a re-export of all the built components from the index.js file,
which will support some existing workflows based on the
dist-custom-elements-bundle output target.

@alicewriteswrongs alicewriteswrongs changed the title docs(dist-custom-elements): update documentation to reflect index.js … docs(dist-custom-elements): update documentation to reflect index.js changes May 23, 2022
@alicewriteswrongs alicewriteswrongs force-pushed the ap/dist-custom-elements-export branch from 4b0d3b2 to b925122 Compare May 23, 2022 19:16
@vercel
Copy link

vercel bot commented May 23, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
stencil-site ✅ Ready (Inspect) Visit Preview Jun 13, 2022 at 4:28PM (UTC)

defineCustomElement as defineCustomElementMyOtherComponent
} from './my-other-component.js';
```

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add a snippet of how this could be used as well? Right now, we tell folks that we'll export this file for them, but we don't give them much instruction as to how to use it compared to the first option (and probably should make that callout that this is an either/or proposition)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that makes sense, I'll add an explanation of the specific use-case of setting this ad module in package.json, do you think there's anything else we should call out?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 I don't think so - with that we should be good!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just realized there's a bit of a wrinkle with this...

…changes

This adds documentation of the change to the `dist-custom-elements`
output target introduced in stenciljs/core#3368. That PR adds
a re-export of all the built components from the `index.js` file,
which will support some existing workflows based on the
`dist-custom-elements-bundle` output target.
@alicewriteswrongs alicewriteswrongs force-pushed the ap/dist-custom-elements-export branch from f324e66 to 0bec636 Compare June 9, 2022 15:22
@alicewriteswrongs
Copy link
Contributor Author

@rwaskiewicz I just updated this to reflect the changes to generation typedefs for dist-custom-elements that are now merged into stenciljs/core#3368

Co-authored-by: Anthony Giuliano <67711678+a-giuliano@users.noreply.github.com>
@rwaskiewicz rwaskiewicz merged commit 0bcabe7 into master Jun 21, 2022
@rwaskiewicz rwaskiewicz deleted the ap/dist-custom-elements-export branch June 21, 2022 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants