Skip to content

Commit

Permalink
Merge pull request #5584 from RustyRaptor/nuxt-docs-issue-5583
Browse files Browse the repository at this point in the history
Explain the default exclude option in the Nuxt module configuration docs.
  • Loading branch information
tugcekucukoglu authored Apr 19, 2024
2 parents e7ec2ad + 3ce7f69 commit ac99818
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions doc/nuxt/configuration/ComponentsDoc.vue
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down Expand Up @@ -39,6 +41,15 @@ primevue: {
},
code3: {
basic: `
primevue: {
components: {
exclude: []
}
}
`
},
code4: {
basic: `
primevue: {
components: {
prefix: 'Prime'
Expand All @@ -47,7 +58,7 @@ primevue: {
}
`
},
code4: {
code5: {
basic: `
primevue: {
components: {
Expand Down

0 comments on commit ac99818

Please sign in to comment.