Skip to main content

Parallax

A plugin to apply parallax effect while panels are moving

See Also:

Constructor​

constructor(selector?: string, scale?: number);

Constructs a new instance of the Parallax class

Parameters​

selector (string) - CSS selector for the element to apply the parallax effect. If empty, the panel element itself is used

scale (number) - Effect amplification scale

Examples​

flicking.addPlugins(new Parallax("img", 1));

Properties​

scale​

Type: number

Effect amplification scale

This property is read-only.

selector​

Type: string

CSS selector for the element to apply the parallax effect. If empty, the panel element itself is used

This property is read-only.

update​

Type: () => void

Recalculate and apply the parallax effect to all visible panels.

Methods​

destroy​

destroy(): void

Destroy the plugin and remove all event listeners.

init​

init(flicking: Flicking): void

Initialize the plugin and apply the parallax effect to the Flicking instance.

Parameters:

  • flicking (Flicking) - The Flicking instance to attach this plugin to