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): add bundle export behavior #921

Merged
merged 2 commits into from
Oct 18, 2022

Conversation

tanner-reits
Copy link
Contributor

This commit adds documentation for the new bundle export behavior on dist-custom-elements coming in Stencil V3

This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
@vercel
Copy link

vercel bot commented Oct 4, 2022

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

Name Status Preview Updated
stencil-site ✅ Ready (Inspect) Visit Preview Oct 4, 2022 at 8:51PM (UTC)

@tanner-reits
Copy link
Contributor Author

I didn't add anything around this being a quick port-over for dist-custom-elements-bundle since I figured that would be handled in the migration guide for v3

@@ -73,6 +73,7 @@ export const config: Config = {
| ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `default` | No additional re-export or auto-definition behavior will be performed.<br><br>This value will be used if no explicit value is set in the config, or if a given value is not a valid option. |
| `auto-define-custom-elements` | A component and its children will be automatically defined with the `CustomElementRegistry` when the component's module is imported. |
| `bundle` | A utility `defineCustomElements()` function is exported from the `index.js` file of the output director. This function can be used to quickly define all Stencil components in a project on the custom elements registry. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| `bundle` | A utility `defineCustomElements()` function is exported from the `index.js` file of the output director. This function can be used to quickly define all Stencil components in a project on the custom elements registry. |
| `bundle` | A utility `defineCustomElements()` function is exported from the `index.js` file of the output directory. This function can be used to quickly define all Stencil components in a project on the custom elements registry. |

Co-authored-by: Ryan Waskiewicz <ryanwaskiewicz@gmail.com>
@rwaskiewicz rwaskiewicz removed their assignment Oct 5, 2022
@rwaskiewicz
Copy link
Contributor

It's a little chaotic on this repo. Gonna merge this so it doesn't get left behind.

@rwaskiewicz rwaskiewicz merged commit 347b9ef into v3.0.0-dev Oct 18, 2022
@tanner-reits tanner-reits deleted the docs/custom-elements-export-behavior-bundle branch October 18, 2022 20:33
rwaskiewicz pushed a commit that referenced this pull request Jan 20, 2023
This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
rwaskiewicz pushed a commit that referenced this pull request Jan 23, 2023
This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
rwaskiewicz pushed a commit that referenced this pull request Jan 25, 2023
This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
rwaskiewicz pushed a commit that referenced this pull request Jan 25, 2023
This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
rwaskiewicz pushed a commit that referenced this pull request Jan 25, 2023
This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
rwaskiewicz pushed a commit that referenced this pull request Jan 25, 2023
This commit adds documentation for the new `bundle` export behavior on `dist-custom-elements` coming in Stencil V3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants