envision 0.15.1

A ratatui framework for collaborative TUI development with headless testing support
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
//! A hierarchical tree view component.
//!
//! [`Tree<T>`] displays data in a hierarchical structure with expandable/collapsible
//! nodes. It supports keyboard navigation and single selection. State is stored in
//! [`TreeState<T>`], updated via [`TreeMessage`], and produces [`TreeOutput`].
//! Tree data is provided via [`TreeNode<T>`].
//!
//!
//! See also [`Accordion`](super::Accordion) for a simpler collapsible panel list.
//!
//! # Example
//!
//! ```rust
//! use envision::component::{Tree, TreeMessage, TreeState, TreeNode, Component};
//!
//! // Create a tree with nodes
//! let mut root = TreeNode::new("Root", "root-data");
//! root.add_child(TreeNode::new("Child 1", "child1"));
//! root.add_child(TreeNode::new("Child 2", "child2"));
//!
//! let mut state = TreeState::new(vec![root]);
//!
//! // Navigate and expand
//! Tree::update(&mut state, TreeMessage::Expand);
//! Tree::update(&mut state, TreeMessage::Down);
//! ```

use super::{Component, EventContext, RenderContext};
use crate::input::{Event, Key};
use crate::scroll::ScrollState;

mod render;
mod traversal;

/// A node in the tree hierarchy.
#[derive(Clone, Debug)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct TreeNode<T> {
    /// Display label for the node.
    label: String,
    /// Custom data associated with this node.
    data: T,
    /// Child nodes.
    children: Vec<TreeNode<T>>,
    /// Whether this node is expanded (children visible).
    expanded: bool,
}

impl<T: PartialEq> PartialEq for TreeNode<T> {
    fn eq(&self, other: &Self) -> bool {
        self.label == other.label
            && self.data == other.data
            && self.children == other.children
            && self.expanded == other.expanded
    }
}

impl<T: Clone> TreeNode<T> {
    /// Creates a new tree node with a label and data.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let node = TreeNode::new("Documents", "/home/user/docs");
    /// assert_eq!(node.label(), "Documents");
    /// assert_eq!(node.data(), &"/home/user/docs");
    /// ```
    pub fn new(label: impl Into<String>, data: T) -> Self {
        Self {
            label: label.into(),
            data,
            children: Vec::new(),
            expanded: false,
        }
    }

    /// Creates a new node that starts expanded.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let node: TreeNode<()> = TreeNode::new_expanded("Root", ());
    /// assert!(node.is_expanded());
    /// ```
    pub fn new_expanded(label: impl Into<String>, data: T) -> Self {
        Self {
            label: label.into(),
            data,
            children: Vec::new(),
            expanded: true,
        }
    }

    /// Returns the node's label.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let node = TreeNode::new("Documents", ());
    /// assert_eq!(node.label(), "Documents");
    /// ```
    pub fn label(&self) -> &str {
        &self.label
    }

    /// Sets the node's label.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new("Old", ());
    /// node.set_label("New");
    /// assert_eq!(node.label(), "New");
    /// ```
    pub fn set_label(&mut self, label: impl Into<String>) {
        self.label = label.into();
    }

    /// Returns a reference to the node's data.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let node = TreeNode::new("Root", 42u32);
    /// assert_eq!(node.data(), &42u32);
    /// ```
    pub fn data(&self) -> &T {
        &self.data
    }

    /// Returns a mutable reference to the node's data.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new("Root", 0u32);
    /// *node.data_mut() = 99;
    /// assert_eq!(node.data(), &99u32);
    /// ```
    pub fn data_mut(&mut self) -> &mut T {
        &mut self.data
    }

    /// Returns the children of this node.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut parent = TreeNode::new("Parent", ());
    /// parent.add_child(TreeNode::new("Child", ()));
    /// assert_eq!(parent.children().len(), 1);
    /// ```
    pub fn children(&self) -> &[TreeNode<T>] {
        &self.children
    }

    /// Returns a mutable reference to the children.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new("Root", ());
    /// node.children_mut().push(TreeNode::new("Child", ()));
    /// assert_eq!(node.children().len(), 1);
    /// ```
    pub fn children_mut(&mut self) -> &mut Vec<TreeNode<T>> {
        &mut self.children
    }

