Home > widget-integration > StickyController > backwardCompatibility

StickyController.backwardCompatibility() method

Applies legacy sticky override config to the options passed into StickyService factories.

This currently maps elements.preDefineSelector into topOffsetSelectors, preserving older shop customizations that pin sticky filters below theme headers or announcement bars.

Signature:

backwardCompatibility(options?: ExtendedBoostStickyOptions, layoutType?: StickyLayoutType, layoutStyle?: string): ExtendedBoostStickyOptions;

Parameters

Parameter

Type

Description

options

ExtendedBoostStickyOptions

(Optional) Sticky options to mutate and return.

layoutType

StickyLayoutType

(Optional) Active layout bucket. Defaults to settings-derived layout when omitted.

layoutStyle

string

(Optional) Active layout style. Defaults to settings-derived style when omitted.

Returns:

ExtendedBoostStickyOptions

Sticky options with backward-compatible overrides applied.