Radish alpha
r
radicle-tui
rad:z39mP9rQAaGmERfUMPULfPUi473tY
Radicle terminal user interface
Radicle
Git
Patches › c08ea4f5
issue: Add selection help
Merged did:key:z6MkgFq6...nBGz opened 2 years ago
Activity Changes +310 -6
2 files changed +310 -6 3da86484 → 1e21a105
modified bin/commands/issue/flux/select.rs
@@ -37,6 +37,7 @@ pub struct App {
pub struct UIState {

    page_size: usize,

    show_search: bool,
+ 
    show_help: bool,

}



impl Default for UIState {
@@ -44,6 +45,7 @@ impl Default for UIState {
        Self {

            page_size: 1,

            show_search: false,
+ 
            show_help: false,

        }

    }

}
@@ -91,6 +93,8 @@ pub enum Action {
    UpdateSearch { value: String },

    ApplySearch,

    CloseSearch,
+ 
    OpenHelp,
+ 
    CloseHelp,

}



impl store::State<Action, Selection> for State {
@@ -125,6 +129,14 @@ impl store::State<Action, Selection> for State {
                self.ui.show_search = false;

                None

            }
+ 
            Action::OpenHelp => {
+ 
                self.ui.show_help = true;
+ 
                None
+ 
            }
+ 
            Action::CloseHelp => {
+ 
                self.ui.show_help = false;
+ 
                None
+ 
            }

        }

    }

}
modified bin/commands/issue/flux/select/ui.rs
@@ -10,7 +10,7 @@ use termion::event::Key;
use ratatui::backend::Backend;

use ratatui::layout::{Constraint, Layout, Rect};

use ratatui::style::Stylize;
- 
use ratatui::text::Line;
+ 
use ratatui::text::{Line, Span, Text};



use radicle_tui as tui;
@@ -18,6 +18,7 @@ use tui::flux::ui::items::{IssueItem, IssueItemFilter};
use tui::flux::ui::span;

use tui::flux::ui::widget::container::{Footer, FooterProps, Header, HeaderProps};

use tui::flux::ui::widget::input::{TextField, TextFieldProps};
+ 
use tui::flux::ui::widget::text::{Paragraph, ParagraphProps};

use tui::flux::ui::widget::{

    Render, Shortcut, Shortcuts, ShortcutsProps, Table, TableProps, Widget,

};
@@ -32,6 +33,7 @@ pub struct ListPageProps {
    selected: Option<IssueItem>,

    mode: Mode,

    show_search: bool,
+ 
    show_help: bool,

}



impl From<&State> for ListPageProps {
@@ -40,11 +42,12 @@ impl From<&State> for ListPageProps {
            selected: state.selected.clone(),

            mode: state.mode.clone(),

            show_search: state.ui.show_search,
+ 
            show_help: state.ui.show_help,

        }

    }

}
- 
pub struct ListPage {
+ 
pub struct ListPage<'a> {

    /// Action sender

    pub action_tx: UnboundedSender<Action>,

    /// State mapped props
@@ -53,11 +56,13 @@ pub struct ListPage {
    issues: Issues,

    /// Search widget

    search: Search,
+ 
    /// Help widget
+ 
    help: Help<'a>,

    /// Shortcut widget

    shortcuts: Shortcuts<Action>,

}
- 
impl Widget<State, Action> for ListPage {
+ 
impl<'a> Widget<State, Action> for ListPage<'a> {

    fn new(state: &State, action_tx: UnboundedSender<Action>) -> Self

    where

        Self: Sized,
@@ -67,6 +72,7 @@ impl Widget<State, Action> for ListPage {
            props: ListPageProps::from(state),

            issues: Issues::new(state, action_tx.clone()),

            search: Search::new(state, action_tx.clone()),
+ 
            help: Help::new(state, action_tx.clone()),

            shortcuts: Shortcuts::new(state, action_tx.clone()),

        }

