Class SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>

SectionScrollProgress is a component that traces the scroll progress of a specified section. It provides the progress of entering the viewport, moving within it, and exiting it.

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- SectionScrollProgress

Index

Constructors

constructor

new SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?, canInit?): SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NScrollSectionProgress.IStaticProps = NScrollSectionProgress.IStaticProps
- ChangeableProps extends NScrollSectionProgress.IChangeableProps = NScrollSectionProgress.IChangeableProps
- CallbacksTypes extends NScrollSectionProgress.ICallbacksTypes = NScrollSectionProgress.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
- canInit: boolean = true
Returns SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>
Overrides Component.constructor
- Defined in src/components/SectionScrollProgress/index.ts:137

Accessors

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Retrieves the module's registered callbacks.

Returns Callbacks<CallbacksTypes>
Inherited from ComponentClass.callbacks
- Defined in src/base/Module/index.ts:79

isDestroyed

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

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

isInitialized

get isInitialized(): boolean
Checks if the module has been initialized.

Returns boolean
Inherited from ComponentClass.isInitialized
- Defined in src/base/Module/index.ts:108

name

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

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

prefix

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

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

progressGlobal

get progressGlobal(): number
Returns the current global progress of the scroll.

Returns number
- Defined in src/components/SectionScrollProgress/index.ts:124
set progressGlobal(value): void
Parameters
- value: number
Returns void
- Defined in src/components/SectionScrollProgress/index.ts:128

progressIn

get progressIn(): number
Returns the progress of the section as it appears in the viewport.

Returns number
- Defined in src/components/SectionScrollProgress/index.ts:216

progressMove

get progressMove(): number
Returns the progress of the section as it moves through the viewport.

Returns number
- Defined in src/components/SectionScrollProgress/index.ts:230

progressOut

get progressOut(): number
Returns the progress of the section as it exits the viewport.

Returns number
- Defined in src/components/SectionScrollProgress/index.ts:223

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
The current properties of the module, which include both static and changeable properties. These can be retrieved dynamically during the module's lifecycle.

Returns TRequiredModuleProp<StaticProps & ChangeableProps>
Inherited from ComponentClass.props
- Defined in src/base/Module/index.ts:64

scopeGlobal

get scopeGlobal(): [number, number]
Returns the global scope of the scrolling section.

Returns [number, number]
- Defined in src/components/SectionScrollProgress/index.ts:71

scopeIn

get scopeIn(): [number, number]
Returns the scope of the section appearing in the viewport.

Returns [number, number]
- Defined in src/components/SectionScrollProgress/index.ts:83

scopeMove

get scopeMove(): [number, number]
Returns the scope of the section moving through the viewport.

Returns [number, number]
- Defined in src/components/SectionScrollProgress/index.ts:95

scopeOut

get scopeOut(): [number, number]
Returns the scope of the section disappearing from the viewport.

Returns [number, number]
- Defined in src/components/SectionScrollProgress/index.ts:107

scrollContainer

get scrollContainer(): Element | Window | CustomScroll<NCustomScroll.IStaticProps, NCustomScroll.IChangeableProps, NCustomScroll.ICallbacksTypes>
Returns the scroll container.

Returns Element | Window | CustomScroll<NCustomScroll.IStaticProps, NCustomScroll.IChangeableProps, NCustomScroll.ICallbacksTypes>
The scroll container.
- Defined in src/components/SectionScrollProgress/index.ts:47

section

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

Returns Element
- Defined in src/components/SectionScrollProgress/index.ts:59

Methods

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Adds a custom callback to the module.
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
  
  The event type to listen for (e.g., 'propsChange', 'destroy').
- action: TAction<CallbacksTypes[T]>
  
  The function to execute when the event is triggered.
- settings: ISettings = {}
  
  Additional settings for the callback.
Returns IAddedCallback
Inherited from Component.addCallback
- Defined in src/base/Module/index.ts:245

addEventListener

