plugins.floaterm.settings

The configuration options for floaterm without the floaterm_ prefix.

For example, the following settings are equivialent to these :setglobal commands:

  • foo_bar = 1 -> :setglobal floaterm_foo_bar=1
  • hello = "world" -> :setglobal floaterm_hello="world"
  • some_toggle = true -> :setglobal floaterm_some_toggle
  • other_toggle = false -> :setglobal nofloaterm_other_toggle

Type: attribute set of anything

Default: { }

Example:

{
  height = 0.9;
  keymap_kill = "<Leader>fk";
  keymap_new = "<Leader>ft";
  keymap_next = "<Leader>fn";
  keymap_prev = "<Leader>fp";
  keymap_toggle = "<Leader>t";
  opener = "edit ";
  rootmarkers = [
    "build/CMakeFiles"
    ".project"
    ".git"
    ".hg"
    ".svn"
    ".root"
  ];
  title = "";
  width = 0.9;
}

Declared by:

plugins.floaterm.settings.autoclose

Whether to close floaterm window once a job gets finished.

  • 0 - Always do NOT close floaterm window.
  • 1 - Close window only if the job exits normally
  • 2 - Always close floaterm window.

Type: null or one of 0, 1, 2 or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.floaterm.settings.autohide

Whether to hide previous floaterms before switching to or opening a another one.

  • 0 - Always do NOT hide previous floaterm windows
  • 1 - Only hide those whose position (b:floaterm_position) is identical to that of the floaterm which will be opened
  • 2 - Always hide them

Type: null or one of 0, 1, 2 or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.floaterm.settings.autoinsert

Whether to enter `|Terminal-mode|` after opening a floaterm.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.floaterm.settings.borderchars

8 characters of the floating window border (top, right, bottom, left, topleft, topright, botright, botleft).

Type: null or string or raw lua code

Default: null

Plugin default: "─│─│┌┐┘└"

Declared by:

plugins.floaterm.settings.giteditor

Whether to override $GIT_EDITOR in floaterm terminals so git commands can open open an editor in the same neovim instance.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.floaterm.settings.height

Width of the floaterm window. It can be either an integer (number of lines) or a float between 0.0 and 1.0. In this case, the width is relative to lines.

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

Default: null

Plugin default: 0.6

Declared by:

plugins.floaterm.settings.keymap_first

Keyboard shortcut to navigate to the first terminal.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.floaterm.settings.keymap_hide

Keyboard shortcut to hide the floaterm window.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.floaterm.settings.keymap_kill

Keyboard shortcut to kill the floaterm window.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.floaterm.settings.keymap_last

Keyboard shortcut to navigate to the last terminal.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.floaterm.settings.keymap_new

Keyboard shortcut to open the floaterm window.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Example: "<F7>"

Declared by:

plugins.floaterm.settings.keymap_next

Keyboard shortcut to navigate to the next terminal.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Example: "<F9>"

Declared by:

plugins.floaterm.settings.keymap_prev

Keyboard shortcut to navigate to the previous terminal.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Example: "<F8>"

Declared by:

plugins.floaterm.settings.keymap_show

Keyboard shortcut to show the floaterm window.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.floaterm.settings.keymap_toggle

Keyboard shortcut to toggle the floaterm window.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Example: "<F12>"

Declared by:

plugins.floaterm.settings.opener

Command used for opening a file in the outside nvim from within :terminal.

Available: "edit", "split", "vsplit", "tabe", "drop" or user-defined commands.

Type: null or string or raw lua code

Default: null

Plugin default: "split"

Declared by:

plugins.floaterm.settings.position

The position of the floaterm window.

It’s recommended to have a look at those options meanings, e.g. :help :leftabove.

  • If wintype is "split" or "vsplit":

    • "leftabove"
    • "aboveleft"
    • "rightbelow"
    • "belowright"
    • "topleft"
    • "botright" (default)

  • If wintype is "float":

    • "top"
    • "bottom"
    • "left"
    • "right"
    • "topleft"
    • "topright"
    • "bottomleft"
    • "bottomright"
    • "center" (default)
    • "auto" (at the cursor place)

Type: null or string or raw lua code

Default: null

Declared by:

plugins.floaterm.settings.rootmarkers

Markers used to detect the project root directory when running.

:FloatermNew --cwd=<root>

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

Default: null

Plugin default:

[
  ".project"
  ".git"
  ".hg"
  ".svn"
  ".root"
]

Declared by:

plugins.floaterm.settings.shell

Which shell should floaterm use. Default value is the same as your shell option.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.floaterm.settings.title

Title format in the floating/popup terminal window. If empty, the title won’t be show.

Type: null or string or raw lua code

Default: null

Plugin default: "floaterm: $1/$2"

Declared by:

plugins.floaterm.settings.titleposition

The position of the floaterm title.

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

Default: null

Plugin default: "left"

Declared by:

plugins.floaterm.settings.width

Width of the floaterm window. It can be either an integer (number of columns) or a float between 0.0 and 1.0. In this case, the width is relative to columns.

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

Default: null

Plugin default: 0.6

Declared by:

plugins.floaterm.settings.wintype

Set it to "split" or "vsplit" if you don’t want to use floating or popup window.

Type: null or string or raw lua code

Default: null

Plugin default: "float"

Declared by: