API

The API offers the same functionality as the commands .

Open

require("dap-view").open()
lua

Opens both nvim-dap-view windows1: views + console.

Close

---@param hide_terminal? boolean
require("dap-view").close()
lua

Closes the views window. Can also hide the terminal window if specified.

Toggle

---@param hide_terminal? boolean
require("dap-view").toggle()
lua

Calls require("dap-view").open() if there's no views window. Else, behaves like require("dap-view").close()

Add Expr

---@param expr? string
require("dap-view").add_expr(expr)
lua

In normal mode, adds the expression under the cursor to the watch list (see caveats ). In visual mode, adds the selection to the watch list. If expr is specified, adds the expression directly, overriding previous conditions.

Jump To View

---@param view "breakpoints" | "exceptions" | "watches" | "repl" | "threads" | "console" | "scopes" | "sessions" | string
require("dap-view").jump_to_view(view)
lua

Shows a given view and jumps to its window.

Show View

---@param view "breakpoints" | "exceptions" | "watches" | "repl" | "threads" | "console" | "scopes" | "sessions" | string
require("dap-view").show_view(view)
lua

Shows a given view. If the specified view is already the current one, jumps to its window.

Navigate

---@param opts {count: number, wrap: boolean, type?: 'views' | 'sessions'}
require("dap-view").navigate(opts)
lua

Switches from the current view to another one by taking the current view's index (in the winbar) and adding a count (default behavior). Can also be used to navigate within sessions, if specified. Has some default keymaps .

Footnotes

  1. In the current tab. May close the views window in another tab. ↩