Extension:FloatingUI

MediaWiki extensions manual

FloatingUI Release status: beta
Implementation	Parser function
Description	implements the FloatingUI Javascript library
Author(s)	alistair3149
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.39+
Composer	starcitizentools/floating-ui
License	GNU General Public License 3.0 or later
Download	GitHub: project page git repository URL [help ] commit history Note: No localisation updates are provided by translatewiki.net .
Hooks used ParserFirstCallInit

The FloatingUI extension implements the FloatingUI Javascript library.

Installation

• Download and place the file(s) in a directory called FloatingUI in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php file:

  wfLoadExtension( 'FloatingUI' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Usage

Parser function

{{#floatingui:reference|content}}

Loading library

There are several ways to load the library on a given page. Once the library is loaded, it can be accessed through window.FloatingUIDOM in Javascript.

To attach the library to a wikipage, put the following wikitext onto the page:

{{#floatingui:}}

Or alternatively, you can load the ResourceLoader module in Javascript:

mw.loader.load( 'ext.floatingUI.lib' );

Defining elements

1. Reference element has to have the HTML class ext-floatingui-reference.
2. Floating element has to have the HTML class ext-floatingui-content and place next to the reference element.