Interface IStaticProps

Static properties for a component. These properties remain constant throughout the lifecycle of the component. This interface extends IStaticProps, inheriting the static properties defined for modules.

Hierarchy

Properties

__fixHelperStaticProps? animationFrame? container? elements? hasWillChange? resizeDebounce? translatePrecision? viewportTarget?

Properties

Optional __fixHelperStaticProps

__fixHelperStaticProps?: any

Optional animationFrame

animationFrame?: false | AnimationFrame<NAnimationFrame.IStaticProps, NAnimationFrame.IChangeableProps, NAnimationFrame.ICallbacksTypes>

Optional AnimationFrame instance to control scrolling animation externally.

Default

false

Optional container

container?: string | HTMLElement

Selector or HTMLElement for the scrollable container.

Default

'#v-custom-scroll'

Optional elements

elements?: string | false | HTMLElement | NodeListOf<HTMLElement> | HTMLElement[]

Defines the scrollable elements inside the wrapper. Can be a selector, a list of elements, or a single element. If set to false, no specific elements are defined.

Default

false

Optional hasWillChange

hasWillChange?: boolean

If true, the will-change CSS property will be applied to the scrollable elements to improve performance.

Default

true

Optional resizeDebounce

resizeDebounce?: number

Timeout value for the resize event, useful for debouncing resize calculations.

Default

0

Optional translatePrecision

translatePrecision?: number | false

Sets precision for the transform property by limiting the number of decimal places. Helps prevent choppy scrolling caused by large decimal values in transforms. Set to false to disable precision rounding.

Default

2

Optional viewportTarget

viewportTarget?: keyof IViewportCallbackTypes

Target for the viewport resize event.

Default

'any'

Settings

Member Visibility

Theme

On This Page