Days
Hours
Minutes
Seconds
x

Froala Editor v4.2.0 is Here LEARN MORE

Skip to content

react

React JS Froala WYSIWYG Editor

Installation

To install react-froala-wysiwyg run:

npm install react-froala-wysiwyg --save
    

Update editor version

To update react-froala-wysiwyg run:

npm update froala-editor
    

Install font-awesome

Font-awesome is used for the editor icons. To install font-awesome run:

npm install font-awesome --save
    

Usage

  1. Require and use Froala Editor component inside your application.
    import React from 'react';
                import ReactDOM from 'react-dom';
                
                // Require Editor CSS files.
                import 'froala-editor/css/froala_style.min.css';
                import 'froala-editor/css/froala_editor.pkgd.min.css';
                
                import FroalaEditorComponent from 'react-froala-wysiwyg';
                
                // Import all Froala Editor plugins;
                // import 'froala-editor/js/plugins.pkgd.min.js';
                
                // Import a single Froala Editor plugin.
                // import 'froala-editor/js/plugins/align.min.js';
                
                // Import a language file.
                // import 'froala-editor/js/languages/de.js';
                
                // Import a third-party plugin.
                // import 'froala-editor/js/third_party/image_tui.min.js';
                // import 'froala-editor/js/third_party/embedly.min.js';
                // import 'froala-editor/js/third_party/spell_checker.min.js';
                
                // Include font-awesome css if required.
                // install using "npm install font-awesome --save"
                // import 'font-awesome/css/font-awesome.css';
                // import 'froala-editor/js/third_party/font_awesome.min.js';
                
                // Include special components if required.
                // import FroalaEditorView from 'react-froala-wysiwyg/FroalaEditorView';
                // import FroalaEditorA from 'react-froala-wysiwyg/FroalaEditorA';
                // import FroalaEditorButton from 'react-froala-wysiwyg/FroalaEditorButton';
                // import FroalaEditorImg from 'react-froala-wysiwyg/FroalaEditorImg';
                // import FroalaEditorInput from 'react-froala-wysiwyg/FroalaEditorInput';
                
                // Render Froala Editor component.
                const root = ReactDOM.createRoot(document.getElementById('editor'));
                root.render(
                  <FroalaEditorComponent tag='textarea'/>
                )
                
            
  2. Add the editor to the application UI by passing id to html element
    <div id="editor">
        </div>   
    
  3. Pass properties to the wrapping DOM element
    <FroalaEditor
              tag='textarea'
              config={config}
              model={model}
              onModelChange={handleModelChange}
        />
    
    tag attr is used to tell on which tag the editor is initialized. There are special tags: a, button, img, input. Do not use them in FroalaEditor component. To initialize the editor on a special tag, use FroalaEditorA, FroalaEditorButton, FroalaEditorImg and FroalaEditorInput components.
 

Config

You can pass editor options as component attributes (optional). config={config} You can pass any existing Froala option. Consult the Froala Editor documentation to view the list of all the available options:
config={{
          placeholderText: 'Edit Your Content Here!',
          charCounterCount: false
        }}
You can use the aditional option: * immediateReactModelUpdate: (default: false) This option updates the React model as soon as a key is released in the editor. Note that it may affect performance.  

Events and Methods

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.
config={{
          placeholder: "Edit Me",
          events : {
            'focus' : function(e, editor) {
              console.log(editor.selection.get());
            }
          }
        }}
Using the editor instance from the arguments of the callback you can call editor methods as described in the method docs. Froala events are described in the events docs. Now you can use these buttons in options: toolbarButtons: [['undo', 'redo' , 'bold'], ['alert', 'clear', 'insert']],  

Model

The editor content model. model = {model} Two way binding:

            import React,{ useState } from 'react';
            
            const App=()=> {
              const [model,setModel] = useState("Example Set");
              
              const handleModelChange= (event)=>{
                setModel(event)
              }
              return (
                <div className="App">
                  <FroalaEditorComponent 
                    tag='textarea'
                    onModelChange={handleModelChange}
                  />
                  <FroalaEditorView
                    model={model}
                />
                </div>
              );
            }
            
