# Colorize field in tree views

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

# 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

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>
      ...

- You can also use `colors="bg_color_field: my_color"` to defined the field name that will be used for the background color of the line.

- 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.

- Can use strings too… In the tree view declaration, put `options="{'fg_color': 'green:customer_state == \'success\''}"` attribute in the `field` tag:

      ...
      <field name="arch" type="xml">
          <tree string="View name">
              ...
              <field name="name" options="{'fg_color': 'green:customer_state == \'success\''}"/>
              ...
          </tree>
      </field>
      ...

Note that you can use single or normal quotes. If the declaration of the options doesn’t follow the JSON format, the options string will be evaluated using py.eval()

# Known issues / Roadmap

- Before version 13.0, this module had a feature allowing to change the color of a line depending on a field, using a `colors` attribute with the name of the field on the `<tree>` element. Since 13.0, the `colors` attribute is no longer in the RelaxNG schema of the tree view, so we can’t use it anymore. This feature has then been dropped, but could be reimplement in another way.

# 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

- Camptocamp
- Therp BV

## Contributors

- Damien Crier <damien.crier@camptocamp.com>
- Holger Brunn <hbrunn@therp.nl>
- Artem Kostyuk <a.kostyuk@mobilunity.com>
- Guewen Baconnier <guewen.baconnier@camptocamp.com>
- Phuc Tran Thanh <phuc@trobz.com>
- Sylvain LE GAL <https://twitter.com/legalsylvain>

## Other credits

The development of this module has been financially supported by:

- Camptocamp

## 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.

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.