angular-markdown-editor

Angular-Markdown-Editor

This package includes a few libraries and tools to make a more convenient "all in one" WYSIWYG Markdown Editor with preview. All of that bundled into a simple Angular Component. This package can be useful for online documentation and/or anything similar (docs, blog, ...).

License

MIT License

Like it? :star: it

You like to use Angular-Markdown-Editor? Be sure to upvote :star: the, also maybe support me with cafeine :coffee: and feel free to contribute. 👷👷‍♀️

Angular Compatibility

• version 1.x for AngularJS 1.x (EOL)
• version 2.x for Angular >= 4.x
  • requires Bootstrap 3.x
• version 3.x for Angular >= 14.x
  • Ivy only
  • this version works with Bootstrap 4 and 5

Dependencies

Here is the list of required dependencies

• Bootstrap-Markdown (editor) itself
• jQuery (required for Bootstrap-Markdown editor)
• Bootstrap >=4.x

Nice to have Dependency

It's a "nice to have" extra, but not a hard dependency, which is to include the ngx-markdown library. It is used in the demo of this package, but technically you could plug any other library that you wish for dealing with the markdown preview.

Demo page

Standalone demo project, with Angular 14 & Bootstrap 5, that you can clone to easily get started

• Bootstrap 5 demo / examples repo

Installation

NPM Package

Angular-Markdown-Editor on NPM

Install through NPM or Yarn

npm install angular-markdown-editor

# or with Yarn
yarn add angular-markdown-editor

Modify your angular.json config

You need to add the necessary CSS Styles for Bootstrap, Markdown Editor and Font-Awesome v4.7. Also make sure to include the proper 3rd party javascript libraries in your scripts as shown below.

"styles": [
    "node_modules/bootstrap/dist/css/bootstrap.css",
    "node_modules/bootstrap-markdown/css/bootstrap-markdown.min.css",
    "node_modules/font-awesome/css/font-awesome.css"
],
"scripts": [
    "node_modules/jquery/dist/jquery.js",
    "node_modules/bootstrap-markdown/js/bootstrap-markdown.js"
],

When using ngx-markdown and/or Prism.js

Prism.js uses separate javascript file for each language, so you'll need to add them yourself. For example, we are showing below the highlight of CSS, JavaScript and TypeScript language:

"styles": [
    "node_modules/prismjs/themes/prism.css"
],
"scripts": [
    "node_modules/prismjs/prism.js",
    "node_modules/prismjs/components/prism-css.min.js",
    "node_modules/prismjs/components/prism-javascript.min.js",
    "node_modules/prismjs/components/prism-typescript.min.js"
],

Import Module

import { AngularMarkdownEditorModule } from 'angular-markdown-editor';

@NgModule({
  declarations: [],
  imports: [AngularMarkdownEditorModule]

  // or pre-define global configuration using the forRoot
  // imports: [AngularMarkdownEditorModule.forRoot({ iconlibrary: 'fa' })]
});

Input attributes

You can pass the following input attribute:

attribute	type	required	comments
textareaId	string	yes	id of the textarea DOM element used by the lib
rows	number	no	number of rows for the textarea, defaults to 10
options	mixed	no	markdown Editor Options to pass to the element
locale	EditorLocale	no	locale set that has a language and dictionary that can be added as an alternative language. Can be 1 or more dictionaries

Global Options

The library comes with it's own Global Editor Options, these propertoes can be overriden at any by the options attribute. Click to see the Global Options defined.

Event Hooks

You can hook to any of the Bootstrap Markdown Editor Events through 2 ways, just choose the one you prefer:

1. Dispatch of Custom Event

Each of the events are available in the View from a Custom Event as (onX)="doSomething()", for example:

<angular-markdown-editor
  textareaId="editor1" rows="12"
  name="markdownText" [(ngModel)]="markdownText"
  (onFullscreenExit)="hidePreview()">
</angular-markdown-editor>

export class MyComponent {
  hidePreview() { console.log(e.getContent()); }
}

You can also pass the Event returned by the Editor via $event.detail.eventData

<angular-markdown-editor
  textareaId="editor1" rows="12"
  name="markdownText" [(ngModel)]="markdownText"
  (onChange)="onChange($event.detail.eventData)">
</angular-markdown-editor>

export class MyComponent {
  onChange(e) {
    console.log(e.getContent());
  }
}

2. Editor Option Callbacks

The second way is to use the callback directly when defining the Editor Options.

<angular-markdown-editor
  textareaId="editor1" rows="12"
  name="markdownText" [(ngModel)]="markdownText"
  [options]="editorOptions">
</angular-markdown-editor>

import { EditorOption } from 'angular-markdown-editor';
export class MyComponent {
  ngOnInit() {
    this.editorOptions: EditorOption = {
      iconlibrary: 'fa',
      onChange: (e) => console.log(e.getContent()),
      onFullscreenExit: () => this.hidePreview()
    };
  }
}

List of Event Hooks

