@nuxtjs/algolia

@nuxtjs/algolia

Algolia module for Nuxt

• ✨  Release Notes
• 📖  Read the documentation

Features

• Nuxt 3 ready
• Easy integration with Algolia
• Handy composables like useAlgolia, useSearch, etc
• [Coming soon] Support for Vue Instantsearch components
• Optional pages crawler support
• TypeScript support

📖  Read the documentation

Setup

WARNING: This package was recently moved to nuxt-community so it's name have changed from @nuxt-modules/algolia to @nuxtjs/algolia. There was no other changes than the name of the package.

yarn add @nuxtjs/algolia # yarn
npm i @nuxtjs/algolia # npm

Basic usage

Firstly, you need to add @nuxtjs/algolia to your Nuxt config.

// nuxt.config.js

{
    buildModules: [
        "@nuxtjs/algolia",
    ],
    algolia: {
        apiKey: "<YOUR_SEARCH_API_KEY>",
        applicationId: "<YOUR_APPLICATION_ID>",
    }
}

Then you can start using @nuxtjs/algolia in your setup function!

<script setup>
const { result, search } = useSearch("test_index"); // pass your index as param

onMounted(async () => {
  await search({ query: "Samsung" });
});
</script>

Development

• Clone this repository
• Install dependencies using yarn install or npm install
• Start development server using yarn dev or npm run dev

License

MIT License

Changelog

0.7.0 (2022-02-15)

Features

• 0.7.0-rc.1 (0d25d09)
• add docs about vue-instantsearch (d059205)
• add name change note (5d0638e)
• add optional types and gitignore (d7049b4)
• add styles (15ca72c)
• instantsearch (ba31313)
• update static assets (90922cc)
• update to nuxt-community (af94090)
• use new module builder (fa3983f)

Bug Fixes

• add default config to playground (5e23f0a)
• gh badges (01d8f1a)
• instantSearch default to false and theme name check (ba49f2f)
• readme & lockfile (cb84097)
• remove version bumps (a5f1447)
• update to new module builder (67918d2)