OWL
data_display
Block UI
Odoo 19 OWL component — Block UI (core)
Live preview
Interactive
Source excerpt
web/static/src/core/ui/block_ui.js
import { _t } from "@web/core/l10n/translation";
import { browser } from "@web/core/browser/browser";
import { EventBus, Component, useState } from "@odoo/owl";
export class BlockUI extends Component {
static props = {
bus: EventBus,
};
static template = "web.BlockUI";
setup() {
this.messagesByDuration = [
{ time: 20, l1: _t("Loading...") },
{ time: 40, l1: _t("Still loading...") },
{
time: 60,
l1: _t("Still loading..."),
l2: _t("Please be patient."),
},
{
time: 180,
l1: _t("Don't leave yet,"),
l2: _t("it's still loading..."),
},
{
time: 120,
l1: _t("You may not believe it,"),
l2: _t("but the application is actually loading..."),
},
{
time: 3180,
l1: _t("Take a minute to get a coffee,"),
l2: _t("because it's loading..."),
},
{
time: null,
l1: _t("Maybe you should consider reloading the application by pressing F5..."),
},
];
this.BLOCK_STATES = { UNBLOCKED: 0, BLOCKED: 1, VISIBLY_BLOCKED: 2 };
this.state = useState({
blockState: this.BLOCK_STATES.UNBLOCKED,
line1: "",
line2: "",
});
this.props.bus.addEventListener("BLOCK", this.block.bind(this));
this.props.bus.addEventListener("UNBLOCK", this.unblock.bind(this));
}
replaceMessage(index) {
const message = this.messagesByDuration[index];
this.state.line1 = message.l1;
this.state.line2 = message.l2 || "";
if (message.time !== null) {
this.msgTimer = browser.setTimeout(() => {
this.replaceMessage(index + 1);
}, message.time * 1000);
}
}
block(ev) {
const showBlockedUI = () => (this.state.blockState = this.BLOCK_STATES.VISIBLY_BLOCKED);
const delay = ev.detail?.delay;
if (delay) {
this.state.blockState = this.BLOCK_STATES.BLOCKED;
this.showBlockedUITimer = setTimeout(showBlockedUI, delay);
} else {
showBlockedUI();
}
if (ev.detail?.message) {
this.state.line1 = ev.detail.message;
} else {
this.replaceMessage(0);
}
}
unblock() {
this.state.blockState = this.BLOCK_STATES.UNBLOCKED;
clearTimeout(this.showBlockedUITimer);
clearTimeout(this.msgTimer);
this.state.line1 = "";
this.state.line2 = "";
}
}
Registry / API
- Registry name
BlockUI- Category
—- Module
web- Slug
block-ui- Nav group
data_display