plugins.dashboard.settings

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

Type: attribute set of anything

Default: { }

Example:

{
  change_to_vcs_root = true;
  config = {
    footer = [
      "Made with ❤️"
    ];
    header = [
      "███╗   ██╗██╗██╗  ██╗██╗   ██╗██╗███╗   ███╗"
      "████╗  ██║██║╚██╗██╔╝██║   ██║██║████╗ ████║"
      "██╔██╗ ██║██║ ╚███╔╝ ██║   ██║██║██╔████╔██║"
      "██║╚██╗██║██║ ██╔██╗ ╚██╗ ██╔╝██║██║╚██╔╝██║"
      "██║ ╚████║██║██╔╝ ██╗ ╚████╔╝ ██║██║ ╚═╝ ██║"
      "╚═╝  ╚═══╝╚═╝╚═╝  ╚═╝  ╚═══╝  ╚═╝╚═╝     ╚═╝"
    ];
    mru = {
      limit = 20;
    };
    project = {
      enable = false;
    };
    shortcut = [
      {
        action = {
          __raw = "function(path) vim.cmd('Telescope find_files') end";
        };
        desc = "Files";
        group = "Label";
        icon = " ";
        icon_hl = "@variable";
        key = "f";
      }
      {
        action = "Telescope app";
        desc = " Apps";
        group = "DiagnosticHint";
        key = "a";
      }
      {
        action = "Telescope dotfiles";
        desc = " dotfiles";
        group = "Number";
        key = "d";
      }
    ];
    week_header = {
      enable = true;
    };
  };
  theme = "hyper";
}

Declared by:

plugins.dashboard.settings.change_to_vcs_root

When opening a file in the “hyper” theme’s “recent files” list (mru), vim will change to the root of vcs.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.dashboard.settings.shortcut_type

The shortcut type.

Type: null or one of “letter”, “number” or raw lua code

Default: null

Plugin default: "letter"

Declared by:

plugins.dashboard.settings.theme

Dashboard comes with two themes, that each have their own distinct config options.

  • “hyper” includes a header, custom shortcuts, recent projects, recent files, and a footer.
  • “doom” is simpler, consisting of a header, center, and footer.

Some options have a note stating which theme they relate to.

Type: null or one of “hyper”, “doom” or raw lua code

Default: null

Plugin default: "hyper"

Declared by: