Merge branch 'main' into antoine/no-assert-container

Author: abey79

.github/workflows/contrib_checks.yml

@@ -132,6 +132,13 @@ jobs:
       - name: Rust checks & tests
         run: pixi run rs-check --skip individual_crates docs_slow
 
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results-ubuntu
+          path: "**/tests/snapshots"
+
   rerun-lints:
     name: Rerun lints
     runs-on: ubuntu-latest

.github/workflows/reusable_checks_rust.yml

@@ -107,6 +107,13 @@ jobs:
         # See tests/assets/rrd/README.md for more
         run: pixi run check-backwards-compatibility
 
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results-ubuntu
+          path: "**/tests/snapshots"
+
   # Run some basics tests on Mac and Windows
   mac-windows-tests:
     name: Test on ${{ matrix.name }}
@@ -160,3 +167,10 @@ jobs:
       - name: Rust all checks & tests
         if: ${{ inputs.CHANNEL == 'nightly' }}
         run: pixi run rs-check
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: test-results-${{ matrix.name }}
+          path: "**/tests/snapshots"

crates/viewer/re_time_panel/src/time_panel.rs

@@ -17,8 +17,8 @@ use re_types::blueprint::components::PanelState;
 use re_types_core::ComponentName;
 use re_ui::filter_widget::format_matching_text;
 use re_ui::{
-    filter_widget, icon_text, icons, list_item, ContextExt as _, DesignTokens, Help, ModifiersText,
-    UiExt as _,
+    filter_widget, icon_text, icons, list_item, maybe_plus, modifiers_text, ContextExt as _,
+    DesignTokens, Help, UiExt as _,
 };
 use re_viewer_context::{
     CollapseScope, HoverHighlight, Item, ItemContext, RecordingConfig, TimeControl, TimeView,
@@ -1358,28 +1358,35 @@ fn paint_range_highlight(
     }
 }
 
+fn help(ctx: &egui::Context) -> Help {
+    Help::new("Timeline")
+        .control("Play/Pause", "Space")
+        .control(
+            "Move time cursor",
+            icon_text!(icons::LEFT_MOUSE_CLICK, "+", "drag time scale"),
+        )
+        .control(
+            "Select time segment",
+            icon_text!(icons::SHIFT, "+", "drag time scale"),
+        )
+        .control(
+            "Pan",
+            icon_text!(icons::LEFT_MOUSE_CLICK, "+", "drag event canvas"),
+        )
+        .control(
+            "Zoom",
+            icon_text!(
+                modifiers_text(Modifiers::COMMAND, ctx),
+                maybe_plus(ctx),
+                icons::SCROLL
+            ),
+        )
+        .control("Reset view", icon_text!("double", icons::LEFT_MOUSE_CLICK))
+}
+
 fn help_button(ui: &mut egui::Ui) {
     ui.help_hover_button().on_hover_ui(|ui| {
-        Help::new("Timeline")
-            .control("Play/Pause", icon_text!("Space"))
-            .control(
-                "Move time cursor",
-                icon_text!(icons::LEFT_MOUSE_CLICK, "+ drag time scale"),
-            )
-            .control(
-                "Select time segment",
-                icon_text!(icons::SHIFT, "+ drag time scale"),
-            )
-            .control(
-                "Pan",
-                icon_text!(icons::LEFT_MOUSE_CLICK, "+ drag event canvas"),
-            )
-            .control(
-                "Zoom",
-                icon_text!(ModifiersText(Modifiers::COMMAND, ui.ctx()), icons::SCROLL),
-            )
-            .control("Reset view", icon_text!("double", icons::LEFT_MOUSE_CLICK))
-            .ui(ui);
+        help(ui.ctx()).ui(ui);
     });
 }
 
@@ -1791,3 +1798,8 @@ fn time_marker_ui(
             .context_menu(|ui| copy_time_properties_context_menu(ui, time_ctrl, hovered_time));
     }
 }
+
+#[test]
+fn test_help_view() {
+    re_viewer_context::test_context::TestContext::test_help_view(help);
+}

crates/viewer/re_time_panel/tests/snapshots/help_view_timeline_mac.png

@@ -5,8 +5,8 @@ mod right_panel;
 use egui::Modifiers;
 use re_ui::filter_widget::format_matching_text;
 use re_ui::{
-    filter_widget::FilterState, list_item, CommandPalette, ContextExt as _, DesignTokens, Help,
-    ModifiersText, UICommand, UICommandSender, UiExt as _,
+    filter_widget::FilterState, list_item, maybe_plus, modifiers_text, CommandPalette,
+    ContextExt as _, DesignTokens, Help, UICommand, UICommandSender, UiExt as _,
 };
 use re_ui::{icon_text, icons, notifications};
 
