Home

Awesome

GitHub GitHub Workflow Status GitHub release (latest by date)

<h3 align="center">Angular SunEditor</h3> <br /> <p align="center"> ngx-suneditor is an Angular module for the SunEditor WYSIWYG Editor. <br /> <br /> <br /> <p align="center"> <img src="http://suneditor.com/docs/screen-main-w.png?v=2700" alt="editor-example"> </p> </p> </p> <hr> <!-- TABLE OF CONTENTS --> <details open="open"> <summary>Table of Contents</summary> <ul> <li><a href="#about-the-project">About The Project</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#getting-started">Getting Started</a></li> <li><a href="#configuration">Configuration</a></li> <li><a href="#events">Events</a></li> <li><a href="#inputs">Inputs</a></li> <li><a href="#functions">Functions</a></li> <li><a href="#additional-functions">Additional Functions</a></li> <li><a href="#plugins">Plugins</a></li> <li><a href="#register-upload-handler">Register UploadHandler</a></li> <li><a href="#view-component">View Component</a></li> <li><a href="#thanks-and-contributing">Thanks And Contributing</a></li> <li><a href="#license">License</a></li> </ul> </details> <br />

About The Project

Supported Angular Versions: 12+

ngx-suneditor is a angular module for SunEditor implementing all features The Angular Way.

SunEditor is a pure javscript based WYSIWYG web editor, with no dependencies.

For further information please visit on Github :octocat: or Web :earth_americas:

<br /> <p align="center"> <a href="https://bauviso.de"> <img src="https://github.com/BauViso/angular-suneditor/blob/master/src/assets/img/Bauvisoschwarz.png" alt="Logo" width="80" height="80"> </a> <h5 align="center">Powered by BauViso</h5> </p> <br />

Prerequisites

Install the SunEditor

Installation

Install the ngx-suneditor

<br />

Getting Started

After installation just import the NgxSuneditorModule to the imports array of your preffered module.

import { NgModule } from "@angular/core";
import { BrowserModule } from "@angular/platform-browser";
import { NgxSuneditorModule } from "../../projects/ngx-suneditor/src/public-api";
import { AppComponent } from "./app.component";

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, NgxSuneditorModule],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

Import css in your styles.css or in angular.json styles array from CDN or node_modules

@import "https://cdn.jsdelivr.net/npm/suneditor@latest/dist/css/suneditor.min.css"; 

or

@import "../node_modules/suneditor/dist/css/suneditor.min";

Edit compilerOptions lib array in tsconfig.json to include APIs for the Windows Script Hosting System as SunEditor uses ActiveXObject

Add "scripthost" - tsconfig.json

{
  ...
  "compilerOptions": {
    ...
    "lib": [... "scripthost"]
  }
}  

Use the ngx-suneditor component in your HTML.

<ngx-suneditor></ngx-suneditor>
<br />

Configuration

There are two ways to pass the options object. You can pass the option on the Module with forRoot() or pass it by @Input as described below. <br />

forRoot

You can pass it in your module to define a standard configuration for the imported editor. With this approch the configuration will be shared over all editor instances.

example:

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    NgxSuneditorModule.forRoot({
      plugins: plugins,
      minWidth: '100%',
      height: '70vh',
      buttonList: [
        ['undo', 'redo'],
        ['font', 'fontSize', 'formatBlock'],
        ['paragraphStyle', 'blockquote'],
        ['bold', 'underline', 'italic', 'strike', 'subscript', 'superscript'],
        ['fontColor', 'hiliteColor', 'textStyle'],
        ['removeFormat'],
        ['outdent', 'indent'],
        ['align', 'horizontalRule', 'list', 'lineHeight'],
        ['table', 'link', 'image', 'video', 'audio'],
        ['fullScreen', 'showBlocks', 'codeView'],
        ['preview', 'print'],
        ['save'],
      ],
    }),
  ],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

If you now use multiple editor instances, the options will be shared

component 1

<ngx-suneditor></ngx-suneditor>

component 2

<ngx-suneditor></ngx-suneditor>
<br />

@Input

Pass the configuration as input to give this instance a specific configuration or override the default configuration that was passed by forRoot.

