Skip to content

FabricElements/fabric-algolia

Repository files navigation

Build Status Published on webcomponents.org

<fabric-algolia>

fabric-algolia is a Polymer 3 Algolia search component.

Installation

Install fabric-algolia with npm

$ npm install FabricElements/fabric-algolia --save

Usage

Import it into the <head> of your page

<script type="module" src="node_modules/@fabricelements/fabric-algolia/fabric-algolia.js"></script>

Example: basic usage

<fabric-algolia application-id=""
                api-key=""
                index=""
                query=""
                response=""></fabric-algolia>
  • application-id (string) - Your Algolia Application ID.
  • api-key (string) - Your Algolia API key.
  • index (string) - Your Algolia records.
  • query (string) - Fields that should be include in the response.
  • response (object) - Algolia's response.

See demo file for examples.

Other attributes

  • settings (object) - Search settings.
  • error (object) - Error.

Events

  • error-changed - Fired when the error property has changed.
  • response-changed - Fired when the response property has changed.

Contributing

Please check CONTRIBUTING.

License

Released under the BSD 3-Clause License.