vertumnus
/
primevue-mirror
mirror of https://github.com/primefaces/primevue.git
1
0
Fork 0
Code Packages Releases Activity

Explain the default behavior of primevue.components.exclude in the Nuxt 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.
pull/5584/head
RustyRaptor 2024-04-14 10:32:03 -06:00 committed by GitHub
parent 8365a30f5b
commit 3ce7f69a9d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/nuxt/configuration/ComponentsDoc.vue
View File

@ -4,13 +4,15 @@
<DocSectionCode :code="code1" importCode hideToggleCode hideStackBlitz />
<p>In case all components are imported, particular components can still be excluded with the <i>exclude</i> option.</p>
<DocSectionCode :code="code2" importCode hideToggleCode hideStackBlitz />
<p>Use the <i>prefix</i> option to give a prefix to the registered component names.</p>
<p>By default, for compatibility reasons, Chart and Editor components are excluded. To include them simply set the <i>exclude</i> option to an empty list.</p>
<DocSectionCode :code="code3" importCode hideToggleCode hideStackBlitz />
<p>Use the <i>prefix</i> option to give a prefix to the registered component names.</p>
<DocSectionCode :code="code4" importCode hideToggleCode hideStackBlitz />
<p>
Component registration can be customized further by implementing the <i>name</i> function that gets an object representing the import metadata. <i>name</i> is the label of the component, <i>as</i> is the default export name and
<i>from</i> is the import path.
</p>
<DocSectionCode :code="code4" importCode hideToggleCode hideStackBlitz />
<DocSectionCode :code="code5" importCode hideToggleCode hideStackBlitz />
</DocSectionText>
</template>
@ -39,6 +41,15 @@ primevue: {
},
code3: {
basic: `
primevue: {
components: {
exclude: []
}
}
`
},
code4: {
basic: `
primevue: {
components: {
prefix: 'Prime'
@ -47,7 +58,7 @@ primevue: {
}
`
},
code4: {
code5: {
basic: `
primevue: {
components: {