Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: prop types not being correctly interpreted by TS #2283

Merged
merged 3 commits into from
Jul 21, 2024
Merged

fix: prop types not being correctly interpreted by TS #2283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4cb2d5
Fix prop types not being correctly interpreted
gpbl Jul 21, 2024
d39b25d
Add docs to selection props
gpbl Jul 21, 2024
780c7ea
Add missing disabled matcher
gpbl Jul 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/DayPicker.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import { isDateRange } from "./utils/typeguards.js";
* @group DayPicker
* @see https://daypicker.dev
*/
export function DayPicker<T extends DayPickerProps>(props: T) {
export function DayPicker(props: DayPickerProps) {
const { components, formatters, labels, dateLib, classNames } = useMemo(
() => ({
dateLib: getDateLib(props.dateLib),
Expand Down Expand Up @@ -116,9 +116,9 @@ export function DayPicker<T extends DayPickerProps>(props: T) {
isSelected,
select,
selected: selectedValue
} = useSelection<T>(props, dateLib) ?? {};
} = useSelection(props, dateLib) ?? {};

const { blur, focused, isFocusTarget, moveFocus, setFocused } = useFocus<T>(
const { blur, focused, isFocusTarget, moveFocus, setFocused } = useFocus(
props,
calendar,
getModifiers,
Expand Down Expand Up @@ -221,9 +221,9 @@ export function DayPicker<T extends DayPickerProps>(props: T) {

const dataAttributes = getDataAttributes(props);

const contextValue: DayPickerContext<T> = {
selected: selectedValue as SelectedValue<T>,
select: select as SelectHandler<T>,
const contextValue: DayPickerContext<DayPickerProps> = {
selected: selectedValue as SelectedValue<DayPickerProps>,
select: select as SelectHandler<DayPickerProps>,
isSelected,
months,
nextMonth,
Expand Down
23 changes: 22 additions & 1 deletion src/types/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,7 +464,9 @@ export interface PropsBase {
export interface PropsSingleRequired {
mode: "single";
required: true;
/** The selected date. */
selected: Date;
/** Event handler when a day is selected. */
onSelect?: (
selected: Date,
triggerDate: Date,
Expand All @@ -480,7 +482,9 @@ export interface PropsSingleRequired {
export interface PropsSingle {
mode: "single";
required?: false | undefined;
/** The selected date. */
selected?: Date | undefined;
/** Event handler when a day is selected. */
onSelect?: (
selected: Date | undefined,
triggerDate: Date,
Expand All @@ -496,14 +500,18 @@ export interface PropsSingle {
export interface PropsMultiRequired {
mode: "multiple";
required: true;
/** The selected dates. */
selected: Date[];
/** Event handler when days are selected. */
onSelect?: (
selected: Date[],
triggerDate: Date,
modifiers: Modifiers,
e: React.MouseEvent | React.KeyboardEvent
) => void;
/** The minimum number of selectable days. */
min?: number;
/** The maximum number of selectable days. */
max?: number;
}
/**
Expand All @@ -514,14 +522,18 @@ export interface PropsMultiRequired {
export interface PropsMulti {
mode: "multiple";
required?: false | undefined;
/** The selected dates. */
selected?: Date[] | undefined;
/** Event handler when days are selected. */
onSelect?: (
selected: Date[] | undefined,
triggerDate: Date,
modifiers: Modifiers,
e: React.MouseEvent | React.KeyboardEvent
) => void;
/** The minimum number of selectable days. */
min?: number;
/** The maximum number of selectable days. */
max?: number;
}
/**
Expand All @@ -532,14 +544,19 @@ export interface PropsMulti {
export interface PropsRangeRequired {
mode: "range";
required: true;
disabled?: Matcher | Matcher[] | undefined;
/** The selected range. */
selected: DateRange;
/** Event handler when a range is selected. */
onSelect?: (
selected: DateRange,
triggerDate: Date,
modifiers: Modifiers,
e: React.MouseEvent | React.KeyboardEvent
) => void;
/** The minimum number of days to include in the range. */
min?: number;
/** The maximum number of days to include in the range. */
max?: number;
}
/**
Expand All @@ -550,14 +567,18 @@ export interface PropsRangeRequired {
export interface PropsRange {
mode: "range";
required?: false | undefined;
selected?: DateRange | undefined;
disabled?: Matcher | Matcher[] | undefined;
/** The selected range. */
selected?: DateRange | undefined;
/** Event handler when the selection changes. */
onSelect?: (
selected: DateRange | undefined,
triggerDate: Date,
modifiers: Modifiers,
e: React.MouseEvent | React.KeyboardEvent
) => void | undefined;
/** The minimum number of days to include in the range. */
min?: number;
/** The maximum number of days to include in the range. */
max?: number;
}