From 5040233234768325ee45cc61aeaa29fbd91a20d1 Mon Sep 17 00:00:00 2001
From: neverland <chenjiahan@youzan.com>
Date: Sat, 9 Nov 2019 16:28:16 +0800
Subject: [PATCH] feat(Toast): add overlay prop (#4969)

---
 src/toast/README.md       | 2 +-
 src/toast/README.zh-CN.md | 2 +-
 src/toast/index.js        | 4 +++-
 types/toast.d.ts          | 1 +
 4 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/src/toast/README.md b/src/toast/README.md
index 09201b4e5..147d57e9c 100644
--- a/src/toast/README.md
+++ b/src/toast/README.md
@@ -143,7 +143,7 @@ Toast.resetDefaultOptions('loading');
 | message | Message | *string* | `''` | - |
 | icon | Custom icon | *string* | - | 2.0.1 |
 | iconPrefix | Icon className prefix | *string* | `van-icon` | 2.0.9 |
-| mask | Whether to show mask | *boolean* | `false` | - |
+| overlay | Whether to show overlay | *boolean* | `false` | 2.2.13 |
 | forbidClick | Whether to forbid click background | *boolean* | `false` | - |
 | closeOnClick | Whether to close after clicked | *boolean* | `false` | 2.1.5 |
 | closeOnClickOverlay | Whether to close when click overlay | *boolean* | `false` | 2.2.13 |
diff --git a/src/toast/README.zh-CN.md b/src/toast/README.zh-CN.md
index 76c416125..4d27cfd56 100644
--- a/src/toast/README.zh-CN.md
+++ b/src/toast/README.zh-CN.md
@@ -146,7 +146,7 @@ Toast.resetDefaultOptions('loading');
 | message | 文本内容，支持通过`\n`换行 | *string* | `''` | - | - |
 | icon | 自定义图标，支持传入图标名称或图片链接，可选值见 [Icon 组件](#/zh-CN/icon) | *string* | - | 2.0.1 |
 | iconPrefix | 图标类名前缀 | *string* | `van-icon` | 2.0.9 |
-| mask | 是否显示背景遮罩层 | *boolean* | `false` | - |
+| overlay | 是否显示背景遮罩层 | *boolean* | `false` | 2.2.13 |
 | forbidClick | 是否禁止背景点击 | *boolean* | `false` | - |
 | closeOnClick | 是否在点击后关闭 | *boolean* | `false` | 2.1.5 |
 | closeOnClickOverlay | 是否在点击遮罩层后关闭 | *boolean* | `false` | 2.2.13 |
diff --git a/src/toast/index.js b/src/toast/index.js
index f9e5453d1..4e3d3c762 100644
--- a/src/toast/index.js
+++ b/src/toast/index.js
@@ -5,10 +5,12 @@ import { isObj, isServer } from '../utils';
 const defaultOptions = {
   icon: '',
   type: 'text',
+  // @deprecated
   mask: false,
   value: true,
   message: '',
   className: '',
+  overlay: false,
   onClose: null,
   onOpened: null,
   duration: 2000,
@@ -65,7 +67,7 @@ function createInstance() {
 function transformOptions(options) {
   return {
     ...options,
-    overlay: options.mask,
+    overlay: options.mask || options.overlay,
     mask: undefined,
     duration: undefined
   };
diff --git a/types/toast.d.ts b/types/toast.d.ts
index 3a9172d0c..73517265c 100644
--- a/types/toast.d.ts
+++ b/types/toast.d.ts
@@ -10,6 +10,7 @@ export type ToastOptions = {
   message?: ToastMessage;
   onClose?: () => void;
   onOpened?: () => void;
+  overlay?: boolean;
   duration?: number;
   position?: string;
   className?: any;