Introduction

The FlareUI library is a collection of lightweight JavaScript functions designed to extend and enhance your MadCap Flare HTML5/frameless outputs. It adds features like reading time estimates, expandable tables, topic popups, and more - all without requiring you to write custom scripts from scratch.

FlareUI-initializer.jsClosed Content/Resources/Scripts/FlareUI-initializer.js

Download

You can download the latest version of the library from: FlareUI.js

The ZIP archive includes FlareUI.js, FlareUI-initializer.js, and a FlareUI-Assets folder containing images.

How it works

After downloading and extracting the ZIP archive:

  1. Copy FlareUI.js and FlareUI-initializer.js to your Content > Resources folder within a Scripts folder.

  2. Copy the FlareUI-Assets folder to the root of your Images folder. This folder contains some placeholder images you can use to test the functions in your output, but you can replace them as needed.

  3. Reference the JS files in your Template Page(s). Place your cursor at the bottom of the Template Page in the XML Editor (WYSIWYG), select Insert > Script, then choose Script Link and select FlareUI.js. Repeat the process for FlareUI-initializer.js.

    Your end result should look like this, just before the closing </body> tag:

    Copy 
    <script src="../Scripts/FlareUI.js">
    </script>
    <script src="../Scripts/FlareUI-initializer.js">
    </script>

Once everything is set up, you can call the functions you’d like in the FlareUI-initializer.js file. Some functions require CSS and/or HTML. Code snippets are provided within each topic so you can copy, paste, and modify them in your stylesheet as needed.

Note: It isn’t recommended to make updates to the FlareUI.js file, as this can cause rework if you download an updated version. However, you can update the FlareUI-initializer.js file. This way, when a new version is released, you can simply replace FlareUI.js in your Scripts folder and update the initializer file to include new functions.

Updates

The library will continue to grow with new features and refinements. Stay tuned for updates, and always download the latest version before adding new functionality.