@payfit/unity-components
Version:
23 lines (22 loc) • 1.27 kB
TypeScript
import { DateValue } from '@internationalized/date';
import { RangeCalendarProps as AriaRangeCalendarProps } from 'react-aria-components/RangeCalendar';
type PropsFromAriaRangeCalendar<TDate extends DateValue> = AriaRangeCalendarProps<TDate>;
export type DateRangeCalendarProps<TDate extends DateValue> = PropsFromAriaRangeCalendar<TDate>;
/**
* The `DateRangeCalendar` component displays a calendar grid and allows users to select a date range (start and end dates).
* @param {DateRangeCalendarProps} props - The props for the `DateRangeCalendar` component
* @example
* ```tsx
* import { DateRangeCalendar } from '@payfit/unity-components'
* import { CalendarDate } from '@internationalized/date'
*
* const [range, setRange] = useState({ start: new CalendarDate(2024, 1, 1), end: new CalendarDate(2024, 1, 15) })
* <DateRangeCalendar value={range} onChange={setRange} />
* ```
* @see {@link DateRangeCalendarProps} for all available props
*/
declare function DateRangeCalendar<TDate extends DateValue>({ value, defaultValue, minValue, maxValue, onChange, onFocusChange, ...props }: DateRangeCalendarProps<TDate>): import("react/jsx-runtime").JSX.Element;
declare namespace DateRangeCalendar {
var displayName: string;
}
export { DateRangeCalendar };