nixvim docs

plugins.statuscol.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  bt_ignore = null;
  clickhandlers = {
    FoldClose = "require('statuscol.builtin').foldclose_click";
    FoldOpen = "require('statuscol.builtin').foldopen_click";
    FoldOther = "require('statuscol.builtin').foldother_click";
    Lnum = "require('statuscol.builtin').lnum_click";
  };
  clickmod = "c";
  ft_ignore = null;
  relculright = true;
  segments = [
    {
      click = "v:lua.ScFa";
      text = [
        "%C"
      ];
    }
    {
      click = "v:lua.ScSa";
      text = [
        "%s"
      ];
    }
    {
      click = "v:lua.ScLa";
      condition = [
        true
        {
          __raw = "require('statuscol.builtin').not_empty";
        }
      ];
      text = [
        {
          __raw = "require('statuscol.builtin').lnumfunc";
        }
        " "
      ];
    }
  ];
  setopt = true;
  thousands = ".";
}

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.bt_ignore

Lua table with ‘buftype’ values for which statuscolumn will be unset.

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

Default: null

Plugin default: null

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.clickhandlers

Builtin click handlers.

Type: attribute set of lua function string

Default: { }

Example:

{
  FoldClose = "require('statuscol.builtin').foldclose_click";
  FoldOpen = "require('statuscol.builtin').foldopen_click";
  FoldOther = "require('statuscol.builtin').foldother_click";
  Lnum = "require('statuscol.builtin').lnum_click";
}

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.clickmod

Modifier used for certain actions in the builtin clickhandlers: a for Alt, c for Ctrl and m for Meta.

Type: null or string or raw lua code

Default: null

Plugin default: "c"

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.ft_ignore

Lua table with ‘filetype’ values for which statuscolumn will be unset.

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

Default: null

Plugin default: null

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.relculright

Whether to right-align the cursor line number with relativenumber set.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.segments

The statuscolumn can be customized through the segments option.

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

Default: null

Plugin default:

[
  {
    click = "v:lua.ScFa";
    text = [
      "%C"
    ];
  }
  {
    click = "v:lua.ScSa";
    text = [
      "%s"
    ];
  }
  {
    click = "v:lua.ScLa";
    condition = [
      true
      {
        __raw = "require('statuscol.builtin').not_empty";
      }
    ];
    text = [
      {
        __raw = "require('statuscol.builtin').lnumfunc";
      }
      " "
    ];
  }
]

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.setopt

Whether to set the statuscolumn option, may be set to false for those who want to use the click handlers in their own statuscolumn: _G.Sc[SFL]a(). Although I recommend just using the segments field below to build your statuscolumn to benefit from the performance optimizations in this plugin.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

• <nixvim/plugins/by-name/statuscol>

plugins.statuscol.settings.thousands

false or line number thousands separator string (“.” / “,”).

Type: null or string or value false (singular enum)

Default: null

Plugin default: false

Declared by:

• <nixvim/plugins/by-name/statuscol>