PHPackages piotrkochan/froala-editor-bundle - 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. [Utility & Helpers](/categories/utility) 4. / 5. piotrkochan/froala-editor-bundle ActiveSymfony-bundle[Utility & Helpers](/categories/utility) piotrkochan/froala-editor-bundle ================================ Provides a Froala editor integration for Symfony 5 & 6. 07PHP Since Sep 4Pushed 3y agoCompare [ Source](https://github.com/piotrkochan/froala-editor-bundle)[ Packagist](https://packagist.org/packages/piotrkochan/froala-editor-bundle)[ RSS](/packages/piotrkochan-froala-editor-bundle/feed)WikiDiscussions master Synced today READMEChangelogDependenciesVersions (1)Used By (0) Kochan FroalaEditor bundle ========================== [](#kochan-froalaeditor-bundle) [![Package version](https://camo.githubusercontent.com/05a635c6c99b6fbb4fb20d451ce7d80cbedb5dc1c898e108e98924101bd0ebc7/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f4b6f6368616e2f66726f616c612d656469746f722d62756e646c652e737667)](https://packagist.org/packages/Kochan/froala-editor-bundle)[![Build Status](https://camo.githubusercontent.com/ef54c38b64544121a47f036a0c508f71628198b227fbb0931cba12d9920e093c/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f4b6f6368616e2f66726f616c612d656469746f722d62756e646c652f436f6e74696e756f7573253230496e746567726174696f6e2f312e78)](https://github.com/Kochan/froala-editor-bundle/actions?query=workflow%3A%22Continuous+Integration%22)[![Downloads](https://camo.githubusercontent.com/dbb018cbfe21c140c7befc9ef175df98d1e2867cdcc1548e87984a1021a4cbec/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f4b6f6368616e2f66726f616c612d656469746f722d62756e646c652e737667)](https://packagist.org/packages/Kochan/froala-editor-bundle)[![PHP Version](https://camo.githubusercontent.com/a56a8e80d3b0336578957f572a90570e5bedab237cc112b1c22f7500aeff1848/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f4b6f6368616e2f66726f616c612d656469746f722d62756e646c652e737667)](https://packagist.org/packages/Kochan/froala-editor-bundle)[![Licence](https://camo.githubusercontent.com/17b34d6caffe2a1aa8b392a886c5dcd15180fa960a59a03dcd4cf4e7dc7c8e98/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f4b6f6368616e2f66726f616c612d656469746f722d62756e646c652e737667)](https://packagist.org/packages/Kochan/froala-editor-bundle) Introduction ------------ [](#introduction) ``` This is a fork of "leapt/froala-editor-bundle", works with php 7.4+ ``` This bundle aims to easily integrate & use the Froala editor in Symfony 5.4+/6.0+. This bundle is a maintained fork of the [KMSFroalaEditorBundle](https://github.com/froala/KMSFroalaEditorBundle). The changelog is available here: - [CHANGELOG-1.x.md](CHANGELOG-1.x.md) Table of Contents ----------------- [](#table-of-contents) 1. [Migration to Kochan Froala Editor bundle from KMS](#migration-to-Kochan-froala-editor-bundle-from-kms) 2. [Installation](#installation) 1. [Step 1: Install the bundle using composer](#step-1-install-the-bundle-using-composer) 2. [Step 2: Add the bundle to your bundles.php](#step-2-add-the-bundle-to-your-bundlesphp) 3. [Step 3: Import routes](#step-3-import-routes) 4. [Step 4: Load Twig form widget](#step-4-load-twig-form-widget) 5. [Step 5: Configure the bundle](#step-5-configure-the-bundle) 1. [Required](#required) 2. [Other options](#other-options) 6. [Step 6: Add Froala to your form](#step-6-add-froala-to-your-form) 7. [Step 7: Install asset files](#step-7-install-asset-files) 8. [Step 8: Display editor content](#step-8-display-editor-content) 1. [Manually](#manually) 2. [Using the Twig extension](#using-the-twig-extension) 9. [Step 9: Profiles (custom configurations)](#step-9-profiles-custom-configurations) 3. [More configuration](#more-configuration) 1. [Plugins](#plugins) 2. [Concept: Image upload/manager](#concept-image-uploadmanager) 3. [Concept: File upload](#concept-file-upload) 4. [Concept: Autosave](#concept-auto-save) 5. [Webpack Encore configuration](#webpack-encore-configuration) 4. [TODO](#todo) 5. [Licence](#licence) 6. [Contributing](#contributing) Migration to Kochan Froala Editor bundle from KMS ------------------------------------------------- [](#migration-to-kochan-froala-editor-bundle-from-kms) It now supports only Symfony 5.4+ & 6.0+, and PHP >= 8.0. Symfony 5.3 is supported in v1.0.0, but its support has been dropped in v1.1.0. Replace occurrences of "kms" by "Kochan" everywhere (matching case: `KMS` becomes `Kochan` & `kms` becomes `Kochan`). Installation ------------ [](#installation) ### Step 1: Install the bundle using composer [](#step-1-install-the-bundle-using-composer) ``` composer require Kochan/froala-editor-bundle ``` Note: if you install the bundle using Symfony Flex & accepted the recipe, you can skip steps 2 to 4. ### Step 2: Add the bundle to your bundles.php [](#step-2-add-the-bundle-to-your-bundlesphp) ``` // config/bundles.php return [ //.. Kochan\FroalaEditorBundle\KochanFroalaEditorBundle::class => ['all' => true], ]; ``` ### Step 3: Import routes [](#step-3-import-routes) ``` # config/routes.yaml kochan_froala_editor: resource: '@KochanFroalaEditorBundle/Resources/config/routing.php' prefix: /froalaeditor ``` ### Step 4: Load Twig form widget [](#step-4-load-twig-form-widget) ``` # In config/packages/twig.yaml twig: form_themes: - '@KochanFroalaEditor/Form/froala_widget.html.twig' ``` ### Step 5: Configure the bundle [](#step-5-configure-the-bundle) #### Required [](#required) First, you have to select your language, other settings are optional (see below). ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: language: 'nl' ``` #### Other options [](#other-options) All Froala options ([list provided here](https://www.froala.com/wysiwyg-editor/docs/options)) are supported. Just add the option name (prefixed with `froala_` if it's in your form type) with your value. If you want to keep Froala default value, don't provide anything in your config file. For options which require an array, provide a value array. For options which require an object, provide a key/value array. Note that some options need some plugins (all information provided in the [Froala documentation](https://www.froala.com/wysiwyg-editor/docs/options)). Example for each option type below: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: toolbarInline: true tableColors: [ '#FFFFFF', '#FF0000' ] saveParams: { "id" : "myEditorField" } ``` To provide a better integration with Symfony, some custom options are added, see the full list below: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: # Froala licence number if you want to use a purchased licence. serialNumber: 'XXXX-XXXX-XXXX' # Disable CodeMirror inclusion. includeCodeMirror: false # Disable Font Awesome inclusion. includeFontAwesome: false # Disable all bundle JavaScript inclusion (not concerning CodeMirror). # Usage: if you are using Grunt or Webpack or other, and you want to include yourself all scripts. includeJS: false # Disable all bundle CSS inclusion (not concerning Font Awesome nor CodeMirror). # Usage: if you are using Grunt or Webpack or other, and you want to include yourself all stylesheets. includeCSS: false # Change the froala base path. # Useful eg. when you load it from your own public directory. # Defaults to "/bundles/kochanfroalaeditor/froala_editor" basePath: '/my/custom/path' # Custom JS file. # Usage: add custom plugins/buttons... customJS: '/custom/js/path' ``` ### Step 6: Add Froala to your form [](#step-6-add-froala-to-your-form) Just add a Froala type in your form: ``` use Kochan\FroalaEditorBundle\Form\Type\FroalaEditorType; $builder->add('field', FroalaEditorType::class); ``` All configuration items can be overridden: ``` $builder->add('field', FroalaEditorType::class, [ 'froala_language' => 'fr', 'froala_toolbarInline' => true, 'froala_tableColors' => ['#FFFFFF', '#FF0000'], 'froala_saveParams' => ['id' => 'myEditorField'], ]); ``` ### Step 7: Install asset files [](#step-7-install-asset-files) To install the asset files, there is `froala:install` command that downloads the last version available of Froala Editor and puts it by default in the `vendor/Kochan/froala-editor-bundle/src/Resources/public/froala_editor/` directory: ``` bin/console froala:install ``` There are a few arguments/options available: - First (and only) argument (optional): the absolute path where the files will be put after download. Defaults to `vendor/Kochan/froala-editor-bundle/src/Resources/public/froala_editor/`. - Option `tag`: the version of Froala that will be installed (eg. `v4.0.1`). Defaults to `master`. - Option `clear` (no value expected, disabled by default): Allow the command to clear a previous install if the path already exists. After you launched the install command, you have to link assets, eg.: ``` bin/console assets:install --symlink public ``` ### Step 8: Display editor content [](#step-8-display-editor-content) #### Manually [](#manually) To preserve the look of the edited HTML outside of the editor you have to include the following CSS files: ``` ``` Also, you should make sure that you put the edited content inside an element that has the class fr-view: ``` {{ myContentHtml|raw }} ``` #### Using the Twig extension [](#using-the-twig-extension) To use the Twig extension, simply call the display function (note that the front CSS file is not included if the parameter includeCSS is false): ``` {{ froala_display(myContentHtml) }} ``` ### Step 9: Profiles (custom configurations) [](#step-9-profiles-custom-configurations) You can define several configuration profiles that will be reused in your forms, without repeating these configurations. When using a profile, the root configuration options will be used & overridden: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: heightMax: 400 attribution: false profiles: profile_1: heightMax: 500 ``` ``` use Kochan\FroalaEditorBundle\Form\Type\FroalaEditorType; $builder->add('field', FroalaEditorType::class, [ 'froala_profile' => 'profile_1', ]); ``` In this example, `profile_1` profile will have these configuration options set: - `heightMax`: 500 - `attribution`: false More configuration ------------------ [](#more-configuration) ### Plugins [](#plugins) All [Froala plugins](https://www.froala.com/wysiwyg-editor/docs/plugins) are enabled, but if you don't need one of them, you can disable some plugins... ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: # Disable some plugins. pluginsDisabled: [ 'save', 'fullscreen' ] ``` ... or chose only plugins to enable: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: # Enable only some plugins. pluginsEnabled: [ 'image', 'file' ] ``` Plugins can be enabled/disabled for each Froala instance by passing the same array in the form builder. ### Concept: Image upload/manager [](#concept-image-uploadmanager) This bundle provides an integration of the [Froala image upload concept](https://www.froala.com/wysiwyg-editor/docs/concepts/image/upload) to store your images on your own web server (see custom options for configuration like upload folder). If you want to use your own uploader, you can override the configuration (if you need to do that, please explain me why to improve the provided uploader). To provide a better integration with Symfony, some custom options are added, see the full list below: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: # The image upload folder in your /web directory. # Default: "/upload". imageUploadFolder: '/my/upload/folder' # The image upload URL base. # Usage: if you are using URL rewriting for your assets. # Default: same value as provided as folder. imageUploadPath: '/my/upload/path' ``` ### Concept: File upload [](#concept-file-upload) This bundle provides an integration of the [Froala file upload concept](https://www.froala.com/wysiwyg-editor/docs/concepts/file/upload) to store your files on your own web server (see custom options for configuration like upload folder). If you want to use your own uploader, you can override the configuration (if you need to do that, please explain me why to improve the provided uploader). To provide a better integration with Symfony, some custom options are added, see the full list below: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: # The file upload folder in your /web directory. # Default: "/upload". fileUploadFolder: '/my/upload/folder' # The file upload URL base. # Usage: if you are using URL rewritting for your assets. # Default: same value as provided as folder. fileUploadPath: '/my/upload/path' # Your public directory, from the root directory. # Default: "/public" publicDir: '/home' ``` ### Concept: Auto-save [](#concept-auto-save) The [Froala auto-save concept](https://www.froala.com/wysiwyg-editor/docs/concepts/save/autosave) to automatically request a save action on your server is working, just enter the correct options in your configuration file: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: saveURL: 'my_save_route' saveInterval: 2500 saveParam: "content" ``` To provide a better integration with Symfony, some custom options are added, see the full list below: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: # Add some parameters to your save URL. # Usage: if you need parameters to generate your save action route (see save explaination below). # Default: null. saveURLParams: { "id" : "myId" } ``` You can add some parameters in your save route (see custom options). ### Webpack Encore configuration [](#webpack-encore-configuration) If you want to load Froala asset files using npm/yarn and Webpack Encore, here's how to do it: ``` import FroalaEditor from 'froala-editor'; import 'froala-editor/css/froala_editor.pkgd.min.css'; import 'froala-editor/css/froala_style.min.css'; // Load your languages import 'froala-editor/js/languages/fr.js'; // Load all plugins, or specific ones import 'froala-editor/js/plugins.pkgd.min.js'; import 'froala-editor/css/plugins.pkgd.min.css'; window.FroalaEditor = FroalaEditor; function froalaDisplayError(p_editor, error ) { alert(`Error ${error.code}: ${error.message}`); } window.froalaDisplayError = froalaDisplayError; ``` Now you can disable Froala bundle CSS/JS inclusion: ``` # config/packages/kochan_froala_editor.yaml kochan_froala_editor: includeJS: false includeCSS: false ``` Don't forget to import the generated Encore CSS/JS files in your HTML if needed. TODO ---- [](#todo) - Add some tests Licence ------- [](#licence) This bundle provides an integration of the WYSIWYG [Froala Editor](https://www.froala.com/wysiwyg-editor) commercial version. Please read the [Froala licence agreement](https://www.froala.com/wysiwyg-editor/terms) and go to the [pricing page](https://www.froala.com/wysiwyg-editor/pricing)if you don't have a licence. Contributing ------------ [](#contributing) Feel free to contribute, like sending [pull requests](https://github.com/Kochan/froala-editor-bundle/pulls) to add features/tests. Note there are a few helpers to maintain code quality, that you can run using these commands: ``` composer cs:dry # Code style check composer phpstan # Static analysis vendor/bin/phpunit # Run tests ``` ### Health Score 16 — LowBetter than 4% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity4 Limited adoption so far Community15 Small or concentrated contributor base Maturity25 Early-stage or recently created project Bus Factor1 Top contributor holds 51.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/8d477de9426821648587277a731c8820caef55175ee90c51244ea12eeba1116c?d=identicon)[piotrkochan](/maintainers/piotrkochan) --- Top Contributors [![jmsche](https://avatars.githubusercontent.com/u/3929498?v=4)](https://github.com/jmsche "jmsche (46 commits)")[![Parashuram-Sram](https://avatars.githubusercontent.com/u/42605654?v=4)](https://github.com/Parashuram-Sram "Parashuram-Sram (10 commits)")[![stefanneculai](https://avatars.githubusercontent.com/u/637004?v=4)](https://github.com/stefanneculai "stefanneculai (7 commits)")[![diananeculai](https://avatars.githubusercontent.com/u/1551136?v=4)](https://github.com/diananeculai "diananeculai (6 commits)")[![mpoiriert](https://avatars.githubusercontent.com/u/4175616?v=4)](https://github.com/mpoiriert "mpoiriert (4 commits)")[![dheerajaccolite](https://avatars.githubusercontent.com/u/47217695?v=4)](https://github.com/dheerajaccolite "dheerajaccolite (4 commits)")[![kapil2704](https://avatars.githubusercontent.com/u/47421622?v=4)](https://github.com/kapil2704 "kapil2704 (4 commits)")[![benatespina](https://avatars.githubusercontent.com/u/3951376?v=4)](https://github.com/benatespina "benatespina (2 commits)")[![UFTimmy](https://avatars.githubusercontent.com/u/7061770?v=4)](https://github.com/UFTimmy "UFTimmy (2 commits)")[![piotrkochan](https://avatars.githubusercontent.com/u/5632761?v=4)](https://github.com/piotrkochan "piotrkochan (1 commits)")[![fabianfabian](https://avatars.githubusercontent.com/u/343640?v=4)](https://github.com/fabianfabian "fabianfabian (1 commits)")[![VaShu](https://avatars.githubusercontent.com/u/2881266?v=4)](https://github.com/VaShu "VaShu (1 commits)")[![gsaulmon](https://avatars.githubusercontent.com/u/730440?v=4)](https://github.com/gsaulmon "gsaulmon (1 commits)") ### Embed Badge ![Health badge](/badges/piotrkochan-froala-editor-bundle/health.svg) ``` [![Health](https://phpackages.com/badges/piotrkochan-froala-editor-bundle/health.svg)](https://phpackages.com/packages/piotrkochan-froala-editor-bundle) ``` ### Alternatives [deptrac/deptrac Deptrac is a static code analysis tool that helps to enforce rules for dependencies between software layers. 3.0k8.8M111](/packages/deptrac-deptrac)[akaunting/laravel-menu Menu and sidebar management package for Laravel 38254.2k](/packages/akaunting-laravel-menu)[smile/module-map Smile Map Utilities Module 10554.7k3](/packages/smile-module-map) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)