IPeriodRangePickerProps

IPeriodRangePickerProps.customRangeHintpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Extra content rendered after the built-in format hint.

customRangeHint?: ReactNode;

IPeriodRangePickerProps.dateFormatpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Date format (date-fns tokens). Formats the input fields for the “GDC.time.date” granularity, and the day-level range preview for all the others.

dateFormat?: string;

IPeriodRangePickerProps.granularitypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

granularity: PeriodRangePickerGranularity;

IPeriodRangePickerProps.isMobilepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

isMobile: boolean;

IPeriodRangePickerProps.onRangeChangepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

onRangeChange: (newRange: IPeriodRange) => void;

IPeriodRangePickerProps.onValidityChangepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Reports whether the picker’s fields currently form a submittable range, even while a field is empty or unparsable - unlike onRangeChange, which stays silent in that case. Pass a stable callback (e.g. a useState setter), not one that changes identity every render.

onValidityChange?: (isValid: boolean) => void;

IPeriodRangePickerProps.rangepropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

range: IPeriodRange;

IPeriodRangePickerProps.submitFormpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

submitForm: () => void;

IPeriodRangePickerProps.weekStartpropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

Which day a week starts on; only relevant when granularity is "GDC.time.week_us" or "GDC.time.date". Defaults to “Sunday”.

weekStart?: WeekStart;

IPeriodRangePickerProps.withoutApplypropertyAlpha

Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.

withoutApply?: boolean;