skytreader / longreads

A minimalist JS library to support bookmarking in text-heavy websites

longreads

A minimalist JS library for bookmarking sections in longform web textual content. This helps your website remember the last section a visitor has been reading, all without the necessity of a backend store. This makes the assumption that your content is properly structured with <section> tags.

The emphasis on minimalism has two objectives:

• Have little to no third party dependencies.
• Do one thing, and only one thing, well.

Usage

The library exposes three methods:

• setBookmark(article: string, section: string): void
• getBookmark(article: string): string
• getCurrentlyViewed(): string[] is a helper function to determine which sections are currently in the viewport. The result is sorted by their top-to- bottom layout order.

article is a unique string that identifies the piece of text a visitor could read.

section is an id in your document. Consider this as in in-page anchors.