rsuite 5.49.0 → 5.50.0

package/cjs/DateRangePicker/DateRangePicker.d.ts

@@ -1,8 +1,11 @@
 import React from 'react';
 import { FormControlBaseProps, PickerBaseProps } from '../@types/common';
-import { PickerComponent, PickerToggleProps } from '../Picker';
+import { DateRangePickerLocale } from '../locales';
+import { PickerComponent } from '../Picker';
 import { DisabledDateFunction, RangeType, DateRange } from './types';
-export interface DateRangePickerProps extends PickerBaseProps, FormControlBaseProps<DateRange | null>, Pick<PickerToggleProps, 'caretAs' | 'readOnly' | 'plaintext' | 'loading'> {
+export interface DateRangePickerProps extends PickerBaseProps<DateRangePickerLocale>, FormControlBaseProps<DateRange | null> {
+    /** Custom caret component */
+    caretAs?: React.ElementType | null;
     /** Predefined date ranges */
     ranges?: RangeType[];
     /** Format date */
@@ -13,12 +16,20 @@ export interface DateRangePickerProps extends PickerBaseProps, FormControlBasePr
     hoverRange?: 'week' | 'month' | ((date: Date) => DateRange);
     /** Whether to click once on selected date range，Can be used with hoverRange */
     oneTap?: boolean;
-    /** ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day */
+    /**
+     * ISO 8601 standard, each calendar week begins on Monday and Sunday on the seventh day
+     *
+     * @see https://en.wikipedia.org/wiki/ISO_week_date
+     */
     isoWeek?: boolean;
+    /** A label displayed at the beginning of toggle button */
+    label?: React.ReactNode;
     /** Set the upper limit of the available year relative to the current selection date */
     limitEndYear?: number;
     /** Set the lower limit of the available year relative to the current selection date */
     limitStartYear?: number;
+    /** Whether to display a loading state indicator */
+    loading?: boolean;
     /** Whether to show week numbers */
     showWeekNumbers?: boolean;
     /** Show only one calendar select */
@@ -47,7 +58,10 @@ export interface DateRangePickerProps extends PickerBaseProps, FormControlBasePr
     onShortcutClick?: (range: RangeType, event: React.MouseEvent) => void;
     /** Called when clean */
     onClean?: (event: React.MouseEvent) => void;
-    /** Custom render value */
+    /**
+     * Custom render value
+     * @deprecated
+     */
     renderValue?: (value: DateRange, format: string) => React.ReactNode;
     /** Custom render for calendar title */
     renderTitle?: (date: Date) => React.ReactNode;