arthur/ui
1
0
Fork 0
mirror of https://github.com/ArthurDanjou/ui.git synced 2026-01-14 12:14:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: add @nuxt/ui-pro source (#2775)

Browse Source
This commit is contained in:
Benjamin Canac
2024-12-04 21:15:07 +01:00
committed by GitHub
parent e79103131f
commit 01c3934403
24 changed files with 880 additions and 149 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/app/app.vue
View File

@@ -7,7 +7,7 @@ const route = useRoute()
const appConfig = useAppConfig()
const colorMode = useColorMode()
const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('content', ['framework']))
const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('content', ['framework', 'module']))
const { data: files } = useLazyAsyncData('search', () => queryCollectionSearchSections('content'), {
server: false
})
@@ -73,7 +73,7 @@ useServerSeoMeta({
twitterCard: 'summary_large_image'
})
const { frameworks } = useSharedData()
const { frameworks, modules } = useSharedData()
const { mappedNavigation, filteredNavigation } = useContentNavigation(navigation)
provide('navigation', mappedNavigation)
@@ -94,7 +94,7 @@ provide('navigation', mappedNavigation)
</NuxtLayout>
<template v-if="!route.path.startsWith('/examples')">
<Footer />
<!-- <Footer /> -->
<ClientOnly>
<LazyUContentSearch
@@ -104,6 +104,10 @@ provide('navigation', mappedNavigation)
id: 'framework',
label: 'Framework',
items: frameworks
}, {
id: 'module',
label: 'Module',
items: modules
}]"
:navigation="filteredNavigation"
:fuse="{ resultLimit: 42 }"
@@ -141,10 +145,10 @@ provide('navigation', mappedNavigation)
--ui-container: var(--container-8xl);
}
html[data-framework="nuxt"] .vue-only {
display: none;
}
html[data-framework="vue"] .nuxt-only {
html[data-framework="nuxt"] .vue-only,
html[data-framework="vue"] .nuxt-only,
html[data-module="ui-pro"] .ui-only,
html[data-module="ui"] .ui-pro-only {
display: none;
}
</style>

1
docs/app/components/FrameworkSelect.vue
View File

@@ -18,7 +18,6 @@ const { frameworks } = useSharedData()
:ui="{
trailingIcon: ['transition-transform duration-200', open ? 'rotate-180' : undefined].filter(Boolean).join(' ')
}"
class="-mx-2 w-[calc(100%+1rem)]"
>
<template #leading>
<UIcon v-for="framework in frameworks" :key="framework.value" :name="framework.icon" :class="`${framework.value}-only`" class="shrink-0 size-5" />

13
docs/app/components/Header.vue
View File

