Introduce variant UIs in `re_component_ui` by abey79 · Pull Request #10034 · rerun-io/rerun

abey79 · 2025-05-21T14:51:06Z

What

This PR add the capability to register and use arbitrary pieces of Arrow-based UI that are not necessarily linked to a specific component. They are called "variant UI", as opposed to "component UI".

To summarise, component UIs:

are registered against a component name
are (typically) implemented with closures that accept (and return, if editable) fully deserialised component
(because of what precedes) are inflexible w.r.t the arrow datatype then can handle
support view and edit, single line and multiline

In contrast, variant UIs (for now):

are registered against a VariantName (conceptually a &'static str constant)
are implemented with closures that accept raw arrow data
are flexible w.r.t the arrow datatype they can handle
(because of what precedes) should explicitly document what arrow datatype they expect/support
only support edit, single line (for now)

Implementation notes:

For now, the variant UI are registered with add_variant_ui and used with variant_ui_raw, which is mostly an independent, parallel path from the pre-existing stuff.
Component descriptor and row id are now passed to UntypedComponentEditOrViewCallback, because these ~~are~~ will be convenient to have in variant ui impls.
This PR includes a redap_uri_button variant ui, which handles data that happens to be rerun-conforming URIs.

…nent ui

…component_ui[_raw]`

…itOrViewCallback`s

github-actions · 2025-05-21T14:51:43Z

Web viewer built successfully. If applicable, you should also test it:

I have tested the web viewer

Result	Commit	Link	Manifest
✅	`5a5a549`	https://rerun.io/viewer/pr/10034	`+nightly` `+main`

^{Note: This comment is updated whenever you push a commit.}

Wumpf

neat, looks straight forward

Wumpf · 2025-05-21T20:43:47Z

+
+    let uri = RedapUri::from_str(url_str)?;
+
+    //TODO(ab): we should provide feedback if the URI is already loaded, e.g. have "go to" instead of "open"


is that hard? we know all the open stores and we know their source, right?

shouldn't be hard, basically about the URI <-> StoreId matching, which might be slightly dirty at this point. I've already an issue open about this so I'll reference it from there.

Wumpf · 2025-05-21T20:44:15Z

+        .clicked()
+    {
+        let url = if ui.input(|i| i.modifiers.command) {
+            egui::OpenUrl::new_tab(uri)


woah, this works on the web now?

Well probably not in the way you think.

Regular click -> open the recording in the current viewer and display it.
Cmd-click -> open the recording in the current viewer, but do not switch to it (aka leave the DisplayMode alone)

IMO this is defo the intended behaviour on native. What should happen on web is debatable. I can see myself wanting either same viewer or separate browser tab, depending on whether I'm focused on latency or ram :) Anyways, orthogonal to this PR. This is dealt with by the bit that hooks into egui and custom handles rerun url schemes.

Well, after testing this in the next PR, it appears that this is broken. But again, this has to do with the way we handle it, so orthogonal to this PR.

ah I see, thanks for clarifying

problem with separate browser tab is that we don't know what the user may have built around rerun

we should probably behave differently if we are in a SPA vs. integrated context (which we currently don't know about), but I digress 😅

Wumpf · 2025-05-21T20:49:00Z

+        fallback_ui(ui, ui_layout, component_raw);
+    }
+
+    /// Show a UI corresponding to the provided variant name.


should document that this falls back to component name based if there's no variant found!

We don't though? Or am I missing something? The fallback is basically the arrow array thrown at arrow_ui

oh I misread because of gh collapsing. Should have expanded more in the diff view

Given that we have a component descriptor.. maybe we should though?

I've got mixed feelings about this. Asking for a non-existent variant is likely a bug. I'll add a todo and a debug log for now, but definitely something we could revisit.

…ect to

… button in the partition table recording links (#10035) ### Related - fixes #9795 - follow-up to #10034 - part of #9741 - future work #10036 ### What This PR introduces the ability to specify on a per-column basis a specific variant ui (see #10034) to use. To that end, a new `ColumnBlueprint` structure is introduced and a bunch of things around that is refactored. This PR also uses the recently introduced `redap_url` variant UI to display the recording link as an "open" button instead of a fully URL. ![image](https://github.com/user-attachments/assets/d512d62c-ac3c-4c46-9caa-4c9bc5305d4f)

abey79 added 7 commits May 21, 2025 16:37

Introduce ComponentUiIdentifier and use it as key to register compo…

b2ae191

…nent ui

Add add_variant_ui and variant_ui_raw, and rename ui[_raw] to `…

0d00a94

…component_ui[_raw]`

Pass &ComponentDescriptor and Option<RowId to `UntypedComponentEd…

bcf40a3

…itOrViewCallback`s

Better signature for the closure provided to add_variant_ui

155e4f8

Variant UI closures now return Box<dyn Error>

ba555c3

Introduce redap_uri_button variant ui

9fb9c23

Introduce VariantName instead of &'static str

1ff17f0

abey79 added 📺 re_viewer affects re_viewer itself include in changelog labels May 21, 2025

Wumpf self-requested a review May 21, 2025 15:01

fix doclink

ab73731

abey79 mentioned this pull request May 21, 2025

Add support for variant UIs in the DataFusion table widget and show a button in the partition table recording links #10035

Merged

Wumpf approved these changes May 21, 2025

View reviewed changes

abey79 added 3 commits May 22, 2025 10:30

add debug asert to ensure we get called for the component name we exp…

c44650a

…ect to

issue reference

ece3771

add debug log if variant name wasn't found

5a5a549

abey79 merged commit ecaabd7 into main May 22, 2025
41 checks passed

abey79 deleted the antoine/component-ui-variant branch May 22, 2025 12:32


		let uri = RedapUri::from_str(url_str)?;

		//TODO(ab): we should provide feedback if the URI is already loaded, e.g. have "go to" instead of "open"

Conversation

abey79 commented May 21, 2025

Related

What

Uh oh!

github-actions Bot commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wumpf left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented May 21, 2025 •

edited

Loading