Skip to main content

An easy and customisable ToolTip implementation for Tkinter

Project description

Downloads PyPI Latest Release Tests Documentation codecov PyPI - License Code style: black

GitHub Sponsor PyaPal

tkinter-tooltip

What this is

This is a simple yet fully customisable tooltip/pop-up implementation for tkinter widgets. It is capable of fully integrating with custom tkinter themes both light and dark ones.

alt

Features

  • normal tooltips
  • show tooltip with s seconds delay
  • tooltip tracks mouse cursor
  • tooltip displays strings and string returning functions
  • fully customisable, tooltip inherits underlying theme style

Install

pip install tkinter-tooltip

Examples

Normal tooltips

By default the tooltip activates when entering and/or moving in the widget are and deactivates when leaving and/or pressing any button.

alt

import tkinter as tk
import tkinter.ttk as ttk
from tktooltip import ToolTip

app = tk.Tk()
b = ttk.Button(app, text="Button")
b.pack()
ToolTip(b, msg="Hover info")
app.mainloop()

Delayed tooltip

alt

import tkinter as tk
import tkinter.ttk as ttk
from tktooltip import ToolTip

app = tk.Tk()
b = ttk.Button(app, text="Button")
b.pack()
ToolTip(b, msg="Hover info", delay=2.0)   # True by default
app.mainloop()

Tracking tooltip

Have the tooltip follow the mousse cursor around when moving.

alt

import tkinter as tk
import tkinter.ttk as ttk
from tktooltip import ToolTip

app = tk.Tk()
b = ttk.Button(app, text="Button")
b.pack()
ToolTip(b, msg="Hover info", follow=True)   # True by default
app.mainloop()

Function as tooltip

Here the tooltip returns the value of time.asctime() which updates with every movement. You can control the refresh rate of the ToolTip through the refresh argument by default it is set to 1s.

alt alt

import time
import tkinter as tk
import tkinter.ttk as ttk
from tktooltip import ToolTip

app = tk.Tk()
b = ttk.Button(app, text="Button")
b.pack()
# NOTE: pass the function itself not the return value
ToolTip(b, msg=time.asctime, delay=0)
app.mainloop()

Themed tooltip

tkinter-tooltip is fully aware of the underlying theme (in this case a dark theme), and can even be furher customised by passing tk styling arguments to the tooltip

alt

Style tooltip and underlying the button. If a full theme has been used then the ToolTip will inherit the settings of the theme by default.

import tkinter as tk
import tkinter.ttk as ttk
from tktooltip import ToolTip

app = tk.Tk()
s = ttk.Style()
s.configure("custom.TButton", foreground="#ffffff", background="#1c1c1c")
b = ttk.Button(app, text="Button", style="custom.TButton")
b.pack()
ToolTip(b, msg="Hover info", delay=0,
        parent_kwargs={"bg": "black", "padx": 5, "pady": 5},
        fg="#ffffff", bg="#1c1c1c", padx=10, pady=10)
app.mainloop()

Notes

  • Certain options do not match great with each other, a good example is follow and delay using small x/y offsets. This can cause the tooltip to appear inside the widget. Hovering over the tooltip will cause it to disappear and reappear, in a new position, potentially again inside the widget.

Contributing

You can find the instructions on how to contribute in this project in the CONTRIBUTING.md file.

Acknowledgements

tkinter-tooltip is based on the original work performed by Tucker Beck licensed under an MIT License.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tkinter_tooltip-3.1.2.tar.gz (859.8 kB view details)

Uploaded Source

Built Distribution

tkinter_tooltip-3.1.2-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file tkinter_tooltip-3.1.2.tar.gz.

File metadata

  • Download URL: tkinter_tooltip-3.1.2.tar.gz
  • Upload date:
  • Size: 859.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for tkinter_tooltip-3.1.2.tar.gz
Algorithm Hash digest
SHA256 dac8a6720c851936dfea2d96f90920a4dac31b46b78379c5e0ef0b6ed8af2964
MD5 95feaee67a62034e093c2459094c193a
BLAKE2b-256 a9f1e864d09013055e4c372995214efbd217415d8c8e91af2dbc91aaabe81f39

See more details on using hashes here.

File details

Details for the file tkinter_tooltip-3.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for tkinter_tooltip-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5bad74f2d476d9e2418598b2438f06e4b658dd6a89ee39a0bbfebb4fb7fdeb7f
MD5 15007e22433a90f90a07f49d05c4afb2
BLAKE2b-256 faa0b1d00dce752c2a3dad72515196da8b40816eac8385b2f901352cee9086c5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page