@atlaskit/modal-dialog
Version:
A modal dialog displays content that requires user interaction, in a layer above the page.
21 lines (20 loc) • 753 B
TypeScript
/// <reference types="react" />
import { ModalDialogProps, OnCloseHandler } from '../types';
export declare type ModalAttributes = {
/**
* Test id passed to the modal dialog.
*/
testId?: ModalDialogProps['testId'];
/**
* Id referenced by the modal dialog's `aria-labelledby` attribute.
* This id should be assigned to the modal title element.
*/
titleId: string;
/**
* Callback function called when the modal dialog is requesting to be closed,
* wrapped in modal dialog's analytic event context.
*/
onClose?: OnCloseHandler;
};
export declare const ModalContext: import("react").Context<ModalAttributes | null>;
export declare const ScrollContext: import("react").Context<boolean | null>;