Skip to content
/ ng-suggest Public

AngularJS module to provide Typeahead via OpenSearch Suggestions

Notifications You must be signed in to change notification settings

gbv/ng-suggest

Repository files navigation

ng-suggest

AngularJS module to provide Typeahead via OpenSearch Suggestions

npm version Build Status Test Coverage GitHub Issues

ng-suggest is a module for AngularJS to facilitate the use of OpenSearch Suggestions and SeeAlso links in web application.

Install

npm

npm install ng-suggest --save

bower

bower install ng-suggest --save

Usage

See https://gbv.github.io/ng-suggest/ for documentation and usage examples!

Customization

To support APIs that do not strictly follow OpenSearch Suggest specification, the {@link ng-suggest.service:OpenSearchSuggestions OpenSearchSuggestions} service can be customized with a transformation function. The {@link ng-suggest.directive:suggest-typeahead suggest-typeahead} directive contains a default template that can be replaced or styled with CSS.

Contributing

See CONTRIBUTING.md for development documentation. Contributions and feedback is appreciated!

Contributors

License

Code licensed under the AGPL. Documentation licensed under CC BY 3.0.