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
//! # dioxus-swdir-tree
//!
//! A lazy-loading directory-tree explorer widget for
//! [Dioxus](https://dioxuslabs.com) GUI apps, built on
//! [`swdir`](https://crates.io/crates/swdir).
//!
//! ## Architecture
//!
//! ```text
//! ┌─────────────────────────────┐
//! Signal │ DirectoryTreeView │ renders
//! ─────────────►│ (this crate) │──────────► HTML rows
//! │ │
//! on_event ◄────│ EventHandler │ user gestures
//! └──────────────┬──────────────┘
//! │ Toggled / Selected
//! ▼
//! ┌─────────────────────────────┐
//! Signal.write │ DirectoryTree │ pure state machine
//! ─────────────►│ (dioxus-swdir-tree-core) │
//! └──────────────┬──────────────┘
//! │ ScanRequest (data)
//! ▼
//! ┌─────────────────────────────┐
//! │ use_scan_driver │ coroutine
//! │ ScanExecutor / Thread │ executes scan
//! └─────────────────────────────┘
//! ```
//!
//! ## Quick start
//!
//! ```no_run
//! # use dioxus::prelude::*;
//! use dioxus_swdir_tree::{DirectoryTreeView, DirectoryTreeEvent, use_scan_driver};
//! use dioxus_swdir_tree_core::{DirectoryTree, ThreadExecutor};
//! use std::sync::Arc;
//!
//! fn app() -> Element {
//! let mut tree = use_signal(|| DirectoryTree::new("/home"));
//! let scans = use_scan_driver(tree, Arc::new(ThreadExecutor));
//!
//! let on_event = move |ev: DirectoryTreeEvent| match ev {
//! DirectoryTreeEvent::Toggled(path) => {
//! if let Some(req) = tree.write().on_toggled(&path) {
//! scans.send(req);
//! }
//! }
//! DirectoryTreeEvent::Selected { path, is_dir, mode } => {
//! tree.write().on_selected(&path, is_dir, mode);
//! }
//! };
//!
//! rsx! { DirectoryTreeView { tree, on_event } }
//! }
//! ```
//!
//! The `default-style` feature (on by default) injects a minimal
//! `dx-swdir-*` stylesheet; disable it to theme from scratch.
// Re-export the component and hook at the crate root for ergonomics.
pub use use_scan_driver;
pub use DirectoryTreeEvent;
pub use DirectoryTreeView;
// Re-export everything from core so application code can depend on this
// crate alone.
pub use *;