Extension:FloatingUI

MediaWiki extensions manual

FloatingUI Release status: stable
Implementation	Parser function
Description	Provides the FloatingUI JavaScript library
Author(s)	alistair3149
Latest version	1.0.5 (Continuous updates)
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.43+
Composer	starcitizentools/floating-ui
Hooks used ParserFirstCallInit
Licence	GNU General Public License 3.0 or later
Download	GitHub: project page git repository URL commit history Note: No localisation updates are provided by translatewiki.net .

The FloatingUI extension provides the FloatingUI JavaScript library to MediaWiki.

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 wiki page, put the following wikitext onto the page:

{{#floatingui:}}

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.