From 0f7f0cc6e454b8c84cfa49f83159d786f1c60865 Mon Sep 17 00:00:00 2001 From: MadCcc Date: Thu, 30 Nov 2023 13:37:46 +0800 Subject: [PATCH] feat: deprecate onAfterChange for onChangeComplete (#46182) --- components/slider/__tests__/type.test.tsx | 6 +++--- components/slider/demo/event.md | 4 ++-- components/slider/demo/event.tsx | 8 ++++---- components/slider/index.en-US.md | 2 +- components/slider/index.tsx | 4 ++++ components/slider/index.zh-CN.md | 2 +- package.json | 2 +- 7 files changed, 16 insertions(+), 12 deletions(-) diff --git a/components/slider/__tests__/type.test.tsx b/components/slider/__tests__/type.test.tsx index b1219a71eb31..41f7c4341a25 100644 --- a/components/slider/__tests__/type.test.tsx +++ b/components/slider/__tests__/type.test.tsx @@ -6,7 +6,7 @@ describe('Slider.typescript', () => { const value = 0; const onChange = (v: number) => v; const result = ( - + ); expect(result).toBeTruthy(); }); @@ -20,7 +20,7 @@ describe('Slider.typescript', () => { defaultValue={value} value={value} onChange={onChange} - onAfterChange={onChange} + onChangeComplete={onChange} /> ); expect(result).toBeTruthy(); @@ -34,7 +34,7 @@ describe('Slider.typescript', () => { defaultValue={value} value={value} onChange={onChange} - onAfterChange={onChange} + onChangeComplete={onChange} step={null} /> ); diff --git a/components/slider/demo/event.md b/components/slider/demo/event.md index 08e4936cf97f..57cae949f564 100644 --- a/components/slider/demo/event.md +++ b/components/slider/demo/event.md @@ -1,7 +1,7 @@ ## zh-CN -当 Slider 的值发生改变时，会触发 `onChange` 事件，并把改变后的值作为参数传入。在 `onmouseup` 时，会触发 `onAfterChange` 事件，并把当前值作为参数传入。 +当 Slider 的值发生改变时，会触发 `onChange` 事件，并把改变后的值作为参数传入。在 `mouseup` 或者 `keyup` 时，会触发 `onChangeComplete` 事件，并把当前值作为参数传入。 ## en-US -The `onChange` callback function will fire when the user changes the slider's value. The `onAfterChange` callback function will fire when `onmouseup` fired. +The `onChange` callback function will fire when the user changes the slider's value. The `onChangeComplete` callback function will fire when `mouseup` or `keyup` fired. diff --git a/components/slider/demo/event.tsx b/components/slider/demo/event.tsx index 8d71b64e3982..069fe28ab058 100644 --- a/components/slider/demo/event.tsx +++ b/components/slider/demo/event.tsx @@ -5,19 +5,19 @@ const onChange = (value: number | number[]) => { console.log('onChange: ', value); }; -const onAfterChange = (value: number | number[]) => { - console.log('onAfterChange: ', value); +const onChangeComplete = (value: number | number[]) => { + console.log('onChangeComplete: ', value); }; const App: React.FC = () => ( <> - + ); diff --git a/components/slider/index.en-US.md b/components/slider/index.en-US.md index a5c2e6d09b72..845e6927afa7 100644 --- a/components/slider/index.en-US.md +++ b/components/slider/index.en-US.md @@ -52,7 +52,7 @@ Common props ref：[Common props](/docs/react/common-props) | tooltip | The tooltip relate props | [tooltip](#tooltip) | - | 4.23.0 | | value | The value of slider. When `range` is false, use number, otherwise, use \[number, number] | number \| \[number, number] | - | | | vertical | If true, the slider will be vertical | boolean | false | | -| onAfterChange | Fire when onmouseup is fired | (value) => void | - | | +| onChangeComplete | Fire when `mouseup` or `keyup` is fired | (value) => void | - | | | onChange | Callback function that is fired when the user changes the slider's value | (value) => void | - | | ### `styles` 和 `classNames` 属性 diff --git a/components/slider/index.tsx b/components/slider/index.tsx index dd177930b904..93024cf2b78c 100644 --- a/components/slider/index.tsx +++ b/components/slider/index.tsx @@ -81,7 +81,9 @@ export interface SliderSingleProps extends SliderBaseProps { value?: number; defaultValue?: number; onChange?: (value: number) => void; + /** @deprecated Please use `onChangeComplete` instead */ onAfterChange?: (value: number) => void; + onChangeComplete?: (value: number) => void; /** @deprecated Please use `styles.handle` instead */ handleStyle?: React.CSSProperties; /** @deprecated Please use `styles.track` instead */ @@ -95,7 +97,9 @@ export interface SliderRangeProps extends SliderBaseProps { value?: number[]; defaultValue?: number[]; onChange?: (value: number[]) => void; + /** @deprecated Please use `onChangeComplete` instead */ onAfterChange?: (value: number[]) => void; + onChangeComplete?: (value: number[]) => void; /** @deprecated Please use `styles.handle` instead */ handleStyle?: React.CSSProperties[]; /** @deprecated Please use `styles.track` instead */ diff --git a/components/slider/index.zh-CN.md b/components/slider/index.zh-CN.md index 66cf03c594c2..1bbf2813acbd 100644 --- a/components/slider/index.zh-CN.md +++ b/components/slider/index.zh-CN.md @@ -54,7 +54,7 @@ demo: | tooltip | 设置 Tooltip 相关属性 | [tooltip](#tooltip) | - | 4.23.0 | | value | 设置当前取值。当 `range` 为 false 时，使用 number，否则用 \[number, number] | number \| \[number, number] | - | | | vertical | 值为 true 时，Slider 为垂直方向 | boolean | false | | -| onAfterChange | 与 `onmouseup` 触发时机一致，把当前值作为参数传入 | (value) => void | - | | +| onChangeComplete | 与 `mouseup` 和 `keyup` 触发时机一致，把当前值作为参数传入 | (value) => void | - | | | onChange | 当 Slider 的值发生改变时，会触发 onChange 事件，并把改变后的值作为参数传入 | (value) => void | - | | ### `styles` 和 `classNames` 属性 diff --git a/package.json b/package.json index ca3cd26f1530..a92ff275a36a 100644 --- a/package.json +++ b/package.json @@ -147,7 +147,7 @@ "rc-resize-observer": "^1.4.0", "rc-segmented": "~2.2.2", "rc-select": "~14.10.0", - "rc-slider": "~10.4.0", + "rc-slider": "~10.5.0", "rc-steps": "~6.0.1", "rc-switch": "~4.1.0", "rc-table": "~7.36.0",