addEventListener<Target, Listener>(element, target, callback, options?): (() => void)
Adds a DOM event listener that will be automatically removed when the module is destroyed.
Type Parameters
- Target extends keyof HTMLElementEventMap
- Listener extends ((event) => void)
Parameters
- element: Document | Element | Window
  
  The target element for the event listener.
- target: Target
  
  The event type to listen for (e.g., 'click', 'resize').
- callback: Listener
  
  The callback function to execute when the event is triggered.
- Optional options: boolean | AddEventListenerOptions
  
  Additional options for the event listener.
Returns (() => void)
- - (): void
  - Returns void
Inherited from Component.addEventListener
- Defined in src/base/Module/index.ts:261

addPlugin

addPlugin<T>(plugin): void
Adds a plugin to the component. The plugin is initialized upon being added, and the plugin's component property is set to the current component instance.
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
  
  An instance of the Plugin class to be added.
Returns void
Inherited from Component.addPlugin
- Defined in src/base/Component/index.ts:30

addResponsiveProps

addResponsiveProps(rules): void
Adds responsive property rules to the module. This must be done before initialization.
Parameters
- rules: IResponsive<ChangeableProps>
  
  The responsive property rules to be added.
Returns void
Inherited from Component.addResponsiveProps
- Defined in src/base/Module/index.ts:159

addViewportCallback

addViewportCallback(target, action, data?): void
Adds a viewport callback that will be automatically removed when the module is destroyed.
Parameters
- target: keyof IViewportCallbackTypes
  
  The viewport target (e.g., width or height).
- action: (() => void)
  
  The callback function to execute when the viewport target changes.
  - - (): void
    - Returns void
- data: undefined | ISettings = {}
  
  Additional data for the callback.
Returns void
Inherited from Component.addViewportCallback
- Defined in src/base/Module/index.ts:225

changeProps

changeProps(props): void
Updates the changeable properties of the module.
Parameters
- props: Partial<ChangeableProps>
  
  The properties to be updated.
Returns void
Inherited from Component.changeProps
- Defined in src/base/Module/index.ts:174

destroy

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

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

init

init(): void
Initializes the module. Calls the internal _init method and marks the module as initialized.

Returns void
Inherited from Component.init
- Defined in src/base/Module/index.ts:194

resize

resize(): void
Resizes the section and recalculates the scroll progress.

Returns void
- Defined in src/components/SectionScrollProgress/index.ts:237

Class SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>

Link

Link

Type Parameters

StaticProps extends NScrollSectionProgress.IStaticProps = NScrollSectionProgress.IStaticProps

ChangeableProps extends NScrollSectionProgress.IChangeableProps = NScrollSectionProgress.IChangeableProps

CallbacksTypes extends NScrollSectionProgress.ICallbacksTypes = NScrollSectionProgress.ICallbacksTypes

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NScrollSectionProgress.IStaticProps = NScrollSectionProgress.IStaticProps

ChangeableProps extends NScrollSectionProgress.IChangeableProps = NScrollSectionProgress.IChangeableProps

CallbacksTypes extends NScrollSectionProgress.ICallbacksTypes = NScrollSectionProgress.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>

Accessors

callbacks

Returns Callbacks<CallbacksTypes>

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

progressGlobal

Returns number

Parameters

value: number

Returns void

progressIn

Returns number

progressMove

Returns number

progressOut

Returns number

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

scopeGlobal

Returns [number, number]

scopeIn

Returns [number, number]

scopeMove

Returns [number, number]

scopeOut

Returns [number, number]

scrollContainer

Returns Element | Window | CustomScroll<NCustomScroll.IStaticProps, NCustomScroll.IChangeableProps, NCustomScroll.ICallbacksTypes>

section

Returns Element

Methods

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

addEventListener

Type Parameters

Target extends keyof HTMLElementEventMap

Listener extends ((event) => void)

Parameters

element: Document | Element | Window

target: Target

callback: Listener

Optional options: boolean | AddEventListenerOptions

Returns (() => void)

Returns void

addPlugin

Type Parameters

`Optional` initialProps: StaticProps & ChangeableProps

`Optional` options: boolean | AddEventListenerOptions