Skip to content

Latest commit

 

History

History
148 lines (105 loc) · 5.49 KB

README.md

File metadata and controls

148 lines (105 loc) · 5.49 KB
Raw

angular-froala

angular-froala provides AngularJS bindings to the froala WYSIWYG editor VERSION 2.

##Version 2 This repository contains bindings for the latest version of the Froala Editor (version 2). Checkout the V1 branch for support of Version 1 of the editor.

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 angular-froala files into your project

    • src/angular-froala.js
    • src/froala-sanitize.js

Usage

  1. Add the froala dependency to your Angular project. example:
    • angular.module('myApp', ['froala'])
  2. Create a textarea with the froala directive in your view and give it a model, where myHtml is a variable on $scope.
    • <textarea froala ng-model="myHtml"></textarea>

###Options

Setting Defaults: to set defaults for the editor pass a config object to angular.value with the key froalaConfig like this:

angular.module('myApp', ['froala']).
	value('froalaConfig', {
		toolbarInline: false,
		placeholderText: 'Enter Text Here'
	});

From the Controller: to set options from the controller, create an options object on scope and simply pass it to the froala directive. example:

app.js

function myCtrl($scope){
	$scope.myHtml = "<h1>Hello World</h1>"
	$scope.froalaOptions = {
		toolbarButtons : ["bold", "italic", "underline", "|", "align", "formatOL", "formatUL"]
	}
}

view.html

<textarea froala="froalaOptions" ng-model="myHtml"></textarea>

View a list of all the options available in the docs

###Methods

To use the methods available, access the editor instance from your froalaOptions object $scope.options.froalaEditor(method) and use it as described in the method docs. example:

function myCtrl($scope){
	$scope.myHtml = "";
	$scope.froalaOptions = {
		toolbarButtons : ["bold", "italic", "underline", "|", "align", "formatOL", "formatUL"],
		events: {
			'froalaEditor.initialized': function () {
				// Use the methods like this.
				$scope.froalaOptions.froalaEditor('selection.get');
			}
		}
	}

###Events 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. ####Attribute app.js

$scope.froalaOptions = {
	placeholder: "Edit Me",
	events : {
		'froalaEditor.focus' : function(e, editor) {/* ... */}
	}

###Manual Instantiation Sometimes you want to control when the Froala Editor will be instantiated. The directive includes a froala-init attributes which will provide you with the controls required to initialize and close the editor.

<div froala froala-init="myControllerFunction(initcontrols)"></div>

Where MyControllerFunction is the name of a function in your controller which will receive an object with different methods to control the editor initialization process. It is primordial that the name of the parameter be initControls otherwise your function will not receive the controls.

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

Checkout the demo file to see a working example.

###Displaying Html

Using ng-bind-html will render your html on the page but the default angular-sanitize.js will strip out all style tags. Remedy this by including froala-sanitize.js instead. example: <div class="fr-view" ng-bind-html="myHtml"></div>

Congrats all is done!

License

The angular-froala 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 Angular-Froala, you will first need to install the required tools to get the project going.

Prerequisites

Dependencies

Installation

Clone the Git Angular-Froala repository on your local machine and run the commands below in the project root directory.

#####1. Install Grunt and Bower

$ npm install -g grunt-cli bower

#####2. Install project dependencies

$ npm install
$ bower install

Running tests

Each contribution to the project should come with its set of unit tests thus ensuring that the new behaviour will not be altered by subsequent commits. So, before each commit to the repository, run the tests by running the following grunt task:

$ grunt test

This will first run a javascript linting tool (JSHint) to make sure that the code is clean and in accordance to the standards. If any errors or warnings are found, they will be displayed on the console. Fix them and rerun the task. When the code is doesn't have any linting warning, the unit tests will be run.