Primitives / foldkit-primitives/dom

KeepScrollOptions

interface · packages/primitives/src/dom/scroll.ts:35

interface KeepScrollOptions {
  readonly storageKey?: string | undefined
  readonly kept?: number | undefined
  readonly patience?: number | undefined
}

How keepScroll remembers and restores each history entry's offset.

Members

KeepScrollOptions.storageKey

property · packages/primitives/src/dom/scroll.ts:37

readonly storageKey?: string | undefined

The sessionStorage key holding entry offsets. Default 'foldkit:scroll'.

KeepScrollOptions.kept

property · packages/primitives/src/dom/scroll.ts:39

readonly kept?: number | undefined

Entries remembered at most: the oldest are forgotten first. Default 50.

KeepScrollOptions.patience

property · packages/primitives/src/dom/scroll.ts:44

readonly patience?: number | undefined

How long a restore holds its place while the next screen settles, in milliseconds. Default 2000.