Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ As long as the user is active, the (optional) keep-alive URL keeps getting pinge

## Documentation
### Options
**title**<br>

Type: `String`

Default: `'Your session is about to expire!'`

This is the text shown to user via Bootstrap warning dialog after warning period. (modal title)

**message**<br>

Type: `String`
Expand All @@ -32,6 +40,22 @@ Default: `'Your session is about to expire.'`

This is the text shown to user via Bootstrap warning dialog after warning period.

**logoutButton**<br>

Type: `String`

Default: `'Logout'`

This is the text shown to user via Bootstrap warning dialog after warning period in the logout button.

**keepAliveButton**<br>

Type: `String`

Default: `'Stay Connected'`

This is the text shown to user via Bootstrap warning dialog after warning period in the Kepp Alive button.

**keepAliveUrl**

Type: `String`
Expand All @@ -56,6 +80,14 @@ Default: `5000` (5 seconds)

Time in milliseconds between two keep-alive pings.

**ajaxType**

Type: `String`

Default: `'POST'`

If you need to specify the ajax method

**ajaxData**

Type: `String`
Expand Down
24 changes: 21 additions & 3 deletions dist/bootstrap-session-timeout.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,12 @@
(function( $ ){
jQuery.sessionTimeout = function( options ) {
var defaults = {
title : 'Your Session is About to Expire!',
message : 'Your session is about to expire.',
logoutButton : 'Logout',
keepAliveButton : 'Stay Connected',
keepAliveUrl : '/keep-alive',
ajaxType : 'POST',
ajaxData : '',
redirUrl : '/timed-out',
logoutUrl : '/log-out',
Expand Down Expand Up @@ -45,7 +49,21 @@
// unless user set his own callback function, prepare bootstrap modal elements and events
if(typeof opt.onWarn !== 'function'){
// create timeout warning dialog
$('body').append('<div class="modal fade" id="sessionTimeout-dialog"><div class="modal-dialog"><div class="modal-content"><div class="modal-header"><button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button><h4 class="modal-title">Your Session is About to Expire!</h4></div><div class="modal-body">'+ opt.message +'</div><div class="modal-footer"><button id="sessionTimeout-dialog-logout" type="button" class="btn btn-default">Logout</button><button id="sessionTimeout-dialog-keepalive" type="button" class="btn btn-primary" data-dismiss="modal">Stay Connected</button></div></div></div></div>');
$('body').append('<div class="modal fade" id="sessionTimeout-dialog"> \
<div class="modal-dialog"> \
<div class="modal-content"> \
<div class="modal-header"> \
<button type="button" class="close" data-dismiss="modal" aria-hidden="true">&times;</button> \
<h4 class="modal-title">'+ opt.title +'</h4> \
</div> \
<div class="modal-body">'+ opt.message +'</div> \
<div class="modal-footer"> \
<button id="sessionTimeout-dialog-logout" type="button" class="btn btn-default">'+ opt.logoutButton +'</button> \
<button id="sessionTimeout-dialog-keepalive" type="button" class="btn btn-primary" data-dismiss="modal">'+ opt.keepAliveButton +'</button> \
</div> \
</div> \
</div> \
</div>');

// "Logout" button click
$('#sessionTimeout-dialog-logout').on('click', function () { window.location = opt.logoutUrl; });
Expand All @@ -69,7 +87,7 @@
function keepAlive () {
if (!keepAlivePinged){
$.ajax({
type: 'POST',
type: opt.ajaxType,
url: opt.keepAliveUrl,
data: opt.ajaxData
});
Expand Down Expand Up @@ -125,4 +143,4 @@
// start session timer
startSessionTimer();
};
})( jQuery );
})( jQuery );
2 changes: 1 addition & 1 deletion dist/bootstrap-session-timeout.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.