Class ScrollView<StaticProps, ChangeableProps, CallbacksTypes>

ScrollView detects when elements enter or leave the viewport. It uses the IntersectionObserver API for efficient detection and triggers events when elements are visible or hidden. Supports adding custom delay and class toggling when elements are in view.

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- ScrollView

Index

Constructors

constructor

Accessors

callbacks elements isDestroyed isFirstStart isInitialized name prefix props

Methods

addCallback addElement addEventListener addPlugin addResponsiveProps addViewportCallback changeProps destroy init removeElement removeElements resize

Constructors

constructor

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

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

elements

get elements(): NScrollView.IElement[]
Returns the elements being observed by the ScrollView.

Returns NScrollView.IElement[]
- Defined in src/components/ScrollView/index.ts:73

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

isFirstStart

get isFirstStart(): boolean
Returns whether this is the first start of observing elements.

Returns boolean
- Defined in src/components/ScrollView/index.ts:61

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

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

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

addElement

addElement(elementProp): IRemovable
Adds an element to the observer list and starts tracking its visibility in the viewport.
Parameters
- elementProp: Element
Returns IRemovable
- Defined in src/components/ScrollView/index.ts:326

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

removeElement

removeElement(elementProp): void
Stops observing an element and removes it from the observer list.
Parameters
- elementProp: Element
  
  The element to stop observing.
Returns void
- Defined in src/components/ScrollView/index.ts:350

removeElements

removeElements(): void
Stops observing all elements and clears the observer list.

Returns void
- Defined in src/components/ScrollView/index.ts:363

resize

resize(): void
Triggers a resize event to update the ScrollView tracking of elements.

Returns void
- Defined in src/components/ScrollView/index.ts:124

Class ScrollView<StaticProps, ChangeableProps, CallbacksTypes>

Link

Link

Type Parameters

StaticProps extends NScrollView.IStaticProps = NScrollView.IStaticProps

ChangeableProps extends NScrollView.IChangeableProps = NScrollView.IChangeableProps

CallbacksTypes extends NScrollView.ICallbacksTypes = NScrollView.ICallbacksTypes

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NScrollView.IStaticProps = NScrollView.IStaticProps

ChangeableProps extends NScrollView.IChangeableProps = NScrollView.IChangeableProps

CallbacksTypes extends NScrollView.ICallbacksTypes = NScrollView.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns ScrollView<StaticProps, ChangeableProps, CallbacksTypes>

Accessors

callbacks

Returns Callbacks<CallbacksTypes>

elements

Returns NScrollView.IElement[]

isDestroyed

Returns boolean

isFirstStart

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

Methods

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

addElement

Parameters

elementProp: Element

Returns IRemovable

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

T extends Plugin<any, any, any, any>

Parameters

plugin: T

Returns void

addResponsiveProps

Parameters

rules: IResponsive<ChangeableProps>

Returns void

addViewportCallback

Parameters

target: keyof IViewportCallbackTypes

action: (() => void)

Returns void

data: undefined | ISettings = {}

Returns void

`Optional` initialProps: StaticProps & ChangeableProps

`Optional` options: boolean | AddEventListenerOptions