README

The FloatingUI extension implements Floating UI library in MediaWiki.

Usage

This extension is in an early stage of development.

Parser function

{{#floatingui:reference|content}}

Loading library only

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

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

Requirements

MediaWiki 1.39 or later

Installation

You can get the extension via Git (specifying FloatingUI as the destination directory):

git clone https://github.com/StarCitizenTools/mediawiki-extensions-FloatingUI.git FloatingUI

Or download it as zip archive.

In either case, the "FloatingUI" extension should end up in the "extensions" directory of your MediaWiki installation. If you got the zip archive, you will need to put it into a directory called FloatingUI.

starcitizentools / floating-ui

Maintainers

Details