Premium Bootstrap Admin Templates

KScrolltop is a Keen's custom plugin defined in [root]/theme/default/src/theme/framework/components/base/scrolltop/scrolltop.js.

First parameter is the id, class, or tag of the HTML element. The second parameter is for the options.

var scrollTop = new KScrolltop(id, options);

var scrollTop = new KScrolltop('k_scrolltop', {
    offset: 300,
    speed: 600,
    toggleClass: 'k-scrolltop--on'
});

var options = {
    offset: 300,
    speed: 600,
    toggleClass: 'k-scrolltop--on'
};

Field Type Description

offset

number

Bottom offset for the scroll top button icon

Sample
`offset: 300`

speed

number

Speed of scroll to the top page

Sample
`speed: 600`

toggleClass

number

Set the toggle class to body tag when the KScrolltop is scrolling.

Sample
`toggleClass: 'k-scrolltop--on'`

Method Description

setDefaults(options)

Set default options

Input Parameters
Name	Type	Description
`options`	`object`	A new options object for the menu

on(name, handler)

Register event

Input Parameters
Name	Type	Description
`name`	`string`	Unique event name
`handler`	`function`	Callback function handler for the event

one(name, handler)

Register event to be run once

Input Parameters
Name	Type	Description
`name`	`string`	Unique event name
`handler`	`function`	Callback function handler for the event

Keen Scrolltop