Nuxt Meilisearch
Getting Started

Setup

Add nuxt-meilisearch to your Nuxt project

Check the Nuxt documentation for more information about installing and using modules.

Installation

Add nuxt-meilisearch using the Nuxt CLI:

npx nuxi@latest module add nuxt-meilisearch

Or install it with your package manager:

# npm
npm install nuxt-meilisearch

# yarn
yarn add nuxt-meilisearch

# pnpm
pnpm add nuxt-meilisearch

Then register the module in nuxt.config.ts:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-meilisearch'],
})

Basic setup

Client side only

Provide your Meilisearch host URL and search API key:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-meilisearch'],
  meilisearch: {
    hostUrl: 'https://my-meilisearch-server.example.com',
    searchApiKey: '<your_search_key>',
  },
})

Advanced setup

Client + server side

Enable server-side usage and optional InstantSearch integration:

nuxt.config.ts
export default defineNuxtConfig({
  modules: ['nuxt-meilisearch'],
  meilisearch: {
    hostUrl: 'https://my-meilisearch-server.example.com',
    searchApiKey: '<your_search_key>',
    adminApiKey: '<your_admin_key>',
    instantSearch: true,
    serverSideUsage: true,
  },
})

For InstantSearch theme customization, see the Advanced guide.

Basic

You can use Meilisearch's power with all composables available in this package.