Scrolltop simple scroll to top button
Users
Karina Clark
Marketing Manager
Olivia Bold
Software Engineer
Ana Clark
UI/UX Designer
Nick Pitola
Art Director
Edward Kulnic
System Administrator
Customers
Company Rbranding
UI Design
Company Re-branding
Web Development
Business Analytics App
Administration
EcoLeaf App Launch
Marketing
Tower Group Website
Google Adwords
Projects
Si-Fi Project by AU Themes
#45670
Shopix Mobile App Planning
#45690
Finance Monitoring SAAS Discussion
#21090
Dashboard Analitics Launch
#34560
Recently Searched:
BoomApp by Keenthemes
#45789
"Kept API Project Meeting
#84050
"KPI Monitoring App Launch
#84250
Project Reference FAQ
#67945
"FitPro App Development
#84250
Shopix Mobile App
#45690
"Landing UI Design" Launch
#24005
No result found
Please try again with a different query
Notifications 24 reports
Project Alice
Phase 1 development
HR Confidential
Confidential staff documents
Company HR
Corporeate staff profiles
Project Jet
New frontend admin theme
Project Breafing
Product launch status update
Banner Assets
Collection of banner images
Icon Assets
Collection of SVG icons
200 OK
New order
Just now
500 ERR
New customer
2 hrs
200 OK
Payment process
5 hrs
300 WRN
Search query
2 days
200 OK
API connection
1 week
200 OK
Database restore
Mar 5
300 WRN
System update
May 15
300 WRN
Server OS update
Apr 3
300 WRN
API rollback
Jun 30
500 ERR
Refund process
Jul 10
500 ERR
Withdrawal process
Sep 10
500 ERR
Mail tasks
Dec 10
Max Smith
Pro
max@kt.com
Overview
ScrollTop is an exclusive component of
Jet that provides a simple build-in solution for a scroll to top button implementation. All CSS and JS requirements are bundled globally by default.
Usage
ScrollTop's script bundles are globally included in all pages.
<link href="assets/css/style.bundle.css" rel="stylesheet" type="text/css"/>
<script src="assets/js/scripts.bundle.js"></script>
Initialization
- ScrollTop's CSS and Javascript files are globally initialized and added into our script bundle.
- Add
.scrolltopcss class anddata-kt-scrolltop="true"to a HTML element to enable it. - ScrollTop instances can also be controlled programmatically. See below for more info.
Basic Example
Add
.scrolltopcss class
data-kt-scrolltop="true"to any element element to enable it. However, it's best to be used with an icon as the child element.The
.scrolltopcss class adds all necessary styling to the scrolltop element. Adding additional Bootstrap classes to scrolltop will also work accordingly to override the default css styling.The ScrollTop component demo can be found at the lower right corner of the browser or click the button below to scroll to the top.
Click herefor more info on the options.Tip: To add scroll top functionality to a stand-alone button or any other HTML element, add
data-kt-scrolltop="true"only.Scroll to top
<!--begin::Scrolltop button-->
<div id="kt_docs_example_basic" class="btn btn-primary" data-kt-scrolltop="true">
Scroll to top
</div>
<!--end::Scrolltop button-->
Markup Reference
Scrolltop uses HTML attributes to define the scrolltop configuration. Here are the references for each below
HTML Attribute references
| Name | Type | Description |
|---|---|---|
data-kt-scrolltop
|
mandatory
|
Enables the element as a scrolltop. Accepts
trueor
falsevalues. |
data-kt-scrolltop-offset
|
optional
|
Defines the offset value in
pxbefore the ScrollTop components comes into effect when scrolling from the top of the page. The
pxstring is not required for this value. For example:
data-kt-scrolltop-offset="300". |
data-kt-scrolltop-speed
|
optional
|
Defines the scrolling speed when scrolltop is clicked. Accepts a number value in
ms. For example:
data-kt-scrolltop-speed="600"will define that it will take about 0.6 seconds to scroll to the top of the page when clicked. |
Methods
All scrolltop components are initialized automatically, however the following are ScrollTop's functionality methods for more control.
| Name | Description |
|---|---|
| Static Methods | |
getInstance(DOMElement element)
|
Get the Toggle instance created
|
| Public Methods | |
KTScrolltop(DOMElement element, Object options)
|
Constructs a new instance of
KTScrolltopclass and initializes a Drawer control:
Remove
data-kt-scrolltop="true"attribute to avoid lazy initialization. Options
offsetand
speedreplicate
data-kt-scrolltop-offsetand
data-kt-scrolltop-speedoptions functionaliy as described above. |
go
|
Triggers the ScrollTop function. If there is room to scroll to top, this will trigger scrolltop to start scrolling to the top of the page.
|
getElement
|
Returns the scrollTop element.
|
