@nuxt-commerce/algolia

@nuxt-commerce/algolia

Algolia module for Nuxt 3

• ✨  Release Notes
• 📖  Read the documentation

Features

• Nuxt 3 ready
• Easy integration with Algolia
• Handy composables like useAlgolia, useSearch, etc
• TypeScript support

📖  Read the documentation

Setup

yarn add @nuxt-commerce/algolia # yarn
npm i @nuxt-commerce/algolia # npm

Basic usage

Firstly, you need to add @nuxt-commerce/algolia to your Nuxt config.

// nuxt.config.js

{
  modules: [
    [
      '@nuxt-commerce/algolia',
      {
        apiKey: '<YOUR_SEARCH_API_KEY>',
        applicationId: '<YOUR_APPLICATION_ID>'
      }
    ]
  ]
}

Then you can start using @nuxt-commerce/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.2.0 (2022-01-10)

Features

• add types for result and req opts (0a39cb3)
• new composable useInitIndex (0655cd8)
• rc version (244f3fd)
• run lint (8358ac6)
• update docs (93d6783)
• update example with new data (c7871b9)
• useInitIndex & req opts in search (0de06cf)