Metadata-Version: 2.1
Name: odoo-addon-web_loading_block_ui
Version: 18.0.1.0.0.3
Requires-Python: >=3.10
Requires-Dist: odoo==18.0.*
Summary: Block the screen with a centered loading overlay while requests are pending
Home-page: https://github.com/OCA/web
License: LGPL-3
Author: ForgeFlow, Odoo Community Association (OCA)
Author-email: support@odoo-community.org
Classifier: Programming Language :: Python
Classifier: Framework :: Odoo
Classifier: Framework :: Odoo :: 18.0
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Description-Content-Type: text/x-rst

====================
Web Loading Block UI
====================

.. 
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! This file is generated by oca-gen-addon-readme !!
   !! changes will be overwritten.                   !!
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   !! source digest: sha256:68b714c85edf983690119636c79f95be1709ed62f4291605430ee21fff7781b2
   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |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-LGPL--3-blue.png
    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
    :alt: License: LGPL-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_loading_block_ui
    :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_loading_block_ui
    :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|

Since Odoo 17.0 the loading indicator is a small badge in the bottom
right corner of the screen and the user interface keeps accepting input
while a request is still running. Odoo 16.0 and earlier blocked the
whole screen with a blurred overlay and a centered spinner when a
request took longer than a few seconds.

This module restores that behaviour on top of the current loading
indicator: when a request stays pending for longer than a configurable
delay, the screen is blocked with the standard Odoo overlay (blurred
background and centered "Loading..." spinner) until every pending
request has been answered.

**Table of contents**

.. contents::
   :local:

Configuration
=============

The delay before the screen is blocked is stored in the system parameter
``web_loading_block_ui.delay``, expressed in milliseconds and counted
from the moment the first request starts. The default value is ``3000``,
which matches the behaviour of Odoo 16.0 and earlier.

To change it, enable developer mode and go to *Settings > Technical >
System Parameters*. Set the value to ``0`` to block the screen as soon
as a request starts. Users need to reload the page for a new value to be
applied.

Usage
=====

Trigger any action that takes longer than the configured delay, for
example opening a heavy report or saving a large record. The screen is
blurred and a centered "Loading..." spinner is shown until the action
finishes. Requests marked as silent by Odoo (background polling,
notifications) never block the screen.

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_loading_block_ui%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
-------

* ForgeFlow

Contributors
------------

- `ForgeFlow <https://www.forgeflow.com>`__:

  - David Jiménez <david.jimenez@forgeflow.com>

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_loading_block_ui>`_ project on GitHub.

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