up.viewport up.viewport.saveScroll([options])

JavaScript function

Saves the top scroll positions of all the viewports configured in up.viewport.config.viewports.

The scroll positions will be associated with the current URL. They can later be restored by calling up.viewport.restoreScroll() at the same URL, or by following a link with an [up-restore-scroll] attribute.

Unpoly automatically saves scroll positions before a fragment update you will rarely need to call this function yourself.

Examples

Should you need to save the current scroll positions outside of a fragment update, you may call:

up.viewport.saveScroll()

Instead of saving the current scroll positions for the current URL, you may also pass another url or vertical scroll positionsfor each viewport:

up.viewport.saveScroll({
  url: '/inbox',
  tops: {
    'body': 0,
    '.sidebar', 100,
    '.main', 320
  }
})