search

swaywm / sway

i3-compatible Wayland compositor
https://swaywm.org
MIT License
14.77k stars 1.11k forks source link

swaybar click event contains an undocumented "scale" property #7114

Open jwtrhs opened 2 years ago

jwtrhs commented 2 years ago

Sway 1.7

The click event JSON object sent by swaybar contains a "scale" property that's not documented by the swaybar-protocol man page.

https://github.com/swaywm/sway/blob/6b97c4fa710975586a701a9491fe461499a4b6dc/swaybar/i3bar.c#L304

It looks like it's not part of the i3bar click event.

https://github.com/i3/i3/blob/9db03797da3cea5dc6898adc79a68ba4523a409c/i3bar/src/child.c#L641

I only encountered this issue writing my own bar script and trying to strictly pass the JSON object as documented.

Is it worth adding this to the man page and noting the difference to i3bar-protocol?

emersion commented 2 years ago

Some extra undocumented fields may be added by Sway to the IPC messages, yes. These are missing from the docs on purpose, because they're experimental or subject to breaking changes.

For this particular case (scale field), we'd need to discuss to decided whether or not we should keep the status quo, remove the field, or document it.