mirror of https://github.com/OCA/web.git
Merge ac2c345b8e into 6a991714e2
David Vidal
GitHub
commit
259756a16e
|
|
@ -0,0 +1,146 @@
|
|||
=============
|
||||
Filter Button
|
||||
=============
|
||||
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:c2b64cc19b28ee8850599360a44f1ba6ad28db0bc8574f041a845a5ca9529af1
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |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/18.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-18-0/web-18-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=18.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
|
||||
=====
|
||||
|
||||
In a search view with header filter buttons, you'll see a filter icon
|
||||
(funnel). Use it to unfold the filters.
|
||||
|
||||
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:%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
|
||||
-------
|
||||
|
||||
* 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/18.0/web_filter_header_button>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# Copyright 2024 Tecnativa - David Vidal
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||
{
|
||||
"name": "Filter Button",
|
||||
"version": "18.0.1.0.0",
|
||||
"summary": "Show selected filters as buttons in the control panel",
|
||||
"author": "Tecnativa, Odoo Community Association (OCA)",
|
||||
"license": "AGPL-3",
|
||||
"category": "Server UX",
|
||||
"website": "https://github.com/OCA/web",
|
||||
"depends": ["web"],
|
||||
"data": [],
|
||||
"demo": [
|
||||
"demo/ir_module_module_view.xml",
|
||||
],
|
||||
"assets": {
|
||||
"web.assets_backend": ["web_filter_header_button/static/src/**/*"],
|
||||
},
|
||||
}
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<odoo>
|
||||
<record id="view_module_filter" model="ir.ui.view">
|
||||
<field name="model">ir.module.module</field>
|
||||
<field name="inherit_id" ref="base.view_module_filter" />
|
||||
<field name="arch" type="xml">
|
||||
<filter name="installed" position="attributes">
|
||||
<attribute
|
||||
name="context"
|
||||
>{'shown_in_panel': {'icon': 'fa-toggle-on', 'hotkey': 'i'}}</attribute>
|
||||
</filter>
|
||||
<filter name="not_installed" position="attributes">
|
||||
<attribute
|
||||
name="context"
|
||||
>{'shown_in_panel': {'icon': 'fa-toggle-off', 'hotkey': 'u'}}</attribute>
|
||||
</filter>
|
||||
<filter name="state" position="attributes">
|
||||
<attribute
|
||||
name="context"
|
||||
>{'group_by':'state', 'shown_in_panel': {'icon': 'fa-th-list', 'hotkey': 's'}}</attribute>
|
||||
</filter>
|
||||
</field>
|
||||
</record>
|
||||
</odoo>
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 15.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
[build-system]
|
||||
requires = ["whool"]
|
||||
build-backend = "whool.buildapi"
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
To show a filter in the header of the views, it should have the a `context` attribute with the key `shown_in_panel`.
|
||||
|
||||
```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:
|
||||
|
||||
```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:
|
||||
|
||||
```python
|
||||
{'shown_in_panel': {'icon': 'fa-thumbs-up', 'name': ''}}
|
||||
```
|
||||
|
||||
You could also want to add a hotkey. In such case add the `hotkey` property:
|
||||
|
||||
```python
|
||||
{'shown_in_panel': {'icon': 'fa-thumbs-up', 'hotkey': 'F'}}
|
||||
```
|
||||
|
||||
You can show filter, groups or even favorites.
|
||||
|
|
@ -0,0 +1 @@
|
|||
This developement is aimed to ease the filter access for touch screens users.
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
- [Tecnativa](https://tecnativa.com)
|
||||
- David Vidal
|
||||
|
|
@ -0,0 +1 @@
|
|||
This module allows to add some selected filters as buttons in the header control panel.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
- 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.
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
In a search view with header filter buttons, you'll see a filter icon (funnel). Use it
|
||||
to unfold the filters.
|
||||
|
||||
There's a demo implementation in `Apps` and you can play around following the *Configure*
|
||||
section.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,487 @@
|
|||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
|
||||
<title>Filter Button</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
Despite the name, some widely supported CSS2 features are used.
|
||||
|
||||
See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: gray; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic, pre.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="filter-button">
|
||||
<h1 class="title">Filter Button</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:c2b64cc19b28ee8850599360a44f1ba6ad28db0bc8574f041a845a5ca9529af1
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/web/tree/18.0/web_filter_header_button"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/web-18-0/web-18-0-web_filter_header_button"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=18.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This module allows to add some selected filters as buttons in the header
|
||||
control panel.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
|
||||
<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
|
||||
<li><a class="reference internal" href="#usage" id="toc-entry-3">Usage</a></li>
|
||||
<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-4">Known issues / Roadmap</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="toc-entry-5">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="toc-entry-6">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="toc-entry-7">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="toc-entry-8">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="toc-entry-9">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="use-cases-context">
|
||||
<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
|
||||
<p>This developement is aimed to ease the filter access for touch screens
|
||||
users.</p>
|
||||
</div>
|
||||
<div class="section" id="configuration">
|
||||
<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
|
||||
<p>To show a filter in the header of the views, it should have the a
|
||||
<tt class="docutils literal">context</tt> attribute with the key <tt class="docutils literal">shown_in_panel</tt>.</p>
|
||||
<pre class="code xml literal-block">
|
||||
<span class="nt"><filter</span><span class="w">
|
||||
</span><span class="na">string=</span><span class="s">"My filter"</span><span class="w">
|
||||
</span><span class="na">name=</span><span class="s">"my_filter"</span><span class="w">
|
||||
</span><span class="na">domain=</span><span class="s">"[('active', '!=', False)]"</span><span class="w">
|
||||
</span><span class="na">context=</span><span class="s">"{'shown_in_panel': True}"</span><span class="w">
|
||||
</span><span class="nt">></span>
|
||||
</pre>
|
||||
<p>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:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="p">{</span><span class="s1">'shown_in_panel'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'icon'</span><span class="p">:</span> <span class="s1">'fa-thumbs-up'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'Ok'</span><span class="p">}}</span>
|
||||
</pre>
|
||||
<p>You might be interested in leaving just the icon. In that case, set an
|
||||
empty string on the <tt class="docutils literal">name</tt> property:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="p">{</span><span class="s1">'shown_in_panel'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'icon'</span><span class="p">:</span> <span class="s1">'fa-thumbs-up'</span><span class="p">,</span> <span class="s1">'name'</span><span class="p">:</span> <span class="s1">''</span><span class="p">}}</span>
|
||||
</pre>
|
||||
<p>You could also want to add a hotkey. In such case add the <tt class="docutils literal">hotkey</tt>
|
||||
property:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="p">{</span><span class="s1">'shown_in_panel'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'icon'</span><span class="p">:</span> <span class="s1">'fa-thumbs-up'</span><span class="p">,</span> <span class="s1">'hotkey'</span><span class="p">:</span> <span class="s1">'F'</span><span class="p">}}</span>
|
||||
</pre>
|
||||
<p>You can show filter, groups or even favorites.</p>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#toc-entry-3">Usage</a></h1>
|
||||
<p>In a search view with header filter buttons, you’ll see a filter icon
|
||||
(funnel). Use it to unfold the filters.</p>
|
||||
<p>There’s a demo implementation in <tt class="docutils literal">Apps</tt> and you can play around
|
||||
following the <em>Configure</em> section.</p>
|
||||
</div>
|
||||
<div class="section" id="known-issues-roadmap">
|
||||
<h1><a class="toc-backref" href="#toc-entry-4">Known issues / Roadmap</a></h1>
|
||||
<ul class="simple">
|
||||
<li>Group filters by kind</li>
|
||||
<li>As we use the <tt class="docutils literal">context</tt> attribute, the inheritance could be
|
||||
limiting in some cases. Keep it in mind or use
|
||||
<tt class="docutils literal">base_view_inheritance_extension</tt> if you want to use proper context
|
||||
inheritance.</li>
|
||||
<li>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.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#toc-entry-5">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
|
||||
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
|
||||
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_filter_header_button%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#toc-entry-6">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-7">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Tecnativa</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#toc-entry-8">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li><a class="reference external" href="https://tecnativa.com">Tecnativa</a><ul>
|
||||
<li>David Vidal</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#toc-entry-9">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org">
|
||||
<img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
|
||||
</a>
|
||||
<p>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.</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/18.0/web_filter_header_button">OCA/web</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,35 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<templates xml:space="preserve">
|
||||
<t t-inherit="web.ControlPanel" t-inherit-mode="extension">
|
||||
<xpath expr="//div[hasclass('o_control_panel_main')]" position="after">
|
||||
<t t-if="this.env.config.viewType and this.env.config.viewType !== 'form'">
|
||||
<Transition
|
||||
visible="state.showButtonFilters"
|
||||
name="'o-fade'"
|
||||
t-slot-scope="transition"
|
||||
leaveDuration="500"
|
||||
>
|
||||
<div
|
||||
class="o_embedded_actions overflow-hidden d-flex flex-wrap w-100 align-items-center justify-content-center gap-2"
|
||||
t-att-class="transition.className"
|
||||
>
|
||||
<FilterButton
|
||||
filters="this.env.searchModel.headerButtonFilters"
|
||||
/>
|
||||
</div>
|
||||
</Transition>
|
||||
</t>
|
||||
</xpath>
|
||||
|
||||
<xpath expr="//button[@t-on-click='onClickShowEmbedded']" position="after">
|
||||
<button
|
||||
t-if="state.headerButtonFilters?.length"
|
||||
class="btn btn-secondary"
|
||||
t-att-class="{active: state.showButtonFilters}"
|
||||
t-on-click="onClickShowshowButtonFilters"
|
||||
>
|
||||
<i class="fa fa-filter" />
|
||||
</button>
|
||||
</xpath>
|
||||
</t>
|
||||
</templates>
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
import {ControlPanel} from "@web/search/control_panel/control_panel";
|
||||
import {FilterButton} from "../filter_button/filter_button.esm";
|
||||
import {browser} from "@web/core/browser/browser";
|
||||
import {patch} from "@web/core/utils/patch";
|
||||
import {useState} from "@odoo/owl";
|
||||
import {user} from "@web/core/user";
|
||||
|
||||
patch(ControlPanel, {
|
||||
components: {...ControlPanel.components, FilterButton},
|
||||
});
|
||||
|
||||
patch(ControlPanel.prototype, {
|
||||
setup() {
|
||||
super.setup(...arguments);
|
||||
this.buttonFiltersVisibilityKey = `visibleHeaderButtons${this.env.config.actionId}+${user.userId}`;
|
||||
this.state = useState({
|
||||
...this.state,
|
||||
headerButtonFilters: this.env.searchModel?.headerButtonFilters,
|
||||
showButtonFilters:
|
||||
this.env.searchModel?.headerButtonFilters.length > 0 &&
|
||||
Boolean(this.env.config.actionId) &&
|
||||
Boolean(
|
||||
JSON.parse(
|
||||
browser.localStorage.getItem(this.buttonFiltersVisibilityKey)
|
||||
)
|
||||
),
|
||||
});
|
||||
},
|
||||
onClickShowshowButtonFilters() {
|
||||
if (this.state.showButtonFilters) {
|
||||
browser.localStorage.removeItem(this.buttonFiltersVisibilityKey);
|
||||
} else {
|
||||
browser.localStorage.setItem(this.buttonFiltersVisibilityKey, true);
|
||||
}
|
||||
this.state.showButtonFilters = !this.state.showButtonFilters;
|
||||
},
|
||||
});
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
import {Component} from "@odoo/owl";
|
||||
|
||||
export class FilterButton extends Component {
|
||||
static template = "filter_button.FilterButton";
|
||||
static props = {
|
||||
filters: {type: Object, optional: false},
|
||||
};
|
||||
setup() {
|
||||
this.model = this.env.searchModel;
|
||||
}
|
||||
/**
|
||||
* Return custom properties depending on the filter properties
|
||||
*
|
||||
* @param {Object} filter
|
||||
* @returns {Object}
|
||||
*/
|
||||
mapFilterType(filter) {
|
||||
const mapping = {
|
||||
filter: {
|
||||
color: "primary",
|
||||
},
|
||||
favorite: {
|
||||
color: "warning",
|
||||
},
|
||||
groupBy: {
|
||||
color: "info",
|
||||
},
|
||||
};
|
||||
return mapping[filter.type];
|
||||
}
|
||||
/**
|
||||
* Clear filters
|
||||
*/
|
||||
onClickReset() {
|
||||
this.model.clearQuery();
|
||||
}
|
||||
/**
|
||||
* Set / unset filter
|
||||
* @param {Object} filter
|
||||
*/
|
||||
onToggleFilter(filter) {
|
||||
this.model.toggleSearchItem(filter.id);
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,39 @@
|
|||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<templates>
|
||||
<t t-name="filter_button.FilterButton">
|
||||
<t t-set="filters" t-value="this.props.filters" />
|
||||
<div t-if="filters" class="o_cp_bottom_filter_buttons">
|
||||
<div class="btn-group" role="group">
|
||||
<button
|
||||
t-if="filters and filters.length"
|
||||
t-attf-class="btn btn-outline-primary"
|
||||
t-on-click.stop="this.onClickReset"
|
||||
>
|
||||
<i class="fa fa-times" />
|
||||
</button>
|
||||
<!-- Directly get the model filters so we can react to changes -->
|
||||
<t t-foreach="filters" t-as="filter" t-key="filter.id">
|
||||
<t t-set="options" t-value="filter.context.shown_in_panel" />
|
||||
<t t-set="filter_mapping" t-value="mapFilterType(filter)" />
|
||||
<t t-set="color" t-value="filter_mapping.color || 'primary'" />
|
||||
<!-- We can set an empty string on the optional name to show only the icon -->
|
||||
<t
|
||||
t-set="name"
|
||||
t-value="options.name !== undefined ? options.name : filter.description"
|
||||
/>
|
||||
<button
|
||||
t-attf-class="btn ms-0 border-start-0 {{filter.isActive ? `btn-${color}` : `btn-outline-${color}`}}"
|
||||
t-on-click.stop="() => this.onToggleFilter(filter)"
|
||||
t-att-data-hotkey="options.hotkey"
|
||||
>
|
||||
<i
|
||||
t-if="options.icon"
|
||||
t-attf-class="fa {{options.icon}} {{name !== '' ? 'mr-1' : ''}}"
|
||||
/>
|
||||
<t t-esc="name" />
|
||||
</button>
|
||||
</t>
|
||||
</div>
|
||||
</div>
|
||||
</t>
|
||||
</templates>
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
import {SearchArchParser} from "@web/search/search_arch_parser";
|
||||
import {patch} from "@web/core/utils/patch";
|
||||
import {makeContext} from "@web/core/context";
|
||||
|
||||
patch(SearchArchParser.prototype, {
|
||||
/**
|
||||
* Allow groupBy filters to show up as buttons
|
||||
* @override
|
||||
*/
|
||||
visitFilter(node) {
|
||||
var context_to_keep = false;
|
||||
if (node.hasAttribute("context")) {
|
||||
const context = makeContext([node.getAttribute("context")]);
|
||||
if (context.group_by && context.shown_in_panel) {
|
||||
context_to_keep = context;
|
||||
}
|
||||
}
|
||||
super.visitFilter(...arguments);
|
||||
if (context_to_keep) {
|
||||
this.currentGroup.at(-1).context = context_to_keep;
|
||||
}
|
||||
},
|
||||
});
|
||||
|
|
@ -0,0 +1,55 @@
|
|||
import {makeContext} from "@web/core/context";
|
||||
import {patch} from "@web/core/utils/patch";
|
||||
import {SearchModel} from "@web/search/search_model";
|
||||
import {useEffect} from "@odoo/owl";
|
||||
|
||||
patch(SearchModel.prototype, {
|
||||
setup() {
|
||||
super.setup(...arguments);
|
||||
// Filter flagged filters to be shown in the control panel.
|
||||
useEffect(
|
||||
() => {
|
||||
this.headerButtonFilters = this.getHeaderButtonFilters();
|
||||
},
|
||||
() => [this.searchItems]
|
||||
);
|
||||
},
|
||||
async load() {
|
||||
await super.load(...arguments);
|
||||
this.headerButtonFilters = this.getHeaderButtonFilters();
|
||||
},
|
||||
/**
|
||||
* Filter flagged filters to be shown in the control panel.
|
||||
*
|
||||
* @returns {Array}
|
||||
*/
|
||||
getHeaderButtonFilters() {
|
||||
return Object.values(this.getSearchItems())
|
||||
.filter((f) => {
|
||||
return f.context && makeContext([f.context]).shown_in_panel;
|
||||
})
|
||||
.map((f) => {
|
||||
return {...f, context: makeContext([f.context])};
|
||||
});
|
||||
},
|
||||
/**
|
||||
* Clear the `show_in_panel` context to prevent it being saved with this context
|
||||
* @override
|
||||
* @returns {Object}
|
||||
*/
|
||||
_getIrFilterDescription() {
|
||||
const {preFavorite, irFilter} = super._getIrFilterDescription(...arguments);
|
||||
if (preFavorite?.context) {
|
||||
delete preFavorite.context.shown_in_panel;
|
||||
}
|
||||
return {preFavorite, irFilter};
|
||||
},
|
||||
/**
|
||||
* Update the header filters buttons state
|
||||
* @override
|
||||
*/
|
||||
async _reloadSections() {
|
||||
await super._reloadSections();
|
||||
this.headerButtonFilters = this.getHeaderButtonFilters();
|
||||
},
|
||||
});
|
||||
Loading…
Reference in New Issue