#### Keen - The Ultimate Multi-Demo Bootstrap Admin Theme

#### The most complete UI/UX template solution for today's web projects of any size

## Keen Scrolltop

### Overview

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

### Initialization

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

    var scrollTop = new KTScrolltop(id, options);

    var scrollTop = new KTScrolltop('kt_scrolltop', {
        offset: 300,
        speed: 600,
        toggleClass: 'kt-scrolltop--on'
    });

### Options

    var options = {
        offset: 300,
        speed: 600,
        toggleClass: 'kt-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 KTScrolltop is scrolling.
Sample
    toggleClass: 'kt-scrolltop--on'

### API Methods

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’s Key Features

Keen empowers your project with virtually limitless array of options
to create endless unique projects.

- Based On Bootstrap 4.x
- Multi-Demo Concept
- Enterprise Ready Architect
- Integrated Build Tools: Gulp, NPM, Yarn, SASS
- Full RTL Support
- Included Classic(without build tool) Version
- Enterprise Ready Core Framework
- Full SASS Support
- Re-Usable Component System
- And many more...

> We truly hope that our love and dedication to produce an incredibly powerful high level solution suits all your project needs. We will continue to deliver incredible enterprise ready solutions for Angular, React and VueJS to serve you better. We sincerely hope you enjoyed using Keen as much as we enjoyed building it.

> Sean, Keenthemes Co-Author