plugins.startup.sections

Type: attribute set of (submodule)

Default: { }

Example:

{
  body = {
    align = "center";
    content = [
      [
        " Find File"
        "Telescope find_files"
        "<leader>ff"
      ]
      [
        "󰍉 Find Word"
        "Telescope live_grep"
        "<leader>lg"
      ]
      [
        " Recent Files"
        "Telescope oldfiles"
        "<leader>of"
      ]
      [
        " File Browser"
        "Telescope file_browser"
        "<leader>fb"
      ]
      [
        " Colorschemes"
        "Telescope colorscheme"
        "<leader>cs"
      ]
      [
        " New File"
        "lua require'startup'.new_file()"
        "<leader>nf"
      ]
    ];
    defaultColor = "";
    foldSection = true;
    highlight = "String";
    margin = 5;
    oldfilesAmount = 0;
    title = "Basic Commands";
    type = "mapping";
  };
  header = {
    align = "center";
    content = {
      __raw = "require('startup.headers').hydra_header";
    };
    defaultColor = "";
    foldSection = false;
    highlight = "Statement";
    margin = 5;
    oldfilesAmount = 0;
    title = "Header";
    type = "text";
  };
}

Declared by:

plugins.startup.sections.<name>.align

How to align the section.

Type: null or one of “center”, “left”, “right” or raw lua code

Default: null

Plugin default: "center"

Declared by:

plugins.startup.sections.<name>.defaultColor

A hex color that gets used if you don’t specify highlight.

Type: null or string or raw lua code

Default: null

Plugin default: "#FF0000"

Declared by:

plugins.startup.sections.<name>.foldSection

Whether to fold or not.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.startup.sections.<name>.highlight

Highlight group in which the section text should be highlighted.

Type: null or string

Default: null

Declared by:

plugins.startup.sections.<name>.margin

The margin for left or right alignment.

  • if < 1 fraction of screen width
  • if > 1 numbers of column

Type: null or integer or floating point number between 0.0 and 1.0 (both inclusive) or (positive integer, meaning >0)

Default: null

Plugin default: 5

Declared by:

plugins.startup.sections.<name>.oldfilesAmount

The amount of oldfiles to be displayed.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 5

Declared by:

plugins.startup.sections.<name>.oldfilesDirectory

if the oldfiles of the current directory should be displayed.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.startup.sections.<name>.title

Title for the folded section.

Type: null or string or raw lua code

Default: null

Plugin default: "title"

Declared by:

plugins.startup.sections.<name>.type

  • “text” -> text that will be displayed
  • “mapping” -> create mappings for commands that can be used. use mappings.executeCommand on the commands to execute.
  • “oldfiles” -> display oldfiles (can be opened with mappings.openFile/openFileSplit)

Type: null or one of “text”, “mapping”, “oldfiles” or raw lua code

Default: null

Plugin default: "text"

Declared by: