diff options
| author | Luke Kershaw <35707277+l-kershaw@users.noreply.github.com> | 2021-12-03 14:21:26 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-03 15:21:26 +0100 |
| commit | 0c819d66059d95d673916b93a80163ce18bd785a (patch) | |
| tree | a63697fdadae230bb0dc925402db7a4591cba962 /lua | |
| parent | 60a4ce080fe7d3e57df209f1ad911bd0bff4ea43 (diff) | |
docs: layout strategy usage (#1493)
Diffstat (limited to 'lua')
| -rw-r--r-- | lua/telescope/pickers/layout_strategies.lua | 14 |
1 files changed, 14 insertions, 0 deletions
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: +--- <code> +--- require('telescope').setup{ +--- defaults = { +--- layout_strategy = 'vertical', +--- layout_config = { height = 0.95 }, +--- }, +--- } +--- </code> +--- +--- ──────────────────────────────────────────────────────────────────────────────── --- --- Layout strategies are different functions to position telescope. --- |
