Skip to content

Commit cd9d915

Browse files
author
nvim-orgmode
committed
1 parent b32bede commit cd9d915

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

docs/configuration.org

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1519,6 +1519,13 @@ Use vim regex flag =\c= to make it case insensitive. See
15191519
=:help vim.regex()= and =:help /magic=.
15201520
Pressing =<TAB>= in filter prompt autocompletes categories and tags.
15211521

1522+
**** org_agenda_preview
1523+
:PROPERTIES:
1524+
:CUSTOM_ID: org_agenda_preview
1525+
:END:
1526+
- Mapped to: =K=
1527+
Preview the agenda item in a floating window. For configuring the floating window, check [[#agenda][Agenda section in ui configuration]].
1528+
15221529
**** org_agenda_show_help
15231530
:PROPERTIES:
15241531
:CUSTOM_ID: org_agenda_show_help
@@ -2995,8 +3002,6 @@ require('orgmode').setup({
29953002
:PROPERTIES:
29963003
:CUSTOM_ID: input
29973004
:END:
2998-
- Type: =boolean=
2999-
- Default: =false=
30003005

30013006
By default, Vim's built-in =input()= function is used for input prompts.
30023007
To use Neovim's =vim.ui.input()= function, add this to config:
@@ -3012,3 +3017,26 @@ require('orgmode').setup({
30123017
#+end_src
30133018

30143019
📝 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.
3020+
3021+
*** Agenda
3022+
:PROPERTIES:
3023+
:CUSTOM_ID: agenda
3024+
:END:
3025+
Use this section to customize the styling of the Agenda preview floating window (See [[#org_agenda_preview][org_agenda_preview]] mapping).
3026+
To see available options for the preview window, check =:help vim.lsp.util.open_floating_preview.Opts=.
3027+
Here's an example how to configure it:
3028+
3029+
#+begin_src lua
3030+
require('orgmode').setup({
3031+
ui = {
3032+
agenda = {
3033+
preview_window = {
3034+
wrap = false, -- This option is set by default
3035+
border = 'single'
3036+
}
3037+
}
3038+
}
3039+
})
3040+
#+end_src
3041+
3042+
📝 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.

0 commit comments

Comments
 (0)