Fandom

Wikia Developers Wiki

BackToTopButton/en

< BackToTopButton

908pages on
this wiki
Add New Page
Talk28 Share

This script adds a button to the right corner of the Oasis footer that takes you back to the top of the page when pressed.

Installation

For personal use, add the following line to your global.js page.

importScriptPage('BackToTopButton/code.js', 'dev');

For site-wide use, add the following line to your community's MediaWiki:ImportJS page.

dev:BackToTopButton/code.js

Customization

If you want to adjust the speed of the scroll up or the amount of scroll down you have to do for the button to appear and a bunch of other options, add the following lines before importing the script (for global.js) or to your community's Wikia.js page.

Button Text

The button text will be automatically shown in the user's language. However, if you wish to change the text, you can do so with the following.

window.BackToTopText = "new text";

Scroll Speed

To adjust scroll speed add this:

window.BackToTopSpeed = number;

Where number is the speed, in milliseconds. Higher numbers result in slower scrolling and smaller numbers result in faster scrolling. Default value is 600.

Button Appearance

To adjust the "depth" you have to reach for the button to appear/disappear add this:

window.BackToTopStart = number;

Where number is distance down the page, in pixels, before the button appears. Higher numbers will make you scroll down further before the button appears. Default value is 800.

Button Format

You can also format the button any way you like with CSS. For example:

/* Back-to-top Button Format */
#backtotop button{
    background: none;
    background-color: transparent;
    color: white;
    border: none;
}
#backtotop button:hover {
    text-decoration: underline;
}

The above CSS rules will make the button look like a simple link.

Disable Button's Fade In/Out Effect

To disable the fade effect add this:

window.BackToTopFade = 0;

To re-enable the effect simply remove this line from your JS page. The fade In/Out effect for the button is On by default.

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.