Nuxt Headless UI

Headless UI 適用於 Nuxt 的整合。完全沒有樣式、完全可存取的 UI 元件，旨在與 Tailwind CSS 美好地整合。

Vue 的 Headless UI 文件：https://headlessui.dev.org.tw/vue/menu

功能

自動動態導入 (沒有全域元件)
完全型別安全
可配置的元件前綴 (預設為 Headless)

快速設定

將 nuxt-headlessui 依賴項新增至您的專案

# Using pnpm
pnpm add -D nuxt-headlessui

# Using yarn
yarn add --dev nuxt-headlessui

# Using npm
npm install --save-dev nuxt-headlessui

將 nuxt-headlessui 新增至 nuxt.config.ts 的 modules 區段

{
    modules: [
        'nuxt-headlessui'
    ],

    // Optionally change the default prefix.
    headlessui: {
        prefix: 'Headless'
    }
}

將以下程式碼新增至 app.vue 檔案內的 <script setup> 中

// Use SSR-safe IDs for Headless UI
provideHeadlessUseId(() => useId())

這是為了避免因 ID 不符而導致的 hydration 問題所必需的。這兩個 composable 都會由 Nuxt 自動導入。provideHeadlessUseId composable 是來自 @headlessui/vue 的 provideUseId composable 的別名。import { provideUseId } from '@headlessui/vue' 直接使用不會直接運作。

就這樣！您現在可以在 Nuxt 應用程式中使用 Headless UI 了✨

用法

完成設定後，只需在元件和頁面中使用 headless 元件，並使用您最喜歡的 CSS 框架為它們設定樣式。您不必導入這些元件。以下是一個 Listbox (Select) 的範例，它使用 heroicons 和 Tailwind CSS

<template>
  <div class="container mx-auto">
    <div class="w-72">
      <HeadlessListbox v-model="selectedPerson">
        <div class="relative mt-1">
          <HeadlessListboxButton
            class="relative w-full cursor-default rounded-lg bg-white py-2 pl-3 pr-10 text-left shadow-md focus:outline-none focus-visible:border-indigo-500 focus-visible:ring-2 focus-visible:ring-white focus-visible:ring-opacity-75 focus-visible:ring-offset-2 focus-visible:ring-offset-orange-300 sm:text-sm"
          >
            <span class="block truncate">{{ selectedPerson.name }}</span>
            <span
              class="pointer-events-none absolute inset-y-0 right-0 flex items-center pr-2"
            >
              <ChevronUpDownIcon
                class="h-5 w-5 text-gray-400"
                aria-hidden="true"
              />
            </span>
          </HeadlessListboxButton>

          <transition
            leave-active-class="transition duration-100 ease-in"
            leave-from-class="opacity-100"
            leave-to-class="opacity-0"
          >
            <HeadlessListboxOptions
              class="absolute mt-1 max-h-60 w-full overflow-auto rounded-md bg-white py-1 text-base shadow-lg ring-1 ring-black ring-opacity-5 focus:outline-none sm:text-sm"
            >
              <HeadlessListboxOption
                v-for="person in people"
                v-slot="{ active, selected }"
                :key="person.name"
                :value="person"
                as="template"
              >
                <li
                  :class="[
                    active ? 'bg-amber-100 text-amber-900' : 'text-gray-900',
                    'relative cursor-default select-none py-2 pl-10 pr-4',
                  ]"
                >
                  <span
                    :class="[
                      selected ? 'font-medium' : 'font-normal',
                      'block truncate',
                    ]"
                  >{{ person.name }}</span>
                  <span
                    v-if="selected"
                    class="absolute inset-y-0 left-0 flex items-center pl-3 text-amber-600"
                  >
                    <CheckIcon class="h-5 w-5" aria-hidden="true" />
                  </span>
                </li>
              </HeadlessListboxOption>
            </HeadlessListboxOptions>
          </transition>
        </div>
      </HeadlessListbox>
    </div>
  </div>
</template>

<script setup>
import { ref } from 'vue'
import { CheckIcon, ChevronUpDownIcon } from '@heroicons/vue/20/solid'

const people = [
  { name: 'Wade Cooper' },
  { name: 'Arlene Mccoy' },
  { name: 'Devon Webb' },
  { name: 'Tom Cook' },
  { name: 'Tanya Fox' },
  { name: 'Hellen Schmidt' }
]
const selectedPerson = ref(people[0])
</script>

如果您正在使用 Tailwind CSS，您可以使用 @headlessui/tailwindcss 外掛程式來取得像 ui-open:* 和 ui-active:* 這樣的修飾符。

開發

# Install dependencies
pnpm install

# Generate type stubs
pnpm run dev:prepare

# Develop with the playground
pnpm run dev

# Build the playground
pnpm run dev:build

# Run ESLint
pnpm run lint