https://github.com/charizard/ember-cli-lunr
Simple full-text search for ember-cli apps using lunr.js
https://github.com/charizard/ember-cli-lunr
ember-addon ember-cli-addon emberjs lunr search search-in-text
Last synced: about 2 months ago
JSON representation
Simple full-text search for ember-cli apps using lunr.js
- Host: GitHub
- URL: https://github.com/charizard/ember-cli-lunr
- Owner: Charizard
- License: mit
- Created: 2016-05-30T18:21:41.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2019-04-01T23:43:32.000Z (over 6 years ago)
- Last Synced: 2024-09-22T13:02:07.066Z (about 1 year ago)
- Topics: ember-addon, ember-cli-addon, emberjs, lunr, search, search-in-text
- Language: JavaScript
- Homepage: http://lunrjs.com/
- Size: 194 KB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ember-cli-lunr
[](https://badge.fury.io/js/ember-cli-lunr) [](https://codeclimate.com/github/Charizard/ember-cli-lunr) [](https://travis-ci.org/Charizard/ember-cli-lunr)
Simple full-text search for ember-cli apps using [lunr.js](http://lunrjs.com/).
## Description
This is a ember-cli wrapper for [lunr.js]( https://github.com/olivernn/lunr.js ), a small full-text search library for use in the browser. It indexes JSON documents and provides a simple search interface for retrieving documents that best match text queries.
## Installation
Installing the library is as easy as:
```bash
ember install ember-cli-lunr
```
## Configuring
Lunr 2.0 uses immutable index, so, you'll have to have an array of items to be searched beforehand. For usage with Lunr 1.0, see [0.0.5](https://github.com/Charizard/ember-cli-lunr/tree/v0.0.5) of this add-on.
Given a model named post,
```js
// app/pods/post/model.js
import DS from 'ember-data';
export default DS.Model.extend({
title: DS.attr('string'),
body: DS.attr('string'),
});
```
First, you'll have to create an index with the documents (keep in mind indexes are immutable) using the Lunr class,
```js
import Lunr from 'ember-cli-lunr/lunr';
...
// Pass in models to create method, this indexes all properties on the model.
let posts = Lunr.create({ models: get(this, 'posts') });
// Or you could specify just the properties that you want to index via the properties key.
let posts = Lunr.create({ models: get(this, 'posts'), properties: ['title'] });
```
Now, you can search anywhere in your app using the `search` method. This method is just a wrapper around lunr.js [search](https://lunrjs.com/docs/lunr.Index.html) method. For more advanced searching, checkout the lunr.js [guides](https://lunrjs.com/guides/searching.html#scoring).
```js
posts.search('lorem ipsum');
```
Putting this all together in a controller,
```js
// app/pods/posts/controller.js
import Controller from '@ember/controller';
import { get, set } from '@ember/object';
import Lunr from 'ember-cli-lunr/lunr';
export default Controller.extend({
// assuming posts array was set on controller from
// setupController in route.
posts: null,
searchQuery: null,
init() {
this._super(...arguments);
let postsIndex = Lunr.create({ models: get(this, 'posts') });
set(this, 'postsIndex', postsIndex);
},
result: computed('searchQuery', function() {
var query = this.get('searchQuery'),
resultIds = get(this, 'postsIndex').search(query).mapBy('ref');
return items.filter(function(item) {
return resultIds.contains(item.get('id'));
});
});
});
```
## Support
Please leave a :star: to show some support. Thanks!