@nuxtjs/algolia
TypeScript icon, indicating that this package has built-in type declarations

1.10.2 • Public • Published

@nuxtjs/algolia

@nuxtjs/algolia

npm version npm downloads Github Actions CI Codecov License

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

Package Sidebar

Install

npm i @nuxtjs/algolia

Weekly Downloads

4,601

Version

1.10.2

License

MIT

Unpacked Size

103 kB

Total Files

27

Last publish

Collaborators

  • damianglowala
  • gugustinette
  • antfu
  • danielroe
  • clarkdo
  • pi0
  • atinux
  • alexchopin
  • baroshem