example:

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule, NgxSuneditorModule],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}
@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.scss"],
})
export class AppComponent {
  editorOptions: SunEditorOptions = {
    minWidth: "100%",
    height: "80vh",
    buttonList: [
      ["undo", "redo"],
      ["font", "fontSize", "formatBlock"],
      ["paragraphStyle", "blockquote"],
      ["bold", "underline", "italic", "strike", "subscript", "superscript"],
      ["fontColor", "hiliteColor", "textStyle"],
      ["removeFormat"],
      ["outdent", "indent"],
      ["align", "horizontalRule", "list", "lineHeight"],
      ["table", "link", "image", "video", "audio"],
      ["fullScreen", "showBlocks", "codeView"],
      ["preview", "print"],
      ["save", "template"],
    ],
  };
}
<ngx-suneditor [options]="editorOptions"></ngx-suneditor>
<br />

forRoot & @Input

Combining forRoot and Input approach

example:

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    NgxSuneditorModule.forRoot({
      minWidth: "100%",
      height: "80vh",
      buttonList: [
        ["undo", "redo"],
        ["font", "fontSize", "formatBlock"],
        ["paragraphStyle", "blockquote"],
        ["bold", "underline", "italic", "strike", "subscript", "superscript"],
      ],
    }),
  ],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

component 1

<!-- Uses the default configuration passed by forRoot -->
<ngx-suneditor></ngx-suneditor>

<!-- Override the default options -->
<ngx-suneditor [options]="editorOptions"></ngx-suneditor>
<br />

Events

All events from SunEditor are mapped to this component and passed by @Output. Plese see the original documentation here and here

You can use all listed events as usual in angular:

<ngx-suneditor
  (onChange)="initContent"
  (onClick)="myClickHandler($event)"
></ngx-suneditor>
namePayloaddescription
createdNgxSunEditorComponentEmitted after the editor compontent was created
onload{ core: Core; reload: boolean }When reloaded with the "setOptions" method
onScroll{ e: Event; core: Core; }Scroll event
onMouseDown{ e: Event; core: Core; }Mouse down
onClick{ e: Event; core: Core; }clicked
onInput{ e: Event; core: Core; }Wysiwyg editor area Input event
onKeyDown{ e: Event; core: Core; }keydown event
onKeyUp{ e: Event; core: Core; }keyup event
onFocus{ e: Event; core: Core;}Focus event
onBlur{ e: Event; core: Core; }Blur event
onResizeEditor{ height: number; prevHeight: number; core: Core;}Called when the editor is resized using the bottom bar
onAudioUploadBefore{ files: any[]; info: audioInputInformation; core: Core; uploadHandler: Function; }Called before the audio is uploaded
onVideoUploadError{ errorMessage: string; result: any; core: Core; }Called on video upload error
onVideoUploadBefore{ files: any[]; info: videoInputInformation; core: Core; uploadHandler: Function; }Called before the video is uploaded
onImageUploadError{ errorMessage: string; result: any; core: Core; }Called on image upload error
onImageUploadBefore{ files: any[]; info: imageInputInformation; core: Core; uploadHandler: Function; }Called before the image is uploaded
onAudioUploadError{ errorMessage: string; result: any; core: Core; }Called on audio upload error
onDrop{ e: Event; cleanData: string; maxCharCount: number; core: Core; }Drop event
onChange{ content: string; core: Core; }Called when the contents changes
showController{ name: string; controllers: Controllers; core: Core; }Called just after the controller is positioned and displayed on the screen
toggleFullScreen{ isFullScreen: boolean; core: Core;}Called when toggling full screen
toggleCodeView{ isCodeView: boolean; core: Core; }Called when toggling between code view and wysiwyg view
showInline{ toolbar: Element; context: Context; core: Core; }Called just before the inline toolbar is positioned and displayed on the screen
onAudioUpload{ files: any[]; info: audioInputInformation; core: Core; uploadHandler: Function; }Called on audio upload
onVideoUpload{ targetElement: HTMLIFrameElement | HTMLVideoElement; index: number; state: string; info: fileInfo; remainingFilesCount: number; core: Core; }Called on video upload
onImageUpload{ targetElement: HTMLImageElement; index: number; state: string; info: fileInfo; remainingFilesCount: number; core: Core; }Called on image upload
onCut{ e: Event; clipboardData: any; core: Core; }Called when cut to clipboard
onCopy{ e: Event; clipboardData: any; core: Core; }Called when copy to clipboard
<br />

Inputs

The NgxSunEditorComponent has multiple inputs as described below:<br />

<b>editorID</b><br /> HTML DOM id Property. default: auto generated id

