ant-design-vue
Version:
An enterprise-class UI design language and Vue-based implementation
69 lines (68 loc) • 3.53 kB
TypeScript
import type { ExtractPropTypes } from 'vue';
import type { RangePickerTimeProps } from '../date-picker/generatePicker';
import type { CommonProps, DatePickerProps } from '../date-picker/generatePicker/props';
import type { GenerateConfig } from '../vc-picker/generate';
import type { PanelMode, RangeValue } from '../vc-picker/interface';
export interface TimePickerLocale {
placeholder?: string;
rangePlaceholder?: [string, string];
}
export declare const timePickerProps: () => {
format: StringConstructor;
showNow: {
type: BooleanConstructor;
default: boolean;
};
showHour: {
type: BooleanConstructor;
default: boolean;
};
showMinute: {
type: BooleanConstructor;
default: boolean;
};
showSecond: {
type: BooleanConstructor;
default: boolean;
};
use12Hours: {
type: BooleanConstructor;
default: boolean;
};
hourStep: NumberConstructor;
minuteStep: NumberConstructor;
secondStep: NumberConstructor;
hideDisabledOptions: {
type: BooleanConstructor;
default: boolean;
};
popupClassName: StringConstructor;
status: {
type: import("vue").PropType<"" | "error" | "warning">;
default: "" | "error" | "warning";
};
};
type CommonTimePickerProps = Partial<ExtractPropTypes<ReturnType<typeof timePickerProps>>>;
export type TimeRangePickerProps<DateType> = Omit<RangePickerTimeProps<DateType>, 'picker' | 'defaultPickerValue' | 'defaultValue' | 'value' | 'onChange' | 'onPanelChange' | 'onOk'> & {
popupClassName?: string;
valueFormat?: string;
defaultPickerValue?: RangeValue<DateType> | RangeValue<string>;
defaultValue?: RangeValue<DateType> | RangeValue<string>;
value?: RangeValue<DateType> | RangeValue<string>;
onChange?: (value: RangeValue<DateType> | RangeValue<string> | null, dateString: [string, string]) => void;
'onUpdate:value'?: (value: RangeValue<DateType> | RangeValue<string> | null) => void;
onPanelChange?: (values: RangeValue<DateType> | RangeValue<string>, modes: [PanelMode, PanelMode]) => void;
onOk?: (dates: RangeValue<DateType> | RangeValue<string>) => void;
};
export type TimePickerProps<DateType> = CommonProps<DateType> & DatePickerProps<DateType> & CommonTimePickerProps & {
addon?: () => void;
};
declare function createTimePicker<DateType, DTimePickerProps extends TimePickerProps<DateType> = TimePickerProps<DateType>, DTimeRangePickerProps extends TimeRangePickerProps<DateType> = TimeRangePickerProps<DateType>>(generateConfig: GenerateConfig<DateType>): {
TimePicker: import("vue").DefineComponent<DTimePickerProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<DTimePickerProps extends import("vue").ComponentPropsOptions<{
[x: string]: unknown;
}> ? ExtractPropTypes<DTimePickerProps> : DTimePickerProps>, import("vue").ExtractDefaultPropTypes<DTimePickerProps>, {}>;
TimeRangePicker: import("vue").DefineComponent<DTimeRangePickerProps, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<DTimeRangePickerProps extends import("vue").ComponentPropsOptions<{
[x: string]: unknown;
}> ? ExtractPropTypes<DTimeRangePickerProps> : DTimeRangePickerProps>, import("vue").ExtractDefaultPropTypes<DTimeRangePickerProps>, {}>;
};
export default createTimePicker;