1.0.0 • Published 1 year ago

@anedomansky/react-session v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

react-session

npm version

An easy-to-use session component with included warning and renewal modals.

Features

  • Session timer
  • Session warning modal
  • Session expired modal

Installation

npm install @anedomansky/react-session

Usage

import Session from '@anedomansky/react-session';
import '/node_modules/@anedomansky/react-session/dist/style.css';

function App() {
  return (
    <div className="App">
      <Session
        additionalExpiredModalClasses="text-expired"
        additionalWarnModalClasses="text-warn"
        duration={10}
        expiredModalBtnText="Restart"
        expiredModalText="Session is expired!"
        expiredModalTitle="Expired Session!"
        onExpiredModalBtnClick={() => console.log('Expired button clicked')}
        onWarnModalBtnClick={() => console.log('Warn button clicked')}
        sessionInfoText="Duration"
        warnModalBtnText="Okay"
        warnModalText="Session is soon over."
        warnModalTitle="Attention!"
      />
    </div>
  )
}

export default App

Props

NameTypeDefaultDescription
additionalExpiredModalClassesstring''Additional CSS classes for the <dialog>-Element
additionalWarnModalClassesstring''Additional CSS classes for the <dialog>-Element
durationnumber1800The duration of the session in seconds
expiredModalBtnTextstring'Reset'The expired modal button text
expiredModalTextstring'The session is expired!'The expired modal text
expiredModalTitlestring'Expired!'The expired modal title
sessionInfoTextstring'Session'The text that is shown above the session timer
onExpiredModalBtnClick(event: React.MouseEvent) => voidCallback, triggered when the expired modal button is clicked
onWarnModalBtnClick(event: React.MouseEvent) => voidCallback, triggered when the warn modal button is clicked
warnModalBtnTextstring'OK'The warn modal button text
warnModalTextstring'The session will soon expire!'The warn modal text
warnModalTitlestring'Warning!'The warn modal title