Skip to content

Commit

Permalink
docs: switch to mouseover and mouseout as default events
Browse files Browse the repository at this point in the history
  • Loading branch information
@gabrieljablonski
gabrieljablonski committed Jun 16, 2024
1 parent f85c6d8 commit 193b3b4
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/docs/options.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@ import { Tooltip } from 'react-tooltip';
| ~~`closeOnEsc`~~ | ~~`boolean`~~ | ~~no~~ | ~~`false`~~ | ~~`true` `false`~~ | ~~Pressing escape key will close the tooltip~~ <br/>**DEPRECATED**<br/>Use `globalCloseEvents` instead. |
| ~~`closeOnScroll`~~ | ~~`boolean`~~ | ~~no~~ | ~~`false`~~ | ~~`true` `false`~~ | ~~Scrolling will close the tooltip~~ <br/>**DEPRECATED**<br/>Use `globalCloseEvents` instead. |
| ~~`closeOnResize`~~ | ~~`boolean`~~ | ~~no~~ | ~~`false`~~ | ~~`true` `false`~~ | ~~Resizing the window will close the tooltip~~ <br/>**DEPRECATED**<br/>Use `globalCloseEvents` instead. |
| `openEvents` | `Record<string, boolean>` | no | `mouseenter` `focus` `mouseover` | `mouseenter` `focus` `mouseover` `click` `dblclick` `mousedown` | Events to be listened on the anchor elements to open the tooltip |
| `closeEvents` | `Record<string, boolean>` | no | `mouseleave` `blur` `mouseout` | `mouseleave` `blur` `mouseout` `click` `dblclick` `mouseup` | Events to be listened on the anchor elements to close the tooltip |
| `openEvents` | `Record<string, boolean>` | no | `mouseover` `focus` | `mouseover` `focus` `mouseenter` `click` `dblclick` `mousedown` | Events to be listened on the anchor elements to open the tooltip |
| `closeEvents` | `Record<string, boolean>` | no | `mouseout` `blur` | `mouseout` `blur` `mouseleave` `click` `dblclick` `mouseup` | Events to be listened on the anchor elements to close the tooltip |
| `globalCloseEvents` | `Record<string, boolean>` | no | | `escape` `scroll` `resize` `clickOutsideAnchor` | Global events to be listened to close the tooltip (`escape` closes on pressing `ESC`, `clickOutsideAnchor` is useful with click events on `openEvents`) |
| `imperativeModeOnly` | `boolean` | no | `false` | `true` `false` | When enabled, default tooltip behavior is disabled. Check [the examples](./examples/imperative-mode.mdx) for more details |
| `style` | `CSSProperties` | no | | a CSS style object | Add inline styles directly to the tooltip |
Expand Down

0 comments on commit 193b3b4

Please sign in to comment.