https://github.com/changhuixu/session-expiration-alert
Angular module for session expiration alert
https://github.com/changhuixu/session-expiration-alert
alert angular angular10 angular6 angular9 session session-expiration session-handler session-management session-manager timer
Last synced: 2 months ago
JSON representation
Angular module for session expiration alert
- Host: GitHub
- URL: https://github.com/changhuixu/session-expiration-alert
- Owner: changhuixu
- Created: 2018-04-06T20:38:45.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-11-03T02:30:47.000Z (12 months ago)
- Last Synced: 2024-12-03T04:47:39.259Z (11 months ago)
- Topics: alert, angular, angular10, angular6, angular9, session, session-expiration, session-handler, session-management, session-manager, timer
- Language: TypeScript
- Homepage: https://changhuixu.github.io/session-expiration-alert/
- Size: 1.51 MB
- Stars: 18
- Watchers: 4
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Session Expiration Alert
[](https://github.com/changhuixu/session-expiration-alert/actions)
[](https://www.npmjs.com/package/session-expiration-alert)
[](https://github.com/changhuixu/session-expiration-alert/blob/master/LICENSE)
An Angular module to time session expiration. When user session idle time reaches a threshold, then pop up a modal dialog to let user choose to continue session or log out the system. When user session is expired, timer will stop and an alert dialog will ask for actions. A http interceptor is registered, so that session timer will restart at every http request.
**v19.x** Dependencies: Angular 19+.
**v13.x** Dependencies: Angular 13+.
**v12.x** Dependencies: Angular 12+, Bootstrap 4.5+ (css), NgBootstrap 10+.
**v11.1.2** When user session is expired, timer will stop and an alert dialog will ask for actions.
**v11.0.0** Breaking Change: Corrected the name for the `SessionInterruptService` service.
**v11.x** Dependencies: Angular 10+, Bootstrap 4.5+ (css), NgBootstrap 7+.
**v10.x** Dependencies: Angular 10+, Bootstrap 4.5+ (css), NgBootstrap 7+.
**v9.x** Dependencies: Angular 9+, Bootstrap 4+ (css), NgBootstrap 6+.
**v6.x** Dependencies: Angular 6+, Bootstrap 4+ (css), NgBootstrap 3+.
## [Demo](https://session-expiration-alert.netlify.com/)
## Usage
In `app.module.ts`
```typescript
@NgModule({
declarations: [AppComponent],
imports: [
BrowserModule,
HttpClientModule,
SessionExpirationAlertModule.forRoot(),
// *** your other import modules
],
providers: [
{
provide: SessionInterruptService,
useClass: AppSessionInterruptService,
},
],
bootstrap: [AppComponent],
})
export class AppModule {}
```
In `app.component.html`
```html
```
In `app-session-interrupt.service.ts`
```typescript
@Injectable()
export class AppSessionInterruptService extends SessionInterruptService {
constructor(private readonly httpClient: HttpClient) {
super();
}
continueSession() {
console.log(`I issue an API request to server.`);
}
stopSession() {
console.log(`I logout.`);
}
}
```
Then the `SessionTimerService` will start to count down at each second.
- To provide actions in the alert modal dialog, you want to provide a `AppSessionInterruptService` class, which will be able to continue session via refreshing cookie, or stop session via logging out.
- To start/stop/reset timer, inject `SessionTimerService` into your component or service, then call `startTimer()`, `stopTimer()`, `resetTimer()` as needed.
- To get the remain time (in seconds), you can subscribe to `remainSeconds$` in `SessionTimerService`.
## Configuration
```typescript
imports: [
// ***
SessionExpirationAlertModule.forRoot({totalMinutes: 0.5}),
//***
],
```
The `SessionExpirationAlertModule` accepts a configuration with interface of `SessionExpirationConfig`, which is an optional input and has a default value of total minutes = 20 min.
```html
```
[optional] `startTimer` indicates if the app needs to work on session expiration check or not. Default: true.
[optional] `alertAt` indicates when the alert modal dialog should show up. The value means how many seconds left till session becomes expired. Default: 60 (seconds).