@@ -7,6 +7,7 @@ const props = defineProps<{
}>()
const config = useRuntimeConfig().public
const { module } = useSharedData()
const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')
@@ -20,16 +21,17 @@ defineShortcuts({
</script>
<template>
<UHeader :ui="{ left: 'min-w-0' }">
<UHeader :ui="{ left: 'min-w-0', toggle: '-mr-1.5' }">
<template #left>
<NuxtLink to="/" class="flex items-end gap-2 font-bold text-xl text-[var(--ui-text-highlighted)] min-w-0 focus-visible:outline-[var(--ui-primary)] shrink-0" aria-label="Nuxt UI">
<Logo class="w-auto h-6 shrink-0" />
<LogoPro class="w-auto h-6 shrink-0 ui-pro-only" />
<Logo class="w-auto h-6 shrink-0 ui-only" />
</NuxtLink>
<UDropdownMenu
v-slot="{ open }"
:modal="false"
:items="[{ label: `v${config.version}`, active: true, color: 'primary', checked: true, type: 'checkbox' }, { label: 'v2.19', to: 'https://ui.nuxt.com' }]"
:items="[{ label: `v${config.version}`, active: true, color: 'primary', checked: true, type: 'checkbox' }, { label: module === 'ui-pro' ? 'v1.5' : 'v2.19', to: module === 'ui-pro' ? 'https://ui.nuxt.com/pro' : 'https://ui.nuxt.com' }]"
:ui="{ content: 'w-(--reka-dropdown-menu-trigger-width) min-w-0' }"
size="xs"
>
@@ -73,7 +75,10 @@ defineShortcuts({
<USeparator type="dashed" class="my-4" />
<FrameworkSelect class="mb-4" />
<div class="flex flex-col gap-2 w-[calc(100%+1rem)] mb-4 -mx-2">
<ModuleSelect />
<FrameworkSelect />
</div>
<UContentNavigation :navigation="navigation" highlight />
</template>

14
docs/app/components/LogoPro.vue Normal file
View File

@@ -0,0 +1,14 @@
<template>
<svg width="1352" height="200" viewBox="0 0 1352 200" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M377 200C379.16 200 381 198.209 381 196V103C381 103 386 112 395 127L434 194C435.785 197.74 439.744 200 443 200H470V50H443C441.202 50 439 51.4941 439 54V148L421 116L385 55C383.248 51.8912 379.479 50 376 50H350V200H377Z" fill="currentColor" />
<path d="M726 92H739C742.314 92 745 89.3137 745 86V60H773V92H800V116H773V159C773 169.5 778.057 174 787 174H800V200H783C759.948 200 745 185.071 745 160V116H726V92Z" fill="currentColor" />
<path d="M591 92V154C591 168.004 585.742 179.809 578 188C570.258 196.191 559.566 200 545 200C530.434 200 518.742 196.191 511 188C503.389 179.809 498 168.004 498 154V92H514C517.412 92 520.769 92.622 523 95C525.231 97.2459 526 98.5652 526 102V154C526 162.059 526.457 167.037 530 171C533.543 174.831 537.914 176 545 176C552.217 176 555.457 174.831 559 171C562.543 167.037 563 162.059 563 154V102C563 98.5652 563.769 96.378 566 94C567.96 91.9107 570.028 91.9599 573 92C573.411 92.0055 574.586 92 575 92H591Z" fill="currentColor" />
<path d="M676 144L710 92H684C680.723 92 677.812 93.1758 676 96L660 120L645 97C643.188 94.1758 639.277 92 636 92H611L645 143L608 200H634C637.25 200 640.182 196.787 642 194L660 167L679 195C680.818 197.787 683.75 200 687 200H713L676 144Z" fill="currentColor" />
<path d="M168 200H279C282.542 200 285.932 198.756 289 197C292.068 195.244 295.23 193.041 297 190C298.77 186.959 300.002 183.51 300 179.999C299.998 176.488 298.773 173.04 297 170.001L222 41C220.23 37.96 218.067 35.7552 215 34C211.933 32.2448 207.542 31 204 31C200.458 31 197.067 32.2448 194 34C190.933 35.7552 188.77 37.96 187 41L168 74L130 9.99764C128.228 6.95784 126.068 3.75491 123 2C119.932 0.245087 116.542 0 113 0C109.458 0 106.068 0.245087 103 2C99.9323 3.75491 96.7717 6.95784 95 9.99764L2 170.001C0.226979 173.04 0.00154312 176.488 1.90993e-06 179.999C-0.0015393 183.51 0.229648 186.959 2 190C3.77035 193.04 6.93245 195.244 10 197C13.0675 198.756 16.4578 200 20 200H90C117.737 200 137.925 187.558 152 164L186 105L204 74L259 168H186L168 200ZM89 168H40L113 42L150 105L125.491 147.725C116.144 163.01 105.488 168 89 168Z" fill="var(--ui-primary)" />
<path d="M958 60.0001H938C933.524 60.0001 929.926 59.9395 927 63C924.074 65.8905 925 67.5792 925 72V141C925 151.372 923.648 156.899 919 162C914.352 166.931 908.468 169 899 169C889.705 169 882.648 166.931 878 162C873.352 156.899 873 151.372 873 141V72.0001C873 67.5793 872.926 65.8906 870 63.0001C867.074 59.9396 863.476 60.0001 859 60.0001H840V141C840 159.023 845.016 173.458 855 184C865.156 194.542 879.893 200 899 200C918.107 200 932.844 194.542 943 184C953.156 173.458 958 159.023 958 141V60.0001Z" fill="currentColor" />
<path fill-rule="evenodd" clip-rule="evenodd" d="M1000 60.0233L1020 60V77L1020 128V156.007L1020 181L1020 189.004C1020 192.938 1019.98 194.429 1017 197.001C1014.02 199.725 1009.56 200 1005 200H986.001V181.006L986 130.012V70.0215C986 66.1576 986.016 64.5494 989 62.023C991.819 59.6358 995.437 60.0233 1000 60.0233Z" fill="currentColor" />
<path d="M1060 200V60H1117C1126.67 60 1134.98 61.2896 1142 65C1149.16 68.7104 1155.29 74.3744 1159 81C1162.71 87.6256 1164 95.3867 1164 104C1164 112.481 1162.71 120.374 1159 127C1155.29 133.626 1149.16 138.157 1142 142C1134.98 145.71 1126.67 148 1117 148H1090V200H1060ZM1115 123C1121.63 123 1126.69 121.578 1130 118C1133.31 114.29 1135 109.433 1135 104C1135 98.567 1133.31 93.5778 1130 90C1126.69 86.2896 1121.63 85 1115 85H1090V123H1115Z" fill="var(--ui-primary)" />
<path d="M1226 123C1219.37 123 1214.31 124.965 1211 130C1207.69 135.035 1206 142.122 1206 151V200H1178V100H1200C1203.31 100 1206 102.686 1206 106V116C1208.65 109.904 1211.16 106.518 1215 104C1218.98 101.482 1224.77 100 1231 100H1242V123H1226Z" fill="var(--ui-primary)" />
<path d="M1299 200C1288.93 200 1280.08 197.373 1272 193C1263.92 188.495 1257.51 182.818 1253 175C1248.49 167.049 1246 157.806 1246 148C1246 138.194 1248.49 129.818 1253 122C1257.51 114.049 1263.92 107.373 1272 103C1280.08 98.4946 1288.93 97 1299 97C1309.07 97 1318.92 98.4946 1327 103C1335.08 107.373 1340.49 114.049 1345 122C1349.51 129.818 1352 138.194 1352 148C1352 157.806 1349.51 167.049 1345 175C1340.49 182.818 1335.08 188.495 1327 193C1318.92 197.373 1309.07 200 1299 200ZM1299 176C1306.42 176 1312.36 173.168 1317 168C1321.64 162.832 1324 156.216 1324 148C1324 139.652 1321.64 133.168 1317 128C1312.36 122.832 1306.42 120 1299 120C1291.58 120 1285.64 122.832 1281 128C1276.36 133.168 1274 139.652 1274 148C1274 156.216 1276.36 162.832 1281 168C1285.64 173.168 1291.58 176 1299 176Z" fill="var(--ui-primary)" />
</svg>
</template>

32
docs/app/components/ModuleSelect.vue Normal file
View File

@@ -0,0 +1,32 @@
<script setup lang="ts">
const { modules } = useSharedData()
</script>
<template>
<UDropdownMenu
v-slot="{ open }"
:modal="false"
:items="modules"
:ui="{ content: 'w-(--reka-dropdown-menu-trigger-width)' }"
>
<UButton
color="neutral"
variant="outline"
block
trailing-icon="i-lucide-chevron-down"
class="min-w-0"
:class="[open && 'bg-[var(--ui-bg-elevated)]']"
:ui="{
trailingIcon: ['transition-transform duration-200', open ? 'rotate-180' : undefined].filter(Boolean).join(' ')
}"
>
<template #leading>
<UIcon v-for="module in modules" :key="module.value" :name="module.icon" :class="`${module.value}-only`" class="shrink-0 size-5" />
</template>
<span v-for="module in modules" :key="module.value" :class="`${module.value}-only`" class="truncate">
{{ module.label }}
</span>
</UButton>
</UDropdownMenu>
</template>

23
docs/app/components/content/IconsTheme.vue
View File

@@ -2,11 +2,12 @@
import json5 from 'json5'
import icons from '../../../../src/theme/icons'
const { framework } = useSharedData()
const appConfig = useAppConfig()
const { framework, module } = useSharedData()
const { data: ast } = await useAsyncData(`icons-theme`, async () => {
const md = `
::code-collapse{class="nuxt-only"}
::code-collapse{class="ui-only nuxt-only"}
\`\`\`ts [app.config.ts]
export default defineAppConfig(${json5.stringify({
@@ -18,6 +19,22 @@ export default defineAppConfig(${json5.stringify({
::
::code-collapse{class="ui-pro-only nuxt-only"}
\`\`\`ts [app.config.ts]
export default defineAppConfig(${json5.stringify({
ui: {
icons: appConfig.ui.icons
}
}, null, 2).replace(/,([ |\t\n]+[}|\])])/g, '$1')})
\`\`\`\
::
::caution{class="ui-pro-only vue-only"}
Nuxt UI Pro v3 does not support Vue yet.
::
::code-collapse{class="vue-only"}
\`\`\`ts [vite.config.ts]
@@ -44,7 +61,7 @@ export default defineConfig({
`
return parseMarkdown(md)
}, { watch: [framework] })
}, { watch: [framework, module] })
</script>
<template>

12
docs/app/components/content/ModuleOnly.vue Normal file
View File

@@ -0,0 +1,12 @@
<script setup lang="ts">
import { Slot } from 'reka-ui'
</script>
<template>
<Slot class="ui-only">
<slot name="ui" />
</Slot>
<Slot class="ui-pro-only">
<slot name="ui-pro" />
</Slot>
</template>

19
docs/app/composables/useContentNavigation.ts
View File

@@ -2,25 +2,34 @@ import type { ContentNavigationItem } from '@nuxt/content'
function processNavigationItem(item: ContentNavigationItem, parent?: ContentNavigationItem): any {
if (item.shadow) {
return item.children?.map(child => processNavigationItem(child, item))
return item.children?.flatMap(child => processNavigationItem(child, item))
}
return {
...item,
title: parent?.title || item.title,
class: item.framework ? `${item.framework}-only` : undefined,
title: parent?.title && parent.title !== 'Pro' ? parent.title : item.title,
badge: parent?.badge || item.badge,
class: [item.framework && `${item.framework}-only`, item.module && `${item.module}-only`].filter(Boolean),
children: item.children?.length ? item.children?.flatMap(child => processNavigationItem(child)) : undefined
}
}
export const useContentNavigation = (navigation: Ref<ContentNavigationItem[] | undefined>) => {
const { framework } = useSharedData()
const { framework, module } = useSharedData()
const mappedNavigation = computed(() => navigation.value?.map(item => processNavigationItem(item)))
const filteredNavigation = computed(() => mappedNavigation.value?.map((item) => {
return {
...item,
children: item.children?.filter((child: any) => !child.framework || child.framework === framework.value)
children: item.children?.filter((child: any) => {
if (child.framework && child.framework !== framework.value) {
return false
}
if (child.module && child.module !== module.value) {
return false
}
return true
})
}
}))

19
docs/app/composables/useSharedData.ts
View File

@@ -11,12 +11,29 @@ function _useSharedData() {
label: 'Vue',
icon: 'i-logos-vue',
value: 'vue',
disabled: module.value === 'ui-pro',
onSelect: () => framework.value = 'vue'
}].map(f => ({ ...f, active: framework.value === f.value })))
const module = useCookie('nuxt-ui-module', { default: () => 'ui' })
const modules = computed(() => [{
label: 'nuxt/ui',
icon: 'i-lucide-box',
value: 'ui',
onSelect: () => module.value = 'ui'
}, {
label: 'nuxt/ui-pro',
icon: 'i-lucide-boxes',
value: 'ui-pro',
disabled: framework.value === 'vue',
onSelect: () => module.value = 'ui-pro'
}].map(m => ({ ...m, active: module.value === m.value })))
return {
framework,
frameworks
frameworks,
module,
modules
}
}

