Home Explore Blog CI



neovim

48th chunk of `runtime/doc/api.txt`
fd3ee76d57adab84395b9f97619426fc76af235a1381cbf70000000100000fd6
    • title_pos: Title position. Must be set with `title`
                    option. Value can be one of "left", "center", or "right".
                    Default is `"left"`.
                  • footer: (optional) Footer in window border, string or
                    list. List should consist of `[text, highlight]` tuples.
                    If string, or a tuple lacks a highlight, the default
                    highlight group is `FloatFooter`.
                  • footer_pos: Footer position. Must be set with `footer`
                    option. Value can be one of "left", "center", or "right".
                    Default is `"left"`.
                  • noautocmd: If true then all autocommands are blocked for
                    the duration of the call.
                  • fixed: If true when anchor is NW or SW, the float window
                    would be kept fixed even if the window would be truncated.
                  • hide: If true the floating window will be hidden and the
                    cursor will be invisible when focused on it.
                  • vertical: Split vertically |:vertical|.
                  • split: Split direction: "left", "right", "above", "below".
                  • _cmdline_offset: (EXPERIMENTAL) When provided, anchor the
                    |cmdline-completion| popupmenu to this window, with an
                    offset in screen cell width.

    Return: ~
        |window-ID|, or 0 on error

nvim_win_get_config({window})                          *nvim_win_get_config()*
    Gets window configuration.

    The returned value may be given to |nvim_open_win()|.

    `relative` is empty for normal windows.

    Attributes: ~
        Since: 0.4.0

    Parameters: ~
      • {window}  |window-ID|, or 0 for current window

    Return: ~
        Map defining the window configuration, see |nvim_open_win()|

nvim_win_set_config({window}, {config})                *nvim_win_set_config()*
    Configures window layout. Cannot be used to move the last window in a
    tabpage to a different one.

    When reconfiguring a window, absent option keys will not be changed.
    `row`/`col` and `relative` must be reconfigured together.

    Attributes: ~
        Since: 0.4.0

    Parameters: ~
      • {window}  |window-ID|, or 0 for current window
      • {config}  Map defining the window configuration, see |nvim_open_win()|

    See also: ~
      • |nvim_open_win()|


==============================================================================
Tabpage Functions                                                *api-tabpage*

nvim_tabpage_del_var({tabpage}, {name})               *nvim_tabpage_del_var()*
    Removes a tab-scoped (t:) variable

    Attributes: ~
        Since: 0.1.0

    Parameters: ~
      • {tabpage}  |tab-ID|, or 0 for current tabpage
      • {name}     Variable name

nvim_tabpage_get_number({tabpage})                 *nvim_tabpage_get_number()*
    Gets the tabpage number

    Attributes: ~
        Since: 0.1.0

    Parameters: ~
      • {tabpage}  |tab-ID|, or 0 for current tabpage

    Return: ~
        Tabpage number

nvim_tabpage_get_var({tabpage}, {name})               *nvim_tabpage_get_var()*
    Gets a tab-scoped (t:) variable

    Attributes: ~
        Since: 0.1.0

    Parameters: ~
      • {tabpage}  |tab-ID|, or 0 for current tabpage
      • {name}     Variable name

    Return: ~
        Variable value

nvim_tabpage_get_win({tabpage})                       *nvim_tabpage_get_win()*
    Gets the current window in a tabpage

    Attributes: ~
        Since: 0.1.0

    Parameters: ~
      • {tabpage}  |tab-ID|, or 0 for current tabpage

    Return: ~
        |window-ID|

nvim_tabpage_is_valid({tabpage})                     *nvim_tabpage_is_valid()*
    Checks if a tabpage is valid

    Attributes: ~
        Since: 0.1.0

    Parameters: ~
      • {tabpage}  |tab-ID|, or 0 for current tabpage

    Return: ~
        true if the tabpage is valid, false otherwise

nvim_tabpage_list_wins({tabpage})

Title: Neovim API: Window Configuration and Tabpage Functions
Summary
This section covers Neovim API functions for configuring floating windows with `nvim_win_get_config` and `nvim_win_set_config`, detailing title/footer positions, autocommand blocking, fixed positioning, and window hiding. It also outlines tabpage functions for managing tab-scoped variables, retrieving tabpage numbers and windows, and validating tabpages.