Skip to content

PdfCraft: An open-source PDF reader and editor written by scratch in pure Rust

fix(ui): reserve the navigation rail footer height (#5677)

FredApps8e035f2e3458
diff --git a/crates/ui-egui/src/chrome.rs b/crates/ui-egui/src/chrome.rs
index 59525aae7..5be9ee506 100644
--- a/crates/ui-egui/src/chrome.rs
+++ b/crates/ui-egui/src/chrome.rs
@@ -577,40 +577,72 @@ pub fn right_rail(app: &mut PdfCraftApp, ui: &mut egui::Ui) {
.show(ui, &items, app.right.as_ref(), |ui| {
// Page navigation cluster at the bottom, a panel of its own so that in a short
// window the buttons above scroll instead of running into it (#3282).
- ui.with_layout(Layout::bottom_up(Align::Center), |ui| {
+ // Let the footer measure its natural height from the top. A bottom-up child can
+ // grow above the auto-sized panel's origin without reserving that space for the
+ // scrolling items, especially with the extra docking button.
+ ui.with_layout(Layout::top_down(Align::Center), |ui| {
ui.spacing_mut().item_spacing.y = 2.0;
- let right = app.side_panels.rail_on_right();
- let dock_tip = if right { tl!("Dock navigation rail on Left") } else { tl!("Dock navigation rail on Right") };
- if icons::button(ui, if right { "panel-left" } else { "panel-right" }, 32.0, false, dock_tip).clicked() {
- app.side_panels.rail_side = if right { crate::side_panels::ToolsSide::Left } else { crate::side_panels::ToolsSide::Right };
+ let page_input_id = view.page_input_id();
+ // Consume replacement selection once, including when the editor has lost focus.
+ let reselect = std::mem::take(&mut view.page_input_reselect);
+ // Navigation updates the idle display, never the text being edited.
+ if !ui.memory(|m| m.has_focus(page_input_id)) {
+ view.page_input = view.current_page_label(labels.get(view.current).map(String::as_str));
+ } else if reselect {
+ // The replacement changed the label while egui retained this editor's cursor.
+ let mut state = egui::TextEdit::load_state(ui.ctx(), page_input_id).unwrap_or_default();
+ let end = egui::text::CCursor::new(view.page_input.chars().count());
+ state.cursor.set_char_range(Some(egui::text::CCursorRange::two(egui::text::CCursor::new(0), end)));
+ state.store(ui.ctx(), page_input_id);
}
- let tip = crate::commands::key_tip(ui.ctx(), tl!("Zoom out ({key})"), crate::commands::ZOOM_OUT);
- if icons::button(ui, "zoom-out", 32.0, false, &tip).clicked() {
- view.zoom_step(false);
+ let edit = egui::TextEdit::singleline(&mut view.page_input)
+ .id(page_input_id)
+ .desired_width(34.0)
+ .align(egui::Align2::CENTER_TOP)
+ .font(theme::medium(12.0))
+ .margin(vec2(2.0, 4.0));
+ let r = egui::Frame::NONE
+ .fill(t.field)
+ .stroke(Stroke::new(1.0, t.border))
+ .corner_radius(CornerRadius::same(5))
+ .show(ui, |ui| ui.add(edit))
+ .inner
+ .on_hover_text(tl!("Current page — type a page number or label (such as iv) and press Enter"))
+ .accessible_name(tl!("Current page"));
+ if r.lost_focus() {
+ if ui.input(|i| i.key_pressed(egui::Key::Enter)) {
+ // A page label first (logical page numbers, as Acrobat), then a number.
+ let typed = view.page_input.clone();
+ view.go_to_typed(&typed, &labels);
+ }
+ view.page_input = view.current_page_label(labels.get(view.current).map(String::as_str));
}
- let tip = crate::commands::key_tip(ui.ctx(), tl!("Zoom in ({key})"), crate::commands::ZOOM_IN);
- if icons::button(ui, "zoom-in", 32.0, false, &tip).clicked() {
- view.zoom_step(true);
+ let font = theme::regular(11.0);
+ let mut position = page_position(view.current, page_count, labels.get(view.current).map_or("", String::as_str));
+ if widgets::text_width(ui, &position, &font) > ui.available_width() {
+ position = page_count.to_string();
}
- // Between rotate and zoom, as in Acrobat. Its command runs once `view` is free.
- let tip = crate::i18n::fmt(tl!("Page display: {layout}"), &[("layout", tl!(view.layout.label()))]);
- let resp = icons::button(ui, view.layout.icon(), 32.0, false, &tip);
- page_display = egui::Popup::menu(&resp)
- .show(|ui| {
- ui.set_min_width(220.0);
- rail_view_menu(ui, view)
- })
- .and_then(|r| r.inner);
- let tip = crate::commands::key_tip(ui.ctx(), tl!("Rotate view clockwise ({key})"), crate::commands::ROTATE_CW);
- if icons::button(ui, "rotate-cw", 32.0, false, &tip).clicked() {
- view.rotate_view(true);
+ // Out of range (an empty document), like `page_position`: "Page 0 of 0", never past the end.
+ let shown = if view.current < page_count { view.current + 1 } else { page_count };
+ let of = crate::i18n::fmt(tl!("Page {p} of {n}"), &[("p", &shown.to_string()), ("n", &page_count.to_string())]);
+ ui.label(egui::RichText::new(position).font(font).color(t.text_muted)).on_hover_text(of);
+ // History is distinct from stepping to the adjacent page, and belongs to this tab.
+ for (forward, icon, label, shortcut, enabled) in [
+ (false, "chevron-left", tl!("Previous view"), crate::commands::PREV_VIEW, !view.back.is_empty()),
+ (true, "chevron-right", tl!("Next view"), crate::commands::NEXT_VIEW, !view.forward.is_empty()),
+ ] {
+ let tip = format!("{label} ({})", crate::commands::shortcut_label(ui.ctx(), shortcut));
+ if ui.add_enabled_ui(enabled, |ui| icons::button(ui, icon, 30.0, false, &tip)).inner.clicked() {
+ view.view_history(forward);
+ }
}
- // Not `columns-2` while fitting the page: that is the two-page view's icon.
- let fit_icon = if view.fit == Fit::Width { "maximize" } else { "maximize-2" };
- if icons::button(ui, fit_icon, 32.0, false, tl!("Toggle fit page / fit width")).clicked() {
- view.fit = if view.fit == Fit::Width { Fit::Page } else { Fit::Width };
- view.goto = Some((view.current, 0.0));
+ if icons::button(ui, "chevron-up", 30.0, false, tl!("Previous page")).clicked() {
+ view.step_page(false);
}
+ if icons::button(ui, "chevron-down", 30.0, false, tl!("Next page")).clicked() {
+ view.step_page(true);
+ }
+ ui.add_space(6.0);
let id = egui::Id::unique("zoom-input");
let draft = id.with("draft");
let mut typed = ui.data(|d| d.get_temp::<String>(draft)).unwrap_or_else(|| format!("{:.0}%", view.zoom * 100.0));
@@ -641,66 +673,37 @@ pub fn right_rail(app: &mut PdfCraftApp, ui: &mut egui::Ui) {
view.set_zoom(zoom);
}
}
- ui.add_space(6.0);
- if icons::button(ui, "chevron-down", 30.0, false, tl!("Next page")).clicked() {
- view.step_page(true);
- }
- if icons::button(ui, "chevron-up", 30.0, false, tl!("Previous page")).clicked() {
- view.step_page(false);
+ // Not `columns-2` while fitting the page: that is the two-page view's icon.
+ let fit_icon = if view.fit == Fit::Width { "maximize" } else { "maximize-2" };
+ if icons::button(ui, fit_icon, 32.0, false, tl!("Toggle fit page / fit width")).clicked() {
+ view.fit = if view.fit == Fit::Width { Fit::Page } else { Fit::Width };
+ view.goto = Some((view.current, 0.0));
}
- // History is distinct from stepping to the adjacent page, and belongs to this tab.
- for (forward, icon, label, shortcut, enabled) in [
- (true, "chevron-right", tl!("Next view"), crate::commands::NEXT_VIEW, !view.forward.is_empty()),
- (false, "chevron-left", tl!("Previous view"), crate::commands::PREV_VIEW, !view.back.is_empty()),
- ] {
- let tip = format!("{label} ({})", crate::commands::shortcut_label(ui.ctx(), shortcut));
- if ui.add_enabled_ui(enabled, |ui| icons::button(ui, icon, 30.0, false, &tip)).inner.clicked() {
- view.view_history(forward);
- }
+ let tip = crate::commands::key_tip(ui.ctx(), tl!("Rotate view clockwise ({key})"), crate::commands::ROTATE_CW);
+ if icons::button(ui, "rotate-cw", 32.0, false, &tip).clicked() {
+ view.rotate_view(true);
}
- let font = theme::regular(11.0);
- let mut position = page_position(view.current, page_count, labels.get(view.current).map_or("", String::as_str));
- if widgets::text_width(ui, &position, &font) > ui.available_width() {
- position = page_count.to_string();
+ // Between rotate and zoom, as in Acrobat. Its command runs once `view` is free.
+ let tip = crate::i18n::fmt(tl!("Page display: {layout}"), &[("layout", tl!(view.layout.label()))]);
+ let resp = icons::button(ui, view.layout.icon(), 32.0, false, &tip);
+ page_display = egui::Popup::menu(&resp)
+ .show(|ui| {
+ ui.set_min_width(220.0);
+ rail_view_menu(ui, view)
+ })
+ .and_then(|r| r.inner);
+ let tip = crate::commands::key_tip(ui.ctx(), tl!("Zoom in ({key})"), crate::commands::ZOOM_IN);
+ if icons::button(ui, "zoom-in", 32.0, false, &tip).clicked() {
+ view.zoom_step(true);
}
- // Out of range (an empty document), like `page_position`: "Page 0 of 0", never past the end.
- let shown = if view.current < page_count { view.current + 1 } else { page_count };
- let of = crate::i18n::fmt(tl!("Page {p} of {n}"), &[("p", &shown.to_string()), ("n", &page_count.to_string())]);
- ui.label(egui::RichText::new(position).font(font).color(t.text_muted)).on_hover_text(of);
- let page_input_id = view.page_input_id();
- // Consume replacement selection once, including when the editor has lost focus.
- let reselect = std::mem::take(&mut view.page_input_reselect);
- // Navigation updates the idle display, never the text being edited.
- if !ui.memory(|m| m.has_focus(page_input_id)) {
- view.page_input = view.current_page_label(labels.get(view.current).map(String::as_str));
- } else if reselect {
- // The replacement changed the label while egui retained this editor's cursor.
- let mut state = egui::TextEdit::load_state(ui.ctx(), page_input_id).unwrap_or_default();
- let end = egui::text::CCursor::new(view.page_input.chars().count());
- state.cursor.set_char_range(Some(egui::text::CCursorRange::two(egui::text::CCursor::new(0), end)));
- state.store(ui.ctx(), page_input_id);
+ let tip = crate::commands::key_tip(ui.ctx(), tl!("Zoom out ({key})"), crate::commands::ZOOM_OUT);
+ if icons::button(ui, "zoom-out", 32.0, false, &tip).clicked() {
+ view.zoom_step(false);
}
- let edit = egui::TextEdit::singleline(&mut view.page_input)
- .id(page_input_id)
- .desired_width(34.0)
- .align(egui::Align2::CENTER_TOP)
- .font(theme::medium(12.0))
- .margin(vec2(2.0, 4.0));
- let r = egui::Frame::NONE
- .fill(t.field)
- .stroke(Stroke::new(1.0, t.border))
- .corner_radius(CornerRadius::same(5))
- .show(ui, |ui| ui.add(edit))
- .inner
- .on_hover_text(tl!("Current page — type a page number or label (such as iv) and press Enter"))
- .accessible_name(tl!("Current page"));
- if r.lost_focus() {
- if ui.input(|i| i.key_pressed(egui::Key::Enter)) {
- // A page label first (logical page numbers, as Acrobat), then a number.
- let typed = view.page_input.clone();
- view.go_to_typed(&typed, &labels);
- }
- view.page_input = view.current_page_label(labels.get(view.current).map(String::as_str));
+ let right = app.side_panels.rail_on_right();
+ let dock_tip = if right { tl!("Dock navigation rail on Left") } else { tl!("Dock navigation rail on Right") };
+ if icons::button(ui, if right { "panel-left" } else { "panel-right" }, 32.0, false, dock_tip).clicked() {
+ app.side_panels.rail_side = if right { crate::side_panels::ToolsSide::Left } else { crate::side_panels::ToolsSide::Right };
}
});
});
diff --git a/crates/ui-egui/tests/it/ui.rs b/crates/ui-egui/tests/it/ui.rs
index 61ff00222..0dc431344 100644
--- a/crates/ui-egui/tests/it/ui.rs
+++ b/crates/ui-egui/tests/it/ui.rs
@@ -1720,36 +1720,53 @@ fn the_edit_panel_keeps_the_add_update_remove_menu() {
/// being drawn under the page number field.
#[test]
fn short_window_rail_buttons_scroll_clear_of_page_navigation() {
- let (width, height) = (1000.0, 560.0);
- let mut h = Harness::builder().with_size(egui::vec2(width, height)).build_eframe(|_cc| {
- let mut app = PdfCraftApp::new();
- app.set_option("language", "en").unwrap();
- app.open_bytes("short.pdf", None, FIXTURE.to_vec()).unwrap();
- app
- });
- crate::support::settle(&mut h);
- let rail = |h: &Harness<'static, PdfCraftApp>, label: &str| {
- h.query_all_by_label(label).map(|n| n.rect()).find(|r| r.left() >= width - 48.0).unwrap_or_else(|| panic!("{label} in the rail"))
- };
- let page = h.get(By::new().role(egui::accesskit::Role::TextInput).value("1")).rect();
- assert!(page.left() >= width - 48.0 && page.bottom() <= height, "page field {page:?} in the rail");
- assert!(rail(&h, "Comments").bottom() <= page.top(), "the first button sits above the page field");
- assert!(rail(&h, "Tags").top() >= page.top(), "the window is short enough that the buttons must scroll");
- let over = rail(&h, "Comments").center();
- h.event(egui::Event::PointerMoved(over));
- for _ in 0..8 {
- h.event(egui::Event::MouseWheel {
- unit: egui::MouseWheelUnit::Point,
- delta: egui::vec2(0.0, -200.0),
- phase: egui::TouchPhase::Move,
- modifiers: egui::Modifiers::NONE,
- source: egui::MouseWheelSource::Unknown,
+ use pdfcraft_ui_egui::side_panels::ToolsSide;
+
+ for side in [ToolsSide::Right, ToolsSide::Left] {
+ let (width, height) = (1000.0, 560.0);
+ let mut h = Harness::builder().with_size(egui::vec2(width, height)).build_eframe(move |_cc| {
+ let mut app = PdfCraftApp::new();
+ app.set_option("language", "en").unwrap();
+ app.side_panels.rail_side = side;
+ app.open_bytes("short.pdf", None, FIXTURE.to_vec()).unwrap();
+ app
});
- h.run_steps(4);
+ crate::support::settle(&mut h);
+ let in_rail = |r: egui::Rect| match side {
+ ToolsSide::Left => r.right() <= 48.0,
+ ToolsSide::Right => r.left() >= width - 48.0,
+ };
+ let rail = |h: &Harness<'static, PdfCraftApp>, label: &str| {
+ h.query_all_by_label(label).map(|n| n.rect()).find(|r| in_rail(*r)).unwrap_or_else(|| panic!("{label} in the rail"))
+ };
+ let page = h.get(By::new().role(egui::accesskit::Role::TextInput).value("1")).rect();
+ assert!(in_rail(page) && page.bottom() <= height, "page field {page:?} in the rail");
+ let dock_label = match side {
+ ToolsSide::Right => "Dock navigation rail on Left",
+ ToolsSide::Left => "Dock navigation rail on Right",
+ };
+ let dock = rail(&h, dock_label);
+ assert!(dock.top() >= page.bottom() && dock.bottom() <= height, "dock button {dock:?} stays below navigation and inside the window");
+ assert!(rail(&h, "Comments").bottom() <= page.top(), "the first button sits above the page field");
+ assert!(rail(&h, "Tags").top() >= page.top(), "the window is short enough that the buttons must scroll");
+ let first = rail(&h, "Comments");
+ let over = first.center();
+ h.event(egui::Event::PointerMoved(over));
+ for _ in 0..8 {
+ h.event(egui::Event::MouseWheel {
+ unit: egui::MouseWheelUnit::Point,
+ delta: egui::vec2(0.0, -200.0),
+ phase: egui::TouchPhase::Move,
+ modifiers: egui::Modifiers::NONE,
+ source: egui::MouseWheelSource::Unknown,
+ });
+ h.run_steps(4);
+ }
+ let tags = rail(&h, "Tags");
+ assert!(tags.top() >= first.top(), "Tags {tags:?} is fully visible in the scrolling area");
+ assert!(tags.bottom() <= page.top(), "Tags {tags:?} scrolls into view above the page field {page:?}");
+ assert_eq!(h.get(By::new().role(egui::accesskit::Role::TextInput).value("1")).rect(), page, "navigation stays put");
}
- let tags = rail(&h, "Tags");
- assert!(tags.bottom() <= page.top(), "Tags {tags:?} scrolls into view above the page field {page:?}");
- assert_eq!(h.get(By::new().role(egui::accesskit::Role::TextInput).value("1")).rect(), page, "navigation stays put");
}
/// A PDF with `n` empty 200×300 pt pages.