OdooWiki OCA HUB

CKEditor Widget

web_widget_ckeditor folder_open OCA/web open_in_new
Web License: AGPL-3

This module adds a new widget ckeditor to edit HTML fields using CKEditor.

auto_awesome What this module does

AI-generated from the code · Odoo 14.0

Replaces Odoo's default HTML text editor with CKEditor, giving users a richer toolbar (headings, fonts, colours, tables, images, alignment) when editing HTML fields in the backend.

This module changes how HTML fields are edited in Odoo's backend. Instead of the standard web editor, users get the CKEditor interface, which offers a wider toolbar with headings, bold/italic/underline, font size and colour, bulleted and numbered lists, alignment, indentation, page breaks, links, image upload, block quotes, tables, and undo/redo.

  • The editor is registered as a widget named ckeditor and is also applied automatically to standard html fields, so existing HTML fields switch to CKEditor without extra configuration.
  • The original Odoo editor remains available under the widget name html_odoo, so it can still be selected explicitly if needed.
  • The toolbar buttons can be customised through the system parameter web_widget_ckeditor.toolbar; if it is empty or invalid, a default toolbar is used.
  • The editor loads its interface in the user's language when a matching translation file exists.
  • In debug mode, an extra source-editing button is added to the toolbar.
  • The editor saves changes automatically as the user types (debounced), and a translation button is shown when editing translatable HTML content.
  • Read-only HTML fields are displayed as plain formatted content.

The module extends ir.config_parameter to expose the toolbar configuration to the web client and adds its assets to the backend assets bundle.

Depends on

web_editor
Models and fields (1)
  • ir.config_parameter · extends an existing model

Text generated by AI (DeepSeek) from reading the Odoo 14.0 code on GitHub; it may contain mistakes, so check the code before deciding. View the code on GitHub

Availability by version

Reviewed: 2026-11-03
Confirmed (verified in repository and branch) Estimated (unverified) No information

Confirmation status: 2 confirmed, 7 with no information of 9 versions.

terminal Installation and usage

OCA documentation · Odoo 14.0

Configuration

Source · Odoo 14.0

By default, this module will replace the original html wysiwyg field with CKEditor. The original html widget will be renamed as html_odoo.

If you only want to use ckeditor on specific views, you can disable the html widget override by archiving the web_widget_ckeditor.assets_backend_field_html_override view.

When the global html widget replacement is disabled, ckeditor has to be explicitly set on the desired ir.ui.view:

<field name="description_html" widget="ckeditor" />

The CKEditor toolbar can be customized with an ir.config_parameter. To do so, please create a parameter named web_widget_ckeditor.toolbar, and set the desired toolbar items using either ,, space or newline as separators.

heading
| bold italic underline removeFormat
| fontSize fontColor fontBackgroundColor
| bulletedList numberedList alignment
| outdent indent pagebreak
| link imageUpload blockQuote insertTable
| undo redo

There's more information about available toolbar items in the official CKEditor documentation page

No verified information in OCA: Installation, Usage.

info

Data imported from GitHub: this sheet reflects the latest catalog review, not a live lookup. Always check the module documentation and staging before installing in production.