ajsridha / ember-froala-editor

Ember component for Froala WYSIWYG HTML Rich Text Editor.

Ember Froala Editor Addon

Bring the Froala WYSIWYG Editor into an ember-cli project with this addon. Besides importing the required Froala Editor files, the main part of this addon is the {{froala-editor}} component. Checkout the documentation Website for installation, configuration, and usage details.

Compatibility

ember and ember-cli 2.4.2+

Installation

ember install ember-froala-editor

Configuration

Take a look at the configuration documentation page for details on the exact configuration options. But basically you add 'ember-froala-editor':{} within your ember-cli-build.js file and adjust the available configuration options. Ex:

// ember-cli-build.js
// ... (snip)

  'ember-froala-editor': {
    plugins  : true,
    languages: ['es','fr','de'],
    themes   : 'royal'
  },

// ... (snip)

Usage

Take a look at the documentation Website for full usage details. But basically this addon comes with a few Ember Components and Helpers to use within your project templates.

{{froala-editor}}
{{froala-content}}

(froala-method)
(merged-hash)

Development

• git clone this repository (fork if you plan on submitting a PR)
• cd ember-froala-editor
• npm install
• bower install

Running Docs Server

• ember server
• Visit the docs at http://localhost:4200

Running Tests

• npm test (Runs ember try:each to test against multiple Ember versions)
• ember test
• ember test --server
• ember server (Visit tests at http://localhost:4200/tests)

Releasing

Notes to self really...

1. If needed, bump the froala-editor version in package.json dependencies
2. npm version x.y.z - Updates the version in package.json and tags in git
3. git push origin master --follow-tags - Pushes any changes and the new version tag up to Github
4. Update the new tag on the Github Releases page
5. npm run deploy - Deploys the docs to gh-pages using ember-cli-github-pages

• May need to git push, deploy will say if this is needed

6. git checkout master - Need to switch back to master after deploying the docs..
7. npm publish - Release the new version to the world!

License

The ember-froala-editor 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.