        .move_with_state(state)
@@ -79,6 +85,7 @@ impl Widget<State, Action> for ListPage {
        ListPage {

            issues: self.issues.move_with_state(state),

            shortcuts: self.shortcuts.move_with_state(state),
+ 
            help: self.help.move_with_state(state),

            props: ListPageProps::from(state),

            ..self

        }
@@ -91,6 +98,8 @@ impl Widget<State, Action> for ListPage {
    fn handle_key_event(&mut self, key: termion::event::Key) {

        if self.props.show_search {

            <Search as Widget<State, Action>>::handle_key_event(&mut self.search, key)
+ 
        } else if self.props.show_help {
+ 
            <Help as Widget<State, Action>>::handle_key_event(&mut self.help, key)

        } else {

            match key {

                Key::Esc | Key::Ctrl('c') => {
@@ -125,6 +134,9 @@ impl Widget<State, Action> for ListPage {
                Key::Char('/') => {

                    let _ = self.action_tx.send(Action::OpenSearch);

                }
+ 
                Key::Char('?') => {
+ 
                    let _ = self.action_tx.send(Action::OpenHelp);
+ 
                }

                _ => {

                    <Issues as Widget<State, Action>>::handle_key_event(&mut self.issues, key);

                }
@@ -133,16 +145,18 @@ impl Widget<State, Action> for ListPage {
    }

}
- 
impl Render<()> for ListPage {
+ 
impl<'a> Render<()> for ListPage<'a> {

    fn render<B: Backend>(&self, frame: &mut ratatui::Frame, _area: Rect, _props: ()) {

        let area = frame.size();

        let layout = tui::flux::ui::layout::default_page(area, 0u16, 1u16);



        let shortcuts = if self.props.show_search {

            vec![
- 
                Shortcut::new("esc", "back"),
- 
                Shortcut::new("enter", "search"),
+ 
                Shortcut::new("esc", "cancel"),
+ 
                Shortcut::new("enter", "apply"),

            ]
+ 
        } else if self.props.show_help {
+ 
            vec![Shortcut::new("?", "close")]

        } else {

            match self.props.mode {

                Mode::Id => vec![
@@ -153,6 +167,7 @@ impl Render<()> for ListPage {
                    Shortcut::new("enter", "show"),

                    Shortcut::new("e", "edit"),

                    Shortcut::new("/", "search"),
+ 
                    Shortcut::new("?", "help"),

                ],

            }

        };
@@ -164,6 +179,8 @@ impl Render<()> for ListPage {
            self.issues.render::<B>(frame, component_layout[0], ());

            self.search

                .render::<B>(frame, component_layout[1], SearchProps {});
+ 
        } else if self.props.show_help {
+ 
            self.help.render::<B>(frame, layout.component, ());

        } else {

            self.issues.render::<B>(frame, layout.component, ());

        }
@@ -589,3 +606,278 @@ impl Render<SearchProps> for Search {
        );

    }

}
+
+ 
pub struct HelpProps<'a> {
+ 
    content: Text<'a>,
+ 
    focus: bool,
+ 
    page_size: usize,
+ 
}
+
+ 
impl<'a> From<&State> for HelpProps<'a> {
+ 
    fn from(state: &State) -> Self {
+ 
        let content = Text::from(
+ 
            [
+ 
                Line::from(Span::raw("Generic keybindings").cyan()),
+ 
                Line::raw(""),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "↑,k")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("move cursor one line up").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "↓,j")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("move cursor one line down").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "PageUp")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("move cursor one page up").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "PageDown")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("move cursor one page down").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "Home")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("move cursor to the first line").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "End")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("move cursor to the last line").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::raw(""),
+ 
                Line::from(Span::raw("Specific keybindings").cyan()),
+ 
                Line::raw(""),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "enter")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("Select issue (if --mode id)").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "enter")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("Show issue").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "e")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("Edit patch").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "/")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("Search").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "?")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("Show help").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "Esc")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("Quit / cancel").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::raw(""),
+ 
                Line::from(Span::raw("Searching").cyan()),
+ 
                Line::raw(""),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "Pattern")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("is:<state> | is:authored | is:assigned | authors:[<did>, ...] | assignees:[<did>, ...] | <search>")
+ 
                            .gray()
+ 
                            .dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
                Line::from(
+ 
                    [
+ 
                        Span::raw(format!("{key:>10}", key = "Example")).gray(),
+ 
                        Span::raw(" "),
+ 
                        Span::raw("is:solved is:authored alias").gray().dim(),
+ 
                    ]
+ 
                    .to_vec(),
+ 
                ),
+ 
            ]
+ 
            .to_vec(),
+ 
        );
+
+ 
        Self {
+ 
            content,
+ 
            focus: false,
+ 
            page_size: state.ui.page_size,
+ 
        }
+ 
    }
+ 
}
+
+ 
pub struct Help<'a> {
+ 
    /// Send messages
+ 
    pub action_tx: UnboundedSender<Action>,
+ 
    /// This widget's render properties
+ 
    pub props: HelpProps<'a>,
