Skip to content

aelisonCode/modal_reminder.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

window-reminder.nvim

A small Neovim plugin that shows a centered reminder popup (floating window).
Designed to be simple, lightweight, and optionally “attention-grabbing”.

Installation (lazy.nvim)

{
  "aelisonCode/modal_reminder.nvim",
  opts = {
    title = "REMINDER",
    message = "Hey, time to take a break!",
    keymaps = {
      enabled = true,
      launch = "<leader>tw", -- Default mapping
    },
  },
  config = function(_, opts)
    require("window_reminder").setup(opts)
  end,
}

Usage

Show the popup:

require("window_reminder").show("Custom message")

Or use the default configured message:

require("window_reminder").show()

Options

  • title (string) : window title text (default: "REMINDER")
  • message (string) : default message text
  • footer (string)
  • min_width (number)
  • padding (number)
  • border (string) : "rounded", "single", etc.
  • disable_mouse (boolean) : sets mouse= while the popup is open
  • keymaps.enabled (boolean)
  • keymaps.launch (string) : key to open the reminder window

About

A simple window that shows a message in the center of the screen. That window block some actions in nvim, that let you take a break on your activitie

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages