< Back

gituiSource file

Options

keybinds#

Keybind overrides to be injected into the wrapped package's key_bindings.ron.

Each attrset in the optionAttrsets are converted to RON in this manner: ${action_name} = { char = "x"; mod = "y"; }; => action: Some(( code: x, modifiers: y))

Where action_name is a valid Gitui action, char is an optional valid Crossterm KeyCode and mod is an optional valid Crossterm Modifier

An action that does not set either char or mod disables the keybind.

For more information on how key_bindings.ron is formatted and used, see the documentation.

Disjoint with the keybindsFile option.

Type
attrsOf<struct<keybind>>
Example
{
  branch_find = {};
  commit_amend = {
    char = "Char('A')";
    mod = "SHIFT";
  };
  move_left = {
    char = "Char('h')";
  };
}

keybindsFile#

key_bindings.ron file to be injected into the wrapped package.

See the documentation for syntax and valid options.

Disjoint with the keybinds option.

Type
pathLike

package#

The gitui package to be wrapped.

Type
derivation

symbols#

Key symbol overrides to be injected into the wrapped package's key_symbols.ron.

Each attrset pair is converted to RON in this manner: { ${key} = symbol }; => key: Some(symbol)

Where key is a valid Gitui KeySymbol, and char is a valid character string.

For more information on how key_bindings.ron is formatted and used, see the documentation.

Disjoint with the symbolsFile option.

Type
attrsOf<string>
Example
{
  page_down = "▼";
}

symbolsFile#

key_symbols.ron file to be injected into the wrapped package.

See the documentation for syntax and valid options.

Disjoint with the symbols option.

Type
pathLike

syntaxFiles#

Files containing .thTheme syntax files that can be loaded by theme.ron

See the documentation for loading .thTheme files in theme.ron.

Type
listOf<pathLike>

theme#

Theme overrides to be injected into the wrapped package's theme.ron.

Each attrset pair is converted to RON in this manner: { ${element} = color; }; => element: Some("color")

Where element is a valid Gitui style element and color is a valid hex string ("#FFFFFF") or Ratatui color

For more information on how key_bindings.ron is formatted and used, see the documentation.

Disjoint with the themeFile option.

Type
attrsOf<string>
Example
{
  selection_bg = "Blue";
  selection_fg = "#ffffff";
}

themeFile#

theme.ron file to be injected into the wrapped package.

See the documentation for syntax and valid options.

Disjoint with the theme option.

Type
pathLike