KScrolltop
is a Keen's custom plugin defined in [root]/theme/default/src/theme/framework/components/base/scrolltop/scrolltop.js
.
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
|
||
speed |
number |
Speed of scroll to the top page
|
||
toggleClass |
number |
Set the toggle class to
|
Method | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
setDefaults(options) |
Set default options
|
||||||||||||
on(name, handler) |
Register event
|
||||||||||||
one(name, handler) |
Register event to be run once
|