fastlion-amis
Version:
一种MIS页面生成工具
134 lines (133 loc) • 4.79 kB
TypeScript
import React from 'react';
import { FormControlProps, FormBaseControl } from './Item';
import 'moment/locale/zh-cn';
import { ShortCuts } from '../../components/DatePicker';
import { Action } from '../../types';
/**
* DateRange 日期范围控件
* 文档：https://baidu.gitee.io/amis/docs/components/form/date-range
*/
export interface DateRangeControlSchema extends FormBaseControl {
/**
* 指定为日期范围控件
*/
type: 'input-date-range' | 'input-datetime-range' | 'input-time-range';
/**
* 分割符, 因为有两个值，开始时间和结束时间，所以要有连接符。默认为英文逗号。
*
*/
delimiter?: string;
/**
* 默认 `X` 即时间戳格式，用来提交的时间格式。更多格式类型请参考 moment.
*/
format?: string;
/**
* 默认 `YYYY-MM-DD` 用来配置显示的时间格式。
*/
inputFormat?: string;
/**
* 开启后将选中的选项 value 的值用连接符拼接起来，作为当前表单项的值。如： `value1,value2` 否则为 `[value1, value2]`
*/
joinValues?: boolean;
/**
* 最大日期限制，支持变量 $xxx 来取值，或者用相对值如：* `-2mins` 2分钟前\n * `+2days` 2天后\n* `-10week` 十周前\n可用单位： `min`、`hour`、`day`、`week`、`month`、`year`。所有单位支持复数形式。
*/
maxDate?: string;
/**
* 最小日期限制，支持变量 $xxx 来取值，或者用相对值如：* `-2mins` 2分钟前\n * `+2days` 2天后\n* `-10week` 十周前\n可用单位： `min`、`hour`、`day`、`week`、`month`、`year`。所有单位支持复数形式。
*/
minDate?: string;
/**
* 最大跨度，比如 2days
*/
maxDuration?: string;
/**
* 最小跨度，比如 2days
*/
minDuration?: string;
/**
* 这里面 value 需要特殊说明一下，因为支持相对值。* `-2mins` 2分钟前\n * `+2days` 2天后\n* `-10week` 十周前\n可用单位： `min`、`hour`、`day`、`week`、`month`、`year`。所有单位支持复数形式。
*/
value?: any;
/**
* 边框模式，全边框，还是半边框，或者没边框。
*/
borderMode?: 'full' | 'half' | 'none';
/**
* 开启后变成非弹出模式，即内联模式。
*/
embed?: boolean;
/**
* 日期范围快捷键
* @deprecated 3.1.0及以后版本废弃，建议用 shortcuts 属性。
*/
ranges?: string | Array<ShortCuts>;
/**
* 日期范围快捷键
*/
shortcuts?: string | Array<ShortCuts>;
/**
* 是否启用游标动画，默认开启
*/
animation?: boolean;
/**
* 日期数据处理函数，用来处理选择日期之后的的值
*
* (value: moment.Moment, config: {type: 'start' | 'end'; originValue: moment.Moment, timeFormat: string}, props: any, data: any, moment: moment) => moment.Moment;
*/
transform?: string;
}
export interface DateRangeProps extends FormControlProps, Omit<DateRangeControlSchema, 'type' | 'className' | 'descriptionClassName' | 'inputClassName'> {
delimiter: string;
format: string;
joinValues: boolean;
}
export default class DateRangeControl extends React.Component<DateRangeProps> {
static defaultProps: {
format: string;
joinValues: boolean;
delimiter: string;
animation: boolean;
};
dateRef?: any;
constructor(props: DateRangeProps);
componentDidUpdate(prevProps: DateRangeProps): void;
getRef: (ref: any) => void;
doAction: (action: Action, data: object, throwErrors: boolean) => void;
render(): React.JSX.Element;
}
export declare class DateRangeControlRenderer extends DateRangeControl {
static defaultProps: {
timeFormat: string;
viewMode: string;
format: string;
joinValues: boolean;
delimiter: string;
animation: boolean;
};
}
export declare class DateTimeRangeControlRenderer extends DateRangeControl {
static defaultProps: {
timeFormat: string;
viewMode: string;
inputFormat: string;
format: string;
joinValues: boolean;
delimiter: string;
animation: boolean;
};
}
export declare class TimeRangeControlRenderer extends DateRangeControl {
static defaultProps: {
format: string;
timeFormat: string;
inputFormat: string;
viewMode: string;
/** shortcuts的兼容配置 */
ranges: string;
shortcuts: string;
joinValues: boolean;
delimiter: string;
animation: boolean;
};
}