nixvim docs

plugins.hydra.hydras.*.config.hint

Configure the hint. Set to false to disable.

Type: null or value false (singular enum) or (attribute set of anything)

Default: null

Plugin default:

{
  offset = 0;
  position = "bottom";
  show_name = true;
}

Declared by:

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

plugins.hydra.hydras.config.hint.float_opts

Options passed to nvim_open_win(). See :h nvim_open_win(). Lets you set border, header, footer, etc.

Note: row, col, height, width, relative, and anchor should not be overridden.

Type: null or (attribute set of anything)

Default: null

plugins.hydra.hydras.config.hint.funcs

Table from function names to function. Functions should return a string. These functions can be used in hints with %{func_name} more in :h hydra-hint.

Type: attribute set of lua function string

Default: { }

Example:

{
  number = ''
    function()
      if vim.o.number then
        return '[x]'
      else
        return '[ ]'
      end
    end
  '';
  relativenumber = ''
    function()
      if vim.o.relativenumber then
        return '[x]'
      else
        return '[ ]'
      end
    end
  '';
}

plugins.hydra.hydras.config.hint.hide_on_load

If set to true, this will prevent the hydra’s hint window from displaying immediately.

Note: you can still show the window manually by calling Hydra.hint:show() and manually close it with Hydra.hint:close().

Type: null or boolean or raw lua code

Default: null

Plugin default: false

plugins.hydra.hydras.config.hint.offset

Offset of the floating window from the nearest editor border.

Type: null or signed integer or floating point number or raw lua code

Default: null

Plugin default: 0

plugins.hydra.hydras.config.hint.position

Set the position of the hint window.

Type: null or one of “top-left”, “top”, “top-right”, “middle-left”, “middle”, “middle-right”, “bottom-left”, “bottom”, “bottom-right” or raw lua code

Default: null

Plugin default: "bottom"

plugins.hydra.hydras.config.hint.show_name

Show the hydras name (or “HYDRA:” if not given a name), at the beginning of an auto-generated hint.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

plugins.hydra.hydras.config.hint.type

• “window”: show hint in a floating window
• “cmdline”: show hint in the echo area
• “statusline”: show auto-generated hint in the status line
• “statuslinemanual”: Do not show a hint, but return a custom status line hint from require("hydra.statusline").get_hint()

Defaults to “window” if hint is passed to the hydra otherwise defaults to “cmdline”.

Type: null or one of “window”, “cmdline”, “statusline”, “statuslinemanual”

Default: null