Class SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>

Trace scroll progress of a section

Type Parameters

StaticProps extends NScrollSectionProgress.IStaticProps = NScrollSectionProgress.IStaticProps
ChangeableProps extends NScrollSectionProgress.IChangeableProps = NScrollSectionProgress.IChangeableProps
CallbacksTypes extends NScrollSectionProgress.ICallbacksTypes = NScrollSectionProgress.ICallbacksTypes

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- SectionScrollProgress

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:96

Properties

`Protected` _frameThrottleIndex

_frameThrottleIndex: number

`Protected` _prevProgressGlobal

_prevProgressGlobal: number

Previous global progress

`Protected` _progressGlobal

_progressGlobal: number

Global progress

`Protected` _scopeGlobal

_scopeGlobal: [number, number]

Scrolling scope

`Protected` _scopeIn

_scopeIn: [number, number]

Scope of element appearing from bottom to top

`Protected` _scopeMove

_scopeMove: [number, number]

Scope of element moving

`Protected` _scopeOut

_scopeOut: [number, number]

Scope of element disappearing from bottom to top

`Protected` _scrollContainer

_scrollContainer: Window | Element | SmoothScroll<NSmoothScroll.IStaticProps, NSmoothScroll.IChangeableProps, NSmoothScroll.ICallbacksTypes>

Scroll container

`Protected` _section

_section: Element

Section element

Accessors

app

get app(): Application
Vevet Application

Returns Application
Inherited from ComponentClass.app
- Defined in src/base/Module/index.ts:68

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

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

isDestroyed

get isDestroyed(): boolean
The module is destroyed

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

isInitialized

get isInitialized(): boolean
The module is initialized

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

name

get name(): string
Module name

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

prefix

get prefix(): string
Module prefix

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

progressGlobal

get progressGlobal(): number
Global progress

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

progressIn

get progressIn(): number
'in' progress

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

progressMove

get progressMove(): number
'move' progress

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

progressOut

get progressOut(): number
'out' progress

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

props

get props(): TRequiredModuleProp<StaticProps & ChangeableProps>
Current properties

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

scopeGlobal

get scopeGlobal(): [number, number]
Scrolling scope

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

scopeIn

get scopeIn(): [number, number]
Scope of element appearing from bottom to top

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

scopeMove

get scopeMove(): [number, number]
Scope of element moving

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

scopeOut

get scopeOut(): [number, number]
Scope of element disappearing from bottom to top

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

scrollContainer

get scrollContainer(): Window | Element | SmoothScroll<NSmoothScroll.IStaticProps, NSmoothScroll.IChangeableProps, NSmoothScroll.ICallbacksTypes>
Scroll container

Returns Window | Element | SmoothScroll<NSmoothScroll.IStaticProps, NSmoothScroll.IChangeableProps, NSmoothScroll.ICallbacksTypes>
- Defined in src/components/SectionScrollProgress/index.ts:35

section

get section(): Element
Section element

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

Methods

`Protected` _calculateScopes

_calculateScopes(__namedParameters): void
Calculate scopes
Parameters
- __namedParameters: IGetScrollValues
Returns void
- Defined in src/components/SectionScrollProgress/index.ts:197

`Protected` _canRender

_canRender(isForce?): boolean
Check if the section can be rendered
Parameters
- isForce: boolean = false
Returns boolean
- Defined in src/components/SectionScrollProgress/index.ts:214

`Protected` _destroy

_destroy(): void
Destroy the component

Returns void
Inherited from Component._destroy
- Defined in src/base/Component/index.ts:39

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    container: Window & typeof globalThis;
    resizeTimeout: number;
    viewportTarget: string;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    container: Window & typeof globalThis;
    resizeTimeout: number;
    viewportTarget: string;
}
Overrides Component._getDefaultProps
- Defined in src/components/SectionScrollProgress/index.ts:22

`Protected` _init

_init(): void
Inner extra initialization

Returns void
Overrides Component._init
- Defined in src/components/SectionScrollProgress/index.ts:126

`Protected` _onPropsMutate

_onPropsMutate(): void
This method is called on properties change

Returns void
Overrides Component._onPropsMutate
- Defined in src/components/SectionScrollProgress/index.ts:161

`Protected` _render

_render(scrollValues, isForce?): void
Render the scene
Parameters
- scrollValues: IGetScrollValues
- isForce: boolean = false
Returns void
- Defined in src/components/SectionScrollProgress/index.ts:219

