feat: add vim cmd to toggle between theme modes

Author: scottmckendry

README.md

@@ -136,6 +136,34 @@ require("cyberdream").setup({
 })
 ```
 
+## 🧑‍🍳 Recipes
+
+Include these alongside the `setup` function to add additional functionality to the theme.
+
+#### Map a key to toggle between light and dark mode
+
+```lua
+-- Add a custom keybinding to toggle the colorscheme
+vim.api.nvim_set_keymap("n", "<leader>tt", ":CyberdreamToggleMode<CR>", { noremap = true, silent = true })
+```
+
+#### Create an `autocmd` to hook into the toggle event and run custom code
+
+```lua
+-- The event data property will contain a string with either "default" or "light" respectively
+vim.api.nvim_create_autocmd("User", {
+    pattern = "CyberdreamToggleMode",
+    callback = function(event)
+        -- Your custom code here!
+        -- For example, notify the user that the colorscheme has been toggled
+        print("Switched to " .. event.data .. " mode!")
+    end,
+})
+```
+
+![image](https://github.com/scottmckendry/cyberdream.nvim/assets/39483124/c0188d60-d62b-4a15-965d-a19757c484e6)
+
+
 ## 🤝 Contributing
 
 Pull requests are welcome. If a plugin you use is not supported, please open an issue and I'll try to add support for it. If you have any suggestions or feedback, please open an issue.

doc/cyberdream.txt

@@ -7,6 +7,7 @@ Table of Contents                               *cyberdream-table-of-contents*
   - Installation                                     |cyberdream-installation|
   - Usage                                                   |cyberdream-usage|
   - Configuring                                       |cyberdream-configuring|
+  - ‍ Recipes                                       |cyberdream-‍-recipes|
   - Contributing                                     |cyberdream-contributing|
 1. Links                                                    |cyberdream-links|
 
@@ -126,6 +127,35 @@ their default values:
 <
 
 
+‍ RECIPES                                           *cyberdream-‍-recipes*
+
+Include these alongside the `setup` function to add additional functionality to
+the theme.
+
+
+MAP A KEY TO TOGGLE BETWEEN LIGHT AND DARK MODE
+
+>lua
+    -- Add a custom keybinding to toggle the colorscheme
+    vim.api.nvim_set_keymap("n", "<leader>tt", ":CyberdreamToggleMode<CR>", { noremap = true, silent = true })
+<
+
+
+CREATE AN AUTOCMD TO HOOK INTO THE TOGGLE EVENT AND RUN CUSTOM CODE
+
+>lua
+    -- The event data property will contain a string with either "default" or "light" respectively
+    vim.api.nvim_create_autocmd("User", {
+        pattern = "CyberdreamToggleMode",
+        callback = function(event)
+            -- Your custom code here!
+            -- For example, notify the user that the colorscheme has been toggled
+            print("Switched to " .. event.data .. " mode!")
+        end,
+    })
+<
+
+
 CONTRIBUTING                                         *cyberdream-contributing*
 
 Pull requests are welcome. If a plugin you use is not supported, please open an
@@ -137,6 +167,7 @@ feedback, please open an issue.
 
 1. *image*: https://github.com/scottmckendry/cyberdream.nvim/assets/39483124/55ad863e-11e6-4539-bf67-118ea328fb5b
 2. *image*: https://github.com/scottmckendry/cyberdream.nvim/assets/39483124/387a32f3-da38-4e96-b1e6-ea55591ec9ae
+3. *image*: https://github.com/scottmckendry/cyberdream.nvim/assets/39483124/c0188d60-d62b-4a15-965d-a19757c484e6
 
 Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
 

lua/cyberdream/config.lua

@@ -32,6 +32,7 @@ M.options = {}
 ---@param options Config|nil
 function M.setup(options)
     M.options = vim.tbl_deep_extend("force", {}, default_options, options or {})
+    vim.g.cyberdream_opts = M.options
 end
 
 M.setup()

lua/cyberdream/init.lua

@@ -12,4 +12,10 @@ M.setup = config.setup
 
 M.colorscheme = M.load
 
+vim.api.nvim_create_user_command("CyberdreamToggleMode", function()
+    local new_variant = util.toggle_theme_variant()
+    util.toggle_lualine_theme(new_variant)
+    vim.api.nvim_exec_autocmds("User", { pattern = "CyberdreamToggleMode", data = new_variant })
+end, {})
+
 return M

lua/cyberdream/util.lua

@@ -1,4 +1,5 @@
 local ts = require("cyberdream.treesitter")
+local config = require("cyberdream.config")
 local M = {}
 
 --- Sets the highlight group to the given table of colors.
@@ -98,4 +99,48 @@ function M.parse_extra_template(template, t)
     return template
 end
 
+--- Override options with a new table of values.
+--- @param new_opts Config
+--- @return Config
+function M.set_options(new_opts)
+    local opts = vim.g.cyberdream_opts
+    vim.g.cyberdream_opts = vim.tbl_deep_extend("force", opts, new_opts)
+
+    return vim.g.cyberdream_opts
+end
+
+--- Apply options to the colorscheme.
+--- @param opts Config
+function M.apply_options(opts)
+    -- Update the colorscheme
+    config.setup(opts)
+    vim.cmd("colorscheme cyberdream")
+end
+
+--- Toggle the theme variant between "default" and "light".
+--- @return string new variant
+function M.toggle_theme_variant()
+    local opts = vim.g.cyberdream_opts
+    opts.theme.variant = opts.theme.variant == "default" and "light" or "default"
+    M.set_options(opts)
+    M.apply_options(opts)
+
+    return opts.theme.variant
+end
+
+--- Toggle theme for lualine
+--- @param new_variant string "default" | "light"
+function M.toggle_lualine_theme(new_variant)
+    if package.loaded["lualine"] == nil then
+        return
+    end
+
+    local lualine_opts = require("lualine").get_config()
+    local lualine_theme = new_variant == "default" and require("lualine.themes.cyberdream")
+        or require("lualine.themes.cyberdream-light")
+
+    lualine_opts.options.theme = lualine_theme
+    require("lualine").setup(lualine_opts)
+end
+
 return M