Skip to content

Commit

Permalink
docs: added open/toggle/close to api section. Fixes #340
Browse files Browse the repository at this point in the history
  • Loading branch information
folke committed Oct 9, 2023
1 parent a97c24c commit fd3176d
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,19 +169,28 @@ nnoremap gR <cmd>TroubleToggle lsp_references<cr>

```lua
-- Lua
vim.keymap.set("n", "<leader>xx", function() require("trouble").open() end)
vim.keymap.set("n", "<leader>xw", function() require("trouble").open("workspace_diagnostics") end)
vim.keymap.set("n", "<leader>xd", function() require("trouble").open("document_diagnostics") end)
vim.keymap.set("n", "<leader>xq", function() require("trouble").open("quickfix") end)
vim.keymap.set("n", "<leader>xl", function() require("trouble").open("loclist") end)
vim.keymap.set("n", "gR", function() require("trouble").open("lsp_references") end)
vim.keymap.set("n", "<leader>xx", function() require("trouble").toggle() end)
vim.keymap.set("n", "<leader>xw", function() require("trouble").toggle("workspace_diagnostics") end)
vim.keymap.set("n", "<leader>xd", function() require("trouble").toggle("document_diagnostics") end)
vim.keymap.set("n", "<leader>xq", function() require("trouble").toggle("quickfix") end)
vim.keymap.set("n", "<leader>xl", function() require("trouble").toggle("loclist") end)
vim.keymap.set("n", "gR", function() require("trouble").toggle("lsp_references") end)
```

### API

You can use the following functions in your keybindings:

```lua
-- toggle trouble with optional mode
require("trouble").toggle(mode?)

-- open trouble with optional mode
require("trouble").open(mode?)

-- close trouble
require("trouble").close()

-- jump to the next item, skipping the groups
require("trouble").next({skip_groups = true, jump = true});

Expand Down

0 comments on commit fd3176d

Please sign in to comment.