podlebar/algolia-module

🔎 Algolia module for Nuxt

@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
• Support for Vue Instantsearch components
• Support for Algolia Recommend
• Support for Docsearch
• Support for Automatic Indexing
• TypeScript support

📖  Read the documentation

Preview

Setup

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

{
    modules: [
        "@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 } = useAlgoliaSearch("test_index"); // pass your index as param

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

Development

1. Clone this repository
2. Install dependencies using yarn install or npm install
3. Start development server using yarn dev or npm run dev

License

MIT License