@craftercms/studio-ui/hooks/useOnClose.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

interface UseOnCloseProps {
  onClose?(event: any, reason: 'backdropClick' | 'escapeKeyDown'): void;
  disableBackdropClick?: boolean;
  disableEscapeKeyDown?: boolean;
}
export declare function useOnClose({
  onClose,
  disableBackdropClick,
  disableEscapeKeyDown
}: UseOnCloseProps): (event: any, reason: any) => boolean;
export default useOnClose;