Class ScrollProgress

ScrollProgress is a component that tracks the scroll progress of a specified section element.

This component can be used for creating scroll-based animations such as parallax effects.

Documentation

Hierarchy (View Summary)

Module<TC, TS, TM>
- ScrollProgress

Index

Constructors

constructor

new ScrollProgress(
    props?: IScrollProgressStaticProps & IScrollProgressMutableProps & Partial<
        {
            onDestroy: (data: undefined, ctx: ScrollProgress) => void;
            onProps: (data: Partial, ctx: ScrollProgress) => void;
            onUpdate: (data: undefined, ctx: ScrollProgress) => void;
        },
    >,
    onCallbacks?: Partial<
        {
            onDestroy: (data: undefined, ctx: ScrollProgress) => void;
            onProps: (data: Partial, ctx: ScrollProgress) => void;
            onUpdate: (data: undefined, ctx: ScrollProgress) => void;
        },
    >,
): ScrollProgress
Parameters
- Optionalprops: IScrollProgressStaticProps & IScrollProgressMutableProps & Partial<
      {
          onDestroy: (data: undefined, ctx: ScrollProgress) => void;
          onProps: (data: Partial, ctx: ScrollProgress) => void;
          onUpdate: (data: undefined, ctx: ScrollProgress) => void;
      },
  >
- OptionalonCallbacks: Partial<
      {
          onDestroy: (data: undefined, ctx: ScrollProgress) => void;
          onProps: (data: Partial, ctx: ScrollProgress) => void;
          onUpdate: (data: undefined, ctx: ScrollProgress) => void;
      },
  >
Returns ScrollProgress
Overrides Module.constructor
- Defined in src/components/ScrollProgress/index.ts:60

Accessors

callbacks

get callbacks(): Callbacks<CallbacksMap, this>
Retrieves the module's callbacks instance.

Returns Callbacks<CallbacksMap, this>
Inherited from Module.callbacks
- Defined in src/base/Module/index.ts:76

inProgress

get inProgress(): { x: number; y: number }
Calculates the progress of the section entering the root element.

Returns { x: number; y: number }
- Defined in src/components/ScrollProgress/index.ts:228

isDestroyed

get isDestroyed(): boolean
Checks if the module has been destroyed.

Returns boolean
Inherited from Module.isDestroyed
- Defined in src/base/Module/index.ts:66

isVisible

get isVisible(): boolean
Indicates whether the section is currently visible within the viewport or root element.

Returns boolean
- Defined in src/components/ScrollProgress/index.ts:79

moveProgress

get moveProgress(): { x: number; y: number }
Calculates the progress of the section's movement within the root element.

Returns { x: number; y: number }
- Defined in src/components/ScrollProgress/index.ts:261

name

get name(): string
The name of the module, derived from the class name

Returns string
Inherited from Module.name
- Defined in src/base/Module/index.ts:56

outProgress

get outProgress(): { x: number; y: number }
Calculates the progress of the section leaving the root element.

Returns { x: number; y: number }
- Defined in src/components/ScrollProgress/index.ts:249

prefix

get prefix(): string
Optional prefix for classnames used by the module

Returns string
Inherited from Module.prefix
- Defined in src/base/Module/index.ts:51

progress

get progress(): { x: number; y: number }
Calculates the global scroll progress of the section relative to the root element.

Returns { x: number; y: number }
- Defined in src/components/ScrollProgress/index.ts:288

props

get props(): TRequiredProps<MutableProps & StaticProps>
Current properties. Do not mutate these directly, use updateProps instead.

Returns TRequiredProps<MutableProps & StaticProps>
Inherited from Module.props
- Defined in src/base/Module/index.ts:46

rootBounds

get rootBounds(): IScrollProgressBounds
The bounds of the root element used for scroll calculations.

Returns IScrollProgressBounds
- Defined in src/components/ScrollProgress/index.ts:84

section

get section(): Element
Returns the section element being tracked for scroll progress.

Returns Element
- Defined in src/components/ScrollProgress/index.ts:74

sectionBounds

get sectionBounds(): IScrollProgressBounds
The bounds of the section element relative to the root element.

Returns IScrollProgressBounds
- Defined in src/components/ScrollProgress/index.ts:89

Methods

`Protected`_addTempClassName

_addTempClassName(element: Element, className: string): void
Adds a class name on an element, and keeps track of it for removal when the module is destroyed.
Parameters
- element: Element
  The target DOM element.
- className: string
  The class name to toggle.
Returns void
Inherited from Module._addTempClassName
- Defined in src/base/Module/index.ts:209

`Protected`_cn

_cn(...classNames: string[]): string
Helper function to generate classnames with the module's prefix.
Parameters
- ...classNames: string[]
  The class names to generate.
Returns string
A string of class names with the module's prefix applied.
Inherited from Module._cn
- Defined in src/base/Module/index.ts:199

`Protected`_destroy

_destroy(): void
Internal method to handle the destruction of the module. It removes all callbacks, destroys properties, and cleans up event listeners and class names.

Returns void
Inherited from Module._destroy
- Defined in src/base/Module/index.ts:231

_getMutable

_getMutable(): { __mutableProp: true }
Retrieves the default mutable properties.

Returns { __mutableProp: true }
Overrides Module._getMutable
- Defined in src/components/ScrollProgress/index.ts:37

