You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

154 lines
4.1 KiB

  1. ================
  2. Web Widget Color
  3. ================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
  15. :target: https://github.com/OCA/web/tree/11.0/web_widget_color
  16. :alt: OCA/web
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/web-11-0/web-11-0-web_widget_color
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/162/11.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module aims to add a color picker to Odoo.
  25. It's a `jsColor <http://jscolor.com/>`_ lib integration.
  26. Features
  27. ========
  28. * The picker allow the user to quickly select a color on edit mode
  29. |picker|
  30. .. note::
  31. Notice how html code and the background color is updating when selecting a color.
  32. * Display the color on form view when you are not editing it
  33. |formview|
  34. * Display the color on list view to quickly find what's wrong!
  35. |listview|
  36. .. |picker| image:: ./images/picker.png
  37. .. |formview| image:: ./images/form_view.png
  38. .. |listview| image:: ./images/list_view.png
  39. **Table of contents**
  40. .. contents::
  41. :local:
  42. Usage
  43. =====
  44. You need to declare a char field::
  45. color = fields.Char(
  46. string="Color",
  47. help="Choose your color"
  48. )
  49. In the view declaration, put widget='color' attribute in the field tag::
  50. ...
  51. <field name="arch" type="xml">
  52. <tree string="View name">
  53. ...
  54. <field name="color" widget="color"/>
  55. ...
  56. </tree>
  57. </field>
  58. ...
  59. <field name="arch" type="xml">
  60. <form string="View name">
  61. ...
  62. <field name="color" widget="color"/>
  63. ...
  64. </form>
  65. </field>
  66. ...
  67. Widget Options::
  68. - readonly_mode
  69. - 'default' > Color Box + text
  70. - 'color' > Only Color Box
  71. - 'text' > Only Text
  72. ...
  73. <field name="arch" type="xml">
  74. <tree string="View name">
  75. ...
  76. <field name="color" widget="color" options="{'readonly_mode': 'color'}"/>
  77. ...
  78. </tree>
  79. </field>
  80. ...
  81. Bug Tracker
  82. ===========
  83. Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
  84. In case of trouble, please check there if your issue has already been reported.
  85. If you spotted it first, help us smashing it by providing a detailed and welcomed
  86. `feedback <https://github.com/OCA/web/issues/new?body=module:%20web_widget_color%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  87. Do not contact contributors directly about support or help with technical issues.
  88. Credits
  89. =======
  90. Authors
  91. ~~~~~~~
  92. * Savoir-faire Linux
  93. * Anybox
  94. * Taktik SA
  95. * Sudokeys
  96. Contributors
  97. ~~~~~~~~~~~~
  98. * Adil Houmadi <adil.houmadi@gmail.com>
  99. * Enric Tobella <etobella@creublanca.es>
  100. * Nicolas JEUDY (Sudokeys) <https://www.github.com/njeudy>
  101. * Alexandre Díaz <dev@redneboa.es>
  102. Maintainers
  103. ~~~~~~~~~~~
  104. This module is maintained by the OCA.
  105. .. image:: https://odoo-community.org/logo.png
  106. :alt: Odoo Community Association
  107. :target: https://odoo-community.org
  108. OCA, or the Odoo Community Association, is a nonprofit organization whose
  109. mission is to support the collaborative development of Odoo features and
  110. promote its widespread use.
  111. This module is part of the `OCA/web <https://github.com/OCA/web/tree/11.0/web_widget_color>`_ project on GitHub.
  112. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.