...
Days
Hours
Minutes
Seconds
x
Skip to content
Froala Documentation

Migrating from Froala V3 to Froala V5

Migrating from Froala V3 to V5 is a seamless transition with no breaking changes. Users will enjoy the same familiar editor, now with more powerful features, an enhanced user experience, and improved stability.

Install Version 5

To find information on the different options for installing Froala Editor, refer to the Getting Started guide

Initialization

Version 5 and version 3 both support the same initialization method, just add your new API key, and the editor will continue to function as it did before, but with new features available.

The following example shows how to initialize the editor in version 5.

new FroalaEditor('.editor', {
  // Pass options.
  optionName: 'Option Value',
  anotherOption:  'Froala Option',
  yetAnotherOne: 100,
  
  // Bind events
  events: {
    eventName: function (param1, param2) {
      // Get editor instance.
      let editor = this;

      // Callback code here

      // Use editor methods.
      editor.method();

    }
  }
})

Plugins

The following plugins are available when you migrate to version 5:

V5.0.0

V4.7.0

V4.5.2

V4.3.0

V4.2.0

V4.0.0

These plugins, except “Track Changes” plugin, are included by default if you are using the froala_editor.pkgd.js file. Otherwise you should include their corresponding stylesheet and JavaScript files.

If you have set the pluginsEnabled option you should add the corresponding plugin identifier.

Sample code:

new FroalaEditor('#froala-editor',  { 
  pluginsEnabled: ['image', 'link', 'exportToWord', 'codeSnippet'],
});

Learn more about how Froala plugins works.

New Options

In addition to the new plugins’ configurations, the following API options has been added:

 

V5.0.1

toolbarButtonsEnabledOnEditorOff Specify which toolbar buttons should remain active even when the Froala editor is disabled.
tableHorizontalResizer Control table horizontal resizing.
tableVerticalResizer Control table vertical resizing.

V5.0.0

retainLineBreaksInCellsOnWrap Control how line breaks within a cell are handled when the cell’s content wraps to multiple lines.

V4.7.2

clearFormatOnEnterNewLine Control whether or not the formatting of the current line is carried over to the new line when you press Enter after pasting content.
cleanReduntantStyleOnGet Removes unnecessary styles from parent elements when retrieving the editor’s content.

V4.6.2

proportionalTableResize Controls how a table behaves when you resize it.
enableTableSelection Enable or disable table selection.

V4.6.0

tableDefaultAlign Set the default alignment of the table.
tableDefaultHeight Set the default height of the table.
tableDefaultBGColor Set the default background color of the table.
tableDefaultBorderColor Set the default border color of the table.
tableDefaultBorderWidth Set the default border width of the table.
tableDefaultBorderStyle Set the default border style of the table.

V4.5.1

allowStylingOnNonEditable Specifies whether styling is permitted on non-editable content.

V4.5.0

pluginsDisabled Defines a list of plugins to be excluded in the current editor instance.
lineHeights (updated) Now accept array of objects

V4.2.1

fontFamilyDefaultSelection Apply a default font family.
fontSizeDefaultSelection Apply a default font size.
preserveTabSpaces Customize or not the number of spaces generated by the \t character.
tabSpaces Configure the editor’s Tab key to insert a specific number of spaces.

V4.1.3


tableResizer Enables resizing table cells.
tableResizerOffset The distance in pixels from the table cell’s left or right border to show the resizer.
tableResizingLimit The minimum width in pixels of a table cell is allowed while resizing.

V4.1.0

toolbarResponsiveToEditor Make the editor toolbar responsive based on the editor size instead of the browser window size.

 

A complete list of Froala editor options is available on the Options API page.

New Methods

In addition to the new plugins’ methods, the following API methods has been added:

 

V4.6.0

V4.1.0

html.wrap(updated)

Integrations

V5 allows you to integrate Froala with modern frameworks and web technologies.

 

Why migrate to V5?

Version 5 offers increased stability and reliability, ensuring a smoother editing experience with fewer disruptions. It also includes a range of new features and bug fixes that enhance functionality and address issues present in previous versions. By upgrading, users can take advantage of these improvements while continuing to enjoy the seamless operation of their favorite editor.

Key improvements:

  • Resolved XSS security vulnerabilities.
  • Typescript Support.
  • Enhanced tables.
  • Improved accessibility.
  • Better iOS mobile support.
  • Enhanced copying and pasting from Word.
  • YouTube Shorts support.
  • Position the toolbar at the bottom on mobile devices.
  • Disable plugins more easily.
  • Filestack integration

You can read the complete changelog here.

Additional Resources

Froala V5.0.0

Froala V5.0.0 Release: Code Snippets, Word Imports, and More

Froala V5.0.0 introduces two major features: code snippet insertion with syntax highlighting, and direct Word document import with formatting preserved. This release also includes table handling improvements and updated styling
Read More
Froala 4.7

Froala 4.7 Release with Anchors, Page Breaks, and Word Export

You asked for anchor text, page breaks, and export to Word features. We listened and today we are excited to announce our long awaited release, Froala 4.7 is available for
Read More
a screen shot of a computer

Why Froala V4.5 Remains the Best WYSIWYG HTML Editor for Developers

It’s been a few weeks since we launched Froala Editor V4.5, and I wanted to take a moment to reflect on the journey behind this release and highlight what makes
Read More
Froala V4.2.1

Froala 4.2.1 release: Word Counter Type definitions, new API options, and More

Say hello to the Froala Editor V4.2.1! We are thrilled to introduce a range of exciting features and enhancements that will take your editing experience to the next level. In
Read More

Migration support

Get hands-on help migrating your project from our dedicated support team. They are available to assist with any questions or concerns you might have during the transition. Don't hesitate to reach out if you encounter any issues or need guidance on utilizing the new features effectively.

Ready to dive in? Explore our plans

Seraphinite AcceleratorOptimized by Seraphinite Accelerator
Turns on site high speed to be attractive for people and search engines.