<b>content</b><br /> Content to show in the Editor. If this value is set the content will be set.

<b>options</b><br /> SunEditorOptions Object is used once when the editor is created

<b>onDrop_param</b><br /> Parameter that is passed to the onDrop event to control the behavior. default: true

<b>onCopy_param</b><br /> Parameter that is passed to the onCopy event to control the behavior. default: true

<b>onCut_param</b><br /> Parameter that is passed to the onCut event to control the behavior. default: true

<b>onAudioUploadError_param</b><br /> Parameter that is passed to the onAudioUploadError event to control the behavior. default: true

<b>onImageUploadBefore_param</b><br /> Parameter that is passed to the onImageUploadBefore event to control the behavior. default: true

<b>onImageUploadError_param</b><br /> Parameter that is passed to the onImageUploadError event to control the behavior. default: true

<b>onVideoUploadBefore_param</b><br /> Parameter that is passed to the onVideoUploadBefore event to control the behavior. default: true

<b>onVideoUploadError_param</b><br /> Parameter that is passed to the onVideoUploadError event to control the behavior. default: true

<b>onAudioUploadBefore_param</b><br /> Parameter that is passed to the onAudioUploadBefore event to control the behavior. default: true

<b>onResizeEditor_param</b><br /> Parameter that is passed to the onResizeEditor event to control the behavior. default: {}

<b>imageUploadHandler</b><br /> Callback to replace the default imageUploadHandler function

<b>videoUploadHandler</b><br /> Callback to replace the default videoUploadHandler function

<b>audioUploadHandler</b><br /> Callback to replace the default audioUploadHandler function

<b>localStorageConfig</b><br /> localStorageConfig Object {id: string, autoSave: boolean, autoLoad: boolean}

id - localStorageKey where the Content gets saved. autoSave - decides if the content should be automaticly saved in the onChange event autoLoad - decides if the content should be automaticly loaded on startUp default: {id: 'ngxSunEditor', autoSave: false, autoLoad: false}

Functions

As described in the SunEdtior documentation there are plenty functions the editor provides.

All functions provided by the original SunEditor can be used directly on the NgxSunEditorComponent. Here you can find Additional Functions that are only available in this Angular Module.

You can get the NgxSunEditorComponent to your component by using @Viewchild or listening to the created event which also returns the instance after it has been created. It's also possible to get the raw SunEditor object that is returned by the editor internal even if it shouldn't be needed for the most usecases.

example (@Viewchild):

@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.scss"],
})
export class AppComponent implements AfterViewInit {
  @ViewChild(NgxSuneditorComponent) ngxSunEditor: NgxSuneditorComponent;

  // Make sure that you access it in ngAfterViewInit at the earliest
  // so you can be sure that the viewchild is set
  ngAfterViewInit() {
    // Call some method on the Viewchild instance
    const history = this.ngxSunEditor.getHistory();
    
    console.log(history); // do your logic ...
  }
}
<!-- Use the component as usual -->
<ngx-suneditor></ngx-suneditor>
<br />

example (created event):

@Component({
  selector: 'app-root',
  templateUrl: './app.component.html',
  styleUrls: ['./app.component.scss'],
})
export class AppComponent implements AfterViewInit {
  private ngxSunEditor: NgxSuneditorComponent;

  onEditorCreated(comp: NgxSuneditorComponent) {
    // Set the editor that is passed as event payload
    this.ngxSunEditor = comp;
    // Call some method on the Viewchild instance
    const history = this.ngxSunEditor.getHistory();
    
    console.log(history); // do your logic ...
  }
}
<!-- Use the event as usual -->
<ngx-suneditor (created)="onEditorCreated($event)"></ngx-suneditor>
<br />

example (raw editor):

@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.scss"],
})
export class AppComponent implements AfterViewInit {
  ngAfterViewInit() {
    // Get the raw editor object instance
    const rawEditor = this.ngxSunEditor.getEditor();
    console.log(rawEditor); // do something wiht the instance
  }
}
<br />

You can use all listed functions:

<br />