@@ -483,12 +483,12 @@ impl egui_tiles::Behavior<Tab> for MyTileTreeBehavior {
             ui.label("Help").on_hover_ui(|ui| {
                 Help::new("Help example")
                     .docs_link("https://rerun.io/docs/reference/types/views/map_view")
-                    .control("Pan", icon_text!(icons::LEFT_MOUSE_CLICK, "+ drag"))
+                    .control("Pan", icon_text!(icons::LEFT_MOUSE_CLICK, "+", "drag"))
                     .control(
                         "Zoom",
                         icon_text!(
-                            ModifiersText(Modifiers::COMMAND, ui.ctx()),
-                            "+",
+                            modifiers_text(Modifiers::COMMAND, ui.ctx()),
+                            maybe_plus(ui.ctx()),
                             icons::SCROLL
                         ),
                     )

crates/viewer/re_time_panel/tests/snapshots/help_view_timeline_windows.png

@@ -1,41 +1,45 @@
 use crate::icon_text::{IconText, IconTextItem};
 use crate::{design_tokens, icons, ColorToken, DesignTokens, Scale, UiExt as _};
-use egui::{OpenUrl, RichText, Sense, TextBuffer as _, Ui, UiBuilder};
+use egui::{OpenUrl, RichText, Sense, TextStyle, Ui, UiBuilder};
 
 /// A help popup where you can show markdown text and controls as a table.
 #[derive(Debug, Clone)]
-pub struct Help<'a> {
+pub struct Help {
     title: String,
     docs_link: Option<String>,
-    sections: Vec<HelpSection<'a>>,
+    sections: Vec<HelpSection>,
 }
 
 /// A single section, separated by a [`egui::Separator`].
 #[derive(Debug, Clone)]
-enum HelpSection<'a> {
+enum HelpSection {
     Markdown(String),
-    Controls(Vec<ControlRow<'a>>),
+    Controls(Vec<ControlRow>),
 }
 
 /// A single row in the controls table.
 #[derive(Debug, Clone)]
-pub struct ControlRow<'a> {
+pub struct ControlRow {
     text: String,
-    items: IconText<'a>,
+    items: IconText,
 }
 
-impl<'a> ControlRow<'a> {
+impl ControlRow {
     /// Create a new control row.
     #[allow(clippy::needless_pass_by_value)]
-    pub fn new(text: impl ToString, items: IconText<'a>) -> Self {
+    pub fn new(text: impl ToString, items: IconText) -> Self {
         Self {
             text: text.to_string(),
             items,
         }
     }
 }
 
-impl<'a> Help<'a> {
+impl Help {
+    pub fn title(&self) -> &str {
+        self.title.as_str()
+    }
+
     /// Create a new help popup.
     #[allow(clippy::needless_pass_by_value)]
     pub fn new(title: impl ToString) -> Self {
@@ -65,20 +69,28 @@ impl<'a> Help<'a> {
 
     /// Add a controls section.
     #[inline]
-    pub fn controls(mut self, controls: Vec<ControlRow<'a>>) -> Self {
+    pub fn controls(mut self, controls: Vec<ControlRow>) -> Self {
         self.sections.push(HelpSection::Controls(controls));
         self
     }
 
     /// Add a single control row to the last controls section.
+    ///
+    /// Split any + or / into an extra `IconTextItem`, like this:
+    /// ```rust
+    /// re_ui::Help::new("Example").control("Pan", re_ui::icon_text!("click", "+", "drag"));
+    /// ```
     #[allow(clippy::needless_pass_by_value)]
     #[inline]
-    pub fn control(mut self, label: impl ToString, items: IconText<'a>) -> Self {
+    pub fn control(mut self, label: impl ToString, items: impl Into<IconText>) -> Self {
         if let Some(HelpSection::Controls(controls)) = self.sections.last_mut() {
-            controls.push(ControlRow::new(label, items));
+            controls.push(ControlRow::new(label, items.into()));
         } else {
             self.sections
-                .push(HelpSection::Controls(vec![ControlRow::new(label, items)]));
+                .push(HelpSection::Controls(vec![ControlRow::new(
+                    label,
+                    items.into(),
+                )]));
         }
         self
     }
@@ -103,7 +115,7 @@ impl<'a> Help<'a> {
     }
 
     /// Show the help popup. Usually you want to show this in [`egui::Response::on_hover_ui`].
-    pub fn ui(&self, ui: &mut Ui) {
+    pub fn ui(self, ui: &mut Ui) {
         egui::Sides::new().show(
             ui,
             |ui| {
@@ -137,11 +149,11 @@ impl<'a> Help<'a> {
             },
         );
 
-        for section in &self.sections {
+        for section in self.sections {
             Self::separator(ui);
             match section {
                 HelpSection::Markdown(md) => {
-                    ui.markdown_ui(md);
+                    ui.markdown_ui(&md);
                 }
                 HelpSection::Controls(controls) => {
                     for row in controls {
@@ -151,28 +163,18 @@ impl<'a> Help<'a> {
                                 ui.strong(RichText::new(&row.text).size(11.0));
                             },
                             |ui| {
+                                let color = design_tokens().color(ColorToken::gray(Scale::S700));
                                 ui.set_height(DesignTokens::small_icon_size().y);
-                                for item in row.items.0.iter().rev() {
+                                ui.spacing_mut().item_spacing.x = 2.0;
+                                ui.style_mut().override_text_style = Some(TextStyle::Monospace);
+                                ui.visuals_mut().override_text_color = Some(color);
+                                for item in row.items.0.into_iter().rev() {
                                     match item {
                                         IconTextItem::Icon(icon) => {
-                                            ui.small_icon(
-                                                icon,
-                                                Some(
-                                                    design_tokens()
-                                                        .color(ColorToken::gray(Scale::S700)),
-                                                ),
-                                            );
+                                            ui.small_icon(&icon, Some(color));
                                         }
                                         IconTextItem::Text(text) => {
-                                            ui.label(
-                                                RichText::new(text.as_str())
-                                                    .monospace()
-                                                    .size(11.0)
-                                                    .color(
-                                                        design_tokens()
-                                                            .color(ColorToken::gray(Scale::S700)),
-                                                    ),
-                                            );
+                                            ui.label(text);
                                         }
                                     }
                                 }