Class ScrollBar<StaticProps, ChangeableProps, CallbacksTypes>

Create custom scroll bar

Type Parameters

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

Hierarchy

Component<StaticProps, ChangeableProps, CallbacksTypes>
- ScrollBar

Index

Constructors

constructor

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

Properties

`Protected` _container

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

Scroll container

`Protected` _xBar

_xBar: default

Horizontal scrollbar

`Protected` _yBar

_yBar: default

Vertical scrollbar

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

container

get container(): 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/ScrollBar/index.ts:43

domParent

get domParent(): Element
The element where scrollbars will be appended

Returns Element
- Defined in src/components/ScrollBar/index.ts:65

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
Overrides ComponentClass.prefix
- Defined in src/components/ScrollBar/index.ts:35

props

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

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

scrollableElement

get scrollableElement(): Element
Scrollable element

Returns Element
- Defined in src/components/ScrollBar/index.ts:48

Methods

`Protected` _destroy

_destroy(): void
Destroy the module

Returns void
Overrides Component._destroy
- Defined in src/components/ScrollBar/index.ts:187

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
    canAutoHide: boolean;
    container: Window & typeof globalThis;
    domParent: boolean;
    isDraggable: boolean;
    minSize: number;
    resizeDebounce: number;
    scrollBehavior: string;
    shouldAutoSize: boolean;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
    canAutoHide: boolean;
    container: Window & typeof globalThis;
    domParent: boolean;
    isDraggable: boolean;
    minSize: number;
    resizeDebounce: number;
    scrollBehavior: string;
    shouldAutoSize: boolean;
}
Overrides Component._getDefaultProps
- Defined in src/components/ScrollBar/index.ts:21

`Protected` _init

_init(): void
Inner extra initialization

Returns void
Overrides Component._init
- Defined in src/components/ScrollBar/index.ts:137

`Protected` _onPropsMutate

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

Returns void
Overrides Component._onPropsMutate
- Defined in src/components/ScrollBar/index.ts:175

`Protected` _setEvents

_setEvents(): void
Returns void
- Defined in src/components/ScrollBar/index.ts:144

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/ScrollBar/index.ts:181

`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 ScrollBar<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NScrollBar.IStaticProps = NScrollBar.IStaticProps

ChangeableProps extends NScrollBar.IChangeableProps = NScrollBar.IChangeableProps

CallbacksTypes extends NScrollBar.ICallbacksTypes = NScrollBar.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NScrollBar.IStaticProps = NScrollBar.IStaticProps

ChangeableProps extends NScrollBar.IChangeableProps = NScrollBar.IChangeableProps

CallbacksTypes extends NScrollBar.ICallbacksTypes = NScrollBar.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

canInit: boolean = true

Returns ScrollBar<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected _container

Protected _xBar

Protected _yBar

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

container

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

domParent

Returns Element

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

scrollableElement

Returns Element

Methods

Protected _destroy

Returns void

Protected _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & { canAutoHide: boolean; container: Window & typeof globalThis; domParent: boolean; isDraggable: boolean; minSize: number; resizeDebounce: number; scrollBehavior: string; shouldAutoSize: boolean; }

Protected _init

Returns void

Protected _onPropsMutate

Returns void

Protected _setEvents

Returns void

addCallback

Type Parameters

T extends string | number | symbol

Parameters

target: T

action: TAction<CallbacksTypes[T]>

settings: ISettings = {}

Returns IAddedCallback

Protected addDestroyableAction

Parameters

action: (() => void)

Returns void

Returns void

addEventListener

Type Parameters

El extends ListenerElement

Target extends keyof HTMLElementEventMap

Callback extends ((evt) => void)

Parameters

el: El

target: Target

callback: Callback

Optional options: IAddEventListenerOptions

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` _container

`Protected` _xBar

`Protected` _yBar

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
canAutoHide: boolean;
container: Window & typeof globalThis;
domParent: boolean;
isDraggable: boolean;
minSize: number;
resizeDebounce: number;
scrollBehavior: string;
shouldAutoSize: boolean;
}

`Protected` _init

`Protected` _onPropsMutate

`Protected` _setEvents

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]

`Protected` toggleClassName