Metadata-Version: 2.1
Name: odoo-addon-base_custom_filter
Version: 18.0.1.0.0.2
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: Add custom filters in standard filters and group by dropdowns
Home-page: https://github.com/OCA/server-ux
License: AGPL-3
Author: Ashish Hirpara, ForgeFlow, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Description-Content-Type: text/x-rst

.. image:: https://odoo-community.org/readme-banner-image
   :target: https://odoo-community.org/get-involved?utm_source=readme
   :alt: Odoo Community Association

=============================================================
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:1146cee576e90982cae4b93d250294f1c7a4899a193f2cf16e2e528c526c9880
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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/license-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/18.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-18-0/server-ux-18-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=18.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
=============

1. Go to *Settings > Custom Filters*.

2. 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
=====

1. Go to the model's menu entry for which you have defined the filter.
2. 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:%2018.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\\> <https://www.ashish-hirpara.com\>>`__
- `Quartile <https://www.quartile.co>`__:

  - Aung Ko Ko Lin

- `Kencove <https://www.kencove.com>`__:

  - Mohamed Alkobrosli

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

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