Class SmoothScrollKeyboardPlugin<StaticProps, ChangeableProps, CallbacksTypes>

Add keyboard navigation

Type Parameters

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

Hierarchy

Plugin<StaticProps, ChangeableProps, CallbacksTypes, SmoothScroll>
- SmoothScrollKeyboardPlugin

Constructors

constructor

new SmoothScrollKeyboardPlugin<StaticProps, ChangeableProps, CallbacksTypes>(initialProps?): SmoothScrollKeyboardPlugin<StaticProps, ChangeableProps, CallbacksTypes>
Type Parameters
- StaticProps extends NSmoothScrollKeyboardPlugin.IStaticProps = NSmoothScrollKeyboardPlugin.IStaticProps
- ChangeableProps extends NSmoothScrollKeyboardPlugin.IChangeableProps = NSmoothScrollKeyboardPlugin.IChangeableProps
- CallbacksTypes extends NSmoothScrollKeyboardPlugin.ICallbacksTypes = NSmoothScrollKeyboardPlugin.ICallbacksTypes
Parameters
- Optional initialProps: StaticProps & ChangeableProps
Returns SmoothScrollKeyboardPlugin<StaticProps, ChangeableProps, CallbacksTypes>
Inherited from Plugin.constructor
- Defined in src/base/Plugin/index.ts:15

Properties

`Protected` `Optional` _tabDebounceTimeout

_tabDebounceTimeout?: Timeout

Accessors

app

get app(): Application
Vevet Application

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

callbacks

get callbacks(): Callbacks<CallbacksTypes>
Module Callbacks

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

component

get component(): Component
Returns Component
Inherited from Plugin.component
- Defined in src/base/Plugin/index.ts:21
set component(value): void
Parameters
- value: Component
Returns void
Inherited from Plugin.component
- Defined in src/base/Plugin/index.ts:25

isDestroyed

get isDestroyed(): boolean
The module is destroyed

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

isInitialized

get isInitialized(): boolean
The module is initialized

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

name

get name(): string
Module name

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

prefix

get prefix(): string
Module prefix

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

props

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

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

Methods

`Protected` _canIgnoreKeyboardEvents

_canIgnoreKeyboardEvents(): boolean
Check if keyboard events may be ignored

Returns boolean
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:43

`Protected` _checkIsEndOfScroll

_checkIsEndOfScroll(): boolean
Check if scroll ended

Returns boolean
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:68

`Protected` _checkScrollContainerInViewport

_checkScrollContainerInViewport(): boolean
Check if scroll container is in viewport

Returns boolean
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:54

`Protected` _destroy

_destroy(): void
Destroy the plugin

Returns void
Overrides Plugin._destroy
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:197

`Protected` _getDefaultProps

_getDefaultProps(): DeepRequired<StaticProps & ChangeableProps> & {
iterator: number;
}
Get Default properties (should be extended)

Returns DeepRequired<StaticProps & ChangeableProps> & {
iterator: number;
}
Overrides Plugin._getDefaultProps
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:24

`Protected` _handleKeydown

_handleKeydown(event): void
Event on keydown
Parameters
- event: KeyboardEvent
Returns void
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:78

`Protected` _handleTab

_handleTab(): void
Handle Tab key

Returns void
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:162

`Protected` _init

_init(): void
Initialize the class

Returns void
Overrides Plugin._init
- Defined in src/components/SmoothScrollKeyboardPlugin/index.ts:34

`Protected` _onPropsMutate

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

Returns void
Inherited from Plugin._onPropsMutate
- Defined in src/base/Module/index.ts:197

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 Plugin.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 Plugin.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 Plugin.addEventListener
- Defined in src/base/Module/index.ts:254

addResponsiveProps

addResponsiveProps(rules): void
Add responsive rules
Parameters
- rules: IResponsive<ChangeableProps>
Returns void
Inherited from Plugin.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 Plugin.addViewportCallback
- Defined in src/base/Module/index.ts:231

changeProps

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

`Protected` className

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

destroy

destroy(): void
Destroy the module

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

init

init(): void
Initializes the class

Returns void
Inherited from Plugin.init
- Defined in src/base/Plugin/index.ts:29

`Protected` toggleClassName

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

Class SmoothScrollKeyboardPlugin<StaticProps, ChangeableProps, CallbacksTypes>

Type Parameters

StaticProps extends NSmoothScrollKeyboardPlugin.IStaticProps = NSmoothScrollKeyboardPlugin.IStaticProps

ChangeableProps extends NSmoothScrollKeyboardPlugin.IChangeableProps = NSmoothScrollKeyboardPlugin.IChangeableProps

CallbacksTypes extends NSmoothScrollKeyboardPlugin.ICallbacksTypes = NSmoothScrollKeyboardPlugin.ICallbacksTypes

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

StaticProps extends NSmoothScrollKeyboardPlugin.IStaticProps = NSmoothScrollKeyboardPlugin.IStaticProps

ChangeableProps extends NSmoothScrollKeyboardPlugin.IChangeableProps = NSmoothScrollKeyboardPlugin.IChangeableProps

CallbacksTypes extends NSmoothScrollKeyboardPlugin.ICallbacksTypes = NSmoothScrollKeyboardPlugin.ICallbacksTypes

Parameters

Optional initialProps: StaticProps & ChangeableProps

Returns SmoothScrollKeyboardPlugin<StaticProps, ChangeableProps, CallbacksTypes>

Properties

Protected Optional _tabDebounceTimeout

Accessors

app

Returns Application

callbacks

Returns Callbacks<CallbacksTypes>

component

Returns Component

Parameters

value: Component

Returns void

isDestroyed

Returns boolean

isInitialized

Returns boolean

name

Returns string

prefix

Returns string

props

Returns TRequiredModuleProp<StaticProps & ChangeableProps>

Methods

Protected _canIgnoreKeyboardEvents

Returns boolean

Protected _checkIsEndOfScroll

Returns boolean

Protected _checkScrollContainerInViewport

Returns boolean

Protected _destroy

Returns void

Protected _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & { iterator: number; }

Protected _handleKeydown

Parameters

event: KeyboardEvent

Returns void

Protected _handleTab

Returns void

Protected _init

Returns void

Protected _onPropsMutate

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

`Optional` initialProps: StaticProps & ChangeableProps

`Protected` `Optional` _tabDebounceTimeout

`Protected` _canIgnoreKeyboardEvents

`Protected` _checkIsEndOfScroll

`Protected` _checkScrollContainerInViewport

`Protected` _destroy

`Protected` _getDefaultProps

Returns DeepRequired<StaticProps & ChangeableProps> & {
iterator: number;
}

`Protected` _handleKeydown

`Protected` _handleTab

`Protected` _init

`Protected` _onPropsMutate

`Protected` addDestroyableAction

`Optional` options: IAddEventListenerOptions

`Protected` className

`Rest` ...classNames: string[]

`Protected` toggleClassName