@atlaskit/tooltip 20.14.6 → 21.0.0

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 (32) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/cjs/internal/get-mouse-position.js +27 -0
  3. package/dist/cjs/{utilities.js → internal/get-virtual-element-from-mouse-pos.js} +0 -22
  4. package/dist/cjs/tooltip-container.js +1 -1
  5. package/dist/cjs/tooltip-primitive.js +1 -1
  6. package/dist/cjs/tooltip-shortcut.js +1 -1
  7. package/dist/cjs/tooltip.js +6 -5
  8. package/dist/es2019/internal/get-mouse-position.js +19 -0
  9. package/dist/es2019/{utilities.js → internal/get-virtual-element-from-mouse-pos.js} +0 -19
  10. package/dist/es2019/tooltip-container.js +1 -1
  11. package/dist/es2019/tooltip-primitive.js +1 -1
  12. package/dist/es2019/tooltip-shortcut.js +1 -1
  13. package/dist/es2019/tooltip.js +3 -2
  14. package/dist/esm/internal/get-mouse-position.js +21 -0
  15. package/dist/esm/{utilities.js → internal/get-virtual-element-from-mouse-pos.js} +0 -21
  16. package/dist/esm/tooltip-container.js +1 -1
  17. package/dist/esm/tooltip-primitive.js +1 -1
  18. package/dist/esm/tooltip-shortcut.js +1 -1
  19. package/dist/esm/tooltip.js +3 -2
  20. package/dist/types/internal/get-mouse-position.d.ts +5 -0
  21. package/dist/types/internal/get-virtual-element-from-mouse-pos.d.ts +8 -0
  22. package/dist/types/internal/tooltip-manager.d.ts +1 -1
  23. package/dist/types/types.d.ts +12 -0
  24. package/dist/types-ts4.5/internal/get-mouse-position.d.ts +5 -0
  25. package/dist/types-ts4.5/internal/get-virtual-element-from-mouse-pos.d.ts +8 -0
  26. package/dist/types-ts4.5/internal/tooltip-manager.d.ts +1 -1
  27. package/dist/types-ts4.5/types.d.ts +12 -0
  28. package/package.json +7 -6
  29. package/tooltip.docs.tsx +53 -0
  30. package/dist/types/utilities.d.ts +0 -24
  31. package/dist/types-ts4.5/utilities.d.ts +0 -24
  32. package/utilities/package.json +0 -17
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # @atlaskit/tooltip
2
2
 
3
+ ## 21.0.0
4
+
5
+ ### Major Changes
6
+
7
+ - [`38f89455de21d`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/38f89455de21d) -
8
+ Removes `tooltip/utilities` entrypoint from public API. Use the utility exports from
9
+ `@atlaskit/tooltip` directly.
10
+
11
+ Removes redundant utility files, split-out multi-export modules and restructures internal files.
12
+
13
+ ### Patch Changes
14
+
15
+ - Updated dependencies
16
+
17
+ ## 20.14.7
18
+
19
+ ### Patch Changes
20
+
21
+ - Updated dependencies
22
+
3
23
  ## 20.14.6
4
24
 
5
25
  ### Patch Changes
@@ -0,0 +1,27 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.getMousePosition = getMousePosition;
7
+ function getMousePosition(mouseCoordinates) {
8
+ var safeMouse = mouseCoordinates || {
9
+ top: 0,
10
+ left: 0
11
+ };
12
+ var getBoundingClientRect = function getBoundingClientRect() {
13
+ return {
14
+ top: safeMouse.top,
15
+ left: safeMouse.left,
16
+ bottom: safeMouse.top,
17
+ right: safeMouse.left,
18
+ width: 0,
19
+ height: 0
20
+ };
21
+ };
22
+ return {
23
+ getBoundingClientRect: getBoundingClientRect,
24
+ clientWidth: 0,
25
+ clientHeight: 0
26
+ };
27
+ }
@@ -3,29 +3,7 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.getMousePosition = getMousePosition;
7
6
  exports.getVirtualElementFromMousePos = getVirtualElementFromMousePos;
