diff --git a/web_tree_dynamic_colored_field/README.rst b/web_tree_dynamic_colored_field/README.rst index cd3242cb..a8893444 100644 --- a/web_tree_dynamic_colored_field/README.rst +++ b/web_tree_dynamic_colored_field/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png - :target: https://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 - ============================ Colorize field in tree views ============================ +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/12.0/web_tree_dynamic_colored_field + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-12-0/web-12-0-web_tree_dynamic_colored_field + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module aims to add support for dynamically coloring fields in tree view according to data in the record. @@ -22,6 +41,11 @@ Features * Add attribute ``fg_color`` on field's ``options`` to change text color of a cell in tree view * Add attribute ``color_field`` on the tree element's ``colors`` to use as color +**Table of contents** + +.. contents:: + :local: + Usage ===== @@ -96,38 +120,43 @@ Example: 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 smash it by providing detailed and welcomed feedback. +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 smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Camptocamp +* Therp BV Contributors ------------- +~~~~~~~~~~~~ * Damien Crier * Holger Brunn * Artem Kostyuk * Guewen Baconnier -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. 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. +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. diff --git a/web_tree_dynamic_colored_field/static/description/index.html b/web_tree_dynamic_colored_field/static/description/index.html new file mode 100644 index 00000000..441ec5ac --- /dev/null +++ b/web_tree_dynamic_colored_field/static/description/index.html @@ -0,0 +1,497 @@ + + + + + + +Colorize field in tree views + + + +
+

Colorize field in tree views

+ + +

Beta License: AGPL-3 OCA/web Translate me on Weblate Try me on Runbot

+

This module aims to add support for dynamically coloring fields in tree view +according to data in the record.

+

It provides attributes on fields with the similar syntax as the colors attribute +in tree tags.

+

Further, it provides a color_field attribute on tree tags’s colors to use +a field’s value as color.

+
+

Features

+
    +
  • Add attribute bg_color on field’s options to color background of a cell in tree view
    • +
  • Add attribute fg_color on field’s options to change text color of a cell in tree view
    • +
  • Add attribute color_field on the tree element’s colors to use as color
    • +
+

Table of contents

+
+
+

Usage

+
    +

  • In the tree view declaration, put options='{"bg_color": "red: customer==True"} attribute in the field tag:

    +
    +...
+<field name="arch" type="xml">
+    <tree string="View name">
+        ...
+        <field name="name" options='{"bg_color": "red: customer == True"}'/>
+        ...
+    </tree>
+</field>
+...
+
+With this example, column which renders 'name' field will have its background colored in red.
+
    +
    • +

  • In the tree view declaration, put options='{"fg_color": "white:customer == True"}' attribute in the field tag:

    +
    +...
+<field name="arch" type="xml">
+    <tree string="View name">
+        ...
+        <field name="name" options='{"fg_color": "white:customer == True"}'/>
+        ...
+    </tree>
+</field>
+...
+
+With this example, column which renders 'name' field will have its text colored in white on a customer records.
+
    +
    • +

  • In the tree view declaration, use options='"color_field": "my_color"' attribute in the tree tag:

    +
    +...
+<field name="arch" type="xml">
+    <tree string="View name" colors="color_field: my_color" >
+        ...
+        <field name="my_color" invisible="1"/>
+        ...
+    </tree>
+</field>
+...
+
    +
    • +

  • If you want to use more than one color, you can split the attributes using ‘;’:

    +
    • +
+
+options='{"fg_color": "red:red_color == True; green:green_color == True"}'
+
+

Example:

+
+...
+ <field name="arch" type="xml">
+     <tree string="View name">
+         ...
+         <field name="name" options='{"fg_color": "red:red_color == True; green:green_color == True"}'/>
+         ...
+     </tree>
+ </field>
+ ...
+
+ With this example, the content of the field named `my_color` will be used to
+ populate the `my_color` CSS value. Use a function field to return whichever
+ color you want depending on the other record values. Note that this
+ overrides the rest of `colors` attributes, and that you need the tree
+ to load your field in the first place by adding it as invisible field.
+
+

Note that you should always use single quotes for fields’ ``options`` and wrap nested values in double quotes since ``options`` is a JSON object.

+
+
+

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 smashing it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Camptocamp
    • +
  • Therp BV
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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.

+

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.

+
+
+
+ +