# CKEditor Widget

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

Table of contents

- Configuration
- Known issues / Roadmap
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Maintainers

# Configuration

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

# Known issues / Roadmap

- Allow to configure toolbar using widget’s options.

    <field
        name="description_html"
        widget="ckeditor"
        options="{'bulletedList': false, 'pageBreak': true}"
    />

- There seems to be a small incompatibility issue with web_drop_target. More information here

# Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us to smash it by providing a detailed and welcomed feedback.

Do not contact contributors directly about support or help with technical issues.

# Credits

## Authors

- Therp BV
- Camptocamp SA

## Contributors

- Therp

  > - Holger Brunn <hbrunn@therp.nl>
  > - Stefan Rijnhart <stefan@therp.nl>
  > - George Daramouskas <gdaramouskas@therp.nl>

- Camptocamp

  > - Iván Todorovich <ivan.todorovich@camptocamp.com>

## Maintainers

This module is maintained by the OCA.

OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

This module is part of the OCA/web project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.