[IMP] web_refresher: Add component to pager to avoid instance for all views

pull/2366/head
Carlos Roca 2022-12-20 10:25:26 +01:00
parent c027ded193
commit 6b1854a8e4
9 changed files with 53 additions and 75 deletions

View File

@ -19,9 +19,9 @@ Web Refresher
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_refresher :target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_refresher
:alt: Translate me on Weblate :alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/162/16.0 :target: https://runboat.odoo-community.org/webui/builds.html?repo=OCA/web&target_branch=16.0
:alt: Try me on Runbot :alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5| |badge1| |badge2| |badge3| |badge4| |badge5|
@ -61,6 +61,7 @@ Contributors
* João Marques * João Marques
* Alexandre D. Díaz * Alexandre D. Díaz
* Carlos Roca
* Thanakrit Pintana * Thanakrit Pintana
* `Factorlibre <https://www.factorlibre.com>`__: * `Factorlibre <https://www.factorlibre.com>`__:

View File

@ -10,8 +10,10 @@
"assets": { "assets": {
"web.assets_backend": [ "web.assets_backend": [
"web_refresher/static/src/scss/refresher.scss", "web_refresher/static/src/scss/refresher.scss",
"web_refresher/static/src/js/refresher.js", "web_refresher/static/src/js/refresher.esm.js",
"web_refresher/static/src/js/pager.esm.js",
"web_refresher/static/src/xml/refresher.xml", "web_refresher/static/src/xml/refresher.xml",
"web_refresher/static/src/xml/pager.xml",
], ],
}, },
} }

View File

@ -3,6 +3,7 @@
* João Marques * João Marques
* Alexandre D. Díaz * Alexandre D. Díaz
* Carlos Roca
* Thanakrit Pintana * Thanakrit Pintana
* `Factorlibre <https://www.factorlibre.com>`__: * `Factorlibre <https://www.factorlibre.com>`__:

View File

@ -367,7 +367,7 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !! !! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !! !! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" 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" 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" href="https://github.com/OCA/web/tree/16.0/web_refresher"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_refresher"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p> <p><a class="reference external" 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" 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" href="https://github.com/OCA/web/tree/16.0/web_refresher"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_refresher"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runboat.odoo-community.org/webui/builds.html?repo=OCA/web&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
<p>Adds a button next to the pager (in trees/kanban views) to refresh the displayed list.</p> <p>Adds a button next to the pager (in trees/kanban views) to refresh the displayed list.</p>
<img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_refresher/static/description/refresh.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_refresher/static/description/refresh.png" /> <img alt="https://raw.githubusercontent.com/OCA/web/16.0/web_refresher/static/description/refresh.png" src="https://raw.githubusercontent.com/OCA/web/16.0/web_refresher/static/description/refresh.png" />
<p><strong>Table of contents</strong></p> <p><strong>Table of contents</strong></p>
@ -406,6 +406,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
<li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul> <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
<li>João Marques</li> <li>João Marques</li>
<li>Alexandre D. Díaz</li> <li>Alexandre D. Díaz</li>
<li>Carlos Roca</li>
</ul> </ul>
</li> </li>
<li>Thanakrit Pintana</li> <li>Thanakrit Pintana</li>

View File

@ -0,0 +1,9 @@
/** @odoo-module **/
/* Copyright 2022 Tecnativa - Carlos Roca
* License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). */
import {Pager} from "@web/core/pager/pager";
import {Refresher} from "./refresher.esm";
Pager.components = Object.assign({}, Pager.components, {
Refresher,
});

View File

@ -0,0 +1,16 @@
/** @odoo-module **/
/* Copyright 2022 Tecnativa - Alexandre D. Díaz
* Copyright 2022 Tecnativa - Carlos Roca
* License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). */
const {Component} = owl;
export class Refresher extends Component {
_doRefresh() {
// Note: here we use the pager props, see xml
const {limit, offset} = this.props;
this.props.onUpdate({offset, limit});
}
}
Refresher.template = "web_refresher.Button";

View File

@ -1,42 +0,0 @@
/* Copyright 2022 Tecnativa - Alexandre D. Díaz
* License AGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). */
odoo.define("refresher.Refresher", function (require) {
"use strict";
const ControlPanel = require("web.ControlPanel");
const {Component, hooks} = owl;
const {useRef} = hooks;
class Refresher extends Component {
_doRefresh() {
// Note: here we use the pager props, see xml
const {limit, currentMinimum} = this.props;
this.trigger("pager-changed", {currentMinimum, limit});
}
}
Refresher.template = "web_refresher.Button";
// Patch control panel to initialize refresher component
ControlPanel.components = Object.assign({}, ControlPanel.components, {
Refresher,
});
ControlPanel.patch("web_refresher.ControlPanel", (T) => {
class ControlPanelRefresher extends T {
constructor() {
super(...arguments);
if ("cp_content" in this.props) {
const content = this.props.cp_content || {};
if ("$refresher" in content) {
this.additionalContent.refresher = content.$refresher;
}
}
this.contentRefs.refresher = useRef("refresher");
}
}
return ControlPanelRefresher;
});
return Refresher;
});

View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!-- Copyright 2022 Tecnativa - Carlos Roca
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
<template>
<t
t-name="web_refresher.Pager"
t-inherit="web.Pager"
t-inherit-mode="extension"
owl="1"
>
<xpath expr="//span[hasclass('o_pager_counter')]" position="before">
<div class="oe_cp_refresher" role="search" t-ref="refresher">
<Refresher t-props="props" />
</div>
</xpath>
</t>
</template>

View File

@ -1,34 +1,7 @@
<?xml version="1.0" encoding="UTF-8" ?> <?xml version="1.0" encoding="UTF-8" ?>
<!-- Copyright 2022 Tecnativa - Alexandre Díaz <!-- Copyright 2022 Tecnativa - Alexandre Díaz
License AGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). --> License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
<template> <template>
<t
t-name="web_refresher.ControlPanel"
t-inherit="web.ControlPanel"
t-inherit-mode="extension"
owl="1"
>
<xpath expr="//div[hasclass('o_cp_pager')]" position="before">
<div class="oe_cp_refresher" role="search" t-ref="refresher">
<Refresher t-props="props.pager" />
</div>
</xpath>
</t>
<t
t-name="web_refresher.ControlPanelX2Many"
t-inherit="web.ControlPanelX2Many"
t-inherit-mode="extension"
owl="1"
>
<xpath expr="//div[hasclass('o_cp_pager')]" position="before">
<div class="oe_cp_refresher" role="search" t-ref="refresher">
<Refresher t-props="props.pager" />
</div>
</xpath>
</t>
<t t-name="web_refresher.Button" owl="1"> <t t-name="web_refresher.Button" owl="1">
<nav class="oe_refresher" aria-label="Pager"> <nav class="oe_refresher" aria-label="Pager">
<span aria-atomic="true"> <span aria-atomic="true">