10
docs/app/error.vue
View File

@@ -11,7 +11,7 @@ const route = useRoute()
const appConfig = useAppConfig()
const colorMode = useColorMode()
const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('content', ['framework']))
const { data: navigation } = await useAsyncData('navigation', () => queryCollectionNavigation('content', ['framework', 'module']))
const { data: files } = useLazyAsyncData('search', () => queryCollectionSearchSections('content'), {
server: false
})
@@ -81,7 +81,7 @@ useServerSeoMeta({
twitterCard: 'summary_large_image'
})
const { frameworks } = useSharedData()
const { frameworks, modules } = useSharedData()
const { mappedNavigation, filteredNavigation } = useContentNavigation(navigation)
provide('navigation', mappedNavigation)
@@ -97,7 +97,7 @@ provide('navigation', mappedNavigation)
<UError :error="error" />
<Footer />
<!-- <Footer /> -->
<ClientOnly>
<LazyUContentSearch
@@ -107,6 +107,10 @@ provide('navigation', mappedNavigation)
id: 'framework',
label: 'Framework',
items: frameworks
}, {
id: 'module',
label: 'Module',
items: modules
}]"
:navigation="filteredNavigation"
:fuse="{ resultLimit: 42 }"

5
docs/app/layouts/docs.vue
View File