+ 
    /// Container header
+ 
    header: Header<Action>,
+ 
    /// Content widget
+ 
    content: Paragraph<Action>,
+ 
    /// Container footer
+ 
    footer: Footer<Action>,
+ 
}
+
+ 
impl<'a> Widget<State, Action> for Help<'a> {
+ 
    fn new(state: &State, action_tx: UnboundedSender<Action>) -> Self
+ 
    where
+ 
        Self: Sized,
+ 
    {
+ 
        Self {
+ 
            action_tx: action_tx.clone(),
+ 
            props: HelpProps::from(state),
+ 
            header: Header::new(state, action_tx.clone()),
+ 
            content: Paragraph::new(state, action_tx.clone()),
+ 
            footer: Footer::new(state, action_tx),
+ 
        }
+ 
        .move_with_state(state)
+ 
    }
+
+ 
    fn move_with_state(self, state: &State) -> Self
+ 
    where
+ 
        Self: Sized,
+ 
    {
+ 
        Self {
+ 
            props: HelpProps::from(state),
+ 
            header: self.header.move_with_state(state),
+ 
            content: self.content.move_with_state(state),
+ 
            footer: self.footer.move_with_state(state),
+ 
            ..self
+ 
        }
+ 
    }
+
+ 
    fn name(&self) -> &str {
+ 
        "help"
+ 
    }
+
+ 
    fn handle_key_event(&mut self, key: termion::event::Key) {
+ 
        let len = self.props.content.lines.len() + 1;
+ 
        let page_size = self.props.page_size;
+ 
        match key {
+ 
            Key::Esc => {
+ 
                let _ = self.action_tx.send(Action::Exit { selection: None });
+ 
            }
+ 
            Key::Char('?') => {
+ 
                let _ = self.action_tx.send(Action::CloseHelp);
+ 
            }
+ 
            Key::Up | Key::Char('k') => {
+ 
                self.content.prev(len, page_size);
+ 
            }
+ 
            Key::Down | Key::Char('j') => {
+ 
                self.content.next(len, page_size);
+ 
            }
+ 
            Key::PageUp => {
+ 
                self.content.prev_page(len, page_size);
+ 
            }
+ 
            Key::PageDown => {
+ 
                self.content.next_page(len, page_size);
+ 
            }
+ 
            Key::Home => {
+ 
                self.content.begin(len, page_size);
+ 
            }
+ 
            Key::End => {
+ 
                self.content.end(len, page_size);
+ 
            }
+ 
            _ => {}
+ 
        }
+ 
    }
+ 
}
+
+ 
impl<'a> Render<()> for Help<'a> {
+ 
    fn render<B: Backend>(&self, frame: &mut ratatui::Frame, area: Rect, _props: ()) {
+ 
        let [header_area, content_area, footer_area] = Layout::vertical([
+ 
            Constraint::Length(3),
+ 
            Constraint::Min(1),
+ 
            Constraint::Length(3),
+ 
        ])
+ 
        .areas(area);
+
+ 
        self.header.render::<B>(
+ 
            frame,
+ 
            header_area,
+ 
            HeaderProps {
+ 
                cells: [String::from(" Help ").into()],
+ 
                widths: [Constraint::Fill(1)],
+ 
                focus: self.props.focus,
+ 
                cutoff: usize::MIN,
+ 
                cutoff_after: usize::MAX,
+ 
            },
+ 
        );
+
+ 
        self.content.render::<B>(
+ 
            frame,
+ 
            content_area,
+ 
            ParagraphProps {
+ 
                content: self.props.content.clone(),
+ 
                focus: self.props.focus,
+ 
                has_footer: true,
+ 
                has_header: true,
+ 
            },
+ 
        );
+
+ 
        let progress = span::default(format!("{}%", self.content.progress())).dim();
+
+ 
        self.footer.render::<B>(
+ 
            frame,
+ 
            footer_area,
+ 
            FooterProps {
+ 
                cells: [String::new().into(), progress.clone().into()],
+ 
                widths: [Constraint::Fill(1), Constraint::Min(4)],
+ 
                focus: self.props.focus,
+ 
                cutoff: usize::MAX,
+ 
                cutoff_after: usize::MAX,
+ 
            },
+ 
        );
+
+ 
        let page_size = content_area.height as usize;
+ 
        if page_size != self.props.page_size {
+ 
            let _ = self.action_tx.send(Action::PageSize(page_size));
+ 
        }
+ 
    }
+ 
}