jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
81 lines (80 loc) • 2.1 kB
TypeScript
/// <reference types="react" />
export interface SingleDatePopupProps {
/**
* The id of the date picker.
*/
id: string;
/**
* Marks if a field is in an error state.
*
* @default false
*/
error?: boolean;
/**
* If the field is required.
*
* @default false
*/
required?: boolean;
/**
* The label to display on the date picker.
*/
label?: string;
/**
* The placeholder to display on the date picker input.
*/
placeholder?: string;
/**
* The initial date to set on the date picker.
*/
initialDate?: any;
/**
* The date format to show the date in.
*/
displayFormat?: string;
/**
* Min date value.
*/
minDate?: any;
/**
* Max date value.
*/
maxDate?: any;
/**
* Even to trigger when the value changes.
*/
onDateChange: (date: any) => void;
/**
* If time selection should be visible.
*/
showTimeSelect?: boolean;
/**
* The time format.
*/
timeFormat?: string;
/**
* The intervals for each value in time select.
*/
timeIntervals?: number;
/**
* The title for time selection.
*/
timeCaption?: string;
/**
* If should be read only (prevent keyboard open).
*
* @default "false"
*/
readOnly?: boolean;
/**
* Disabled keyboard navigation.
*/
disabledKeyboardNavigation?: boolean;
}
/**
* A date popup can be used inside forms or filters in order to make it easier to choose a date. The single date picker is used for single value
* dates like a birthdate or a reminder date. Use the "min and max values" prop
* to allow any date value to be inserted (including past dates).
*/
export declare const SingleDatePopup: ({ id, placeholder, initialDate, onDateChange, label, displayFormat, showTimeSelect, timeFormat, timeIntervals, timeCaption, minDate, maxDate, readOnly, required, error, disabledKeyboardNavigation, ...props }: SingleDatePopupProps) => JSX.Element;
export default SingleDatePopup;