Input Parameters

Name Type Description
className string The class name to apply to the main element.
el HTMLElement The element to render the overlay to.
isDark boolean True to create a dark overlay.

Overlay Interface

Name Type/Description
get() Returns the fabric component.

Fabric Overlay Interface

Name Type/Description
overlayElement The overlay element.
hide() Hides the overlay.
remove() Removes the overlay.
show() Shows the overlay.


var $REST = require("gd-sprest-js");

// Create the overlay
var el = document.querySelector("#overlay");
$REST.JS.Fabric.Overlay({ el: el });


import { Fabric } from "gd-sprest-js";

// Create the overlay
let el = document.querySelector("#overlay");
Fabric.Overlay({ el });