From 0c819d66059d95d673916b93a80163ce18bd785a Mon Sep 17 00:00:00 2001 From: Luke Kershaw <35707277+l-kershaw@users.noreply.github.com> Date: Fri, 3 Dec 2021 14:21:26 +0000 Subject: [PATCH] docs: layout strategy usage (#1493) --- doc/telescope.txt | 16 ++++++++++++++++ lua/telescope/pickers/layout_strategies.lua | 14 ++++++++++++++ 2 files changed, 30 insertions(+) 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: diff --git a/lua/telescope/pickers/layout_strategies.lua b/lua/telescope/pickers/layout_strategies.lua index c0692be..75ce032 100644 --- a/lua/telescope/pickers/layout_strategies.lua +++ b/lua/telescope/pickers/layout_strategies.lua @@ -1,6 +1,20 @@ ---@tag telescope.layout ---@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: +--- +--- require('telescope').setup{ +--- defaults = { +--- layout_strategy = 'vertical', +--- layout_config = { height = 0.95 }, +--- }, +--- } +--- +--- +--- ──────────────────────────────────────────────────────────────────────────────── --- --- Layout strategies are different functions to position telescope. ---