Skip to content

Repository files navigation

canopy-react-overlay

Creates a full page overlay modal thingy for AppStateESS/Canopy. The parent class determines its viewable status. Use the close function prop to hide it.

Install

npm install --save-dev @essappstate/canopy-react-overlay

Example

import Overlay from '@essappstate/canopy-react-overlay'
<Overlay
show={this.state.show}
close={this.toggleTheShowVariable}
width="500px"
title="My Overlay">
<p>The content goes here.</p>
</Overlay>

Props

NameTypeDesc.
closefunctionRequired. Function to run upon closing overlay
titlestringText to appear in header of overlay
widthstringWidth of content area. The default is 100% width and height. If width is set, the height will be adaptive and the content area will be place near the top of the screen.
showbooleanIf true, show the overlay. False (hidden) by default.
overflowstringBy default, the overflow is auto on the y axis and hidden on the x axis.
childrennodeThe content of the overlay.

About

Creates a full page overlay modal thingy.

Resources

Stars

0 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages