@clayui/shared/lib/Overlay.d.ts

ClayShared component

/**
 * SPDX-FileCopyrightText: © 2022 Liferay, Inc. <https://liferay.com>
 * SPDX-License-Identifier: BSD-3-Clause
 */
import React from 'react';
declare type Props = {
    children: React.ReactElement;
    inert?: boolean;
    isCloseOnInteractOutside?: boolean;
    isKeyboardDismiss?: boolean;
    isModal?: boolean;
    isOpen: boolean;
    menuClassName?: string;
    menuRef: React.RefObject<HTMLElement>;
    onClose: (action: 'escape' | 'blur') => void;
    portalRef?: React.RefObject<HTMLElement>;
    suppress?: Array<React.RefObject<HTMLElement>>;
    triggerRef: React.RefObject<HTMLElement>;
};
/**
 * Overlay component is used for components like dialog and modal.
 * For example, Autocomplete, DatePicker, ColorPicker, DropDown are components
 * that can use and have the same consistent behavior.
 */
export declare function Overlay({ children, inert, isCloseOnInteractOutside, isKeyboardDismiss, isModal, isOpen, menuClassName, menuRef, onClose, portalRef, suppress, triggerRef, }: Props): JSX.Element;
export {};