@synerise/ds-tooltip 1.4.8 → 1.4.9

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 (3) hide show
  1. package/CHANGELOG.md +4 -0
  2. package/README.md +22 -43
  3. package/package.json +6 -6
package/CHANGELOG.md CHANGED
@@ -3,6 +3,10 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [1.4.9](https://github.com/synerise/synerise-design/compare/@synerise/ds-tooltip@1.4.8...@synerise/ds-tooltip@1.4.9) (2026-03-20)
7
+
8
+ **Note:** Version bump only for package @synerise/ds-tooltip
9
+
6
10
  ## [1.4.8](https://github.com/synerise/synerise-design/compare/@synerise/ds-tooltip@1.4.7...@synerise/ds-tooltip@1.4.8) (2026-03-09)
7
11
 
8
12
  **Note:** Version bump only for package @synerise/ds-tooltip
package/README.md CHANGED
@@ -11,46 +11,25 @@ Tooltip UI Component
11
11
 
12
12
  ## API
13
13
 
14
- | Property | Description | Type | Default |
15
- | --------------------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
16
- | align | this value will be merged into placement's config, please refer to the settings rc-tooltip | Object | - |
17
- | arrowPointAtCenter | Whether the arrow is pointed at the center of target, supported after `antd@1.11+` | boolean | `false` |
18
- | autoAdjustOverflow | Whether to adjust popup placement automatically when popup is off screen | boolean | `true` |
19
- | button | Button to display in tooltip footer | ReactNode | - |
20
- | defaultVisible | Whether the floating tooltip card is visible by default | boolean | `false` |
21
- | description | tooltip description text | ReactNode | - |
22
- | image | iamge to be rendered above the description | ReactNode | - |
23
- | getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | ()=>React.HTMLElement | () => document.body |
24
- | icon | icon that can be displayed next to title | React.ReactNode | NotificationsM, orange-500 |
25
- | mouseEnterDelay | Delay in seconds, before tooltip is shown on mouse enter | number | `0.1` |
26
- | mouseLeaveDelay | Delay in seconds, before tooltip is hidden on mouse leave | number | `0.1` |
27
- | offset | size of space between trigger and tooltip, you should set `small` when the you use `Icon` as a trigger | `default`, `small` | `default` |
28
- | onVisibleChange | Callback executed when visibility of the tooltip card is changed | (visible: boolean) => void | - |
29
- | overlayClassName | Class name of the tooltip card | string | - |
30
- | overlayStyle | Style of the tooltip card | object | - |
31
- | placement | The position of the tooltip relative to the target. | `top` / `left` / `right` / `bottom` / `topLeft` / `topRight` / `bottomLeft` / `bottomRight` / `leftTop` / `leftBottom` / `rightTop` / `rightBottom` | `top` |
32
- | title | tooltip title text | string | - |
33
- | trigger | Tooltip trigger mode | `hover`, `focus`, `click`, | `hover` |
34
- | tutorialAutoplay | Whether to autoplay tutorial | boolean | `false` |
35
- | tutorialAutoplaySpeed | speed of autoplay [ms] | number | 5000 |
36
- | tutorials | steps of tutorial | Tutorials[] | - |
37
- | type | type of tooltip | `default` / `icon` / `largeSimple` / `largeScrollable` / `tutorial` / `avatar` / `button` / `header-label` / `status` | `default` |
38
- | visible | Whether the floating tooltip card is visible or not | boolean | `false` |
39
- | timeToHideAfterClick | time after which tooltip disappears [ms] (value 0 inactivate this functionality) | number | 0 |
40
- | render | render prop that allows to render custom component as tooltip | () => React.ReactNode | - |
41
- | disabled | Determines if tooltip is disabled | boolean | `false` |
42
-
43
- ### ButtonSettings
44
-
45
- | Property | Description | Type | Default |
46
- | ---------- | ------------------------------------------- | ------------------------ | ------- |
47
- | buttonIcon | Icon of button | React.ReactNode | - |
48
- | label | Label of button | React.ReactNode / string | - |
49
- | onClick | Callback executed after clicking the button | () => void | - |
50
-
51
- ### Tutorial
52
-
53
- | Property | Description | Type | Default |
54
- | ----------- | ---------------------------- | ------------------------ | ------- |
55
- | title | title of tutorial step | string / React.ReactNode | - |
56
- | description | description of tutorial step | string / React.ReactNode | - |
14
+ | Property | Description | Type | Default |
15
+ | -------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |
16
+ | button | Button to display in tooltip footer | ReactNode | - |
17
+ | description | Tooltip description text. Only rendered when `type` is `largeSimple` or `largeScrollable`. | ReactNode | - |
18
+ | disabled | Determines if tooltip is disabled — renders children directly without a wrapper | boolean | - |
19
+ | getPopupContainer | The DOM container of the tip, the default behavior is to create a `div` element in `body` | `() => HTMLElement` | `() => document.body` |
20
+ | icon | Icon displayed inline before the title text | ReactNode | - |
21
+ | image | Image/node rendered between title and description | ReactNode | - |
22
+ | offset | Space between trigger and tooltip: `default` = 8 px, `small` = 4 px | `'default'` \| `'small'` | `'default'` |
23
+ | onOpenChange | Callback executed when visibility of the tooltip changes | `(newOpen: boolean) => void` | - |
24
+ | open | Controlled open state | boolean | - |
25
+ | overlayStyle | Inline style applied to the tooltip content wrapper | CSSProperties | - |
26
+ | placement | The position of the tooltip relative to the target | `'top'` \| `'topLeft'` \| `'topCenter'` \| `'topRight'` \| `'bottom'` \| `'bottomLeft'` \| `'bottomCenter'` \| `'bottomRight'` \| `'left'` \| `'leftTop'` \| `'leftBottom'` \| `'right'` \| `'rightTop'` \| `'rightBottom'` | `'top'` |
27
+ | popoverProps | Additional props forwarded to the underlying `<Popover>` (escape hatch) | `Omit<PopoverOptions, 'zIndex' \| 'getPopupContainer'>` | - |
28
+ | render | Custom render prop — when provided, all structured content props are ignored | `() => ReactNode` | - |
29
+ | shortCuts | Keyboard hint(s) rendered as styled key badges beside the title | `ReactNode \| ReactNode[]` | - |
30
+ | status | Content rendered above the title row (e.g. a status badge) | ReactNode | - |
31
+ | timeToHideAfterClick | Time in ms after which tooltip auto-hides when `trigger` includes `'click'`. `0` disables auto-hide. | number | `0` |
32
+ | title | Tooltip title text or node | ReactNode | - |
33
+ | trigger | Tooltip trigger mode | `'hover'` \| `'click'` \| `Array<'hover' \| 'click'>` | `'hover'` |
34
+ | type | Visual variant of the tooltip | `'default'` \| `'largeSimple'` \| `'largeScrollable'` | `'default'` |
35
+ | zIndex | CSS z-index for the floating layer | number | theme `zindex-tooltip` |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@synerise/ds-tooltip",
3
- "version": "1.4.8",
3
+ "version": "1.4.9",
4
4
  "description": "Tooltip UI Component for the Synerise Design System",
5
5
  "license": "ISC",
6
6
  "repository": "synerise/synerise-design",
@@ -36,10 +36,10 @@
36
36
  "types": "dist/index.d.ts",
37
37
  "dependencies": {
38
38
  "@floating-ui/react": "^0.27.16",
39
- "@synerise/ds-icon": "^1.14.1",
40
- "@synerise/ds-popover": "^1.5.1",
41
- "@synerise/ds-scrollbar": "^1.2.15",
42
- "@synerise/ds-utils": "^1.6.0"
39
+ "@synerise/ds-icon": "^1.15.0",
40
+ "@synerise/ds-popover": "^1.5.2",
41
+ "@synerise/ds-scrollbar": "^1.2.16",
42
+ "@synerise/ds-utils": "^1.7.0"
43
43
  },
44
44
  "peerDependencies": {
45
45
  "@synerise/ds-core": "*",
@@ -49,5 +49,5 @@
49
49
  "devDependencies": {
50
50
  "@testing-library/user-event": "^14.6.1"
51
51
  },
52
- "gitHead": "8dfafc5d7278f09d430f1e7499782d05c76b47c0"
52
+ "gitHead": "8efc031fa688c0b87c7b3915bae93546bb63bcac"
53
53
  }