Mini Animate

info

You can enable the extra with the :LazyExtras command. Plugins marked as optional will only be configured if they are installed.

Below you can find a list of included plugins and their default settings.

caution

You don't need to copy the default settings to your config. They are only shown here for reference.

snacks.nvim

disable snacks scroll when animate is enabled

Options

opts = {
  scroll = { enabled = false },
}

Full Spec

{
  "snacks.nvim",
  opts = {
    scroll = { enabled = false },
  },
}

mini.animate

Animates many common Neovim actions, like scrolling, moving the cursor, and resizing windows.

Options

opts = function(_, opts)
  -- don't use animate when scrolling with the mouse
  local mouse_scrolled = false
  for _, scroll in ipairs({ "Up", "Down" }) do
    local key = "<ScrollWheel" .. scroll .. ">"
    vim.keymap.set({ "", "i" }, key, function()
      mouse_scrolled = true
      return key
    end, { expr = true })
  end

  vim.api.nvim_create_autocmd("FileType", {
    pattern = "grug-far",
    callback = function()
      vim.b.minianimate_disable = true
    end,
  })

  -- schedule setting the mapping to override the default mapping from `keymaps.lua`
  -- seems `keymaps.lua` is the last event to execute on `VeryLazy` and it overwrites it
  vim.schedule(function()
    Snacks.toggle({
      name = "Mini Animate",
      get = function()
        return not vim.g.minianimate_disable
      end,
      set = function(state)
        vim.g.minianimate_disable = not state
      end,
    }):map("<leader>ua")
  end)

  local animate = require("mini.animate")
  return vim.tbl_deep_extend("force", opts, {
    resize = {
      timing = animate.gen_timing.linear({ duration = 50, unit = "total" }),
    },
    scroll = {
      timing = animate.gen_timing.linear({ duration = 150, unit = "total" }),
      subscroll = animate.gen_subscroll.equal({
        predicate = function(total_scroll)
          if mouse_scrolled then
            mouse_scrolled = false
            return false
          end
          return total_scroll > 1
        end,
      }),
    },
  })
end

Full Spec

{
  "nvim-mini/mini.animate",
  event = "VeryLazy",
  cond = vim.g.neovide == nil,
  opts = function(_, opts)
    -- don't use animate when scrolling with the mouse
    local mouse_scrolled = false
    for _, scroll in ipairs({ "Up", "Down" }) do
      local key = "<ScrollWheel" .. scroll .. ">"
      vim.keymap.set({ "", "i" }, key, function()
        mouse_scrolled = true
        return key
      end, { expr = true })
    end

    vim.api.nvim_create_autocmd("FileType", {
      pattern = "grug-far",
      callback = function()
        vim.b.minianimate_disable = true
      end,
    })

    -- schedule setting the mapping to override the default mapping from `keymaps.lua`
    -- seems `keymaps.lua` is the last event to execute on `VeryLazy` and it overwrites it
    vim.schedule(function()
      Snacks.toggle({
        name = "Mini Animate",
        get = function()
          return not vim.g.minianimate_disable
        end,
        set = function(state)
          vim.g.minianimate_disable = not state
        end,
      }):map("<leader>ua")
    end)

    local animate = require("mini.animate")
    return vim.tbl_deep_extend("force", opts, {
      resize = {
        timing = animate.gen_timing.linear({ duration = 50, unit = "total" }),
      },
      scroll = {
        timing = animate.gen_timing.linear({ duration = 150, unit = "total" }),
        subscroll = animate.gen_subscroll.equal({
          predicate = function(total_scroll)
            if mouse_scrolled then
              mouse_scrolled = false
              return false
            end
            return total_scroll > 1
          end,
        }),
      },
    })
  end,
}