plugins.telescope.extensions.file-browser.settings

settings for the file-browser telescope extension.

Type: attribute set of anything

Default: { }

Example:

{
  file_browser = {
    hijack_netrw = true;
    theme = "ivy";
  };
}

Declared by:

plugins.telescope.extensions.file-browser.settings.add_dirs

Whether the file browser shows folders.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.file-browser.settings.auto_depth

Unlimit or set depth to auto_depth & unset grouped on prompt for file_browser.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.browse_files

A custom lua function to override for the file browser.

Type: null or lua function string

Default: null

Plugin default: require('telescope._extensions.file_browser.finders').browse_files

Declared by:

plugins.telescope.extensions.file-browser.settings.browse_folders

A custom lua function to override for the folder browser.

Type: null or lua function string

Default: null

Plugin default: require('telescope._extensions.file_browser.finders').browse_folders

Declared by:

plugins.telescope.extensions.file-browser.settings.collapse_dirs

Skip with only a single (possibly hidden) sub-dir in file_browser.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.cwd

Directory to browse folders from. vim.fn.expanded automatically.

Type: null or string or raw lua code

Default: null

Plugin default: "{__raw = \"vim.loop.cwd()\";}"

Declared by:

plugins.telescope.extensions.file-browser.settings.cwd_to_path

Whether folder browser is launched from path rather than cwd.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.depth

File tree depth to display, false for unlimited depth.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 1

Declared by:

plugins.telescope.extensions.file-browser.settings.dir_icon

Change the icon for a directory.

Type: null or string or raw lua code

Default: null

Plugin default: ""

Declared by:

plugins.telescope.extensions.file-browser.settings.dir_icon_hl

Change the highlight group of dir icon.

Type: null or string or raw lua code

Default: null

Plugin default: "Default"

Declared by:

plugins.telescope.extensions.file-browser.settings.display_stat

Ordered stat; see upstream for more info.

Type: null or (attribute set of (anything or raw lua code))

Default: null

Plugin default:

{
  date = true;
  size = true;
  mode = true;
}

Declared by:

plugins.telescope.extensions.file-browser.settings.files

Start in file (true) or folder (false) browser.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.file-browser.settings.git_status

Show the git status of files (true if git is found).

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by:

plugins.telescope.extensions.file-browser.settings.grouped

Group initial sorting by directories and then files.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.hidden

Determines whether to show hidden files or not.

Type: null or boolean or (submodule)

Default: null

Plugin default:

{
  file_browser = false;
  folder_browser = false;
}

Declared by:

plugins.telescope.extensions.file-browser.settings.hide_parent_dir

Hide ../ in the file browser.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.hijack_netrw

Use telescope file browser when opening directory paths.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.path

Directory to browse files from. vim.fn.expanded automatically.

Type: null or string or raw lua code

Default: null

Plugin default: "{__raw = \"vim.loop.cwd()\";}"

Declared by:

plugins.telescope.extensions.file-browser.settings.prompt_path

Show the current relative path from cwd as the prompt prefix.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.quiet

Suppress any notification from file_browser actions.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.respect_gitignore

Induces slow-down w/ plenary finder (true if fd available).

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.select_buffer

Select current buffer if possible. May imply hidden=true.

Type: null or boolean or raw lua code

Default: null

Plugin default: false

Declared by:

plugins.telescope.extensions.file-browser.settings.theme

Custom theme, will use your global theme by default.

Type: null or string or raw lua code

Default: null

Declared by:

plugins.telescope.extensions.file-browser.settings.use_fd

Use fd if available over plenary.scandir.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: