From cf8eb036a8870bb6ce26c04338c83d4ed4aef558 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Thu, 19 Mar 2020 12:25:56 +0000 Subject: [PATCH] [UPD] README.rst --- web_tree_dynamic_colored_field/README.rst | 38 +++++++------------ .../static/description/index.html | 34 +++++++---------- 2 files changed, 27 insertions(+), 45 deletions(-) diff --git a/web_tree_dynamic_colored_field/README.rst b/web_tree_dynamic_colored_field/README.rst index a8893444b..7fb8cfb6d 100644 --- a/web_tree_dynamic_colored_field/README.rst +++ b/web_tree_dynamic_colored_field/README.rst @@ -14,13 +14,13 @@ Colorize field in tree views :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 + :target: https://github.com/OCA/web/tree/13.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 + :target: https://translation.odoo-community.org/projects/web-13-0/web-13-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 + :target: https://runbot.odoo-community.org/runbot/162/13.0 :alt: Try me on Runbot |badge1| |badge2| |badge3| |badge4| |badge5| @@ -28,18 +28,11 @@ Colorize field in tree views 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** @@ -77,18 +70,6 @@ Usage 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:: - - ... - - - ... - - ... - - - ... - * If you want to use more than one color, you can split the attributes using ';': .. code:: @@ -117,13 +98,22 @@ Example: **Note that you should always use single quotes for fields' ``options`` and wrap nested values in double quotes since ``options`` is a JSON object.** +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 ```` 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 smashing it by providing a detailed and welcomed -`feedback `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -157,6 +147,6 @@ 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. +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 index d5fcf9a7a..da8919a4e 100644 --- a/web_tree_dynamic_colored_field/static/description/index.html +++ b/web_tree_dynamic_colored_field/static/description/index.html @@ -367,19 +367,14 @@ ul.auto-toc { !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

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

+

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

@@ -416,19 +411,6 @@ With this example, column which renders 'name' field will have its background co 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 ‘;’:

    • @@ -455,12 +437,22 @@ options='{"fg_color": "red:red_color == True; green:green_color =

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

    +
    +

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

    +feedback.

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

    @@ -488,7 +480,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome

    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.

    +

    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.