@wordpress/components 29.12.0 → 29.13.1-next.719a03cbe.0

package/src/calendar/date-range-calendar/index.tsx

@@ -0,0 +1,203 @@
+/**
+ * External dependencies
+ */
+import { differenceInCalendarDays } from 'date-fns';
+import { DayPicker, rangeContainsModifiers } from 'react-day-picker';
+import { enUS } from 'react-day-picker/locale';
+/**
+ * WordPress dependencies
+ */
+import { useMemo, useState } from '@wordpress/element';
+/**
+ * Internal dependencies
+ */
+import { COMMON_PROPS, MODIFIER_CLASSNAMES } from '../utils/constants';
+import { clampNumberOfMonths } from '../utils/misc';
+import { useControlledValue } from '../utils/use-controlled-value';
+import { useLocalizationProps } from '../utils/use-localization-props';
+import type { DateRangeCalendarProps, DateRange } from '../types';
+
+export function usePreviewRange( {
+	selected,
+	hoveredDate,
+	excludeDisabled,
+	min,
+	max,
+	disabled,
+}: Pick<
+	DateRangeCalendarProps,
+	'selected' | 'excludeDisabled' | 'min' | 'max' | 'disabled'
+> & {
+	hoveredDate: Date | undefined;
+} ) {
+	return useMemo( () => {
+		if ( ! hoveredDate || ! selected?.from ) {
+			return;
+		}
+
+		let previewHighlight: DateRange | undefined;
+		let potentialNewRange: { from: Date; to: Date } | undefined;
+
+		// Hovering on a date before the start of the selected range
+		if ( hoveredDate < selected.from ) {
+			previewHighlight = {
+				from: hoveredDate,
+				to: selected.from,
+			};
+
+			potentialNewRange = {
+				from: hoveredDate,
+				to: selected.to ?? selected.from,
+			};
+		} else if (
+			selected.to &&
+			hoveredDate > selected.from &&
+			hoveredDate < selected.to
+		) {
+			// Hovering on a date between the start and end of the selected range
+			previewHighlight = {
+				from: selected.from,
+				to: hoveredDate,
+			};
+
+			potentialNewRange = {
+				from: selected.from,
+				to: hoveredDate,
+			};
+		} else if ( hoveredDate > selected.from ) {
+			// Hovering on a date after the end of the selected range (either
+			// because it's greater than selected.to, or because it's not defined)
+			previewHighlight = {
+				from: selected.to ?? selected.from,
+				to: hoveredDate,
+			};
+
+			potentialNewRange = {
+				from: selected.from,
+				to: hoveredDate,
+			};
+		}
+
+		if (
+			min !== undefined &&
+			min > 0 &&
+			potentialNewRange &&
+			differenceInCalendarDays(
+				potentialNewRange.to,
+				potentialNewRange.from
+			) < min
+		) {
+			previewHighlight = {
+				from: hoveredDate,
+				to: hoveredDate,
+			};
+		}
+
+		if (
+			max !== undefined &&
+			max > 0 &&
+			potentialNewRange &&
+			differenceInCalendarDays(
+				potentialNewRange.to,
+				potentialNewRange.from
+			) > max
+		) {
+			previewHighlight = {
+				from: hoveredDate,
+				to: hoveredDate,
+			};
+		}
+
+		if (
+			excludeDisabled &&
+			disabled &&
+			potentialNewRange &&
+			rangeContainsModifiers( potentialNewRange, disabled )
+		) {
+			previewHighlight = {
+				from: hoveredDate,
+				to: hoveredDate,
+			};
+		}
+
+		return previewHighlight;
+	}, [ selected, hoveredDate, excludeDisabled, min, max, disabled ] );
+}
+
+/**
+ * `DateRangeCalendar` is a React component that provides a customizable calendar
+ * interface for **date range** selection.
+ *
+ * The component is built with accessibility in mind and follows ARIA best
+ * practices for calendar widgets. It provides keyboard navigation, screen reader
+ * support, and customizable labels for internationalization.
+ */
+export const DateRangeCalendar = ( {
+	defaultSelected,
+	selected: selectedProp,
+	onSelect,
+	numberOfMonths = 1,
+	excludeDisabled,
+	min,
+	max,
+	disabled,
+	locale = enUS,
+	timeZone,
+	...props
+}: DateRangeCalendarProps ) => {
+	const localizationProps = useLocalizationProps( {
+		locale,
+		timeZone,
+		mode: 'range',
+	} );
+
+	const [ selected, setSelected ] = useControlledValue<
+		DateRange | undefined
+	>( {
+		defaultValue: defaultSelected,
+		value: selectedProp,
+		onChange: onSelect,
+	} );
+
+	const [ hoveredDate, setHoveredDate ] = useState< Date | undefined >(
+		undefined
+	);
+
+	// Compute the preview range for hover effect
+	const previewRange = usePreviewRange( {
+		selected,
+		hoveredDate,
+		excludeDisabled,
+		min,
+		max,
+		disabled,
+	} );
+
+	const modifiers = useMemo( () => {
+		return {
+			preview: previewRange,
+			preview_start: previewRange?.from,
+			preview_end: previewRange?.to,
+		};
+	}, [ previewRange ] );
+
+	return (
+		<DayPicker
+			{ ...COMMON_PROPS }
+			{ ...localizationProps }
+			{ ...props }
+			mode="range"
+			numberOfMonths={ clampNumberOfMonths( numberOfMonths ) }
+			disabled={ disabled }
+			excludeDisabled={ excludeDisabled }
+			min={ min }
+			max={ max }
+			selected={ selected }
+			onSelect={ setSelected }
+			onDayMouseEnter={ ( date ) => setHoveredDate( date ) }
+			onDayMouseLeave={ () => setHoveredDate( undefined ) }
+			modifiers={ modifiers }
+			modifiersClassNames={ MODIFIER_CLASSNAMES }
+		/>
+	);
+};

