jobiqo-cl
Version:
[](https://circleci.com/gh/jobiqo/jobiqo-cl)
105 lines (104 loc) • 2.72 kB
TypeScript
/// <reference types="react" />
export interface RangeDatePopupProps {
/**
* Marks if a field is in an error state.
*
* @default false
*/
error?: boolean;
/**
* If the field is required.
*
* @default false
*/
required?: boolean;
/**
* Id for the start date input.
*/
startDateId?: string;
/**
* Id for the end date input.
*/
endDateId?: string;
/**
* Date picker label.
*/
label?: string;
/**
* Description for this field.
*/
description?: string;
/**
* Start date aria label (if no label set).
*/
startDateAriaLabel?: string;
/**
* End date aria label (if no label set).
*/
endDateAriaLabel?: string;
/**
* Start date placeholder text.
*/
startDatePlaceholderText?: string;
/**
* End date placeholder text.
*/
endDatePlaceholderText?: string;
/**
* Initial value for start date.
*/
initialStartDate?: any;
/**
* Initial value for end date.
*/
initialEndDate?: any;
/**
* Even to trigger when dates change.
*/
onDatesChange: (date: any) => void;
/**
* Format to display the dates in.
*/
displayFormat?: string;
/**
* Min date value.
*/
minDate?: any;
/**
* Max date value.
*/
maxDate?: any;
/**
* 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 range date picker is used
* for multiple value dates like a start and end of education item or work experience. Use the "min and max dates" prop
* to allow any date value to be inserted (including past dates).
*/
export declare const RangeDatePopup: ({ startDateId, endDateId, initialStartDate, initialEndDate, label, description, startDateAriaLabel, endDateAriaLabel, startDatePlaceholderText, endDatePlaceholderText, onDatesChange, displayFormat, minDate, maxDate, showTimeSelect, timeFormat, timeIntervals, timeCaption, readOnly, required, error, disabledKeyboardNavigation, ...props }: RangeDatePopupProps) => JSX.Element;
export default RangeDatePopup;