Add links to our docs in component tooltips

Cargo.lock

@@ -1564,7 +1564,7 @@ checksum = "68b0cf012f1230e43cd00ebb729c6bb58707ecfa8ad08b52ef3a4ccd2697fc30"
 [[package]]
 name = "ecolor"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "bytemuck",
  "serde",
@@ -1573,7 +1573,7 @@ dependencies = [
 [[package]]
 name = "eframe"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "ahash",
  "bytemuck",
@@ -1609,7 +1609,7 @@ dependencies = [
 [[package]]
 name = "egui"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "accesskit",
  "ahash",
@@ -1626,7 +1626,7 @@ dependencies = [
 [[package]]
 name = "egui-wgpu"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "ahash",
  "bytemuck",
@@ -1645,7 +1645,7 @@ dependencies = [
 [[package]]
 name = "egui-winit"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "accesskit_winit",
  "ahash",
@@ -1685,7 +1685,7 @@ dependencies = [
 [[package]]
 name = "egui_extras"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "ahash",
  "egui",
@@ -1701,7 +1701,7 @@ dependencies = [
 [[package]]
 name = "egui_glow"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "ahash",
  "bytemuck",
@@ -1719,7 +1719,7 @@ dependencies = [
 [[package]]
 name = "egui_plot"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "ahash",
  "egui",
@@ -1762,7 +1762,7 @@ checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07"
 [[package]]
 name = "emath"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "bytemuck",
  "serde",
@@ -1863,7 +1863,7 @@ dependencies = [
 [[package]]
 name = "epaint"
 version = "0.27.2"
-source = "git+https://github.com/emilk/egui.git?rev=86560554bcb16e90530f58c120dc29b7a24b1486#86560554bcb16e90530f58c120dc29b7a24b1486"
+source = "git+https://github.com/emilk/egui.git?rev=c0a9800d051f2d23fb63e26cbc87d35e7e17d13e#c0a9800d051f2d23fb63e26cbc87d35e7e17d13e"
 dependencies = [
  "ab_glyph",
  "ahash",
@@ -5156,6 +5156,7 @@ dependencies = [
  "itertools 0.13.0",
  "once_cell",
  "re_arrow2",
+ "re_case",
  "re_error",
  "re_string_interner",
  "re_tracing",

Cargo.toml

@@ -454,13 +454,13 @@ missing_errors_doc = "allow"
 # As a last resport, patch with a commit to our own repository.
 # ALWAYS document what PR the commit hash is part of, or when it was merged into the upstream trunk.
 
-ecolor = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" }      # egui master 2024-05-31
-eframe = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" }      # egui master 2024-05-31
-egui = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" }        # egui master 2024-05-31
-egui_extras = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" } # egui master 2024-05-31
-egui_plot = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" }   # egui master 2024-05-31
-egui-wgpu = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" }   # egui master 2024-05-31
-emath = { git = "https://github.com/emilk/egui.git", rev = "86560554bcb16e90530f58c120dc29b7a24b1486" }       # egui master 2024-05-31
+ecolor = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" }      # egui master 2024-06-03
+eframe = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" }      # egui master 2024-06-03
+egui = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" }        # egui master 2024-06-03
+egui_extras = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" } # egui master 2024-06-03
+egui_plot = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" }   # egui master 2024-06-03
+egui-wgpu = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" }   # egui master 2024-06-03
+emath = { git = "https://github.com/emilk/egui.git", rev = "c0a9800d051f2d23fb63e26cbc87d35e7e17d13e" }       # egui master 2024-06-03
 
 # Useful while developing:
 # ecolor = { path = "../../egui/crates/ecolor" }

crates/re_blueprint_tree/src/blueprint_tree.rs

@@ -469,7 +469,7 @@ impl BlueprintTree {
                     list_item::LabelContent::new("$origin")
                         .subdued(true)
                         .italics(true)
-                        .with_icon(&re_ui::icons::LINK),
+                        .with_icon(&re_ui::icons::INTERNAL_LINK),
                 )
                 .on_hover_text(
                     "This subtree corresponds to the Space View's origin, and is displayed above \

crates/re_data_ui/src/item_ui.rs

@@ -409,30 +409,34 @@ pub fn component_path_button_to(
     );
 
     let response = response.on_hover_ui(|ui| {
-        // TODO(egui#4471): better tooltip size management
-        ui.set_max_width(250.0);
-        ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend);
+        ui.style_mut().wrap_mode = Some(egui::TextWrapMode::Extend); // Make tooltip as wide as needed
+
+        let background_x_range = (ui.max_rect() + ui.spacing().menu_margin).x_range();
 
-        // wrap lone item
         list_item::list_item_scope(ui, "component_path_tooltip", |ui| {
-            list_item::ListItem::new(ctx.re_ui)
-                .interactive(false)
-                .show_flat(
-                    ui,
-                    list_item::LabelContent::new(if is_static {
-                        "Static component"
-                    } else {
-                        "Temporal component"
-                    })
-                    .with_icon(icon)
-                    .exact_width(true),
-                );
+            re_ui::full_span::full_span_scope(ui, background_x_range, |ui| {
+                list_item::ListItem::new(ctx.re_ui)
+                    .interactive(false)
+                    .show_flat(
+                        ui,
+                        list_item::LabelContent::new(if is_static {
+                            "Static component"
+                        } else {
+                            "Temporal component"
+                        })
+                        .with_icon(icon)
+                        .exact_width(true),
+                    );
+
+                let component_name = component_path.component_name;
+
+                ui.label(format!("Full name: {}", component_name.full_name()));
+
+                if let Some(url) = component_name.doc_url() {
+                    list_item::hyperlink_to_ui(ctx.re_ui, ui, "Documentation", url);
+                }
+            });
         });
-
-        ui.label(format!(
-            "Full name: {}",
-            component_path.component_name.full_name()
-        ));
     });
 
     cursor_interact_with_selectable(ctx, response, item)

crates/re_types_core/Cargo.toml

@@ -29,6 +29,7 @@ serde = ["dep:serde", "re_string_interner/serde"]
 
 [dependencies]
 # Rerun
+re_case.workspace = true
 re_error.workspace = true
 re_string_interner.workspace = true
 re_tracing.workspace = true

crates/re_types_core/src/loggable.rs

@@ -206,6 +206,30 @@ impl ComponentName {
         }
         None
     }
+
+    /// Web URL to the Rerun documentation for this component.
+    pub fn doc_url(&self) -> Option<String> {
+        if let Some(archetype_name_pascal_case) = self.indicator_component_archetype() {
+            // Link indicator components to their archetype.
+            // This code should be correct as long as this url passes our link checker:
+            // https://rerun.io/docs/reference/types/archetypes/line_strips3d
+
+            let archetype_name_snake_case = re_case::to_snake_case(&archetype_name_pascal_case);
+            let base_url = "https://rerun.io/docs/reference/types/archetypes";
+            Some(format!("{base_url}/{archetype_name_snake_case}"))
+        } else if let Some(component_name_pascal_case) =
+            self.full_name().strip_prefix("rerun.components.")
+        {
+            // This code should be correct as long as this url passes our link checker:
+            // https://rerun.io/docs/reference/types/components/half_sizes2d
+
+            let component_name_snake_case = re_case::to_snake_case(component_name_pascal_case);
+            let base_url = "https://rerun.io/docs/reference/types/components";
+            Some(format!("{base_url}/{component_name_snake_case}"))
+        } else {
+            None // A user component
+        }
+    }
 }
 
 // ---

crates/re_ui/src/icons.rs

@@ -147,7 +147,10 @@ pub const ENTITY_EMPTY: Icon = Icon::new(
     "entity_empty",
     include_bytes!("../data/icons/entity_empty.png"),
 );
-pub const LINK: Icon = Icon::new("link", include_bytes!("../data/icons/link.png"));
+
+/// Link within the viewer
+pub const INTERNAL_LINK: Icon = Icon::new("link", include_bytes!("../data/icons/link.png"));
+
 pub const COMPONENT_TEMPORAL: Icon =
     Icon::new("component", include_bytes!("../data/icons/component.png"));
 pub const COMPONENT_STATIC: Icon = Icon::new(

crates/re_ui/src/list_item/mod.rs

@@ -76,3 +76,24 @@ pub trait ListItemContent {
         DesiredWidth::AtLeast(0.0)
     }
 }
+
+/// Helper for adding a list-item hyperlink.
+pub fn hyperlink_to_ui(
+    re_ui: &crate::ReUi,
+    ui: &mut egui::Ui,
+    text: impl Into<egui::WidgetText>,
+    url: impl ToString,
+) -> egui::Response {
+    let response = ListItem::new(re_ui)
+        .show_flat(
+            ui,
+            LabelContent::new(text)
+                .with_icon(&crate::icons::EXTERNAL_LINK)
+                .exact_width(true),
+        )
+        .on_hover_cursor(egui::CursorIcon::PointingHand);
+    if response.clicked() {
+        ui.ctx().open_url(egui::OpenUrl::new_tab(url));
+    }
+    response
+}