@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
• Support for Vue Instantsearch components
• Support for Algolia Recommend
• Optional pages crawler support
• TypeScript support

📖  Read the documentation

Preview

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.9.0 (2022-04-27)

Features

• component: import initial implementation for the component (48cd3e4)
• doc-search: add DocSearchOptions type and use it in ModuleOptions (46a2c5a)
• doc-search: update DocSearch component (c551950)
• docsearch: change options priority (e018b81)
• docsearch: defaults apiKey and applicationId to global ones (4ee3ffb)
• docsearch: rename component (add Algolia prefix) (43cd2cb)
• docsearch: update docsearch implementation (c82e46a)
• docsearch: update imports and fix typo (review) (1433572)
• module: add docSearch config option, push components dir if true (b56b6a9)
• playground: update playground (da6fa7e)
• playground: update playground to show docSearch feature (bb4f516)
• rc (8416d72)
• small adjustements after docsearch (11bc881)

Bug Fixes

• build: update build externals to support @docsearch (cf17c28)
• fixed issue templates (a343047)
• provided compatibility options (f744382)
• types: fix typo (2f19c76)