@react-aria/calendar 3.0.0-nightly.3142 → 3.0.0-nightly.3148

package/src/useCalendarCell.ts

@@ -17,20 +17,45 @@ import {HTMLAttributes, RefObject, useEffect, useMemo, useRef} from 'react';
 // @ts-ignore
 import intlMessages from '../intl/*.json';
 import {mergeProps} from '@react-aria/utils';
-import {PressProps, usePress} from '@react-aria/interactions';
 import {useDateFormatter, useMessageFormatter} from '@react-aria/i18n';
+import {usePress} from '@react-aria/interactions';
 
 export interface AriaCalendarCellProps {
+  /** The date that this cell represents. */
   date: CalendarDate,
+  /**
+   * Whether the cell is disabled. By default, this is determined by the
+   * Calendar's `minValue`, `maxValue`, and `isDisabled` props.
+   */
   isDisabled?: boolean
 }
 
 interface CalendarCellAria {
-  cellProps: PressProps & HTMLAttributes<HTMLElement>,
+  /** Props for the grid cell element (e.g. `<td>`). */
+  cellProps: HTMLAttributes<HTMLElement>,
+  /** Props for the button element within the cell. */
   buttonProps: HTMLAttributes<HTMLElement>,
-  isPressed: boolean
+  /** Whether the cell is currently being pressed. */
+  isPressed: boolean,
+  /** Whether the cell is selected. */
+  isSelected: boolean,
+  /** Whether the cell is focused. */
+  isFocused: boolean,
+  /** Whether the cell is disabled. */
+  isDisabled: boolean,
+  /**
+   * Whether the cell is outside the visible range of the calendar.
+   * For example, dates before the first day of a month in the same week.
+   */
+  isOutsideVisibleRange: boolean,
+  /** The day number formatted according to the current locale. */
+  formattedDate: string
 }
 
+/**
+ * Provides the behavior and accessibility implementation for a calendar cell component.
+ * A calendar cell displays a date cell within a calendar grid which can be selected by the user.
+ */
 export function useCalendarCell(props: AriaCalendarCellProps, state: CalendarState | RangeCalendarState, ref: RefObject<HTMLElement>): CalendarCellAria {
   let {date, isDisabled} = props;
   let formatMessage = useMessageFormatter(intlMessages);
@@ -204,6 +229,14 @@ export function useCalendarCell(props: AriaCalendarCellProps, state: CalendarSta
     }
   }, [isFocused, ref]);
 
+  let cellDateFormatter = useDateFormatter({
+    day: 'numeric',
+    timeZone: state.timeZone,
+    calendar: date.calendar.identifier
+  });
+
+  let formattedDate = useMemo(() => cellDateFormatter.format(nativeDate), [cellDateFormatter, nativeDate]);
+
   return {
     cellProps: {
       role: 'gridcell',
@@ -239,6 +272,11 @@ export function useCalendarCell(props: AriaCalendarCellProps, state: CalendarSta
         e.preventDefault();
       }
     }),
-    isPressed
+    isPressed,
+    isFocused,
+    isSelected,
+    isDisabled,
+    isOutsideVisibleRange: date.compare(state.visibleRange.start) < 0 || date.compare(state.visibleRange.end) > 0,
+    formattedDate
   };
 }

package/src/useCalendarGrid.ts

@@ -10,24 +10,36 @@
  * governing permissions and limitations under the License.
  */
 
-import {CalendarDate} from '@internationalized/date';
+import {CalendarDate, startOfWeek} from '@internationalized/date';
 import {CalendarGridAria} from './types';
 import {calendarIds, useSelectedDateDescription, useVisibleRangeDescription} from './utils';
-import {CalendarPropsBase} from '@react-types/calendar';
 import {CalendarState, RangeCalendarState} from '@react-stately/calendar';
 import {KeyboardEvent} from 'react';
 import {mergeProps, useDescription, useLabels} from '@react-aria/utils';
-import {useLocale} from '@react-aria/i18n';
+import {useDateFormatter, useLocale} from '@react-aria/i18n';
 
-interface CalendarGridProps extends CalendarPropsBase {
+interface CalendarGridProps {
+  /**
+   * The first date displayed in the calendar grid.
+   * Defaults to the first visible date in the calendar.
+   * Override this to display multiple date grids in a calendar.
+   */
   startDate?: CalendarDate,
+  /**
+   * The last date displayed in the calendar grid.
+   * Defaults to the last visible date in the calendar.
+   * Override this to display multiple date grids in a calendar.
+   */
   endDate?: CalendarDate
 }
 
+/**
+ * Provides the behavior and accessibility implementation for a calendar grid component.
+ * A calendar grid displays a single grid of days within a calendar or range calendar which
+ * can be keyboard navigated and selected by the user.
+ */
 export function useCalendarGrid(props: CalendarGridProps, state: CalendarState | RangeCalendarState): CalendarGridAria {
   let {
-    isReadOnly = false,
-    isDisabled = false,
     startDate = state.visibleRange.start,
     endDate = state.visibleRange.end
   } = props;
@@ -108,15 +120,31 @@ export function useCalendarGrid(props: CalendarGridProps, state: CalendarState |
     'aria-labelledby': calendarIds.get(state)
   });
 
+  let dayFormatter = useDateFormatter({weekday: 'narrow'});
+  let dayFormatterLong = useDateFormatter({weekday: 'long'});
+  let {locale} = useLocale();
+  let weekStart = startOfWeek(state.visibleRange.start, locale);
+  let weekDays = [...new Array(7).keys()].map((index) => {
+    let date = weekStart.add({days: index});
+    let dateDay = date.toDate(state.timeZone);
+    let narrow = dayFormatter.format(dateDay);
+    let long = dayFormatterLong.format(dateDay);
+    return {
+      narrow,
+      long
+    };
+  });
+
   return {
     gridProps: mergeProps(descriptionProps, labelProps, {
       role: 'grid',
-      'aria-readonly': isReadOnly || null,
-      'aria-disabled': isDisabled || null,
+      'aria-readonly': state.isReadOnly || null,
+      'aria-disabled': state.isDisabled || null,
       'aria-multiselectable': ('highlightedRange' in state) || undefined,
       onKeyDown,
       onFocus: () => state.setFocused(true),
       onBlur: () => state.setFocused(false)
-    })
+    }),
+    weekDays
   };
 }

package/src/useRangeCalendar.ts

@@ -17,6 +17,10 @@ import {RefObject, useRef} from 'react';
 import {useCalendarBase} from './useCalendarBase';
 import {useEvent, useId} from '@react-aria/utils';
 
+/**
+ * Provides the behavior and accessibility implementation for a range calendar component.
+ * A range calendar displays one or more date grids and allows users to select a contiguous range of dates.
+ */
 export function useRangeCalendar<T extends DateValue>(props: RangeCalendarProps<T>, state: RangeCalendarState, ref: RefObject<HTMLElement>): CalendarAria {
   let res = useCalendarBase(props, state);
   res.nextButtonProps.id = useId();

package/src/useCalendarTableHeader.ts

@@ -1,11 +0,0 @@
-interface CalendarTableHeaderAria {
-  columnHeaderProps: {scope?: 'col'}
-}
-
-export function useCalendarTableHeader(): CalendarTableHeaderAria {
-  return {
-    columnHeaderProps: {
-      scope: 'col'
-    }
-  };
-}