To achieve one way binding and pass only the initial editor content, do not pass onModelChange attribute. Use the content in other places:
<input value={model}/>
A Step-by-Step Guide and Demos For React Integration:
 

Special tags

You can also use the editor on img, button, input and a tags:
<FroalaEditorImg
          model={model}
        />
        <FroalaEditorButton
          model={model}
        />
        <FroalaEditorInput
          model={model}
        />
        <FroalaEditorA
          model={model}
        />
The model must be an object containing the attributes for your special tags. Example:

            model={{src: 'path/to/image.jpg',
                width:"300px",
                alt:"Old Clock"
            }} 
        
  • The model can contain a special attribute named innerHTML which inserts innerHTML in the element: If you are using ‘button’ tag, you can specify the button text like this:

            model={{innerHTML: 'Click Me'}} 
            
As the button text is modified by the editor, the innerHTML attribute from buttonModel model will be modified too. Specific option for special tags
  • reactIgnoreAttrs:(default: null) This option is an array of attributes that you want to ignore when the editor updates the froalaModel
    
                config: {
                 reactIgnoreAttrs: ['class', 'id']
                },
                
    
Learn More About React Special Tags

Manual Instantiation

Gets the functionality to operate on the editor: create, destroy and get editor instance. Use it if you want to manually initialize the editor. onManualControllerReady={handleManualController}
handleManualController=  (initControls) => {
          //...
        }
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

Displaying HTML

To display content created with the Froala Editor use the FroalaEditorView component.
<FroalaEditor
          model={content}
          onModelChange={handleModelChange}
        />
        <FroalaEditorView
          model={content}
        />
  1. Require and use Froala Editor component inside your application.
     
            import React from 'react';
            import ReactDOM from 'react-dom';
            
            
            // Require Editor CSS files.
            import 'froala-editor/css/froala_style.min.css';
            import 'froala-editor/css/froala_editor.pkgd.min.css';
            
            import FroalaEditorComponent from 'react-froala-wysiwyg';
            
            // Import all Froala Editor plugins;
            // import 'froala-editor/js/plugins.pkgd.min.js';
            
            // Import a single Froala Editor plugin.
            // import 'froala-editor/js/plugins/align.min.js';
            
            // Import a language file.
            // import 'froala-editor/js/languages/de.js';
            
            // Import a third-party plugin.
            // import 'froala-editor/js/third_party/image_tui.min.js';
            // import 'froala-editor/js/third_party/embedly.min.js';
            // import 'froala-editor/js/third_party/spell_checker.min.js';
            
            // Include font-awesome css if required.
            // install using "npm install font-awesome --save"
            // import 'font-awesome/css/font-awesome.css';
            // import 'froala-editor/js/third_party/font_awesome.min.js';
            
            // Include special components if required.
            // import FroalaEditorView from 'react-froala-wysiwyg/FroalaEditorView';
            // import FroalaEditorA from 'react-froala-wysiwyg/FroalaEditorA';
            // import FroalaEditorButton from 'react-froala-wysiwyg/FroalaEditorButton';
            // import FroalaEditorImg from 'react-froala-wysiwyg/FroalaEditorImg';
            // import FroalaEditorInput from 'react-froala-wysiwyg/FroalaEditorInput';
            
            // Render Froala Editor component.
            ReactDOM.render(<FroalaEditorComponent tag='textarea'/>, document.getElementById('editor'));
            
        
    
  2. Add the editor to the application UI by passing id to html element
    <div id="editor">
    </div>   
    
  3. Pass properties to the wrapping DOM element
    <FroalaEditor
          tag='textarea'
          config={this.config}
          model={this.state.model}
          onModelChange={this.handleModelChange}
    />
    
    tag attr is used to tell on which tag the editor is initialized. There are special tags: a, button, img, input. Do not use them in FroalaEditor component. To initialize the editor on a special tag, use FroalaEditorA, FroalaEditorButton, FroalaEditorImg and FroalaEditorInput components.
 

Config

You can pass editor options as component attributes (optional). config={this.config} You can pass any existing Froala option. Consult the Froala Editor documentation to view the list of all the available options:
config={{
      placeholderText: 'Edit Your Content Here!',
      charCounterCount: false
    }}