    /// Adds a child node.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut parent = TreeNode::new("Parent", ());
    /// parent.add_child(TreeNode::new("Child", ()));
    /// assert_eq!(parent.children().len(), 1);
    /// ```
    pub fn add_child(&mut self, child: TreeNode<T>) {
        self.children.push(child);
    }

    /// Returns true if this node has children.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut parent = TreeNode::new("Parent", ());
    /// assert!(!parent.has_children());
    /// parent.add_child(TreeNode::new("Child", ()));
    /// assert!(parent.has_children());
    /// ```
    pub fn has_children(&self) -> bool {
        !self.children.is_empty()
    }

    /// Returns true if this node is expanded.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let node = TreeNode::new("Root", ());
    /// assert!(!node.is_expanded());
    /// ```
    pub fn is_expanded(&self) -> bool {
        self.expanded
    }

    /// Sets the expanded state.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new("Root", ());
    /// node.set_expanded(true);
    /// assert!(node.is_expanded());
    /// ```
    pub fn set_expanded(&mut self, expanded: bool) {
        self.expanded = expanded;
    }

    /// Expands this node.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new("Root", ());
    /// node.expand();
    /// assert!(node.is_expanded());
    /// ```
    pub fn expand(&mut self) {
        self.expanded = true;
    }

    /// Collapses this node.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new_expanded("Root", ());
    /// node.collapse();
    /// assert!(!node.is_expanded());
    /// ```
    pub fn collapse(&mut self) {
        self.expanded = false;
    }

    /// Toggles the expanded state.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeNode;
    ///
    /// let mut node = TreeNode::new("Root", ());
    /// node.toggle();
    /// assert!(node.is_expanded());
    /// node.toggle();
    /// assert!(!node.is_expanded());
    /// ```
    pub fn toggle(&mut self) {
        self.expanded = !self.expanded;
    }
}

/// Messages that can be sent to a Tree component.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TreeMessage {
    /// Move selection down to the next visible node.
    Down,
    /// Move selection up to the previous visible node.
    Up,
    /// Expand the currently selected node.
    Expand,
    /// Collapse the currently selected node.
    Collapse,
    /// Toggle expand/collapse of the currently selected node.
    Toggle,
    /// Select the current node (emit Selected output).
    Select,
    /// Expand all nodes.
    ExpandAll,
    /// Collapse all nodes.
    CollapseAll,
    /// Set the filter text for searching nodes.
    SetFilter(String),
    /// Clear the filter text.
    ClearFilter,
}

/// Output messages from a Tree component.
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum TreeOutput {
    /// A node was selected (activated). Contains the path to the node.
    Selected(Vec<usize>),
    /// A node was expanded. Contains the path to the node.
    Expanded(Vec<usize>),
    /// A node was collapsed. Contains the path to the node.
    Collapsed(Vec<usize>),
    /// The filter text changed.
    FilterChanged(String),
}

/// State for a Tree component.
#[derive(Clone, Debug)]
#[cfg_attr(
    feature = "serialization",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct TreeState<T> {
    /// The root nodes of the tree.
    roots: Vec<TreeNode<T>>,
    /// Index of the currently selected node in the flattened view, or `None` if empty.
    selected_index: Option<usize>,
    /// Current filter text for searching nodes by label.
    filter_text: String,
    /// Scroll state for scrollbar rendering.
    #[cfg_attr(feature = "serialization", serde(skip))]
    scroll: ScrollState,
}

impl<T: Clone + PartialEq> PartialEq for TreeState<T> {
    fn eq(&self, other: &Self) -> bool {
        self.roots == other.roots
            && self.selected_index == other.selected_index
            && self.filter_text == other.filter_text
    }
}

impl<T: Clone> Default for TreeState<T> {
    fn default() -> Self {
        Self::new(Vec::new())
    }
}

