feat: update

Author: Meet-student

README.md

@@ -54,6 +54,7 @@ render(<Picker />, mountNode);
 | autoFocus | boolean | false | whether auto focus |
 | showTime | boolean \| Object | [showTime options](#showTime-options) | to provide an additional time selection |
 | picker | time \| date \| week \| month \| year |  | control which kind of panel should be shown |
+| showHoverValue | boolean | true | When the user selects the date hover option, the value of the input field undergoes a temporary change |
 | format | String \| String[] | depends on whether you set timePicker and your locale | use to format/parse date(without time) value to/from input. When an array is provided, all values are used for parsing and first value for display |
 | use12Hours | boolean | false | 12 hours display mode |
 | value | moment |  | current value like input's value |
@@ -102,7 +103,7 @@ render(<Picker />, mountNode);
 ### RangePicker
 
 | Property | Type | Default | Description |
-| --- | --- | --- | --- |
+| --- | --- | --- | --- | --- |
 | prefixCls | String | rc-picker | prefixCls of this component |
 | className | String | '' | additional css class of root dom |
 | style | React.CSSProperties |  | additional style of root dom node |
@@ -112,6 +113,7 @@ render(<Picker />, mountNode);
 | defaultPickerValue | moment |  | Set default display picker view date |
 | separator | String | '~' | set separator between inputs |
 | picker | time \| date \| week \| month \| year |  | control which kind of panel |
+| showHoverValue | boolean | true | When the user selects the date hover option, the value of the input field undergoes a temporary change |
 | placeholder | [String, String] |  | placeholder of date input |
 | showTime | boolean \| Object | [showTime options](#showTime-options) | to provide an additional time selection |
 | showTime.defaultValue | [moment, moment] |  | to set default time of selected date |

docs/examples/basic.tsx

@@ -155,12 +155,12 @@ export default () => {
           <Picker<Moment> {...sharedProps} locale={enUS} onKeyDown={keyDown} />
         </div>
         <div style={{ margin: '0 8px' }}>
-          <h3>ShowPreviewValue is false</h3>
+          <h3>ShowHoverValue is false</h3>
           <Picker<Moment>
             {...sharedProps}
             locale={enUS}
             onKeyDown={keyDown}
-            showPreviewValue={false}
+            showHoverValue={false}
           />
         </div>
       </div>

docs/examples/range.tsx

@@ -203,10 +203,10 @@ export default () => {
           />
         </div>
         <div style={{ margin: '0 8px' }}>
-          <h3>ShowPreviewValue is false</h3>
+          <h3>ShowHoverValue is false</h3>
           <RangePicker<Moment>
             {...sharedProps}
-            showPreviewValue={false}
+            showHoverValue={false}
             value={undefined}
             locale={zhCN}
             placeholder={['start...', 'end...']}

docs/examples/time.tsx

@@ -54,12 +54,12 @@ export default () => {
         })}
       />
 
-      <h3>ShowPreviewValue is false</h3>
+      <h3>showHoverValue is false</h3>
       <RangePicker
         defaultValue={[defaultValue, defaultValue]}
         picker="time"
         locale={zhCN}
-        showPreviewValue={false}
+        showHoverValue={false}
         generateConfig={momentGenerateConfig}
         disabledTime={(now, type) => ({
           disabledHours: () => (type === 'start' ? [now.hours()] : [now.hours() - 5]),

src/PickerInput/RangePicker.tsx

@@ -164,7 +164,7 @@ function RangePicker<DateType extends object = any>(
     styles: propStyles,
     classNames: propClassNames,
 
-    showPreviewValue = true,
+    showHoverValue = true,
     // Value
     defaultValue,
     value,
@@ -506,7 +506,7 @@ function RangePicker<DateType extends object = any>(
 
   // ======================== Panel =========================
   const onPanelHover = (date: DateType) => {
-    if (showPreviewValue) {
+    if (showHoverValue) {
       setInternalHoverValues(date ? fillCalendarValue(date, activeIndex) : null);
     }
     setHoverSource('cell');

src/PickerInput/SinglePicker.tsx

@@ -128,7 +128,7 @@ function Picker<DateType extends object = any>(
     styles: propStyles,
     classNames: propClassNames,
 
-    showPreviewValue = true,
+    showHoverValue = true,
 
     // Value
     order,
@@ -435,7 +435,7 @@ function Picker<DateType extends object = any>(
 
   // ======================== Panel =========================
   const onPanelHover = (date: DateType | null) => {
-    if (showPreviewValue) {
+    if (showHoverValue) {
       setInternalHoverValue(date);
     }
     setHoverSource('cell');

src/interface.tsx

@@ -425,7 +425,10 @@ export interface SharedPickerProps<DateType extends object = any>
    */
   preserveInvalidOnBlur?: boolean;
 
-  showPreviewValue?: boolean;
+  /**
+   * When the user selects the date hover option, the value of the input field undergoes a temporary change
+   */
+  showHoverValue?: boolean;
 
   // Motion
   transitionName?: string;

tests/range.spec.tsx

@@ -2121,14 +2121,14 @@ describe('Picker.Range', () => {
     expect(container.querySelectorAll('.rc-picker-input')[0]).toHaveClass('rc-picker-input-active');
   });
 
-  it('should not update preview value in input when showPreviewValue is false', () => {
+  it('should not update preview value in input when showHoverValue is false', () => {
     const { container } = render(
       <DayRangePicker
         minDate={dayjs('2024')}
         open
         mode={['year', 'year']}
         showTime
-        showPreviewValue={false}
+        showHoverValue={false}
         needConfirm
         value={[dayjs('2024-01-01'), dayjs('2025-01-01')]}
       />,

tests/time.spec.tsx

@@ -70,14 +70,14 @@ describe('Picker.Time', () => {
     expect(container.querySelector('input')).toHaveValue('1990-09-03 12:00:00.000 PM');
   });
 
-  it('hover should not update preview value in input when showPreviewValue is false', async () => {
+  it('hover should not update preview value in input when showHoverValue is false', async () => {
     const { container } = render(
       <DayPicker
         showTime={{
           showMillisecond: true,
           use12Hours: true,
         }}
-        showPreviewValue={false}
+        showHoverValue={false}
         defaultValue={dayjs('1990-09-03 01:02:03')}
       />,
     );