audrius/web
1
0
Fork 1
mirror of https://github.com/OCA/web.git synced 2025-02-22 13:21:25 +02:00
Code Issues Packages Projects Releases Wiki Activity

[IMP] web_domain_field: documentation

Browse Source
This commit is contained in:
Stefan Rijnhart
2022-12-09 10:13:49 +01:00
parent 0c1a30c88e
commit 4ff0c51ef1
4 changed files with 67 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
web_domain_field/README.rst
View File

@@ -14,20 +14,20 @@ Web Domain Field
: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/15.0/web_domain_field
:target: https://github.com/OCA/web/tree/16.0/web_domain_field
:alt: OCA/web
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_domain_field
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_domain_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/15.0
:target: https://runbot.odoo-community.org/runbot/162/16.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
When you define a view you can specify on the relational fields a domain
attribute. This attribute is evaluated as filter to apply when displaying
existing records for selection.
This technical addon allows developers to specify a field domain in a view
using the value of another field in that view, rather than as a static
XML attribute.
**Table of contents**
@@ -89,13 +89,30 @@ The field used as domain must provide the domain as a JSON encoded string.
[('type', '=', 'product'), ('name', 'like', rec.name)]
)
.. note::
You do not actually need this module to craft a dynamic domain. Odoo comes
with its own `py.js <https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js>`_
web library to parse expressions such as domains. `py.js` supports more
complex expressions than just static lists.
Here is an example of a conditional domain based on the value of another
field:
.. code-block:: python
(order_id or partner_id) and [('id', 'in', allowed_picking_ids)]
or [('state', '=', 'done'), ('picking_type_id.code', '=', 'outgoing')]
For OCA modules, this method is preferred over adding this module as an
additional dependency.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
Do not contact contributors directly about support or help with technical issues.
@@ -127,6 +144,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 <https://github.com/OCA/web/tree/15.0/web_domain_field>`_ project on GitHub.
This module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_domain_field>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

6
web_domain_field/readme/DESCRIPTION.rst
View File

@@ -1,3 +1,3 @@
When you define a view you can specify on the relational fields a domain
attribute. This attribute is evaluated as filter to apply when displaying
existing records for selection.
This technical addon allows developers to specify a field domain in a view
using the value of another field in that view, rather than as a static
XML attribute.

17
web_domain_field/readme/USAGE.rst
View File

@@ -49,3 +49,20 @@ The field used as domain must provide the domain as a JSON encoded string.
rec.product_id_domain = json.dumps(
[('type', '=', 'product'), ('name', 'like', rec.name)]
)
.. note::
You do not actually need this module to craft a dynamic domain. Odoo comes
with its own `py.js <https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js>`_
web library to parse expressions such as domains. `py.js` supports more
complex expressions than just static lists.
Here is an example of a conditional domain based on the value of another
field:
.. code-block:: python
(order_id or partner_id) and [('id', 'in', allowed_picking_ids)]
or [('state', '=', 'done'), ('picking_type_id.code', '=', 'outgoing')]
For OCA modules, this method is preferred over adding this module as an
additional dependency.

29
web_domain_field/static/description/index.html
View File

@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
<title>Web Domain Field</title>
<style type="text/css">
@@ -367,10 +367,10 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/15.0/web_domain_field"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_domain_field"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/15.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>When you define a view you can specify on the relational fields a domain
attribute. This attribute is evaluated as filter to apply when displaying
existing records for selection.</p>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_domain_field"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_domain_field"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This technical addon allows developers to specify a field domain in a view
using the value of another field in that view, rather than as a static
XML attribute.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
@@ -433,13 +433,28 @@ view.</p>
<span class="p">[(</span><span class="s1">'type'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'product'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'like'</span><span class="p">,</span> <span class="n">rec</span><span class="o">.</span><span class="n">name</span><span class="p">)]</span>
<span class="p">)</span>
</pre>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p>You do not actually need this module to craft a dynamic domain. Odoo comes
with its own <a class="reference external" href="https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js">py.js</a>
web library to parse expressions such as domains. <cite>py.js</cite> supports more
complex expressions than just static lists.</p>
<p>Here is an example of a conditional domain based on the value of another
field:</p>
<pre class="code python literal-block">
<span class="p">(</span><span class="n">order_id</span> <span class="ow">or</span> <span class="n">partner_id</span><span class="p">)</span> <span class="ow">and</span> <span class="p">[(</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'in'</span><span class="p">,</span> <span class="n">allowed_picking_ids</span><span class="p">)]</span>
<span class="ow">or</span> <span class="p">[(</span><span class="s1">'state'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'done'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'picking_type_id.code'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'outgoing'</span><span class="p">)]</span>
</pre>
<p class="last">For OCA modules, this method is preferred over adding this module as an
additional dependency.</p>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
@@ -465,7 +480,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<p>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.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/15.0/web_domain_field">OCA/web</a> project on GitHub.</p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_domain_field">OCA/web</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
</div>
</div>