@atlaskit/calendar 14.0.8 → 14.0.10

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 (7) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/calendar.js +1 -1
  3. package/dist/es2019/calendar.js +1 -1
  4. package/dist/esm/calendar.js +1 -1
  5. package/dist/types/types.d.ts +23 -24
  6. package/dist/types-ts4.5/types.d.ts +23 -24
  7. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/calendar
2
2
 
3
+ ## 14.0.10
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 14.0.9
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies
14
+
3
15
  ## 14.0.8
4
16
 
5
17
  ### Patch Changes
package/dist/cjs/calendar.js CHANGED
@@ -34,7 +34,7 @@ var boxStyles = (0, _primitives.xcss)({
34
34
  var analyticsAttributes = {
35
35
  componentName: 'calendar',
36
36
  packageName: "@atlaskit/calendar",
37
- packageVersion: "14.0.8"
37
+ packageVersion: "0.0.0-development"
38
38
  };
39
39
  var InnerCalendar = /*#__PURE__*/(0, _react.forwardRef)(function Calendar(_ref, ref) {
40
40
  var day = _ref.day,
package/dist/es2019/calendar.js CHANGED
@@ -24,7 +24,7 @@ const boxStyles = xcss({
24
24
  const analyticsAttributes = {
25
25
  componentName: 'calendar',
26
26
  packageName: "@atlaskit/calendar",
27
- packageVersion: "14.0.8"
27
+ packageVersion: "0.0.0-development"
28
28
  };
29
29
  const InnerCalendar = /*#__PURE__*/forwardRef(function Calendar({
30
30
  day,
package/dist/esm/calendar.js CHANGED
@@ -28,7 +28,7 @@ var boxStyles = xcss({
28
28
  var analyticsAttributes = {
29
29
  componentName: 'calendar',
30
30
  packageName: "@atlaskit/calendar",
31
- packageVersion: "14.0.8"
31
+ packageVersion: "0.0.0-development"
32
32
  };
33
33
  var InnerCalendar = /*#__PURE__*/forwardRef(function Calendar(_ref, ref) {
34
34
  var day = _ref.day,
package/dist/types/types.d.ts CHANGED
@@ -12,32 +12,31 @@ export type SelectEvent = {
12
12
  } & DateObj;
13
13
  export interface CalendarProps extends WithAnalyticsEventsProps {
14
14
  /**
15
- * The number of the day currently focused. Places border around the date. 0 highlights no date.
15
+ * The number of the day currently focused. Places border around the date. Enter `0` to highlight no date.
16
16
  */
17
17
  day?: number;
18
18
  /**
19
- * Default for `day`.
19
+ * Sets the default value for `day`.
20
20
  */
21
21
  defaultDay?: number;
22
22
  /**
23
- * Default for `month`.
23
+ * Sets the default value for `month`.
24
24
  */
25
25
  defaultMonth?: number;
26
26
  /**
27
- * Default for `previouslySelected`.
27
+ * Sets the default value for `previouslySelected`.
28
28
  */
29
29
  defaultPreviouslySelected?: Array<string>;
30
30
  /**
31
- * Default for `selected`.
31
+ * Sets the default value for `selected`.
32
32
  */
33
33
  defaultSelected?: Array<string>;
34
34
  /**
35
- * Default for `year`.
35
+ * Sets the default value for `year`.
36
36
  */
37
37
  defaultYear?: number;
38
38
  /**
39
- * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates provided are greyed out.
40
- * This does not prevent these dates being selected.
39
+ * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates provided are greyed out and not selectable.
41
40
  */
42
41
  disabled?: Array<string>;
43
42
  /**
@@ -45,11 +44,11 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
45
44
  */
46
45
  disabledDateFilter?: (date: string) => boolean;
47
46
  /**
48
- * The latest enabled date
47
+ * The latest enabled date. All dates in the future after this date will be disabled.
49
48
  */
50
49
  maxDate?: string;
51
50
  /**
52
- * The earliest enabled date
51
+ * The earliest enabled date. All dates in the past before this date will be disabled.
53
52
  */
54
53
  minDate?: string;
55
54
  /**
@@ -57,7 +56,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
57
56
  */
58
57
  month?: number;
59
58
  /**
60
- * The aria-label attribute associated with the next-month arrow.
59
+ * The aria-label attribute associated with the next month arrow, to describe it to assistive technology.
61
60
  */
62
61
  nextMonthLabel?: string;
63
62
  /**
@@ -70,7 +69,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
70
69
  */
71
70
  onChange?: (event: ChangeEvent, analyticsEvent: UIAnalyticsEvent) => void;
72
71
  /**
73
- * Called when the calendar receives focus. This could be from a mouse event on the container by tabbing into it.
72
+ * Called when the calendar receives focus. This could be called from a mouse event on the container, or by tabbing into it.
74
73
  */
75
74
  onFocus?: React.FocusEventHandler;
76
75
  /**
@@ -86,7 +85,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
86
85
  */
87
86
  previouslySelected?: Array<string>;
88
87
  /**
89
- * The aria-label attribute associated with the previous-month arrow.
88
+ * The aria-label attribute associated with the previous month arrow, to describe it to assistive technology.
90
89
  */
91
90
  previousMonthLabel?: string;
92
91
  /**
@@ -103,7 +102,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
103
102
  */
104
103
  year?: number;
105
104
  /**
106
- * BCP 47 language tag (e.g. ja-JP) that ensures dates are in the official format for the locale.
105
+ * BCP 47 language tag (e.g. `ja-JP`) that ensures dates are in the official format for the locale.
107
106
  */
108
107
  locale?: string;
109
108
  /**
@@ -111,14 +110,14 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
111
110
  */
112
111
  analyticsContext?: Record<string, any>;
113
112
  /**
114
- * Start day of the week for the calendar.
115
- * - `0` sunday (default value)
116
- * - `1` monday
117
- * - `2` tuesday
118
- * - `3` wednesday
119
- * - `4` thursday
120
- * - `5` friday
121
- * - `6` saturday
113
+ * Start day of the week for the calendar. The mapping between numbers and days of the week is as follows:
114
+ * - `0` Sunday (default value)
115
+ * - `1` Monday
116
+ * - `2` Tuesday
117
+ * - `3` Wednesday
118
+ * - `4` Thursday
119
+ * - `5` Friday
120
+ * - `6` Saturday
122
121
  */
123
122
  weekStartDay?: WeekDay;
124
123
  /**
@@ -133,11 +132,11 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
133
132
  */
134
133
  testId?: string;
135
134
  /**
136
- * Class name to apply to the calendar
135
+ * Class name to apply to the calendar.
137
136
  */
138
137
  className?: string;
139
138
  /**
140
- * Style customization to apply to the calendar
139
+ * Style customization to apply to the calendar.
141
140
  */
142
141
  style?: CSSProperties;
143
142
  /**
package/dist/types-ts4.5/types.d.ts CHANGED
@@ -12,32 +12,31 @@ export type SelectEvent = {
12
12
  } & DateObj;
13
13
  export interface CalendarProps extends WithAnalyticsEventsProps {
14
14
  /**
15
- * The number of the day currently focused. Places border around the date. 0 highlights no date.
15
+ * The number of the day currently focused. Places border around the date. Enter `0` to highlight no date.
16
16
  */
17
17
  day?: number;
18
18
  /**
19
- * Default for `day`.
19
+ * Sets the default value for `day`.
20
20
  */
21
21
  defaultDay?: number;
22
22
  /**
23
- * Default for `month`.
23
+ * Sets the default value for `month`.
24
24
  */
25
25
  defaultMonth?: number;
26
26
  /**
27
- * Default for `previouslySelected`.
27
+ * Sets the default value for `previouslySelected`.
28
28
  */
29
29
  defaultPreviouslySelected?: Array<string>;
30
30
  /**
31
- * Default for `selected`.
31
+ * Sets the default value for `selected`.
32
32
  */
33
33
  defaultSelected?: Array<string>;
34
34
  /**
35
- * Default for `year`.
35
+ * Sets the default value for `year`.
36
36
  */
37
37
  defaultYear?: number;
38
38
  /**
39
- * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates provided are greyed out.
40
- * This does not prevent these dates being selected.
39
+ * Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates provided are greyed out and not selectable.
41
40
  */
42
41
  disabled?: Array<string>;
43
42
  /**
@@ -45,11 +44,11 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
45
44
  */
46
45
  disabledDateFilter?: (date: string) => boolean;
47
46
  /**
48
- * The latest enabled date
47
+ * The latest enabled date. All dates in the future after this date will be disabled.
49
48
  */
50
49
  maxDate?: string;
51
50
  /**
52
- * The earliest enabled date
51
+ * The earliest enabled date. All dates in the past before this date will be disabled.
53
52
  */
54
53
  minDate?: string;
55
54
  /**
@@ -57,7 +56,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
57
56
  */
58
57
  month?: number;
59
58
  /**
60
- * The aria-label attribute associated with the next-month arrow.
59
+ * The aria-label attribute associated with the next month arrow, to describe it to assistive technology.
61
60
  */
62
61
  nextMonthLabel?: string;
63
62
  /**
@@ -70,7 +69,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
70
69
  */
71
70
  onChange?: (event: ChangeEvent, analyticsEvent: UIAnalyticsEvent) => void;
72
71
  /**
73
- * Called when the calendar receives focus. This could be from a mouse event on the container by tabbing into it.
72
+ * Called when the calendar receives focus. This could be called from a mouse event on the container, or by tabbing into it.
74
73
  */
75
74
  onFocus?: React.FocusEventHandler;
76
75
  /**
@@ -86,7 +85,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
86
85
  */
87
86
  previouslySelected?: Array<string>;
88
87
  /**
89
- * The aria-label attribute associated with the previous-month arrow.
88
+ * The aria-label attribute associated with the previous month arrow, to describe it to assistive technology.
90
89
  */
91
90
  previousMonthLabel?: string;
92
91
  /**
@@ -103,7 +102,7 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
103
102
  */
104
103
  year?: number;
105
104
  /**
106
- * BCP 47 language tag (e.g. ja-JP) that ensures dates are in the official format for the locale.
105
+ * BCP 47 language tag (e.g. `ja-JP`) that ensures dates are in the official format for the locale.
107
106
  */
108
107
  locale?: string;
109
108
  /**
@@ -111,14 +110,14 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
111
110
  */
112
111
  analyticsContext?: Record<string, any>;
113
112
  /**
114
- * Start day of the week for the calendar.
115
- * - `0` sunday (default value)
116
- * - `1` monday
117
- * - `2` tuesday
118
- * - `3` wednesday
119
- * - `4` thursday
120
- * - `5` friday
121
- * - `6` saturday
113
+ * Start day of the week for the calendar. The mapping between numbers and days of the week is as follows:
114
+ * - `0` Sunday (default value)
115
+ * - `1` Monday
116
+ * - `2` Tuesday
117
+ * - `3` Wednesday
118
+ * - `4` Thursday
119
+ * - `5` Friday
120
+ * - `6` Saturday
122
121
  */
123
122
  weekStartDay?: WeekDay;
124
123
  /**
@@ -133,11 +132,11 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
133
132
  */
134
133
  testId?: string;
135
134
  /**
136
- * Class name to apply to the calendar
135
+ * Class name to apply to the calendar.
137
136
  */
138
137
  className?: string;
139
138
  /**
140
- * Style customization to apply to the calendar
139
+ * Style customization to apply to the calendar.
141
140
  */
142
141
  style?: CSSProperties;
143
142
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/calendar",
3
- "version": "14.0.8",
3
+ "version": "14.0.10",
4
4
  "description": "An interactive calendar for date selection experiences.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -27,15 +27,15 @@
27
27
  },
28
28
  "dependencies": {
29
29
  "@atlaskit/analytics-next": "^9.2.0",
30
- "@atlaskit/button": "^17.4.0",
30
+ "@atlaskit/button": "^17.6.0",
31
31
  "@atlaskit/ds-explorations": "^3.2.0",
32
32
  "@atlaskit/ds-lib": "^2.2.0",
33
33
  "@atlaskit/heading": "^1.6.0",
34
- "@atlaskit/icon": "^22.0.0",
34
+ "@atlaskit/icon": "^22.1.0",
35
35
  "@atlaskit/locale": "^2.6.0",
36
- "@atlaskit/primitives": "^2.0.0",
36
+ "@atlaskit/primitives": "^4.0.0",
37
37
  "@atlaskit/theme": "^12.6.0",
38
- "@atlaskit/tokens": "^1.37.0",
38
+ "@atlaskit/tokens": "^1.39.0",
39
39
  "@babel/runtime": "^7.0.0",
40
40
  "@emotion/react": "^11.7.1",
41
41
  "date-fns": "^2.17.0",