feat: add setup opts, callbacks, persistent bookmarks, text search and menu UI

README.md

@@ -7,13 +7,17 @@
 
 ## Features
 
-- **Open PDF Files**: Use Telescope to quickly search and open PDF files.
+- **Open PDF Files**: Quickly search and open PDF files using the currently supported pickers: `telescope.nvim`, `fzf-lua`, or the built-in `vim.ui.select`.
 - **Extract Text**: Extract the text from a PDF using `pdftotext` for easy reading or note-taking.
 - **Pagination**: Navigate through the document using next/previous page commands.
 - **Customizable Pagination**: Set how many lines per page should be displayed.
 - **Virtual Text Display**: See page numbers displayed in the buffer.
+- **Bookmarks**: Save your reading position with a bookmark and jump back to it anytime.
+
+
+<img width="800" height="495" alt="260709-14-22-34" src="https://github.com/user-attachments/assets/20ce5aa0-ffca-4972-9ca4-501736de00ac" />
+
 
-![Preview](https://i.imgur.com/ClDZhnc.gif)
 
 ---
 
@@ -22,8 +26,12 @@
 ### Prerequisites
 
 - **Neovim** version 0.5 or higher
-- **Telescope.nvim**: The plugin uses Telescope to search for PDF files.
-- **pdftotext**: This plugin relies on the `pdftotext` command-line tool to extract text from PDFs. Install `pdftotext` using the following command:
+- **Picker**: **Telescope.nvim** (optional), **Fzf-lua** (optional), or the **default** picker (`vim.ui.select`)
+- **[Zathura](https://github.com/pwmt/zathura)**: document viewer
+  ```bash
+  sudo apt install zathura
+  ```
+- **pdftotext**: this plugin relies on the `pdftotext` command-line tool to extract text from PDFs. Install it using the following command:
   ```bash
   sudo apt install poppler-utils
   ```
@@ -35,16 +43,57 @@ To install `PDFview.nvim` using **LazyVim**, add the following configuration to
 ```lua
 {
   "basola21/PDFview",
-  lazy = false,
-  dependencies = { "nvim-telescope/telescope.nvim" }
-}
+  event = "VeryLazy",
+  dependencies = { 
+    "nvim-telescope/telescope.nvim" 
+  },
+  opts = {
+    path = "/path/to/pdf_folder", -- path pdf folder
+    save = "/path/to/save_folder", -- bookmark save folder
+    picker = "default", -- fzf-lua, telescope, default (using vim.ui.select)
+    open = {
+      cb = nil,
+    },
+    window = {
+      winhighlight = nil,
+    },
+    keymaps = {
+      menu = "<CR>",
+      go_to_page = "gf",
+      show_page_in_zathura = "<Leader>x",
+      next_page = "<a-n>",
+      prev_page = "<a-p>",
+      bookmark = "b",
+      save = "s",
+    },
+    keys = {
+      {
+        "<Leader>fp",
+        function()
+          require("pdfview").select_file_pdf()
+        end,
+        desc = "Select pdf file",
+      },
+      {
+        "<Leader>fP",
+        function()
+          require("pdfview").menu()
+        end,
+        desc = "Open menu",
+      },
+  },
+},
 ```
 
 ### Mappings
 
-You can add the following key mappings to your Neovim configuration for easy navigation through the PDF pages:
+The `next_page` and `prev_page` keymaps are already set up for you in the `opts.keymaps` table above.
+However, if you'd rather define your own custom keys instead of using the built-in ones, you can call the underlying functions directly:
 
 ```lua
+-- Open menu pdfview
+map("n", "<leader>ff", "<cmd>:lua require('pdfview').menu()<CR>", { desc = "PDFview: Menu" })
+
 -- Navigate to the next page in the PDF
 map("n", "<leader>jj", "<cmd>:lua require('pdfview.renderer').next_page()<CR>", { desc = "PDFview: Next page" })
 
@@ -59,14 +108,16 @@ map("n", "<leader>kk", "<cmd>:lua require('pdfview.renderer').previous_page()<CR
 1. **Opening a PDF File**  
    Use the following command to open a PDF:
    ```lua
-   require('pdfview').open()
+   require("pdfview").select_file_pdf()
+   -- or
+   require("pdfview").menu()
    ```
    This will open Telescope's file finder, allowing you to search for PDF files in your project or system.
 
 2. **Navigating Pages**  
    Use the defined key mappings to navigate between pages:
-   - `<leader>jj` for the next page.
-   - `<leader>kk` for the previous page.
+   - `<a-n>` or `<leader>jj` for the next page.
+   - `<a-p>` or `<leader>kk` for the previous page.
 
 3. **Extracting Text from a PDF**  
    When you select a PDF using Telescope, the plugin extracts the text using `pdftotext` and displays it in a buffer, allowing for easy reading or note-taking.
@@ -86,14 +137,63 @@ map("n", "<leader>kk", "<cmd>:lua require('pdfview.renderer').previous_page()<CR
 
 ## Configuration
 
-The default lines per page are set to `50`. You can change this value by modifying the `lines_per_page` variable in the `renderer.lua` file.
+### Support callback
+
+You can define a custom callback function (`open.cb`) that gets triggered whenever a PDF is opened, receiving the PDF's file path as an argument. This is useful for integrating with other plugins, for example, automatically sending the opened PDF to codecompanion.nvim for translation or summarization.
+
+Example using `codecompanion.nvim`:
+
+```lua
+
+  ... -- default config
+  open = {
+     cb = function(pdf_path)
+       vim.api.nvim_input ":CodeCompanion /translator_role <CR>"
+     end,
+  },
+```
+
+### Support Statusline
+
+Example using `heirline.nvim`:
+
+```lua
+local get_pdfview = function()
+  if not pdfview then
+    local ok, session = pcall(require, "pdfview.renderer")
+    if ok then
+      pdfview = session
+    end
+  end
+  return pdfview
+end
+
+
+...
+
+{
+  ...
+	provider = function()
+		if vim.bo.filetype == "pdfview" then
+			if not pdfview then
+				pdfview = get_pdfview()
+			end
+
+			local pdf_render = pdfview.get()
+			if pdf_render and pdf_render.pdf_path then
+				return vim.fn.fnamemodify(pdf_render.pdf_path, ":~") .. " (Page " .. pdf_render.current_page .. ")"
+			end
+		end
+	end,
+}
+
+```
 
 ---
 
 ## Planned Features
 
 - **Improved Navigation**: Refine the pagination and scrolling behavior for a smoother reading experience.
-- **Customization**: Add options for setting default configurations like `lines_per_page` and buffer options.
 - **Document Search**: Implement a search feature to find specific text within the PDF.
 - **Improved Structure**: Enhance the project structure for better maintainability and scalability.
 

TODO.org

@@ -0,0 +1,11 @@
+* TODO
+  - [x] define bookmark save path
+  - [x] implement bookmark menu
+  - [x] implement bookmark saving
+  - [x] implement last bookmark
+
+  - [X] implement text search
+  - [ ] implement snacks picker
+  - [ ] implement toggle case_sensitive
+  - [ ] implement popup search status
+  - [ ] update readme

lua/pdfview/config.lua

@@ -0,0 +1,51 @@
+local M = {}
+
+---@type PDFviewCfg
+M.defaults = {
+  path = vim.fn.stdpath "config",
+  save = vim.fn.stdpath "state",
+  picker = "default",
+  open = {
+    cb = nil,
+  },
+  window = {
+    winhighlight = nil,
+    text_search_indicator = {
+      sep_front = "",
+      sep_back = "",
+      hl = "WarningMsg",
+      attr = "fg",
+      icon = " ",
+    },
+  },
+  keymaps = {
+    menu = "<CR>",
+    go_to_page = "gf",
+    show_page_in_zathura = "<Leader>x",
+    next_page = "<a-n>",
+    prev_page = "<a-p>",
+    open_bookmark = "b",
+    save_bookmark = "s",
+    search = "<C-s>",
+    pick_search = "<Leader>s",
+    next_search_text = "<C-n>",
+    prev_search_text = "<C-p>",
+  },
+}
+
+---@param cfg_tbl PDFviewCfg
+---@param opts PDFviewCfg
+local function merge_settings(cfg_tbl, opts)
+  opts = opts or {}
+  local def = vim.tbl_deep_extend("force", cfg_tbl, opts)
+  return def
+end
+
+---@param opts PDFviewCfg
+function M.update_settings(opts)
+  opts = opts or {}
+
+  M.defaults = merge_settings(M.defaults, opts)
+end
+
+return M