telescope.nvim/doc/telescope.txt

================================================================================
                                                                *telescope.nvim*

Telescope.nvim is a plugin for fuzzy finding and neovim. It helps you search,
filter, find and pick things in Lua.

To find out more:
https://github.com/nvim-telescope/telescope.nvim

  :h telescope.setup
  :h telescope.builtin
  :h telescope.layout
  :h telescope.actions

telescope.extensions()                                *telescope.extensions()*

    Use telescope.extensions to reference any extensions within your
    configuration.
    While the docs currently generate this as a function, it's actually a table.
    Sorry.



telescope.load_extension({name})                  *telescope.load_extension()*

    Load an extension.


    Parameters: ~
        {name} (string)  Name of the extension


telescope.register_extension({mod})           *telescope.register_extension()*

    Register an extension. To be used by plugin authors.


    Parameters: ~
        {mod} (table)  Module


telescope.setup({opts})                                    *telescope.setup()*

    Setup function to be run by user. Configures the defaults, extensions
    and other aspects of telescope.



    Valid keys for {opts.defaults}

                                          *telescope.defaults.entry_prefix*
    entry_prefix: ~
        Prefix in front of each result entry. Current selection not included.

        Default: '  '

                                         *telescope.defaults.prompt_prefix*
    prompt_prefix: ~
        Will be shown in front of the prompt.

        Default: '> '

                                       *telescope.defaults.scroll_strategy*
    scroll_strategy: ~
        Determines what happens you try to scroll past view of the picker.

          Available options are:
          - "cycle" (default)
          - "limit"

                                       *telescope.defaults.selection_caret*
    selection_caret: ~
        Will be shown in front of the selection.

        Default: '> '

                                    *telescope.defaults.selection_strategy*
    selection_strategy: ~
        Determines how the cursor acts after each sort iteration.

          Available options are:
          - "reset" (default)
          - "follow"
          - "row"

                                      *telescope.defaults.sorting_strategy*
    sorting_strategy: ~
        Determines the direction "better" results are sorted towards.

          Available options are:
          - "descending" (default)
          - "ascending"

    Parameters: ~
        {opts} (table)  Configuration opts. Keys: defaults, extensions



================================================================================
                                                             *telescope.builtin*

A collection of builtin pickers for telesceope.

Meant for both example and for easy startup.

Any of these functions can just be called directly by doing:

:lua require('telescope.builtin').$NAME()

This will use the default configuration options.
  Other configuration options are still in flux at the moment

builtin.live_grep()                                      *builtin.live_grep()*

    Live grep means grep as you type.




================================================================================
                                                             *telescope.actions*

Actions functions that are useful for people creating their own mappings.

actions.add_selection({prompt_bufnr})                *actions.add_selection()*

    Add current entry to multi select


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_selection_better({prompt_bufnr})*actions.move_selection_better()*

    Move the selection to the entry that has a better score


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_selection_next({prompt_bufnr})    *actions.move_selection_next()*

    Move the selection to the next entry


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_selection_previous({prompt_bufnr})*actions.move_selection_previous()*

    Move the selection to the previous entry


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_selection_worse({prompt_bufnr})  *actions.move_selection_worse()*

    Move the selection to the entry that has a worse score


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_to_bottom({prompt_bufnr})              *actions.move_to_bottom()*

    Move to the bottom of the picker


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_to_middle({prompt_bufnr})              *actions.move_to_middle()*

    Move to the middle of the picker


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.move_to_top({prompt_bufnr})                    *actions.move_to_top()*

    Move to the top of the picker


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.remove_selection({prompt_bufnr})          *actions.remove_selection()*

    Remove current entry from multi select


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr


actions.toggle_selection({prompt_bufnr})          *actions.toggle_selection()*

    Toggle current entry status for multi select


    Parameters: ~
        {prompt_bufnr} (number)  The prompt bufnr



================================================================================
                                                              *telescope.layout*


Layout strategies are different functions to position telescope.

All layout strategies are functions with the following signature: >

     function(picker, columns, lines)
       -- Do some calculations here...
       return {
         preview = preview_configuration
         results = results_configuration,
         prompt = prompt_configuration,
       }
     end
<

    Parameters: ~
        - picker  : A Picker object. (docs coming soon)
        - columns : number Columns in the vim window
        - lines   : number Lines in the vim window

TODO: I would like to make these link to `telescope.layout_strategies.*`, but it's not yet possible.

Available layout strategies include:
  horizontal:
  - See |layout_strategies.horizontal|

  vertical:
  - See |layout_strategies.vertical|

  flex:
  - See |layout_strategies.flex|


layout_strategies.center()                        *layout_strategies.center()*

    Centered layout wih smaller default sizes (I think)

       +--------------+
       |    Preview   |
       +--------------+
       |    Prompt    |
       +--------------+
       |    Result    |
       |    Result    |
       |    Result    |
       +--------------+




layout_strategies.flex()                            *layout_strategies.flex()*

    Swap between `horizontal` and `vertical` strategies based on the window
    width
      -  Supports `vertical` or `horizontal` features

      Uses:
       flip_columns
       flip_lines



layout_strategies.horizontal()                *layout_strategies.horizontal()*

    Horizontal previewer

      +-------------+--------------+
      |             |              |
      |   Results   |              |
      |             |    Preview   |
      |             |              |
      +-------------|              |
      |   Prompt    |              |
      +-------------+--------------+



layout_strategies.vertical()                    *layout_strategies.vertical()*

    Vertical perviewer stacks the items on top of each other.

       +-----------------+
       |    Previewer    |
       |    Previewer    |
       |    Previewer    |
       +-----------------+
       |     Result      |
       |     Result      |
       |     Result      |
       +-----------------+
       |     Prompt      |
       +-----------------+





 vim:tw=78:ts=8:ft=help:norl: