Skip to main content
U.S. Flag

An official website of the United States government

Idle Timeout

A component that counts down to the end of a session (behind the scenes) and shows a warning message after a set amount of time of inactivity.

Examples

Loading

Code

React

React Properties Documentation
NameTypeDefaultDescription
closeButtonTextstring'Close'

The text for the dialog's 'close' button

continueSessionTextstring'Continue session'

The text for the 'continue session' button in warning dialog.

headingstring'Are you still there?'

The heading text for the warning dialog.

endSessionButtonTextstring'Logout'

The text for the button that ends the session in warning dialog.

endSessionUrlstring'/logout'

The URL to direct to when the user intentionally ends the session.

formatMessage(timeTilTimeout: number) => string | React.ReactNode(timeTilTimeout: number): React.ReactNode => { const unitOfTime = timeTilTimeout === 1 ? 'minute' : 'minutes'; return ( <p> You&apos;ve been inactive for a while. <br /> Your session will end in{' '} <strong> {timeTilTimeout} {unitOfTime} </strong> . <br /> <br /> Select &quot;Continue session&quot; below if you want more time. </p> ); }

A formatting function that returns the string to be used in the warning modal. The formatting function is provided the timeTilTimeout (in minutes).

onSessionContinue(...args: any[]) => any

Optional function that is called when the user chooses to keep the session alive. This function is called by the 'continue session' button or the 'close' button. The IdleTimeout component will reset the countdown internally.

onSessionForcedEnd(...args: any[]) => any

Optional function that is called when the session is manually ended by user. If not provided, the behavior of onTimeout will be used.

onTimeoutrequired(...args: any[]) => any

Function that is called when the timeout countdown reaches zero.

showSessionEndButtonbooleanfalse

Describes if the button to manually end session should be shown in the warning dialog.

timeToTimeoutrequirednumber

Defines the amount of minutes of idle activity until the session is timed out

timeToWarningrequirednumber

Defines the amount of minutes of idle activity that will trigger the warning message.

Customization

The following Sass variables can be overridden to customize Dialog components:

Sass variables for dialog
VariableDefault Core Theme Value
$dialog__background-color$color-white
$dialog__padding32px
$dialog-overlay__background-color$color-transparent-black-alpha50

Guidance

When to use

  • Use the IdleTimeout for authenticated sessions to force logout after a set amount of time on inactivity