package/src/calendar/index.tsx

@@ -0,0 +1,3 @@
+export { TZDate } from 'react-day-picker';
+export { DateCalendar } from './date-calendar';
+export { DateRangeCalendar } from './date-range-calendar';

package/src/calendar/stories/date-calendar.story.tsx

@@ -0,0 +1,221 @@
+/**
+ * External dependencies
+ */
+import { fn } from '@storybook/test';
+import {
+	enUS,
+	fr,
+	es,
+	de,
+	it,
+	he,
+	ru,
+	ja,
+	ptBR,
+	nl,
+	ko,
+	tr,
+	id,
+	zhCN,
+	zhTW,
+	ar,
+	sv,
+} from 'date-fns/locale';
+import type { Meta, StoryObj } from '@storybook/react';
+
+/**
+ * WordPress dependencies
+ */
+import { useState, useEffect } from '@wordpress/element';
+/**
+ * Internal dependencies
+ */
+import { DateCalendar, TZDate } from '..';
+
+const meta: Meta< typeof DateCalendar > = {
+	title: 'Components/Selection & Input/Time & Date/DateCalendar',
+	component: DateCalendar,
+	argTypes: {
+		locale: {
+			options: [
+				'English (US)',
+				'French',
+				'Spanish',
+				'German',
+				'Italian',
+				'Hebrew',
+				'Russian',
+				'Japanese',
+				'Portuguese (Brazil)',
+				'Dutch',
+				'Korean',
+				'Turkish',
+				'Indonesian',
+				'Chinese (Simplified)',
+				'Chinese (Traditional)',
+				'Arabic',
+				'Swedish',
+			],
+			mapping: {
+				'English (US)': enUS,
+				French: fr,
+				Spanish: es,
+				German: de,
+				Italian: it,
+				Hebrew: he,
+				Russian: ru,
+				Japanese: ja,
+				'Portuguese (Brazil)': ptBR,
+				Dutch: nl,
+				Korean: ko,
+				Turkish: tr,
+				Indonesian: id,
+				'Chinese (Simplified)': zhCN,
+				'Chinese (Traditional)': zhTW,
+				Arabic: ar,
+				Swedish: sv,
+			},
+			control: 'select',
+		},
+		timeZone: {
+			options: [
+				'Pacific/Honolulu',
+				'America/New_York',
+				'Europe/London',
+				'Asia/Tokyo',
+				'Pacific/Auckland',
+			],
+			control: 'select',
+		},
+		labels: {
+			control: false,
+		},
+		defaultSelected: { control: 'date' },
+		selected: { control: 'date' },
+		onSelect: {
+			control: false,
+		},
+		defaultMonth: { control: 'date' },
+		month: { control: 'date' },
+		onMonthChange: {
+			control: false,
+		},
+		endMonth: { control: 'date' },
+		startMonth: { control: 'date' },
+	},
+	args: {
+		onMonthChange: fn(),
+		onSelect: fn(),
+	},
+};
+export default meta;
+
+type Story = StoryObj< typeof DateCalendar >;
+
+export const Default: Story = {};
+
+export const DisabledDates: Story = {
+	args: {
+		disabled: [
+			// Disable tomorrow (single date)
+			new Date( new Date().setDate( new Date().getDate() + 1 ) ),
+			// Disable all dates after Feb 1st of next year
+			{ after: new Date( new Date().getFullYear() + 1, 1, 1 ) },
+			// Disable all dates before Dec 1st of last year
+			{ before: new Date( new Date().getFullYear() - 1, 11, 1 ) },
+			// Disable all dates between 12th and 14th of August of this year
+			{
+				after: new Date( new Date().getFullYear(), 7, 11 ),
+				before: new Date( new Date().getFullYear(), 7, 15 ),
+			},
+			// Disable all dates between 21st and 26th of October of this year
+			{
+				from: new Date( new Date().getFullYear(), 9, 21 ),
+				to: new Date( new Date().getFullYear(), 9, 26 ),
+			},
+			// Disable all Wednesdays
+			{ dayOfWeek: 3 },
+			// Disable all prime day numbers
+			function isPrimeDate( date: Date ) {
+				return [ 2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31 ].includes(
+					date.getDate()
+				);
+			},
+		],
+	},
+};
+
+const nextMonth = new Date().getMonth() === 11 ? 0 : new Date().getMonth() + 1;
+const nextMonthYear =
+	new Date().getMonth() === 11
+		? new Date().getFullYear() + 1
+		: new Date().getFullYear();
+const firstDayOfNextMonth = new Date( nextMonthYear, nextMonth, 1 );
+export const WithSelectedDateAndMonth: Story = {
+	args: {
+		defaultSelected: firstDayOfNextMonth,
+		defaultMonth: firstDayOfNextMonth,
+	},
+};
+
+/**
+ * When working with time zones, use the `TZDate` object exported by this package instead of the native `Date` object.
+ */
+export const WithTimeZone: Story = {
+	render: function DateCalendarWithTimeZone( args ) {
+		const [ selected, setSelected ] = useState< TZDate | null >( null );
+
+		useEffect( () => {
+			setSelected(
+				// Select one week from today every time the time zone changes.
+				new TZDate(
+					new Date().setDate( new Date().getDate() + 7 ),
+					args.timeZone
+				)
+			);
+		}, [ args.timeZone ] );
+
+		return (
+			<>
+				<DateCalendar
+					{ ...args }
+					selected={ selected }
+					onSelect={ ( selectedDate, ...rest ) => {
+						setSelected(
+							selectedDate
+								? new TZDate( selectedDate, args.timeZone )
+								: null
+						);
+						args.onSelect?.( selectedDate, ...rest );
+					} }
+					disabled={ [
+						{
+							// Disable any date before today
+							before: new TZDate( new Date(), args.timeZone ),
+						},
+					] }
+				/>
+
+				<p>
+					Calendar set to { args.timeZone ?? 'current' } timezone,
+					disabling selection for all dates before today, and starting
+					with a default date of 1 week from today.
+				</p>
+			</>
+		);
+	},
+	args: {
+		timeZone: 'Pacific/Auckland',
+	},
+	argTypes: {
+		selected: {
+			control: false,
+		},
+		defaultSelected: {
+			control: false,
+		},
+		disabled: {
+			control: false,
+		},
+	},
+};

