Module: Overlay

An overlay component.

Parameters:

Name Type Description

props

object

The props for the component template.

Properties

Name	Type	Description
`animationDelay`	number	Delay before the animation starts.
`children`	JSX.Element	React element children.
`customAttributes`	object	Any custom attributes.
`customClasses`	string \| Array \| object	An array of additional classes.
`hasConfirm`	boolean	Whether the overlay has a confirm button.
`i18n`	object	i18n strings.
`ignoreOutsideClickClasses`	Array	Array of selectors to ignore outside click.
`isOpen`	boolean	Whether the overlay is open.
`onCancel`	function	Callback function when the overlay is canceled.
`onClose`	function	Callback function when the overlay is closed.
`onCloseAfterAnimation`	function	Callback function when the overlay is closed after animation.
`onConfirm`	function	Callback function when the overlay is confirmed.
`onOpen`	function	Callback function when the overlay is opened.
`onOpenAfterAnimation`	function	Callback function when the overlay is opened after animation.
`placement`	string	Placement of the overlay.
`position`	string	Position of the overlay.
`verticalOffset`	number	Vertical offset of the overlay.
`width`	string	Width of the overlay.
`zIndex`	number	Z-index of the overlay.

ref

object | null

Ref to the component.

Since: 5.6.0
Source: modules/Overlay/index.js, line 9

Returns:

The overlay component.

Type:: JSX.Element

Example

import Overlay from '@gravityforms/components/react/admin/modules/Overlay';

return (
    <Overlay>
        <div>Overlay Content</div>
    </Overlay>
);