Add custom filters for fields via UI

Technical Name:
base_search_custom_field_filter
License:
Author:
Tecnativa
  • Odoo Version

Add custom filters for fields via UI

Beta License: AGPL-3 OCA/server-ux Translate me on Weblate Try me on Runbot

This module allows to define custom filters in the search views for an specific field belonging to the document or any other related document.

This nature makes the definition quite technical, but once done, it adds the element in the UI for regular user use.

Table of contents

Configuration

  1. Go to Settings > Technical > User Interface > Custom Field Filters.
  2. Create a new record, and define following information:
    • The Model for which you are defining the filter. It will appear in all the search views of this model.
    • The label you want to see on the search line on the Name field. This field allows translations for proper UI in different languages.
    • The Expression, which is the field chain string with dot notation. Examples: product_id, product_id.seller_ids.name, partner_id.lang.
    • Optionally, you can fill Position After for indicating after which existing field (technical name) the filter will appear. If empty or not found, the filter will be added at the end.
  3. You can reorder records for determining sorting for multiple filters for the same model with the arrow handle in the left part.

Usage

  1. Go to the menu entry for which you have defined the custom field filter.
  2. On the search bar, type anything.
  3. In the filter list, you will see the line for the element you have defined.

As demo data, a custom field filter is included for sample purposes:

https://raw.githubusercontent.com/OCA/server-ux/12.0/base_search_custom_field_filter/static/src/img/ir_ui_custom_field_filter.png

Steps for trying this sample:

  1. Install contacts module.
  2. Go to Contacts.
  3. Type "english" and you'll find the filter "Language" at the end:
https://raw.githubusercontent.com/OCA/server-ux/12.0/base_search_custom_field_filter/static/src/img/contact_search.png

Bug Tracker

Bugs are tracked on GitHub 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.

Do not contact contributors directly about support or help with technical issues.

Credits

Authors

  • Tecnativa

Contributors

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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.

Current maintainer:

pedrobaeza

This module is part of the OCA/server-ux project on GitHub.

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