Skip to content

Commit 641ad41

Browse files
committed
update readme
Update readme with new options
1 parent b7e09ee commit 641ad41

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,14 @@ As long as the user is active, the (optional) keep-alive URL keeps getting pinge
2424

2525
## Documentation
2626
### Options
27+
**title**<br>
28+
29+
Type: `String`
30+
31+
Default: `'Your session is about to expire!'`
32+
33+
This is the text shown to user via Bootstrap warning dialog after warning period. (modal title)
34+
2735
**message**<br>
2836

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

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

43+
**logoutButton**<br>
44+
45+
Type: `String`
46+
47+
Default: `'Logout'`
48+
49+
This is the text shown to user via Bootstrap warning dialog after warning period in the logout button.
50+
51+
**keepAliveButton**<br>
52+
53+
Type: `String`
54+
55+
Default: `'Stay Connected'`
56+
57+
This is the text shown to user via Bootstrap warning dialog after warning period in the Kepp Alive button.
58+
3559
**keepAliveUrl**
3660

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

5781
Time in milliseconds between two keep-alive pings.
5882

83+
**ajaxType**
84+
85+
Type: `String`
86+
87+
Default: `'POST'`
88+
89+
If you need to specify the ajax method
90+
5991
**ajaxData**
6092

6193
Type: `String`

0 commit comments

Comments
 (0)