PHPackages                             froala/wysiwyg-cake - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. froala/wysiwyg-cake

ActiveCakephp-plugin

froala/wysiwyg-cake
===================

A beautiful WYSIWYG text editor based on HTML5 technology. Cross browser, with mobile support, high performance and Retina Ready modern design.

v5.0.1(3mo ago)910.9k↓27.8%16[5 PRs](https://github.com/froala/wysiwyg-cake/pulls)proprietaryCSSPHP >=5.5.9CI passing

Since May 5Pushed 3mo ago5 watchersCompare

[ Source](https://github.com/froala/wysiwyg-cake)[ Packagist](https://packagist.org/packages/froala/wysiwyg-cake)[ Docs](https://www.froala.com/wysiwyg-editor)[ RSS](/packages/froala-wysiwyg-cake/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (3)Versions (88)Used By (0)

Froala WYSIWYG Editor Plugin for CakePHP 3
==========================================

[](#froala-wysiwyg-editor-plugin-for-cakephp-3)

[![Packagist](https://camo.githubusercontent.com/f20a02b0b73047097a0567129503af93a34e9bfbae342247b7bc3615b608317e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f66726f616c612f777973697779672d63616b652e737667)](https://packagist.org/packages/froala/wysiwyg-cake)[![Packagist](https://camo.githubusercontent.com/1e34345526e75e137c558587136e32a902b4404ac8d4a5152681bd8e05fe64ae/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f66726f616c612f777973697779672d63616b652e737667)](https://packagist.org/packages/froala/wysiwyg-cake)

> CakePHP Plugin for Froala Javascript WYSIWYG Text Editor. For CakePHP >=3.0.

> See [froala/wysiwyg-cake2](https://github.com/froala/wysiwyg-cake2) for CakePHP version 2.

About
-----

[](#about)

The purpose of placing [Froala WYSIWYG Editor](https://www.froala.com/wysiwyg-editor) in a plugin is to keep it separate from a themed view, the regular webroot or the app in general, which makes it easier to update and overall follows the idea of keeping the code clean and modular.

Installation
------------

[](#installation)

To use Froala WYSIWYG Editor you need to clone git repository:

```
git clone git://github.com/froala/wysiwyg-cake.git Plugin/Froala

```

Or if your CakePHP application is setup as a git repository, you can add it as a submodule:

```
git submodule add git://github.com/froala/wysiwyg-cake.git Plugin/Froala

```

Or open terminal/command prompt (windows) type composer require froala/wysiwyg-cake

Alternatively, you can download an archive from the [master branch on Github](https://github.com/froala/wysiwyg-cake/archive/master.zip) and extract the contents to `Froala plugin`.

Make sure that you load the plugin routes by adding to your bootstrap file(bootstrap.php) in config folder:

Plugin::loadAll(); or Plugin::load('Froala'); This will load all plugins at once or only the Froala plugin.

Usage
-----

[](#usage)

The Froala helper is basically just a convenience helper that allows you to use php and CakePHP conventions to generate the configuration for Froala and as an extra it allows you to load configs.

```
// Loads Froala Editor javascript also will load all the plugins and css for the plugins

// Will target one specific html selector on which the editor will be init.
// Second paramenter is mix can be array/object of options that the Froala Editor will take.