0.0.1 • Published 4 years ago

@uninge-test/u3 v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

react-fantasy-modal

Powerful modal dialog component for React.

Table of Contents

Installation

$ npm i react-fantasy-modal

# or 

$ yarn add react-fantasy-modal

Usage

import React from 'react';
import Modal from 'react-fantasy-modal';
import 'react-fantasy-modal/dist/index.css';
function onHandleMove(e) {
  console.log(e, '--->>> onHandleMove');
}
function onHandleResize(e) {
  console.log(e, '--->>> onHandleResize');
}


function onHandleOk() {
    console.log('onOk callback')
}

function onHandleCancel() {
  console.log('onCancel callback')
}


<Modal
  visible
  keyboard
  draggable
  resizable

  title="Hello Modal"
  cancelText={"自定义取消文字"}
  okText={"自定义确定文字"}

  onMove={onHandleMove}
  onResize={onHandleResize}
  onCancel={onHandleCancel}
  onOk={onHandleOk}
  onStageChange={console.log}
>
  Hello Modal!
</Modal>

API documentation

属性说明类型默认值
appendContainer设置 Modal 的 z-indexnumber-
visible对话框是否可见boolean-
theme皮肤(内置dark可选)string-
keyboard是否支持键盘事件(关闭、移动、缩放、最大最小化)boolean-
mask是否展示遮罩booleantrue
maskStyle遮罩样式CSSProperties-
maskClassName遮罩classstring-
maskClosable点击蒙层是否允许关闭booleantrue
shouldUpdateOnDrag拖拽过程是否允许视图元素更新booleanfalse
stage对话框展示状态,默认(DEFAULT)、最大化(FULLSCREEN)、最小化(MINIMIZED)stringDEFAULT
onCancel点击遮罩层或右上角叉或取消按钮的回调function(e)-
onOk点击确定回调function(e)-
draggable对话框是否可拖拽(只支持标题部分拖拽)booleantrue
resizable对话框是否可缩放booleantrue
stageChangeByDoubleClick对话框是否可通过双击改变状态booleantrue
onMove拖动对话框的回调function(e)-
onResize缩放对话框的回调function(e)-
onStageChange对话框状态改变的回调function(e)-
style可用于设置对话框样式,调位置等CSSProperties-
className对话框容器的类名string-
width对话框宽度(受控属性,缩放将无效)number-
height对话框高度(受控属性,缩放将无效)number-
top对话框距离顶部位置(受控属性,垂直拖动将无效)number-
left对话框距离左侧位置(受控属性,水平拖动将无效)number-
initialWidth对话框初始宽度number-
initialHeight对话框初始高度number-
initialTop对话框初始距离顶部位置number-
initialLeft对话框初始距离左侧位置number-
minWidth对话框最小宽度number256
minHeight对话框最小高度number256
zIndex设置 Modal 的 z-indexnumber1000
title标题ReactNode-
titleBarClassName对话框标题容器的类名string-
minimizeButton自定义最小化图标ReactNode-
maximizeButton自定义最大化图标ReactNode-
restoreButton自定义复原图标ReactNode-
closeButton自定义关闭图标ReactNode-
contentClassName对话框内容容器类名string-
footerClassName对话框底部容器类名string-
showCancel取消按钮是否可见booleantrue
showOk确定按钮是否可见booleantrue
cancelText取消按钮文字ReactNode取消
okText确认按钮文字ReactNode确定

Demos

@todo

TODOS

  • more themes
  • Testing