@fenderdigital/react-session-activity

Fender React UI Kit SessionActivity Component

Usage no npm install needed!

<script type="module">
  import fenderdigitalReactSessionActivity from 'https://cdn.skypack.dev/@fenderdigital/react-session-activity';
</script>

README

SessionActivity for Fender React UI Kit

Description

It monitors a user's session. The session ends if no activity occurs between the create and expire dates. The session expire increases, if any user activity is detected.

Installation and Usage

yarn add @fenderdigital/react-session-activity --save

import SessionActivity from '@fenderdigital/react-session-activity';

Props

  • activity - stores user activity in an object to update the session with
  • createdAt - time session starts
  • children - renders any child elements
  • duration - session duration in seconds
  • expiresAt - time session expires
  • lengthOfSession - the length of a session in mins
  • onExpired - callback for when the session expires, with current state
  • onPlaying - callback for when the session is running, with current state
  • onStart - callback for when the session is running, with current state
  • onUpdate - callback for when the session updates, with current state
  • sessionId - uuid for a given session
  • timezone - users timezone
  • updatedAt - time session was updated
propName propType defaultValue isRequired
activity object null -
createdAt string none -
children node none -
duration number none -
expiresAt string none -
lengthOfSession number 30 -
onExpired func () => {} -
onPlaying func () => {} -
onStart func () => {} -
onUpdate func () => {} -
sessionId string none -
timezone string none -
updatedAt string none -

Development

Check the Monorepo README for development documentation.