Nuxt Nation 大会即将到来。加入我们,时间为 11 月 12 日至 13 日。

meilisearch
nuxt-meilisearch

适用于 Nuxt 的 Meilisearch 即时搜索模块

xlanex6/nuxt-meilisearch

Latest Stable Version LicenseTwitter Follow

Nuxt Meilisearch

在您的 Nuxt 应用程序中快速集成 Meilisearch 高度相关的搜索引擎。

阅读 Nuxt Meilisearch 文档

功能

  • Nuxt 3 集成
  • 自动导入的组合式函数
  • 服务器端渲染支持
  • Meilisearch 的客户端和服务器集成
  • 完全支持 TypeScript
  • 兼容 Instant Meilisearch
  • Vue Algolia InstantSearch 组件(可选)

安装

安装 nuxt-meilisearch

# with npm
npm install nuxt-meilisearch

# with yarn
yarn add nuxt-meilisearch

# with pnpm
pnpm add nuxt-meilisearch

!警告 v1.0 在模块配置选项上引入了重大更改。

然后,更新您的 nuxt.config.ts

// nuxt.config.ts

export default defineNuxtConfig({
 modules: [
   'nuxt-meilisearch'
 ],
 meilisearch: {
   hostUrl:  '<your_meilisearch_host>', //required
   searchApiKey: '<public_search_api_key>', // required
   adminApiKey: '<admin_api_key>', // optional
   serverSideUsage: true // default: false
})

用法

此示例在 books 索引中执行搜索

<script setup>
const { search, result } = useMeiliSearch('books')

onMounted(async () => {
  await search('harry');
})
</script>

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

Nuxt Meilisearch 文档 中了解更多信息。

贡献

欢迎提出问题和发送拉取请求。🫶

本地开发

  • 运行 npm run dev:prepare 以生成类型存根。
  • 使用 npm run dev 以开发模式启动 游乐场

许可证

MIT 许可证