@nutui/nutui-react
Version:
京东风格的轻量级移动端 React 组件库,支持一套代码生成 H5 和小程序
98 lines (97 loc) • 1.97 kB
TypeScript
import { default as React, FunctionComponent, MouseEvent, ReactNode } from 'react';
import { OverlayProps } from '../overlay/overlay';
type Teleport = HTMLElement | (() => HTMLElement) | null;
export interface PopupProps extends OverlayProps {
/**
* 弹出位置
* @default center
*/
position: string
/**
* 动画名
* @default -
*/
transition: string
/**
* 自定义遮罩样式
* @default -
*/
overlayStyle: React.CSSProperties
/**
* 自定义遮罩类名
* @default -
*/
overlayClassName: string
/**
* 是否显示关闭按钮
* @default false
*/
closeable: boolean
/**
* 关闭按钮位置
* @default top-right
*/
closeIconPosition: string
/**
* 自定义 Icon
* @default close
*/
closeIcon: ReactNode
/**
* 标题左侧部分
* @default -
*/
left: ReactNode
/**
* 标题中间部分
* @default -
*/
title: ReactNode
/**
* 子标题/描述部分
* @default -
*/
description: ReactNode
/**
* 组件不可见时,卸载内容
* @default false
*/
destroyOnClose: boolean
/**
* 指定节点挂载
* @default null
*/
portal: Teleport
/**
* 是否显示遮罩
* @default true
*/
overlay: boolean
/**
* 是否显示圆角
* @default false
*/
round: boolean
/**
* 打开弹框时触发
* @default -
*/
onOpen: () => void
/**
* 关闭弹框时触发
* @default -
*/
onClose: () => void
/**
* 点击遮罩触发
* @default -
*/
onOverlayClick: (e: MouseEvent) => boolean | void
/**
* 点击关闭图标时触发
* @default -
*/
onCloseIconClick: (e: MouseEvent) => boolean | void
}
export declare const Popup: FunctionComponent<Partial<PopupProps> & Omit<React.HTMLAttributes<HTMLDivElement>, 'title'>>;
export {};