@stakefish/ui
Version:
<div align="center"> <a href="https://www.npmjs.com/package/@stakefish/ui"><img src="https://gateway.pinata.cloud/ipfs/QmbZL1ceA8Yiz2pKALTg919jYx141DPUGegC9L4XpyayW5" width="300" /></a> </div>
39 lines (38 loc) • 1.21 kB
TypeScript
import React from "react";
import { ModalProps as MuiModalProps } from "@mui/material/Modal";
import { IconProps } from "./Icon";
export declare type ModalSize = "xs" | "sm" | "md" | "safeArea" | "fullScreen";
export interface ModalProps extends MuiModalProps {
/**
* Value that will be used as `aria-labelledby`.
* Identifies the element (or elements) that labels the current element.
* @see aria-describedby.
*/
titleId?: string;
/**
* Value that will be used as `aria-describedby`.
* Identifies the element (or elements) that describes the object.
* @see aria-labelledby
*/
descriptionId?: string;
/**
* Width of the modal box.
*/
size?: ModalSize;
/**
* Render a close button at top-right corner.
* If `true`, a default `closeCircle` icon will be applied.
* Or changing the icon with iconKey.
*/
closeButton?: boolean | IconProps["iconKey"];
/**
* Is scrollable?
*/
scrollable?: boolean;
/**
* Make backdrop color transparent
*/
transparentBackdrop?: boolean;
}
declare const Modal: React.FC<ModalProps>;
export default Modal;