impl<T: Clone> TreeState<T> {
    /// Creates a new tree state with the given root nodes.
    ///
    /// If roots are non-empty, the first node is selected.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let roots = vec![
    ///     TreeNode::new("Root 1", 1),
    ///     TreeNode::new("Root 2", 2),
    /// ];
    /// let state = TreeState::new(roots);
    /// assert_eq!(state.roots().len(), 2);
    /// ```
    pub fn new(roots: Vec<TreeNode<T>>) -> Self {
        let selected_index = if roots.is_empty() { None } else { Some(0) };
        Self {
            roots,
            selected_index,
            filter_text: String::new(),
            scroll: ScrollState::default(),
        }
    }

    /// Sets the initially selected index in the flattened view (builder method).
    ///
    /// The index is clamped to the valid range of visible nodes.
    /// Has no effect on empty trees.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let mut root = TreeNode::new_expanded("Root", ());
    /// root.add_child(TreeNode::new("Child 1", ()));
    /// root.add_child(TreeNode::new("Child 2", ()));
    ///
    /// let state = TreeState::new(vec![root]).with_selected(2);
    /// assert_eq!(state.selected_index(), Some(2));
    /// ```
    pub fn with_selected(mut self, index: usize) -> Self {
        if self.roots.is_empty() {
            return self;
        }
        let visible = self.flatten().len();
        self.selected_index = Some(index.min(visible.saturating_sub(1)));
        self
    }

    /// Returns the root nodes.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let state = TreeState::new(vec![
    ///     TreeNode::new("Root 1", 1),
    ///     TreeNode::new("Root 2", 2),
    /// ]);
    /// assert_eq!(state.roots().len(), 2);
    /// assert_eq!(state.roots()[0].label(), "Root 1");
    /// ```
    pub fn roots(&self) -> &[TreeNode<T>] {
        &self.roots
    }

    /// Returns a mutable reference to the root nodes.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let mut state = TreeState::new(vec![TreeNode::new("Root", ())]);
    /// state.roots_mut().push(TreeNode::new("Another Root", ()));
    /// assert_eq!(state.roots().len(), 2);
    /// ```
    pub fn roots_mut(&mut self) -> &mut Vec<TreeNode<T>> {
        &mut self.roots
    }

    /// Updates a root node at the given index via a closure.
    ///
    /// No-ops if the index is out of bounds. This is safe because it
    /// does not change the number of root nodes or their positions,
    /// so selection and filter state remain valid.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let mut state = TreeState::new(vec![
    ///     TreeNode::new("Root 1", 1),
    ///     TreeNode::new("Root 2", 2),
    /// ]);
    /// state.update_root(0, |root| root.set_label("Updated Root"));
    /// assert_eq!(state.roots()[0].label(), "Updated Root");
    /// ```
    pub fn update_root(&mut self, index: usize, f: impl FnOnce(&mut TreeNode<T>)) {
        if let Some(root) = self.roots.get_mut(index) {
            f(root);
        }
    }

    /// Sets the root nodes.
    ///
    /// Resets selection to the first node, or `None` if the new roots are empty.
    /// Clears any active filter.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let mut state = TreeState::new(vec![TreeNode::new("Old", 0)]);
    /// state.set_roots(vec![TreeNode::new("New 1", 1), TreeNode::new("New 2", 2)]);
    /// assert_eq!(state.roots().len(), 2);
    /// assert_eq!(state.selected_index(), Some(0));
    /// ```
    pub fn set_roots(&mut self, roots: Vec<TreeNode<T>>) {
        self.roots = roots;
        self.filter_text.clear();
        self.selected_index = if self.roots.is_empty() { None } else { Some(0) };
        self.scroll.set_content_length(self.flatten().len());
    }

    /// Returns the currently selected index in the flattened view.
    ///
    /// Returns `None` if the tree is empty.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let state = TreeState::new(vec![TreeNode::new("Root", ())]);
    /// assert_eq!(state.selected_index(), Some(0));
    ///
    /// let empty: TreeState<()> = TreeState::new(vec![]);
    /// assert_eq!(empty.selected_index(), None);
    /// ```
    pub fn selected_index(&self) -> Option<usize> {
        self.selected_index
    }

    /// Alias for [`selected_index()`](Self::selected_index).
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let state = TreeState::new(vec![TreeNode::new("Root", ())]);
    /// assert_eq!(state.selected(), Some(0));
    /// ```
    pub fn selected(&self) -> Option<usize> {
        self.selected_index()
    }

