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: docs: layout strategy usage (#1493) --- lua/telescope/pickers/layout_strategies.lua | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'lua') 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. --- -- cgit v1.2.3