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

Code Format

pull/4126/head
GitHub Actions Bot 2023-10-15 21:00:28 +00:00
parent 18576538e7
commit 4b1c58d771
10 changed files with 20 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/nuxt/DownloadDoc.vue
View File

@ -1,8 +1,6 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
The <a href="https://www.npmjs.com/package/nuxt-primevue" target="_blank" rel="noopener noreferrer">nuxt-prime</a> package is the official module by PrimeTek.
</p>
<p>The <a href="https://www.npmjs.com/package/nuxt-primevue" target="_blank" rel="noopener noreferrer">nuxt-prime</a> package is the official module by PrimeTek.</p>
</DocSectionText>
<DocSectionCode :code="code" hideToggleCode hideCodeSandbox hideStackBlitz />
</template>

4
doc/nuxt/ExampleDoc.vue
View File

@ -1,7 +1,5 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
A sample <a href="https://github.com/primefaces/primevue-examples/tree/main/nuxt-quickstart" rel="noopener noreferrer">starter example</a> is available at PrimeVue examples repository.
</p>
<p>A sample <a href="https://github.com/primefaces/primevue-examples/tree/main/nuxt-quickstart" rel="noopener noreferrer">starter example</a> is available at PrimeVue examples repository.</p>
</DocSectionText>
</template>

8
doc/nuxt/SetupDoc.vue
View File

@ -1,12 +1,8 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
The module is enabled by adding <i>nuxt-primevue</i> to the modules option. Configuration values are defined with the <i>primevue</i> property.
</p>
<p>The module is enabled by adding <i>nuxt-primevue</i> to the modules option. Configuration values are defined with the <i>primevue</i> property.</p>
<DocSectionCode :code="code1" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
<p>
The complete API with the all available configuration options along with the default values.
</p>
<p>The complete API with the all available configuration options along with the default values.</p>
<DocSectionCode :code="code2" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
</DocSectionText>
</template>

4
doc/nuxt/StyleDoc.vue
View File

@ -1,8 +1,8 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
Module is used to configure the PrimeVue options, register components, directives and composables. CSS configuration of the styled mode is not included at the moment due to the upcoming enhancements like moving theming to core with CSS variables.
In styled mode, the theme can be defined at Nuxt configuration with the <i>css</i> property. Note that this only applies to styled mode, in unstyled mode a theme file is not required as styling is done externally.
Module is used to configure the PrimeVue options, register components, directives and composables. CSS configuration of the styled mode is not included at the moment due to the upcoming enhancements like moving theming to core with CSS
variables. In styled mode, the theme can be defined at Nuxt configuration with the <i>css</i> property. Note that this only applies to styled mode, in unstyled mode a theme file is not required as styling is done externally.
</p>
<DocSectionCode :code="code1" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
<p>

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

@ -1,21 +1,14 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
The components to import and register are defined with the <i>include</i> option using a string array. When the value is ignored
or set using the <i>*</i> alias, all of the components are registered.
</p>
<p>The components to import and register are defined with the <i>include</i> option using a string array. When the value is ignored or set using the <i>*</i> alias, all of the components are registered.</p>
<DocSectionCode :code="code1" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
<p>
In case all components are imported, particular components can still be excluded with the <i>exclude</i> option.
</p>
<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 hideCodeSandbox hideStackBlitz />
<p>
Use the <i>prefix</i> option to give a prefix to the registered component names.
</p>
<p>Use the <i>prefix</i> option to give a prefix to the registered component names.</p>
<DocSectionCode :code="code3" importCode hideToggleCode hideCodeSandbox 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.
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 hideCodeSandbox hideStackBlitz />
</DocSectionText>
@ -66,7 +59,7 @@ primevue: {
}
`
}
}
};
}
};
</script>

6
doc/nuxt/configuration/ComposablesDoc.vue
View File

@ -1,8 +1,6 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
Determines the composables to use, when default value is ignored or set as <i>*</i> all composables are imported.
</p>
<p>Determines the composables to use, when default value is ignored or set as <i>*</i> all composables are imported.</p>
<DocSectionCode :code="code1" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
</DocSectionText>
</template>
@ -20,7 +18,7 @@ primevue: {
}
`
}
}
};
}
};
</script>

10
doc/nuxt/configuration/DirectivesDoc.vue
View File

@ -1,12 +1,8 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
The names of the directives to import and register are provided using the <i>include</i> property. When the value is ignored or set using the * alias, all of the directives are registered.
</p>
<p>The names of the directives to import and register are provided using the <i>include</i> property. When the value is ignored or set using the * alias, all of the directives are registered.</p>
<DocSectionCode :code="code1" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
<p>
Similar to components, certain directives can be excluded and name registration can be customized.
</p>
<p>Similar to components, certain directives can be excluded and name registration can be customized.</p>
<DocSectionCode :code="code2" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
<DocSectionCode :code="code3" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
</DocSectionText>
@ -45,7 +41,7 @@ primevue: {
}
`
}
}
};
}
};
</script>

4
doc/nuxt/configuration/OptionsDoc.vue
View File

@ -1,8 +1,6 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
Main configuration settings of PrimeVue, refer to the <PrimeVueNuxtLink to="/configuration">configuration</PrimeVueNuxtLink> documentation for details. Defaults to an empty object.
</p>
<p>Main configuration settings of PrimeVue, refer to the <PrimeVueNuxtLink to="/configuration">configuration</PrimeVueNuxtLink> documentation for details. Defaults to an empty object.</p>
</DocSectionText>
<DocSectionCode :code="code" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
</template>

4
doc/nuxt/configuration/UsePrimeVueDoc.vue
View File

@ -1,8 +1,6 @@
<template>
<DocSectionText v-bind="$attrs">
<p>
Whether to install the PrimeVue plugin, defaults to <i>true</i>. Disable this option if you prefer to configure PrimeVue manually e.g. with a Nuxt plugin.
</p>
<p>Whether to install the PrimeVue plugin, defaults to <i>true</i>. Disable this option if you prefer to configure PrimeVue manually e.g. with a Nuxt plugin.</p>
</DocSectionText>
<DocSectionCode :code="code" importCode hideToggleCode hideCodeSandbox hideStackBlitz />
</template>

2
pages/nuxt/index.vue
View File

@ -72,7 +72,7 @@ export default {
id: 'composables',
label: 'composables',
component: ComposablesDoc
},
}
]
},
{