Implemented the final widget for confirmation prompts!

This commit is contained in:
2024-02-14 14:13:00 -07:00
parent cf14483338
commit 32a8a4de76
14 changed files with 450 additions and 404 deletions
+1
View File
@@ -10,6 +10,7 @@ use ratatui::widgets::{Paragraph, Widget};
#[path = "checkbox_tests.rs"]
mod checkbox_tests;
#[derive(PartialEq, Debug, Copy, Clone)]
pub struct Checkbox<'a> {
label: &'a str,
is_checked: bool,
+154
View File
@@ -0,0 +1,154 @@
use crate::ui::styles::ManagarrStyle;
use crate::ui::utils::{layout_paragraph_borderless, title_block_centered};
use crate::ui::widgets::button::Button;
use crate::ui::widgets::checkbox::Checkbox;
use ratatui::buffer::Buffer;
use ratatui::layout::{Constraint, Flex, Layout, Rect};
use ratatui::widgets::{Paragraph, Widget};
use std::iter;
#[cfg(test)]
#[path = "confirmation_prompt_tests.rs"]
mod confirmation_prompt_tests;
pub struct ConfirmationPrompt<'a> {
title: &'a str,
prompt: &'a str,
content: Option<Paragraph<'a>>,
checkboxes: Option<Vec<Checkbox<'a>>>,
yes_no_value: bool,
yes_no_highlighted: bool,
}
impl<'a> ConfirmationPrompt<'a> {
pub fn new() -> Self {
Self {
title: "",
prompt: "",
content: None,
checkboxes: None,
yes_no_value: false,
yes_no_highlighted: true,
}
}
pub fn title(mut self, title: &'a str) -> Self {
self.title = title;
self
}
pub fn prompt(mut self, prompt: &'a str) -> Self {
self.prompt = prompt;
self
}
pub fn content(mut self, content: Paragraph<'a>) -> Self {
self.content = Some(content);
self
}
pub fn checkboxes(mut self, checkboxes: Vec<Checkbox<'a>>) -> Self {
self.checkboxes = Some(checkboxes);
self
}
pub fn yes_no_value(mut self, yes_highlighted: bool) -> Self {
self.yes_no_value = yes_highlighted;
self
}
pub fn yes_no_highlighted(mut self, yes_highlighted: bool) -> Self {
self.yes_no_highlighted = yes_highlighted;
self
}
fn render_confirmation_prompt_with_checkboxes(self, area: Rect, buf: &mut Buffer) {
title_block_centered(self.title).render(area, buf);
if let Some(checkboxes) = self.checkboxes {
let mut constraints = vec![
Constraint::Length(4),
Constraint::Fill(0),
Constraint::Length(3),
];
constraints.splice(
1..1,
iter::repeat(Constraint::Length(3)).take(checkboxes.len()),
);
let chunks = Layout::vertical(constraints).margin(1).split(area);
let [yes_area, no_area] =
Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)])
.areas(chunks[checkboxes.len() + 2]);
layout_paragraph_borderless(self.prompt).render(chunks[0], buf);
checkboxes
.into_iter()
.enumerate()
.for_each(|(i, checkbox)| {
checkbox.render(chunks[i + 1], buf);
});
Button::new()
.title("Yes")
.selected(self.yes_no_value && self.yes_no_highlighted)
.render(yes_area, buf);
Button::new()
.title("No")
.selected(!self.yes_no_value && self.yes_no_highlighted)
.render(no_area, buf);
}
}
fn render_confirmation_prompt(self, area: Rect, buf: &mut Buffer) {
title_block_centered(self.title).render(area, buf);
let [prompt_area, buttons_area] = if let Some(content_paragraph) = self.content {
let [prompt_area, content_area, _, buttons_area] = Layout::vertical([
Constraint::Length(4),
Constraint::Length(7),
Constraint::Fill(0),
Constraint::Length(3),
])
.margin(1)
.areas(area);
content_paragraph.render(content_area, buf);
[prompt_area, buttons_area]
} else {
let [prompt_area, buttons_area] =
Layout::vertical([Constraint::Percentage(72), Constraint::Length(3)])
.margin(1)
.flex(Flex::SpaceBetween)
.areas(area);
[prompt_area, buttons_area]
};
layout_paragraph_borderless(self.prompt).render(prompt_area, buf);
let [yes_area, no_area] =
Layout::horizontal([Constraint::Percentage(50), Constraint::Percentage(50)])
.areas(buttons_area);
Button::new()
.title("Yes")
.selected(self.yes_no_value)
.render(yes_area, buf);
Button::new()
.title("No")
.selected(!self.yes_no_value)
.render(no_area, buf);
}
}
impl<'a> Widget for ConfirmationPrompt<'a> {
fn render(self, area: Rect, buf: &mut Buffer) {
if self.checkboxes.is_some() {
self.render_confirmation_prompt_with_checkboxes(area, buf);
} else {
self.render_confirmation_prompt(area, buf);
}
}
}
@@ -0,0 +1,93 @@
#[cfg(test)]
mod tests {
use crate::ui::widgets::checkbox::Checkbox;
use crate::ui::widgets::confirmation_prompt::ConfirmationPrompt;
use pretty_assertions::{assert_eq, assert_str_eq};
use ratatui::widgets::Paragraph;
#[test]
fn test_confirmation_prompt_new() {
let confirmation_prompt = ConfirmationPrompt::new();
assert_str_eq!(confirmation_prompt.title, "");
assert_str_eq!(confirmation_prompt.prompt, "");
assert_eq!(confirmation_prompt.content, None);
assert_eq!(confirmation_prompt.checkboxes, None);
assert!(!confirmation_prompt.yes_no_value);
assert!(confirmation_prompt.yes_no_highlighted);
}
#[test]
fn test_confirmation_prompt_title() {
let confirmation_prompt = ConfirmationPrompt::new().title("title");
assert_str_eq!(confirmation_prompt.title, "title");
assert_str_eq!(confirmation_prompt.prompt, "");
assert_eq!(confirmation_prompt.content, None);
assert_eq!(confirmation_prompt.checkboxes, None);
assert!(!confirmation_prompt.yes_no_value);
assert!(confirmation_prompt.yes_no_highlighted);
}
#[test]
fn test_confirmation_prompt_prompt() {
let confirmation_prompt = ConfirmationPrompt::new().prompt("prompt");
assert_str_eq!(confirmation_prompt.prompt, "prompt");
assert_str_eq!(confirmation_prompt.title, "");
assert_eq!(confirmation_prompt.content, None);
assert_eq!(confirmation_prompt.checkboxes, None);
assert!(!confirmation_prompt.yes_no_value);
assert!(confirmation_prompt.yes_no_highlighted);
}
#[test]
fn test_confirmation_prompt_content() {
let content = Paragraph::new("content");
let confirmation_prompt = ConfirmationPrompt::new().content(content.clone());
assert_eq!(confirmation_prompt.content, Some(content));
assert_str_eq!(confirmation_prompt.title, "");
assert_str_eq!(confirmation_prompt.prompt, "");
assert_eq!(confirmation_prompt.checkboxes, None);
assert!(!confirmation_prompt.yes_no_value);
assert!(confirmation_prompt.yes_no_highlighted);
}
#[test]
fn test_confirmation_prompt_checkboxes() {
let checkboxes = vec![Checkbox::new("test").highlighted(true).checked(false)];
let confirmation_prompt = ConfirmationPrompt::new().checkboxes(checkboxes.clone());
assert_eq!(confirmation_prompt.checkboxes, Some(checkboxes));
assert_str_eq!(confirmation_prompt.title, "");
assert_str_eq!(confirmation_prompt.prompt, "");
assert_eq!(confirmation_prompt.content, None);
assert!(!confirmation_prompt.yes_no_value);
assert!(confirmation_prompt.yes_no_highlighted);
}
#[test]
fn test_confirmation_prompt_yes_no_value() {
let confirmation_prompt = ConfirmationPrompt::new().yes_no_value(true);
assert!(confirmation_prompt.yes_no_value);
assert_str_eq!(confirmation_prompt.title, "");
assert_str_eq!(confirmation_prompt.prompt, "");
assert_eq!(confirmation_prompt.content, None);
assert_eq!(confirmation_prompt.checkboxes, None);
assert!(confirmation_prompt.yes_no_highlighted);
}
#[test]
fn test_confirmation_prompt_yes_no_highlighted() {
let confirmation_prompt = ConfirmationPrompt::new().yes_no_highlighted(false);
assert!(!confirmation_prompt.yes_no_highlighted);
assert_str_eq!(confirmation_prompt.title, "");
assert_str_eq!(confirmation_prompt.prompt, "");
assert_eq!(confirmation_prompt.content, None);
assert_eq!(confirmation_prompt.checkboxes, None);
assert!(!confirmation_prompt.yes_no_value);
}
}
+2 -2
View File
@@ -42,7 +42,7 @@ mod tests {
let managarr_table =
ManagarrTable::new(Some(&mut stateful_table), |&s| Row::new(vec![Cell::new(s)]))
.headers(headers.clone());
.headers(headers);
let row_mapper = managarr_table.row_mapper;
assert_eq!(managarr_table.table_headers, headers);
@@ -67,7 +67,7 @@ mod tests {
let managarr_table =
ManagarrTable::new(Some(&mut stateful_table), |&s| Row::new(vec![Cell::new(s)]))
.constraints(constraints.clone());
.constraints(constraints);
let row_mapper = managarr_table.row_mapper;
assert_eq!(managarr_table.constraints, constraints);
+1
View File
@@ -1,5 +1,6 @@
pub(super) mod button;
pub(super) mod checkbox;
pub(super) mod confirmation_prompt;
pub(super) mod error_message;
pub(super) mod input_box;
pub(super) mod loading_block;