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

Explain the default exclude option in the Nuxt module configuration docs. #5584

Merged
merged 1 commit into from
Apr 19, 2024

Conversation

RustyRaptor
Copy link
Contributor

In the documentation for configuring the Nuxt module components, there is no indication that Chart and Editor are excluded by default. The only way to find out is if you happen upon a single issue in the github repo of the nuxt module npm package or read the full source code of the module. Although the intention of this default behavior is to avoid compatibility issues because of the dependencies of those 2 components, it leads to even more confusion when you know what they need but they aren't being detected as components. They are excluded even if you use the '*' option in include. This change introduces a helpful tip into the docs page so users know what to do when they want to use those components. The solution is to set exclude to [].

###Defect Fixes
issue #5583

…xt module configuration and how to mitigate.

In the documentation for configuring the Nuxt module components, there is no indication that Chart and Editor are excluded by default. The only way to find out is if you happen upon a single issue in the github repo of the nuxt module npm package or read the full source code of the module. Although the intention of this default behavior is to avoid compatibility issues because of the dependencies of those 2 components, it leads to even more confusion when you know what they need but they aren't being detected as components. They are excluded even if you use the * option in include. This change introduces a helpful tip into the docs page so users know what to do when they want to use those components.
Copy link

vercel bot commented Apr 14, 2024

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

2 Ignored Deployments
Name Status Preview Comments Updated (UTC)
primevue ⬜️ Ignored (Inspect) Visit Preview Apr 14, 2024 4:40pm
primevue-v4 ⬜️ Ignored (Inspect) Visit Preview Apr 14, 2024 4:40pm

@tugcekucukoglu tugcekucukoglu merged commit ac99818 into primefaces:master Apr 19, 2024
3 of 4 checks passed
@tugcekucukoglu tugcekucukoglu added the Component: Documentation Issue or pull request is related to Documentation label Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation Issue or pull request is related to Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants