Easily add Algolia DocSearch to your Gatsby site.
Inspired by the code at https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-plugin-google-tagmanager
npm install --save gatsby-plugin-algolia-docsearch
How to use
// In your gatsby-config.jsplugins:resolve: `gatsby-plugin-algolia-docsearch`options:apiKey: "ALGOLIA_DOCUSEARCH_API_KEY" // requiredindexName: "ALGOLIA_DOCUSEARCH_INDEX_NAME" // requiredinputSelector: "ALGOLIA_DOCUSEARCH_INPUT_SELCTOR" // requireddebug: false // (bool) Optional. Default `false`;
inputSelector must be set. This plugin has been configured not to throw when one
of these is missing, rather, it will simply do nothing.
Now all that you need to do it add an
input type element anywhere on the page with a selector that matches the
field in your
options object to enjoy Algolia DocSearch in your Gatsby project!
This plugin uses the MutationObserver API to watch for changes to your
DOM tree and then call the
docsearch function once at least once instance of the element is found in the tree.
It's a pretty neat API with support for all browsers including IE11. (<= IE10 won't be able to use this plugin however)
A small amount of overhead may occur on initial load due to this function watching the DOM tree however, once the element is found successfully the observer is destroyed.