	Language
	English
	English
	English
	French
	German
	German
	German
	Italian
	Korean
	Spanish
	Catalan
	Dutch
	Portuguese
	Portuguese
	Arabic
	Arabic
	Bulgarian
	Bangla
	Bosnian
	Czech
	Greek
	Estonian
	Persian
	Finnish
	Danish
	Hindi
	Indonesian
	Icelandic
	Croatian
	Japanese
	Hungarian
	Hebrew
	Georgian
	Central Kurdish
	Khmer
	Kyrgyz
	Kazakh
	Lithuanian
	Latvian
	Malay
	Norwegian
	Polish
	Romanian
	Russian
	Slovak
	Slovenian
	Serbian
	Serbian
	Swedish
	Thai
	Turkish
	Ukrainian
	Uzbek
	Vietnamese
	Chinese
	Chinese

IdleMonitor

IdleMonitor tracks user actions and invokes corresponding events when user goes idle after a specified time and becomes active again.

IdleMonitor Tag Documentation

IdleMonitor watches user actions on a page and notify callbacks in case they go idle or active again.

Name	Type	Required	Default	Description
id	String	false	generated	Unique identifier of the component in a namingContainer.
rendered	boolean	false	true	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding	UIComponent	false	generated	An EL expression referring to a server side UIComponent instance in a backing bean.
widgetVar	String	false	generated ('widget_' + componentClientId)	Name of the client side widget.
multiWindowSupport	boolean	false	false	When true, the lastAccessed state is shared across all browser windows within the same servlet context.
onactive	String	false		Client side callback to execute when the user comes back.
onidle	String	false		Client side callback to execute when the user goes idle.
timeout	int	false	300000	Time to wait in milliseconds until deciding if the user is idle.

Name	Description
No records found.

Name	Type	Default	Description
idle	AjaxBehaviorEvent	false	Fires when the user goes idle.
active	AjaxBehaviorEvent	false	Fires when the user becomes active again.

Name	Library	Target
jquery/jquery.js	primefaces
core.js	primefaces
idlemonitor/idlemonitor.js	primefaces

Family org.primefaces.component

Type org.primefaces.component.IdleMonitor

Class org.primefaces.component.idlemonitor.IdleMonitor

Renderer Type org.primefaces.component.IdleMonitorRenderer

Renderer Class org.primefaces.component.idlemonitor.IdleMonitorRenderer

RESOURCES

Tag DocumentationNew DocumentationNew Documentation JSDoc


<div class="card">
    <h:form>
        Stay idle on this page for 5 seconds to view the demo.

        <p:growl id="messages" showDetail="true" sticky="true"/>

        <p:idleMonitor timeout="5000">
            <p:ajax event="idle" listener="#{idleMonitorView.onIdle}" update="messages"/>
            <p:ajax event="active" listener="#{idleMonitorView.onActive}" update="messages"/>
        </p:idleMonitor>
    </h:form>
</div>


package org.primefaces.showcase.view.misc;

import jakarta.enterprise.context.RequestScoped;
import jakarta.faces.application.FacesMessage;
import jakarta.faces.context.FacesContext;
import jakarta.inject.Named;

@Named
@RequestScoped
public class IdleMonitorView {

    public void onIdle() {
        FacesContext.getCurrentInstance().addMessage(null, new FacesMessage(FacesMessage.SEVERITY_WARN,
                "No activity.", "User is idle"));
    }

    public void onActive() {
        FacesContext.getCurrentInstance().addMessage(null, new FacesMessage(FacesMessage.SEVERITY_WARN,
                "Activity detected", "User is active"));
    }
}

IdleMonitor

IdleMonitor Tag Documentation

Usage

Reloading page