_getStatic

_getStatic(): {
    __staticProp: true;
    optimized: boolean;
    root: Element;
    section: Element;
    useSvh: boolean;
}
Retrieves the default static properties.

Returns {
    __staticProp: true;
    optimized: boolean;
    root: Element;
    section: Element;
    useSvh: boolean;
}
- __staticProp: true
- optimized: boolean
  If true, progress is calculated only while the section is within the viewport or the root element. Improves performance by avoiding unnecessary calculations.
  Default
  true
- root: Element
  The root element used as a reference for scroll progress calculation. Usually it is the scroll container. If null, the viewport is used as the reference.
  Default
  null
- section: Element
  The element whose scroll progress is tracked.
- useSvh: boolean
  If true, the scroll progress is calculated based on the small viewport height (svh in css) instead of the current viewport height (vh in css).
  Default
  false
Overrides Module._getStatic
- Defined in src/components/ScrollProgress/index.ts:32

`Protected`_handleProps

_handleProps(diff: Partial<IScrollProgressMutableProps>): void
Method that is called when the module's properties mutate. In most cases, used to handle callbacks.
Parameters
- diff: Partial<IScrollProgressMutableProps>
Returns void
Inherited from Module._handleProps
- Defined in src/base/Module/index.ts:131

destroy

destroy(): void
Destroys the module, cleaning up resources, callbacks, and event listeners.

Returns void
Inherited from Module.destroy
- Defined in src/base/Module/index.ts:223

getProgress

getProgress(
    topThreshold: number,
    rightThreshold: number,
    bottomThreshold: number,
    leftThreshold: number,
): { x: number; y: number }
Calculates the section scroll progress relative to the root element.

The function takes top or left corner of the section as the reference point.
Parameters
- topThreshold: number
  Top threshold of the section position.
- rightThreshold: number
  Right threshold of the section position.
- bottomThreshold: number
  Bottom threshold of the section position.
- leftThreshold: number
  Left threshold of the section position.
Returns { x: number; y: number }
The scroll progress along the x and y axes.
Example
```
const progress = getProgress(0, vevet.width, vevet.height / 2, 0)

// `progress.y` is `0` when the top corner of the section is at the beginning of the viewport or root element
// `progress.y` is `1` when the top corner of the section is at the center of the viewport or root element
```
- Defined in src/components/ScrollProgress/index.ts:205

on

on<T extends keyof IScrollProgressCallbacksMap>(
    target: T,
    listener: TCallbacksAction<IScrollProgressCallbacksMap[T], ScrollProgress>,
    settings?: ICallbacksSettings,
): () => void
Adds a custom callback to the module.
Type Parameters
- T extends keyof IScrollProgressCallbacksMap
Parameters
- target: T
  The event type to listen for (e.g., 'props', 'destroy').
- listener: TCallbacksAction<IScrollProgressCallbacksMap[T], ScrollProgress>
  The function to execute when the event is triggered.
- settings: ICallbacksSettings = {}
  Additional settings for the callback.
Returns () => void
Inherited from Module.on
- Defined in src/base/Module/index.ts:185

onDestroy

onDestroy(action: () => void): void
Adds a callback on the module's destruction.
Parameters
- action: () => void
  The function to execute during destruction.
Returns void
Inherited from Module.onDestroy
- Defined in src/base/Module/index.ts:167

update

update(isForce?: boolean): void
Updates the section and root bounds, and emits an update callback.
Parameters
- isForce: boolean = false
Returns void
- Defined in src/components/ScrollProgress/index.ts:155

updateProps

updateProps(props: Partial<IScrollProgressMutableProps>): void
Change module's mutable properties
Parameters
- props: Partial<IScrollProgressMutableProps>
Returns void
Inherited from Module.updateProps
- Defined in src/base/Module/index.ts:137

Class ScrollProgress

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns ScrollProgress

Accessors

callbacks

Returns Callbacks<CallbacksMap, this>

inProgress

Returns { x: number; y: number }

isDestroyed

Returns boolean

isVisible

Returns boolean

moveProgress

Returns { x: number; y: number }

name

Returns string

outProgress

Returns { x: number; y: number }

prefix

Returns string

progress

Returns { x: number; y: number }

props

Returns TRequiredProps<MutableProps & StaticProps>

rootBounds

Returns IScrollProgressBounds

section

Returns Element

sectionBounds

Returns IScrollProgressBounds

Methods

Protected_addTempClassName

Parameters

Returns void

Protected_cn

Parameters

Returns string

Protected_destroy

Returns void

_getMutable

Returns { __mutableProp: true }

_getStatic

Returns { __staticProp: true; optimized: boolean; root: Element; section: Element; useSvh: boolean;}

__staticProp: true

optimized: boolean

Default

root: Element

Default

section: Element

useSvh: boolean

Default

Protected_handleProps

Parameters

Returns void

destroy

Returns void

getProgress

Parameters

Returns { x: number; y: number }

Example

on

Type Parameters

Parameters

Returns () => void

onDestroy

Parameters

Returns void

update

Parameters

Returns void

updateProps

Parameters

Returns void

`Protected`_addTempClassName

`Protected`_cn

`Protected`_destroy

Returns {
__staticProp: true;
optimized: boolean;
root: Element;
section: Element;
useSvh: boolean;
}

`Protected`_handleProps