8
- function getMousePosition(mouseCoordinates) {
9
- var safeMouse = mouseCoordinates || {
10
- top: 0,
11
- left: 0
12
- };
13
- var getBoundingClientRect = function getBoundingClientRect() {
14
- return {
15
- top: safeMouse.top,
16
- left: safeMouse.left,
17
- bottom: safeMouse.top,
18
- right: safeMouse.left,
19
- width: 0,
20
- height: 0
21
- };
22
- };
23
- return {
24
- getBoundingClientRect: getBoundingClientRect,
25
- clientWidth: 0,
26
- clientHeight: 0
27
- };
28
- }
29
7
  function getVirtualElementFromMousePos(mousePos, _ref) {
30
8
  var targetElement = _ref.targetElement,
31
9
  tooltipPosition = _ref.tooltipPosition;
@@ -1,4 +1,4 @@
1
- /* tooltip-container.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-container.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  "use strict";
3
3
 
4
4
  var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
@@ -1,4 +1,4 @@
1
- /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  "use strict";
3
3
 
4
4
  var _typeof = require("@babel/runtime/helpers/typeof");
@@ -1,4 +1,4 @@
1
- /* tooltip-shortcut.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-shortcut.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  "use strict";
3
3
 
4
4
  var _typeof = require("@babel/runtime/helpers/typeof");
@@ -22,10 +22,11 @@ var _popper = require("@atlaskit/popper");
22
22
  var _portal = _interopRequireDefault(require("@atlaskit/portal"));
23
23
  var _constants = require("@atlaskit/theme/constants");
24
24
  var _dragManager = require("./internal/drag-manager");
25
+ var _getMousePosition = require("./internal/get-mouse-position");
26
+ var _getVirtualElementFromMousePos = require("./internal/get-virtual-element-from-mouse-pos");
25
27
  var _tooltipManager = require("./internal/tooltip-manager");
26
28
  var _useUniqueId = _interopRequireDefault(require("./internal/use-unique-id"));
27
29
  var _tooltipContainer = _interopRequireDefault(require("./tooltip-container"));
28
- var _utilities = require("./utilities");
29
30
  function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
30
31
  function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
31
32
  function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -33,7 +34,7 @@ var tooltipZIndex = _constants.layers.tooltip();
33
34
  var analyticsAttributes = {
34
35
  componentName: 'tooltip',
35
36
  packageName: "@atlaskit/tooltip",
36
- packageVersion: "20.14.5"
37
+ packageVersion: "0.0.0-development"
37
38
  };
38
39
 
39
40
  // Inverts motion direction
@@ -337,7 +338,7 @@ function Tooltip(_ref) {
337
338
  // TODO: ideally not recalculating this object each time
338
339
  // Removing old `mouse` behind gate because it stored a function.
339
340
  // With the gate we just store the coords which are easier to work with.
340
- mouse: (0, _platformFeatureFlags.fg)('platform_dst_nav4_side_nav_resize_tooltip_feedback') ? undefined : (0, _utilities.getMousePosition)({
341
+ mouse: (0, _platformFeatureFlags.fg)('platform_dst_nav4_side_nav_resize_tooltip_feedback') ? undefined : (0, _getMousePosition.getMousePosition)({
341
342
  left: event.clientX,
342
343
  top: event.clientY
343
344
  }),
@@ -375,7 +376,7 @@ function Tooltip(_ref) {
375
376
  var _apiRef$current3;
376
377
  if ((_apiRef$current3 = apiRef.current) !== null && _apiRef$current3 !== void 0 && _apiRef$current3.isActive()) {
377
378
  if (!(0, _platformFeatureFlags.fg)('platform_dst_nav4_side_nav_resize_tooltip_feedback')) {
378
- apiRef.current.mousePosition = (0, _utilities.getMousePosition)({
379
+ apiRef.current.mousePosition = (0, _getMousePosition.getMousePosition)({
379
380
  left: event.clientX,
380
381
  top: event.clientY
381
382
  });
@@ -452,7 +453,7 @@ function Tooltip(_ref) {
452
453
  var getReferenceElement = function getReferenceElement() {
453
454
  var _apiRef$current5, _apiRef$current6;
454
455
  if (isMousePosition && (_apiRef$current5 = apiRef.current) !== null && _apiRef$current5 !== void 0 && _apiRef$current5.mousePos && targetRef.current && (0, _platformFeatureFlags.fg)('platform_dst_nav4_side_nav_resize_tooltip_feedback')) {
455
- return (0, _utilities.getVirtualElementFromMousePos)(apiRef.current.mousePos, {
456
+ return (0, _getVirtualElementFromMousePos.getVirtualElementFromMousePos)(apiRef.current.mousePos, {
456
457
  targetElement: targetRef.current,
457
458
  tooltipPosition: position
458
459
  });
@@ -0,0 +1,19 @@
1
+ export function getMousePosition(mouseCoordinates) {
2
+ const safeMouse = mouseCoordinates || {
3
+ top: 0,
4
+ left: 0
5
+ };
6
+ const getBoundingClientRect = () => ({
7
+ top: safeMouse.top,
8
+ left: safeMouse.left,
9
+ bottom: safeMouse.top,
10
+ right: safeMouse.left,
11
+ width: 0,
12
+ height: 0
13
+ });
14
+ return {
15
+ getBoundingClientRect,
16
+ clientWidth: 0,
17
+ clientHeight: 0
18
+ };
19
+ }
@@ -1,22 +1,3 @@
1
- export function getMousePosition(mouseCoordinates) {
2
- const safeMouse = mouseCoordinates || {
3
- top: 0,
4
- left: 0
5
- };
6
- const getBoundingClientRect = () => ({
7
- top: safeMouse.top,
8
- left: safeMouse.left,
9
- bottom: safeMouse.top,
10
- right: safeMouse.left,
11
- width: 0,
12
- height: 0
13
- });
14
- return {
15
- getBoundingClientRect,
16
- clientWidth: 0,
17
- clientHeight: 0
18
- };
19
- }
20
1
  export function getVirtualElementFromMousePos(mousePos, {
21
2
  targetElement,
22
3
  tooltipPosition
@@ -1,4 +1,4 @@
1
- /* tooltip-container.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-container.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  import "./tooltip-container.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -1,4 +1,4 @@
1
- /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  import "./tooltip-primitive.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -1,4 +1,4 @@
1
- /* tooltip-shortcut.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-shortcut.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  import "./tooltip-shortcut.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -12,15 +12,16 @@ import { Popper } from '@atlaskit/popper';
12
12
  import Portal from '@atlaskit/portal';
13
13
  import { layers } from '@atlaskit/theme/constants';
14
14
  import { register } from './internal/drag-manager';
15
+ import { getMousePosition } from './internal/get-mouse-position';
16
+ import { getVirtualElementFromMousePos } from './internal/get-virtual-element-from-mouse-pos';
15
17
  import { show } from './internal/tooltip-manager';
16
18
  import useUniqueId from './internal/use-unique-id';
17
19
  import TooltipContainer from './tooltip-container';
18
- import { getMousePosition, getVirtualElementFromMousePos } from './utilities';
19
20
  const tooltipZIndex = layers.tooltip();
20
21
  const analyticsAttributes = {
21
22
  componentName: 'tooltip',
22
23
  packageName: "@atlaskit/tooltip",
23
- packageVersion: "20.14.5"
24
+ packageVersion: "0.0.0-development"
24
25
  };
25
26
 
26
27
  // Inverts motion direction
@@ -0,0 +1,21 @@
1
+ export function getMousePosition(mouseCoordinates) {
2
+ var safeMouse = mouseCoordinates || {
3
+ top: 0,
4
+ left: 0
5
+ };
6
+ var getBoundingClientRect = function getBoundingClientRect() {
7
+ return {
8
+ top: safeMouse.top,
9
+ left: safeMouse.left,
10
+ bottom: safeMouse.top,
11
+ right: safeMouse.left,
12
+ width: 0,
13
+ height: 0
14
+ };
15
+ };
16
+ return {
17
+ getBoundingClientRect: getBoundingClientRect,
18
+ clientWidth: 0,
19
+ clientHeight: 0
20
+ };
21
+ }
@@ -1,24 +1,3 @@
1
- export function getMousePosition(mouseCoordinates) {
2
- var safeMouse = mouseCoordinates || {
3
- top: 0,
4
- left: 0
5
- };
6
- var getBoundingClientRect = function getBoundingClientRect() {
7
- return {
8
- top: safeMouse.top,
9
- left: safeMouse.left,
10
- bottom: safeMouse.top,
11
- right: safeMouse.left,
12
- width: 0,
13
- height: 0
14
- };
15
- };
16
- return {
17
- getBoundingClientRect: getBoundingClientRect,
18
- clientWidth: 0,
19
- clientHeight: 0
20
- };
21
- }
22
1
  export function getVirtualElementFromMousePos(mousePos, _ref) {
23
2
  var targetElement = _ref.targetElement,
24
3
  tooltipPosition = _ref.tooltipPosition;
@@ -1,4 +1,4 @@
1
- /* tooltip-container.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-container.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  import "./tooltip-container.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -1,4 +1,4 @@
1
- /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  import "./tooltip-primitive.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -1,4 +1,4 @@
1
- /* tooltip-shortcut.tsx generated by @compiled/babel-plugin v0.38.1 */
1
+ /* tooltip-shortcut.tsx generated by @compiled/babel-plugin v0.39.1 */
2
2
  import "./tooltip-shortcut.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -16,15 +16,16 @@ import { Popper } from '@atlaskit/popper';
16
16
  import Portal from '@atlaskit/portal';
17
17
  import { layers } from '@atlaskit/theme/constants';
18
18
  import { register } from './internal/drag-manager';
19
+ import { getMousePosition } from './internal/get-mouse-position';
20
+ import { getVirtualElementFromMousePos } from './internal/get-virtual-element-from-mouse-pos';
19
21
  import { show } from './internal/tooltip-manager';
20
22
  import useUniqueId from './internal/use-unique-id';
21
23
  import TooltipContainer from './tooltip-container';
22
- import { getMousePosition, getVirtualElementFromMousePos } from './utilities';
23
24
  var tooltipZIndex = layers.tooltip();
24
25
  var analyticsAttributes = {
25
26
  componentName: 'tooltip',
26
27
  packageName: "@atlaskit/tooltip",
27
- packageVersion: "20.14.5"
28
+ packageVersion: "0.0.0-development"
28
29
  };
29
30
 
30
31
  // Inverts motion direction
@@ -0,0 +1,5 @@
1
+ import type { FakeMouseElement } from '../types';
2
+ export declare function getMousePosition(mouseCoordinates: {
3
+ top: number;
4
+ left: number;
5
+ }): FakeMouseElement;
@@ -0,0 +1,8 @@
1
+ import type { VirtualElement } from '@popperjs/core';
2
+ export declare function getVirtualElementFromMousePos(mousePos: {
3
+ clientX: number;
4
+ clientY: number;
5
+ }, { targetElement, tooltipPosition, }: {
6
+ targetElement: HTMLElement;
7
+ tooltipPosition: 'mouse' | 'mouse-x' | 'mouse-y';
8
+ }): VirtualElement;
@@ -1,5 +1,5 @@
1
1
  import type { VirtualElement } from '@popperjs/core';
2
- import type { FakeMouseElement } from '../utilities';
2
+ import type { FakeMouseElement } from '../types';
3
3
  export type Source = {
4
4
  type: 'mouse';
5
5
  mouse?: VirtualElement | FakeMouseElement;
@@ -15,6 +15,18 @@ export interface TriggerProps {
15
15
  ref: (node: HTMLElement | null) => void;
16
16
  'aria-describedby'?: string | undefined;
17
17
  }
18
+ export interface FakeMouseElement {
19
+ getBoundingClientRect: () => {
20
+ top: number;
21
+ left: number;
22
+ bottom: number;
23
+ right: number;
24
+ width: number;
25
+ height: number;
26
+ };
27
+ clientWidth: number;
28
+ clientHeight: number;
29
+ }
18
30
  export interface TooltipProps {
19
31
  /**
20
32
  * The content of the tooltip. It can be either a:
@@ -0,0 +1,5 @@
1
+ import type { FakeMouseElement } from '../types';
2
+ export declare function getMousePosition(mouseCoordinates: {
3
+ top: number;
4
+ left: number;
5
+ }): FakeMouseElement;
@@ -0,0 +1,8 @@
1
+ import type { VirtualElement } from '@popperjs/core';
2
+ export declare function getVirtualElementFromMousePos(mousePos: {
3
+ clientX: number;
4
+ clientY: number;
5
+ }, { targetElement, tooltipPosition, }: {
6
+ targetElement: HTMLElement;
7
+ tooltipPosition: 'mouse' | 'mouse-x' | 'mouse-y';
8
+ }): VirtualElement;
@@ -1,5 +1,5 @@
1
1
  import type { VirtualElement } from '@popperjs/core';
2
- import type { FakeMouseElement } from '../utilities';
2
+ import type { FakeMouseElement } from '../types';
3
3
  export type Source = {
4
4
  type: 'mouse';
5
5
  mouse?: VirtualElement | FakeMouseElement;
@@ -15,6 +15,18 @@ export interface TriggerProps {
15
15
  ref: (node: HTMLElement | null) => void;
16
16
  'aria-describedby'?: string | undefined;
17
17
  }
18
+ export interface FakeMouseElement {
19
+ getBoundingClientRect: () => {
20
+ top: number;
21
+ left: number;
22
+ bottom: number;
23
+ right: number;
24
+ width: number;
25
+ height: number;
26
+ };
27
+ clientWidth: number;
28
+ clientHeight: number;
29
+ }
18
30
  export interface TooltipProps {
19
31
  /**
20
32
  * The content of the tooltip. It can be either a:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/tooltip",
3
- "version": "20.14.6",
3
+ "version": "21.0.0",
4
4
  "description": "A tooltip briefly describes an interactive element on mouse hover or keyboard focus.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -33,14 +33,14 @@
33
33
  },
34
34
  "dependencies": {
35
35
  "@atlaskit/analytics-next": "^11.1.0",
36
- "@atlaskit/ds-lib": "^5.3.0",
36
+ "@atlaskit/ds-lib": "^6.0.0",
37
37
  "@atlaskit/layering": "^3.6.0",
38
- "@atlaskit/motion": "^5.3.0",
38
+ "@atlaskit/motion": "^5.4.0",
39
39
  "@atlaskit/platform-feature-flags": "^1.1.0",
40
40
  "@atlaskit/popper": "^7.1.0",
41
41
  "@atlaskit/portal": "^5.2.0",
42
42
  "@atlaskit/theme": "^22.0.0",
43
- "@atlaskit/tokens": "^11.0.0",
43
+ "@atlaskit/tokens": "^11.1.0",
44
44
  "@babel/runtime": "^7.0.0",
45
45
  "@compiled/react": "^0.20.0",
46
46
  "bind-event-listener": "^3.0.0"
@@ -56,13 +56,14 @@
56
56
  "@af/visual-regression": "workspace:^",
57
57
  "@atlaskit/button": "^23.10.0",
58
58
  "@atlaskit/css": "^0.19.0",
59
- "@atlaskit/docs": "^11.6.0",
60
- "@atlaskit/icon": "^32.0.0",
59
+ "@atlaskit/docs": "^11.7.0",
60
+ "@atlaskit/icon": "^33.0.0",
61
61
  "@atlaskit/link": "^3.3.0",
62
62
  "@atlaskit/primitives": "^18.0.0",
63
63
  "@atlaskit/section-message": "^8.12.0",
64
64
  "@atlassian/feature-flags-test-utils": "^1.0.0",
65
65
  "@atlassian/ssr-tests": "workspace:^",
66
+ "@atlassian/structured-docs-types": "workspace:^",
66
67
  "@atlassian/testing-library": "^0.4.0",
67
68
  "@testing-library/react": "^16.3.0",
68
69
  "react-dom": "^18.2.0",
@@ -0,0 +1,53 @@
1
+ import path from 'path';
2
+
3
+ import type { ComponentStructuredContentSource } from '@atlassian/structured-docs-types';
4
+
5
+ const documentation: ComponentStructuredContentSource[] = [
6
+ {
7
+ name: 'Tooltip',
8
+ description:
9
+ 'A tooltip is a floating, non-actionable label used to explain a user interface element or feature.',
10
+ status: 'general-availability',
11
+ import: {
12
+ name: 'Tooltip',
13
+ package: '@atlaskit/tooltip',
14
+ type: 'default',
15
+ packagePath: path.resolve(__dirname),
16
+ packageJson: require('./package.json'),
17
+ },
18
+ usageGuidelines: [
19
+ 'Use only on interactive elements (must be focusable for keyboard and screen readers)',
20
+ 'Opens on hover or focus; content is text only',
21
+ 'Use with icon buttons for labels; for useful but non-essential info (e.g. shortcuts); for truncated text when truncation is unavoidable',
22
+ 'Never use on disabled elements (see Button a11y)',
23
+ 'Do not put critical info in tooltip—use labels, helper text, or inline message',
24
+ 'No interactive or visual content inside (no links/buttons/icons)—use Popup or Modal',
25
+ 'Use Inline message for richer/longer content; Popup/Modal for interactive content',
26
+ ],
27
+ contentGuidelines: [
28
+ 'Keep concise; do not repeat the visible label',
29
+ 'Use helpful, non-essential information only',
30
+ 'Icon button and link icon button have their own content guidelines',
31
+ ],
32
+ accessibilityGuidelines: [
33
+ 'Use only on interactive elements (keyboard focusable; screen reader can reach them)',
34
+ 'Never use tooltips on disabled elements',
35
+ 'Do not put critical information in tooltips—use visible labels, helper text, or inline message',
36
+ 'No links, buttons, or icons inside tooltip—use Popup or Modal for interactive content',
37
+ 'Keyboard shortcuts shown in tooltip are not exposed to assistive tech—provide an alternative (e.g. panel, dialog)',
38
+ 'Ensure tooltip content is announced by screen readers',
39
+ 'Provide keyboard access (hover + focus trigger)',
40
+ ],
41
+ examples: [
42
+ {
43
+ name: 'Default Tooltip',
44
+ description: 'Default Tooltip example',
45
+ source: path.resolve(__dirname, './examples/default-tooltip.tsx'),
46
+ },
47
+ ],
48
+ keywords: ['tooltip', 'hint', 'help', 'floating', 'label', 'explanation'],
49
+ categories: ['overlays-and-layering'],
50
+ },
51
+ ];
52
+
53
+ export default documentation;
@@ -1,24 +0,0 @@
1
- import type { VirtualElement } from '@popperjs/core';
2
- export interface FakeMouseElement {
3
- getBoundingClientRect: () => {
4
- top: number;
5
- left: number;
6
- bottom: number;
7
- right: number;
8
- width: number;
9
- height: number;
10
- };
11
- clientWidth: number;
12
- clientHeight: number;
13
- }
14
- export declare function getMousePosition(mouseCoordinates: {
15
- top: number;
16
- left: number;
17
- }): FakeMouseElement;
18
- export declare function getVirtualElementFromMousePos(mousePos: {
19
- clientX: number;
20
- clientY: number;
21
- }, { targetElement, tooltipPosition, }: {
22
- targetElement: HTMLElement;
23
- tooltipPosition: 'mouse' | 'mouse-x' | 'mouse-y';
24
- }): VirtualElement;
@@ -1,24 +0,0 @@
1
- import type { VirtualElement } from '@popperjs/core';
2
- export interface FakeMouseElement {
3
- getBoundingClientRect: () => {
4
- top: number;
5
- left: number;
6
- bottom: number;
7
- right: number;
8
- width: number;
9
- height: number;
10
- };
11
- clientWidth: number;
12
- clientHeight: number;
13
- }
14
- export declare function getMousePosition(mouseCoordinates: {
15
- top: number;
16
- left: number;
17
- }): FakeMouseElement;
18
- export declare function getVirtualElementFromMousePos(mousePos: {
19
- clientX: number;
20
- clientY: number;
21
- }, { targetElement, tooltipPosition, }: {
22
- targetElement: HTMLElement;
23
- tooltipPosition: 'mouse' | 'mouse-x' | 'mouse-y';
24
- }): VirtualElement;
@@ -1,17 +0,0 @@
1
- {
2
- "name": "@atlaskit/tooltip/utilities",
3
- "main": "../dist/cjs/utilities.js",
4
- "module": "../dist/esm/utilities.js",
5
- "module:es2019": "../dist/es2019/utilities.js",
6
- "sideEffects": [
7
- "**/*.compiled.css"
8
- ],
9
- "types": "../dist/types/utilities.d.ts",
10
- "typesVersions": {
11
- ">=4.5 <5.9": {
12
- "*": [
13
- "../dist/types-ts4.5/utilities.d.ts"
14
- ]
15
- }
16
- }
17
- }