Search by

froala / wysiwyg-editor

stefanneculai

A beautiful jQuery WYSIWYG HTML rich text editor. High performance and modern design make it easy to use for developers and loved by users.

Package info

github.com/froala/wysiwyg-editor

Homepage

Issues

Language:CSS

Type:component

pkg:composer/froala/wysiwyg-editor

Statistics

Installs: 357 999

Dependents: 3

Suggesters: 0

Stars: 5 393


README

A rich text editor built for people, with AI you control.

npm npm

Froala Rich Text Editor

What is Froala?

Froala adds a complete writing experience to any web product: content management systems, learning platforms, email and page builders, help desks, CRMs and document tools.

End users get familiar formatting, Word import and export, real-time collaboration with track changes, and AI assistance. Developers skip building and maintaining an editor of their own. Content stays in-house, and AI requests go only to the model you choose.

The editor works with React, Angular, Vue, Svelte and plain JavaScript, and many more.

Install with npm

npm install froala-editor
import FroalaEditor from 'froala-editor';
import 'froala-editor/js/plugins.pkgd.min.js';
import 'froala-editor/css/froala_editor.pkgd.min.css';

new FroalaEditor('#froala-editor', {
  key: 'your-license-key' // see "License key" below
});

Quick start (CDN)

Two files, one element, one line of JavaScript:

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Froala Editor - Quick start</title>
  <link href="https://cdn.jsdelivr.net/npm/froala-editor@latest/css/froala_editor.pkgd.min.css" rel="stylesheet">
</head>
<body>
  <div id="froala-editor"></div>

  <script src="https://cdn.jsdelivr.net/npm/froala-editor@latest/js/froala_editor.pkgd.min.js"></script>
  <script>
    new FroalaEditor('#froala-editor');
  </script>
</body>
</html>

In production, pin a version instead of @latest (for example froala-editor@5.6.0) and use the same version for both files.

What's in the package

File What it brings
js/froala_editor.pkgd.min.js The editor and every plugin, in one file.
css/froala_editor.pkgd.min.css Styles for the editor and every plugin, in one file.
js/froala_editor.min.js The editor core only, without plugins. This is the package's main entry.
css/froala_editor.min.css Styles for the editor core only.
js/plugins.pkgd.min.js / css/plugins.pkgd.min.css Every plugin, to load next to the core files.
js/plugins/*.min.js / css/plugins/*.min.css One plugin per file, for selective loading.
js/third_party/*.min.js / css/third_party/*.min.css Integrations with third-party services, such as Embedly and the image editors.
css/froala_style.min.css Styles for showing edited content outside the editor.
css/themes/*.min.css Optional editor themes.

Selective loading

To build your editor with fewer plugins, load the core files plus only the plugins you use:

// Editor core (required)
import FroalaEditor from 'froala-editor';

// Plugins
import 'froala-editor/js/plugins/align.min.js';
import 'froala-editor/js/plugins/image.min.js';

// Core styles, plus styles for the plugins that have their own
import 'froala-editor/css/froala_editor.min.css';
import 'froala-editor/css/plugins/image.min.css';

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

Plugin names and options: Plugins documentation.

Frameworks

Demos and examples

Browser support

The latest two versions of Chrome, Edge, Firefox, Safari and Opera, plus Safari on iOS and Chrome, Firefox and the default browser on Android.

Documentation and support

For questions or help integrating the editor, contact support instead of opening an issue.

Reporting issues

GitHub Issues is the official bug tracker. To help us fix a bug quickly:

  1. Check that you're on the latest version (see the changelog).
  2. Include steps to reproduce, ideally a minimal runnable example (CodePen, JSFiddle or StackBlitz).
  3. Name the browser and operating system where it happens.

Licenses

Froala is a professional commercial component with a 30-day free trial. Every Froala plan is self-hosted and includes all plugins, AI Assist and collaboration, with unlimited editor loads, users and developers.

  • 30-day trial. It's free. No registration or account is required. All features are unlocked, with just a small watermark. It's not intended for production use.
  • Commercial license. It may come with unlimited products and domains on one wildcard key and cover SaaS, OEM and on-premise distribution.

Need source code, volume pricing or custom terms? Contact sales. Find more details on the pricing page or in the license terms.

License key

Froala requires a key, passed in the key option. Start with the trial key if you're just trying the product or comparing it with other solutions.

new FroalaEditor('#froala-editor', {
  key: 'TRIAL-LICENSE-KEY-FOR-FROALA-NOT-FOR-PRODUCTION-USE', // 30-day trial key or your commercial key
});

Before you go live, replace the trial key with your commercial key. License information is available in the License file in the root folder.

Without a valid key the editor shows a notice in the bar at the bottom, under "Powered by Froala", and writes the same text to the browser console once. The text says whether the key is missing, a trial, invalid or expired, and is translated with the editor's language. A valid key shows nothing.

On a local host (localhost, 127.x.x.x, 0.0.0.0) you get the same notice as on a public site if there is no key, the key is a trial key, or the key has expired. A key that is still valid (a term key also during its 15 day grace period) gives a clean editor there, so licensed developers are not affected.

Built with ❤️ by the Froala team