<b>setToolbarButtons</b><br /> Set the toolbar buttons

  const buttonList = [
      ['undo', 'redo'],
      ['font', 'fontSize', 'formatBlock'],
      ['paragraphStyle', 'blockquote'],
      ['bold', 'underline', 'italic', 'strike', 'subscript', 'superscript'],
      ['fontColor', 'hiliteColor', 'textStyle'],
      ['removeFormat'],
      ['outdent', 'indent'],
      ['align', 'horizontalRule', 'list', 'lineHeight'],
      ['table', 'link', 'image', 'video', 'audio'],
      ['fullScreen', 'showBlocks', 'codeView'],
      ['preview', 'print'],
      ['save', 'template'],
    ];
    this.ngxSunEditor.setToolbarButtons(buttonList);
<br />

<b>setOptions</b><br /> Pass a SunEditorOptions object to the editor to change the options after the editor was created

  const options: SunEditorOptions = {
      plugins: plugins,
      minWidth: '100%',
      height: '80vh',
      buttonList: [
        ['undo', 'redo'],
      ],
  }  
  this.ngxSunEditor.setOptions(options);
<br />

<b>setDefaultStyle</b><br /> Define the style of the edit area without re render

  const styles = 'background-color: coral;' 
  this.ngxSunEditor.setDefaultStyle(styles);
<br />

<b>noticeOpen</b><br /> Opens a message in the notice panel (Alert)

   const message = 'I ! <3 any';
    this.ngxSunEditor.noticeOpen(message);
<br />

<b>noticeClose</b><br /> Closes the notice panel (Alert)

    this.ngxSunEditor.noticeClose();
<br />

<b>save</b><br /> Copying the contents of the editor to the original textarea and return the content or the full textarea. When passed true as param it only returns the content. Otherwise the original HTMLInputElement is returned

    // when called with false the full textarea is returned
    const textarea = this.ngxSunEditor.save(false) as HTMLInputElement;
    console.log(textarea.value);

    // when called with true the content returned
    const content = this.ngxSunEditor.save(true);
    console.log(content);
<br />

<b>getContext</b><br /> Gets the SunEditor's context object. Contains settings, plugins, and cached element objects

    const ctx = this.ngxSunEditor.getContext();
<br />

<b>getContents</b><br /> Gets the contents of the suneditor

    const content = this.ngxSunEditor.getContents(true);
<br />

<b>getText</b><br /> Gets only the text of the suneditor contents

    const rawText = this.ngxSunEditor.getText();
<br />

<b>insertImage</b><br /> Upload images using image plugin

    this.ngxSunEditor.insertImage(files);
<br />

<b>setContents</b><br /> Change the contents of the suneditor

    this.ngxSunEditor.setContents('I ! <3 any');
<br />

<b>appendContents</b><br /> Change the contents of the suneditor

    this.ngxSunEditor.appendContents('I ! <3 any');
<br />

<b>readOnly</b><br /> Switch "ReadOnly" mode.

    this.ngxSunEditor.readOnly(true);
<br />

<b>disabled</b><br /> Disable the suneditor

    this.ngxSunEditor.disabled();
<br />

<b>enabled</b><br /> Enables the suneditor

    this.ngxSunEditor.enabled();
<br />

<b>show</b><br /> Show the suneditor

    this.ngxSunEditor.show();
<br />

<b>hide</b><br /> Hide the suneditor

    this.ngxSunEditor.hide();
<br />

<b>toggleDisplayBlocks</b><br /> Toggle display blocks

    this.ngxSunEditor.toggleDisplayBlocks()
<br />

<b>toggleCodeViewMode</b><br /> Toggle codeView on/off

    this.ngxSunEditor.toggleCodeViewMode()
<br />

<b>undo</b><br /> Undo changes

    this.ngxSunEditor.undo()
<br />

<b>redo</b><br /> Redo changes

    this.ngxSunEditor.redo()
<br />

<b>removeFormat</b><br /> Remove format of the currently selected range

    this.ngxSunEditor.removeFormat()
<br />

<b>print</b><br /> Prints the current contents of the editor.

    this.ngxSunEditor.print()
<br />

<b>toggleFullScreenMode</b><br /> Toggle the editor fullscreen mode

    this.ngxSunEditor.toggleFullScreenMode()
<br />

<b>showBlocks</b><br /> Display blocks in the editor

    this.ngxSunEditor.showBlocks()
<br />

<b>insertHTML</b><br /> Inserts an HTML element or HTML string or plain string at the current cursor position

    this.ngxSunEditor.insertHTML('<p> I ! <3 any </p>');
<br />

<b>getCharCount</b><br /> Get the editor's number of characters or binary data size. You can use the "charCounterType" option format.

    const charCount = this.ngxSunEditor.getCharCount()
