cogA button for scrolling back to top, adapted to Flamingo theme and customizable
TypeXAR
CategoryOther
Developed by

Kebir Yacine, slauriere

Active Installs4
Rating
1 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

Back To Top provides a button for scrolling back to the top. It uses the following Flamingo theme colors

  • @navbar-default-bg for the button background
  • @navbar-default-link-color for the arrow and tooltip color

By default, the extension is applied to all pages in the wiki. 

Changing the text for now requires editing the variable text in the JavaScriptExtension.

If you need to apply the extension to one document only, edit the SSX and JSX objects in page BackToTop.Code and update their property "Use this extension" to "On demand only". Then, the SSX and the JSX should be called on demand the target page as follows:

#set ($discard = $xwiki.ssx.use("BackToTop.Code"))
#set ($discard = $xwiki.jsx.use("BackToTop.Code"))

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.3

  • The extension is now available from the XWiki Maven repository.
  • The code was simplified and reformatted.

v1.2

  • WCAG improvements: show hint on focus in addition to hover, add button label for screen readers

v1.1

  • A possibility for the extension to work on others versions less than 6.4M2 without adaptation with the flamingo color theme.
    

Get Connected