Nuxt3 中文课程《实战全栈开发简书》限时优惠

This module is not yet compatible with Nuxt 3

Head over to v2.nuxt.com

algolia
algolia

Algolia Search Module for Nuxt

@nuxtjs/algolia

@nuxtjs/algolia

npm versionnpm downloadsGithub Actions CICodecovLicense

Algolia module for Nuxt

Features

  • Easy integration with Algolia
  • Handy composables like useAlgoliaSearch, useAsyncAlgoliaSearch
  • Support for Vue Instantsearch components
  • Support for Algolia Recommend
  • Support for Docsearch
  • Support for Automatic Indexing
  • Support for caching the requests and responses
  • Support for SSR requests

📖  Read the documentation

Preview

Open in StackBlitz

Setup

npx nuxi@latest module add algolia

Basic usage

Add ALGOLIA_API_KEY and ALGOLIA_APPLICATION_ID environment variables to .env file.

ALGOLIA_API_KEY="0fd1c4eba2d831788333e77c9d855f1d"
ALGOLIA_APPLICATION_ID="AGN9HEEKF3"

Now you can start using @nuxtjs/algolia in your app!

Client side:

<script setup lang="ts">
const { result, search } = useAlgoliaSearch('test_index')

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

<template>
  <div>{{ result }}</div>
</template>

Or SSR:

<script setup lang="ts">
const { data } = await useAsyncAlgoliaSearch({ indexName: 'test_index', query: 'Samsung' })
</script>

<template>
  <div>{{ data }}</div>
</template>

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