ngx-elasticlunr
v0.0.1
Published
A wrapper around Elasticlunr.js for easy use in Angular apps.
Downloads
5
Readme
ngx-elasticlunr
Demo
https://phillipcurl.github.io/ngx-elasticlunr/
Table of contents
About
A wrapper around Elasticlunr.js for easy use in Angular apps.
Installation
Install through npm:
npm install --save ngx-elasticlunr
Then include in your apps module:
import { Component, NgModule } from '@angular/core';
import { NgxElasticlunrModule } from 'ngx-elasticlunr';
@NgModule({
imports: [
NgxElasticlunrModule.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-elasticlunr/bundles/ngx-elasticlunr.umd.js"></script>
<script>
// everything is exported ngxElasticlunr namespace
</script>
Documentation
All documentation is auto-generated from the source via compodoc and can be viewed here: https://phillipcurl.github.io/ngx-elasticlunr/docs/
Development
Prepare your environment
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