@react-types/datepicker 3.0.0-nightly.1383 → 3.0.0-nightly.1386

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-types/datepicker",
-  "version": "3.0.0-nightly.1383+df9eb3253",
+  "version": "3.0.0-nightly.1386+7e8a7f696",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "types": "src/index.d.ts",
@@ -9,8 +9,8 @@
     "url": "https://github.com/adobe/react-spectrum"
   },
   "dependencies": {
-    "@internationalized/date": "3.0.0-nightly.3074+df9eb3253",
-    "@react-types/shared": "3.0.0-nightly.1383+df9eb3253"
+    "@internationalized/date": "3.0.0-nightly.3077+7e8a7f696",
+    "@react-types/shared": "3.0.0-nightly.1386+7e8a7f696"
   },
   "publishConfig": {
     "access": "public"
@@ -18,5 +18,5 @@
   "peerDependencies": {
     "react": "^16.8.0 || ^17.0.0-rc.1"
   },
-  "gitHead": "df9eb3253328c2aee23de4ff3d48c63b4d8222e8"
+  "gitHead": "7e8a7f69685139b3574453b424a5ad4c8fa4e808"
 }

package/src/index.d.ts

@@ -34,11 +34,20 @@ type MappedDateValue<T> =
 
 export type Granularity = 'day' | 'hour' | 'minute' | 'second' | 'millisecond';
 interface DatePickerBase<T extends DateValue> extends InputBase, Validation, FocusableProps, LabelableProps, HelpTextProps {
+  /** The minimum allowed date that a user may select. */
   minValue?: DateValue,
+  /** The maximum allowed date that a user may select. */
   maxValue?: DateValue,
+  /** A placeholder date to display when no value is selected. Defaults to today's date at midnight. */
   placeholderValue?: T,
+  /** Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale. */
   hourCycle?: 12 | 24,
+  /** Determines the smallest unit that is displayed in the date picker. By default, this is `"day"` for dates, and `"minute"` for times. */
   granularity?: Granularity,
+  /**
+   * Whether to hide the time zone abbreviation.
+   * @default false
+   */
   hideTimeZone?: boolean
 }
 
@@ -52,13 +61,26 @@ export interface DateRangePickerProps<T extends DateValue> extends DatePickerBas
 export interface AriaDateRangePickerProps<T extends DateValue> extends AriaDatePickerBaseProps<T>, DateRangePickerProps<T> {}
 
 interface SpectrumDatePickerBase<T extends DateValue> extends AriaDatePickerBaseProps<T>, SpectrumLabelableProps, StyleProps {
+  /**
+   * Whether the date picker should be displayed with a quiet style.
+   * @default false
+   */
   isQuiet?: boolean,
+  /**
+   * Whether to show the localized date format as help text below the field.
+   * @default false
+   */
   showFormatHelpText?: boolean,
+  /**
+   * The maximum number of months to display at once in the calendar popover, if screen space permits.
+   * @default 1
+   */
   maxVisibleMonths?: number
 }
 
 export interface SpectrumDatePickerProps<T extends DateValue> extends DatePickerProps<T>, SpectrumDatePickerBase<T> {}
 export interface SpectrumDateRangePickerProps<T extends DateValue> extends DateRangePickerProps<T>, SpectrumDatePickerBase<T> {}
+export interface SpectrumDateFieldProps<T extends DateValue> extends Omit<SpectrumDatePickerProps<T>, 'maxVisibleMonths'> {}
 
 export type TimeValue = Time | CalendarDateTime | ZonedDateTime;
 type MappedTimeValue<T> =
@@ -68,14 +90,27 @@ type MappedTimeValue<T> =
   never;
 
 export interface TimePickerProps<T extends TimeValue> extends InputBase, Validation, FocusableProps, LabelableProps, ValueBase<T, MappedTimeValue<T>> {
+  /** Whether to display the time in 12 or 24 hour format. By default, this is determined by the user's locale. */
   hourCycle?: 12 | 24,
+  /**
+   * Determines the smallest unit that is displayed in the time picker.
+   * @default 'minute'
+   */
   granularity?: 'hour' | 'minute' | 'second' | 'millisecond',
+  /** Whether to hide the time zone abbreviation. */
   hideTimeZone?: boolean,
+  /** A placeholder time to display when no value is selected. Defaults to 12:00 or 00:00 depending on the hour cycle. */
   placeholderValue?: T,
+  /** The minimum allowed time that a user may select. */
   minValue?: TimeValue,
+  /** The maximum allowed time that a user may select. */
   maxValue?: TimeValue
 }
 
 export interface SpectrumTimePickerProps<T extends TimeValue> extends TimePickerProps<T>, SpectrumLabelableProps, DOMProps, StyleProps {
+  /**
+   * Whether the time field should be displayed with a quiet style.
+   * @default false
+   */
   isQuiet?: boolean
 }