@@ -11,7 +11,10 @@ const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')
<template #left>
<UPageAside>
<template #top>
<FrameworkSelect />
<div class="flex flex-col gap-2 w-[calc(100%+1rem)] -mx-2">
<ModuleSelect />
<FrameworkSelect />
</div>
</template>
<UContentNavigation :navigation="navigation" highlight />

27
docs/app/pages/[...slug].vue
View File

@@ -3,7 +3,7 @@ import type { ContentNavigationItem } from '@nuxt/content'
import { findPageBreadcrumb, mapContentNavigation } from '#ui-pro/utils/content'
const route = useRoute()
const { framework } = useSharedData()
const { framework, module } = useSharedData()
definePageMeta({
layout: 'docs'
@@ -18,16 +18,17 @@ const { data: surround } = await useAsyncData(`${route.path}-surround`, () => {
return queryCollectionItemSurroundings('content', route.path, {
fields: ['description']
}).orWhere(group => group.where('framework', '=', framework.value).where('framework', 'IS NULL'))
.orWhere(group => group.where('module', '=', module.value).where('module', 'IS NULL'))
}, {
watch: [framework]
watch: [framework, module]
})
const navigation = inject<Ref<ContentNavigationItem[]>>('navigation')
const breadcrumb = computed(() => mapContentNavigation(findPageBreadcrumb(navigation?.value, page.value)).map(({ icon, ...link }) => link))
// Redirect to the correct framework version if the page is not the current framework
if (!import.meta.prerender) {
// Redirect to the correct framework version if the page is not the current framework
watch(framework, () => {
if (page.value?.framework && page.value?.framework !== framework.value) {
if (route.path.endsWith(`/${page.value?.framework}`)) {
@@ -37,19 +38,33 @@ if (!import.meta.prerender) {
}
}
})
// Redirect to the correct module version if the page is not the current module
watch(module, () => {
if (page.value?.module && page.value?.module !== module.value) {
if (page.value?.module === 'ui-pro' && route.path.includes('/pro')) {
navigateTo(`${route.path.replace('/pro', '')}`)
} else if (page.value?.module === 'ui' && !route.path.includes('/pro')) {
navigateTo(`${route.path.replace(`/${framework.value}`, '')}/pro/${framework.value}`)
}
}
})
}
// Update the framework if the page has a different framework
// Update the framework/module if the page has different ones
watch(page, () => {
if (page.value?.framework && page.value?.framework !== framework.value) {
framework.value = page.value?.framework as string
}
if (page.value?.module && page.value?.module !== module.value) {
module.value = page.value?.module as string
}
}, { immediate: true })
useSeoMeta({
titleTemplate: '%s - Nuxt UI v3',
titleTemplate: `%s - Nuxt UI ${page.value.module === 'ui-pro' ? 'Pro' : ''} v3${page.value.framework === 'vue' ? ' for Vue' : ''}`,
title: page.value.navigation?.title ? page.value.navigation.title : page.value.title,
ogTitle: `${page.value.navigation?.title ? page.value.navigation.title : page.value.title} - Nuxt UI v3`,
ogTitle: `${page.value.navigation?.title ? page.value.navigation.title : page.value.title} - Nuxt UI ${page.value.module === 'ui-pro' ? 'Pro' : ''} v3${page.value.framework === 'vue' ? ' for Vue' : ''}`,
description: page.value.description,
ogDescription: page.value.description
})

2
docs/app/pages/roadmap.vue
View File

@@ -20,7 +20,7 @@ const src = computed(() => `https://volta.net/embed/${token}?theme=${colorMode.v
</script>
<template>
<div class="h-[calc(100vh-var(--ui-header-height)-var(--ui-header-height)-48px-1px)]">
<div class="h-[calc(100vh-var(--ui-header-height))]">
<ClientOnly>
<iframe :src="src" width="100%" height="100%" />
</ClientOnly>

11
docs/app/plugins/framework.ts → docs/app/plugins/data.ts
View File

@@ -1,12 +1,13 @@
export default defineNuxtPlugin({
enforce: 'post',
setup() {
const { framework } = useSharedData()
const { framework, module } = useSharedData()
if (import.meta.client) {
useHead({
htmlAttrs: {
'data-framework': framework
'data-framework': framework,
'data-module': module
}
})
}
@@ -23,8 +24,10 @@ export default defineNuxtPlugin({
}
}
var framework = getCookie('nuxt-ui-framework');
document.documentElement.setAttribute('data-framework', framework || 'nuxt');
var f = getCookie('nuxt-ui-framework');
document.documentElement.setAttribute('data-framework', f || 'nuxt');
var m = getCookie('nuxt-ui-module');
document.documentElement.setAttribute('data-module', m || 'ui');
`.replace(/\s+/g, ' '),
type: 'text/javascript',
tagPriority: -1

55
docs/content.config.ts
View File

@@ -1,24 +1,45 @@
import { defineCollection, z } from '@nuxt/content'
import { resolve } from 'node:path'
const schema = z.object({
framework: z.string().optional(),
module: z.string().optional(),
navigation: z.object({
title: z.string().optional()
}),
links: z.array(z.object({
label: z.string(),
icon: z.string(),
avatar: z.object({
src: z.string(),
alt: z.string()
}).optional(),
to: z.string(),
target: z.string().optional()
}))
})
const pro = process.env.NUXT_UI_PRO_PATH
? {
cwd: resolve(__dirname, process.env.NUXT_UI_PRO_PATH, 'docs'),
include: 'content/**',
prefix: '/'
}
: process.env.NUXT_GITHUB_TOKEN
? {
repository: 'https://github.com/nuxt/ui-pro/tree/v3',
include: 'docs/content/**',
prefix: '/',
authToken: process.env.NUXT_GITHUB_TOKEN
}
: undefined
export const collections = {
content: defineCollection({
type: 'page',
source: '**/*',
schema: z.object({
framework: z.string().optional(),
navigation: z.object({
title: z.string().optional()
}),
links: z.array(z.object({
label: z.string(),
icon: z.string(),
avatar: z.object({
src: z.string(),
alt: z.string()
}).optional(),
to: z.string(),
target: z.string().optional()
}))
})
source: [{
include: '**/*'
}, pro!],
schema
})
}

8
docs/content/1.getting-started/2.installation/1.nuxt.md
View File

@@ -2,6 +2,7 @@
title: Installation
description: 'Learn how to install and configure Nuxt UI in your Nuxt application.'
framework: nuxt
module: ui
---
::callout{to="/getting-started/installation/vue" icon="i-logos-vue" class="hidden"}
@@ -55,7 +56,7 @@ export default defineNuxtConfig({
@import "@nuxt/ui";
```
::note
::tip
Use the `css` property in your `nuxt.config.ts` to import your CSS file.
```ts [nuxt.config.ts]
@@ -66,9 +67,10 @@ export default defineNuxtConfig({
```
::
::tip
::callout{icon="i-simple-icons-visualstudiocode"}
It's recommended to install the [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) extension for VSCode and add the following settings:
```json
```json [settings.json]
"files.associations": {
"*.css": "tailwindcss"
},

8
docs/content/1.getting-started/2.installation/2.vue.md
View File

@@ -2,6 +2,7 @@
title: Installation
description: 'Learn how to install and configure Nuxt UI in your Vue application.'
framework: vue
module: ui
---
::callout{to="/getting-started/installation/nuxt" icon="i-logos-nuxt-icon" class="hidden"}
@@ -90,7 +91,7 @@ app.mount('#app')
@import "@nuxt/ui";
```
::note
::tip
Import the CSS file in your `main.ts`.
```ts [main.ts]{1}
@@ -108,9 +109,10 @@ app.mount('#app')
```
::
::tip
::callout{icon="i-simple-icons-visualstudiocode"}
It's recommended to install the [Tailwind CSS IntelliSense](https://marketplace.visualstudio.com/items?itemName=bradlc.vscode-tailwindcss) extension for VSCode and add the following settings:
```json
```json [settings.json]
"files.associations": {
"*.css": "tailwindcss"
},

175
docs/content/1.getting-started/3.theme.md
View File

@@ -11,6 +11,9 @@ Nuxt UI v3 uses Tailwind CSS v4 beta, you can read the [prerelease documentation
Tailwind CSS v4 takes a CSS-first configuration approach, you now customize your theme with CSS variables inside a `@theme` directive:
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -33,6 +36,34 @@ Tailwind CSS v4 takes a CSS-first configuration approach, you now customize your
--color-green-950: #052E16;
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@theme {
--font-sans: 'Public Sans', sans-serif;
--breakpoint-3xl: 1920px;
--color-green-50: #EFFDF5;
--color-green-100: #D9FBE8;
--color-green-200: #B3F5D1;
--color-green-300: #75EDAE;
--color-green-400: #00DC82;
--color-green-500: #00C16A;
--color-green-600: #00A155;
--color-green-700: #007F45;
--color-green-800: #016538;
--color-green-900: #0A5331;
--color-green-950: #052E16;
}
```
:::
::
The `@theme` directive tells Tailwind to make new utilities and variants available based on these variables. It's the equivalent of the `theme.extend` key in Tailwind CSS v3 `tailwind.config.ts` file.
@@ -46,12 +77,27 @@ You can use the `@source` directive to add explicit content glob patterns if you
This can be useful when writing Tailwind classes in markdown files with [`@nuxt/content`](https://github.com/nuxt/content):
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@source "../content";
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@source "../content";
```
:::
::
::note{to="https://tailwindcss.com/docs/v4-beta#adding-content-sources"}
Learn how to add content sources in Tailwind CSS v4.
@@ -61,12 +107,27 @@ Learn how to add content sources in Tailwind CSS v4.
You can use the `@plugin` directive to import Tailwind CSS plugins.
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@plugin "@tailwindcss/typography";
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@plugin "@tailwindcss/typography";
```
:::
::
::note{to="https://tailwindcss.com/docs/v4-beta#using-plugins"}
Learn more about using plugins in Tailwind CSS v4.
@@ -214,6 +275,9 @@ These color aliases are not automatically defined as Tailwind CSS colors, so cla
However, you can generate these classes using Tailwind's `@theme` directive, allowing you to use custom color utility classes while maintaining dynamic color aliases:
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -232,6 +296,31 @@ However, you can generate these classes using Tailwind's `@theme` directive, all
--color-primary-950: var(--ui-color-primary-950);
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@theme {
--color-primary-50: var(--ui-color-primary-50);
--color-primary-100: var(--ui-color-primary-100);
--color-primary-200: var(--ui-color-primary-200);
--color-primary-300: var(--ui-color-primary-300);
--color-primary-400: var(--ui-color-primary-400);
--color-primary-500: var(--ui-color-primary-500);
--color-primary-600: var(--ui-color-primary-600);
--color-primary-700: var(--ui-color-primary-700);
--color-primary-800: var(--ui-color-primary-800);
--color-primary-900: var(--ui-color-primary-900);
--color-primary-950: var(--ui-color-primary-950);
}
```
:::
::
::
### Tokens
@@ -275,6 +364,9 @@ You can use these variables in classes like `text-[var(--ui-primary)]`, it will
::tip
You can change which shade is used for each color on light and dark mode:
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -287,6 +379,25 @@ You can change which shade is used for each color on light and dark mode:
--ui-primary: var(--ui-color-primary-200);
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
:root {
--ui-primary: var(--ui-color-primary-700);
}
.dark {
--ui-primary: var(--ui-color-primary-200);
}
```
:::
::
::
#### Neutral Palette
@@ -380,6 +491,9 @@ body {
::tip
You can customize these CSS variables to tailor the appearance of your application:
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -394,6 +508,27 @@ You can customize these CSS variables to tailor the appearance of your applicati
--ui-border: var(--ui-color-neutral-900);
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
:root {
--ui-bg: var(--ui-color-neutral-50);
--ui-text: var(--ui-color-neutral-900);
}
.dark {
--ui-bg: var(--ui-color-neutral-950);
--ui-border: var(--ui-color-neutral-900);
}
```
:::
::
::
#### Border Radius
@@ -413,6 +548,9 @@ Try the :prose-icon{name="i-lucide-swatch-book" class="text-[var(--ui-primary)]"
::tip
You can customize the default radius value using the default Tailwind CSS variables or a value of your choice:
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -421,6 +559,21 @@ You can customize the default radius value using the default Tailwind CSS variab
--ui-radius: var(--radius-sm);
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
:root {
--ui-radius: var(--radius-sm);
}
```
:::
::
::
#### Container
@@ -436,6 +589,9 @@ Nuxt UI uses a global `--ui-container` CSS variable to define the width of the c
::tip
You can customize the default container width using the default Tailwind CSS variables or a value of your choice:
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -448,6 +604,25 @@ You can customize the default container width using the default Tailwind CSS var
--ui-container: var(--container-8xl);
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@theme {
--container-8xl: 90rem;
}
:root {
--ui-container: var(--container-8xl);
}
```
:::
::
::
## Components theme

2
docs/content/1.getting-started/4.icons/1.nuxt.md
View File

@@ -124,6 +124,6 @@ Read more about this in the `@nuxt/icon` documentation.
## Theme
You can change the default icons used by Nuxt UI components in your `app.config.ts`:
You can change the default icons used by components in your `app.config.ts`:
:icons-theme

17
docs/content/1.getting-started/5.fonts.md
View File

@@ -13,6 +13,9 @@ links:
Nuxt UI automatically registers the [`@nuxt/fonts`](https://github.com/nuxt/fonts) module for you, so there's no additional setup required. To use a font in your Nuxt UI application, you can simply declare it in your CSS. It will be automatically loaded and optimized for you.
::module-only
#ui
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui";
@@ -21,6 +24,20 @@ Nuxt UI automatically registers the [`@nuxt/fonts`](https://github.com/nuxt/font
--font-sans: 'Public Sans', sans-serif;
}
```
:::
#ui-pro
:::div
```css [main.css]
@import "tailwindcss";
@import "@nuxt/ui-pro";
@theme {
--font-sans: 'Public Sans', sans-serif;
}
```
:::
::
You can disable the `@nuxt/fonts` module with the `ui.fonts` option in your `nuxt.config.ts`:

22
docs/nuxt.config.ts
View File

@@ -4,9 +4,9 @@ import pkg from '../package.json'
const { resolve } = createResolver(import.meta.url)
export default defineNuxtConfig({
// extends: [
// process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, 'docs') : process.env.NUXT_GITHUB_TOKEN && ['github:nuxt/ui-pro/docs#dev', { giget: { auth: process.env.NUXT_GITHUB_TOKEN } }]
// ],
extends: [
process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, 'docs') : process.env.NUXT_GITHUB_TOKEN && ['github:nuxt/ui-pro/docs#v3', { giget: { auth: process.env.NUXT_GITHUB_TOKEN } }]
],
modules: [
'../src/module',
@@ -26,6 +26,17 @@ export default defineNuxtConfig({
],
app: {
head: {
// LemonSqueezy affiliate
script: [{
key: 'lmsqueezy-config',
innerHTML: 'window.lemonSqueezyAffiliateConfig = { store: "nuxt" };'
}, {
key: 'lmsqueezy',
src: 'https://lmsqueezy.com/affiliate.js',
defer: true
}]
},
rootAttrs: {
'vaul-drawer-wrapper': '',
'class': 'bg-[var(--ui-bg)]'
@@ -85,7 +96,6 @@ export default defineNuxtConfig({
],
crawlLinks: true,
autoSubfolderIndex: false
// ignore: !process.env.NUXT_GITHUB_TOKEN ? ['/pro'] : []
},
cloudflare: {
pages: {
@@ -115,8 +125,8 @@ export default defineNuxtConfig({
'@nuxtjs/plausible',
'nuxt/dist',
'nuxt-og-image',
resolve('./app/components')
// process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, 'docs', 'components') : '.c12'
resolve('./app/components'),
process.env.NUXT_UI_PRO_PATH ? resolve(process.env.NUXT_UI_PRO_PATH, 'docs', 'components') : '.c12'
],
metaFields: {
type: false,

2
docs/package.json
View File

@@ -10,7 +10,7 @@
"@nuxt/content": "https://pkg.pr.new/@nuxt/content@c5b1a4f",
"@nuxt/image": "^1.8.1",
"@nuxt/ui": "latest",
"@nuxt/ui-pro": "https://pkg.pr.new/@nuxt/ui-pro@3c6070d",
"@nuxt/ui-pro": "https://pkg.pr.new/@nuxt/ui-pro@69c8478",
"@nuxthub/core": "^0.8.7",
"@nuxtjs/plausible": "^1.2.0",
"@octokit/rest": "^21.0.2",

3
package.json
View File

@@ -145,6 +145,7 @@
"@nuxt/ui": "workspace:*",
"happy-dom": "14.12.3",
"rollup": "^4.24.0",
"typescript": "5.6.3"
"typescript": "5.6.3",
"chokidar": "3.6.0"
}
}

531
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff