feat(agenda): Add mapping to preview headline in agenda with "K"

Author: kristijanhusak

docs/configuration.org

@@ -1519,6 +1519,13 @@ Use vim regex flag =\c= to make it case insensitive. See
 =:help vim.regex()= and =:help /magic=.
 Pressing =<TAB>= in filter prompt autocompletes categories and tags.
 
+**** org_agenda_preview
+:PROPERTIES:
+:CUSTOM_ID: org_agenda_preview
+:END:
+- Mapped to: =K=
+  Preview the agenda item in a floating window. For configuring the floating window, check [[#agenda][Agenda section in ui configuration]].
+
 **** org_agenda_show_help
 :PROPERTIES:
 :CUSTOM_ID: org_agenda_show_help
@@ -2995,8 +3002,6 @@ require('orgmode').setup({
 :PROPERTIES:
 :CUSTOM_ID: input
 :END:
-- Type: =boolean=
-- Default: =false=
 
 By default, Vim's built-in =input()= function is used for input prompts.
 To use Neovim's =vim.ui.input()= function, add this to config:
@@ -3012,3 +3017,26 @@ require('orgmode').setup({
 #+end_src
 
 📝 NOTE: If you are using a plugin for =vim.ui.input=, make sure it supports autocompletion for better experience. [[https://github.com/folke/snacks.nvim][snacks.nvim]] input module supports autocompletion.
+
+*** Agenda
+:PROPERTIES:
+:CUSTOM_ID: agenda
+:END:
+Use this section to customize the styling of the Agenda preview floating window (See [[#org_agenda_preview][org_agenda_preview]] mapping).
+To see available options for the preview window, check =:help vim.lsp.util.open_floating_preview.Opts=.
+Here's an example how to configure it:
+
+#+begin_src lua
+require('orgmode').setup({
+  ui = {
+    agenda = {
+      preview_window = {
+        wrap = false, -- This option is set by default
+        border = 'single'
+      }
+    }
+  }
+})
+#+end_src
+
+📝 NOTE: This preview should be used only as read only view of the headline and it's content. Modifying the file from the preview window is not supported.

lua/orgmode/agenda/init.lua

@@ -382,6 +382,28 @@ function Agenda:refile()
   })
 end
 
+function Agenda:preview_item()
+  local headline = self:get_headline_at_cursor()
+  if not headline then
+    return
+  end
+
+  local lines = headline:get_lines()
+  local offset = 4
+  local width = lines[1]:len() + offset
+
+  vim.tbl_map(function(line)
+    width = math.max(width, line:len() + offset)
+  end, lines)
+
+  local win_opts = vim.tbl_deep_extend('force', {
+    width = width,
+  }, config.ui.agenda.preview_window or {})
+
+  local buf = vim.lsp.util.open_floating_preview(lines, '', win_opts)
+  vim.api.nvim_set_option_value('filetype', 'org', { buf = buf })
+end
+
 function Agenda:clock_out()
   return self:_remote_edit({
     action = 'clock.org_clock_out',
@@ -591,11 +613,8 @@ function Agenda:get_headline_at_cursor()
 
   for _, view in ipairs(self.views) do
     local agenda_line = view:get_line(line_nr)
-    if agenda_line then
-      local headline = agenda_line.headline
-      if headline then
-        return headline
-      end
+    if agenda_line and agenda_line.headline then
+      return agenda_line.headline
     end
   end
 end

lua/orgmode/config/_meta.lua

@@ -174,6 +174,7 @@
 ---@field folds? { colored: boolean } Should folds be colored or use the default folding highlight. Default: { colored: true }
 ---@field menu? { handler: fun() | nil } Menu configuration
 ---@field input? { use_vim_ui: boolean } Input configuration
+---@field agenda? { preview_window?: vim.lsp.util.open_floating_preview.Opts } Agenda preview window option
 
 ---@class OrgMappingsConfig
 ---@field disable_all? boolean Disable all mappings. Default: false

lua/orgmode/config/defaults.lua

@@ -124,6 +124,7 @@ local DefaultConfig = {
       org_agenda_filter = '/',
       org_agenda_refile = '<prefix>r',
       org_agenda_add_note = '<prefix>na',
+      org_agenda_preview = 'K',
       org_agenda_show_help = 'g?',
     },
     capture = {
@@ -221,6 +222,11 @@ local DefaultConfig = {
     input = {
       use_vim_ui = false,
     },
+    agenda = {
+      preview_window = {
+        wrap = false,
+      },
+    },
   },
 }
 

lua/orgmode/config/mappings/init.lua

@@ -123,6 +123,12 @@ return {
         help_desc = 'Refile headline to specific destination',
       },
     }),
+    org_agenda_preview = m.action('agenda.preview_item', {
+      opts = {
+        desc = 'org preview',
+        help_desc = 'Preview agenda item in floating window',
+      },
+    }),
     org_agenda_add_note = m.action(
       'agenda.add_note',
       { opts = { desc = 'org add note', help_desc = 'Add a note to the current headline' } }