=============================================================
Add custom filters in standard filters and group by dropdowns
=============================================================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:94a0bc95df60e84b19f876f64311c224ff21cb02a69338ab05a2e5b8894ce596
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/16.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-16-0/server-ux-16-0-base_custom_filter
    :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-ux&target_branch=16.0
    :alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module enables the definition of bespoke searches within a model's search view, in
addition to permitting the creation of custom filters that will be displayed beneath the
standard filters, as well as within the group-by menus of a model's search view.

**Table of contents**

.. contents::
   :local:

Configuration
=============

#. Go to *Settings > Custom Filters*.
#. Create a record assigning model, type (search/filter/groupby) and necessary attributes.
   Available fields and corresponding attributes (in brackets) for each type are as follows:

   Search:

      * Search Field (``name``)
      * Filter Domain (``filter_domain``)
      * User Groups (``groups``)

   Filter:

      * Domain (``domain``)
      * User Groups (``groups``)

   Group By:

      * Group By Field (field to be assigned to ``group_by`` context)
      * User Groups (``groups``)

   See `the official documentation <https://www.odoo.com/documentation/16.0/developer/reference/backend/views.html#search>`_ for the definition of each attribute.
   Additionally, filter and group-by records can be respectively grouped together with "Group" assignment (there will be a separator in between groups).

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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/server-ux/issues/new?body=module:%20base_custom_filter%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.

Credits
=======

Authors
~~~~~~~

* Ashish Hirpara
* ForgeFlow

Contributors
~~~~~~~~~~~~

* `ForgeFlow S.L. <https://www.forgeflow.com>`_:

  * Jordi Masvidal

* `Ashish Hirpara <https://www.ashish-hirpara.com>`

* `Quartile <https://www.quartile.co>`__:

  * Aung Ko Ko Lin

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/16.0/base_custom_filter>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
