awesomeWM/awesome

Make tool tips indicate the action that a click will acheive

Open

#3,539 opened on Dec 29, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Lua (6,882 stars) (620 forks)batch import
good first issue

Description

The tool tips that display, upon hovering over a window's title-bar-buttons, would be more helpful to newcomers if the text shown was based on the current state of that toggle button.

For example, if a window is maximized, the tool tip could say "unmaximize", and if the window is not maximized it could say "maximize". Similar state-based tool-tips could be applied to all title-bar-buttons, instead of just statically displaying the same text across all states.

I realize that the icons themselves change based on state, but as a new user (who is unfamiliar with these pictorial states), I would appreciate tool tips that are more dynamically informative and less static. I understand that a lot of advanced users remove these title bars completely. So, it would be nice if their behavior catered more to newcomers.

awesome v4.3 (Too long) • Compiled against Lua 5.3.3 (running with Lua 5.3) • D-Bus support: ✔ • execinfo support: ✔ • xcb-randr version: 1.6 • LGI version: 0.9.2

Contributor guide

Tech stack
lua
Domain
desktop
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Lua basicsawesomeWM widget API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
The issue requests dynamic tooltips on title bar buttons based on window state. To implement, examine the titlebar button definitions in the `awful` module, likely in `lib/awful/titlebar.lua`. Modify tooltip text dynamically by checking client properties like `maximized`. The codebase is Lua, so focus on relevant Lua files under `lib/awful/`.