From 216ca56e632a7c08a93940f362f3bd8582f35fec Mon Sep 17 00:00:00 2001
From: neverland <chenjiahan@youzan.com>
Date: Sun, 22 Dec 2019 13:03:25 +0800
Subject: [PATCH] types(Checkbox): add toggle method type (#5354)

---
 src/checkbox/README.zh-CN.md |  4 ++--
 src/checkbox/index.js        |  1 +
 types/checkbox-group.d.ts    |  5 +++++
 types/checkbox.d.ts          |  5 +++++
 types/index.d.ts             | 14 ++++++++------
 5 files changed, 21 insertions(+), 8 deletions(-)
 create mode 100644 types/checkbox-group.d.ts
 create mode 100644 types/checkbox.d.ts

diff --git a/src/checkbox/README.zh-CN.md b/src/checkbox/README.zh-CN.md
index 3dad91827..fe24bdf08 100644
--- a/src/checkbox/README.zh-CN.md
+++ b/src/checkbox/README.zh-CN.md
@@ -232,7 +232,7 @@ export default {
 
 | 方法名 | 说明 | 参数 | 返回值 |
 |------|------|------|------|
-| toggleAll | 切换所有复选框的选中状态 | checked?: boolean | - |
+| toggleAll | 切换所有复选框，传`true`为选中，`false`为取消选中，不传参为取反 | checked?: boolean | - |
 
 ### Checkbox 方法
 
@@ -240,4 +240,4 @@ export default {
 
 | 方法名 | 说明 | 参数 | 返回值 |
 |------|------|------|------|
-| toggle | 切换选中状态 | checked?: boolean | - |
+| toggle | 切换选中状态，传`true`为选中，`false`为取消选中，不传参为取反 | checked?: boolean | - |
diff --git a/src/checkbox/index.js b/src/checkbox/index.js
index 1ce28b4ae..ad81fd92d 100644
--- a/src/checkbox/index.js
+++ b/src/checkbox/index.js
@@ -33,6 +33,7 @@ export default createComponent({
   },
 
   methods: {
+    // @exposed-api
     toggle(checked = !this.checked) {
       // When toggle method is called multiple times at the same time,
       // only the last call is valid.
diff --git a/types/checkbox-group.d.ts b/types/checkbox-group.d.ts
new file mode 100644
index 000000000..5a53fa574
--- /dev/null
+++ b/types/checkbox-group.d.ts
@@ -0,0 +1,5 @@
+import { VanComponent } from './component';
+
+export class CheckboxGroup extends VanComponent {
+  toggleAll(checked?: boolean): void;
+}
diff --git a/types/checkbox.d.ts b/types/checkbox.d.ts
new file mode 100644
index 000000000..dc7c54b53
--- /dev/null
+++ b/types/checkbox.d.ts
@@ -0,0 +1,5 @@
+import { VanComponent } from './component';
+
+export class Checkbox extends VanComponent {
+  toggle(checked?: boolean): void;
+}
diff --git a/types/index.d.ts b/types/index.d.ts
index 923e4eccd..6912859b0 100644
--- a/types/index.d.ts
+++ b/types/index.d.ts
@@ -2,12 +2,14 @@ import Vue from 'vue';
 import { VanComponent } from './component';
 import { AddressEdit } from './address-edit';
 import { Area } from './area';
-import { Toast } from './toast';
+import { Checkbox } from './checkbox';
+import { CheckboxGroup } from './checkbox-group';
 import { Dialog } from './dialog';
-import { Notify } from './notify';
-import { Locale } from './locale';
-import { Lazyload } from './lazyload';
 import { ImagePreview } from './image-preview';
+import { Lazyload } from './lazyload';
+import { Locale } from './locale';
+import { Notify } from './notify';
+import { Toast } from './toast';
 
 export const version: string;
 export function install(vue: typeof Vue): void;
@@ -20,8 +22,6 @@ export class CellGroup extends VanComponent {}
 export class CountDown extends VanComponent {}
 export class Divider extends VanComponent {}
 export class SwipeCell extends VanComponent {}
-export class Checkbox extends VanComponent {}
-export class CheckboxGroup extends VanComponent {}
 export class Circle extends VanComponent {}
 export class Col extends VanComponent {}
 export class Collapse extends VanComponent {}
@@ -88,6 +88,8 @@ export class Uploader extends VanComponent {}
 export {
   AddressEdit,
   Area,
+  Checkbox,
+  CheckboxGroup,
   Dialog,
   ImagePreview,
   Lazyload,