@mitch528/angular-froala-wysiwyg
Advanced tools
Angular 2, 4, 5, 6 and 7 bindings for Froala WYSIWYG HTML rich text editor
Angular 2, Angular 4, Angular 5, Angular 6 and Angular 7 bindings for Froala WYSIWYG Editor.
Install angular-froala-wysiwyg from npm
npm install angular-froala-wysiwyg
You will need CSS styles and Font Awesome
<!-- index.html -->
<link href="node_modules/froala-editor/css/froala_editor.pkgd.min.css" rel="stylesheet">
<link href="node_modules/font-awesome/css/font-awesome.min.css" rel="stylesheet">
npm update froala-editor --save
Note: you can skip this part if you already have application generated.
npm install -g @angular/cli
ng new my-app
cd my-app
angular-froala-wysiwygnpm install angular-froala-wysiwyg --save
src/app/app.module.ts and add// Import Angular plugin.
import { FroalaEditorModule, FroalaViewModule } from 'angular-froala-wysiwyg';
...
@NgModule({
...
imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot() ... ],
...
})
angular.json file and insert a new entry into the styles array"styles": [
"styles.css",
"./node_modules/froala-editor/css/froala_editor.pkgd.min.css",
"./node_modules/froala-editor/css/froala_style.min.css",
"./node_modules/font-awesome/css/font-awesome.css"
]
angular.json file 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"
]
src/app/app.component.html and add<div [froalaEditor]>Hello, Froala!</div>
ng serve
ionic v2 or v3Note: you can skip this part if you already have application generated.
npm install -g cordova ionic
ionic start myApp blank
cd myApp
For v3 make sure that you use the latest version of ionic and also the latest version of angular.
Installing Froala Wysiwyg Editor in Ionic is fairly easy, it can be done using npm:
npm install angular-froala-wysiwyg --save
src/app/app.module.ts and add// Import Froala Editor.
import "froala-editor/js/froala_editor.pkgd.min.js";
// Import Angular2 plugin.
import { FroalaEditorModule, FroalaViewModule } from 'angular-froala-wysiwyg';
...
@NgModule({
...
imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot() ... ],
...
})
src/app/main.ts and addimport * as $ from 'jquery';
window["$"] = $;
window["jQuery"] = $;
package.json add the following:"config": {
"ionic_copy": "./config/copy.config.js"
}
mkdir config
cp node_modules/@ionic/app-scripts/config/copy.config.js ./config/
config/copy.config.js file and add the following at the beginning of module.exportsmodule.exports = {
copyFroalaEditorCss: {
src: ['{{ROOT}}/node_modules/froala-editor/css/froala_editor.pkgd.min.css', '{{ROOT}}/node_modules/froala-editor/css/froala_style.min.css'],
dest: '{{BUILD}}'
},
copyFontAwesome: {
src: '{{ROOT}}/node_modules/font-awesome/css/font-awesome.min.css',
dest: '{{BUILD}}'
},
copyFontsAwesomeFonts: {
src: '{{ROOT}}/node_modules/font-awesome/fonts/*',
dest: '{{WWW}}/fonts'
},
...
}
src/index.html file and add in the <head> tag:<link rel="stylesheet" href="build/font-awesome.min.css">
<link rel="stylesheet" href="build/froala_editor.pkgd.min.css">
<link rel="stylesheet" href="build/froala_style.min.css">
In your desired view add the Froala Editor like this:
<div [froalaEditor]>Hello, Froala!</div>
ionic serve
webpackNote: you can skip this part if you already have application generated.
git clone --depth 1 https://github.com/AngularClass/angular-starter.git
cd angular-starter
npm install
angular-froala-wysiwygnpm install angular-froala-wysiwyg --save
src/app/app.module.ts and add// Import the Froala Editor plugin.
import "froala-editor/js/froala_editor.pkgd.min.js";
// Import Angular plugin.
import { FroalaEditorModule, FroalaViewModule } from 'angular-froala-wysiwyg';
...
@NgModule({
...
imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot(), ... ],
...
})
src/app/app.component.ts and add to the template<div [froalaEditor]>Hello, Froala!</div>
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'
}
config/webpack.common.js copy the following to pluginsnew webpack.ProvidePlugin({
$: "jquery",
jQuery: "jquery"
})
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' },
{ rel: 'stylesheet', href: '/assets/froala-editor/css/froala_style.min.css' }
npm run start
angular-seedNote: 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.git
cd angular-seed
npm install
angular-froala-wysiwygnpm install angular-froala-wysiwyg --save
tools/config/project.config.ts file and uncomment the following line from the top of the fileimport { ExtendPackages } from './seed.config.interfaces';
tools/config/project.config.ts file 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 },
{ src: 'froala-editor/css/froala_style.min.css', inject: true }
];
...
let additionalPackages: ExtendPackages[] = [
// required for dev build
{
name:'angular-froala-wysiwyg',
path:'node_modules/angular-froala-wysiwyg/bundles/angular-froala-wysiwyg.umd.min.js'
},
// required for prod build
{
name:'angular-froala-wysiwyg/*',
path:'node_modules/angular-froala-wysiwyg/bundles/angular-froala-wysiwyg.umd.min.js'
}
]
this.addPackagesBundles(additionalPackages);
src/client/app/home/home.module.ts and add// Import Angular2 plugin.
import { FroalaEditorModule, FroalaViewModule } from 'angular-froala-wysiwyg';
...
@NgModule({
...
imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot() ... ],
...
})
src/client/app/home/home.component.html and add<div [froalaEditor]>Hello, Froala!</div>
npm run start
system.js and JITNote: you can skip this part if you already have application generated.
git clone https://github.com/angular/quickstart.git angular-quickstart
cd angular-quickstart
npm install
angular-froala-wysiwygnpm install angular-froala-wysiwyg --save
src/index.html and add<link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css">
<link rel="stylesheet" href="node_modules/froala-editor/css/froala_editor.pkgd.min.css">
<link rel="stylesheet" href="node_modules/froala-editor/css/froala_style.min.css">
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/froala-editor/js/froala_editor.pkgd.min.js"></script>
src/app/app.module.ts and add// Import Angular2 plugin.
import { FroalaEditorModule, FroalaViewModule } from 'angular-froala-wysiwyg';
...
@NgModule({
...
imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot(), ... ],
...
})
src/app/app.component.ts file and add to the template<div [froalaEditor]>Hello, Froala!</div>
src/systemjs.config.js file and add to mapmap: {
...
'angular-froala-wysiwyg': 'npm:angular-froala-wysiwyg/bundles/angular-froala-wysiwyg.umd.js',
...
}
<div [froalaEditor]>Hello, Froala!</div>
npm run start
aotNote: you can skip this part if you already have application generated.
git clone https://github.com/angular/quickstart.git angular-quickstart
cd angular-quickstart
npm install
Install additional dependencies. Make sure that there is no UNMET PEER DEPENDENCY.
npm install @angular/compiler-cli @angular/platform-server --save
npm install rollup rollup-plugin-node-resolve rollup-plugin-commonjs rollup-plugin-uglify --save-dev
npm install lite-server --save-dev
Copy scr/tsconfig.json to a new file called tsconfig-aot.json in the root of the project, then modify it as follows.
{
"compilerOptions": {
"target": "es5",
"module": "es2015",
"moduleResolution": "node",
"sourceMap": true,
"emitDecoratorMetadata": true,
"experimentalDecorators": true,
"lib": ["es2015", "dom"],
"noImplicitAny": true,
"suppressImplicitAnyIndexErrors": true,
"typeRoots": [
"./node_modules/@types/"
]
},
"files": [
"src/app/app.module.ts",
"src/main.ts"
],
"angularCompilerOptions": {
"genDir": "aot",
"skipMetadataEmit" : true
}
}
Create a configuration file (rollup-config.js) in the project root directory to tell Rollup how to process the application.
import nodeResolve from 'rollup-plugin-node-resolve';
import commonjs from 'rollup-plugin-commonjs';
import uglify from 'rollup-plugin-uglify';
export default {
entry: 'src/main.js',
dest: 'src/build.js', // output a single application bundle
sourceMap: false,
format: 'iife',
onwarn: function(warning) {
// Skip certain warnings
// should intercept ... but doesn't in some rollup versions
if ( warning.code === 'THIS_IS_UNDEFINED' ) { return; }
// console.warn everything else
console.warn( warning.message );
},
plugins: [
nodeResolve({jsnext: true, module: true}),
commonjs({
include: 'node_modules/rxjs/**',
}),
uglify()
]
};
Update src/main.ts file for AOT:
import { platformBrowser } from '@angular/platform-browser';
import { AppModuleNgFactory } from '../aot/src/app/app.module.ngfactory';
console.log('Running AOT compiled');
platformBrowser().bootstrapModuleFactory(AppModuleNgFactory);
angular-froala-wysiwygnpm install angular-froala-wysiwyg --save
src/index.html and add<link rel="stylesheet" href="node_modules/font-awesome/css/font-awesome.min.css">
<link rel="stylesheet" href="node_modules/froala-editor/css/froala_editor.pkgd.min.css">
<link rel="stylesheet" href="node_modules/froala-editor/css/froala_style.min.css">
<script src="node_modules/jquery/dist/jquery.min.js"></script>
<script src="node_modules/froala-editor/js/froala_editor.pkgd.min.js"></script>
src/app/app.module.ts and add// Import Angular2 plugin.
import { FroalaEditorModule, FroalaViewModule } from 'angular-froala-wysiwyg';
...
@NgModule({
...
imports: [FroalaEditorModule.forRoot(), FroalaViewModule.forRoot(), ... ],
...
})
src/app/app.component.ts file and add to the template<div [froalaEditor]>Hello, Froala!</div>
rollup-config.js and add the following//paths are relative to the execution path
export default {
...
plugins: [
...
commonjs({
include: [
'node_modules/rxjs/**',
'node_modules/angular-froala-wysiwyg/**'
]
}),
...
]
}
node_modules/.bin/ngc -p tsconfig-aot.json
node_modules/.bin/rollup -c rollup-config.js -c rollup-config.js
lite-server
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:
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.
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>
Use it with reactive forms:
<form [formGroup]="form" (ngSubmit)="onSubmit()">
<textarea [froalaEditor] formControlName="formModel"></textarea>
<button type="submit">Submit</button>
</form>
If you want to use two-way binding to display the form model in other places you must include [(froalaModel)]:
<form [formGroup]="form" (ngSubmit)="onSubmit()">
<textarea [froalaEditor] formControlName="formModel" [(froalaModel)]="form.formModel"></textarea>
<div [froalaView]="form.formModel"></div>
<button type="submit">Submit</button>
</form>
If you want to wrap froalaEditor directive into a component that supports reactive forms please see froala.component.ts from demo.
You can extend the functionality by adding a custom button like bellow:
// We will make usage of the Init hook and make the implementation there.
import { Component, OnInit } from '@angular/core';
declare var $ :any;
@Component({
selector: 'app-demo',
template: `<div class="sample">
<h2>Sample 11: Add Custom Button</h2>
<div [froalaEditor]="options" [(froalaModel)]="content" ></div>
</div>`,
export class AppComponent implements OnInit{
ngOnInit () {
$.FroalaEditor.DefineIcon('alert', {NAME: 'info'});
$.FroalaEditor.RegisterCommand('alert', {
title: 'Hello',
focus: false,
undo: false,
refreshAfterCallback: false,
callback: () => {
alert('Hello!', this);
}
});
}
public options: Object = {
charCounterCount: true,
toolbarButtons: ['bold', 'italic', 'underline', 'paragraphFormat','alert'],
toolbarButtonsXS: ['bold', 'italic', 'underline', 'paragraphFormat','alert'],
toolbarButtonsSM: ['bold', 'italic', 'underline', 'paragraphFormat','alert'],
toolbarButtonsMD: ['bold', 'italic', 'underline', 'paragraphFormat','alert'],
};
}
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.
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.
public inputOptions: Object = {
angularIgnoreAttrs: ['class', 'id']
};
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:
To display content created with the froala editor use the froalaView directive.
[froalaView]="editorContent"
<div [froalaEditor] [(froalaModel)]="editorContent"></div>
<div [froalaView]="editorContent"></div>
The angular-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.
If you want to contribute to angular-froala-wyswiyg, you will first need to install the required tools to get the project going.
$ npm install
$ npm run demo.build
$ npm run start
FAQs
Angular 2, 4, 5, 6 and 7 bindings for Froala WYSIWYG HTML rich text editor
We found that @mitch528/angular-froala-wysiwyg demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.