Skip to content

[VACANT TO FINISH] TUI: Enable arrow-key cursor navigation and Enter selection in menus: Assisted by AI #2026

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.

Sign up for GitHub

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[VACANT TO FINISH] TUI: Enable arrow-key cursor navigation and Enter selection in menus: Assisted by AI #2026

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/ansible_navigator/data/help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,15 @@
- `[0-9]` Go to menu item
- `:<number> ` Go to menu item
- `:{{ n|filter }} ` Template the menu item
- `arrow up, arrow down` Move cursor
- `enter` Select highlighted item

# Content and tasks

- `[0-9]` Go to task number
- `:<number>` Go to task number
- `+, - ` Next/Previous task
- `arrow up, arrow down` Next/Previous task
- `_, :_` Toggle hidden keys
- `:{{ key|filter }}` Template the key's value
- `:d, :doc` Show the doc for the current task's module
Expand Down
93 changes: 91 additions & 2 deletions src/ansible_navigator/ui_framework/ui.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# cspell:ignore KEY_NPAGE, KEY_PPAGE
# pylint: disable=too-many-lines
"""The main UI renderer."""

from __future__ import annotations
Expand Down Expand Up @@ -199,7 +200,12 @@ def __init__(
self._status_color = 0
self._screen: Window = curses.initscr()
self._screen.timeout(refresh)
self._screen.keypad(True) # Enable keypad mode for proper key handling
self._one_line_input = FormHandlerText(screen=self._screen, ui_config=self._ui_config)
# This tracks which visible row to highlight
self._highlight_line_offset: int | None = None
# This tracks the cursor position in menus
self._menu_cursor_pos: int = 0

def clear(self) -> None:
"""Clear the screen."""
Expand Down Expand Up @@ -464,7 +470,7 @@ def _display(
index_width = len(str(count))

keypad = {str(x) for x in range(10)}
other_valid_keys = ["+", "-", "_", "KEY_F(5)", "^[", "\x1b"]
other_valid_keys = ["+", "-", "_", "KEY_F(5)", "^[", "\x1b", "CURSOR_ENTER"]

while True:
self._screen.erase()
Expand All @@ -479,10 +485,29 @@ def _display(
line_index = line_numbers[idx]
line_index_str = str(line_index).rjust(index_width)
prefix = f"{line_index_str}\u2502"
# Apply highlight decoration when this is the selected row
if (
indent_heading
and self._highlight_line_offset is not None
and idx == self._highlight_line_offset
):
# Rebuild the line with reverse-video decoration added
highlighted_parts = tuple(
CursesLinePart(
column=lp.column,
string=lp.string,
color=lp.color,
decoration=lp.decoration | curses.A_REVERSE,
)
for lp in line
)
line_to_draw = CursesLine(highlighted_parts)
else:
line_to_draw = line
self._add_line(
window=self._screen,
lineno=idx + len(heading),
line=line,
line=line_to_draw,
prefix=prefix,
)

Expand All @@ -504,6 +529,14 @@ def _display(
if await_input:
char = self._screen.getch()
key = "KEY_F(5)" if char == -1 else curses.keyname(char).decode()
# Debug: log the raw char and converted key for troubleshooting
self._logger.debug("Raw char: %s, Converted key: '%s'", char, key)
# Check for Enter key codes and return a special value for cursor navigation
if char in [10, 13]: # Enter key codes: 10=LF, 13=CR
self._logger.debug(
"Enter key detected! Raw char: %s, setting key to CURSOR_ENTER", char
)
key = "CURSOR_ENTER"
else:
key = "KEY_F(5)"

Expand Down Expand Up @@ -915,6 +948,19 @@ def _show_menu(
showing_indices,
)

# Determine which row to highlight, if enabled
self._highlight_line_offset = None
if self._menu_indices:
self._menu_cursor_pos = max(
0,
min(self._menu_cursor_pos, len(self._menu_indices) - 1),
)
selected_global_index = self._menu_indices[self._menu_cursor_pos]
try:
self._highlight_line_offset = showing_indices.index(selected_global_index)
except ValueError:
self._highlight_line_offset = None

entry = self._display(
lines=menu_lines,
line_numbers=line_numbers,
Expand All @@ -925,9 +971,52 @@ def _show_menu(
await_input=await_input,
)

# Debug: log what entry we received
self._logger.debug("Received entry: '%s'", entry)

# Handle arrow navigation for menus when enabled
if entry in ["KEY_RESIZE", "KEY_DOWN", "KEY_UP", "KEY_NPAGE", "KEY_PPAGE", "^F", "^B"]:
if entry in ["KEY_DOWN", "KEY_UP"] and self._menu_indices:
# Move the cursor position
if entry == "KEY_DOWN" and self._menu_cursor_pos < len(self._menu_indices) - 1:
self._menu_cursor_pos += 1
# If moved past the last visible item, scroll down one
if (
self._highlight_line_offset is None
or self._highlight_line_offset >= len(showing_indices) - 1
):
# Mimic _display scroll down
viewport_height = self._screen_height - len(menu_heading) - 1
self.scroll(
max(
min(self.scroll() + 1, len(self._menu_indices)),
viewport_height,
),
)
elif entry == "KEY_UP" and self._menu_cursor_pos > 0:
self._menu_cursor_pos -= 1
# If moved before the first visible item, scroll up one
if self._highlight_line_offset is None or self._highlight_line_offset <= 0:
viewport_height = self._screen_height - len(menu_heading) - 1
self.scroll(max(self.scroll() - 1, viewport_height))
# Re-render with updated highlight
continue
# Otherwise, preserve prior behavior
continue

# Enter key should select the highlighted item for cursor navigation
if (
entry == "CURSOR_ENTER" or entry in ["^J", "^M", "KEY_ENTER", "KEY_RETURN"]
) and self._menu_indices:
self._logger.debug(
"Enter key selection triggered! Entry: '%s', Selecting index %s",
entry,
self._menu_cursor_pos,
)
index_to_select = self._menu_indices[self._menu_cursor_pos]
entry = str(index_to_select)
self._logger.debug("Changed entry to: '%s'", entry)

name, action = self._template_match_action(entry, current)
if name and action:
if name == "select":
Expand Down
Loading