[Mapping feature] results_scrolling_up and results_scrolling_down hooks

[bluz71]

Hello Telescope crew,

Excellent work with regards to the recent merge of #1232 (results scrolling, up to 1,000). Many thanks for that.

With that foundation in place, I would like to be able to page up/down the results list quickly via custom mappings, similar to the existing results_scrolling_up and results_scrolling_down hooks listed in mappings.lua. But for the results list.

I could not seem to find an existing request for this, hence this new issue (apologies if I am mistaken).

Currently, I only see <Up> and <Down> single line results scrolling. Like preview scrolling, ideally I would like half page result scrolling hooks.

Possible?
Or already available?

Cheers.

[mattleong]

I do know that G and gg were added as default mappings in one of the last commits. Maybe helpful for ya

[bluz71]

No, not helpful.

Up and down arrows already navigate the list ends. G and gg are not applicable to this feature request.

[l-kershaw]

This is not something that is currently built in to Telescope, however there are enough features available to get something along these lines working. For example, the following code in your config adds "shift selection by half page" mappings:

require("telescope").setup({
  -- OTHER CONFIG HERE
  defaults= {
    mappings = {
      n = {
        ["<C-e>"] = function(prompt_bufnr)
          local results_win = state.get_status(prompt_bufnr).results_win
          local height = vim.api.nvim_win_get_height(results_win)
          action_set.shift_selection(prompt_bufnr, math.floor(height/2))
        end,
        ["<C-y>"] = function(prompt_bufnr)
          local results_win = state.get_status(prompt_bufnr).results_win
          local height = vim.api.nvim_win_get_height(results_win)
          action_set.shift_selection(prompt_bufnr, -math.floor(height/2))
        end,
      },
      i = {
        ["<C-e>"] = function(prompt_bufnr)
          local results_win = state.get_status(prompt_bufnr).results_win
          local height = vim.api.nvim_win_get_height(results_win)
          action_set.shift_selection(prompt_bufnr, math.floor(height/2))
        end,
        ["<C-y>"] = function(prompt_bufnr)
          local results_win = state.get_status(prompt_bufnr).results_win
          local height = vim.api.nvim_win_get_height(results_win)
          action_set.shift_selection(prompt_bufnr, -math.floor(height/2))
        end,
      },
    },
  },
  -- OTHER CONFIG HERE
})

The one downside of this setup is that visually, your selection jumps around a lot when used repeatedly, but I'm not really sure how to fix that.

@bluz71 does this fit your needs?

[bluz71]

Yes, that works perfect. Personally, I don't see any jump problems. I got it working just like my old fzf setup.

Note however, one also needs to do the following for the above to work:

local state = require('telescope.state')
local action_set = require "telescope.actions.set"

That solves the issue for me.
I do think other people will find this useful.

Would the Telescope powers-that-be see fit to abstract this into the existing mappings with a nicer API?

[bluz71]

Thank you, the new API works great.