    /// Sets the selected index in the flattened view.
    ///
    /// The index is clamped to the valid range of visible nodes.
    /// Has no effect on empty trees.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let mut root = TreeNode::new_expanded("Root", ());
    /// root.add_child(TreeNode::new("Child 1", ()));
    /// root.add_child(TreeNode::new("Child 2", ()));
    ///
    /// let mut state = TreeState::new(vec![root]);
    /// state.set_selected(Some(2));
    /// assert_eq!(state.selected_index(), Some(2));
    /// ```
    pub fn set_selected(&mut self, index: Option<usize>) {
        match index {
            Some(i) => {
                if self.roots.is_empty() {
                    return;
                }
                let visible = self.flatten().len();
                self.selected_index = Some(i.min(visible.saturating_sub(1)));
            }
            None => self.selected_index = None,
        }
    }

    /// Returns true if the tree is empty.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeState;
    ///
    /// let empty: TreeState<()> = TreeState::new(vec![]);
    /// assert!(empty.is_empty());
    /// ```
    pub fn is_empty(&self) -> bool {
        self.roots.is_empty()
    }

    /// Returns the path of the currently selected node.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let state = TreeState::new(vec![TreeNode::new("Root", ())]);
    /// assert_eq!(state.selected_path(), Some(vec![0]));
    /// ```
    pub fn selected_path(&self) -> Option<Vec<usize>> {
        let flat = self.flatten();
        flat.get(self.selected_index?).map(|n| n.path.clone())
    }

    /// Returns a reference to the currently selected node.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let state = TreeState::new(vec![TreeNode::new("Root", 42)]);
    /// let node = state.selected_node().unwrap();
    /// assert_eq!(node.label(), "Root");
    /// assert_eq!(node.data(), &42);
    /// ```
    pub fn selected_node(&self) -> Option<&TreeNode<T>> {
        let path = self.selected_path()?;
        self.get_node(&path)
    }

    /// Returns a reference to the currently selected node.
    ///
    /// This is an alias for [`selected_node()`](Self::selected_node) that provides a
    /// consistent accessor name across all selection-based components.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let state = TreeState::new(vec![TreeNode::new("Root", 1)]);
    /// assert_eq!(state.selected_item(), state.selected_node());
    /// ```
    pub fn selected_item(&self) -> Option<&TreeNode<T>> {
        self.selected_node()
    }

    /// Expands all nodes in the tree.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let mut root = TreeNode::new("Root", ());
    /// root.add_child(TreeNode::new("Child", ()));
    /// let mut state = TreeState::new(vec![root]);
    /// state.expand_all();
    /// assert!(state.roots()[0].is_expanded());
    /// ```
    pub fn expand_all(&mut self) {
        for root in &mut self.roots {
            Self::expand_all_recursive(root);
        }
        self.scroll.set_content_length(self.flatten().len());
    }

    /// Collapses all nodes in the tree.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let mut root = TreeNode::new_expanded("Root", ());
    /// root.add_child(TreeNode::new("Child", ()));
    /// let mut state = TreeState::new(vec![root]);
    /// state.collapse_all();
    /// assert!(!state.roots()[0].is_expanded());
    /// ```
    pub fn collapse_all(&mut self) {
        for root in &mut self.roots {
            Self::collapse_all_recursive(root);
        }
        // Reset selection to ensure it's still valid
        self.selected_index = if self.roots.is_empty() { None } else { Some(0) };
        self.scroll.set_content_length(self.flatten().len());
    }

    /// Returns the number of visible nodes.
    ///
    /// # Examples
    ///
    /// ```
    /// use envision::prelude::*;
    ///
    /// let mut root = TreeNode::new_expanded("Root", ());
    /// root.add_child(TreeNode::new("Child 1", ()));
    /// root.add_child(TreeNode::new("Child 2", ()));
    /// let state = TreeState::new(vec![root]);
    /// // Root + 2 children visible (root is expanded)
    /// assert_eq!(state.visible_count(), 3);
    /// ```
    pub fn visible_count(&self) -> usize {
        self.flatten().len()
    }

    /// Returns the current filter text.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::TreeState;
    ///
    /// let state: TreeState<()> = TreeState::new(vec![]);
    /// assert_eq!(state.filter_text(), "");
    /// ```
    pub fn filter_text(&self) -> &str {
        &self.filter_text
    }

    /// Sets the filter text for case-insensitive substring matching on node labels.
    ///
    /// When a filter is active, only nodes whose label matches or whose
    /// descendants match are shown. Ancestor nodes are auto-expanded to
    /// reveal matching descendants without modifying their actual expanded state.
    ///
    /// Selection is preserved if the selected node remains visible,
    /// otherwise it moves to the first visible node.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let mut state = TreeState::new(vec![
    ///     TreeNode::new("Alpha", ()),
    ///     TreeNode::new("Beta", ()),
    /// ]);
    /// state.set_filter_text("alpha");
    /// assert_eq!(state.filter_text(), "alpha");
    /// assert_eq!(state.visible_count(), 1);
    /// ```
    pub fn set_filter_text(&mut self, text: &str) {
        let prev_path = self.selected_path();
        self.filter_text = text.to_string();
        self.revalidate_selection(prev_path);
        self.scroll.set_content_length(self.flatten().len());
    }

    /// Clears the filter, showing all nodes with their original expanded state.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeState, TreeNode};
    ///
    /// let mut state = TreeState::new(vec![
    ///     TreeNode::new("Alpha", ()),
    ///     TreeNode::new("Beta", ()),
    /// ]);
    /// state.set_filter_text("alpha");
    /// assert_eq!(state.visible_count(), 1);
    /// state.clear_filter();
    /// assert_eq!(state.filter_text(), "");
    /// assert_eq!(state.visible_count(), 2);
    /// ```
    pub fn clear_filter(&mut self) {
        let prev_path = self.selected_path();
        self.filter_text.clear();
        self.revalidate_selection(prev_path);
        self.scroll.set_content_length(self.flatten().len());
    }
}

impl<T: Clone + 'static> TreeState<T> {
    /// Updates the tree state with a message, returning any output.
    ///
    /// # Example
    ///
    /// ```rust
    /// use envision::component::{TreeMessage, TreeNode, TreeState};
    ///
    /// let mut root = TreeNode::new("Root", ());
    /// root.add_child(TreeNode::new("Child", ()));
    /// let mut state = TreeState::new(vec![root]);
    /// state.update(TreeMessage::Expand);
    /// assert!(state.roots()[0].is_expanded());
    /// ```
    pub fn update(&mut self, msg: TreeMessage) -> Option<TreeOutput> {
        Tree::update(self, msg)
    }
}

/// A hierarchical tree view component.
///
/// Displays data in a tree structure with expandable/collapsible nodes.
/// Supports keyboard navigation and single selection.
///
/// # Visual Format
///
/// ```text
/// â–¶ Documents
/// â–¼ Projects
///   ├─ envision
///   │  ├─ src
///   │  └─ tests
///   └─ other
/// ```
///
/// # Keyboard Navigation
///
/// - `Up/Down` - Move selection
/// - `Right` - Expand node
/// - `Left` - Collapse node
/// - `Enter` - Select/activate node
///
/// # Example
///
/// ```rust
/// use envision::component::{Tree, TreeMessage, TreeOutput, TreeState, TreeNode, Component};
///
/// // Build tree structure
/// let mut docs = TreeNode::new("Documents", "docs");
/// docs.add_child(TreeNode::new("readme.md", "readme"));
/// docs.add_child(TreeNode::new("guide.md", "guide"));
///
/// let mut projects = TreeNode::new_expanded("Projects", "projects");
/// projects.add_child(TreeNode::new("envision", "envision"));
///
/// let mut state = TreeState::new(vec![docs, projects]);
///
/// // Navigate
/// Tree::update(&mut state, TreeMessage::Down);
/// Tree::update(&mut state, TreeMessage::Expand);
/// ```
pub struct Tree<T>(std::marker::PhantomData<T>);

impl<T: Clone + 'static> Component for Tree<T> {
    type State = TreeState<T>;
    type Message = TreeMessage;
    type Output = TreeOutput;

    fn init() -> Self::State {
        TreeState::default()
    }

    fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output> {
        // Filter messages are handled before the disabled check,
        // allowing filter changes even when the tree is disabled.
        match msg {
            TreeMessage::SetFilter(ref text) => {
                state.set_filter_text(text);
                return Some(TreeOutput::FilterChanged(text.clone()));
            }
            TreeMessage::ClearFilter => {
                state.clear_filter();
                return Some(TreeOutput::FilterChanged(String::new()));
            }
            _ => {}
        }

        let flat = state.flatten();
        if flat.is_empty() {
            return None;
        }

        let selected = state.selected_index?;

        match msg {
            TreeMessage::Down => {
                if selected < flat.len() - 1 {
                    state.selected_index = Some(selected + 1);
                }
                None
            }
            TreeMessage::Up => {
                if selected > 0 {
                    state.selected_index = Some(selected - 1);
                }
                None
            }
            TreeMessage::Expand => {
                if let Some(node_info) = flat.get(selected) {
                    if node_info.has_children && !node_info.is_expanded {
                        let path = node_info.path.clone();
                        if let Some(node) = state.get_node_mut(&path) {
                            node.expand();
                            state.scroll.set_content_length(state.flatten().len());
                            return Some(TreeOutput::Expanded(path));
                        }
                    }
                }
                None
            }
            TreeMessage::Collapse => {
                if let Some(node_info) = flat.get(selected) {
                    if node_info.has_children && node_info.is_expanded {
                        let path = node_info.path.clone();
                        if let Some(node) = state.get_node_mut(&path) {
                            node.collapse();
                            // Adjust selected index if needed
                            let new_flat = state.flatten();
                            if selected >= new_flat.len() {
                                state.selected_index = Some(new_flat.len().saturating_sub(1));
                            }
                            state.scroll.set_content_length(new_flat.len());
                            return Some(TreeOutput::Collapsed(path));
                        }
                    }
                }
                None
            }
            TreeMessage::Toggle => {
                if let Some(node_info) = flat.get(selected) {
                    if node_info.has_children {
                        let path = node_info.path.clone();
                        let was_expanded = node_info.is_expanded;
                        if let Some(node) = state.get_node_mut(&path) {
                            node.toggle();
                            if was_expanded {
                                // Adjust selected index if needed after collapse
                                let new_flat = state.flatten();
                                if selected >= new_flat.len() {
                                    state.selected_index = Some(new_flat.len().saturating_sub(1));
                                }
                                state.scroll.set_content_length(new_flat.len());
                                return Some(TreeOutput::Collapsed(path));
                            } else {
                                state.scroll.set_content_length(state.flatten().len());
                                return Some(TreeOutput::Expanded(path));
                            }
                        }
                    }
                }
                None
            }
            TreeMessage::Select => flat
                .get(selected)
                .map(|node_info| TreeOutput::Selected(node_info.path.clone())),
            TreeMessage::ExpandAll => {
                state.expand_all();
                // scroll content length already updated by expand_all()
                None
            }
            TreeMessage::CollapseAll => {
                state.collapse_all();
                // scroll content length already updated by collapse_all()
                None
            }
            TreeMessage::SetFilter(_) | TreeMessage::ClearFilter => {
                unreachable!("handled above")
            }
        }
    }

    fn handle_event(
        _state: &Self::State,
        event: &Event,
        ctx: &EventContext,
    ) -> Option<Self::Message> {
        if !ctx.focused || ctx.disabled {
            return None;
        }
        if let Some(key) = event.as_key() {
            match key.code {
                Key::Up | Key::Char('k') => Some(TreeMessage::Up),
                Key::Down | Key::Char('j') => Some(TreeMessage::Down),
                Key::Left | Key::Char('h') => Some(TreeMessage::Collapse),
                Key::Right | Key::Char('l') => Some(TreeMessage::Expand),
                Key::Char(' ') => Some(TreeMessage::Toggle),
                Key::Enter => Some(TreeMessage::Select),
                _ => None,
            }
        } else {
            None
        }
    }

    fn view(state: &Self::State, ctx: &mut RenderContext<'_, '_>) {
        render::view(state, ctx);
    }
}

#[cfg(test)]
mod snapshot_tests;
#[cfg(test)]
mod tests;