iota/iota-cli/src/help_overlay.rs

use crossterm::event::KeyCode;
use ratatui::{
    Frame,
    layout::Rect,
    text::{Line, Span},
    widgets::{Block, Borders, Clear, Paragraph},
};

use crate::{
    interaction_result::InteractionResult,
    render_context::RenderContext,
    screens::screens::{HitMap, Screen, UiEvent},
    theme::ResolvedTheme,
};

pub struct HelpOverlay {
    scroll: usize,
}

impl HelpOverlay {
    pub fn new() -> Self {
        Self { scroll: 0 }
    }

    fn build_lines(&self, theme: &ResolvedTheme) -> Vec<Line<'static>> {
        vec![
            Line::from(""),
            Line::from(Span::styled(
                "Global Keyboard Shortcuts",
                theme.text.heading,
            )),
            Line::from(""),
            Line::from(vec![
                Span::styled("  F6", theme.text.link),
                Span::styled("        Toggle header navigation", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Tab", theme.text.link),
                Span::styled("      Move focus to next panel", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Shift+Tab", theme.text.link),
                Span::styled("  Move focus to previous panel", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Esc", theme.text.link),
                Span::styled("        Go back / Close dialog", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Ctrl+C", theme.text.link),
                Span::styled("      Quit the application", theme.text.normal),
            ]),
            Line::from(""),
            Line::from(Span::styled("Dashboard Navigation", theme.text.heading)),
            Line::from(""),
            Line::from(vec![
                Span::styled("  o/O", theme.text.link),
                Span::styled("        Open Overview screen", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  u/U", theme.text.link),
                Span::styled("        Open Users screen", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  m/M", theme.text.link),
                Span::styled("        Open Metrics screen", theme.text.normal),
            ]),
            Line::from(""),
            Line::from(Span::styled("Log Panel", theme.text.heading)),
            Line::from(""),
            Line::from(vec![
                Span::styled("  j/Down", theme.text.link),
                Span::styled("     Scroll down", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  k/Up", theme.text.link),
                Span::styled("       Scroll up", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Enter", theme.text.link),
                Span::styled("      Lock/unlock scroll", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  /", theme.text.link),
                Span::styled("          Filter logs", theme.text.normal),
            ]),
            Line::from(""),
            Line::from(Span::styled("Console Panel", theme.text.heading)),
            Line::from(""),
            Line::from(vec![
                Span::styled("  Enter", theme.text.link),
                Span::styled("      Send command", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Up/Down", theme.text.link),
                Span::styled("    Command history", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Tab", theme.text.link),
                Span::styled("        Auto-complete", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  /help", theme.text.link),
                Span::styled("       List available commands", theme.text.normal),
            ]),
            Line::from(""),
            Line::from(Span::styled("List Navigation", theme.text.heading)),
            Line::from(""),
            Line::from(vec![
                Span::styled("  j/Down", theme.text.link),
                Span::styled("     Next item", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  k/Up", theme.text.link),
                Span::styled("       Previous item", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  PgUp/PgDn", theme.text.link),
                Span::styled("  Page up/down", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  Home", theme.text.link),
                Span::styled("       First item", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  End", theme.text.link),
                Span::styled("        Last item", theme.text.normal),
            ]),
            Line::from(vec![
                Span::styled("  /", theme.text.link),
                Span::styled("          Filter list", theme.text.normal),
            ]),
            Line::from(""),
            Line::from(Span::styled(
                "Press ? or Esc to close this overlay",
                theme.text.muted,
            )),
        ]
    }
}

impl Screen for HelpOverlay {
    fn as_any(&self) -> &dyn Any {
        self
    }

    fn as_any_mut(&mut self) -> &mut dyn Any {
        self
    }

    fn render(&self, f: &mut Frame, rect: Rect, context: &RenderContext<'_>, _hits: &mut HitMap) {
        let area = crate::layout::fit::centered_rect(
            rect,
            crate::layout::fit::RequiredSize {
                width: 52,
                height: 40,
            },
        );

        f.render_widget(Clear, area);
        let block = Block::default()
            .title(" Keyboard Shortcuts (?) ")
            .borders(Borders::ALL)
            .border_style(context.theme.borders.focused)
            .style(context.theme.surfaces.overlay);

        let inner = block.inner(area);
        f.render_widget(block, area);

        let lines = self.build_lines(context.theme);
        let paragraph = Paragraph::new(lines)
            .scroll((self.scroll as u16, 0))
            .style(context.theme.text.normal);
        f.render_widget(paragraph, inner);
    }

    fn handle_event(&mut self, event: UiEvent) -> InteractionResult {
        let UiEvent::Key(key) = event else {
            return InteractionResult::Unhandled;
        };
        match key.code {
            KeyCode::Esc | KeyCode::Char('?') | KeyCode::Char('q') => {
                InteractionResult::CloseScreen
            }
            KeyCode::Down | KeyCode::Char('j') => {
                self.scroll = self.scroll.saturating_add(1);
                InteractionResult::Handled
            }
            KeyCode::Up | KeyCode::Char('k') => {
                self.scroll = self.scroll.saturating_sub(1);
                InteractionResult::Handled
            }
            KeyCode::PageDown => {
                self.scroll = self.scroll.saturating_add(10);
                InteractionResult::Handled
            }
            KeyCode::PageUp => {
                self.scroll = self.scroll.saturating_sub(10);
                InteractionResult::Handled
            }
            _ => InteractionResult::Unhandled,
        }
    }

    fn key_hints(&self) -> Vec<crate::screens::screens::KeyHint> {
        vec![
            crate::screens::screens::KeyHint {
                keys: "Up/Down",
                action: "Scroll",
            },
            crate::screens::screens::KeyHint {
                keys: "Esc/?",
                action: "Close",
            },
        ]
    }
}

use std::any::Any;