Skip to content
ngx-magic-scroll

MagicScrollOptions

Defaults for an application or overrides for one magicScroll region.

Properties

Section titled “Properties”

activationThreshold?

Section titled “activationThreshold?”

optional activationThreshold?: number

Relative activation threshold (0.0 to 1.0) defining the trigger line within the visible reading area.

anchorPrefixes?

Section titled “anchorPrefixes?”

optional anchorPrefixes?: readonly string[] | string[]

Allowed anchor ID prefixes. Descendant elements matching any prefix participate. Explicit scrollAnchor markers also participate. Passing an empty array [] disables prefix matching so only explicit markers participate.

anchorSelection?

Section titled “anchorSelection?”

optional anchorSelection?: AnchorSelectionMode

Selection strategy for anchor discovery.

  • 'all': Selects elements matching prefixes or explicit markers (default).
  • 'explicit': Selects only elements with explicit scrollAnchor markers.

behavior?

Section titled “behavior?”

optional behavior?: object

Restoration and deliberate user navigation have separate defaults.

interaction?

Section titled “interaction?”

optional interaction?: ScrollBehavior

restoration?

Section titled “restoration?”

optional restoration?: ScrollBehavior

bottomOffset?

Section titled “bottomOffset?”

optional bottomOffset?: number

Bottom offset in pixels to adjust the active reading boundary from the bottom.

debounceTime?

Section titled “debounceTime?”

optional debounceTime?: number

headerOffset?

Section titled “headerOffset?”

optional headerOffset?: number

Gap below the header, or the complete top offset when no header is selected.

headerSelector?

Section titled “headerSelector?”

optional headerSelector?: string

Selector for a fixed/sticky header whose height is measured automatically.

ignoreWhenInView?

Section titled “ignoreWhenInView?”

optional ignoreWhenInView?: "none" | "top" | "full" | "always"

preserveOnLayoutChange?

Section titled “preserveOnLayoutChange?”

optional preserveOnLayoutChange?: boolean

Preserve anchor-relative reading position when region content reflows (e.g. image loads, form expansions, accordion toggles) without changing scrollSource. Defaults to false (explicit opt-in).

preserveOnResize?

Section titled “preserveOnResize?”

optional preserveOnResize?: boolean

Preserve the current anchor on window resize and measured header-height changes.

restoreOnDataChange?

Section titled “restoreOnDataChange?”

optional restoreOnDataChange?: boolean

Keep the current anchor visible after later data updates. Defaults to true.