Merge pull request #66 from ynqa/render-on-resize

fix: render on resize

Author: ynqa

promkit-core/src/render.rs

@@ -56,6 +56,7 @@ impl<K: Ord + Send + 'static> Renderer<K> {
         self
     }
 
+    // TODO: Implement diff rendering
     pub async fn render(&self) -> anyhow::Result<()> {
         let panes: Vec<Pane> = self
             .panes

promkit/src/lib.rs

@@ -14,14 +14,11 @@ use futures::StreamExt;
 use scopeguard::defer;
 use tokio::sync::Mutex;
 
-use core::{
-    crossterm::{
-        cursor,
-        event::{self, Event, EventStream},
-        execute,
-        terminal::{disable_raw_mode, enable_raw_mode},
-    },
-    render::SharedRenderer,
+use core::crossterm::{
+    cursor,
+    event::{self, Event, EventStream},
+    execute,
+    terminal::{disable_raw_mode, enable_raw_mode},
 };
 
 /// Singleton for EventStream. If a new EventStream is created for each Prompt::run,
@@ -49,12 +46,6 @@ pub enum Signal {
 /// are evaluated, and how the final result is produced.
 #[async_trait::async_trait]
 pub trait Prompt {
-    /// The type of index used to identify different components in the prompt.
-    type Index: Ord + Send + Sync + 'static;
-
-    /// Returns a shared renderer for the prompt.
-    fn renderer(&self) -> SharedRenderer<Self::Index>;
-
     /// Initializes the handler, preparing it for use.
     /// This method is called before the prompt starts running.
     ///

promkit/src/preset.rs

@@ -37,3 +37,14 @@ pub mod form;
 #[cfg(feature = "text")]
 #[cfg_attr(docsrs, doc(cfg(feature = "text")))]
 pub mod text;
+
+use std::{future::Future, pin::Pin};
+
+use crate::{core::crossterm::event::Event, Signal};
+
+/// Type alias for the evaluator function used in the prompt.
+pub type Evaluator<T> =
+    for<'a> fn(
+        event: &'a Event,
+        ctx: &'a mut T,
+    ) -> Pin<Box<dyn Future<Output = Result<Signal, anyhow::Error>> + Send + 'a>>;

promkit/src/preset/checkbox.rs

@@ -12,6 +12,7 @@ use crate::{
         render::{Renderer, SharedRenderer},
         PaneFactory,
     },
+    preset::Evaluator,
     widgets::{
         checkbox,
         text::{self, Text},
@@ -28,16 +29,13 @@ pub enum Index {
     Checkbox = 1,
 }
 
-/// Type alias for the evaluator function used in the checkbox preset.
-pub type Evaluator = fn(event: &Event, ctx: &mut Checkbox) -> anyhow::Result<Signal>;
-
 /// Represents a checkbox component for creating
 /// and managing a list of selectable options.
 pub struct Checkbox {
     /// Shared renderer for the prompt, allowing for rendering of UI components.
     pub renderer: Option<SharedRenderer<Index>>,
     /// Function to evaluate the input events and update the state of the prompt.
-    pub evaluator_fn: Evaluator,
+    pub evaluator: Evaluator<Self>,
     /// State for the title displayed above the checkbox list.
     pub title: text::State,
     /// State for the checkbox list itself.
@@ -46,12 +44,6 @@ pub struct Checkbox {
 
 #[async_trait::async_trait]
 impl crate::Prompt for Checkbox {
-    type Index = Index;
-
-    fn renderer(&self) -> SharedRenderer<Self::Index> {
-        self.renderer.clone().unwrap()
-    }
-
     async fn initialize(&mut self) -> anyhow::Result<()> {
         let size = crossterm::terminal::size()?;
         self.renderer = Some(SharedRenderer::new(
@@ -68,17 +60,9 @@ impl crate::Prompt for Checkbox {
     }
 
     async fn evaluate(&mut self, event: &Event) -> anyhow::Result<Signal> {
-        let ret = (self.evaluator_fn)(event, self);
+        let ret = (self.evaluator)(event, self).await;
         let size = crossterm::terminal::size()?;
-        self.renderer
-            .as_ref()
-            .unwrap()
-            .update([
-                (Index::Title, self.title.create_pane(size.0, size.1)),
-                (Index::Checkbox, self.checkbox.create_pane(size.0, size.1)),
-            ])
-            .render()
-            .await?;
+        self.render(size.0, size.1).await?;
         ret
     }
 
@@ -96,11 +80,10 @@ impl crate::Prompt for Checkbox {
 }
 
 impl Checkbox {
-    /// Creates a new `Checkbox` instance with the provided items.
-    pub fn new<T: Display, I: IntoIterator<Item = T>>(items: I) -> Self {
+    fn new_with_checkbox(checkbox: checkbox::Checkbox) -> Self {
         Self {
             renderer: None,
-            evaluator_fn: evaluate::default,
+            evaluator: |event, ctx| Box::pin(evaluate::default(event, ctx)),
             title: text::State {
                 style: ContentStyle {
                     attributes: Attributes::from(Attribute::Bold),
@@ -109,7 +92,7 @@ impl Checkbox {
                 ..Default::default()
             },
             checkbox: checkbox::State {
-                checkbox: checkbox::Checkbox::from_displayable(items),
+                checkbox,
                 cursor: String::from("❯ "),
                 active_mark: '☒',
                 inactive_mark: '☐',
@@ -123,31 +106,14 @@ impl Checkbox {
         }
     }
 
+    /// Creates a new `Checkbox` instance with the provided items.
+    pub fn new<T: Display, I: IntoIterator<Item = T>>(items: I) -> Self {
+        Self::new_with_checkbox(checkbox::Checkbox::from_displayable(items))
+    }
+
     /// Creates a new `Checkbox` instance with the provided items and their checked states.
     pub fn new_with_checked<T: Display, I: IntoIterator<Item = (T, bool)>>(items: I) -> Self {
-        Self {
-            renderer: None,
-            evaluator_fn: evaluate::default,
-            title: text::State {
-                style: ContentStyle {
-                    attributes: Attributes::from(Attribute::Bold),
-                    ..Default::default()
-                },
-                ..Default::default()
-            },
-            checkbox: checkbox::State {
-                checkbox: checkbox::Checkbox::new_with_checked(items),
-                cursor: String::from("❯ "),
-                active_mark: '☒',
-                inactive_mark: '☐',
-                active_item_style: ContentStyle {
-                    foreground_color: Some(Color::DarkCyan),
-                    ..Default::default()
-                },
-                inactive_item_style: ContentStyle::default(),
-                lines: Default::default(),
-            },
-        }
+        Self::new_with_checkbox(checkbox::Checkbox::new_with_checked(items))
     }
 
     /// Sets the title text displayed above the checkbox list.
@@ -193,8 +159,24 @@ impl Checkbox {
     }
 
     /// Sets the evaluator function for handling input events.
-    pub fn evaluator(mut self, evaluator: Evaluator) -> Self {
-        self.evaluator_fn = evaluator;
+    pub fn evaluator(mut self, evaluator: Evaluator<Self>) -> Self {
+        self.evaluator = evaluator;
         self
     }
+
+    /// Render the prompt with the specified width and height.
+    async fn render(&mut self, width: u16, height: u16) -> anyhow::Result<()> {
+        match self.renderer.as_ref() {
+            Some(renderer) => {
+                renderer
+                    .update([
+                        (Index::Title, self.title.create_pane(width, height)),
+                        (Index::Checkbox, self.checkbox.create_pane(width, height)),
+                    ])
+                    .render()
+                    .await
+            }
+            None => Err(anyhow::anyhow!("Renderer not initialized")),
+        }
+    }
 }

promkit/src/preset/checkbox/evaluate.rs

@@ -16,8 +16,14 @@ use crate::{
 /// | <kbd>↑</kbd>           | Move the selection up
 /// | <kbd>↓</kbd>           | Move the selection down
 /// | <kbd>Space</kbd>       | Toggle the checkbox state for the current item
-pub fn default(event: &Event, ctx: &mut Checkbox) -> anyhow::Result<Signal> {
+pub async fn default(event: &Event, ctx: &mut Checkbox) -> anyhow::Result<Signal> {
     match event {
+        // Render for refreshing prompt on resize.
+        Event::Resize(width, height) => {
+            ctx.render(*width, *height).await?;
+        }
+
+        // Quit
         Event::Key(KeyEvent {
             code: KeyCode::Enter,
             modifiers: KeyModifiers::NONE,

promkit/src/preset/form.rs

@@ -10,15 +10,13 @@ use crate::{
         render::{Renderer, SharedRenderer},
         PaneFactory,
     },
+    preset::Evaluator,
     widgets::{cursor::Cursor, text_editor},
     Signal,
 };
 
 mod evaluate;
 
-/// Represents the indices of various components in the form preset.
-pub type Evaluator = fn(event: &Event, ctx: &mut Form) -> anyhow::Result<Signal>;
-
 /// Represents the visual styles for different states of text editor components.
 pub struct Style {
     /// Style for the prefix of the text editor.
@@ -34,7 +32,7 @@ pub struct Form {
     /// Shared renderer for the prompt, allowing for rendering of UI components.
     pub renderer: Option<SharedRenderer<usize>>,
     /// Function to evaluate the input events and update the state of the prompt.
-    pub evaluator_fn: Evaluator,
+    pub evaluator: Evaluator<Self>,
     /// State for the multiple text editor components.
     pub readlines: Cursor<Vec<text_editor::State>>,
     /// Default styles applied to text editors.
@@ -45,12 +43,6 @@ pub struct Form {
 
 #[async_trait::async_trait]
 impl crate::Prompt for Form {
-    type Index = usize;
-
-    fn renderer(&self) -> SharedRenderer<Self::Index> {
-        self.renderer.clone().unwrap()
-    }
-
     async fn initialize(&mut self) -> anyhow::Result<()> {
         // Update styles based on the current position.
         self.overwrite_styles();
@@ -71,24 +63,13 @@ impl crate::Prompt for Form {
     }
 
     async fn evaluate(&mut self, event: &Event) -> anyhow::Result<Signal> {
-        let ret = (self.evaluator_fn)(event, self);
+        let ret = (self.evaluator)(event, self).await;
 
         // Update the styles based on the current position.
         self.overwrite_styles();
 
         let size = crossterm::terminal::size()?;
-        self.renderer
-            .as_ref()
-            .unwrap()
-            .update(
-                self.readlines
-                    .contents()
-                    .iter()
-                    .enumerate()
-                    .map(|(i, state)| (i, state.create_pane(size.0, size.1))),
-            )
-            .render()
-            .await?;
+        self.render(size.0, size.1).await?;
         ret
     }
 
@@ -142,13 +123,32 @@ impl Form {
 
         Self {
             renderer: None,
-            evaluator_fn: evaluate::default,
+            evaluator: |event, ctx| Box::pin(evaluate::default(event, ctx)),
             readlines: Cursor::new(readlines, 0, false),
             focus_styles,
             unfocus_styles,
         }
     }
 
+    /// Render the prompt with the specified width and height.
+    async fn render(&mut self, width: u16, height: u16) -> anyhow::Result<()> {
+        match self.renderer.as_ref() {
+            Some(renderer) => {
+                renderer
+                    .update(
+                        self.readlines
+                            .contents()
+                            .iter()
+                            .enumerate()
+                            .map(|(i, state)| (i, state.create_pane(width, height))),
+                    )
+                    .render()
+                    .await
+            }
+            None => Err(anyhow::anyhow!("Renderer not initialized")),
+        }
+    }
+
     /// Updates the styles of text editor states based on their active or inactive status.
     fn overwrite_styles(&mut self) {
         let current_position = self.readlines.position();

promkit/src/preset/form/evaluate.rs

@@ -6,10 +6,17 @@ use crate::{
     Signal,
 };
 
-pub fn default(event: &Event, ctx: &mut Form) -> anyhow::Result<Signal> {
+/// Default event handler for the `Form` prompt.
+pub async fn default(event: &Event, ctx: &mut Form) -> anyhow::Result<Signal> {
     let current_position = ctx.readlines.position();
 
     match event {
+        // Render for refreshing prompt on resize.
+        Event::Resize(width, height) => {
+            ctx.render(*width, *height).await?;
+        }
+
+        // Quit
         Event::Key(KeyEvent {
             code: KeyCode::Enter,
             modifiers: KeyModifiers::NONE,