@douyinfe/semi-foundation 2.24.3 → 2.25.0-alpha.0

package/lib/es/datePicker/foundation.d.ts

@@ -4,12 +4,12 @@ import type { ArrayElement } from '../utils/type';
 import type { Type, DateInputFoundationProps, InsetInputValue } from './inputFoundation';
 import type { MonthsGridFoundationProps } from './monthsGridFoundation';
 import type { WeekStartNumber } from './_utils/getMonthTable';
-export declare type ValidateStatus = ArrayElement<typeof strings.STATUS>;
-export declare type InputSize = ArrayElement<typeof strings.SIZE_SET>;
-export declare type Position = ArrayElement<typeof strings.POSITION_SET>;
-export declare type PresetPosition = ArrayElement<typeof strings.PRESET_POSITION_SET>;
-export declare type BaseValueType = string | number | Date;
-export declare type DayStatusType = {
+export type ValidateStatus = ArrayElement<typeof strings.STATUS>;
+export type InputSize = ArrayElement<typeof strings.SIZE_SET>;
+export type Position = ArrayElement<typeof strings.POSITION_SET>;
+export type PresetPosition = ArrayElement<typeof strings.PRESET_POSITION_SET>;
+export type BaseValueType = string | number | Date;
+export type DayStatusType = {
     isToday?: boolean;
     isSelected?: boolean;
     isDisabled?: boolean;
@@ -21,7 +21,7 @@ export declare type DayStatusType = {
     isOffsetRangeEnd?: boolean;
     isHoverInOffsetRange?: boolean;
 };
-export declare type DisabledDateOptions = {
+export type DisabledDateOptions = {
     rangeStart?: string;
     rangeEnd?: string;
     /**
@@ -29,12 +29,12 @@ export declare type DisabledDateOptions = {
      */
     rangeInputFocus?: 'rangeStart' | 'rangeEnd' | false;
 };
-export declare type PresetType = {
-    start?: string | Date | number;
-    end?: string | Date | number;
+export type PresetType = {
+    start?: BaseValueType | (() => BaseValueType);
+    end?: BaseValueType | (() => BaseValueType);
     text?: string;
 };
-export declare type TriggerRenderProps = {
+export type TriggerRenderProps = {
     [x: string]: any;
     value?: ValueType;
     inputValue?: string;
@@ -45,24 +45,24 @@ export declare type TriggerRenderProps = {
     inputReadOnly?: boolean;
     componentProps?: DatePickerFoundationProps;
 };
-export declare type DateOffsetType = (selectedDate?: Date) => Date;
-export declare type DensityType = 'default' | 'compact';
-export declare type DisabledDateType = (date?: Date, options?: DisabledDateOptions) => boolean;
-export declare type DisabledTimeType = (date?: Date | Date[], panelType?: string) => ({
+export type DateOffsetType = (selectedDate?: Date) => Date;
+export type DensityType = 'default' | 'compact';
+export type DisabledDateType = (date?: Date, options?: DisabledDateOptions) => boolean;
+export type DisabledTimeType = (date?: Date | Date[], panelType?: string) => ({
     disabledHours?: () => number[];
     disabledMinutes?: (hour: number) => number[];
     disabledSeconds?: (hour: number, minute: number) => number[];
 });
-export declare type OnCancelType = (date: Date | Date[], dateStr: string | string[]) => void;
-export declare type OnPanelChangeType = (date: Date | Date[], dateStr: string | string[]) => void;
-export declare type OnChangeType = (date?: Date | Date[] | string | string[], dateStr?: string | string[] | Date | Date[]) => void;
-export declare type OnConfirmType = (date: Date | Date[], dateStr: string | string[]) => void;
-export declare type OnPresetClickType = (item: PresetType, e: any) => void;
-export declare type PresetsType = Array<PresetType | (() => PresetType)>;
-export declare type RenderDateType = (dayNumber?: number, fullDate?: string) => any;
-export declare type RenderFullDateType = (dayNumber?: number, fullDate?: string, dayStatus?: DayStatusType) => any;
-export declare type TriggerRenderType = (props: TriggerRenderProps) => any;
-export declare type ValueType = BaseValueType | BaseValueType[];
+export type OnCancelType = (date: Date | Date[], dateStr: string | string[]) => void;
+export type OnPanelChangeType = (date: Date | Date[], dateStr: string | string[]) => void;
+export type OnChangeType = (date?: Date | Date[] | string | string[], dateStr?: string | string[] | Date | Date[]) => void;
+export type OnConfirmType = (date: Date | Date[], dateStr: string | string[]) => void;
+export type OnPresetClickType = (item: PresetType, e: any) => void;
+export type PresetsType = Array<PresetType | (() => PresetType)>;
+export type RenderDateType = (dayNumber?: number, fullDate?: string) => any;
+export type RenderFullDateType = (dayNumber?: number, fullDate?: string, dayStatus?: DayStatusType) => any;
+export type TriggerRenderType = (props: TriggerRenderProps) => any;
+export type ValueType = BaseValueType | BaseValueType[];
 export interface ElementProps {
     bottomSlot?: any;
     insetLabel?: any;
@@ -74,7 +74,7 @@ export interface RenderProps {
     renderFullDate?: RenderFullDateType;
     triggerRender?: TriggerRenderType;
 }
-export declare type RangeType = 'rangeStart' | 'rangeEnd' | false;
+export type RangeType = 'rangeStart' | 'rangeEnd' | false;
 export interface EventHandlerProps {
     onCancel?: OnCancelType;
     onChange?: OnChangeType;
@@ -85,11 +85,13 @@ export interface EventHandlerProps {
     onClear?: (e: any) => void;
     onFocus?: (e: any, rangType: RangeType) => void;
     onPresetClick?: OnPresetClickType;
+    onClickOutSide?: () => void;
 }
-export interface DatePickerFoundationProps extends ElementProps, RenderProps, EventHandlerProps {
+export interface DatePickerFoundationProps extends ElementProps, RenderProps, EventHandlerProps, Pick<MonthsGridFoundationProps, 'startYear' | 'endYear'> {
     autoAdjustOverflow?: boolean;
     autoFocus?: boolean;
     autoSwitchDate?: boolean;
+    borderless?: boolean;
     className?: string;
     defaultOpen?: boolean;
     defaultPickerValue?: ValueType;
@@ -136,24 +138,26 @@ export interface DatePickerFoundationProps extends ElementProps, RenderProps, Ev
     dateFnsLocale?: any;
     localeCode?: string;
     rangeSeparator?: string;
-    insetInput?: boolean;
+    insetInput?: DateInputFoundationProps['insetInput'];
     preventScroll?: boolean;
 }
 export interface DatePickerFoundationState {
     panelShow: boolean;
     isRange: boolean;
+    /** value of trigger input */
     inputValue: string;
     value: Date[];
-    cachedSelectedValue: Date[];
+    cachedSelectedValue: (Date | null)[];
     prevTimeZone: string | number;
     rangeInputFocus: RangeType;
     autofocus: boolean;
+    /** value of inset input */
     insetInputValue: InsetInputValue;
     triggerDisabled: boolean;
 }
 export { Type, DateInputFoundationProps };
 export interface DatePickerAdapter extends DefaultAdapter<DatePickerFoundationProps, DatePickerFoundationState> {
-    togglePanel: (panelShow: boolean) => void;
+    togglePanel: (panelShow: boolean, cb?: () => void) => void;
     registerClickOutSide: () => void;
     unregisterClickOutSide: () => void;
     notifyBlur: DatePickerFoundationProps['onBlur'];
@@ -176,6 +180,9 @@ export interface DatePickerAdapter extends DefaultAdapter<DatePickerFoundationPr
     updateInsetInputValue: (insetInputValue: InsetInputValue) => void;
     setInsetInputFocus: () => void;
     setTriggerDisabled: (disabled: boolean) => void;
+    setInputFocus: () => void;
+    setInputBlur: () => void;
+    setRangeInputBlur: () => void;
 }
 /**
  * The datePicker foundation.js is responsible for maintaining the date value and the input box value, as well as the callback of both
@@ -183,9 +190,9 @@ export interface DatePickerAdapter extends DefaultAdapter<DatePickerFoundationPr
  *  task 2. When the input box changes, update the date value = > Notify the change
  */
 export default class DatePickerFoundation extends BaseFoundation<DatePickerAdapter> {
+    clickConfirmButton: boolean;
     constructor(adapter: DatePickerAdapter);
     init(): void;
-    isValidTimeZone(timeZone?: string | number): boolean;
     initFromProps({ value, timeZone, prevTimeZone }: Pick<DatePickerFoundationProps, 'value' | 'timeZone'> & {
         prevTimeZone?: string | number;
     }): void;
@@ -195,6 +202,18 @@ export default class DatePickerFoundation extends BaseFoundation<DatePickerAdapt
      * If the user passes an empty value, you need to set the range input focus to rangeStart, so that the user can continue to select from the beginning after clearing
      */
     initRangeInputFocus(result: Date[]): void;
+    /**
+     * value 可能是 UTC value 也可能是 zoned value
+     *
+     * UTC value -> 受控传入的 value
+     *
+     * zoned value -> statue.value，保存的是当前计算机时区下选择的日期
+     *
+     * 如果是时区变化，则需要将旧 zoned value 转为新时区下的 zoned value
+     *
+     * 如果是 value 变化，则不需要传入之前的时区，将 UTC value 转为 zoned value 即可
+     *
+     */
     parseWithTimezone(value: ValueType, timeZone: string | number, prevTimeZone: string | number): Date[];
     _isMultiple(): boolean;
     /**
@@ -212,18 +231,6 @@ export default class DatePickerFoundation extends BaseFoundation<DatePickerAdapt
     destroy(): void;
     initPanelOpenStatus(defaultOpen?: boolean): void;
     openPanel(): void;
-    /**
-     * do these side effects when type is dateRange or dateTimeRange
-     *   1. trigger input blur, if input value is invalid, set input value and state value to previous status
-     *   2. set cachedSelectedValue using given dates(in needConfirm mode)
-     *      - directly closePanel without click confirm will set cachedSelectedValue to state value
-     *      - select one date(which means that the selection value is incomplete) and click confirm also set cachedSelectedValue to state value
-     */
-    rangeTypeSideEffectsWhenClosePanel(inputValue: string, willUpdateDates: Date[]): void;
-    /**
-     * clear input value when selected date is not confirmed
-     */
-    needConfirmSideEffectsWhenClosePanel(willUpdateDates: Date[] | null | undefined): void;
     /**
      * clear inset input value when close panel
      */
@@ -245,6 +252,23 @@ export default class DatePickerFoundation extends BaseFoundation<DatePickerAdapt
      * @param {Date[]} dates
      */
     closePanel(e?: any, inputValue?: string, dates?: Date[]): void;
+    open(): void;
+    close(): void;
+    focus(focusType?: Exclude<RangeType, false>): void;
+    blur(): void;
+    /**
+     * reset cachedSelectedValue, inputValue when close panel
+     */
+    resetInnerSelectedStates(willUpdateDates?: Date[]): void;
+    resetFocus(e?: any): void;
+    /**
+     * cachedSelectedValue can be `(Date|null)[]` or `null`
+     */
+    isCachedSelectedValueValid(dates: Date[]): boolean;
+    /**
+     * 将输入框内容置空
+     */
+    clearInputValue(): void;
     /**
      * clear range input focus when open is controlled
      * fixed github 1375
@@ -379,12 +403,18 @@ export default class DatePickerFoundation extends BaseFoundation<DatePickerAdapt
         needCheckFocusRecord?: boolean;
     }): void;
     /**
-     * when changing the year and month through the panel when the type is year or month
+     * when changing the year and month through the panel when the type is year or month or monthRange
      * @param {*} item
      */
     handleYMSelectedChange(item?: {
-        currentMonth?: number;
-        currentYear?: number;
+        currentMonth?: {
+            left: number;
+            right: number;
+        };
+        currentYear?: {
+            left: number;
+            right: number;
+        };
     }): void;
     handleConfirm(): void;
     handleCancel(): void;
@@ -428,15 +458,14 @@ export default class DatePickerFoundation extends BaseFoundation<DatePickerAdapt
     _notifyChange(value: Date[]): void;
     /**
      * Get the date changed through the date panel or enter
-     * @param {Date[]} dates
-     * @returns {Date[]}
      */
     _getChangedDates(dates: Date[]): any[];
     /**
      * Whether a date is disabled
-     * @param {Array} value
+     * @param value The date that needs to be judged whether to disable
+     * @param selectedValue Selected date, when selecting a range, pass this date to the second parameter of `disabledDate`
      */
-    _someDateDisabled(value: Date[]): boolean;
+    _someDateDisabled(value: Date[], selectedValue: Date[]): boolean;
     /**
      * Format locale date
      * locale get from LocaleProvider