AngularJS2 bindings for Froala WYSIWYG HTML Rich Text Editor.
TypeScript HTML JavaScript CSS

README.md

angular2-froala-wyswiyg

angular2-froala-wyswiyg provides Angular2 bindings to the Froala WYSIWYG editor VERSION 2.

Installation

  1. Clone this repo or download the zip.

  2. Run bower install or Download the editor from https://www.froala.com/wysiwyg-editor/ and jQuery

  3. Load Froala WYSIWYG editor (and all desired plugins), jQuery and the angular2 directives file into your project.

    • lib/froala.directives.ts

    NB: You must ensure jQuery is included before angular2.

Usage

1. Import froala directives:

import { FroalaEditorDirective, FroalaViewDirective } from 'path/to/froala.directives';

2. Use them in your component:

@Component({
  selector: 'app',
  template: `
    <div [froalaEditor]="options" [(froalaModel)]="content"></div>
  `,
  directives: [FroalaEditorDirective]
})

You can check src/app.component.ts file for a more detailed usage example.

  • 'src' directory contains a working example that will need a server to run. To run them: npm start.

  • 'demo' directory contains a minified working example that can run without a server. To build demo/app.js in case you've modified the sources(src dir): npm run build. To run: open demo/index.html directly into browser.

Options

You can pass editor options as Input (optional).

[froalaEditor]='options'

You can pass any existing Froala option. Consult the Froala documentation to view the list of all the available options:

public options: Object = { 
  placeholderText: 'Edit Your Content Here!',
  charCounterCount: false
}

Aditional option is used:

  • immediateAngularModelUpdate: (default: false) This option synchronizes the angular model as soon as a key is released in the editor. Note that it may affect performances.

Events and Methods

Events can be passed in with the options, with a key events and object where the key is the event name and the value is the callback function.

public options: Object = {
  placeholder: "Edit Me",
  events : {
    'froalaEditor.focus' : function(e, editor) {
      console.log(editor.selection.get());
    }
  }
}

Using the editor instance from the arguments of the callback you can call editor methods as described in the method docs.

Froala events are described in the events docs.

Model

The WYSIWYG HTML editor content model.

[(froalaModel)]="editorContent"

Pass initial content:

public editorContent: string = 'My Document\'s Title'

Use the content in other places:

<input [ngModel]="editorContent"/>
<input [(ngModel)]="editorContent"/> <!-- For two way binding -->

Other two way binding example:

<div [froalaEditor] [(froalaModel)]="editorContent"></div>
<div [froalaEditor] [(froalaModel)]="editorContent"></div>

Special tags

You can also use the editor on img, button, input and a tags:

<img [froalaEditor] [(froalaModel)]="imgObj"/>

The model must be an object containing the attributes for your special tags. Example:

public imgObj: Object = {
  src: 'path/to/image.jpg'
};

The froalaModel will change as the attributes change during usage.

  • froalaModel can contain a special attribute named innerHTML which inserts innerHTML in the element: If you are using 'button' tag, you can specify the button text like this:
public buttonModel: Object = {
  innerHTML: 'Click Me'
};

As the button text is modified by the editor, the innerHTML attribute from buttonModel model will be modified too.

Specific option for special tags

  • angularIgnoreAttrs: (default: null) This option is an array of attributes that you want to ignore when the editor updates the froalaModel:

    public inputOptions: Object = {
    angularIgnoreAttrs: ['class', 'ng-model', 'id']
    };

Manual Instantiation

Gets the functionality to operate on the editor: create, destroy and get editor instance. Use it if you want to manually initialize the editor.

(froalaInit)="initialize($event)"

Where initialize is the name of a function in your component which will receive an object with different methods to control the editor initialization process.

public initialize(initControls) {
  this.initControls = initControls;
  this.deleteAll = function() {
      this.initControls.getEditor()('html.set', '');
  };
}

The object received by the function will contain the following methods:

  • initialize: Call this method to initialize the Froala Editor
  • destroy: Call this method to destroy the Froala Editor
  • getEditor: Call this method to retrieve the editor that was created. This method will return null if the editor was not yet created

Displaying HTML

To display content created with the froala editor use the froalaView directive.

[froalaView]="editorContent"

<div [froalaEditor] [(froalaModel)]="editorContent"></div>
<div [froalaView]="editorContent"></div>

License

The angular2-froala-wyswiyg project is under MIT license. However, in order to use Froala WYSIWYG HTML Editor plugin you should purchase a license for it.

Froala Editor has 3 different licenses for commercial use. For details please see License Agreement.

Development environment setup

If you want to contribute to angular2-froala-wyswiyg, you will first need to install the required tools to get the project going.

Prerequisites

Dependencies

  • Bower (package management)
1. Install Bower
$ npm install -g grunt-cli bower
2. Install project dependencies
$ npm install
$ bower install
3. Run in development mode. Is loads the src files that make use of lib/froala.directives
$ npm start