API
DDrawerProps
interface DDrawerProps extends React.HTMLAttributes<HTMLDivElement> {
dVisible: boolean;
dContainer?: DRefExtra | false;
dPlacement?: 'top' | 'right' | 'bottom' | 'left';
dWidth?: number | string;
dHeight?: number | string;
dZIndex?: number | string;
dMask?: boolean;
dMaskClosable?: boolean;
dEscClosable?: boolean;
dSkipFirstTransition?: boolean;
dDestroyAfterClose?: boolean;
dHeader?: React.ReactElement | string;
dFooter?: React.ReactElement;
dChildDrawer?: React.ReactElement;
onClose?: () => void;
afterVisibleChange?: (visible: boolean) => void;
}
| 属性 |
说明 |
默认值 |
版本 |
| dVisible |
抽屉是否可见,受控,默认为 false |
- |
|
| dContainer |
设置父容器,false 表示元素的 parentElement |
- |
|
| dPlacement |
设置抽屉位置 |
'right' |
|
| dWidth |
设置抽屉宽度 |
400 |
|
| dHeight |
设置抽屉高度 |
280 |
|
| dZIndex |
设置抽屉的 z-index |
- |
|
| dMask |
是否显示遮罩层 |
true |
|
| dMaskClosable |
点击遮罩层关闭抽屉 |
true |
|
| dEscClosable |
是否可通过 Esc 关闭抽屉 |
true |
|
| dSkipFirstTransition |
是否跳过第一次动画 |
true |
|
| dDestroyAfterClose |
是否关闭抽屉后销毁节点 |
true |
|
| dHeader |
设置页头 |
- |
|
| dFooter |
设置页脚 |
- |
|
| dChildDrawer |
设置嵌套抽屉 |
- |
|
| onClose |
关闭抽屉的回调 |
- |
|
| afterVisibleChange |
完成显/隐的回调 |
- |
|
interface DDrawerHeaderProps extends React.HTMLAttributes<HTMLDivElement> {
dActions?: React.ReactNode[];
dCloseProps?: DButtonProps;
onCloseClick?: () => void | boolean | Promise<boolean>;
}
| 属性 |
说明 |
默认值 |
版本 |
| dActions |
操作按钮,'close' 表示关闭按钮 |
['close'] |
|
| dCloseProps |
设置关闭按钮的 props |
- |
|
| onCloseClick |
点击关闭按钮的回调 |
- |
|
interface DDrawerFooterProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'children'> {
dAlign?: 'left' | 'center' | 'right';
dActions?: React.ReactNode[];
dCancelProps?: DButtonProps;
dOkProps?: DButtonProps;
onCancelClick?: () => void | boolean | Promise<boolean>;
onOkClick?: () => void | boolean | Promise<boolean>;
}
| 属性 |
说明 |
默认值 |
版本 |
| dAlign |
设置按钮位置 |
'right' |
|
| dActions |
操作按钮,'cancel' 表示取消按钮,'ok' 表示确认按钮 |
['cancel', 'ok'] |
|
| dCancelProps |
设置取消按钮的 props |
- |
|
| dOkProps |
设置确认按钮的 props |
- |
|
| onCancelClick |
点击取消按钮的回调,返回 false 时终止关闭窗口,支持 Promise |
- |
|
| onOkClick |
点击确认按钮的回调,返回 false 时终止关闭窗口,支持 Promise |
- |
|