Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Word wrapping #1887

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
154 changes: 154 additions & 0 deletions examples/full-screen/simple-demos/word-wrapping.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
#!/usr/bin/env python
"""
An example of a BufferControl in a full screen layout that offers auto
completion.

Important is to make sure that there is a `CompletionsMenu` in the layout,
otherwise the completions won't be visible.
"""

from prompt_toolkit.application import Application
from prompt_toolkit.buffer import Buffer
from prompt_toolkit.filters import Condition
from prompt_toolkit.formatted_text import HTML, to_formatted_text
from prompt_toolkit.key_binding import KeyBindings
from prompt_toolkit.layout.containers import Float, FloatContainer, HSplit, Window
from prompt_toolkit.layout.controls import BufferControl, FormattedTextControl
from prompt_toolkit.layout.layout import Layout
from prompt_toolkit.layout.menus import CompletionsMenu

LIPSUM = " ".join(
"""\
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas
quis interdum enim. Nam viverra, mauris et blandit malesuada, ante est bibendum
mauris, ac dignissim dui tellus quis ligula. Aenean condimentum leo at
dignissim placerat. In vel dictum ex, vulputate accumsan mi. Donec ut quam
placerat massa tempor elementum. Sed tristique mauris ac suscipit euismod. Ut
tempus vehicula augue non venenatis. Mauris aliquam velit turpis, nec congue
risus aliquam sit amet. Pellentesque blandit scelerisque felis, faucibus
consequat ante. Curabitur tempor tortor a imperdiet tincidunt. Nam sed justo
sit amet odio bibendum congue. Quisque varius ligula nec ligula gravida, sed
convallis augue faucibus. Nunc ornare pharetra bibendum. Praesent blandit ex
quis sodales maximus.""".split("\n")
)


def get_line_prefix(lineno, wrap_count):
if wrap_count == 0:
return HTML('[%s] <style bg="orange" fg="black">--&gt;</style> ') % lineno

text = str(lineno) + "-" + "*" * (lineno // 2) + ": "
return HTML('[%s.%s] <style bg="ansigreen" fg="ansiblack">%s</style>') % (
lineno,
wrap_count,
text,
)


# Global wrap lines flag.
wrap_lines = True


# The layout
buff = Buffer(complete_while_typing=True)
buff.text = LIPSUM


body = FloatContainer(
content=HSplit(
[
Window(
FormattedTextControl(
'Press "q" to quit. Press "w" to enable/disable wrapping.'
),
height=1,
style="reverse",
),
# Break words
Window(
BufferControl(buffer=buff),
wrap_lines=Condition(lambda: wrap_lines),
word_wrap=False,
),
# Default word wrapping
Window(
BufferControl(buffer=buff),
wrap_lines=Condition(lambda: wrap_lines),
word_wrap=True,
),
# Add a marker to signify continuation
Window(
BufferControl(buffer=buff),
wrap_lines=True,
wrap_finder=Window._whitespace_wrap_finder(
continuation=to_formatted_text(" ⮠")
),
get_line_prefix=lambda lineno, wrap_count: to_formatted_text(" ⭢ ")
if wrap_count
else [],
),
# Truncating (only wrap the first time around)
Window(
BufferControl(buffer=buff),
wrap_lines=True,
wrap_finder=lambda line,
lineno,
wrap_count,
start,
end,
fallback=Window._whitespace_wrap_finder(): (end - 3, -1, "...")
if wrap_count > 0
else fallback(line, lineno, wrap_count, start, end),
),
# Split only after vowels
Window(
BufferControl(buffer=buff),
wrap_lines=True,
wrap_finder=Window._whitespace_wrap_finder(
sep="[aeiouyAEIOUY]",
split="after",
continuation=to_formatted_text("-"),
),
),
]
),
floats=[
Float(
xcursor=True,
ycursor=True,
content=CompletionsMenu(max_height=16, scroll_offset=1),
)
],
)


# Key bindings
kb = KeyBindings()


@kb.add("q")
@kb.add("c-c")
def _(event):
"Quit application."
event.app.exit()


@kb.add("w")
def _(event):
"Disable/enable wrapping."
global wrap_lines
wrap_lines = not wrap_lines


# The `Application`
application = Application(
layout=Layout(body), key_bindings=kb, full_screen=True, mouse_support=True
)


def run():
application.run()


if __name__ == "__main__":
run()
13 changes: 10 additions & 3 deletions examples/prompts/auto-completion/fuzzy-custom-completer.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,21 +36,28 @@ def get_completions(self, document, complete_event):
def main():
# Simple completion menu.
print("(The completion menu displays colors.)")
prompt("Type a color: ", completer=FuzzyCompleter(ColorCompleter()))
r = prompt(
"Type a color: ",
completer=FuzzyCompleter(ColorCompleter()),
complete_style=CompleteStyle.MULTI_COLUMN,
)
print(r)

# Multi-column menu.
prompt(
r = prompt(
"Type a color: ",
completer=FuzzyCompleter(ColorCompleter()),
complete_style=CompleteStyle.MULTI_COLUMN,
)
print(r)

# Readline-like
prompt(
r = prompt(
"Type a color: ",
completer=FuzzyCompleter(ColorCompleter()),
complete_style=CompleteStyle.READLINE_LIKE,
)
print(r)


if __name__ == "__main__":
Expand Down
Loading
Loading