Categories
Plugins

angular2-froala-wysiwyg-base

angular2-froala-wyswiyg

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

Table of contents

Installation instructions
Integration

angular-cli
webpack
angular-seed
system.js
JIT
AOT

Usage
Manual Initialization
Displaying HTML
License

Installation instructions
Install angular2-froala-wysiwyg from npm
npm install angular2-froala-wysiwyg –save
You will need CSS styles and Font Awesome
Integration
Use with angular-cli
Installing angular-cli
Important: please check angular-cli version, it should be => “1.0.0-beta.24”.
Note: you can skip this part if you already have application generated by ng-cli and webpack.
npm i -g angular-cling new my-appcd my-app
Adding angular2-froala-wysiwyg

install angular2-froala-wysiwyg

npm install angular2-froala-wysiwyg –save

open src/app/app.module.ts and add

# Import Angular2 plugin.import { FroalaEditorModule, FroalaViewModule } from ‘angular2-froala-wysiwyg’;… @NgModule({   …   imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot() … ],   … })

open angular-cli.json and insert a new entry into the styles array

“styles”: [  “styles.css”,  “../node_modules/font-awesome/css/font-awesome.css”,  “../node_modules/froala-editor/css/froala_editor.pkgd.min.css”],

in angular-cli.json and insert a new entry into the scripts array

“scripts”: [  “../node_modules/jquery/dist/jquery.min.js”,  “../node_modules/froala-editor/js/froala_editor.pkgd.min.js”],

in angular-cli.json add the following to load Font Awesome fonts

“addons”: [  “../node_modules/font-awesome/fonts/*.+(otf|eot|svg|ttf|woff|woff2)”],

open src/app/app.component.html and add

Hello, Froala!

Run angular-cli
ng serve
Use with webpack
Create webpack app
Note: you can skip this part if you already have application generated.
git clone –depth 1 https://github.com/angularclass/angular2-webpack-starter.gitcd angular2-webpack-starternpm install
Adding angular2-froala-wysiwyg

install angular2-froala-wysiwyg

npm install angular2-froala-wysiwyg –save

open src/app/app.module.ts and add

# Import the Froala Editor plugin.import “froala-editor/js/froala_editor.pkgd.min.js”; # Import Angular2 plugin.import { FroalaEditorModule, FroalaViewModule } from ‘angular2-froala-wysiwyg’;… @NgModule({   …   imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot(), … ],   … })

open src/app/app.component.ts and add to the template

Hello, Froala!

open config/webpack.common.js and add the following to CopyWebpackPlugin

{  from: ‘node_modules/froala-editor/css/’,  to: ‘assets/froala-editor/css/’,},{  from: ‘node_modules/font-awesome/css/font-awesome.min.css’,  to: ‘assets/font-awesome/css/font-awesome.min.css’,},{  from: ‘node_modules/font-awesome/fonts’,  to: ‘assets/font-awesome/fonts’}

in config/webpack.common.js copy the following to plugins

new webpack.ProvidePlugin({  $: “jquery”,  jQuery: “jquery”})

open config/head-config.common.js and add a new entry to link

{ rel: ‘stylesheet’, href: ‘/assets/font-awesome/css/font-awesome.min.css’ },{ rel: ‘stylesheet’, href: ‘/assets/froala-editor/css/froala_editor.pkgd.min.css’ }
Run webpack app
npm run start
Use with angular-seed
Create angular-seed app
Note: you can skip this part if you already have application generated. For more details please also read: https://github.com/mgechev/angular-seed.
git clone –depth 1 https://github.com/mgechev/angular-seed.gitcd angular-seednpm install
Adding angular2-froala-wysiwyg

install angular2-froala-wysiwyg

npm install angular2-froala-wysiwyg –save

open tools/config/projesct.config.ts and uncomment the following line from the top of the file

import { ExtendPackages } from ‘./seed.config.interfaces’;

in tools/config/projesct.config.ts add

… this.NPM_DEPENDENCIES = [  …this.NPM_DEPENDENCIES,  { src: ‘jquery/dist/jquery.min.js’, inject: ‘libs’},  { src: ‘froala-editor/js/froala_editor.pkgd.min.js’, inject: ‘libs’ },  { src: ‘font-awesome/css/font-awesome.min.css’, inject: true },  { src: ‘froala-editor/css/froala_editor.pkgd.min.css’, inject: true }]; … let additionalPackages: ExtendPackages[] = [  // required for dev build  {    name:’angular2-froala-wysiwyg’,    path:’node_modules/angular2-froala-wysiwyg/bundles/angular2-froala-wysiwyg.umd.min.js’  },   // required for prod build  {    name:’angular2-froala-wysiwyg/*’,    path:’node_modules/angular2-froala-wysiwyg/bundles/angular2-froala-wysiwyg.umd.min.js’  }] this.addPackagesBundles(additionalPackages);

open src/client/app/home/home.module.ts and add

# Import Angular2 plugin.import { FroalaEditorModule, FroalaViewModule } from ‘angular2-froala-wysiwyg’;… @NgModule({   …   imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot() … ],   … })

open src/client/app/home/home.component.html and add

Hello, Froala!

Run webpack app
npm run start
Use with system.js, jit and aot
Create Angular app
Note: you can skip this part if you already have application generated.
git clone https://github.com/angular/quickstart.git quickstartcd quickstartnpm install
For AOT configuration, please follow the detailed guides from Angular: https://angular.io/docs/ts/latest/cookbook/aot-compiler.html.
Adding angular2-froala-wysiwyg

install angular2-froala-wysiwyg

npm install angular2-froala-wysiwyg –save

open src/index.html and add

 

open src/app/app.module.ts and add

# Import Angular2 plugin.import { FroalaEditorModule, FroalaViewModule } from ‘angular2-froala-wysiwyg’;… @NgModule({   …   imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot(), … ],   … })

open src/app/app.component.ts and add to the template

Hello, Froala!

[only if you’re using AOT] open rollup-config.js and add the following

//paths are relative to the execution pathexport default {  …  plugins: [    …    commonjs({      include: [        ‘node_modules/rxjs/**’,        ‘node_modules/angular2-froala-wysiwyg/**’      ]    }),    …  ]}
[only if you’re using AOT] Compile
ngc -p tsconfig-aot.json && rollup -c rollup-config.js
Run app
npm run start
Usage
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:
 
Other two way binding example:

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

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 Initialization
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”

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.

GitHub Repo