 | A button for scrolling back to top, adapted to Flamingo theme and customizable |
| Type | XAR |
| Category | Other |
| Developed by | Kebir Yacine, slauriere |
| Active Installs | 172 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Description
XWiki Back To Top plugin is a nice JavaScript extension, it's adapted to the current flamingo theme color applied to your platform, the beautiful style is made with LESS css.
Here the demo by video:
This extension is contain only one XWiki document with 2 objects:
- LESS StyleSheetExtension
- JavaScriptExtension
It's very simple to install, you may just import the XAR on your platform to make it work.
By default, the extension is applied to all platform documents, you can customize it easily:
- To apply the extension on only the view or edit mode, you change the "displaymode" to "view" or "edit" on the JavaScriptExtension.
- You can change the text by editing the variable text on the JavaScriptExtension.
- You can apply the extension for one document, in this case you edit in object the document "BackToTop.Code" and change the select "Use this extension" to "On demande only" for the StyleSheetExtension and JavaScriptExtension object, after you should call the ssx and the jsx on your page like this:
#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:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Release Notes
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.
