algolia
@nuxtjs/algolia

用於 Nuxt 的 Algolia 搜尋模組

@nuxtjs/algolia

@nuxtjs/algolia

npm versionnpm downloadsGithub Actions CICodecovLicense

適用於 NuxtAlgolia 模組

功能

  • 輕鬆整合 Algolia
  • 便捷的組合式函式,例如 useAlgoliaSearch、useAsyncAlgoliaSearch
  • 支援 Vue Instantsearch 元件
  • 支援 Algolia Recommend
  • 支援 Docsearch
  • 支援自動索引
  • 支援快取請求和響應
  • 支援 SSR 請求

📖  閱讀文件

預覽

Open in StackBlitz

設定

npx nuxi@latest module add algolia

基本用法

ALGOLIA_API_KEYALGOLIA_APPLICATION_ID 環境變數新增到 .env 檔案中。

ALGOLIA_API_KEY="0fd1c4eba2d831788333e77c9d855f1d"
ALGOLIA_APPLICATION_ID="AGN9HEEKF3"

現在你可以在你的應用中開始使用 @nuxtjs/algolia 了!

客戶端

<script setup lang="ts">
const { result, search } = useAlgoliaSearch('test_index')

onMounted(async () => {
  await search({ query: 'Samsung' })
})
</script>

<template>
  <div>{{ result }}</div>
</template>

或 SSR

<script setup lang="ts">
const { data } = await useAsyncAlgoliaSearch({ indexName: 'test_index', query: 'Samsung' })
</script>

<template>
  <div>{{ data }}</div>
</template>

開發

  1. 克隆此倉庫
  2. 使用 yarn installnpm install 安裝依賴項
  3. 使用 yarn dev:preparenpm run dev:prepare 來準備開發環境
  4. 使用 yarn devnpm run dev 啟動開發伺服器

許可證

麻省理工學院許可證