<br />

<b>preview</b><br /> Open a new tab as preview window.

    this.ngxSunEditor.preview()
<br />

<b>getHistory</b><br /> Get the actual history Stack

    const history = this.ngxSunEditor.getHistory()
<br />

<b>selectAll</b><br /> Select all in the editor

    this.ngxSunEditor.selectAll()
<br />

<b>getSelection</b><br /> Get window selection obejct

    const selectionObj = this.ngxSunEditor.getSelection()
<br />

<b>showLoading</b><br /> Set the editor in loading mode. Show a loading spinner, disable inputs and grey out

    this.ngxSunEditor.showLoading()
<br />

<b>closeLoading</b><br /> Remove the loading mode

    this.ngxSunEditor.closeLoading()
<br />

<b>submenuOn</b><br /> Enabled submenu

    this.ngxSunEditor.submenuOn(ele);
<br />

<b>submenuOff</b><br /> Disable submenu

    this.ngxSunEditor.submenuOff()
<br />

<b>containerOn</b><br /> Enable container

    this.ngxSunEditor.containerOn(ele);
<br />

<b>containerOff</b><br /> Disable container

    this.ngxSunEditor.containerOff()
<br />

<b>addClass</b><br /> Append the className value of the argument value element

    this.ngxSunEditor.addClass(ele, 'custom-class');
<br />

<b>removeClass</b><br /> Delete the className value of the argument value element

    this.ngxSunEditor.removeClass(ele, 'custom-class');
<br />

<b>setStyle</b><br /> Set style, if all styles are deleted, the style properties are deleted

    this.ngxSunEditor.setStyle(ele, 'marginLeft', 50);
<br />

<b>addDocEvent</b><br /> Add an event to document. When created as an Iframe, the same event is added to the document in the Iframe.

    this.ngxSunEditor.addDocEvent('click', listener, false);
<br />

<b>removeDocEvent</b><br /> Remove events from document. * When created as an Iframe, the event of the document inside the Iframe is also removed.

    this.ngxSunEditor.removeDocEvent('click', listener);
<br />

<b>actionCall</b><br /> Run plugin calls and basic commands.

    this.ngxSunEditor.actionCall('custom command', 'command', ele);
<br />

<b>indent_outdent</b><br /> Set indentation separator "indent" or "outdent"

    this.ngxSunEditor.indent_outdent('indent');
<br />

<b>getImagesInfo</b><br /> Gets uploaded images informations

    const img_info = this.ngxSunEditor.getImagesInfo()
<br />

<b>getFilesInfo</b><br /> Gets uploaded files(plugin using fileManager) information list.

    const filesInfo = this.ngxSunEditor.getFilesInfo('video');
<br />

<b>commandHandler</b><br /> Execute command of command button(All Buttons except submenu and dialog) (undo, redo, bold, underline, italic, strikethrough, subscript, superscript, removeFormat, indent, outdent, fullscreen, showBlocks, codeview, preview, print, copy, cut, paste)

    this.ngxSunEditor.commandHandler(ele, 'strikethrough');
<br />

Additional Functions

There are some functions that are only available on this Angular module as they are not part of the original SunEditor. This functions are our implementation! We provide this while having in mind the most convenient usage without conflicting the original behavior.

Everyone is welcome to report a feature request by opening a new issue: Feature request to help us improve this module :rocket:

These are the functions we provide:

<b>getEditorID</b><br /> Returns the HTML id Attribute that is randomly generated on startup on every editor instance.

  const id = this.ngxSunEditor.getEditorID();
<br />

<b>getEditor</b><br /> Returns the raw editor instance.

  const rawEditor = this.ngxSunEditor.getEditor();
<br />

<b>loadLocalStorageContent</b><br /> loads the localStorageContent to the Editor

  this.ngxSunEditor.loadLocalStorageContent();
<br />

<b>saveToLocalStorage</b><br /> Save Content to LocalStorage

  this.ngxSunEditor.saveToLocalStorage();
<br />

<b>getLocalStorageKey</b><br /> Returns the LocalStorageKey

  const lsKey = this.ngxSunEditor.getLocalStorageKey();
<br />

<b>getIsAutoSaveToLocalStorage</b><br /> Returns the current state of AutoSaveToLocalStorage

  const autoSaveLs = this.ngxSunEditor.getIsAutoSaveToLocalStorage();
<br />

