feat: render hook

.github/workflows/rust.yml

@@ -18,6 +18,8 @@ jobs:
         run: cargo build
       - name: Test
         run: cargo test
+      - name: Test json_tree_test for simd_json feature
+        run: cargo test --features=simd_json --no-default-features --test json_tree_test
       - name: Clippy
         run: cargo clippy
       - name: Format

README.md

@@ -15,9 +15,6 @@ An interactive JSON tree visualiser for `egui`, with search and highlight functi
 ## Usage
 
 ```rust
-use egui::{Color32};
-use egui_json_tree::{DefaultExpand, JsonTree, JsonTreeStyle};
-
 let value = serde_json::json!({ "foo": "bar", "fizz": [1, 2, 3]});
 
 // Simple:
@@ -30,19 +27,52 @@ let response = JsonTree::new("customised-tree", &value)
         ..Default::default()
     })
     .default_expand(DefaultExpand::All)
-    .response_callback(|response, json_pointer_string| {
-      // Handle interactions within the JsonTree.
-    })
     .abbreviate_root(true) // Show {...} when the root object is collapsed.
+    .on_render(|ui, ctx| {
+        // Customise rendering of the JsonTree, and/or handle interactions.
+        match ctx {
+            RenderContext::Property(ctx) => {
+                ctx.render_default(ui).context_menu(|ui| {
+                    // Show a context menu when right clicking
+                    // an array index or object key.
+                });
+            }
+            RenderContext::BaseValue(ctx) => {
+                // Show a button after non-recursive JSON values.
+                ctx.render_default(ui);
+                if ui.small_button("+").clicked() {
+                    // ...
+                }
+            }
+            RenderContext::ExpandableDelimiter(ctx) => {
+                // Render array brackets and object braces as normal.
+                ctx.render_default(ui);
+            }
+        };
+    })
     .show(ui);
 
 // Reset the expanded state of all arrays/objects to respect the `default_expand` setting.
 response.reset_expanded(ui);
 ```
 
-See [demo.rs](./examples/demo.rs) and run the examples for more detailed use cases, including the search match highlight/auto expand functionality, and how to copy JSON paths and values to the clipboard.
+See [demo.rs](./examples/demo.rs) and run the examples for more detailed use cases, including:
+
+- Automatic expansion of arrays/objects and highlighting, based on search term matches.
+- Copying JSON paths and values to the clipboard.
+- A JSON editor UI.
+
+## Supported JSON Types
+
+`JsonTree` can visualise any type that implements `value::ToJsonTreeValue`.
+See the table of crate features below for provided implementations.
+
+| Feature      | JSON Type                 | Default |
+| ------------ | ------------------------- | ------- |
+| `serde_json` | `serde_json::Value`       | Yes     |
+| `simd_json`  | `simd_json::owned::Value` | No      |
 
-`JsonTree` can visualise any type that implements `value::ToJsonTreeValue`. Implementations to support `serde_json::Value` (enabled by default by the crate feature `serde_json`) and `simd_json::owned::Value` (optionally enabled by the crate feature `simd_json`) are provided with this crate. If you wish to use a different JSON type, see the `value` module, and disable default features in your `Cargo.toml` if you do not need the `serde_json` dependency.
+If you wish to use a different JSON type, see the `value` module, and disable default features in your `Cargo.toml` if you do not need the `serde_json` dependency.
 
 ## Run Examples