@atlaskit/tooltip 18.1.1 → 18.1.2

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,11 @@
1
1
  # @atlaskit/tooltip
2
2
 
3
+ ## 18.1.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [#75714](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/75714) [`33f4a64132a3`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/33f4a64132a3) - Remove duplicate accessible labels on Icon buttons, which were unnecessarily added through the `aria-label` attribute.
8
+
3
9
  ## 18.1.1
4
10
 
5
11
  ### Patch Changes
@@ -32,7 +32,7 @@ var tooltipZIndex = _constants.layers.tooltip();
32
32
  var analyticsAttributes = {
33
33
  componentName: 'tooltip',
34
34
  packageName: "@atlaskit/tooltip",
35
- packageVersion: "18.1.1"
35
+ packageVersion: "18.1.2"
36
36
  };
37
37
 
38
38
  // Inverts motion direction
@@ -18,7 +18,7 @@ const tooltipZIndex = layers.tooltip();
18
18
  const analyticsAttributes = {
19
19
  componentName: 'tooltip',
20
20
  packageName: "@atlaskit/tooltip",
21
- packageVersion: "18.1.1"
21
+ packageVersion: "18.1.2"
22
22
  };
23
23
 
24
24
  // Inverts motion direction
@@ -22,7 +22,7 @@ var tooltipZIndex = layers.tooltip();
22
22
  var analyticsAttributes = {
23
23
  componentName: 'tooltip',
24
24
  packageName: "@atlaskit/tooltip",
25
- packageVersion: "18.1.1"
25
+ packageVersion: "18.1.2"
26
26
  };
27
27
 
28
28
  // Inverts motion direction
@@ -28,7 +28,7 @@ export interface TooltipProps {
28
28
  update?: () => void;
29
29
  }) => ReactNode);
30
30
  /**
31
- * Extend `TooltipPrimitive` to create your own tooltip and pass it as component
31
+ * Extend `TooltipPrimitive` to create your own tooltip and pass it as component.
32
32
  */
33
33
  component?: ComponentType<TooltipPrimitiveProps>;
34
34
  /**
@@ -38,13 +38,13 @@ export interface TooltipProps {
38
38
  /**
39
39
  * Hide the tooltip when the click event is triggered. This should be
40
40
  * used when tooltip should be hidden if `onClick` react synthetic event
41
- * is triggered, which happens after `onMouseDown` event
41
+ * is triggered, which happens after `onMouseDown` event.
42
42
  */
43
43
  hideTooltipOnClick?: boolean;
44
44
  /**
45
45
  * Hide the tooltip when the mousedown event is triggered. This should be
46
46
  * used when tooltip should be hidden if `onMouseDown` react synthetic event
47
- * is triggered, which happens before `onClick` event
47
+ * is triggered, which happens before `onClick` event.
48
48
  */
49
49
  hideTooltipOnMouseDown?: boolean;
50
50
  /**
@@ -72,13 +72,13 @@ export interface TooltipProps {
72
72
  /**
73
73
  * Replace the wrapping element. This accepts the name of a html tag which will
74
74
  * be used to wrap the element.
75
- * If you provide a component it needs to support a ref prop which is used by popper for positioning
75
+ * If you provide a component it needs to support a ref prop which is used by popper for positioning.
76
76
  */
77
77
  tag?: keyof JSX.IntrinsicElements | React.ComponentType<React.AllHTMLAttributes<HTMLElement> & {
78
78
  ref: React.Ref<HTMLElement>;
79
79
  }>;
80
80
  /**
81
- * Show only one line of text, and truncate when too long
81
+ * Used to show only one line of text, and truncate when too long. Avoid this wherever possible, as any important information that is truncated will be visually hidden to the person reading the tooltip.
82
82
  */
83
83
  truncate?: boolean;
84
84
  /**
@@ -91,9 +91,9 @@ export interface TooltipProps {
91
91
  /**
92
92
  * A `testId` prop is provided for specified elements, which is a unique
93
93
  * string that appears as a data attribute `data-testid` in the rendered code,
94
- * serving as a hook for automated tests */
94
+ * serving as a hook for automated tests. */
95
95
  testId?: string;
96
- /** Analytics context metadata */
96
+ /** Analytics context metadata. */
97
97
  analyticsContext?: Record<string, any>;