<b>getIsAutoLoadToLocalStorage</b><br /> Returns the current state of AutoLoadToLocalStorage

  const autoLoadLs = this.ngxSunEditor.getIsAutoLoadToLocalStorage();
<br />

<b>isReadOnly</b><br /> Returns the readonly state of the SunEditor

    const readonly = this.ngxSunEditor.isReadOnly()
    if (readonly) {
      // do something while editor is readonly
    };
<br />

<b>isHidden</b><br /> Returns the hidden state of the editor

    const hidden = this.ngxSunEditor.isHidden()
    if (hidden) {
      // do something while editor is hidden
    };
<br />

<b>isDisplayBlocks</b><br /> Returns the displayBlocks state of the editor

    const isDisplayBlocks = this.ngxSunEditor.isDisplayBlocks()
    if (isDisplayBlocks) {
      // do something while editor is isDisplayBlocks
    };
<br />

<b>isDisabled</b><br /> Returns the disabled state of the SunEditor

    const disabled = this.ngxSunEditor.isDisabled()
    if (disabled) {
      // do something while editor is disabled
    };
<br />

<b>isCodeViewMode</b><br /> Returns the CodeViewMode state of the editor

    const isCodeViewMode = this.ngxSunEditor.isCodeViewMode()
    if (isCodeViewMode) {
      // do something while editor is isCodeViewMode
    };
<br />

<b>isFullScreenMode</b><br /> Returns the fullScreenMode state of the editor

    const isFullScreenMode = this.ngxSunEditor.isFullScreenMode()
    if (isFullScreenMode) {
      // do something when editor is isFullScreenMode
    }
<br />

<b>isLoading</b><br /> Returns the loading state of the SunEditor

    const loading = this.ngxSunEditor.isLoading()
    if (loading) {
      // do something while editor is loading
    };
<br />

Plugins

How to use plugins is shown in the documentation. Just import the plugins to your module or component as pass it through the options like described in <a href="#configuration">Configuration</a> section.

example:

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { NgxSuneditorModule } from '../../projects/ngx-suneditor/src/public-api';
import { AppComponent } from './app.component';
import plugins from 'suneditor/src/plugins'; // Import all offical available plugins

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    NgxSuneditorModule.forRoot({
      plugins: plugins, // pass the imported plugins
      minWidth: '100%',
      height: '80vh',
      buttonList: [
        ['undo', 'redo'],
        ['font', 'fontSize', 'formatBlock'],
        ['paragraphStyle', 'blockquote'],
        ['bold', 'underline', 'italic', 'strike', 'subscript', 'superscript'],
        ['fontColor', 'hiliteColor', 'textStyle'],
        ['removeFormat'],
        ['outdent', 'indent'],
        ['align', 'horizontalRule', 'list', 'lineHeight'],
        ['table', 'link', 'image', 'video', 'audio'],
        ['fullScreen', 'showBlocks', 'codeView'],
        ['preview', 'print'],
        ['save', 'template'],
      ],
    }),
  ],
  providers: [],
  bootstrap: [AppComponent],
})
export class AppModule {}

Please visit CustomPlugins if you wan't to create your own plugin.

<br />

Register Upload Handler

You can override the default callback functions for upload handlers to include your logic on uploads.

To overrite the default callback pass your function as @Input to the NgxSunEditorComponent

  ngAfterViewInit() {
    
    this.ngxSunEditor.audioUploadHandler = (xmlHttp: XMLHttpRequest, info: audioInputInformation, core: Core) => {
      // do something here ...
      return;
    };

  }

Please see the original Documentation for further information.

<br />

View Component

In addition to the editor, there is also a view component ngx-sunview to display the content. This component can bypass angular's DomSanitizer using a SafeHtmlPipe.

The component has two @Input properties.

remember to import the suneditor-contents.css before using it!

example:

<ngx-sunview [bypassSantiziser]="true" [content]="initContent"></ngx-sunview>
<h5>Editor</h5> <img src="https://github.com/BauViso/angular-suneditor/blob/master/src/assets/img/editor-content.png"> <h5>View</h5> <img src="https://github.com/BauViso/angular-suneditor/blob/master/src/assets/img/editor-view.png"> <br />

Thanks And Contributing

Special Thanks to JiHong88 - The creator of SunEditor.

Contributions are welcome :heart: - please read CONTRIBUTING.md

License

ngx-suneditor may be freely distributed under the MIT license.