docs: layout strategy usage (#1493)
This commit is contained in:
@@ -1563,6 +1563,22 @@ themes.get_ivy() *themes.get_ivy()*
|
|||||||
================================================================================
|
================================================================================
|
||||||
*telescope.layout*
|
*telescope.layout*
|
||||||
|
|
||||||
|
The layout of telescope pickers can be adjusted using the
|
||||||
|
|telescope.defaults.layout_strategy| and |telescope.defaults.layout_config|
|
||||||
|
options. For example, the following configuration changes the default layout
|
||||||
|
strategy and the default size of the picker:
|
||||||
|
>
|
||||||
|
require('telescope').setup{
|
||||||
|
defaults = {
|
||||||
|
layout_strategy = 'vertical',
|
||||||
|
layout_config = { height = 0.95 },
|
||||||
|
},
|
||||||
|
}
|
||||||
|
<
|
||||||
|
|
||||||
|
|
||||||
|
────────────────────────────────────────────────────────────────────────────────
|
||||||
|
|
||||||
Layout strategies are different functions to position telescope.
|
Layout strategies are different functions to position telescope.
|
||||||
|
|
||||||
All layout strategies are functions with the following signature:
|
All layout strategies are functions with the following signature:
|
||||||
|
|||||||
@@ -1,6 +1,20 @@
|
|||||||
---@tag telescope.layout
|
---@tag telescope.layout
|
||||||
|
|
||||||
---@brief [[
|
---@brief [[
|
||||||
|
--- The layout of telescope pickers can be adjusted using the
|
||||||
|
--- |telescope.defaults.layout_strategy| and |telescope.defaults.layout_config| options.
|
||||||
|
--- For example, the following configuration changes the default layout strategy and the
|
||||||
|
--- default size of the picker:
|
||||||
|
--- <code>
|
||||||
|
--- require('telescope').setup{
|
||||||
|
--- defaults = {
|
||||||
|
--- layout_strategy = 'vertical',
|
||||||
|
--- layout_config = { height = 0.95 },
|
||||||
|
--- },
|
||||||
|
--- }
|
||||||
|
--- </code>
|
||||||
|
---
|
||||||
|
--- ────────────────────────────────────────────────────────────────────────────────
|
||||||
---
|
---
|
||||||
--- Layout strategies are different functions to position telescope.
|
--- Layout strategies are different functions to position telescope.
|
||||||
---
|
---
|
||||||
|
|||||||
Reference in New Issue
Block a user