=============================================================
Add custom filters in standard filters and group by dropdowns
=============================================================
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--ux-lightgray.png?logo=github
:target: https://github.com/OCA/server-ux/tree/14.0/base_custom_filter
:alt: OCA/server-ux
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-ux-14-0/server-ux-14-0-base_custom_filter
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/250/14.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allows to define custom filters to be shown under the standard
filters and group by menus of a model's search view.
**Table of contents**
.. contents::
:local:
Configuration
=============
#. Go to *Settings > Custom Filters*.
#. Create a new Custom Filter, and define following information:
* The **Model** for which you are defining the filter.
* The **Type** depending on whether you want to add a filter or a grouping by
by a field.
* The **Domain** that will be applied with the filter.
* The **Group By Field** used to perform the group by.
* The **Group** to have filters under the same separator.
#. You can reorder records from the list view with the arrow handle. This will
determine the order in which they appear in the filters/groupby menu.
#. A separator is added between each custom filter added. You can create Custom
Filter Groups to group filters that you want to have displayed under the same
separator.
Usage
=====
#. Go to the model's menu entry for which you have defined the filter.
#. On the filters and group by dropdowns, you will see the configured filters.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-ux/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/server-ux/issues/new?body=module:%20base_custom_filter%0Aversion:%2014.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.
Credits
=======
Authors
~~~~~~~
* Ashish Hirpara
* ForgeFlow
Contributors
~~~~~~~~~~~~
* `ForgeFlow S.L. <https://www.forgeflow.com>`_:
* Jordi Masvidal
* `Ashish Hirpara <https://www.ashish-hirpara.com>`
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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.
.. |maintainer-AshishHirapara| image:: https://github.com/AshishHirapara.png?size=40px
:target: https://github.com/AshishHirapara
:alt: AshishHirapara
.. |maintainer-ForgeFlow| image:: https://github.com/ForgeFlow.png?size=40px
:target: https://github.com/ForgeFlow
:alt: ForgeFlow
Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-AshishHirapara| |maintainer-ForgeFlow|
This module is part of the `OCA/server-ux <https://github.com/OCA/server-ux/tree/14.0/base_custom_filter>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
5b490d7c61