Skip to content

tembokk/telescope-media-files.nvim

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Telescope-media-files.nvim

Preview images, pdf, epub, video, and fonts from Neovim using Telescope.

Demo

ONLY SUPPORTED ON LINUX

Install

Plug 'nvim-lua/popup.nvim'
Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim'
Plug 'nvim-telescope/telescope-media-files.nvim'

Setup

require('telescope').load_extension('media_files')

Configuration

This extension can be configured using extensions field inside Telescope setup function.

require'telescope'.setup {
  extensions = {
    media_files = {
      -- filetypes whitelist
      -- defaults to {"png", "jpg", "gif", "mp4", "webm", "pdf"}
      filetypes = {"png", "webp", "jpg", "jpeg"},
      find_cmd = "rg" -- find command (defaults to `fd`)
      -- default: copy entry's relative path to vim clipboard
      on_enter = function(filepath)
        vim.fn.setreg('+', filepath)
        vim.notify("The image path has been copied to system clipboard!")
      end
    }
  },
}

Available commands

:Telescope media_files

"Using lua function
lua require('telescope').extensions.media_files.media_files()
-- Useful for plugin developer that use telescope-media-files on their plugin
require('telescope').extensions.media_files.media_files({}, function(filepath)
  -- Your custom action to do when file is selected
end)

When you press <CR>/Enter on a selected file, it will copy its relative path to vim clipboard except when you modify on_enter.

Prerequisites

credit to https://github.com/cirala/vifmimg

About

Telescope extension to preview media files using Ueberzug.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Shell 50.7%
  • Lua 49.3%