Instant code highlighting, auto-detect language, super easy to use
Install with NPM
npm i ngx-highlightjsimport { HighlightModule } from 'ngx-highlightjs';
@NgModule({
imports: [
HighlightModule
]
})
export class AppModule { }Note: By default this will lazy-load highlight.js bundle library including all languages.
To avoid import everything from highlight.js library, you should import each language you want to highlight manually.
To do so, use the injection token HIGHLIGHT_OPTIONS to provide options:
import { HighlightModule, HIGHLIGHT_OPTIONS } from 'ngx-highlightjs';
/**
* Import specific languages to avoid importing everything
* The following will lazy load highlight.js core script (~9.6KB) + the selected languages bundle (each lang. ~1kb)
*/
export function getHighlightLanguages() {
return {
typescript: () => import('highlight.js/lib/languages/typescript'),
css: () => import('highlight.js/lib/languages/css'),
xml: () => import('highlight.js/lib/languages/xml')
};
}
@NgModule({
imports: [
HighlightModule
],
providers: [
{
provide: HIGHLIGHT_OPTIONS,
useValue: {
languages: getHighlightLanguages()
}
}
],
})
export class AppModule {
}- languages: The set of languages to register.
- lineNumbers: Lazy-load lines numbers library which adds line numbers to the highlighted code element.
- config: Set highlight.js config, see configure-options.
Import highlight.js theme from the node_modules directory in angular.json
"styles": [
"styles.css",
"../node_modules/highlight.js/styles/github.css",
]
Or import it in src/style.scss
@import '~highlight.js/styles/github.css';List of all available themes from highlight.js
The following line will highlight the given code and append it to the host element
<pre><code [highlight]="code"></code></pre>-
[highlight]: (string), Accept code string to highlight, default
null -
[languages]: (string[]), An array of language names and aliases restricting auto detection to only these languages, default:
null -
[lineNumbers]: (boolean), A flag that indicates adding line numbers to highlighted code element
-
(highlighted): Stream that emits
HighlightResultobject when element is highlighted.
In version >= 4, a new sub-package were added with the following features:
- Highlight gists using gists API
- Highlight code directly from URL
import { HighlightPlusModule } from 'ngx-highlightjs/plus';
@NgModule({
imports: [
HighlightPlusModule
]
})
export class AppModule {
}- Use
[gist]directive with the gist id to get the response through the output(gistLoaded). - Once
(gistLoaded)emits, you will get access to the gist response. - Use
gistContentpipe to extract the file content from gist response using gist file name.
Example:
<pre [gist]="gistId" (gistLoaded)="gist = $event">
<code [highlight]="gist | gistContent: 'main.js'"></code>
</pre>To loop over gist?.files, use keyvalue pipe to pass file name into gistContent pipe.
Example:
<ng-container [gist]="gistId" (gistLoaded)="gist = $event">
<pre *ngFor="let file of gist?.files | keyvalue">
<code [highlight]="gist | gistContent: file.key"></code>
</pre>
</ng-container>Use the pipe codeFromUrl with the async pipe together to get the code text from a raw URL.
Example:
<pre>
<code [highlight]="codeUrl | codeFromUrl | async"></code>
</pre>This project uses Angular CLI to build the package.
$ ng build ngx-highlightjsIf you identify any errors in the library, or have an idea for an improvement, please open an issue.
Murhaf Sousli