Skip to content

Latest commit

 

History

History
64 lines (46 loc) · 1.22 KB

README.md

File metadata and controls

64 lines (46 loc) · 1.22 KB

ngx-markjs

It is Angular 14 wrapper for very cool text highlighting lib Mark.js

How to use

Install

npm i mark.js
npm i ngx-markjs

Import module

...
import {NgxMarkjsModule} from 'ngx-markjs';

@NgModule({
...
  imports: [
...
    NgxMarkjsModule
  ],
...
})
export class AppModule { }

Use directive

<div class="content_wrapper" 
     [markjsHighlight]="searchText"
     [markjsConfig]="config"
     [scrollToFirstMarked]="true"
>

If you want to use it from source code

Incase of some compilation issues you can try to import ngxMarkjsModule directly in your application from .ts file

import {NgxMarkjsModule} from 'ngx-markjs/src/public-api'; 

But in that case you should include path to module in tsconfig.json ('include' section).

Start demo project

Clone this repo and do install

npm install

ng serve

demo app

Additional mark.js config params can be found on its officail site

Did you Like this lib? Follow me on Twitter for more Angular and RxJS staff!

Need a mentorship for Angular and RxJS? Find me on codementor.io