学习 Nuxt,包含 100+ 个技巧!

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 在开发模式下启动 playground

许可证

MIT 许可证