https://github.com/niklashenning/pyqttooltip
A modern and fully customizable tooltip library for PyQt and PySide
https://github.com/niklashenning/pyqttooltip
customizable modern pypi pypi-package pyqt pyqt5 pyqt6 pyside2 pyside6 python tooltip
Last synced: 8 months ago
JSON representation
A modern and fully customizable tooltip library for PyQt and PySide
- Host: GitHub
- URL: https://github.com/niklashenning/pyqttooltip
- Owner: niklashenning
- License: mit
- Created: 2024-05-12T16:49:21.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-17T09:04:02.000Z (about 1 year ago)
- Last Synced: 2025-03-18T02:01:41.689Z (8 months ago)
- Topics: customizable, modern, pypi, pypi-package, pyqt, pyqt5, pyqt6, pyside2, pyside6, python, tooltip
- Language: Python
- Homepage: https://pypi.org/project/pyqttooltip/
- Size: 59.6 KB
- Stars: 32
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyQt Tooltip
[](https://pypi.org/project/pyqttooltip/)
[](https://github.com/niklashenning/pyqttooltip)
[](https://github.com/niklashenning/pyqttooltip)
[](https://github.com/niklashenning/pyqttooltip)
[](https://github.com/niklashenning/pyqttooltip/blob/master/LICENSE)
A modern and fully customizable tooltip library for PyQt and PySide
## Features
- Fixed and automatic placement
- Supports fallback placements
- Customizable triangle
- Customizable animations and delays
- Fully customizable and modern UI
- Works with `PyQt5`, `PyQt6`, `PySide2`, and `PySide6`
## Installation
```
pip install pyqttooltip
```
## Usage
```python
from PyQt6.QtWidgets import QMainWindow, QPushButton
from pyqttooltip import Tooltip, TooltipPlacement
class Window(QMainWindow):
def __init__(self):
super().__init__(parent=None)
# Add button
self.button = QPushButton('Button', self)
# Add tooltip to button
self.tooltip = Tooltip(self.button, 'This is a tooltip')
```
The tooltip will automatically be shown while hovering the widget. If you want to manually
show and hide the tooltip, you can use the `show()` and `hide()` methods:
```python
tooltip.show()
tooltip.hide()
```
To delete a tooltip, you can use the `deleteLater()` method:
```python
tooltip.deleteLater()
```
To get notified when a tooltip gets shown or hidden, you can subscribe to the `shown` and `hidden` signals:
```python
tooltip.shown.connect(lambda: print('shown'))
tooltip.hidden.connect(lambda: print('hidden'))
```
## Customization
* **Setting the widget:**
```python
tooltip.setWidget(widget) # Default: None
```
* **Setting the text:**
```python
tooltip.setText('Text of the tooltip') # Default: ''
```
* **Setting the placement:**
```python
tooltip.setPlacement(TooltipPlacement.RIGHT) # Default: TooltipPlacement.AUTO
```
> **AVAILABLE PLACEMENTS:**
`AUTO`, `LEFT`, `RIGHT`, `TOP`, `BOTTOM`
* **Setting the fallback placements:**
```python
tooltip.setFallbackPlacements([TooltipPlacement.TOP, TooltipPlacement.BOTTOM]) # Default: []
```
> If the tooltip doesn't fit on the screen with the primary placement, one of the
> fallback placements will be chosen instead in the order of the provided list.
>
To get the current placement of the tooltip, you can use the `getActualPlacement()` method.
* **Enabling or disabling the triangle:**
```python
tooltip.setTriangleEnabled(False) # Default: True
```
* **Setting the size of the triangle:**
```python
tooltip.setTriangleSize(7) # Default: 5
```
* **Setting a duration:**
```python
tooltip.setDuration(1000) # Default: 0
```
> The duration is the time in milliseconds after which the tooltip will start fading out again.
> If the duration is set to `0`, the tooltip will stay visible for as long as the widget is hovered.
* **Setting the offsets:**
```python
# Setting the offset for a specific placement
tooltip.setOffsetByPlacement(TooltipPlacement.LEFT, QPoint(-10, 5))
# Using a dict that specifies the offset for each placement you want to set
offsets = {
TooltipPlacement.LEFT: QPoint(-10, 5),
TooltipPlacement.RIGHT: QPoint(10, 5),
TooltipPlacement.TOP: QPoint(5, -10),
TooltipPlacement.BOTTOM: QPoint(5, 10)
}
tooltip.setOffsets(offsets)
# Setting the offsets for all the placements to a single value
tooltip.setOffsetsAll(QPoint(10, 5))
```
> Each placement / side has its own offset to allow for full customizability.
> Each offset is a QPoint, which is made up of an x and y value.
>
By default, all the offsets are set to `QPoint(0, 0)`.
* **Adding delays to the fade in / out animations after hovering the widget:**
```python
tooltip.setShowDelay(500) # Default: 50
tooltip.setHideDelay(500) # Default: 50
```
* **Setting the durations of the fade in / out animations:**
```python
tooltip.setFadeInDuration(250) # Default: 150
tooltip.setFadeOutDuration(250) # Default: 150
```
* **Setting the border radius:**
```python
tooltip.setBorderRadius(0) # Default: 2
```
* **Enabling or disabling the border:**
```python
tooltip.setBorderEnabled(True) # Default: False
```
* **Setting custom colors:**
```python
tooltip.setBackgroundColor(QColor('#FCBA03')) # Default: QColor('#111214')
tooltip.setTextColor(QColor('#000000')) # Default: QColor('#CFD2D5')
tooltip.setBorderColor(QColor('#A38329')) # Default: QColor('#403E41')
```
* **Setting a custom font:**
```python
tooltip.setFont(QFont('Consolas', 10)) # Default: QFont('Arial', 9, QFont.Weight.Bold)
```
* **Applying margins to the content of the tooltip:**
```python
tooltip.setMargins(QMargins(10, 8, 10, 8)) # Default: QMargins(12, 8, 12, 7)
```
* **Setting a maximum width:**
```python
tooltip.setMaximumWidth(150) # Default: 16777215 (QWIDGETSIZE_MAX)
```
* **Enabling or disabling text centering for wrapped text:**
```python
tooltip.setTextCenteringEnabled(False) # Default: True
```
* **Enabling or disabling the drop shadow:**
```python
tooltip.setDropShadowEnabled(False) # Default: True
```
* **Changing the drop shadow strength:**
```python
tooltip.setDropShadowStrength(3.5) # Default: 2.0
```
* **Making the tooltip translucent:**
```python
tooltip.setOpacity(0.8) # Default: 1.0
```
**
Other customization options:**
| Option | Description | Default |
|-----------------------------|---------------------------------------------------------------|----------------------------|
| `setShowingOnDisabled()` | Whether the tooltips should also be shown on disabled widgets | `False` |
| `setFadeInEasingCurve()` | The easing curve of the fade in animation | `QEasingCurve.Type.Linear` |
| `setFadeOutEasingCurve()` | The easing curve of the fade out animation | `QEasingCurve.Type.Linear` |
| `setMarginLeft()` | Set left margin individually | `12` |
| `setMarginRight()` | Set right margin individually | `12` |
| `setMarginTop()` | Set top margin individually | `8` |
| `setMarginBottom()` | Set bottom margin individually | `7` |
## Demo
https://github.com/user-attachments/assets/fa768d30-f3cc-4883-aa8b-fed3a8824b23
The demos for PyQt5, PyQt6, and PySide6 can be found in the [demo](https://github.com/niklashenning/pyqttooltip/blob/master/demo) folder.
> To keep the demo simple, only the most important features are included.
> To get an overview of all the customization options, check out the documentation above.
## Tests
Installing the required test dependencies [PyQt6](https://pypi.org/project/PyQt6/), [pytest](https://github.com/pytest-dev/pytest), and [coveragepy](https://github.com/nedbat/coveragepy):
```
pip install PyQt6 pytest coverage
```
To run the tests with coverage, clone this repository, go into the main directory and run:
```
coverage run -m pytest
coverage report --ignore-errors -m
```
## License
This software is licensed under the [MIT license](https://github.com/niklashenning/pyqttooltip/blob/master/LICENSE).