`Protected` _setEvents

_setEvents(): void
Set events

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

addCallback

addCallback<T>(target, action, settings?): IAddedCallback
Add a module callback
Type Parameters
- T extends string | number | symbol
Parameters
- target: T
- action: TAction<CallbacksTypes[T]>
- settings: ISettings = {}
Returns IAddedCallback
Inherited from Component.addCallback
- Defined in src/base/Module/index.ts:245

`Protected` addDestroyableAction

addDestroyableAction(action): void
Add destroyable actions
Parameters
- action: (() => void)
  - - (): void
    - Returns void
Returns void
Inherited from Component.addDestroyableAction
- Defined in src/base/Module/index.ts:224

addEventListener

addEventListener<El, Target, Callback>(el, target, callback, options?): IAddEventListener
Add a DOM event listener
Type Parameters
- El extends ListenerElement
- Target extends keyof HTMLElementEventMap
- Callback extends ((evt) => void)
Parameters
- el: El
- target: Target
- callback: Callback
- Optional options: IAddEventListenerOptions
Returns IAddEventListener
Inherited from Component.addEventListener
- Defined in src/base/Module/index.ts:254

addPlugin

addPlugin<T>(plugin): void
Add a single plugin
Type Parameters
- T extends Plugin<any, any, any, any>
Parameters
- plugin: T
Returns void
Inherited from Component.addPlugin
- Defined in src/base/Component/index.ts:21

addResponsiveProps

addResponsiveProps(rules): void
Add responsive rules
Parameters
- rules: IResponsive<ChangeableProps>
Returns void
Inherited from Component.addResponsiveProps
- Defined in src/base/Module/index.ts:173

addViewportCallback

addViewportCallback(target, action, data?): void
Add a viewport callback that will be removed on class destroy
Parameters
- target: keyof NViewport.ICallbacksTypes
- action: ((arg) => void)
  - - (arg): void
    - Parameters
      
      arg: IChanges
      
      Returns void
- data: undefined | ISettings = {}
Returns void
Inherited from Component.addViewportCallback
- Defined in src/base/Module/index.ts:231

changeProps

changeProps(props): void
Change module properties
Parameters
- props: Partial<ChangeableProps>
Returns void
Inherited from Component.changeProps
- Defined in src/base/Module/index.ts:184

`Protected` className

className(...classNames): string
Parameters
- Rest ...classNames: string[]
Returns string
Inherited from Component.className
- Defined in src/base/Module/index.ts:279

destroy

destroy(): void
Destroy the module

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

init

init(): void
Initializes the class

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

resize

resize(): void
Resize the scene

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

`Protected` toggleClassName

toggleClassName(element, className, isActive): void
Toggle classList
Parameters
- element: Element
- className: string
- isActive: boolean
Returns void
Inherited from Component.toggleClassName
- Defined in src/base/Module/index.ts:284

Class SectionScrollProgress<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NScrollSectionProgress.IStaticProps = NScrollSectionProgress.IStaticProps

ChangeableProps extends NScrollSectionProgress.IChangeableProps = NScrollSectionProgress.IChangeableProps

CallbacksTypes extends NScrollSectionProgress.ICallbacksTypes = NScrollSectionProgress.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

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>

Properties

Protected _frameThrottleIndex

Protected _prevProgressGlobal

Protected _progressGlobal

Protected _scopeGlobal

Protected _scopeIn

Protected _scopeMove

Protected _scopeOut

Protected _scrollContainer

Protected _section

Accessors

app

Returns Application

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 Window | Element | SmoothScroll<NSmoothScroll.IStaticProps, NSmoothScroll.IChangeableProps, NSmoothScroll.ICallbacksTypes>

section

Returns Element

Methods

Protected _calculateScopes

Parameters

__namedParameters: IGetScrollValues

Returns void

Protected _canRender

Parameters

isForce: boolean = false

Returns boolean

Protected _destroy

Returns void

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` _frameThrottleIndex

`Protected` _prevProgressGlobal

`Protected` _progressGlobal

`Protected` _scopeGlobal

`Protected` _scopeIn

`Protected` _scopeMove

`Protected` _scopeOut

`Protected` _scrollContainer

`Protected` _section

`Protected` _calculateScopes

`Protected` _canRender

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
container: Window & typeof globalThis;
resizeTimeout: number;
viewportTarget: string;
}

`Protected` _init

`Protected` _onPropsMutate

`Protected` _render

`Protected` _setEvents

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]