plugins.edgy.settings

Options provided to the require('edgy').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  animate = {
    enabled = false;
  };
  bottom = [
    {
      filter = ''
        function(buf, win)
          return vim.api.nvim_win_get_config(win).relative == ""
        end
      '';
      ft = "toggleterm";
      size = 30;
    }
    {
      filter = ''
        function(buf)
          return vim.bo[buf].buftype == "help"
        end
      '';
      ft = "help";
      size = 20;
    }
  ];
  left = [
    {
      ft = "NvimTree";
      size = 30;
      title = "nvimtree";
    }
    {
      ft = "Outline";
      open = "SymbolsOutline";
    }
    {
      ft = "dapui_scopes";
    }
    {
      ft = "dapui_breakpoints";
    }
    {
      ft = "dap-repl";
    }
  ];
  wo = {
    signcolumn = "no";
    spell = false;
    winbar = false;
    winfixheight = false;
    winfixwidth = false;
    winhighlight = "";
  };
}

Declared by:

plugins.edgy.settings.bottom

List of the bottom edgebar configurations.

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.edgy.settings.close_when_all_hidden

Close edgy when all windows are hidden instead of opening one of them. Disable to always keep at least one edgy split visible in each open section.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.edgy.settings.exit_when_last

Enable this to exit Neovim when only edgy windows are left.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.edgy.settings.keys

Buffer-local keymaps to be added to edgebar buffers. Existing buffer-local keymaps will never be overridden.

Each value is either:

  • A function declaration (as a raw lua string) -> fun(win:Edgy.Window)
  • false to disable this mapping.

Type: null or (attribute set of (lua function string or value false (singular enum) or raw lua code))

Default: null

Plugin default:

{
  "<c-q>" = ''
    function(win)
      win:hide()
    end
  '';
  "<c-w>+" = ''
    function(win)
      win:resize("height", 2)
    end
  '';
  "<c-w>-" = ''
    function(win)
      win:resize("height", -2)
    end
  '';
  "<c-w><lt>" = ''
    function(win)
      win:resize("width", -2)
    end
  '';
  "<c-w>=" = ''
    function(win)
      win.view.edgebar:equalize()
    end
  '';
  "<c-w>>" = ''
    function(win)
      win:resize("width", 2)
    end
  '';
  Q = ''
    function(win)
      win.view.edgebar:close()
    end
  '';
  "[W" = ''
    function(win)
      win:prev({ pinned = false, focus = true })
    end
  '';
  "[w" = ''
    function(win)
      win:prev({ visible = true, focus = true })
    end
  '';
  "]W" = ''
    function(win)
      win:next({ pinned = false, focus = true })
    end
  '';
  "]w" = ''
    function(win)
      win:next({ visible = true, focus = true })
    end
  '';
  q = ''
    function(win)
      win:close()
    end
  '';
}

Declared by:

plugins.edgy.settings.left

List of the left edgebar configurations.

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.edgy.settings.right

List of the right edgebar configurations.

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.edgy.settings.top

List of the top edgebar configurations.

Type: null or (list of (string or (submodule) or raw lua code))

Default: null

Plugin default: [ ]

Declared by:

plugins.edgy.settings.wo

Global window options for edgebar windows.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default:

{
  signcolumn = "no";
  spell = false;
  winbar = true;
  winfixheight = false;
  winfixwidth = true;
  winhighlight = "WinBar:EdgyWinBar,Normal:EdgyNormal";
}

Declared by: