=============
Filter Button
=============
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:474ef01827c48e1ba05df2c8301f718da67a2251d4ae3282ab86a3537dd7d3f2
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |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%2Fweb-lightgray.png?logo=github
:target: https://github.com/OCA/web/tree/15.0/web_filter_header_button
: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_filter_header_button
: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/web&target_branch=15.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
This module allows to add some selected filters as buttons in the header
control panel.
**Table of contents**
.. contents::
:local:
Use Cases / Context
===================
This developement is aimed to ease the filter access for touch screens
users.
Configuration
=============
To show a filter in the header of the views, it should have the a
``context`` attribute with the key ``shown_in_panel``.
.. code:: xml
<filter
string="My filter"
name="my_filter"
domain="[('active', '!=', False)]"
context="{'shown_in_panel': True}"
>
This will show the filter in the header with its name. You can customize
the button adding an icon or with a custom name passing an object to
that key:
.. code:: python
{'shown_in_panel': {'icon': 'fa-thumbs-up', 'name': 'Ok'}}
You might be interested in leaving just the icon. In that case, set an
empty string on the ``name`` property:
.. code:: python
{'shown_in_panel': {'icon': 'fa-thumbs-up', 'name': ''}}
You could also want to add a hotkey. In such case add the ``hotkey``
property:
.. code:: python
{'shown_in_panel': {'icon': 'fa-thumbs-up', 'hotkey': 'F'}}
You can show filter, groups or even favorites.
Usage
=====
There's a demo implementation in ``Apps`` and you can play around
following the *Configure* section.
Known issues / Roadmap
======================
- Group filters by kind
- As we use the ``context`` attribute, the inheritance could be
limiting in some cases. Keep it in mind or use
``base_view_inheritance_extension`` if you want to use proper context
inheritance.
- Another nice to have would be to be able to hide the filters in the
filter list to be able to show them just in the header, although
there's not a straigh forward way to do it and it could lead to side
effects.
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 to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_filter_header_button%0Aversion:%2015.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
-------
* Tecnativa
Contributors
------------
- `Tecnativa <https://tecnativa.com>`__
- David Vidal
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.
This module is part of the `OCA/web <https://github.com/OCA/web/tree/15.0/web_filter_header_button>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/web",
"name": "odoo-addon-web-filter-header-button",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Tecnativa, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": null,
"platform": null,
"description": "=============\nFilter Button\n=============\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:474ef01827c48e1ba05df2c8301f718da67a2251d4ae3282ab86a3537dd7d3f2\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png\n :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html\n :alt: License: AGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github\n :target: https://github.com/OCA/web/tree/15.0/web_filter_header_button\n :alt: OCA/web\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_filter_header_button\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=15.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nThis module allows to add some selected filters as buttons in the header\ncontrol panel.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nUse Cases / Context\n===================\n\nThis developement is aimed to ease the filter access for touch screens\nusers.\n\nConfiguration\n=============\n\nTo show a filter in the header of the views, it should have the a\n``context`` attribute with the key ``shown_in_panel``.\n\n.. code:: xml\n\n <filter\n string=\"My filter\"\n name=\"my_filter\"\n domain=\"[('active', '!=', False)]\"\n context=\"{'shown_in_panel': True}\"\n >\n\nThis will show the filter in the header with its name. You can customize\nthe button adding an icon or with a custom name passing an object to\nthat key:\n\n.. code:: python\n\n {'shown_in_panel': {'icon': 'fa-thumbs-up', 'name': 'Ok'}}\n\nYou might be interested in leaving just the icon. In that case, set an\nempty string on the ``name`` property:\n\n.. code:: python\n\n {'shown_in_panel': {'icon': 'fa-thumbs-up', 'name': ''}}\n\nYou could also want to add a hotkey. In such case add the ``hotkey``\nproperty:\n\n.. code:: python\n\n {'shown_in_panel': {'icon': 'fa-thumbs-up', 'hotkey': 'F'}}\n\nYou can show filter, groups or even favorites.\n\nUsage\n=====\n\nThere's a demo implementation in ``Apps`` and you can play around\nfollowing the *Configure* section.\n\nKnown issues / Roadmap\n======================\n\n- Group filters by kind\n- As we use the ``context`` attribute, the inheritance could be\n limiting in some cases. Keep it in mind or use\n ``base_view_inheritance_extension`` if you want to use proper context\n inheritance.\n- Another nice to have would be to be able to hide the filters in the\n filter list to be able to show them just in the header, although\n there's not a straigh forward way to do it and it could lead to side\n effects.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_filter_header_button%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n-------\n\n* Tecnativa\n\nContributors\n------------\n\n- `Tecnativa <https://tecnativa.com>`__\n\n - David Vidal\n\nMaintainers\n-----------\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\nThis module is part of the `OCA/web <https://github.com/OCA/web/tree/15.0/web_filter_header_button>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3",
"summary": "Show selected filters as buttons in the control panel",
"version": "15.0.1.1.0",
"project_urls": {
"Homepage": "https://github.com/OCA/web"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb964e8214bc0e9889ea211b0f0d644b71e8a02f2266aa2fe775b9ae78746e61",
"md5": "bdecd181a7f75a37753ba500e4e2e437",
"sha256": "575312b7cd7a52cbfd4789e53ab5ae2649dae18a6f552f9e204961c93bf18080"
},
"downloads": -1,
"filename": "odoo_addon_web_filter_header_button-15.0.1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdecd181a7f75a37753ba500e4e2e437",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 27729,
"upload_time": "2024-05-31T13:37:29",
"upload_time_iso_8601": "2024-05-31T13:37:29.466226Z",
"url": "https://files.pythonhosted.org/packages/fb/96/4e8214bc0e9889ea211b0f0d644b71e8a02f2266aa2fe775b9ae78746e61/odoo_addon_web_filter_header_button-15.0.1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-31 13:37:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "web",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "odoo-addon-web-filter-header-button"
}
JSON
