type: update Wave props type (ant-design#48092)

* fix: fix the Wave not disappear when motion === false

* docs: update docs

* type: update type

* type: update type

* docs: revert

Author: li-jia-nan

components/_util/wave/WaveEffect.tsx

@@ -1,10 +1,11 @@
+import * as React from 'react';
 import classNames from 'classnames';
 import CSSMotion from 'rc-motion';
-import { render, unmount } from 'rc-util/lib/React/render';
 import raf from 'rc-util/lib/raf';
-import * as React from 'react';
+import { render, unmount } from 'rc-util/lib/React/render';
+
+import { TARGET_CLS, type ShowWaveEffect } from './interface';
 import { getTargetWaveColor } from './util';
-import { type ShowWaveEffect, TARGET_CLS } from './interface';
 
 function validateNum(value: number) {
   return Number.isNaN(value) ? 0 : value;

components/_util/wave/index.ts

@@ -12,7 +12,7 @@ import useWave from './useWave';
 export interface WaveProps {
   disabled?: boolean;
   children?: React.ReactNode;
-  component?: string;
+  component?: 'Tag' | 'Button' | 'Checkbox' | 'Radio' | 'Switch';
 }
 
 const Wave: React.FC<WaveProps> = (props) => {
@@ -48,7 +48,6 @@ const Wave: React.FC<WaveProps> = (props) => {
       ) {
         return;
       }
-
       showWave(e);
     };
 

components/_util/wave/useWave.ts

@@ -1,16 +1,17 @@
 import * as React from 'react';
 import { useEvent } from 'rc-util';
 import raf from 'rc-util/lib/raf';
-import showWaveEffect from './WaveEffect';
+
 import { ConfigContext } from '../../config-provider';
 import useToken from '../../theme/useToken';
 import { TARGET_CLS, type ShowWave } from './interface';
+import showWaveEffect from './WaveEffect';
 
-export default function useWave(
+const useWave = (
   nodeRef: React.RefObject<HTMLElement>,
   className: string,
-  component?: string,
-) {
+  component?: 'Tag' | 'Button' | 'Checkbox' | 'Radio' | 'Switch',
+) => {
   const { wave } = React.useContext(ConfigContext);
   const [, token, hashId] = useToken();
 
@@ -41,4 +42,6 @@ export default function useWave(
   };
 
   return showDebounceWave;
-}
+};
+
+export default useWave;

components/button/index.en-US.md

@@ -85,11 +85,21 @@ It accepts all props which native buttons support.
 
 ## FAQ
 
+### How to close the click wave effect?
+
+If you don't need this feature, you can set `disabled` of `wave` in [ConfigProvider](/components/config-provider#api) as `true`.
+
+```jsx
+<ConfigProvider wave={{ disabled: true }}>
+  <Button>click</Button>
+</ConfigProvider>
+```
+
 ### How to remove space between 2 chinese characters?
 
 Following the Ant Design specification, we will add one space between if Button (exclude Text button and Link button) contains two Chinese characters only. If you don't need that, you can use [ConfigProvider](/components/config-provider/#api) to set `autoInsertSpaceInButton` as `false`.
 
-```tsx
+```jsx
 <ConfigProvider autoInsertSpaceInButton={false}>
   <Button>按钮</Button>
 </ConfigProvider>

components/button/index.zh-CN.md

@@ -90,11 +90,21 @@ group:
 
 ## FAQ
 
+### 如何关闭点击波纹效果？
+
+如果你不需要这个特性，可以设置 [ConfigProvider](/components/config-provider-cn#api) 的 `wave` 的 `disabled` 为 `true`。
+
+```jsx
+<ConfigProvider wave={{ disabled: true }}>
+  <Button>click</Button>
+</ConfigProvider>
+```
+
 ### 如何移除两个汉字之间的空格？
 
-根据 Ant Design 设计规范要求，我们会在按钮内(文本按钮和链接按钮除外)只有两个汉字时自动添加空格，如果你不需要这个特性，可以设置 [ConfigProvider](/components/config-provider-cn#api) 的 `autoInsertSpaceInButton` 为 `false`。
+根据 Ant Design 设计规范要求，我们会在按钮内（文本按钮和链接按钮除外）只有两个汉字时自动添加空格，如果你不需要这个特性，可以设置 [ConfigProvider](/components/config-provider-cn#api) 的 `autoInsertSpaceInButton` 为 `false`。
 
-```tsx
+```jsx
 <ConfigProvider autoInsertSpaceInButton={false}>
   <Button>按钮</Button>
 </ConfigProvider>

components/theme/interface/seeds.ts

@@ -1,4 +1,5 @@
 import type { PresetColorType } from './presetColors';
+
 // ======================================================================
 // ==                            Seed Token                            ==
 // ======================================================================
@@ -273,7 +274,7 @@ export interface SeedToken extends PresetColorType {
    * @nameEN Motion Style
    * @desc 用于配置动画效果，为 `false` 时则关闭动画
    * @descEN Used to configure the motion effect, when it is `false`, the motion is turned off
-   * @default false
+   * @default true
    */
   motion: boolean;
 }