Skip to content

Commit

Permalink
Add ZeroOffset Spoon (#329)
Browse files Browse the repository at this point in the history
  • Loading branch information
@gavinest
gavinest authored Feb 27, 2025
1 parent 43b4fba commit 6f01453
Show file tree
Hide file tree
Showing 3 changed files with 338 additions and 0 deletions.
217 changes: 217 additions & 0 deletions Source/ZeroOffset.spoon/docs.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
[
{
"Constant" : [

],
"submodules" : [

],
"Function" : [

],
"Variable" : [

],
"stripped_doc" : [

],
"type" : "Module",
"Deprecated" : [

],
"desc" : "Display UTC time in the menu bar",
"Constructor" : [

],
"Field" : [

],
"Method" : [
{
"doc" : "Initial setup for ZeroOffset\n\nParameters:\n * None\n\nReturns:\n * The ZeroOffset object",
"desc" : "Initial setup for ZeroOffset",
"def" : "ZeroOffset:init()",
"stripped_doc" : [
"Initial setup for ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:init()",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "init",
"parameters" : [
" * None",
""
]
},
{
"doc" : "Starts ZeroOffset\n\nParameters:\n * None\n\nReturns:\n * The ZeroOffset object",
"desc" : "Starts ZeroOffset",
"def" : "ZeroOffset:start()",
"stripped_doc" : [
"Starts ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:start()",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "start",
"parameters" : [
" * None",
""
]
},
{
"doc" : "Stops ZeroOffset\n\nParameters:\n * None\n\nReturns:\n * The ZeroOffset object",
"desc" : "Stops ZeroOffset",
"def" : "ZeroOffset:stop()",
"stripped_doc" : [
"Stops ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:stop()",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "stop",
"parameters" : [
" * None",
""
]
},
{
"doc" : "Binds hotkeys for ZeroOffset\n\nParameters:\n * mapping - A table containing hotkey objifier\/key details for the following items:\n * toggle - This will toggle the display of the UTC time in menubar\n\nReturns:\n * The ZeroOffset object",
"desc" : "Binds hotkeys for ZeroOffset",
"def" : "ZeroOffset:bindHotkeys(mapping)",
"stripped_doc" : [
"Binds hotkeys for ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:bindHotkeys(mapping)",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "bindHotkeys",
"parameters" : [
" * mapping - A table containing hotkey objifier\/key details for the following items:",
" * toggle - This will toggle the display of the UTC time in menubar",
""
]
}
],
"Command" : [

],
"items" : [
{
"doc" : "Binds hotkeys for ZeroOffset\n\nParameters:\n * mapping - A table containing hotkey objifier\/key details for the following items:\n * toggle - This will toggle the display of the UTC time in menubar\n\nReturns:\n * The ZeroOffset object",
"desc" : "Binds hotkeys for ZeroOffset",
"def" : "ZeroOffset:bindHotkeys(mapping)",
"stripped_doc" : [
"Binds hotkeys for ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:bindHotkeys(mapping)",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "bindHotkeys",
"parameters" : [
" * mapping - A table containing hotkey objifier\/key details for the following items:",
" * toggle - This will toggle the display of the UTC time in menubar",
""
]
},
{
"doc" : "Initial setup for ZeroOffset\n\nParameters:\n * None\n\nReturns:\n * The ZeroOffset object",
"desc" : "Initial setup for ZeroOffset",
"def" : "ZeroOffset:init()",
"stripped_doc" : [
"Initial setup for ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:init()",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "init",
"parameters" : [
" * None",
""
]
},
{
"doc" : "Starts ZeroOffset\n\nParameters:\n * None\n\nReturns:\n * The ZeroOffset object",
"desc" : "Starts ZeroOffset",
"def" : "ZeroOffset:start()",
"stripped_doc" : [
"Starts ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:start()",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "start",
"parameters" : [
" * None",
""
]
},
{
"doc" : "Stops ZeroOffset\n\nParameters:\n * None\n\nReturns:\n * The ZeroOffset object",
"desc" : "Stops ZeroOffset",
"def" : "ZeroOffset:stop()",
"stripped_doc" : [
"Stops ZeroOffset",
""
],
"notes" : [

],
"signature" : "ZeroOffset:stop()",
"type" : "Method",
"returns" : [
" * The ZeroOffset object"
],
"name" : "stop",
"parameters" : [
" * None",
""
]
}
],
"doc" : "Display UTC time in the menu bar\n\nDownload: [https:\/\/github.com\/gavinest\/ZeroOffset\/blob\/main\/Spoons\/ZeroOffset.spoon.zip](https:\/\/github.com\/gavinest\/ZeroOffset\/blob\/main\/Spoons\/ZeroOffset.spoon.zip)",
"name" : "ZeroOffset"
}
]
Binary file added Source/ZeroOffset.spoon/icon.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
121 changes: 121 additions & 0 deletions Source/ZeroOffset.spoon/init.lua
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
--- === ZeroOffset ===
---
--- Display UTC time in the menu bar
---
--- Download: [https://github.com/gavinest/ZeroOffset/blob/main/Spoons/ZeroOffset.spoon.zip](https://github.com/gavinest/ZeroOffset/blob/main/Spoons/ZeroOffset.spoon.zip)

local obj = {
hs = hs,
}
obj.__index = obj

-- Metadata
obj.name = "ZeroOffset"
obj.version = "0.0.0"
obj.author = "Gavin Estenssoro"
obj.homepage = "https://github.com/gavinest/ZeroOffset"
obj.license = "MIT - https://opensource.org/licenses/MIT"

--- ZeroOffset:init()
--- Method
--- Initial setup for ZeroOffset
---
--- Parameters:
--- * None
---
--- Returns:
--- * The ZeroOffset object
function obj:init()
self.menuBarItem = nil
self.hotKeyToggle = nil
self.showUtc = false
self.timer = self.hs.timer.new(1, function() self:updateMenuText() end)
return self
end

--- ZeroOffset:start()
--- Method
--- Starts ZeroOffset
---
--- Parameters:
--- * None
---
--- Returns:
--- * The ZeroOffset object
function obj:start()
if self.menuBarItem then self:stop() end
self.menuBarItem = self.hs.menubar.new()
self.menuBarItem:setClickCallback(function() self:clicked() end)

if self.hotKeyToggle then self.hotKeyToggle:enable() end

self:toggleShowUtc()
return self
end

--- ZeroOffset:stop()
--- Method
--- Stops ZeroOffset
---
--- Parameters:
--- * None
---
--- Returns:
--- * The ZeroOffset object
function obj:stop()
self.timer:stop()

if self.menuBarItem then
self.menuBarItem:delete()
self.menuBarItem = nil
end

if self.hotKeyToggle then
self.hotKeyToggle:disable()
self.hotKeyToggle = nil
end
return self
end

--- ZeroOffset:bindHotkeys(mapping)
--- Method
--- Binds hotkeys for ZeroOffset
---
--- Parameters:
--- * mapping - A table containing hotkey objifier/key details for the following items:
--- * toggle - This will toggle the display of the UTC time in menubar
---
--- Returns:
--- * The ZeroOffset object
function obj:bindHotkeys(mapping)
if self.hotKeyToggle then self.hotKeyToggle:delete() end
local toggleMods = mapping["toggle"][1]
local toggleKey = mapping["toggle"][2]
self.hotKeyToggle = self.hs.hotkey.new(toggleMods, toggleKey, function() self:clicked() end)
return self
end

function obj:toggleShowUtc()
if self.showUtc then
self:updateMenuText()
self.timer:start()
self.menuBarItem:setIcon(nil)
else
self.timer:stop()
self.menuBarItem:setTitle(nil)
local iconPath = self.hs.spoons.resourcePath("icon.png")
self.menuBarItem:setIcon(self.hs.image.imageFromPath(iconPath):setSize({w=24,h=24}))
end
self.showUtc = not self.showUtc
end

function obj:clicked()
self:toggleShowUtc()
end

function obj:updateMenuText()
local utc_time = os.date("!%Y-%m-%d %H:%M:%S")
self.menuBarItem:setTitle(utc_time .. ' UTC')
end

return obj

0 comments on commit 6f01453

Please sign in to comment.