@atlaskit/calendar 12.2.0 → 12.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @atlaskit/calendar
 
+## 12.3.0
+
+### Minor Changes
+
+- [`e1e33cfe0db`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e1e33cfe0db) - [ux] Adds tabIndex prop for `@atlaskit/calendar`, useful when needing to disable calendar from receiving focus by keyboard.
+
 ## 12.2.0
 
 ### Minor Changes

package/dist/cjs/calendar.js

@@ -83,7 +83,7 @@ var gridsContainerStyles = (0, _core.css)({
 var analyticsAttributes = {
   componentName: 'calendar',
   packageName: "@atlaskit/calendar",
-  packageVersion: "12.2.0"
+  packageVersion: "12.3.0"
 };
 var CalendarWithMode = /*#__PURE__*/(0, _react.forwardRef)(function Calendar(_ref, ref) {
   var day = _ref.day,
@@ -125,7 +125,9 @@ var CalendarWithMode = /*#__PURE__*/(0, _react.forwardRef)(function Calendar(_re
       calendarRef = _ref.calendarRef,
       mode = _ref.mode,
       className = _ref.className,
-      style = _ref.style;
+      style = _ref.style,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
 
   var _useControlledDateSta = (0, _useControlledDateState.default)({
     day: day,
@@ -245,7 +247,7 @@ var CalendarWithMode = /*#__PURE__*/(0, _react.forwardRef)(function Calendar(_re
     "aria-describedby": announceId,
     "aria-label": "calendar",
     role: "grid",
-    tabIndex: 0
+    tabIndex: tabIndex
   }, (0, _core.jsx)(_heading.default // The month number needs to be translated to index in the month
   // name array e.g. 1 (January) -> 0
   , {

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/calendar",
-	"version": "12.2.0",
+	"version": "12.3.0",
 	"sideEffects": false
 }

package/dist/es2019/calendar.js

@@ -48,7 +48,7 @@ const gridsContainerStyles = css({
 const analyticsAttributes = {
   componentName: 'calendar',
   packageName: "@atlaskit/calendar",
-  packageVersion: "12.2.0"
+  packageVersion: "12.3.0"
 };
 const CalendarWithMode = /*#__PURE__*/forwardRef(function Calendar({
   day,
@@ -79,7 +79,8 @@ const CalendarWithMode = /*#__PURE__*/forwardRef(function Calendar({
   calendarRef,
   mode,
   className,
-  style
+  style,
+  tabIndex = 0
 }, ref) {
   const {
     day: [dayValue, setDayValue],
@@ -185,7 +186,7 @@ const CalendarWithMode = /*#__PURE__*/forwardRef(function Calendar({
     "aria-describedby": announceId,
     "aria-label": "calendar",
     role: "grid",
-    tabIndex: 0
+    tabIndex: tabIndex
   }, jsx(HeadingComponent // The month number needs to be translated to index in the month
   // name array e.g. 1 (January) -> 0
   , {

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/calendar",
-	"version": "12.2.0",
+	"version": "12.3.0",
 	"sideEffects": false
 }

package/dist/esm/calendar.js

@@ -54,7 +54,7 @@ var gridsContainerStyles = css({
 var analyticsAttributes = {
   componentName: 'calendar',
   packageName: "@atlaskit/calendar",
-  packageVersion: "12.2.0"
+  packageVersion: "12.3.0"
 };
 var CalendarWithMode = /*#__PURE__*/forwardRef(function Calendar(_ref, ref) {
   var day = _ref.day,
@@ -96,7 +96,9 @@ var CalendarWithMode = /*#__PURE__*/forwardRef(function Calendar(_ref, ref) {
       calendarRef = _ref.calendarRef,
       mode = _ref.mode,
       className = _ref.className,
-      style = _ref.style;
+      style = _ref.style,
+      _ref$tabIndex = _ref.tabIndex,
+      tabIndex = _ref$tabIndex === void 0 ? 0 : _ref$tabIndex;
 
   var _useControlledDateSta = useControlledDateState({
     day: day,
@@ -216,7 +218,7 @@ var CalendarWithMode = /*#__PURE__*/forwardRef(function Calendar(_ref, ref) {
     "aria-describedby": announceId,
     "aria-label": "calendar",
     role: "grid",
-    tabIndex: 0
+    tabIndex: tabIndex
   }, jsx(HeadingComponent // The month number needs to be translated to index in the month
   // name array e.g. 1 (January) -> 0
   , {

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/calendar",
-	"version": "12.2.0",
+	"version": "12.3.0",
 	"sideEffects": false
 }

package/dist/types/calendar.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="react" />
 import type { CalendarProps } from './types';
-declare const Calendar: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Pick<CalendarProps, "year" | "previousMonthLabel" | "nextMonthLabel" | "mode" | "testId" | "style" | "disabled" | "selected" | "className" | "onFocus" | "onBlur" | "onChange" | "onSelect" | "analyticsContext" | "day" | "month" | "defaultDay" | "defaultMonth" | "defaultYear" | "today" | "defaultSelected" | "previouslySelected" | "defaultPreviouslySelected" | "weekStartDay" | "disabledDateFilter" | "minDate" | "maxDate" | "locale" | "calendarRef" | "createAnalyticsEvent"> & import("react").RefAttributes<HTMLDivElement>>>;
+declare const Calendar: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<Pick<CalendarProps, "year" | "previousMonthLabel" | "nextMonthLabel" | "mode" | "testId" | "style" | "disabled" | "selected" | "className" | "tabIndex" | "onFocus" | "onBlur" | "onChange" | "onSelect" | "analyticsContext" | "day" | "month" | "defaultDay" | "defaultMonth" | "defaultYear" | "today" | "defaultSelected" | "previouslySelected" | "defaultPreviouslySelected" | "weekStartDay" | "disabledDateFilter" | "minDate" | "maxDate" | "locale" | "calendarRef" | "createAnalyticsEvent"> & import("react").RefAttributes<HTMLDivElement>>>;
 export default Calendar;

package/dist/types/types.d.ts

@@ -103,6 +103,10 @@ export interface CalendarProps extends WithAnalyticsEventsProps {
      * @internal Legacy theme mode, can be either 'light' or 'dark'
      */
     mode?: ThemeModes;
+    /**
+     * Tab index indicates if the calendar can be focused by keyboard or only programmatically.
+     */
+    tabIndex?: number;
 }
 export interface CalendarRef {
     navigate: (type: ArrowKeys) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/calendar",
-  "version": "12.2.0",
+  "version": "12.3.0",
   "description": "An interactive calendar for date selection experiences.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/report.api.md

@@ -0,0 +1,175 @@
+## API Report File for "@atlaskit/calendar"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+/// <reference types="react" />
+
+import { CSSProperties } from 'react';
+import { ForwardRefExoticComponent } from 'react';
+import { MemoExoticComponent } from 'react';
+import { RefAttributes } from 'react';
+import { ThemeModes } from '@atlaskit/theme/types';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
+
+declare type ArrowKeys = 'left' | 'up' | 'right' | 'down';
+
+declare const Calendar: MemoExoticComponent<ForwardRefExoticComponent<
+  Pick<
+    CalendarProps,
+    | 'year'
+    | 'previousMonthLabel'
+    | 'nextMonthLabel'
+    | 'mode'
+    | 'testId'
+    | 'style'
+    | 'disabled'
+    | 'selected'
+    | 'className'
+    | 'onFocus'
+    | 'onBlur'
+    | 'onChange'
+    | 'onSelect'
+    | 'analyticsContext'
+    | 'day'
+    | 'month'
+    | 'defaultDay'
+    | 'defaultMonth'
+    | 'defaultYear'
+    | 'today'
+    | 'defaultSelected'
+    | 'previouslySelected'
+    | 'defaultPreviouslySelected'
+    | 'weekStartDay'
+    | 'disabledDateFilter'
+    | 'minDate'
+    | 'maxDate'
+    | 'locale'
+    | 'calendarRef'
+    | 'createAnalyticsEvent'
+  > &
+    RefAttributes<HTMLDivElement>
+>>;
+export default Calendar;
+
+export declare interface CalendarProps extends WithAnalyticsEventsProps {
+  /** The number of the day currently focused. Places border around the date. 0 highlights no date. */
+  day?: number;
+  /** Default for `day`. */
+  defaultDay?: number;
+  /** Default for `month`. */
+  defaultMonth?: number;
+  /** Default for `previouslySelected`. */
+  defaultPreviouslySelected?: Array<string>;
+  /** Default for `selected`. */
+  defaultSelected?: Array<string>;
+  /** Default for `year`. */
+  defaultYear?: number;
+  /** Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates provided are greyed out.
+     This does not prevent these dates being selected. */
+  disabled?: Array<string>;
+  /** A filter function that takes a date string in the format 'YYYY-MM-DD' and returns true if that date should be disabled. */
+  disabledDateFilter?: (date: string) => boolean;
+  /** The latest enabled date */
+  maxDate?: string;
+  /** The earliest enabled date */
+  minDate?: string;
+  /** The number of the month (from 1 to 12) which the calendar should be on. */
+  month?: number;
+  /** The aria-label attribute associated with the next-month arrow. */
+  nextMonthLabel?: string;
+  /** Function which is called when the calendar is no longer focused. */
+  onBlur?: React.FocusEventHandler;
+  /** Called when the calendar is navigated. This can be triggered by the keyboard, or by clicking the navigational buttons.
+     The 'interface' property indicates the the direction the calendar was navigated whereas the 'iso' property is a string of the format YYYY-MM-DD. */
+  onChange?: (event: ChangeEvent, analyticsEvent: UIAnalyticsEvent) => void;
+  /** Called when the calendar receives focus. This could be from a mouse event on the container by tabbing into it. */
+  onFocus?: React.FocusEventHandler;
+  /** Function called when a day is clicked on. Calls with an object that has
+     a day, month and year property as numbers, representing the date just clicked.
+     It also has an 'iso' property, which is a string of the selected date in the
+     format YYYY-MM-DD. */
+  onSelect?: (event: SelectEvent, analyticsEvent: UIAnalyticsEvent) => void;
+  /** Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates
+     provided are given a background color. */
+  previouslySelected?: Array<string>;
+  /** The aria-label attribute associated with the previous-month arrow. */
+  previousMonthLabel?: string;
+  /** Takes an array of dates as string in the format 'YYYY-MM-DD'. All dates
+     provided are given a background color. */
+  selected?: Array<string>;
+  /** Value of current day, as a string in the format 'YYYY-MM-DD'. */
+  today?: string;
+  /** Year to display the calendar for. */
+  year?: number;
+  /** BCP 47 language tag (e.g. ja-JP) that ensures dates are in the official format for the locale. */
+  locale?: string;
+  /** Additional information to be included in the `context` of analytics events. */
+  analyticsContext?: Record<string, any>;
+  /**
+   * Start day of the week for the calendar.
+   * - `0` sunday (default value)
+   * - `1` monday
+   * - `2` tuesday
+   * - `3` wednesday
+   * - `4` thursday
+   * - `5` friday
+   * - `6` saturday
+   */
+  weekStartDay?: WeekDay;
+  /**
+   * A `testId` prop is provided for specified elements, which is a unique string that appears as a data attribute `data-testid` in the rendered code, serving as a hook for automated tests
+   *
+   * testId--container - Outermost container containing everything inside calendar
+   * testId--month - Container containing all available days for the month
+   * testId--previous-month - Button to show next month
+   * testId--next-month - Button to show previous month
+   * testId--current-month-year - Text containing the current month and year
+   * testId--selected-day - The currently selected day (may be missing if a date isn’t selected)
+   * */
+  testId?: string;
+  /**
+   * Class name to apply to the calendar
+   */
+  className?: string;
+  /**
+   * Style customization to apply to the calendar
+   */
+  style?: CSSProperties;
+  /**
+   * @internal An additional ref which exposes Calendar's internal api's. We kept this for
+   * backward compatibility. PLEASE DO NOT USE THIS.
+   */
+  calendarRef?: React.Ref<CalendarRef>;
+  /**
+   * @internal Legacy theme mode, can be either 'light' or 'dark'
+   */
+  mode?: ThemeModes;
+}
+
+export declare interface CalendarRef {
+  navigate: (type: ArrowKeys) => void;
+}
+
+export declare type ChangeEvent = {
+  iso: ISODate;
+  type: 'left' | 'up' | 'right' | 'down' | 'prev' | 'next';
+} & DateObj;
+
+declare type DateObj = {
+  day: number;
+  month: number;
+  year: number;
+};
+
+declare type ISODate = string;
+
+export declare type SelectEvent = {
+  iso: ISODate;
+} & DateObj;
+
+declare type WeekDay = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+
+export {};
+```