panel-reactflow 0.4.0b1__tar.gz → 0.4.1__tar.gz

{panel_reactflow-0.4.0b1 → panel_reactflow-0.4.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: panel-reactflow
-Version: 0.4.0b1
+Version: 0.4.1
 Summary: A Panel wrapper for the Reactflow JS library.
 Project-URL: Homepage, https://github.com/panel-extensions/panel-reactflow
 Project-URL: Source, https://github.com/panel-extensions/panel-reactflow

{panel_reactflow-0.4.0b1 → panel_reactflow-0.4.1}/docs/how-to/declare-types.md

@@ -6,6 +6,7 @@ kind of node/edge carries**. A type can provide:
 - a type name (`type`)
 - a display label (`label`)
 - node handles (`inputs` / `outputs`)
+- handle connectivity controls (`input_connectable*` / `output_connectable*`)
 - a schema for the `data` payload (`schema`)
 
 Types are separate from editors. A type defines structure; an editor defines
@@ -237,3 +238,159 @@ flow = ReactFlow(
 
 Types without a schema still work; they just do not get schema-driven
 validation or auto-generated forms.
+
+---
+
+## Handle tooltips
+
+By default, handles are plain connection points. You can add a tooltip (shown
+on hover) by passing a dict with `"id"` and `"label"` instead of a plain string:
+
+```python
+from panel_reactflow import NodeType
+
+node_types = {
+    "transform": NodeType(
+        type="transform",
+        label="Transform",
+        inputs=[{"id": "in", "label": "Data Input"}],
+        outputs=[
+            {"id": "success", "label": "Successful results"},
+            {"id": "error", "label": "Failed records"},
+        ],
+    ),
+}
+```
+
+Plain strings and dicts can be mixed freely in the same list:
+
+```python
+inputs=["simple_port", {"id": "documented_port", "label": "Hover to see this"}]
+```
+
+---
+
+## Control handle connectivity
+
+By default, all handles (inputs and outputs) are fully connectable — users can
+drag edges from or to any handle. Use the `*_connectable*` flags to restrict
+which connections are allowed.
+
+### Common patterns
+
+#### Data source (output only)
+
+A node that produces data but cannot accept incoming connections to its output:
+
+```python
+from panel_reactflow import NodeType
+
+source_type = NodeType(
+    type="data_source",
+    label="Data Source",
+    outputs=["data"],
+    output_connectable_start=True,   # Can drag FROM output
+    output_connectable_end=False,    # Cannot drag TO output
+)
+```
+
+#### Data sink (input only)
+
+A node that consumes data but cannot produce outgoing connections from its input:
+
+```python
+sink_type = NodeType(
+    type="data_sink",
+    label="Data Sink",
+    inputs=["data"],
+    input_connectable_start=False,   # Cannot drag FROM input
+    input_connectable_end=True,      # Can drag TO input
+)
+```
+
+#### Monitor node
+
+A node that accepts input but whose output is status-only (one direction):
+
+```python
+monitor_type = NodeType(
+    type="monitor",
+    label="Monitor",
+    inputs=["in"],
+    outputs=["status"],
+    input_connectable_start=False,   # Cannot start edges from input
+    output_connectable_end=False,    # Cannot end edges at output
+)
+```
+
+### All connectivity flags
+
+| Flag | Default | Controls |
+|------|---------|----------|
+| `input_connectable` | `True` | Whether input handles are connectable at all |
+| `input_connectable_start` | `True` | Whether edges can start from input handles |
+| `input_connectable_end` | `True` | Whether edges can end at input handles |
+| `output_connectable` | `True` | Whether output handles are connectable at all |
+| `output_connectable_start` | `True` | Whether edges can start from output handles |
+| `output_connectable_end` | `True` | Whether edges can end at output handles |
+
+### Complete example
+
+```python
+import panel as pn
+from panel_reactflow import NodeType, NodeSpec, EdgeSpec, ReactFlow
+
+pn.extension("jsoneditor")
+
+# Define node types with different connectivity patterns
+node_types = {
+    "source": NodeType(
+        type="source",
+        label="Data Source",
+        outputs=["data"],
+        output_connectable_start=True,
+        output_connectable_end=False,
+    ),
+    "transform": NodeType(
+        type="transform",
+        label="Transform",
+        inputs=["in"],
+        outputs=["out"],
+        # All connectable flags default to True
+    ),
+    "sink": NodeType(
+        type="sink",
+        label="Data Sink",
+        inputs=["data"],
+        input_connectable_start=False,
+        input_connectable_end=True,
+    ),
+}
+
+# Create a data pipeline
+flow = ReactFlow(
+    nodes=[
+        NodeSpec(id="src", type="source", position={"x": 0, "y": 100}, data={}).to_dict(),
+        NodeSpec(id="tx", type="transform", position={"x": 250, "y": 100}, data={}).to_dict(),
+        NodeSpec(id="snk", type="sink", position={"x": 500, "y": 100}, data={}).to_dict(),
+    ],
+    edges=[
+        EdgeSpec(id="e1", source="src", target="tx").to_dict(),
+        EdgeSpec(id="e2", source="tx", target="snk").to_dict(),
+    ],
+    node_types=node_types,
+    sizing_mode="stretch_both",
+)
+
+flow.servable()
+```
+
+In this example:
+
+- Users can drag from the **source** output to the **transform** input ✓
+- Users cannot drag to the **source** output ✗
+- Users can drag from the **transform** output to the **sink** input ✓
+- Users cannot drag from the **sink** input ✗
+
+The UI prevents invalid connections automatically — non-connectable handles
+show different cursor behavior and won't accept drag operations.

{panel_reactflow-0.4.0b1 → panel_reactflow-0.4.1}/docs/releases.md

@@ -1,5 +1,62 @@
 # Release Notes
 
+## Version 0.4.1
+
+A small enhancement release adding viewport zoom controls.
+
+### Enhancements
+
+- **Zoom limits** — new `min_zoom` (default `0.5`) and `max_zoom`
+  (default `2`) parameters constrain how far the canvas can be zoomed
+  out and in, and can be updated at runtime
+  ([#69](https://github.com/panel-extensions/panel-reactflow/pull/69)).
+
+## Version 0.4.0
+
+This release adds new interaction features, edge routing options, and
+handle customization capabilities.
+
+### Highlights
+
+- **Right-click context menu** — nodes and the canvas now support a
+  configurable context menu triggered on right-click, enabling custom
+  actions like delete, duplicate, or copy without toolbar buttons
+  ([#65](https://github.com/panel-extensions/panel-reactflow/pull/65)).
+- **Smart edge routing** — new smart edge types (`smartBezier`,
+  `smartStep`, `smartStraight`) that automatically route around nodes
+  instead of passing through them
+  ([#64](https://github.com/panel-extensions/panel-reactflow/pull/64)).
+- **Handle connectivity controls** — per-type flags
+  (`input_connectable`, `input_connectable_start`,
+  `input_connectable_end`, and their `output_*` counterparts) let you
+  restrict which handles users can drag edges from or to
+  ([#63](https://github.com/panel-extensions/panel-reactflow/pull/63)).
+- **Handle tooltips** — handles can now carry a `label` that appears as
+  an instant tooltip on hover, making port purpose discoverable without
+  cluttering the canvas. Pass `{"id": "port_name", "label": "Description"}`
+  in your `inputs`/`outputs` lists
+  ([#67](https://github.com/panel-extensions/panel-reactflow/pull/67)).
+- **`Node.flow` and `Edge.flow` back-references** — instance-based nodes
+  and edges now hold a `.flow` reference to their parent `ReactFlow`,
+  simplifying imperative graph manipulation from callbacks
+  ([#56](https://github.com/panel-extensions/panel-reactflow/pull/56)).
+- **Delete key support** — selected nodes and edges can now be removed
+  with the Delete key, matching standard graph-editor UX expectations.
+- **Bundle cache-busting** — the frontend bundle URL now includes a
+  content hash, preventing stale cached bundles after upgrades
+  ([#68](https://github.com/panel-extensions/panel-reactflow/pull/68)).
+
+### Bug fixes
+
+- Fixed stale node views not updating and deletion causing flicker
+  ([#60](https://github.com/panel-extensions/panel-reactflow/pull/60)).
+- Fixed `flow` attribute initialization on component creation
+  ([#59](https://github.com/panel-extensions/panel-reactflow/pull/59)).
+- Edge/node add/remove events are now emitted exactly once
+  ([#58](https://github.com/panel-extensions/panel-reactflow/pull/58)).
+- Fixed removing a node when edges are defined as `Edge` instances
+  ([#57](https://github.com/panel-extensions/panel-reactflow/pull/57)).
+
 ## Version 0.3.0
 
 This release focuses on core graph-model capabilities, callback ergonomics,