@react-types/calendar 3.0.0-nightly.1378 → 3.0.0-nightly.1393

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +4 -4
  2. package/src/index.d.ts +22 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@react-types/calendar",
3
- "version": "3.0.0-nightly.1378+c8381816b",
3
+ "version": "3.0.0-nightly.1393+480974741",
4
4
  "description": "Spectrum UI components in React",
5
5
  "license": "Apache-2.0",
6
6
  "types": "src/index.d.ts",
@@ -9,8 +9,8 @@
9
9
  "url": "https://github.com/adobe/react-spectrum"
10
10
  },
11
11
  "dependencies": {
12
- "@internationalized/date": "3.0.0-nightly.3069+c8381816b",
13
- "@react-types/shared": "3.0.0-nightly.1378+c8381816b"
12
+ "@internationalized/date": "3.0.0-nightly.3084+480974741",
13
+ "@react-types/shared": "3.0.0-nightly.1393+480974741"
14
14
  },
15
15
  "publishConfig": {
16
16
  "access": "public"
@@ -18,5 +18,5 @@
18
18
  "peerDependencies": {
19
19
  "react": "^16.8.0 || ^17.0.0-rc.1"
20
20
  },
21
- "gitHead": "c8381816b644e0a495106e3404637bc9e8aad084"
21
+ "gitHead": "480974741ca38d66a154cecb8f63207b1f015aa9"
22
22
  }
package/src/index.d.ts CHANGED
@@ -21,11 +21,24 @@ type MappedDateValue<T> =
21
21
  never;
22
22
 
23
23
  export interface CalendarPropsBase {
24
- timeZone?: string,
24
+ /** The minimum allowed date that a user may select. */
25
25
  minValue?: DateValue,
26
+ /** The maximum allowed date that a user may select. */
26
27
  maxValue?: DateValue,
28
+ /**
29
+ * Whether the calendar is disabled.
30
+ * @default false
31
+ */
27
32
  isDisabled?: boolean,
33
+ /**
34
+ * Whether the calendar value is immutable.
35
+ * @default false
36
+ */
28
37
  isReadOnly?: boolean,
38
+ /**
39
+ * Whether to automatically focus the calendar when it mounts.
40
+ * @default false
41
+ */
29
42
  autoFocus?: boolean
30
43
  }
31
44
 
@@ -34,9 +47,17 @@ export interface CalendarProps<T extends DateValue> extends CalendarPropsBase, V
34
47
  export interface RangeCalendarProps<T extends DateValue> extends CalendarPropsBase, ValueBase<RangeValue<T>, RangeValue<MappedDateValue<T>>> {}
35
48
 
36
49
  export interface SpectrumCalendarProps<T extends DateValue> extends CalendarProps<T>, DOMProps, StyleProps {
50
+ /**
51
+ * The number of months to display at once. Up to 3 months are supported.
52
+ * @default 1
53
+ */
37
54
  visibleMonths?: number
38
55
  }
39
56
 
40
57
  export interface SpectrumRangeCalendarProps<T extends DateValue> extends RangeCalendarProps<T>, DOMProps, StyleProps {
58
+ /**
59
+ * The number of months to display at once. Up to 3 months are supported.
60
+ * @default 1
61
+ */
41
62
  visibleMonths?: number
42
63
  }