web/web_editor_background_color/README.rst

.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg
   :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
   :alt: License: LGPL-3

==================================
Web Editor Background Color Picker
==================================

This module extends the functionality of the web editor to support
setting a custom background color to any snippet allowing you to customize it.

.. figure:: /web_editor_background_color/static/description/mass_mailing_editor.png
   :alt: Screenshot of color picker in mass mailing editor

Usage
=====

To use this module, you need to:

#. Install any module that makes use of the web editor, such as
   ``mass_mailing`` or ``website``.
#. Use that module's facilities to edit some web content.
#. Drag & drop any snippet into the web editor body.
#. Click on *Customize > Color*.
#. Choose:

   * A color from the theme preset.
   * A custom color by clicking on the text input and then either:

     * Writing the HTML color code.
     * Selecting a color from the color picker.
     * Writing "transparent" to remove it.

.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
   :alt: Try me on Runbot
   :target: https://runbot.odoo-community.org/runbot/162/9.0

Known issues / Roadmap
======================

* When migrating to v10, adapt this option again to its brand new built-in
  colorpicker.
* While you write to the text input, you may notice it disappears for a moment,
  but don't worry, you are still writing.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues
<https://github.com/OCA/web/issues>`_. In case of trouble, please
check there if your issue has already been reported. If you spotted it first,
help us smash it by providing detailed and welcomed feedback.

Credits
=======

External libraries
------------------

* This addon includes code copied from bootstrap-colorpicker_

.. _bootstrap-colorpicker: https://github.com/itsjavi/bootstrap-colorpicker/tree/2.5.1

Contributors
------------

* Jairo Llopis <jairo.llopis@tecnativa.com>

Maintainer
----------

.. image:: https://odoo-community.org/logo.png
   :alt: Odoo Community Association
   :target: https://odoo-community.org

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.

To contribute to this module, please visit https://odoo-community.org.