You can use the aditional option: * immediateReactModelUpdate: (default: false) This option updates the React model as soon as a key is released in the editor. Note that it may affect performance.  

Events and Methods

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.
config={{
      placeholder: "Edit Me",
      events : {
        'focus' : function(e, editor) {
          console.log(editor.selection.get());
        }
      }
    }}
Using the editor instance from the arguments of the callback you can call editor methods as described in the method docs. Froala events are described in the events docs.  

Model

The editor content model. model = {this.state.model} Two way binding:
import React from 'react';
    
    class EditorComponent extends React.Component {
      constructor () {
        super();
    
        this.handleModelChange = this.handleModelChange.bind(this);
    
        this.state = {
          model: 'Example text'
        };
      }
    
      handleModelChange: function(model) {
        this.setState({
          model: model
        });
      }
    
      render () {
        return <FroalaEditor
                  model={this.state.model}
                  onModelChange={this.handleModelChange}
               />
      }
    }
    
To achieve one way binding and pass only the initial editor content, do not pass onModelChange attribute. Use the content in other places:
<input value={this.state.model}/>
 

Special tags

You can also use the editor on img, button, input and a tags:
<FroalaEditorImg
      config={this.config}
    />
    <FroalaEditorButton
      config={this.config}
    />
    <FroalaEditorInput
      config={this.config}
    />
    <FroalaEditorA
      config={this.config}
    />
The model must be an object containing the attributes for your special tags. Example:
constructor () {
      super();
    
      this.handleModelChange = this.handleModelChange.bind(this);
    
      this.state = {
        model: {src: 'path/to/image.jpg'}
      };
    }
  • The model can contain a special attribute named innerHTML which inserts innerHTML in the element: If you are using ‘button’ tag, you can specify the button text like this:
this.state = {
      model: {innerHTML: 'Click Me'}
    };
As the button text is modified by the editor, the innerHTML attribute from buttonModel model will be modified too.
Learn More About React Special Tags

Manual Instantiation

Gets the functionality to operate on the editor: create, destroy and get editor instance. Use it if you want to manually initialize the editor. onManualControllerReady={this.handleManualController}
handleManualController: function(initControls) {
      //...
    }
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

Displaying HTML

To display content created with the Froala Editor use the FroalaEditorView component.
<FroalaEditor
      model={this.state.content}
      onModelChange={this.handleModelChange}
    />
    <FroalaEditorView
      model={this.state.content}
    />

Using type definition file

index.d.ts file is the type definition file for this repository. It is placed inside lib folder.In order to use it in your code , use the following line: ///<reference path= "index.d.ts" /> where path is the location of index.d.ts file.

Custom Buttons

You can pass the custom buttons to the editor by following way:

<script>
            import Froalaeditor from 'froala-editor';
            Froalaeditor.DefineIcon('alert', {NAME: 'info', SVG_KEY: 'help'});
              Froalaeditor.RegisterCommand('alert', {
                title: 'Hello',
                focus: false,
                undo: false,
                refreshAfterCallback: false,
                callback: function () {
                  alert('Hello!');
                }
              });
            
              Froalaeditor.DefineIcon('clear', {NAME: 'remove', SVG_KEY: 'remove'});
              Froalaeditor.RegisterCommand('clear', {
                title: 'Clear HTML',
                focus: false,
                undo: true,
                refreshAfterCallback: true,
                callback: function () {
                  this.html.set('');
                  this.events.focus();
                }
              });
            
              Froalaeditor.DefineIcon('insert', {NAME: 'plus', SVG_KEY: 'add'});
              Froalaeditor.RegisterCommand('insert', {
                title: 'Insert HTML',
                focus: true,
                undo: true,
                refreshAfterCallback: true,
                callback: function () {
                  this.html.insert('My New HTML');
                }
              });
              </script>            
        

Now you can use these buttons in options:
toolbarButtons: [['undo', 'redo' , 'bold'], ['alert', 'clear', 'insert']],

Learn More About Custom Buttons

Do you think we can improve this article? Let us know.