Git Product home page Git Product logo

ember-froala-editor's Introduction

Ember Froala Editor Addon Build Status Ember Observer Score Join the chat at https://gitter.im/froala/ember-froala-editor

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

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
  1. git checkout master - Need to switch back to master after deploying the docs..
  2. 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.

ember-froala-editor's People

Contributors

dianaprajescu avatar ember-tomster avatar gitter-badger avatar mike183 avatar panman82 avatar rlivsey avatar stefanneculai avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.