UNPKG

@neo4j-ndl/react

Version:

React implementation of Neo4j Design System

43 lines (42 loc) 1.94 kB
/** * * Copyright (c) "Neo4j" * Neo4j Sweden AB [http://neo4j.com] * * This file is part of Neo4j. * * Neo4j is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * 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 General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ import React from 'react'; import { type CommonProps, type HtmlAttributes } from '../_common/types'; export declare enum ModalCloseReason { BACKDROP_CLICK = "backdropClick", ESCAPE_KEY_DOWN = "escapeKeyDown" } export interface ModalProps { /** Whether the Modal is open. */ isOpen: boolean; /** Content to render inside the Modal. */ children: React.ReactNode; /** Sets the size(max-width) of the Modal, use 'unset' for custom sizing. */ size?: 'small' | 'medium' | 'large' | 'unset'; /** The container where the modal will be rendered. */ container?: Element; /** Callback function called when the modal is closed. */ onClose?: (e: React.MouseEvent<HTMLElement> | React.KeyboardEvent<HTMLElement>, reason?: ModalCloseReason) => void; /** Forwards the props to the modal container's wrapper - use with caution */ rootProps?: HtmlAttributes<'div'>; } export declare const Modal: ({ isOpen: open, size, onClose, children, container, rootProps, style, className, htmlAttributes, ref, ...restProps }: CommonProps<"div", ModalProps>) => import("react/jsx-runtime").JSX.Element | null; //# sourceMappingURL=Modal.d.ts.map