@atlaskit/tooltip 17.8.1 → 17.8.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @atlaskit/tooltip
 
+## 17.8.3
+
+### Patch Changes
+
+- [`599bfe90ee3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/599bfe90ee3) - Internal change to use shape tokens. There is no expected visual change.
+
+## 17.8.2
+
+### Patch Changes
+
+- [`9d00501a414`](https://bitbucket.org/atlassian/atlassian-frontend/commits/9d00501a414) - Ensure legacy types are published for TS 4.5-4.8
+
 ## 17.8.1
 
 ### Patch Changes

package/dist/cjs/Tooltip.js

@@ -32,7 +32,7 @@ var tooltipZIndex = _constants.layers.tooltip();
 var analyticsAttributes = {
   componentName: 'tooltip',
   packageName: "@atlaskit/tooltip",
-  packageVersion: "17.8.1"
+  packageVersion: "17.8.3"
 };
 
 // Inverts motion direction

package/dist/cjs/TooltipContainer.js

@@ -18,7 +18,7 @@ var baseStyles = (0, _react2.css)({
   padding: "var(--ds-space-025, 2px)".concat(" ", "var(--ds-space-075, 6px)"),
   top: "var(--ds-space-0, 0px)",
   left: "var(--ds-space-0, 0px)",
-  borderRadius: "var(--ds-radius-100, 3px)",
+  borderRadius: "var(--ds-border-radius, 3px)",
   fontSize: "var(--ds-font-size-075, 12px)",
   lineHeight: 1.3,
   overflowWrap: 'break-word',

package/dist/cjs/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/tooltip",
-	"version": "17.8.1",
+	"version": "17.8.3",
 	"sideEffects": false
 }

package/dist/es2019/Tooltip.js

@@ -20,7 +20,7 @@ const tooltipZIndex = layers.tooltip();
 const analyticsAttributes = {
   componentName: 'tooltip',
   packageName: "@atlaskit/tooltip",
-  packageVersion: "17.8.1"
+  packageVersion: "17.8.3"
 };
 
 // Inverts motion direction

package/dist/es2019/TooltipContainer.js

@@ -10,7 +10,7 @@ const baseStyles = css({
   padding: `${"var(--ds-space-025, 2px)"} ${"var(--ds-space-075, 6px)"}`,
   top: "var(--ds-space-0, 0px)",
   left: "var(--ds-space-0, 0px)",
-  borderRadius: "var(--ds-radius-100, 3px)",
+  borderRadius: "var(--ds-border-radius, 3px)",
   fontSize: "var(--ds-font-size-075, 12px)",
   lineHeight: 1.3,
   overflowWrap: 'break-word',

package/dist/es2019/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/tooltip",
-	"version": "17.8.1",
+	"version": "17.8.3",
 	"sideEffects": false
 }

package/dist/esm/Tooltip.js

@@ -24,7 +24,7 @@ var tooltipZIndex = layers.tooltip();
 var analyticsAttributes = {
   componentName: 'tooltip',
   packageName: "@atlaskit/tooltip",
-  packageVersion: "17.8.1"
+  packageVersion: "17.8.3"
 };
 
 // Inverts motion direction

package/dist/esm/TooltipContainer.js

@@ -10,7 +10,7 @@ var baseStyles = css({
   padding: "var(--ds-space-025, 2px)".concat(" ", "var(--ds-space-075, 6px)"),
   top: "var(--ds-space-0, 0px)",
   left: "var(--ds-space-0, 0px)",
-  borderRadius: "var(--ds-radius-100, 3px)",
+  borderRadius: "var(--ds-border-radius, 3px)",
   fontSize: "var(--ds-font-size-075, 12px)",
   lineHeight: 1.3,
   overflowWrap: 'break-word',

package/dist/esm/version.json

@@ -1,5 +1,5 @@
 {
 	"name": "@atlaskit/tooltip",
-	"version": "17.8.1",
+	"version": "17.8.3",
 	"sideEffects": false
 }

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

@@ -0,0 +1,8 @@
+/** @jsx jsx */
+import { jsx } from '@emotion/react';
+import { TooltipProps } from './types';
+declare function Tooltip({ children, position, mousePosition, content, truncate, component: Container, tag: TargetContainer, testId, delay, onShow, onHide, hideTooltipOnClick, hideTooltipOnMouseDown, analyticsContext, strategy, }: TooltipProps): jsx.JSX.Element;
+declare namespace Tooltip {
+    var displayName: string;
+}
+export default Tooltip;

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

@@ -0,0 +1,6 @@
+/// <reference types="react" />
+import { TooltipPrimitiveProps } from './TooltipPrimitive';
+export interface TooltipContainerProps extends TooltipPrimitiveProps {
+}
+declare const TooltipContainer: import("react").ForwardRefExoticComponent<Pick<TooltipContainerProps, "style" | "className" | "children" | "placement" | "testId" | "onMouseOut" | "onMouseOver" | "id" | "truncate"> & import("react").RefAttributes<HTMLDivElement>>;
+export default TooltipContainer;

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

@@ -0,0 +1,17 @@
+/** @jsx jsx */
+import { CSSProperties, ReactNode } from 'react';
+import { PositionType } from './types';
+export interface TooltipPrimitiveProps {
+    truncate?: boolean;
+    style?: CSSProperties;
+    className?: string;
+    children: ReactNode;
+    testId?: string;
+    placement: PositionType;
+    ref: React.Ref<any>;
+    onMouseOver?: (e: React.MouseEvent<HTMLElement>) => void;
+    onMouseOut?: (e: React.MouseEvent<HTMLElement>) => void;
+    id?: string;
+}
+declare const TooltipPrimitive: import("react").ForwardRefExoticComponent<Pick<TooltipPrimitiveProps, "style" | "className" | "children" | "placement" | "testId" | "onMouseOut" | "onMouseOver" | "id" | "truncate"> & import("react").RefAttributes<HTMLDivElement>>;
+export default TooltipPrimitive;

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

@@ -0,0 +1,4 @@
+export { default } from './Tooltip';
+export { default as TooltipPrimitive } from './TooltipPrimitive';
+export type { TooltipPrimitiveProps } from './TooltipPrimitive';
+export type { PositionType, TooltipProps } from './types';

package/dist/types-ts4.5/internal/shared-schedule.d.ts

@@ -0,0 +1,2 @@
+export declare function clearScheduled(): void;
+export declare function scheduleTimeout(fn: () => void, delay: number): void;

package/dist/types-ts4.5/internal/tooltip-manager.d.ts

@@ -0,0 +1,29 @@
+import { FakeMouseElement } from '../utilities';
+export type Source = {
+    type: 'mouse';
+    mouse: FakeMouseElement;
+} | {
+    type: 'keyboard';
+};
+export type Entry = {
+    source: Source;
+    show: (value: {
+        isImmediate: boolean;
+    }) => void;
+    hide: (value: {
+        isImmediate: boolean;
+    }) => void;
+    delay: number;
+    done: () => void;
+};
+export type API = {
+    isActive: () => boolean;
+    mousePosition: FakeMouseElement | null;
+    requestHide: (value: {
+        isImmediate: boolean;
+    }) => void;
+    finishHideAnimation: () => void;
+    keep: () => void;
+    abort: () => void;
+};
+export declare function show(entry: Entry): API;

package/dist/types-ts4.5/internal/use-unique-id.d.ts

@@ -0,0 +1 @@
+export default function useUniqueId(prefix: string, shouldRenderId: boolean): string | undefined;

package/dist/{types/internal/props-for-extract-react-types.d.ts → types-ts4.5/types.d.ts}

@@ -1,12 +1,26 @@
-import { ComponentType, ElementType, ReactNode } from 'react';
-import { TooltipPrimitiveProps } from '../TooltipPrimitive';
-import { PositionType, PositionTypeBase } from '../types';
-type Props = {
+import { ComponentType, ReactNode } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+import { Placement } from '@atlaskit/popper';
+import { TooltipPrimitiveProps } from './TooltipPrimitive';
+export type PositionTypeBase = Placement;
+export type PositionType = PositionTypeBase | 'mouse';
+export interface TriggerProps {
+    onMouseOver: (event: React.MouseEvent<HTMLElement>) => void;
+    onMouseOut: (event: React.MouseEvent<HTMLElement>) => void;
+    onMouseMove: ((event: React.MouseEvent<HTMLElement>) => void) | undefined;
+    onMouseDown: (event: React.MouseEvent<HTMLElement>) => void;
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    onFocus: (event: React.FocusEvent<HTMLElement>) => void;
+    onBlur: (event: React.FocusEvent<HTMLElement>) => void;
+    ref: (node: HTMLElement | null) => void;
+    'aria-describedby'?: string | undefined;
+}
+export interface TooltipProps {
     /**
      * The content of the tooltip. It can be either a:
      * 1. `ReactNode`
      * 2. Function which returns a `ReactNode`
-     
+  
      * The benefit of the second approach is that it allows you to consume the `update` render prop.
      * This `update` function can be called to manually recalculate the position of the tooltip.
      */
@@ -43,12 +57,12 @@ type Props = {
      * Function to be called when the tooltip will be shown. It is called when the
      * tooltip begins to animate in.
      */
-    onShow?: () => void;
+    onShow?: (analyticsEvent: UIAnalyticsEvent) => void;
     /**
      * Function to be called when the tooltip will be hidden. It is called after the
      * delay, when the tooltip begins to animate out.
      */
-    onHide?: () => void;
+    onHide?: (analyticsEvent: UIAnalyticsEvent) => void;
     /**
      * Where the tooltip should appear relative to its target.
      * If set to `"mouse"` the tooltip will display next to the mouse pointer instead.
@@ -59,19 +73,21 @@ type Props = {
      * Replace the wrapping element. This accepts the name of a html tag which will
      * be used to wrap the element.
      * If you provide a component it needs to support a ref prop which is used by popper for positioning
-     * Note: actual type is not ElementType, it is either a JSX.IntrinsticElement (eg "div")
-     * or a component that supports React.AllHTMLAttributes<HTMLElement> has a ref prop (React.Ref<HTMLElement>).
-     * Using ElementType here for documentation because it is close and works with our prop extraction tool
      */
-    tag?: ElementType;
+    tag?: keyof JSX.IntrinsicElements | React.ComponentType<React.AllHTMLAttributes<HTMLElement> & {
+        ref: React.Ref<HTMLElement>;
+    }>;
     /**
      * Show only one line of text, and truncate when too long
      */
     truncate?: boolean;
     /**
-     * Elements to be wrapped by the tooltip
+     * Elements to be wrapped by the tooltip.
+     * It can be either a:
+     * 1. `ReactNode`
+     * 2. Function which returns a `ReactNode`
      */
-    children: ReactNode;
+    children: ReactNode | ((props: TriggerProps) => 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,
@@ -79,6 +95,8 @@ type Props = {
     testId?: string;
     /** Analytics context metadata */
     analyticsContext?: Record<string, any>;
-};
-export default function PropsHack(props: Props): null;
-export {};
+    /**
+     * Used to define the strategy of popper.
+     */
+    strategy?: 'absolute' | 'fixed' | undefined;
+}

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

@@ -0,0 +1,16 @@
+export interface FakeMouseElement {
+    getBoundingClientRect: () => {
+        top: number;
+        left: number;
+        bottom: number;
+        right: number;
+        width: number;
+        height: number;
+    };
+    clientWidth: number;
+    clientHeight: number;
+}
+export declare function getMousePosition(mouseCoordinates: {
+    top: number;
+    left: number;
+}): FakeMouseElement;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/tooltip",
-  "version": "17.8.1",
+  "version": "17.8.3",
   "description": "A tooltip is a floating, non-actionable label used to explain a user interface element or feature.",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -24,7 +24,7 @@
   "atlaskit:src": "src/index.ts",
   "atlassian": {
     "team": "Design System Team",
-    "releaseModel": "scheduled",
+    "releaseModel": "continuous",
     "website": {
       "name": "Tooltip",
       "category": "Components"
@@ -45,7 +45,7 @@
     "@atlaskit/popper": "^5.5.0",
     "@atlaskit/portal": "^4.3.0",
     "@atlaskit/theme": "^12.5.0",
-    "@atlaskit/tokens": "^1.4.0",
+    "@atlaskit/tokens": "^1.11.0",
     "@babel/runtime": "^7.0.0",
     "@emotion/react": "^11.7.1",
     "bind-event-listener": "^2.1.1",
@@ -56,17 +56,17 @@
     "react-dom": "^16.8.0"
   },
   "devDependencies": {
-    "@atlaskit/button": "^16.7.0",
+    "@atlaskit/button": "^16.8.0",
     "@atlaskit/docs": "*",
     "@atlaskit/icon": "^21.12.0",
     "@atlaskit/section-message": "^6.4.0",
     "@atlaskit/ssr": "*",
     "@atlaskit/visual-regression": "*",
-    "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@emotion/styled": "^11.0.0",
     "@testing-library/dom": "^8.17.1",
     "@testing-library/react": "^12.1.5",
+    "jest-axe": "^4.0.0",
     "jest-in-case": "^1.0.2",
     "react-dom": "^16.8.0",
     "react-redux": "^5.1.2",

package/tmp/api-report-tmp.d.ts

@@ -0,0 +1,106 @@
+## API Report File for "@atlaskit/tooltip"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ComponentType } from 'react';
+import { CSSProperties } from 'react';
+import { ForwardRefExoticComponent } from 'react';
+import { jsx } from '@emotion/react';
+import { Placement } from '@atlaskit/popper';
+import { ReactNode } from 'react';
+import { RefAttributes } from 'react';
+import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
+
+// @public (undocumented)
+export type PositionType = 'mouse' | PositionTypeBase;
+
+// @public (undocumented)
+type PositionTypeBase = Placement;
+
+// @public (undocumented)
+function Tooltip({ children, position, mousePosition, content, truncate, component: Container, tag: TargetContainer, testId, delay, onShow, onHide, hideTooltipOnClick, hideTooltipOnMouseDown, analyticsContext, strategy, }: TooltipProps): jsx.JSX.Element;
+
+// @public (undocumented)
+namespace Tooltip {
+    var // (undocumented)
+    displayName: string;
+}
+export default Tooltip;
+
+// @public (undocumented)
+export const TooltipPrimitive: ForwardRefExoticComponent<Pick<TooltipPrimitiveProps, "children" | "className" | "id" | "onMouseOut" | "onMouseOver" | "placement" | "style" | "testId" | "truncate"> & RefAttributes<HTMLDivElement>>;
+
+// @public (undocumented)
+export interface TooltipPrimitiveProps {
+    // (undocumented)
+    children: ReactNode;
+    // (undocumented)
+    className?: string;
+    // (undocumented)
+    id?: string;
+    // (undocumented)
+    onMouseOut?: (e: React.MouseEvent<HTMLElement>) => void;
+    // (undocumented)
+    onMouseOver?: (e: React.MouseEvent<HTMLElement>) => void;
+    // (undocumented)
+    placement: PositionType;
+    // (undocumented)
+    ref: React.Ref<any>;
+    // (undocumented)
+    style?: CSSProperties;
+    // (undocumented)
+    testId?: string;
+    // (undocumented)
+    truncate?: boolean;
+}
+
+// @public (undocumented)
+export interface TooltipProps {
+    analyticsContext?: Record<string, any>;
+    children: ((props: TriggerProps) => ReactNode) | ReactNode;
+    component?: ComponentType<TooltipPrimitiveProps>;
+    content: (({ update }: {
+        update: () => void;
+    }) => ReactNode) | ReactNode;
+    delay?: number;
+    hideTooltipOnClick?: boolean;
+    hideTooltipOnMouseDown?: boolean;
+    mousePosition?: PositionTypeBase;
+    onHide?: (analyticsEvent: UIAnalyticsEvent) => void;
+    onShow?: (analyticsEvent: UIAnalyticsEvent) => void;
+    position?: PositionType;
+    strategy?: 'absolute' | 'fixed' | undefined;
+    tag?: React.ComponentType<React.AllHTMLAttributes<HTMLElement> & {
+        ref: React.Ref<HTMLElement>;
+    }> | keyof JSX.IntrinsicElements;
+    testId?: string;
+    truncate?: boolean;
+}
+
+// @public (undocumented)
+interface TriggerProps {
+    // (undocumented)
+    'aria-describedby'?: string | undefined;
+    // (undocumented)
+    onBlur: (event: React.FocusEvent<HTMLElement>) => void;
+    // (undocumented)
+    onClick: (event: React.MouseEvent<HTMLElement>) => void;
+    // (undocumented)
+    onFocus: (event: React.FocusEvent<HTMLElement>) => void;
+    // (undocumented)
+    onMouseDown: (event: React.MouseEvent<HTMLElement>) => void;
+    // (undocumented)
+    onMouseMove: ((event: React.MouseEvent<HTMLElement>) => void) | undefined;
+    // (undocumented)
+    onMouseOut: (event: React.MouseEvent<HTMLElement>) => void;
+    // (undocumented)
+    onMouseOver: (event: React.MouseEvent<HTMLElement>) => void;
+    // (undocumented)
+    ref: (node: HTMLElement | null) => void;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```

package/dist/cjs/internal/props-for-extract-react-types.js

@@ -1,12 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = PropsHack;
-/* Note: this file is a workaround because extract-react-types cannot correctly process the "tag" prop
-It is a copy paste of the `TooltipProps` from `types.ts` except for the `tag` prop which is different */
-
-function PropsHack(props) {
-  return null;
-}

package/dist/es2019/internal/props-for-extract-react-types.js

@@ -1,6 +0,0 @@
-/* Note: this file is a workaround because extract-react-types cannot correctly process the "tag" prop
-It is a copy paste of the `TooltipProps` from `types.ts` except for the `tag` prop which is different */
-
-export default function PropsHack(props) {
-  return null;
-}

package/dist/esm/internal/props-for-extract-react-types.js

@@ -1,6 +0,0 @@
-/* Note: this file is a workaround because extract-react-types cannot correctly process the "tag" prop
-It is a copy paste of the `TooltipProps` from `types.ts` except for the `tag` prop which is different */
-
-export default function PropsHack(props) {
-  return null;
-}