Multiline prompts?

[DavidVentura]

I am trying to use a Completion where the display_meta is very long (like help text). But I can't get it to wrap / render new lines (\r nor \n). newlines render as ^J. I also tried using <br/> when parsing as HTML but that also doesn't work. is this supported/ easy to support?

Example image attached

[MrMino]

You need to give people some code that exemplifies what you are trying to do, otherwise you're making it difficult to help you.

[DavidVentura]

Sure, that's a screenshot of the example colored-completions.py, i assumed the example unnecessary, but here's one:

from prompt_toolkit.completion import Completer, Completion
from prompt_toolkit.shortcuts import prompt

class ColorCompleter(Completer):
    def get_completions(self, document, complete_event):
        word = document.get_word_before_cursor()
        yield Completion("Some value", display_meta="Line1\nLine2")
prompt("Prompt ", completer=ColorCompleter())

this snippet does not show 2 lines, instead it shows Line1^JLine2

[MrMino]

Quick notes (updated as I go):

• Some of this is handled in CompletionsMenuControl.create_content

• The closure get_line in that method utilizes CompletionsMenuControl. _get_menu_item_meta_fragments, which returns somewhat correct FormattedText:

   from prompt_toolkit import print_formatted_text
   from prompt_toolkit.completion import Completion
   from prompt_toolkit.layout.menus import CompletionsMenuControl, _get_menu_item_fragments
  
   completion = Completion("Some value", display_meta="Line1\nLine2")
   ftext = _get_menu_item_fragments(completion, True, 10, True)
   ftext += CompletionsMenuControl()._get_menu_item_meta_fragments(completion, True, 10)
   print_formatted_text(ftext)

• The closure that returns these lines is then given to an UIContent instance
• The instance has a get_line(idx) method, where a line with the newline character is returned, which is wrong.
• To fix this, the get_line(idx) closure has to be modified such that it defers the next line into the return value for the next idx
• Additionally, the meta-text needs to be indented the right way in the next line - currently it is not.

[DavidVentura]

I think there's something else - I modified create_content to return duplicated completions if there are newlines:

    def create_content(self, width: int, height: int) -> UIContent:
        """
        Create a UIContent object for this control.
        """
        complete_state = get_app().current_buffer.complete_state
        if complete_state:
            completions = []
            for c in complete_state.completions:
                for line in c.display_meta_text.splitlines():
                    completions.append(c)

but still get_line only ever gets called with idx 0 -- i presume the height of the "popup" is not related to the # of completions in the UIContent.

and from my rudimentary understanding, a lot of the logic depends on cursor_position.y, so returning more lines would require many changes..

it looks like returning "thicker" lines and accounting for per-line height while rendering would be a lot easier

[DavidVentura]

hey, i followed the idea from @MrMino and hacked something together that kinda works:

however the floating window does not show all rows even with space. not sure where to start digging for that. i will open a PR later today for some discussion on the approach