Skip to content

session-resume 0.1.0 Latest version

Install from the command line:
Learn more
$ npm install @github/session-resume@0.1.0
Install via package.json:
"@github/session-resume": "0.1.0"

About this package

Session Resume

Annotate fields to be persisted on navigation away from the current page.
Fields be automatically restored when the user revists the page again in
their current browser session (excludes separate tabs).

Not designed for persisted crash recovery.

Installation

$ npm install @github/session-resume

Usage

HTML

<form>
  <input id="new-comment" class="js-session-resumable"/>
</form>

JS

import {persistResumableFields, restoreResumableFields, setForm} from '@github/session-resume'

function getPageID() {
  return window.location.pathname
}

// Listen for all form submit events and to see if their default submission
// behavior is invoked.
window.addEventListener('submit', setForm, {capture: true})

// Resume field content on regular page loads.
window.addEventListener('pageshow', function() {
  restoreResumableFields(getPageID())
})

// Persist resumable fields when page is unloaded
window.addEventListener('pagehide', function() {
  persistResumableFields(getPageID())
})

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

Package details

  • @github github
  • April 10, 2020
  • 11 dependencies
  • MIT License

Download activity

  • Total downloads 6
  • Last 30 days 2
  • Last week 2
  • Today 0

Recent versions

View all
You can’t perform that action at this time.