niceone-algolia

0.1.0 • Public • Published

niceone-algolia

npm version npm downloads Github Actions CI Codecov License

Simple wrapper/integration for Algolia InstantSearch.

📖 Release Notes

Setup

  1. Add niceone-algolia dependency to your project
yarn add niceone-algolia # or npm install niceone-algolia
  1. Add niceone-algolia to the modules section of nuxt.config.js
{
  modules: [
    'niceone-algolia'
  ],

  publicRuntimeConfig: {
    algolia: {
      applicationId: [YOUR APPLICATION ID],
      apiKey: [YOUR API KEY],
    }
  }
}

Usage

Component

asyncData

async asyncData ({ $algolia }) {
  const index = $algolia.initIndex('instant_search');
  const results = await index.search('Google');
  return results;
}

methods/created/mounted/etc

methods: {
  async fetchResults(query) {
    const index = this.$algolia.initIndex('instant_search');
    this.results = await index.search(query);
  }
}

Store actions (including nuxtServerInit)

// In store
{
  actions: {
    async fetchGoogleProducts ({ commit }) {
      const index = this.$algolia.initIndex('instant_search');
      const products = await index.search('Google');
      commit('SET_PRODUCTS', products);
    }
  }
}

Development

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

License

MIT License

Readme

Keywords

none

Package Sidebar

Install

npm i niceone-algolia

Weekly Downloads

0

Version

0.1.0

License

MIT

Unpacked Size

5.68 kB

Total Files

5

Last publish

Collaborators

  • shoaibkhandev