| | |
| | | // Project: https://github.com/YouCanBookMe/react-datetime |
| | | // Definitions by: Ivan Verevkin <vereva@x-root.org> |
| | | |
| | | // These are the typings for Typescript 1.8 |
| | | // for Typescript 2.0+ see DateTime.d.ts |
| | | |
| | | //// <reference path="../moment/moment-node.d.ts" /> |
| | | |
| | | declare module ReactDatetime { |
| | |
| | | Represents the selected date by the component, in order to use it as a controlled component. |
| | | This prop is parsed by moment.js, so it is possible to use a date string or a moment.js date. |
| | | */ |
| | | value?: string; |
| | | value?: Date; |
| | | /* |
| | | Represents the selected date for the component to use it as a uncontrolled component. |
| | | This prop is parsed by moment.js, so it is possible to use a date string or a moment.js date. |
| | | */ |
| | | defaultValue?: string; |
| | | defaultValue?: Date; |
| | | /* |
| | | Represents the month which is viewed on opening the calendar when there is no selected date. |
| | | This prop is parsed by Moment.js, so it is possible to use a date `string` or a `moment` object. |
| | | */ |
| | | viewDate?: Date; |
| | | /* |
| | | Defines the format for the date. It accepts any moment.js date format. |
| | | If true the date will be displayed using the defaults for the current locale. |
| | |
| | | */ |
| | | locale?: string; |
| | | /* |
| | | Callback trigger when the date changes. The callback receives the selected moment object as |
| | | only parameter, if the date in the input is valid. If it isn't, the value |
| | | of the input (a string) is returned. |
| | | Whether to interpret input times as UTC or the user's local timezone. |
| | | */ |
| | | onChange?:(x: string) => void; |
| | | utc?: boolean; |
| | | /* |
| | | Callback trigger when the date changes. The callback receives the selected `moment` object as |
| | | only parameter, if the date in the input is valid. If the date in the input is not valid, the |
| | | callback receives the value of the input (a string). |
| | | */ |
| | | onChange?: (momentOrInputString: string|any) => void; |
| | | /* |
| | | Callback trigger for when the user opens the datepicker. |
| | | */ |
| | | onFocus?: (e) => void; |
| | | onFocus?: () => void; |
| | | /* |
| | | Callback trigger for when the user clicks outside of the input, simulating a regular onBlur. |
| | | The callback receives the selected moment object as only parameter, if the date in the |
| | | input is valid. If it isn't, the value of the input (a string) is returned. |
| | | The callback receives the selected `moment` object as only parameter, if the date in the input |
| | | is valid. If the date in the input is not valid, the callback receives the value of the |
| | | input (a string). |
| | | */ |
| | | onBlurs?: (e) => void; |
| | | onBlur?: (momentOrInputString : string|any) => void; |
| | | /* |
| | | Callback trigger when the view mode changes. The callback receives the selected view mode |
| | | string ('years', 'months', 'days', 'time') as only parameter. |
| | | */ |
| | | onViewModeChange?: (viewMode: string) => void; |
| | | /* |
| | | The default view to display when the picker is shown. ('years', 'months', 'days', 'time') |
| | | */ |
| | |
| | | */ |
| | | inputProps?: Object; |
| | | /* |
| | | Replace the rendering of the input element. The accepted function has openCalendar |
| | | (a function which opens the calendar) and the default calculated props for the input. |
| | | Must return a React component or null. |
| | | */ |
| | | renderInput?: (props: Object, openCalendar: Function) => React.Component<any, any>; |
| | | /* |
| | | Define the dates that can be selected. The function receives (currentDate, selectedDate) |
| | | and should return a true or false whether the currentDate is valid or not. See selectable dates. |
| | | */ |
| | | isValidDate?: (x: string) => void; |
| | | isValidDate?: (currentDate: any, selectedDate: any) => boolean; |
| | | /* |
| | | Customize the way that the days are shown in the day picker. The accepted function has |
| | | the selectedDate, the current date and the default calculated props for the cell, |
| | | and must return a React component. See appearance customization |
| | | */ |
| | | renderDay?: (x: string) => void; |
| | | renderDay?: (props: any, currentDate: any, selectedDate: any) => React.Component<any, any>; |
| | | /* |
| | | Customize the way that the months are shown in the month picker. |
| | | The accepted function has the selectedDate, the current date and the default calculated |
| | | props for the cell, the month and the year to be shown, and must return a |
| | | React component. See appearance customization |
| | | */ |
| | | renderMonth?: (x: string) => void; |
| | | renderMonth?: (props: any, month: number, year: number, selectedDate: any) => React.Component<any, any>; |
| | | /* |
| | | Customize the way that the years are shown in the year picker. |
| | | The accepted function has the selectedDate, the current date and the default calculated |
| | | props for the cell, the year to be shown, and must return a React component. |
| | | See appearance customization |
| | | */ |
| | | renderYear?: (x: string) => void; |
| | | renderYear?: (props: any, year: number, selectedDate: any) => React.Component<any, any>; |
| | | /* |
| | | Whether to use moment's strict parsing when parsing input. |
| | | */ |
| | |
| | | When true, once the day has been selected, the react-datetime will be automatically closed. |
| | | */ |
| | | closeOnSelect?: boolean; |
| | | /* |
| | | Allow to add some constraints to the time selector. It accepts an object with the format |
| | | {hours:{ min: 9, max: 15, step:2}} so the hours can't be lower than 9 or higher than 15, and |
| | | it will change adding or subtracting 2 hours everytime the buttons are clicked. The constraints |
| | | can be added to the hours, minutes, seconds and milliseconds. |
| | | */ |
| | | timeConstraints?: Object; |
| | | /* |
| | | When true, keep the picker open when click event is triggered outside of component. When false, |
| | | close it. |
| | | */ |
| | | disableOnClickOutside?: boolean; |
| | | } |
| | | |
| | | interface DatetimeComponent extends React.ComponentClass<DatetimepickerProps> { |