From 5634881eda3c8897a21bf3c79212b072c0ed6fba Mon Sep 17 00:00:00 2001 From: Chenjia Date: Thu, 12 Apr 2018 21:01:51 -0700 Subject: [PATCH] add docs for keyboard props on modal component #8818 (#10030) --- components/modal/index.en-US.md | 1 + components/modal/index.zh-CN.md | 1 + 2 files changed, 2 insertions(+) diff --git a/components/modal/index.en-US.md b/components/modal/index.en-US.md index d535864fc5..65c6c52acc 100644 --- a/components/modal/index.en-US.md +++ b/components/modal/index.en-US.md @@ -69,6 +69,7 @@ The properties of the object are follows: | title | Title | string\|ReactNode | - | | width | Width of the modal dialog | string\|number | 416 | | zIndex | The `z-index` of the Modal | Number | 1000 | +| keyboard | Whether support press esc to close | Boolean | true | | onCancel | Specify a function that will be called when the user clicks the Cancel button. The parameter of this function is a function whose execution should include closing the dialog. You can also just return a promise and when the promise is resolved, the modal dialog will also be closed | function | - | | onOk | Specify a function that will be called when the user clicks the OK button. The parameter of this function is a function whose execution should include closing the dialog. You can also just return a promise and when the promise is resolved, the modal dialog will also be closed | function | - | diff --git a/components/modal/index.zh-CN.md b/components/modal/index.zh-CN.md index 9662688379..115cd6eecb 100644 --- a/components/modal/index.zh-CN.md +++ b/components/modal/index.zh-CN.md @@ -36,6 +36,7 @@ title: Modal | width | 宽度 | string\|number | 520 | | wrapClassName | 对话框外层容器的类名 | string | - | | zIndex | 设置 Modal 的 `z-index` | Number | 1000 | +| keyboard | 是否支持键盘esc关闭 | boolean | true | | onCancel | 点击遮罩层或右上角叉或取消按钮的回调 | function(e) | 无 | | onOk | 点击确定回调 | function(e) | 无 |