Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@algolia/algoliasearch-netlify-frontend

Package Overview
Dependencies
Maintainers
60
Versions
34
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@algolia/algoliasearch-netlify-frontend

`algoliasearch-netlify` is the front-end bundle we recommend to use with our Netlify plugin. It's designed to be compatible with the index structure extracted by the [plugin](../plugin).

  • 0.0.2
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
132
increased by175%
Maintainers
60
Weekly downloads
 
Created
Source

algoliasearch-netlify

algoliasearch-netlify is the front-end bundle we recommend to use with our Netlify plugin. It's designed to be compatible with the index structure extracted by the plugin.

Usage

<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@algolia/algoliasearch-netlify@0/dist/algoliasearchNetlify.css" />
<script type="text/javascript" href="https://cdn.jsdelivr.net/npm/@algolia/algoliasearch-netlify@0/dist/algoliasearchNetlify.js"></script>
<script type="text/javascript">
  algoliasearchNetlify({
    appId: '<YOUR_ALGOLIA_APP_ID>',
    apiKey: '<YOUR_ALGOLIA_API_KEY>',
    indexName: 'netlify_<YOUR_NETLIFY_SITE_ID>_<YOUR_BRANCH>',
  });
</script>

Scripts

  • yarn dev: run dev environment
  • yarn release: build & publish the library

Available options

Here's the full list of options with their default value.

algoliasearchNetlify({
  // Mandatory
  appId: '<YOUR_ALGOLIA_APP_ID>',                             // Application ID (Can be found in https://www.algolia.com/api-keys)
  apiKey: '<YOUR_ALGOLIA_API_KEY>',                           // Search api key (Can be found in https://www.algolia.com/api-keys)
  indexName: 'netlify_<YOUR_NETLIFY_SITE_ID>_<YOUR_BRANCH>',  // Index name (Can be found in https://www.algolia.com/indexes)

  // Optional
  analytics: true,                                            // Enable search analytics
  autocomplete: {
    hitsPerPage: 5,                                           // Amount of results to display
    inputSelector: 'input[type=search]',                      // CSS selector of your search input(s)
  },
  color: '#3c4fe0',                                           // Main color
  debug: false,                                               // Debug mode (keeps the autocomplete open)
  poweredBy: true,                                            // Controls displaying the logo (mandatory with our FREE plan)
});

Development

yarn dev

This runs a webpack-dev-server on port 9100. Meant to be used in conjunction with the test website.

Releasing

FAQs

Package last updated on 27 Sep 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc