@react-types/datepicker - npm Package Compare versions

Comparing version 3.0.0-alpha.1 to 3.0.0-alpha.2

package.json

 {
   "name": "@react-types/datepicker",
-  "version": "3.0.0-alpha.1",
+  "version": "3.0.0-alpha.2",
   "description": "Spectrum UI components in React",
@@ -12,4 +12,4 @@ "license": "Apache-2.0",
   "dependencies": {
-    "@internationalized/date": "3.0.0-alpha.1",
-    "@react-types/shared": "^3.10.0"
+    "@internationalized/date": "3.0.0-alpha.2",
+    "@react-types/shared": "^3.11.0"
   },
@@ -22,3 +22,3 @@ "publishConfig": {
   },
-  "gitHead": "16fc29ac722793ffaea083f13760d82ab341cc8d"
+  "gitHead": "54c2366c4f31bd4bf619126131cd583c12972acc"
 }

src/index.d.ts

@@ -37,7 +37,16 @@ /*
 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
@@ -56,4 +65,16 @@ }
 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
@@ -64,2 +85,3 @@ }
 export interface SpectrumDateRangePickerProps<T extends DateValue> extends DateRangePickerProps<T>, SpectrumDatePickerBase<T> {}
+export interface SpectrumDateFieldProps<T extends DateValue> extends Omit<SpectrumDatePickerProps<T>, 'maxVisibleMonths'> {}
 
@@ -74,7 +96,16 @@ export type TimeValue = Time | CalendarDateTime | ZonedDateTime;
 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
@@ -84,3 +115,7 @@ }
 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
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

17056

increased by10.61%

Lines of code

105

increased by50%

Dependency changes

• + Added@internationalized/date@3.0.0-alpha.2(transitive)

• - Removed@internationalized/date@3.0.0-alpha.1(transitive)

• Updated@internationalized/date@3.0.0-alpha.2

• Updated@react-types/shared@^3.11.0