• onPreview
• onPreviewEnd
• onSave
• onBlur
• onFocus
• onFullscreen
• onFullscreenExit
• onChange
• onSelect
• onShow

API - Editor Methods

The editor API is quite dense and I will not list the entire set of methods, but you can see the entire list from the Editor Method Interface. To call any of the Editor Methods, you will have to first get a reference to the Editor's instance which you can get from the onShow callback.

Get the Editor's instance through the onShow, via the Custom Event (from the View) or Editor Option callback (just choose the one you prefer). Below shows how to get it through the latter option.

View

<button (click)="showFullScreen()">Show Full Screen</button>
<angular-markdown-editor
  textareaId="editor1" rows="12"
  name="markdownText" [(ngModel)]="markdownText"
  [options]="editorOptions">
</angular-markdown-editor>

Component

import { EditorInstance, EditorOption } from 'angular-markdown-editor';
export class MyComponent {
  bsEditorInstance: EditorInstance;

  ngOnInit() {
    this.editorOptions = {
      iconlibrary: 'fa',
      onShow: (e) => this.bsEditorInstance = e
    };
  }

  showFullScreen() {
    this.bsEditorInstance.setFullscreen(true);
  }
}

Preview Button (need a Parser)

For the "Preview" button to work, you will need to provide a parser to the Editor Options. This lib has no deep dependencies to any Markdown Parser (you could use marked.js or any other parser). But assuming we are using ngx-markdown, we can add the parser this way:

Component

import { MarkdownService } from 'ngx-markdown';

export class TestComponent implements OnInit {
  constructor(private markdownService: MarkdownService) {}

  ngOnInit() {
    this.editorOptions = {
      parser: (val) => this.markdownService.parse(val.trim())
    };
  }
}

Security - Dealing with Cross Site Scripting (XSS)

If you want to use this package for any type of users, you should consider sanatizing your data for Cross Site Scripting (XSS) attack. A good package to use for sanitizing is DOMPurify and you should sanitize your data when calling the parser as shown below. Also if you have any Markdown Preview, remember to sanitize them as well probably via the form input or control.

this.editorOptions = {
  parser: (val: string) => {
    const sanitizedText = DOMPurify.sanitize(val.trim());
    this.markdownService.parse(sanitizedText);
  }
};

Additional Editor Buttons

I really thought that some buttons were missing to go a great job (Strikethrough & Table). So I added them directly in the Global Options. If you want to add your own, then just look at how it was done in the Global Options and read the section additionalButtons of Bootstrap Markdown website.

Adding Locale

You can add a locale to the editor but passing a locale object (and bind it in the View) which contain a language and the dictionary of words used by the editor. The entire list of words can be seen in the example below. So for example, if we want to add French locale, we will do the following (you can see demo code):

View

<button (click)="showFullScreen()">Show Full Screen</button>
<angular-markdown-editor
  textareaId="editor1" rows="12"
  name="markdownText" [(ngModel)]="markdownText"
  [locale]="locale"
  [options]="editorOptions">
</angular-markdown-editor>

Component

import { EditorInstance, EditorLocale, EditorOption } from 'angular-markdown-editor';
export class MyComponent {
  locale: EditorLocale = {
    language: 'fr',
    dictionary: {
      'Bold': 'Gras',
      'Italic': 'Italique',
      'Heading': 'Titre',
      'URL/Link': 'Insérer un lien HTTP',
      'Image': 'Insérer une image',
      'List': 'Liste à puces',
      'Ordered List': 'Liste ordonnée',
      'Unordered List': 'Liste non-ordonnée',
      'Code': 'Code',
      'Quote': 'Citation',
      'Preview': 'Prévisualiser',
      'Strikethrough': 'Caractères barrés',
      'Table': 'Table',
      'strong text': 'texte important',
      'emphasized text': 'texte souligné',
      'heading text': 'texte d\'entête',
      'enter link description here': 'entrez la description du lien ici',
      'Insert Hyperlink': 'Insérez le lien hypertexte',
      'enter image description here': 'entrez la description de l\'image ici',
      'Insert Image Hyperlink': 'Insérez le lien hypertexte de l\'image',
      'enter image title here': 'entrez le titre de l\'image ici',
      'list text here': 'texte à puce ici'
    }
  };

  // if you want to pass multiple locales, just pass it as an array
  /*
  locale: EditorLocale[] = [
    { language: 'fr', dictionary: { 'Bold': 'Gras', ...
    { language: 'en', dictionary: { 'Bold': 'Bold', ...
  ];
  */

  ngOnInit() {
    this.editorOptions = {
      language: 'fr', // also set the language option to French
      onShow: (e) => this.bsEditorInstance = e
    };
  }
}

Note I could not find a way to change the language dynamically, so it seems that we would have to destroy the component and re-create it for switching the language/locale.

Changelog

3.1.1 (2024-09-21)

Bug Fixes

• update github link of bootstrap-markdown dep, fixes #64 (40da5ef)