import * as React from 'react'; import type { IconButtonProps } from '../IconButton'; import type { BackyardBaseProps } from '../utils/typings/BackyardProps'; import type { BDSForwardRef } from '../utils/typings/BDSComponentProps'; import type { BackyardTheme } from '../ThemeProvider/ThemeProvider'; /** * Backyard React Modal * * Barebones modal component for styling and handling if extended * * This component contains only the styling for the modal component, not the logic for handling displaying the modal * * The children of this component should be one of the three included modal components: * * 1) `ModalHeader` (Required) - for the header of the component, * containing the label, title, and an icon if desired * * 2) `ModalBody` (Required) - for the body of the component, * containing the body text and any additional components for the modal * * 3) `ModalFooter` (Optional) - for the footer of the component, * if any controls are needed for the modal, such as a 'cancel' button, or an action button * * Example: * * } * > * Modal Heading * * * Modal Body * * * * * * * * For controlling this modal, or any other custom modal, use `ModalController` * * * * * * * )} * /> */ declare const Modal: BDSForwardRef; declare type ModalRef = HTMLDivElement; declare type ModalOverrideProps = 'size' | 'height' | 'width'; interface ModalProps extends BackyardBaseProps { /** * Children Components * Should only contain `ModalHeader`, `ModalBody`, and `ModalFooter` as children */ children: React.ReactNode; /** * DOM Class Name */ className?: string; /** * Whether or not modal is invisible to user * If the modal is invisible, all pointer events will be ignored */ invisible?: boolean; /** * Size of the modal * If the modal size is full-screen, the modal will expand to 100vw x 100vh * If the modal body content exceeds 100vh, then the body will overflow with a scrollbar */ size?: 'small' | 'medium' | 'large' | 'jumbo' | 'auto' | 'full-screen'; /** * Shape of the outer modal */ shape?: 'rounded' | 'squared'; /** * `onClick` handler for close button, when the close button is clicked * By default, does nothing, but `ModalController` will automatically add a close handle for this button */ onCloseClick?: IconButtonProps['onClick']; /** * Props to extend the close icon button with */ closeProps?: React.PropsWithRef; /** * Whether or not `Modal` has lines between `ModalHeader` and `ModalFooter` * * @default false */ noLines?: boolean; /** * Height of the Modal * * Shorthand for `style={{ height }}` */ height?: keyof BackyardTheme['sizes'] | string; /** * Width of the Modal * * Note: Overrides `size` prop * * Shorthand for `style={{ width }}` */ width?: keyof BackyardTheme['sizes'] | string; /** * Maximum Height of the Modal * * Shorthand for `style={{ maxHeight }}` */ maxHeight?: keyof BackyardTheme['sizes'] | string; /** * Maximum Width of the Modal * * Shorthand for `style={{ maxWidth }}` */ maxWidth?: keyof BackyardTheme['sizes'] | string; /** * Context to provide children */ context?: Record; } export { Modal }; export type { ModalProps, ModalRef }; export default Modal;