docs(Button): 更新按钮点击事件类型

79E · Dec 8, 2022 · 94d9470 · 94d9470
1 parent 40af2de
commit 94d9470
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/guide/contribution.md b/docs/guide/contribution.md
@@ -109,9 +109,9 @@ color?: String;
  * @desc 用户点击按钮后触发此方法
  * @default ''
  * @param event React.MouseEvent<HTMLButtonElement, MouseEvent>
- * @return void | Promise<void>
+ * @return void
  */
-onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | Promise<void>;
+onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
 ```
 
 总结：就是让用户用的明明白白，一眼就知道怎么使用。

diff --git a/src/components/button/README.md b/src/components/button/README.md
@@ -79,7 +79,7 @@ import { Button } from "aunt";
 
 | 事件名  | 说明           | 类型                                                                                | 默认值 |
 | ------- | -------------- | ----------------------------------------------------------------------------------- | ------ |
-| onClick | 点击图标时触发 | `(event:React.MouseEvent<HTMLButtonElement, MouseEvent>) => void \| Promise<void> ` | `-`    |
+| onClick | 点击图标时触发 | `(event:React.MouseEvent<HTMLButtonElement, MouseEvent>) => void ` | `-`    |
 
 ## 样式变量
 

diff --git a/src/components/button/types.ts b/src/components/button/types.ts
@@ -96,5 +96,5 @@ export interface ButtonProps extends BaseTypeProps {
    * @param event React.MouseEvent<HTMLButtonElement, MouseEvent>
    * @return void | Promise<void>
    */
-  onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | Promise<void>;
+  onClick?: (event: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void;
 }