-
Notifications
You must be signed in to change notification settings - Fork 22
feat(tui): Help screen and keyboard shortcut reference overlay #453
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
Open
jaeko44
wants to merge
11
commits into
main
Choose a base branch
from
task/eb0893c6b815-feat-tui-help-screen-and-keyboard-shortcut-refer
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
ef44101
chore: auto-commit agent work (eb0893c6-b81)
jaeko44 8dbdb88
Update tui/app.mjs
jaeko44 a824e6d
Update tui/app.mjs
jaeko44 942b30d
Update tui/app.mjs
jaeko44 b4d5c8e
Update ui/tui/App.js
jaeko44 ff6ffe4
Merge remote-tracking branch 'origin/main' into task/eb0893c6b815-fea…
jaeko44 ab2f8b5
Merge remote-tracking branch 'origin/task/eb0893c6b815-feat-tui-help-…
jaeko44 5952ca1
Merge branch 'main' into task/eb0893c6b815-feat-tui-help-screen-and-k…
jaeko44 d1b9726
Merge branch 'main' into task/eb0893c6b815-feat-tui-help-screen-and-k…
jaeko44 57729a2
Merge remote-tracking branch 'origin/main' into HEAD
jaeko44 049641f
Merge remote-tracking branch 'origin/main' into HEAD
jaeko44 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| import React, { useCallback, useEffect, useMemo, useState } from "react"; | ||
| import htm from "htm"; | ||
| import { Box, Text, useApp, useInput } from "ink"; | ||
| import { Box, Text, useApp, useInput, useStdout } from "ink"; | ||
|
|
||
| import wsBridgeFactory from "./lib/ws-bridge.mjs"; | ||
| import { getNextScreenForInput } from "./lib/navigation.mjs"; | ||
|
|
@@ -10,6 +10,7 @@ import AgentsScreen from "./screens/agents.mjs"; | |
| import StatusScreen from "./screens/status.mjs"; | ||
| import { readTuiHeaderConfig } from "./lib/header-config.mjs"; | ||
| import { listTasksFromApi } from "../ui/tui/tasks-screen-helpers.js"; | ||
| import HelpScreen, { getFooterHints } from "../ui/tui/HelpScreen.js"; | ||
|
|
||
| const html = htm.bind(React.createElement); | ||
|
|
||
|
|
@@ -52,6 +53,7 @@ function upsertById(items = [], nextItem) { | |
|
|
||
| export default function App({ host, port, connectOnly, initialScreen, refreshMs, wsClient }) { | ||
| const { exit } = useApp(); | ||
| const { stdout } = useStdout(); | ||
| const [screen, setScreen] = useState(initialScreen || "status"); | ||
| const [connected, setConnected] = useState(false); | ||
| const [connectionState, setConnectionState] = useState("offline"); | ||
|
|
@@ -60,6 +62,9 @@ export default function App({ host, port, connectOnly, initialScreen, refreshMs, | |
| const [tasks, setTasks] = useState([]); | ||
| const [error, setError] = useState(null); | ||
| const [screenInputLocked, setScreenInputLocked] = useState(false); | ||
| const [helpOpen, setHelpOpen] = useState(false); | ||
| const [helpScrollOffset, setHelpScrollOffset] = useState(0); | ||
| const [footerHints, setFooterHints] = useState(() => getFooterHints(initialScreen || "status")); | ||
| const [refreshCountdownSec, setRefreshCountdownSec] = useState( | ||
| Math.max(0, Math.ceil(Number(refreshMs || 2000) / 1000)), | ||
| ); | ||
|
|
@@ -180,28 +185,53 @@ export default function App({ host, port, connectOnly, initialScreen, refreshMs, | |
| }; | ||
| }, [bridge, refreshMs]); | ||
|
|
||
| useEffect(() => { | ||
| setFooterHints((current) => (current?.length ? current : getFooterHints(screen))); | ||
| }, [screen]); | ||
jaeko44 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| useEffect(() => { | ||
| const intervalId = setInterval(() => { | ||
| setRefreshCountdownSec((previous) => Math.max(0, previous - 1)); | ||
| }, 1000); | ||
| return () => clearInterval(intervalId); | ||
| }, []); | ||
|
|
||
| const handleInput = useCallback((input) => { | ||
| const handleInput = useCallback((input, key) => { | ||
| if (input === "?") { | ||
| setHelpOpen((current) => !current); | ||
| return; | ||
| } | ||
| if (helpOpen) { | ||
| if (key?.escape) { | ||
| setHelpOpen(false); | ||
| return; | ||
| } | ||
| if (key?.upArrow) { | ||
| setHelpScrollOffset((current) => Math.max(0, current - 1)); | ||
| return; | ||
| } | ||
| if (key?.downArrow) { | ||
| setHelpScrollOffset((current) => current + 1); | ||
| return; | ||
| } | ||
|
Comment on lines
+205
to
+217
|
||
| return; | ||
| } | ||
| if (input === "q") { | ||
| exit(); | ||
| return; | ||
| } | ||
| setScreen((current) => getNextScreenForInput(current, input)); | ||
| }, [exit]); | ||
| }, [exit, helpOpen]); | ||
|
|
||
| useInput((input) => { | ||
| if (screenInputLocked) return; | ||
| handleInput(input); | ||
| useInput((input, key) => { | ||
| if (screenInputLocked && !helpOpen) return; | ||
jaeko44 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| handleInput(input, key); | ||
| }); | ||
|
|
||
| const ScreenComponent = SCREENS[screen] || StatusScreen; | ||
| const screenStats = screen === "status" ? stats : undefined; | ||
| const footerText = (footerHints || []).map(([keysLabel, description]) => `${keysLabel} ${description}`).join(" | "); | ||
| const helpRows = Math.max(6, (stdout?.rows || 24) - 5); | ||
|
|
||
| return html` | ||
| <${Box} flexDirection="column" minHeight=${0}> | ||
|
|
@@ -233,7 +263,18 @@ export default function App({ host, port, connectOnly, initialScreen, refreshMs, | |
| refreshMs=${refreshMs} | ||
| onTasksChange=${setTasks} | ||
| onInputCaptureChange=${setScreenInputLocked} | ||
| onFooterHintsChange=${setFooterHints} | ||
| /> | ||
| ${helpOpen | ||
| ? html` | ||
| <${Box} flexDirection="column" marginTop=${1}> | ||
| <${HelpScreen} scrollOffset=${helpScrollOffset} maxRows=${helpRows} /> | ||
jaeko44 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| <//> | ||
| ` | ||
| : null} | ||
| <//> | ||
| <${Box} paddingX=${1}> | ||
| <${Text} dimColor>${footerText}<//> | ||
| <//> | ||
| <//> | ||
| `; | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
latestText()is coupled to the literal string "Agents:" (from StatusHeader row1). This makes the test harness brittle to unrelated header text changes. Consider deriving the “latest frame” boundary from Ink’s clear-screen sequences in the raw buffer, or introducing an explicit frame delimiter, instead of hardcoding a header substring.