BlockUI component allows to block any piece(s) of page during various Ajax calls. Blocking is initiated by a "source" component which blocks one or more "target" components. BlockUI adds a layer and any custom content over target elements to be blocked and gives the appearance and behavior of blocking user interaction. It's very handy if you have e.g. a large datatable and sorting, filtering, pagination takes much time. You can block everything, even the entire page, but keep im mind that some HTML elements as table or span can not be blocked. The best approach is to wrap them in a div (h:panelGroup with layout="block").

There are two methods how to use BlockUI. The first one utilizes widget's JavaScript API. This method is shown in the first use case. The second one utilizes jQuery global ajax callbacks. This method hooks into ajax calls automatically, so that there are no needs to call block() / unblock() explicitly. This is so-called "autoShow" mode which is demonstrated in the second use case. Keep in mind please that some PrimeFaces components and p:ajax have the "global" attribute. Setting "global" to false will not trigger BlockUI in "autoShow" mode.

BlockUI is smart enough to recognize multiply blocking of the same element by different ajax calls. Only when all ajax calls finish their work, the blocked element gets unblocked.
Components and more
Documentation pe:blockUI
Attributes (move mouse over the names to see data types)
Name Description
id Unique identifier of the component in a namingContainer.
rendered Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding An EL expression referring to a server side UIComponent instance in a backing bean.
widgetVar Name of the client side widget.
css Styles for the message when blocking. Styles should be defined as JSON object, e.g. {backgroundColor: 'fff', width: 30%}.
cssOverlay Styles for the overlay. Styles should be defined as JSON object, e.g. {opacity: 0.4, backgroundColor: 'red'}
source Specifies component(s) which send(s) an ajax request and triggers blocking. If nothing specified, the parent component is used.
target Specifies component(s) or HTML element(s) to be blocked. If the target is null or not defined, the entire page is blocked.
content Id of the component in terms of findComponent to be used as content shown during blocking. If nothing specified, the content of blockUI component is used.
event Name(s) of one or several accepted events. Several events should be defined as space or comma separated list.
autoShow Flag whether the blocking is shown automatically without the need to use JavaScript widget. Default value is false.
timeout Time in millis to wait before auto-unblocking. Don't define it or set to 0 to disable auto-unblock. Default value is 0.
centerX Set this attribute to true to have the message automatically centered along the X axis. Note: it only effects element blocking (page blocking controlled by CSS via the css attribute). Default value is true.
centerY Set this attribute to true to have the message automatically centered along the Y axis. Default value is true.
fadeIn Fade In time in millis; set to 0 to disable fadeIn on block.
fadeOut Fade Out time in millis; set to 0 to disable fadeOut on unblock.
showOverlay Disable if you do not want to show the overlay. Default value is true.
focusInput Focus will be placed in the first available input field when page blocking. Default value is true.
PrimeFaces Extensions Showcase - © 2011-2021,PrimeFaces: 11.0.0,PrimeFaces Extensions: 11.0.3,JSF: Apache MyFaces JSF-2.3 Core API 2.3.9,Server: jetty/9.4.36.v20210114,Build time: 2022-04-17 14:55