feat: toggling returns visible value (#73)

tris203 · Jun 16, 2024 · 6aab38a · 6aab38a
1 parent 7a76d43
commit 6aab38a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -80,6 +80,16 @@ or
 require("precognition").toggle()
 ```
 
+The return value indicating the visible state can be used to produce a notification.
+
+```lua
+if require("precognition").toggle() then
+    vim.notify("precognition on")
+else
+    vim.notify("precognition off")
+end
+```
+
 The subcommands and functions `show` and `hide` are also available.
 
 ### Peeking

diff --git a/lua/precognition/init.lua b/lua/precognition/init.lua
@@ -407,12 +407,14 @@ function M.hide()
 end
 
 --- Toggle automatic showing of hints
+--- with return value indicating the visible state
 function M.toggle()
     if visible then
         M.hide()
     else
         M.show()
     end
+    return visible
 end
 
 ---@param opts Precognition.PartialConfig