doc(layout_strategies): document shared options for bottom_pane (#2887)

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

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

---------

Co-authored-by: Github Actions <actions@github>
This commit is contained in:
James Trew
2024-01-22 22:13:22 -05:00
committed by GitHub
parent 20efb38649
commit 36dce6261a
2 changed files with 22 additions and 1 deletions

View File

@@ -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()|

View File

@@ -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",
}),