API Scrolling viewports

module up.viewport

The up.viewport module controls the scroll position of scrollable containers ("viewports").

The default viewport for any web application is the main document. An application may define additional viewports by giving the CSS property { overflow-y: scroll } to any <div>.

Revealing new content

When following a link to a fragment Unpoly will automatically scroll the document's viewport to reveal the updated content.

You should make Unpoly aware of fixed elements in your layout, such as navigation bars or headers. Unpoly will respect these sticky elements when revealing updated fragments.

You should also tell Unpoly when your application has more than one viewport, so Unpoly can pick the right viewport to scroll for each fragment update.

Bootstrap integration

When using Bootstrap integration (unpoly-bootstrap3.js and unpoly-bootstrap3.css) Unpoly will automatically be aware of sticky Bootstrap components such as fixed navbar.