aws-northstar/esm/components/Modal/index.d.ts

NorthStar Design System

/** *******************************************************************************************************************
  Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
  
  Licensed under the Apache License, Version 2.0 (the "License").
  You may not use this file except in compliance with the License.
  You may obtain a copy of the License at
  
      http://www.apache.org/licenses/LICENSE-2.0
  
  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.                                                                              *
 ******************************************************************************************************************** */
import { FunctionComponent, ReactNode } from 'react';
export interface ModalProps {
    /** Whether the modal should be displayed */
    visible?: boolean;
    /** The title to display */
    title: string;
    /** The subtitle to display */
    subtitle?: string;
    /** The content of the modal */
    children: ReactNode;
    /** A footer to display */
    footer?: ReactNode;
    /** Callback for when the user dismisses the modal */
    onClose?: Function;
    /** the width of the modal */
    width?: string;
}
/** A modal is a pop-up dialog that can be used to prompt a user for confirmation. */
declare const Modal: FunctionComponent<ModalProps>;
export default Modal;