https://github.com/fabricelements/fabric-algolia
Algolia search for polymer projects
https://github.com/fabricelements/fabric-algolia
algolia polymer search web-component web-components
Last synced: about 1 month ago
JSON representation
Algolia search for polymer projects
- Host: GitHub
- URL: https://github.com/fabricelements/fabric-algolia
- Owner: FabricElements
- License: bsd-3-clause
- Created: 2017-09-04T17:23:00.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2019-07-15T16:15:20.000Z (almost 7 years ago)
- Last Synced: 2025-01-27T08:31:32.759Z (over 1 year ago)
- Topics: algolia, polymer, search, web-component, web-components
- Language: HTML
- Size: 55.7 KB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://travis-ci.org/FabricElements/fabric-algolia)
[](https://www.webcomponents.org/element/FabricElements/fabric-algolia)
## \
`fabric-algolia` is a [Polymer 3](http://polymer-project.org) Algolia search component.
## Installation
Install `fabric-algolia` with npm
```shell
$ npm install FabricElements/fabric-algolia --save
```
## Usage
Import it into the `` of your page
```html
```
### Example: basic usage
```html
```
* `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](./demo/index.html) 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](./CONTRIBUTING.md).
## License
Released under the [BSD 3-Clause License](./LICENSE.md).