summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLuke Kershaw <35707277+l-kershaw@users.noreply.github.com>2021-12-03 14:21:26 +0000
committerGitHub <noreply@github.com>2021-12-03 15:21:26 +0100
commit0c819d66059d95d673916b93a80163ce18bd785a (patch)
treea63697fdadae230bb0dc925402db7a4591cba962 /doc
parent60a4ce080fe7d3e57df209f1ad911bd0bff4ea43 (diff)
docs: layout strategy usage (#1493)
Diffstat (limited to 'doc')
-rw-r--r--doc/telescope.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/telescope.txt b/doc/telescope.txt
index 67c0da4..5d4dd64 100644
--- a/doc/telescope.txt
+++ b/doc/telescope.txt
@@ -1563,6 +1563,22 @@ themes.get_ivy() *themes.get_ivy()*
================================================================================
*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.
All layout strategies are functions with the following signature: