[Request] Ability to have hs.menubar items retain their same position upon startup/hs.reload (or at least next to the "main" Hammerspoon menubar item) rather than always reverting back to the left-most item

[dmattera]

Not sure this is even possible given the way Hammerspoon utilizes the APIs for hs.menubars/how the system behaves but just thought I'd raise the question. This is something that would benefit me and my personal workflow quite significantly as I utilize multiple hs.menubar items heavily and have a lot of non-HS items which means they aren't all always visible and so every time I reload, I have to move them all back to an always-visible section of menubar one by one.

Steps to reproduce:

1. Create and show a new hs.menubar item
2. Said menubar item will be placed at the end (left-most side) of all the existing menubar items
3. Cmd+click/drag the new item to a new position in the menubar
4. Perform hs.reload() or restart Hammerspoon enitrely
5. The hs.menubar item is placed back at the end of existing menubar items (unlike the "main" Hammerspoon menubar which, if you restarted Hammerspoon enitrely, will return to the position it occupied before the restart)

[DemoorBug]

Same problem, it resets to the leftmost side every time it starts, very annoying

[jeffheartmp]

bump on this!

[latenitefilms]

This might be helpful?

https://github.com/shergin/NSStatusBar-MISSINGOrder

EDIT: looks like Hammerspoon already had ability to set the "priority" but this no longer works on Catalina and above.

https://apple.stackexchange.com/a/399310

Mortennn/Dozer#69

[latenitefilms]

Maybe the issue is as simple as just not supplying the menubar items an autosavename?

https://developer.apple.com/documentation/appkit/nsstatusitem/1644022-autosavename

[asmagill]

We don't use autosaveName for menus, though we do for toolbar buttons.

We can't change menu position programmatically anymore -- that was removed in Catalina.

I do wonder if setting an autosaveName for the statusItem would remember position information... I can't think of a whole lot else that it might be saving... If you can't get to it sooner, I may try this weekend and see if I can add support for it so we can test it out.

[latenitefilms]

My guess is that it'll most likely fix things, as without an autosaveName, it won't be able to keep track of user-created menubar items. I'll try test it out today.

[latenitefilms]

I've just added a pull request (#3195) which seems to do the trick.

[jeffheartmp]

Hey @latenitefilms thank you for doing this, really cool stuff.

I checked out your branch, compiled Hammerspoon.app in Xcode, moved it to Applications folder, allowed permissions, then updated my .hammerspoon code to include this:

caffeine = hs.menubar.new()

function setCaffeineDisplay(state)
    --add the position on each click
    caffeine:autosaveName('caffeine');
    
    if state then
        caffeine:setTitle("U")      
    else 
        caffeine:setTitle("D")
    end
end

function caffeineClicked()
    setCaffeineDisplay(hs.caffeinate.toggle("displayIdle"))
end

After I move the icon, I click it to trigger the autosaveName method.

But after I reload hammerspoon, it shoots back to the left again.

Any ideas?

[latenitefilms]

Try setting the autosaveName when creating the menubar instead, as opposed to using the autosaveName method. I might need to tweak the method if it's not working as intended.

[latenitefilms]

I've just pushed a fix for the hs.menubar:autosaveName() method.

Here's some example code for testing:

a = hs.menubar.new(true, "A"):setTitle("A")
b = hs.menubar.new(true, "B"):setTitle("B")
c = hs.menubar.new(true):autosaveName("C"):setTitle("C")
z = hs.menubar.new(true):setTitle("Z") -- this won't save position

To test, run the above code in the Console, change the menubar icon positions, restart Hammerspoon, then run the code again.

[jeffheartmp]

When I try to build the hammerspoon app in Xcode I get this error:

WARN: Function/Method/Constructor description for hs.menubar:autosaveName([name]) should be a single line. Other content may belong in the Notes: section.

[jeffheartmp]

I've just pushed a fix for the hs.menubar:autosaveName() method.

Here's some example code for testing:

a = hs.menubar.new(true, "A"):setTitle("A")
b = hs.menubar.new(true, "B"):setTitle("B")
c = hs.menubar.new(true):autosaveName("C"):setTitle("C")
z = hs.menubar.new(true):setTitle("Z") -- this won't save position

To test, run the above code in the Console, change the menubar icon positions, restart Hammerspoon, then run the code again.

This worked on the last build that I made, thank you for the fix!

[latenitefilms]

Opps - I've fixed the documentation bug. Thanks!

[kusazh]

This doesn't work in the latest release. Was it included in release?

[dmattera]

This doesn't work in the latest release. Was it included in release?

It was not included

Commit was pushed about a month after the latest release.