package/src/calendar/stories/date-range-calendar.story.tsx

@@ -0,0 +1,230 @@
+/**
+ * External dependencies
+ */
+import { fn } from '@storybook/test';
+import {
+	enUS,
+	fr,
+	es,
+	de,
+	it,
+	he,
+	ru,
+	ja,
+	ptBR,
+	nl,
+	ko,
+	tr,
+	id,
+	zhCN,
+	zhTW,
+	ar,
+	sv,
+} from 'date-fns/locale';
+import type { Meta, StoryObj } from '@storybook/react';
+/**
+ * WordPress dependencies
+ */
+import { useState, useEffect } from '@wordpress/element';
+/**
+ * Internal dependencies
+ */
+import { DateRangeCalendar, TZDate } from '..';
+
+const meta: Meta< typeof DateRangeCalendar > = {
+	title: 'Components/Selection & Input/Time & Date/DateRangeCalendar',
+	component: DateRangeCalendar,
+	argTypes: {
+		locale: {
+			options: [
+				'English (US)',
+				'French',
+				'Spanish',
+				'German',
+				'Italian',
+				'Hebrew',
+				'Russian',
+				'Japanese',
+				'Portuguese (Brazil)',
+				'Dutch',
+				'Korean',
+				'Turkish',
+				'Indonesian',
+				'Chinese (Simplified)',
+				'Chinese (Traditional)',
+				'Arabic',
+				'Swedish',
+			],
+			mapping: {
+				'English (US)': enUS,
+				French: fr,
+				Spanish: es,
+				German: de,
+				Italian: it,
+				Hebrew: he,
+				Russian: ru,
+				Japanese: ja,
+				'Portuguese (Brazil)': ptBR,
+				Dutch: nl,
+				Korean: ko,
+				Turkish: tr,
+				Indonesian: id,
+				'Chinese (Simplified)': zhCN,
+				'Chinese (Traditional)': zhTW,
+				Arabic: ar,
+				Swedish: sv,
+			},
+			control: 'select',
+		},
+		timeZone: {
+			options: [
+				'Pacific/Honolulu',
+				'America/New_York',
+				'Europe/London',
+				'Asia/Tokyo',
+				'Pacific/Auckland',
+			],
+			control: 'select',
+		},
+		labels: {
+			control: false,
+		},
+		defaultSelected: { control: false },
+		selected: { control: false },
+		onSelect: {
+			control: false,
+		},
+		defaultMonth: { control: 'date' },
+		month: { control: 'date' },
+		onMonthChange: {
+			control: false,
+		},
+		endMonth: { control: 'date' },
+		startMonth: { control: 'date' },
+	},
+	args: {
+		onMonthChange: fn(),
+		onSelect: fn(),
+	},
+};
+export default meta;
+
+type Story = StoryObj< typeof DateRangeCalendar >;
+
+export const Default: Story = {};
+
+export const DisabledDates: Story = {
+	args: {
+		disabled: [
+			// Disable tomorrow (single date)
+			new Date( new Date().setDate( new Date().getDate() + 1 ) ),
+			// Disable all dates after Feb 1st of next year
+			{ after: new Date( new Date().getFullYear() + 1, 1, 1 ) },
+			// Disable all dates before Dec 1st of last year
+			{ before: new Date( new Date().getFullYear() - 1, 11, 1 ) },
+			// Disable all dates between 12th and 14th of August of this year
+			{
+				after: new Date( new Date().getFullYear(), 7, 11 ),
+				before: new Date( new Date().getFullYear(), 7, 15 ),
+			},
+			// Disable all dates between 21st and 26th of October of this year
+			{
+				from: new Date( new Date().getFullYear(), 9, 21 ),
+				to: new Date( new Date().getFullYear(), 9, 26 ),
+			},
+			// Disable all Wednesdays
+			{ dayOfWeek: 3 },
+			// Disable all prime day numbers
+			function isPrimeDate( date: Date ) {
+				return [ 2, 3, 5, 7, 11, 13, 17, 19, 23, 29, 31 ].includes(
+					date.getDate()
+				);
+			},
+		],
+	},
+};
+
+const nextMonth = new Date().getMonth() === 11 ? 0 : new Date().getMonth() + 1;
+const nextMonthYear =
+	new Date().getMonth() === 11
+		? new Date().getFullYear() + 1
+		: new Date().getFullYear();
+const firstDayOfNextMonth = new Date( nextMonthYear, nextMonth, 1 );
+const fourthDayOfNextMonth = new Date( nextMonthYear, nextMonth, 4 );
+export const WithSelectedRangeAndMonth: Story = {
+	args: {
+		defaultSelected: {
+			from: firstDayOfNextMonth,
+			to: fourthDayOfNextMonth,
+		},
+		defaultMonth: firstDayOfNextMonth,
+	},
+};
+
+/**
+ * When working with time zones, use the `TZDate` object exported by this package instead of the native `Date` object.
+ */
+export const WithTimeZone: Story = {
+	render: function DateCalendarWithTimeZone( args ) {
+		const [ range, setRange ] = useState< typeof args.selected | null >(
+			null
+		);
+
+		useEffect( () => {
+			setRange(
+				// Select from one week from today to two weeks from today
+				// every time the timezone changes.
+				{
+					from: new TZDate(
+						new Date().setDate( new Date().getDate() + 7 ),
+						args.timeZone
+					),
+					to: new TZDate(
+						new Date().setDate( new Date().getDate() + 14 ),
+						args.timeZone
+					),
+				}
+			);
+		}, [ args.timeZone ] );
+
+		return (
+			<>
+				<DateRangeCalendar
+					{ ...args }
+					selected={ range }
+					onSelect={ ( selectedDate, ...rest ) => {
+						setRange(
+							// Set controlled state to null if there's no selection
+							! selectedDate ||
+								( selectedDate.from === undefined &&
+									selectedDate.to === undefined )
+								? null
+								: selectedDate
+						);
+						args.onSelect?.( selectedDate, ...rest );
+					} }
+					disabled={ [
+						{
+							// Disable any date before today
+							before: new TZDate( new Date(), args.timeZone ),
+						},
+					] }
+				/>
+				<p>
+					Calendar set to { args.timeZone ?? 'current' } timezone,
+					disabling selection for all dates before today, and starting
+					with a default date range of 1 week from today to 2 weeks
+					from today.
+				</p>
+			</>
+		);
+	},
+	args: {
+		timeZone: 'Pacific/Auckland',
+	},
+	argTypes: {
+		disabled: {
+			control: false,
+		},
+	},
+};