@atlaskit/tabs 13.4.0 → 13.4.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/tabs
 
+## 13.4.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
+## 13.4.1
+
+### Patch Changes
+
+- [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
+
 ## 13.4.0
 
 ### Minor Changes

package/dist/cjs/components/tabs.js

@@ -21,7 +21,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 var analyticsAttributes = {
   componentName: 'tabs',
   packageName: "@atlaskit/tabs",
-  packageVersion: "13.4.0"
+  packageVersion: "13.4.2"
 };
 var getTabPanelWithContext = function getTabPanelWithContext(_ref) {
   var tabPanel = _ref.tabPanel,

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/tabs",
-	"version": "13.4.0",
+	"version": "13.4.2",
 	"sideEffects": false
 }

package/dist/es2019/components/tabs.js

@@ -10,7 +10,7 @@ import { onMouseDownBlur } from '../internal/utils';
 const analyticsAttributes = {
   componentName: 'tabs',
   packageName: "@atlaskit/tabs",
-  packageVersion: "13.4.0"
+  packageVersion: "13.4.2"
 };
 const getTabPanelWithContext = ({
   tabPanel,

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/tabs",
-	"version": "13.4.0",
+	"version": "13.4.2",
 	"sideEffects": false
 }

package/dist/esm/components/tabs.js

@@ -15,7 +15,7 @@ import { onMouseDownBlur } from '../internal/utils';
 var analyticsAttributes = {
   componentName: 'tabs',
   packageName: "@atlaskit/tabs",
-  packageVersion: "13.4.0"
+  packageVersion: "13.4.2"
 };
 var getTabPanelWithContext = function getTabPanelWithContext(_ref) {
   var tabPanel = _ref.tabPanel,

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/tabs",
-	"version": "13.4.0",
+	"version": "13.4.2",
 	"sideEffects": false
 }

package/dist/types/internal/colors.d.ts

@@ -1,5 +1,5 @@
 import { ThemeModes } from '@atlaskit/theme/types';
-export declare type TabColors = {
+export type TabColors = {
     labelColor: string;
     activeLabelColor: string;
     hoverLabelColor: string;
@@ -7,7 +7,7 @@ export declare type TabColors = {
     focusBorderColor: string;
 };
 export declare const getTabColors: (mode: ThemeModes) => TabColors;
-export declare type TabLineColors = {
+export type TabLineColors = {
     lineColor: string;
     hoveredColor: string;
     activeColor: string;

package/dist/types/types.d.ts

@@ -56,8 +56,8 @@ export interface TabData {
      */
     [key: string]: any;
 }
-export declare type SelectedType = number;
-export declare type OnChangeCallback = (index: SelectedType, analyticsEvent: UIAnalyticsEvent) => void;
+export type SelectedType = number;
+export type OnChangeCallback = (index: SelectedType, analyticsEvent: UIAnalyticsEvent) => void;
 export interface TabsProps extends WithAnalyticsEventsProps {
     /**
      * The index of the tab that will be selected by default when the component mounts.
@@ -108,7 +108,7 @@ export interface TabListProps {
      */
     children: ReactNode;
 }
-export declare type TabAttributesType = {
+export type TabAttributesType = {
     /**
      * Changes the selected tab.
      */
@@ -152,7 +152,7 @@ export declare type TabAttributesType = {
      */
     tabIndex: number;
 };
-export declare type TabListAttributesType = {
+export type TabListAttributesType = {
     /**
      * The index of the selected tab.
      */
@@ -167,7 +167,7 @@ export declare type TabListAttributesType = {
      */
     onChange: (index: SelectedType) => void;
 };
-export declare type TabPanelAttributesType = {
+export type TabPanelAttributesType = {
     /**
      * Role is "tabpanel".
      */

package/dist/types-ts4.5/components/tab-list.d.ts

@@ -0,0 +1,13 @@
+import { jsx } from '@emotion/react';
+import { TabListProps } from '../types';
+/**
+ * __TabList__
+ *
+ * A TabList groups `Tab` components together.
+ *
+ * - [Examples](https://atlassian.design/components/tabs/examples)
+ * - [Code](https://atlassian.design/components/tabs/code)
+ * - [Usage](https://atlassian.design/components/tabs/usage)
+ */
+declare const TabList: (props: TabListProps) => jsx.JSX.Element;
+export default TabList;

package/dist/types-ts4.5/components/tab-panel.d.ts

@@ -0,0 +1,13 @@
+import { jsx } from '@emotion/react';
+import { TabPanelProps } from '../types';
+/**
+ * __TabPanel__
+ *
+ * A TabPanel houses the contents of a Tab.
+ *
+ * - [Examples](https://atlassian.design/components/tabs/examples)
+ * - [Code](https://atlassian.design/components/tabs/code)
+ * - [Usage](https://atlassian.design/components/tabs/usage)
+ */
+declare const TabPanel: ({ children, testId }: TabPanelProps) => jsx.JSX.Element;
+export default TabPanel;

package/dist/types-ts4.5/components/tab.d.ts

@@ -0,0 +1,13 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { TabProps } from '../types';
+/**
+ * __Tab__
+ *
+ * Tab represents an indivudal Tab displayed in a TabList.
+ *
+ * - [Examples](https://atlassian.design/components/tabs/examples)
+ * - [Code](https://atlassian.design/components/tabs/code)
+ * - [Usage](https://atlassian.design/components/tabs/usage)
+ */
+export default function Tab({ children, testId }: TabProps): jsx.JSX.Element;

package/dist/types-ts4.5/components/tabs.d.ts

@@ -0,0 +1,13 @@
+import { jsx } from '@emotion/react';
+import { TabsProps } from '../types';
+/**
+ * __Tabs__
+ *
+ * Tabs acts as a container for all Tab components.
+ *
+ * - [Examples](https://atlassian.design/components/tabs/examples)
+ * - [Code](https://atlassian.design/components/tabs/code)
+ * - [Usage](https://atlassian.design/components/tabs/usage)
+ */
+declare const Tabs: (props: TabsProps) => jsx.JSX.Element;
+export default Tabs;

package/dist/types-ts4.5/hooks.d.ts

@@ -0,0 +1,3 @@
+export declare const useTab: () => import("./types").TabAttributesType;
+export declare const useTabList: () => import("./types").TabListAttributesType;
+export declare const useTabPanel: () => import("./types").TabPanelAttributesType;

package/dist/types-ts4.5/index.d.ts

@@ -0,0 +1,6 @@
+export { default } from './components/tabs';
+export { default as TabPanel } from './components/tab-panel';
+export { default as Tab } from './components/tab';
+export { default as TabList } from './components/tab-list';
+export type { TabProps, TabPanelProps, TabsProps, TabListProps, TabAttributesType, TabListAttributesType, TabPanelAttributesType, TabData, } from './types';
+export { useTab, useTabPanel } from './hooks';

package/dist/types-ts4.5/internal/colors.d.ts

@@ -0,0 +1,17 @@
+import { ThemeModes } from '@atlaskit/theme/types';
+export type TabColors = {
+    labelColor: string;
+    activeLabelColor: string;
+    hoverLabelColor: string;
+    selectedColor: string;
+    focusBorderColor: string;
+};
+export declare const getTabColors: (mode: ThemeModes) => TabColors;
+export type TabLineColors = {
+    lineColor: string;
+    hoveredColor: string;
+    activeColor: string;
+    selectedColor: string;
+};
+export declare const getTabLineColor: (mode: ThemeModes) => TabLineColors;
+export declare const getTabPanelFocusColor: (mode: ThemeModes) => string;

package/dist/types-ts4.5/internal/context.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { TabAttributesType, TabListAttributesType, TabPanelAttributesType } from '../types';
+export declare const TabContext: import("react").Context<TabAttributesType | null>;
+export declare const TabListContext: import("react").Context<TabListAttributesType | null>;
+export declare const TabPanelContext: import("react").Context<TabPanelAttributesType | null>;

package/dist/types-ts4.5/internal/styles.d.ts

@@ -0,0 +1,5 @@
+import { CSSObject, SerializedStyles } from '@emotion/react';
+import { ThemeModes } from '@atlaskit/theme/types';
+export declare const getTabsStyles: (mode: ThemeModes) => SerializedStyles;
+export declare const getTabListStyles: (mode: ThemeModes) => SerializedStyles;
+export declare const getTabStyles: (mode: ThemeModes) => CSSObject;

package/dist/types-ts4.5/internal/utils.d.ts

@@ -0,0 +1,2 @@
+import type { MouseEvent } from 'react';
+export declare const onMouseDownBlur: (e: MouseEvent<HTMLElement>) => void;

package/dist/types-ts4.5/performance/examples.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="react" />
+import type { PublicInteractionTask } from 'storybook-addon-performance';
+export declare const performance: {
+    (): JSX.Element;
+    story: {
+        name: string;
+        parameters: {
+            performance: {
+                interactions: PublicInteractionTask[];
+            };
+        };
+    };
+};
+export declare const heavyPerformance: {
+    (): JSX.Element;
+    story: {
+        name: string;
+        parameters: {
+            performance: {
+                interactions: PublicInteractionTask[];
+            };
+        };
+    };
+};

package/dist/types-ts4.5/types.d.ts

@@ -0,0 +1,196 @@
+import { KeyboardEvent, MouseEvent, ReactNode } from 'react';
+import UIAnalyticsEvent from '@atlaskit/analytics-next/UIAnalyticsEvent';
+import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next/withAnalyticsEvents';
+export interface TabProps {
+    /**
+     * The children to be rendered within a `Tab`.
+     */
+    children: ReactNode;
+    /**
+     * A `testId` prop is  is a unique string that appears as a data attribute `data-testid`
+     * on the `Tab` element, serving as a hook for automated tests.
+     */
+    testId?: string;
+}
+export interface TabPanelProps {
+    /**
+     * The children to be rendered within a `TabPanel`.
+     */
+    children: ReactNode;
+    /**
+     * A `testId` prop is  is a unique string that appears as a data attribute `data-testid`
+     * on the `TabPanel` element, serving as a hook for automated tests.
+     */
+    testId?: string;
+}
+/**
+ * @deprecated
+ * Previously this was the type for the tabs prop that was used like
+ * <Tabs tabs={tabs} />
+ * The codemod changes this to be
+ * <Tabs>
+ *  <TabList>
+ *    {tabs.map(tab => <Tab testId={tab.testId}>{tab.label}</Tab>)}
+ *  </TabList>
+ *  {tabs.map(tab => <TabPanel>{tab.content}</TabPanel>)}
+ * </Tabs>
+ * The TabData type remains so the variable used in tabs can have a type.
+ */
+export interface TabData {
+    /**
+     * String to be put inside a tab
+     */
+    label?: string;
+    /**
+     * String to be put inside a tab panel
+     */
+    content?: ReactNode;
+    /**
+     * 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. This `testId` is put on the tab.
+     */
+    testId?: string;
+    /**
+     * Used by consumers to convey extra information about the tab.
+     */
+    [key: string]: any;
+}
+export type SelectedType = number;
+export type OnChangeCallback = (index: SelectedType, analyticsEvent: UIAnalyticsEvent) => void;
+export interface TabsProps extends WithAnalyticsEventsProps {
+    /**
+     * The index of the tab that will be selected by default when the component mounts.
+     * If not set the first tab will be displayed by default.
+     */
+    defaultSelected?: SelectedType;
+    /**
+     * A callback function which will be fired when a changed. It will be passed
+     * the index of the selected tab and a `UIAnalyticsEvent`.
+     */
+    onChange?: OnChangeCallback;
+    /**
+     * The selected tab's index. If this prop is set the component behaves as a
+     * controlled component. It will be up to you to listen to `onChange`.
+     */
+    selected?: SelectedType;
+    /**
+     * Tabs by default leaves `TabPanel`'s mounted on the page after they have been selected.
+     * If you would like to unmount a `TabPanel` when it is not selected, set this prop to
+     * be true.
+     */
+    shouldUnmountTabPanelOnChange?: boolean;
+    /**
+     * Additional information to be included in the `context` of analytics events that come from `Tabs`.
+     */
+    analyticsContext?: Record<string, any>;
+    /**
+     * A `testId` prop is a unique string that appears as a data attribute `data-testid`
+     * on the `Tabs` element, serving as a hook for automated tests.
+     */
+    testId?: string;
+    /**
+     * The children of Tabs. The first child should be a `TabList` filled with `Tab`'s.
+     * Subsequent children should be `TabPanel`'s. There should be a `Tab` for each `TabPanel`.
+     * If you want to customize `Tab` or `TabPanel`, refer to the examples in the documentation.
+     */
+    children: ReactNode;
+    /**
+     * A unique ID that will be used to generate IDs for tabs and tab panels.
+     * This is required for accessibility purposes.
+     */
+    id: string;
+}
+export interface TabListProps {
+    /**
+     * A collection of `Tab`'s.  There should be a `Tab` for each `TabPanel`.
+     * If you want to customize `Tab` there is documentation in the tab section.
+     */
+    children: ReactNode;
+}
+export type TabAttributesType = {
+    /**
+     * Changes the selected tab.
+     */
+    onClick: () => void;
+    /**
+     * ID of the tab.
+     */
+    id: string;
+    /**
+     * The id of the tab panel that this tab links.
+     */
+    'aria-controls': string;
+    /**
+     * The position of this tab within the tab list.
+     */
+    'aria-posinset': number;
+    /**
+     * Whether this tab is selected.
+     */
+    'aria-selected': boolean;
+    /**
+     * The number of tabs in this tab list.
+     */
+    'aria-setsize': number;
+    /**
+     * Prevents a focus ring being shown when clicked.
+     */
+    onMouseDown: (e: MouseEvent<HTMLElement>) => void;
+    /**
+     * Allows navigation of tabs with automatic activation.
+     * Read here for more details: https://www.w3.org/TR/wai-aria-practices-1.1/examples/tabs/tabs-1/tabs.html
+     */
+    onKeyDown: (e: KeyboardEvent<HTMLElement>) => void;
+    /**
+     * Role is "tab".
+     */
+    role: 'tab';
+    /**
+     * If the tab is selected the tab index is 0 and is focusable.
+     * Otherwise it is -1 and is not focusable.
+     */
+    tabIndex: number;
+};
+export type TabListAttributesType = {
+    /**
+     * The index of the selected tab.
+     */
+    selected: SelectedType;
+    /**
+     * A unique ID that will be used to generate IDs for tabs and tab panels.
+     * This is required for accessibility reasons.
+     */
+    tabsId: string;
+    /**
+     * A callback function which will be fired when a tab is changed.
+     */
+    onChange: (index: SelectedType) => void;
+};
+export type TabPanelAttributesType = {
+    /**
+     * Role is "tabpanel".
+     */
+    role: 'tabpanel';
+    /**
+     * ID of the the tab panel.
+     */
+    id: string;
+    /**
+     * Hidden is true if it is not the selected tab.
+     */
+    hidden?: boolean;
+    /**
+     * The id of the tab that links to this tab panel.
+     */
+    'aria-labelledby': string;
+    /**
+     * Prevents a focus ring being shown when clicked.
+     */
+    onMouseDown: (e: MouseEvent<HTMLElement>) => void;
+    /**
+     * If the tab panel is selected the tab index is 0 and is focusable.
+     * Otherwise it is -1 and is not focusable.
+     */
+    tabIndex: number;
+};

package/hooks/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/hooks.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/hooks.d.ts"
+        "../dist/types-ts4.5/hooks.d.ts"
       ]
     }
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/tabs",
-  "version": "13.4.0",
+  "version": "13.4.2",
   "description": "Tabs are used to organize content by grouping similar information on the same page.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,14 @@
   "module": "dist/esm/index.js",
   "module:es2019": "dist/es2019/index.js",
   "types": "dist/types/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <4.9": {
+      "*": [
+        "dist/types-ts4.5/*",
+        "dist/types-ts4.5/index.d.ts"
+      ]
+    }
+  },
   "sideEffects": false,
   "atlaskit:src": "src/index.tsx",
   "atlassian": {
@@ -27,7 +35,7 @@
     "@atlaskit/codemod-utils": "^4.2.0",
     "@atlaskit/ds-explorations": "^2.1.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.3.0",
+    "@atlaskit/tokens": "^1.4.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1"
   },
@@ -46,12 +54,11 @@
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@testing-library/react": "^12.1.5",
-    "enzyme": "^3.10.0",
     "jscodeshift": "^0.13.0",
     "react-dom": "^16.8.0",
     "react-lorem-component": "^0.13.0",
     "storybook-addon-performance": "^0.16.0",
-    "typescript": "4.5.5",
+    "typescript": "~4.9.5",
     "wait-for-expect": "^1.2.0"
   },
   "techstack": {

package/types/package.json

@@ -6,9 +6,9 @@
   "sideEffects": false,
   "types": "../dist/types/types.d.ts",
   "typesVersions": {
-    ">=4.0 <4.5": {
+    ">=4.5 <4.9": {
       "*": [
-        "../dist/types-ts4.0/types.d.ts"
+        "../dist/types-ts4.5/types.d.ts"
       ]
     }
   }