API Docs for: 2.10.19
Show:

oreesh-overlay Class

Defined in: src/elements/oreesh-overlay/oreesh-overlay.html:2
Module: oreesh

An overlay container.

// Can be created dynamically
var overlay = new OreeshOverlay();


<!-- Or via HTML -->
<!-- A default overlay, which is visible by default -->
<oreesh-overlay>
    <div>
        stuff stuff stuff
    </div>
</oreesh-overlay>

<!-- There are attirbutes to control opacity color/intesity and shadow -->
<oreesh-overlay opacity="high">
    <div class="oreesh-overlay-shadow-target">
        stuff stuff stuff
    </div>
</oreesh-overlay>

Methods

close

()

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:56

Closes the overlay, removing it from the screen.

open

()

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:51

Opens the overlay, making it appear on the screen.

Attributes

absolute

Boolean

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:45

Change the position style to absolute in content element.

no-animate

Boolean

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:32

Enables fade-in and fade-out animations for the overlay.

no-shadow

Boolean

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:26

Removes shadow styling to the overlay. To have styling one div inside the oreesh-overlay must have the class oreesh-overlay-shadow-target; the shadow will be applied to that div.

opacity

Boolean

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:38

Sets the opacity value. Options are low, high, or none.

Default: `low`

z-index-backdrop

Number

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:67

Custom z-index style for backdrop area.

z-index-content

Number

Defined in src/elements/oreesh-overlay/oreesh-overlay.html:61

Custom z-index style for content area.