带有 Vue & UI Pro 的仪表板模板

meilisearch
meilisearch

Meilisearch 的 Nuxt 即时搜索模块

xlanex6/nuxt-meilisearch

nuxt-meilisearch

Latest Stable Version LicenseTwitter Follow


Meilisearch 模块,适用于 Nuxt

完整文档

访问模块文档网站 以查看所有 功能 详细信息。

功能

  • 完整 Nuxt 3 集成
  • 自动导入可组合函数 useMeiliSearchuseAsyncMeiliSearch 用于 SSR 使用
  • 从 Nuxt 服务器端管理 Meilisearch
  • 完全支持 TypeScript
  • 轻松集成 MeilisearchJS 库
  • 支持 Vue Algolia InstantSearch 组件(可选)

⚠️⚠️⚠️ 模块配置的重大变更,从之前的版本开始 ⚠️⚠️⚠️

此模块的 1.0.0 版本在模块配置方面引入了重大变更。

设置

安装 nuxt-meilisearch!

npm install --save-dev nuxt-meilisearch  // yarn add --dev nuxt-meilisearch

将其添加到 nuxt.config.ts 的 modules 部分

nuxt.config.ts
export default defineNuxtConfig({
 modules: [
   'nuxt-meilisearch'
 ],
 meilisearch: {
   hostUrl:  'http://my-meilisearch-server.domain.com', //required
   searchApiKey: '<your_public_key>', // required
   adminApiKey: '<your_secret_key>', // optional
   serverSideUsage: true // default false
})

用法

您可以使用 composables 加载 Meilisearch 客户端

pages/index.vue
<script setup>
const { search, result } = useMeiliSearch('books') // `books` is the index name

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

开发

欢迎 PR 和 ISSUES

  • 运行 npm run dev:prepare 生成类型存根。
  • 使用 npm run dev 在开发模式下启动 playground

许可证

MIT 许可证