@atlaskit/tooltip 20.4.6 → 20.4.8

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # @atlaskit/tooltip
2
2
 
3
+ ## 20.4.8
4
+
5
+ ### Patch Changes
6
+
7
+ - [`6d3595e270d09`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6d3595e270d09) -
8
+ Minor fixes to Tooltip's component prop and DropdownMenu types to be more compatible with React
9
+ 18.3.1
10
+ - Updated dependencies
11
+
12
+ ## 20.4.7
13
+
14
+ ### Patch Changes
15
+
16
+ - [`042005250a589`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/042005250a589) -
17
+ Typescript fixes
18
+ - Updated dependencies
19
+
3
20
  ## 20.4.6
4
21
 
5
22
  ### Patch Changes
@@ -1,4 +1,4 @@
1
- /* tooltip-container.tsx generated by @compiled/babel-plugin v0.36.1 */
1
+ /* tooltip-container.tsx generated by @compiled/babel-plugin v0.38.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.36.1 */
1
+ /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.38.1 */
2
2
  "use strict";
3
3
 
4
4
  var _typeof = require("@babel/runtime/helpers/typeof");
@@ -451,7 +451,7 @@ function Tooltip(_ref) {
451
451
 
452
452
  // Don't set `data-testid` unless it's defined, as it's not in the interface.
453
453
  if (testId) {
454
- // @ts-expect-error - Adding `data-testid` to the TriggerProps interface breaks Buttons.
454
+ // Adding `data-testid` to the TriggerProps interface breaks Buttons, so we use type assertion
455
455
  tooltipTriggerProps['data-testid'] = "".concat(testId, "--container");
456
456
  }
457
457
 
@@ -1,4 +1,4 @@
1
- /* tooltip-container.tsx generated by @compiled/babel-plugin v0.36.1 */
1
+ /* tooltip-container.tsx generated by @compiled/babel-plugin v0.38.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.36.1 */
1
+ /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.38.1 */
2
2
  import "./tooltip-primitive.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -427,7 +427,7 @@ function Tooltip({
427
427
 
428
428
  // Don't set `data-testid` unless it's defined, as it's not in the interface.
429
429
  if (testId) {
430
- // @ts-expect-error - Adding `data-testid` to the TriggerProps interface breaks Buttons.
430
+ // Adding `data-testid` to the TriggerProps interface breaks Buttons, so we use type assertion
431
431
  tooltipTriggerProps['data-testid'] = `${testId}--container`;
432
432
  }
433
433
 
@@ -1,4 +1,4 @@
1
- /* tooltip-container.tsx generated by @compiled/babel-plugin v0.36.1 */
1
+ /* tooltip-container.tsx generated by @compiled/babel-plugin v0.38.1 */
2
2
  import _defineProperty from "@babel/runtime/helpers/defineProperty";
3
3
  import "./tooltip-container.compiled.css";
4
4
  import * as React from 'react';
@@ -1,4 +1,4 @@
1
- /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.36.1 */
1
+ /* tooltip-primitive.tsx generated by @compiled/babel-plugin v0.38.1 */
2
2
  import "./tooltip-primitive.compiled.css";
3
3
  import * as React from 'react';
4
4
  import { ax, ix } from "@compiled/react/runtime";
@@ -442,7 +442,7 @@ function Tooltip(_ref) {
442
442
 
443
443
  // Don't set `data-testid` unless it's defined, as it's not in the interface.
444
444
  if (testId) {
445
- // @ts-expect-error - Adding `data-testid` to the TriggerProps interface breaks Buttons.
445
+ // Adding `data-testid` to the TriggerProps interface breaks Buttons, so we use type assertion
446
446
  tooltipTriggerProps['data-testid'] = "".concat(testId, "--container");
447
447
  }
448
448
 
@@ -11,9 +11,9 @@ export interface TooltipPrimitiveProps {
11
11
  children: ReactNode;
12
12
  testId?: string;
13
13
  placement: PositionType;
14
- ref: React.Ref<any>;
15
- onMouseOver?: (e: React.MouseEvent<HTMLElement>) => void;
16
- onMouseOut?: (e: React.MouseEvent<HTMLElement>) => void;
14
+ ref?: React.Ref<HTMLDivElement>;
15
+ onMouseOver?: (e: React.MouseEvent<HTMLDivElement>) => void;
16
+ onMouseOut?: (e: React.MouseEvent<HTMLDivElement>) => void;
17
17
  id?: string;
18
18
  }
19
19
  /**
@@ -34,7 +34,7 @@ export interface TooltipProps {
34
34
  /**
35
35
  * Extend `TooltipPrimitive` to create your own tooltip and pass it as component.
36
36
  */
37
- component?: ComponentType<TooltipPrimitiveProps> | React.ForwardRefExoticComponent<React.PropsWithoutRef<TooltipPrimitiveProps> & React.RefAttributes<HTMLElement>>;
37
+ component?: ComponentType<TooltipPrimitiveProps> | React.ForwardRefExoticComponent<React.PropsWithoutRef<TooltipPrimitiveProps> & React.RefAttributes<HTMLDivElement>>;
38
38
  /**
39
39
  * Time in milliseconds to wait before showing and hiding the tooltip. Defaults to 300.
40
40
  */
@@ -11,9 +11,9 @@ export interface TooltipPrimitiveProps {
11
11
  children: ReactNode;
12
12
  testId?: string;
13
13
  placement: PositionType;
14
- ref: React.Ref<any>;
15
- onMouseOver?: (e: React.MouseEvent<HTMLElement>) => void;
16
- onMouseOut?: (e: React.MouseEvent<HTMLElement>) => void;
14
+ ref?: React.Ref<HTMLDivElement>;
15
+ onMouseOver?: (e: React.MouseEvent<HTMLDivElement>) => void;
16
+ onMouseOut?: (e: React.MouseEvent<HTMLDivElement>) => void;
17
17
  id?: string;
18
18
  }
19
19
  /**
@@ -34,7 +34,7 @@ export interface TooltipProps {
34
34
  /**
35
35
  * Extend `TooltipPrimitive` to create your own tooltip and pass it as component.
36
36
  */
37
- component?: ComponentType<TooltipPrimitiveProps> | React.ForwardRefExoticComponent<React.PropsWithoutRef<TooltipPrimitiveProps> & React.RefAttributes<HTMLElement>>;
37
+ component?: ComponentType<TooltipPrimitiveProps> | React.ForwardRefExoticComponent<React.PropsWithoutRef<TooltipPrimitiveProps> & React.RefAttributes<HTMLDivElement>>;
38
38
  /**
39
39
  * Time in milliseconds to wait before showing and hiding the tooltip. Defaults to 300.
40
40
  */
package/offerings.json ADDED
@@ -0,0 +1,37 @@
1
+ [
2
+ {
3
+ "name": "Tooltip",
4
+ "package": "@atlaskit/tooltip",
5
+ "import": {
6
+ "name": "Tooltip",
7
+ "package": "@atlaskit/tooltip",
8
+ "type": "default"
9
+ },
10
+ "keywords": ["tooltip", "hint", "help", "floating", "label", "explanation"],
11
+ "categories": ["overlays-and-layering"],
12
+ "shortDescription": "A tooltip is a floating, non-actionable label used to explain a user interface element or feature.",
13
+ "status": "general-availability",
14
+ "accessibilityGuidelines": [
15
+ "Ensure tooltip content is announced by screen readers",
16
+ "Use appropriate hover/focus triggers",
17
+ "Provide keyboard access to tooltip content",
18
+ "Use clear, descriptive tooltip text",
19
+ "Consider tooltip timing and persistence"
20
+ ],
21
+ "usageGuidelines": [
22
+ "Use to provide additional context or explanation",
23
+ "Keep tooltip content concise and helpful",
24
+ "Position tooltips appropriately to avoid obstruction",
25
+ "Use consistent tooltip behavior across the interface",
26
+ "Consider mobile touch interactions"
27
+ ],
28
+ "contentGuidelines": [
29
+ "Write clear, concise explanatory text",
30
+ "Use helpful, actionable information",
31
+ "Avoid redundant information already visible",
32
+ "Use consistent tone and style"
33
+ ],
34
+ "generativeInstructions": "./docs/ai/tooltip-instructions.md",
35
+ "examples": ["./examples/default-tooltip.tsx"]
36
+ }
37
+ ]
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/tooltip",
3
- "version": "20.4.6",
3
+ "version": "20.4.8",
4
4
  "description": "A tooltip is a floating, non-actionable label used to explain a user interface element or feature.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -33,7 +33,7 @@
33
33
  },
34
34
  "dependencies": {
35
35
  "@atlaskit/analytics-next": "^11.1.0",
36
- "@atlaskit/ds-lib": "^5.0.0",
36
+ "@atlaskit/ds-lib": "^5.1.0",
37
37
  "@atlaskit/layering": "^3.0.0",
38
38
  "@atlaskit/motion": "^5.3.0",
39
39
  "@atlaskit/platform-feature-flags": "^1.1.0",
@@ -55,10 +55,10 @@
55
55
  "@af/visual-regression": "workspace:^",
56
56
  "@atlaskit/button": "^23.4.0",
57
57
  "@atlaskit/css": "^0.14.0",
58
- "@atlaskit/docs": "^11.0.0",
59
- "@atlaskit/icon": "^28.1.0",
58
+ "@atlaskit/docs": "^11.1.0",
59
+ "@atlaskit/icon": "^28.3.0",
60
60
  "@atlaskit/link": "^3.2.0",
61
- "@atlaskit/primitives": "^14.14.0",
61
+ "@atlaskit/primitives": "^14.15.0",
62
62
  "@atlaskit/section-message": "^8.7.0",
63
63
  "@atlassian/ssr-tests": "^0.3.0",
64
64
  "@testing-library/react": "^13.4.0",