98
98
  /**
99
99
  * Used to define the strategy of popper.
@@ -28,7 +28,7 @@ export interface TooltipProps {
28
28
  update?: () => void;
29
29
  }) => ReactNode);
30
30
  /**
31
- * Extend `TooltipPrimitive` to create your own tooltip and pass it as component
31
+ * Extend `TooltipPrimitive` to create your own tooltip and pass it as component.
32
32
  */
33
33
  component?: ComponentType<TooltipPrimitiveProps>;
34
34
  /**
@@ -38,13 +38,13 @@ export interface TooltipProps {
38
38
  /**
39
39
  * Hide the tooltip when the click event is triggered. This should be
40
40
  * used when tooltip should be hidden if `onClick` react synthetic event
41
- * is triggered, which happens after `onMouseDown` event
41
+ * is triggered, which happens after `onMouseDown` event.
42
42
  */
43
43
  hideTooltipOnClick?: boolean;
44
44
  /**
45
45
  * Hide the tooltip when the mousedown event is triggered. This should be
46
46
  * used when tooltip should be hidden if `onMouseDown` react synthetic event
47
- * is triggered, which happens before `onClick` event
47
+ * is triggered, which happens before `onClick` event.
48
48
  */
49
49
  hideTooltipOnMouseDown?: boolean;
50
50
  /**
@@ -72,13 +72,13 @@ export interface TooltipProps {
72
72
  /**
73
73
  * Replace the wrapping element. This accepts the name of a html tag which will
74
74
  * be used to wrap the element.
75
- * If you provide a component it needs to support a ref prop which is used by popper for positioning
75
+ * If you provide a component it needs to support a ref prop which is used by popper for positioning.
76
76
  */
77
77
  tag?: keyof JSX.IntrinsicElements | React.ComponentType<React.AllHTMLAttributes<HTMLElement> & {
78
78
  ref: React.Ref<HTMLElement>;
79
79
  }>;
80
80
  /**
81
- * Show only one line of text, and truncate when too long
81
+ * Used to show only one line of text, and truncate when too long. Avoid this wherever possible, as any important information that is truncated will be visually hidden to the person reading the tooltip.
82
82
  */
83
83
  truncate?: boolean;
84
84
  /**
@@ -91,9 +91,9 @@ export interface TooltipProps {
91
91
  /**
92
92
  * A `testId` prop is provided for specified elements, which is a unique
93
93
  * string that appears as a data attribute `data-testid` in the rendered code,
94
- * serving as a hook for automated tests */
94
+ * serving as a hook for automated tests. */
95
95
  testId?: string;
96
- /** Analytics context metadata */
96
+ /** Analytics context metadata. */
97
97
  analyticsContext?: Record<string, any>;
98
98
  /**
99
99
  * Used to define the strategy of popper.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/tooltip",
3
- "version": "18.1.1",
3
+ "version": "18.1.2",
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/"
@@ -42,13 +42,13 @@
42
42
  "./utilities": "./src/utilities.ts"
43
43
  },
44
44
  "dependencies": {
45
- "@atlaskit/analytics-next": "^9.1.0",
45
+ "@atlaskit/analytics-next": "^9.2.0",
46
46
  "@atlaskit/ds-lib": "^2.2.0",
47
47
  "@atlaskit/motion": "^1.5.0",
48
48
  "@atlaskit/popper": "^5.5.0",
49
49
  "@atlaskit/portal": "^4.4.0",
50
50
  "@atlaskit/theme": "^12.6.0",
51
- "@atlaskit/tokens": "^1.33.0",
51
+ "@atlaskit/tokens": "^1.38.0",
52
52
  "@babel/runtime": "^7.0.0",
53
53
  "@emotion/react": "^11.7.1",
54
54
  "bind-event-listener": "^2.1.1",
@@ -60,7 +60,7 @@
60
60
  },
61
61
  "devDependencies": {
62
62
  "@af/accessibility-testing": "*",
63
- "@atlaskit/button": "^17.2.0",
63
+ "@atlaskit/button": "^17.5.0",
64
64
  "@atlaskit/ssr": "*",
65
65
  "@atlaskit/visual-regression": "*",
66
66
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",