From 37c4f1b355d843e95ba41f2a73d83de58fb74dae Mon Sep 17 00:00:00 2001 From: TJ DeVries Date: Fri, 30 Oct 2020 18:36:34 -0400 Subject: [PATCH] fix: Update documentation about setting custom maps for a picker --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4a3580d..45a505d 100644 --- a/README.md +++ b/README.md @@ -184,8 +184,6 @@ To see the full list of mappings, check out `lua/telescope/mappings.lua` and the To override ALL of the default mappings, you can use the `default_mappings` key in the `setup` table. -To override only SOME of the default mappings, you can use the `mappings` key in the `setup` table. - ``` To disable a keymap, put [map] = false @@ -226,6 +224,24 @@ require('telescope').setup { } ``` +To override only SOME of the default mappings, you can use the `attach_mappings` key in the `setup` table. For example: + +```lua +function my_custom_picker(results) + pickers.new(opts, { + prompt_title = 'Custom Picker', + finder = finders.new_table(results), + sorter = sorters.fuzzy_with_index_bias(), + attach_mappings = function(_, map) + -- Map "" in insert mode to the funciton, actions.set_command_line + map('i', '', actions.set_command_line) + + return true + end, + }):find() +end +``` + Additionally, the prompt's filetype will be `TelescopePrompt`. You can customize the filetype as you would normally. ## Status (Unstable API)