Skip to content

Commit

Permalink
doc(layout_strategies): document shared options for bottom_pane (#2887
Browse files Browse the repository at this point in the history
)

* doc(layout_strategies): document shared options for `bottom_pane`

* [docgen] Update doc/telescope.txt
skip-checks: true

---------

Co-authored-by: Github Actions <actions@github>
  • Loading branch information
jamestrew and Github Actions authored Jan 23, 2024
1 parent 20efb38 commit 36dce62
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 1 deletion.
15 changes: 15 additions & 0 deletions doc/telescope.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2357,6 +2357,21 @@ layout_strategies.bottom_pane() *telescope.layout.bottom_pane()*

For an easy ivy configuration, see |themes.get_ivy()|

`picker.layout_config` shared options:
- height:
- How tall to make Telescope's entire layout
- See |resolver.resolve_height()|
- mirror: Flip the location of the results/prompt and preview windows
- prompt_position:
- Where to place prompt window.
- Available Values: 'bottom', 'top'
- scroll_speed: The number of lines to scroll through the previewer

`picker.layout_config` unique options:
- preview_cutoff: When columns are less than this value, the preview will be disabled
- preview_width:
- Change the width of Telescope's preview window
- See |resolver.resolve_width()|



Expand Down
8 changes: 7 additions & 1 deletion lua/telescope/pickers/layout_strategies.lua
Original file line number Diff line number Diff line change
Expand Up @@ -847,9 +847,15 @@ end)
--- Bottom pane can be used to create layouts similar to "ivy".
---
--- For an easy ivy configuration, see |themes.get_ivy()|
---@eval { ["description"] = require("telescope.pickers.layout_strategies")._format("bottom_pane") }
layout_strategies.bottom_pane = make_documented_layout(
"bottom_pane",
vim.tbl_extend("error", shared_options, {
vim.tbl_extend("error", {
height = shared_options.height,
mirror = shared_options.mirror,
scroll_speed = shared_options.scroll_speed,
prompt_position = shared_options.prompt_position,
}, {
preview_width = { "Change the width of Telescope's preview window", "See |resolver.resolve_width()|" },
preview_cutoff = "When columns are less than this value, the preview will be disabled",
}),
Expand Down

0 comments on commit 36dce62

Please sign in to comment.