feat: implement TreeState arrow key methods

examples/example.rs

@@ -91,11 +91,11 @@ fn run_app<B: Backend>(terminal: &mut Terminal<B>, mut app: App) -> io::Result<(
         if let Event::Key(key) = event::read()? {
             match key.code {
                 KeyCode::Char('q') => return Ok(()),
-                KeyCode::Left => app.tree.close(),
+                KeyCode::Left => app.tree.left(),
-                KeyCode::Right => app.tree.open(),
+                KeyCode::Right => app.tree.right(),
                 KeyCode::Char('\n') => app.tree.toggle(),
-                KeyCode::Down => app.tree.next(),
+                KeyCode::Down => app.tree.down(),
-                KeyCode::Up => app.tree.previous(),
+                KeyCode::Up => app.tree.up(),
                 _ => {}
             }
         }

examples/util/mod.rs

@@ -1,4 +1,4 @@
-use tui_tree_widget::{flatten, get_identifier_without_leaf, TreeItem, TreeState};
+use tui_tree_widget::{TreeItem, TreeState};
 
 pub struct StatefulTree<'a> {
     pub state: TreeState,
@@ -21,42 +21,20 @@ impl<'a> StatefulTree<'a> {
         }
     }
 
-    fn move_up_down(&mut self, down: bool) {
+    pub fn down(&mut self) {
-        let visible = flatten(&self.state.get_all_opened(), &self.items);
+        self.state.key_down(&self.items);
-        let current_identifier = self.state.selected();
-        let current_index = visible
-            .iter()
-            .position(|o| o.identifier == current_identifier);
-        let new_index = current_index.map_or(0, |current_index| {
-            if down {
-                current_index.saturating_add(1)
-            } else {
-                current_index.saturating_sub(1)
-            }
-            .min(visible.len() - 1)
-        });
-        let new_identifier = visible.get(new_index).unwrap().identifier.clone();
-        self.state.select(new_identifier);
     }
 
-    pub fn next(&mut self) {
+    pub fn up(&mut self) {
-        self.move_up_down(true);
+        self.state.key_up(&self.items);
     }
 
-    pub fn previous(&mut self) {
+    pub fn left(&mut self) {
-        self.move_up_down(false);
+        self.state.key_left();
     }
 
-    pub fn close(&mut self) {
+    pub fn right(&mut self) {
-        let selected = self.state.selected();
+        self.state.key_right();
-        if !self.state.close(&selected) {
-            let (head, _) = get_identifier_without_leaf(&selected);
-            self.state.select(head);
-        }
-    }
-
-    pub fn open(&mut self) {
-        self.state.open(self.state.selected());
     }
 
     pub fn toggle(&mut self) {

src/lib.rs

@@ -85,6 +85,52 @@ impl TreeState {
     pub fn close_all(&mut self) {
         self.opened.clear();
     }
+
+    /// Handles the up arrow key.
+    /// Moves up in the current depth or to its parent.
+    pub fn key_up(&mut self, items: &[TreeItem]) {
+        let visible = flatten(&self.get_all_opened(), items);
+        let current_identifier = self.selected();
+        let current_index = visible
+            .iter()
+            .position(|o| o.identifier == current_identifier);
+        let new_index = current_index.map_or(0, |current_index| {
+            current_index.saturating_sub(1).min(visible.len() - 1)
+        });
+        let new_identifier = visible[new_index].identifier.clone();
+        self.select(new_identifier);
+    }
+
+    /// Handles the down arrow key.
+    /// Moves down in the current depth or into a child node.
+    pub fn key_down(&mut self, items: &[TreeItem]) {
+        let visible = flatten(&self.get_all_opened(), items);
+        let current_identifier = self.selected();
+        let current_index = visible
+            .iter()
+            .position(|o| o.identifier == current_identifier);
+        let new_index = current_index.map_or(0, |current_index| {
+            current_index.saturating_add(1).min(visible.len() - 1)
+        });
+        let new_identifier = visible[new_index].identifier.clone();
+        self.select(new_identifier);
+    }
+
+    /// Handles the left arrow key.
+    /// Closes the currently selected or moves to its parent.
+    pub fn key_left(&mut self) {
+        let selected = self.selected();
+        if !self.close(&selected) {
+            let (head, _) = get_identifier_without_leaf(&selected);
+            self.select(head);
+        }
+    }
+
+    /// Handles the right arrow key.
+    /// Openes the currently selected.
+    pub fn key_right(&mut self) {
+        self.open(self.selected());
+    }
 }
 
 #[derive(Debug, Clone)]