Check the Nuxt.js documentation for more information about installing and using modules in Nuxt.js.
Add nuxt-meilisearch using the Nuxt CLI to your project
npx nuxi@latest module add nuxt-meilisearch
or add nuxt-meilisearch using your dependency manager
# with npm
npm install nuxt-meilisearch
# with yarn
yarn add nuxt-meilisearch
# with pnpm
pnpm add nuxt-meilisearch
and then to the modules section of nuxt.config.ts:
export default defineNuxtConfig({
...
modules: [
'nuxt-meilisearch'
],
...
The basic setup is to provide the host url and the search api key.
...
meilisearch: {
hostUrl: 'http://my-meilisearch-server.domain.com' //reqired
searchApiKey: '<your_search_key>' // reqired
}
...
})
You can customization Meilisearch client meilisearchConfig.
Full documentation on Meiliserch client page for more details.
import { defineNuxtConfig } from 'nuxt'
export default defineNuxtConfig({
...
modules: [
'nuxt-meilisearch'
],
meilisearch: {
hostUrl: 'http://my-meilisearch-server.domain.com'
searchApiKey: '<your_search_key>',
adminApiKey: '<your_admin_key>',
instantSearch: true, // default false
serverSideUsage: false// default false
}
...
})