ngx-lunr

Demo

https://phillipcurl.github.io/ngx-lunr/

Table of contents

• About
• Installation
• Documentation
• Development
• License

About

A wrapper around Lunr.js for easy use in Angular apps.

Installation

Install through npm:

npm install --save ngx-lunr

Then include in your apps module:

import { Component, NgModule } from '@angular/core';
import { NgxLunrModule } from 'ngx-lunr';

@NgModule({
  imports: [
    NgxLunrModule.forRoot()
  ]
})
export class MyModule {}

Finally use in one of your apps components:

import { Component } from '@angular/core';

@Component({
  template: '<hello-world></hello-world>'
})
export class MyComponent {}

You may also find it useful to view the demo source.

Usage without a module bundler

<script src="node_modules/ngx-lunr/bundles/ngx-lunr.umd.js"></script>
<script>
    // everything is exported ngxLunr namespace
</script>

Documentation

All documentation is auto-generated from the source via compodoc and can be viewed here: https://phillipcurl.github.io/ngx-lunr/docs/

Development

Prepare your environment

• Install Node.js and yarn
• Install local dev dependencies: yarn while current directory is this repo

Development server

Run yarn start to start a development server on port 8000 with auto reload + tests.

Testing

Run yarn test to run tests once or yarn run test:watch to continually run tests.

Release

• Bump the version in package.json (once the module hits 1.0 this will become automatic)

yarn run release

License

MIT