diff --git a/packages/hooks/src/useToggle/__tests__/index.spec.ts b/packages/hooks/src/useToggle/__tests__/index.spec.ts index 402d5ba670..d67d51d357 100644 --- a/packages/hooks/src/useToggle/__tests__/index.spec.ts +++ b/packages/hooks/src/useToggle/__tests__/index.spec.ts @@ -15,14 +15,14 @@ describe('useToggle', () => { }); test('test on methods', async () => { - const hook = renderHook(() => useToggle('Hello')); - expect(hook.result.current[0]).toBe('Hello'); + const hook = renderHook(() => useToggle(true)); + expect(hook.result.current[0]).toBeTruthy(); callToggle(hook); expect(hook.result.current[0]).toBeFalsy(); act(() => { hook.result.current[1].setLeft(); }); - expect(hook.result.current[0]).toBe('Hello'); + expect(hook.result.current[0]).toBeTruthy(); act(() => { hook.result.current[1].setRight(); }); diff --git a/packages/hooks/src/useToggle/index.en-US.md b/packages/hooks/src/useToggle/index.en-US.md index a77dadd619..f4d7d77dac 100644 --- a/packages/hooks/src/useToggle/index.en-US.md +++ b/packages/hooks/src/useToggle/index.en-US.md @@ -22,17 +22,15 @@ A hook that toggle states. ```typescript const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue?: boolean); -const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue: T); - const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue: T, reverseValue: U) ``` ### Params -| Property | Description | Type | Default | -| ------------ | --------------------------- | ---- | ------- | -| defaultValue | The default value. Optional | `T` | `false` | -| reverseValue | The reverse value. Optional | `U` | - | +| Property | Description | Type | Default | +| ------------ | --------------------------- | -------------- | ------- | +| defaultValue | The default value. Optional | `boolean \| T` | `false` | +| reverseValue | The reverse value. Optional | `U` | - | ### Result diff --git a/packages/hooks/src/useToggle/index.ts b/packages/hooks/src/useToggle/index.ts index 3a9c30217f..d863bdea02 100644 --- a/packages/hooks/src/useToggle/index.ts +++ b/packages/hooks/src/useToggle/index.ts @@ -7,9 +7,9 @@ export interface Actions { toggle: () => void; } -function useToggle(): [boolean, Actions]; +function useToggle(): [boolean, Actions]; -function useToggle(defaultValue: T): [T, Actions]; +function useToggle(defaultValue: boolean): [boolean, Actions]; function useToggle(defaultValue: T, reverseValue: U): [T | U, Actions]; diff --git a/packages/hooks/src/useToggle/index.zh-CN.md b/packages/hooks/src/useToggle/index.zh-CN.md index e7446eb823..2bcf893280 100644 --- a/packages/hooks/src/useToggle/index.zh-CN.md +++ b/packages/hooks/src/useToggle/index.zh-CN.md @@ -22,17 +22,15 @@ nav: ```typescript const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue?: boolean); -const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue: T); - const [state, { toggle, set, setLeft, setRight }] = useToggle(defaultValue: T, reverseValue: U); ``` ### Params -| 参数 | 说明 | 类型 | 默认值 | -| ------------ | ------------------------ | ---- | ------- | -| defaultValue | 可选项,传入默认的状态值 | `T` | `false` | -| reverseValue | 可选项,传入取反的状态值 | `U` | - | +| 参数 | 说明 | 类型 | 默认值 | +| ------------ | ------------------------ | -------------- | ------- | +| defaultValue | 可选项,传入默认的状态值 | `boolean \| T` | `false` | +| reverseValue | 可选项,传入取反的状态值 | `U` | - | ### Result