summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorjem-odoo <jem@openerp.com>2018-05-09 09:40:02 +0200
committerjem-odoo <jem@openerp.com>2018-08-13 14:33:48 +0200
commit1f72644c445826ae7263e9b0f4737ffab99a778e (patch)
tree255ca293129b536eee1675403bdbea7e57519d67 /doc/reference
parent6b4062ea63c628c81caecfca21968820b17d0573 (diff)
[IMP] web: float_factor and float_toggle widgets
This commit provides new js widgets for list, kanban and form views on float field. 1/ 'float_factor' displays the normal float field, but takes a conversion factor as option. The displays value is the normal one multiplied by the factor. You can use the widget like <field name="my_float_field" widget="float_factor" option="{'factor': 2}"/> 2/ 'float_toggle' displays a button (in edit mode) looping on a range of given value at each click. A conversion factor is optional (default will be 1) to display a converted value, but sent to non converted one to the server. You can use the widget like <field name="my_float" widget="float_toggle" option="{'range': [0, 0.5, 1], 'factor': 2}"/> 'range' and 'factor' are put in the options. In simple read mode, the widget display the value as a traditionnal text (like a normal char field). This commit provides tests and documentation for those 2 widgets. Task #39079
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/javascript_reference.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/reference/javascript_reference.rst b/doc/reference/javascript_reference.rst
index 6cbfd3563dd..14647955afa 100644
--- a/doc/reference/javascript_reference.rst
+++ b/doc/reference/javascript_reference.rst
@@ -1418,6 +1418,26 @@ order.
- Supported field types: *float*
+- float_factor (FieldFloatFactor)
+ This widget aims to display properly a float value that converted using a factor
+ given in its options. So, for example, the value saved in database is 0.5 and the
+ factor is 3, the widget value should be formatted as 1.5.
+
+ - Supported field types: *float*
+
+- float_toggle (FieldFloatToggle)
+ The goal of this widget is to replace the input field by a button containing a
+ range of possible values (given in the options). Each click allows the user to loop
+ in the range. The purpose here is to restrict the field value to a predefined selection.
+ Also, the widget support the factor conversion as the *float_factor* widget (Range values
+ should be the result of the conversion).
+
+ - Supported field types: *float*
+
+ .. code-block:: xml
+
+ <field name="days_to_close" widget="float_toggle" options='{"factor": 2, "range": [0, 4, 8]}'/>
+
- boolean (FieldBoolean)
This is the default field type for fields of type *boolean*.