ratatui_ruby 0.7.1 → 0.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.builds/ruby-3.2.yml +1 -1
- data/.builds/ruby-3.3.yml +1 -1
- data/.builds/ruby-3.4.yml +1 -1
- data/.builds/ruby-4.0.0.yml +1 -1
- data/AGENTS.md +12 -4
- data/CHANGELOG.md +49 -0
- data/README.md +7 -7
- data/Rakefile +1 -1
- data/doc/{application_architecture.md → concepts/application_architecture.md} +30 -0
- data/doc/{application_testing.md → concepts/application_testing.md} +4 -2
- data/doc/{event_handling.md → concepts/event_handling.md} +1 -1
- data/doc/contributors/auditing/parity.md +233 -0
- data/doc/contributors/developing_examples.md +10 -10
- data/doc/contributors/upstream_requests/tab_rects.md +173 -0
- data/doc/contributors/upstream_requests/title_rects.md +132 -0
- data/doc/contributors/v1.0.0_blockers.md +54 -747
- data/doc/{quickstart.md → getting_started/quickstart.md} +26 -26
- data/doc/{why.md → getting_started/why.md} +1 -1
- data/doc/index.md +23 -9
- data/doc/{terminal_limitations.md → troubleshooting/terminal_limitations.md} +33 -0
- data/doc/troubleshooting/tui_output.md +76 -0
- data/examples/app_all_events/README.md +1 -0
- data/examples/app_all_events/app.rb +2 -0
- data/examples/app_all_events/model/app_model.rb +2 -0
- data/examples/app_all_events/model/event_color_cycle.rb +2 -0
- data/examples/app_all_events/model/event_entry.rb +2 -0
- data/examples/app_all_events/model/msg.rb +2 -0
- data/examples/app_all_events/model/timestamp.rb +2 -0
- data/examples/app_all_events/update.rb +2 -0
- data/examples/app_all_events/view/app_view.rb +2 -0
- data/examples/app_all_events/view/controls_view.rb +2 -0
- data/examples/app_all_events/view/counts_view.rb +2 -0
- data/examples/app_all_events/view/live_view.rb +2 -0
- data/examples/app_all_events/view/log_view.rb +2 -0
- data/examples/app_all_events/view.rb +2 -0
- data/examples/app_color_picker/README.md +2 -0
- data/examples/app_color_picker/app.rb +2 -0
- data/examples/app_color_picker/clipboard.rb +2 -0
- data/examples/app_color_picker/color.rb +2 -0
- data/examples/app_color_picker/controls.rb +2 -0
- data/examples/app_color_picker/copy_dialog.rb +2 -0
- data/examples/app_color_picker/export_pane.rb +2 -0
- data/examples/app_color_picker/harmony.rb +2 -0
- data/examples/app_color_picker/input.rb +2 -0
- data/examples/app_color_picker/main_container.rb +2 -0
- data/examples/app_color_picker/palette.rb +2 -0
- data/examples/app_login_form/README.md +3 -0
- data/examples/app_login_form/app.rb +2 -0
- data/examples/app_stateful_interaction/README.md +2 -0
- data/examples/app_stateful_interaction/app.rb +2 -0
- data/examples/timeout_demo.rb +2 -0
- data/examples/verify_quickstart_dsl/README.md +2 -2
- data/examples/verify_quickstart_dsl/app.rb +2 -0
- data/examples/verify_quickstart_layout/README.md +2 -2
- data/examples/verify_quickstart_layout/app.rb +2 -0
- data/examples/verify_quickstart_lifecycle/README.md +2 -2
- data/examples/verify_quickstart_lifecycle/app.rb +2 -0
- data/examples/verify_readme_usage/app.rb +2 -0
- data/examples/{widget_barchart_demo → widget_barchart}/README.md +5 -3
- data/examples/{widget_barchart_demo → widget_barchart}/app.rb +7 -5
- data/examples/{widget_block_demo → widget_block}/README.md +5 -3
- data/examples/{widget_block_demo → widget_block}/app.rb +6 -4
- data/examples/{widget_box_demo → widget_box}/README.md +7 -4
- data/examples/{widget_box_demo → widget_box}/app.rb +7 -5
- data/examples/{widget_calendar_demo → widget_calendar}/README.md +6 -3
- data/examples/{widget_calendar_demo → widget_calendar}/app.rb +6 -4
- data/examples/{widget_canvas_demo → widget_canvas}/README.md +2 -2
- data/examples/{widget_canvas_demo → widget_canvas}/app.rb +6 -4
- data/examples/{widget_cell_demo → widget_cell}/README.md +6 -3
- data/examples/{widget_cell_demo → widget_cell}/app.rb +7 -5
- data/examples/{widget_center_demo → widget_center}/README.md +2 -2
- data/examples/{widget_center_demo → widget_center}/app.rb +6 -4
- data/examples/{widget_chart_demo → widget_chart}/README.md +7 -4
- data/examples/{widget_chart_demo → widget_chart}/app.rb +7 -5
- data/examples/{widget_gauge_demo → widget_gauge}/README.md +6 -3
- data/examples/{widget_gauge_demo → widget_gauge}/app.rb +7 -5
- data/examples/widget_layout_split/README.md +5 -2
- data/examples/widget_layout_split/app.rb +3 -1
- data/examples/{widget_line_gauge_demo → widget_line_gauge}/README.md +6 -3
- data/examples/{widget_line_gauge_demo → widget_line_gauge}/app.rb +7 -5
- data/examples/{widget_list_demo → widget_list}/README.md +7 -4
- data/examples/{widget_list_demo → widget_list}/app.rb +7 -5
- data/examples/{widget_map_demo → widget_map}/README.md +7 -4
- data/examples/{widget_map_demo → widget_map}/app.rb +4 -2
- data/examples/{widget_overlay_demo → widget_overlay}/README.md +6 -3
- data/examples/{widget_overlay_demo → widget_overlay}/app.rb +5 -3
- data/examples/{widget_popup_demo → widget_popup}/README.md +7 -4
- data/examples/{widget_popup_demo → widget_popup}/app.rb +6 -4
- data/examples/{widget_ratatui_logo_demo → widget_ratatui_logo}/README.md +6 -3
- data/examples/{widget_ratatui_logo_demo → widget_ratatui_logo}/app.rb +8 -6
- data/examples/{widget_ratatui_mascot_demo → widget_ratatui_mascot}/README.md +6 -3
- data/examples/{widget_ratatui_mascot_demo → widget_ratatui_mascot}/app.rb +6 -4
- data/examples/widget_rect/README.md +5 -2
- data/examples/widget_rect/app.rb +2 -0
- data/examples/widget_render/README.md +4 -1
- data/examples/widget_render/app.rb +2 -0
- data/examples/widget_rich_text/README.md +4 -1
- data/examples/widget_rich_text/app.rb +2 -0
- data/examples/widget_scroll_text/README.md +4 -1
- data/examples/widget_scroll_text/app.rb +3 -1
- data/examples/{widget_scrollbar_demo → widget_scrollbar}/README.md +7 -4
- data/examples/{widget_scrollbar_demo → widget_scrollbar}/app.rb +6 -4
- data/examples/{widget_sparkline_demo → widget_sparkline}/README.md +6 -3
- data/examples/{widget_sparkline_demo → widget_sparkline}/app.rb +7 -5
- data/examples/widget_style_colors/README.md +4 -1
- data/examples/widget_style_colors/app.rb +2 -0
- data/examples/{widget_table_demo → widget_table}/README.md +7 -4
- data/examples/{widget_table_demo → widget_table}/app.rb +4 -2
- data/examples/{widget_tabs_demo → widget_tabs}/README.md +6 -3
- data/examples/{widget_tabs_demo → widget_tabs}/app.rb +7 -5
- data/examples/widget_text_width/README.md +5 -2
- data/examples/widget_text_width/app.rb +2 -0
- data/exe/.gitkeep +0 -0
- data/ext/ratatui_ruby/Cargo.lock +1 -1
- data/ext/ratatui_ruby/Cargo.toml +1 -1
- data/ext/ratatui_ruby/extconf.rb +2 -0
- data/ext/ratatui_ruby/src/lib.rs +2 -2
- data/ext/ratatui_ruby/src/rendering.rs +9 -0
- data/ext/ratatui_ruby/src/style.rs +22 -2
- data/ext/ratatui_ruby/src/text.rs +26 -0
- data/ext/ratatui_ruby/src/widgets/barchart.rs +8 -6
- data/ext/ratatui_ruby/src/widgets/chart.rs +31 -4
- data/ext/ratatui_ruby/src/widgets/table.rs +13 -5
- data/ext/ratatui_ruby/src/widgets/tabs.rs +49 -9
- data/lib/ratatui_ruby/buffer/cell.rb +2 -0
- data/lib/ratatui_ruby/buffer.rb +2 -0
- data/lib/ratatui_ruby/cell.rb +2 -0
- data/lib/ratatui_ruby/event/focus_gained.rb +2 -0
- data/lib/ratatui_ruby/event/focus_lost.rb +2 -0
- data/lib/ratatui_ruby/event/key/character.rb +2 -0
- data/lib/ratatui_ruby/event/key/media.rb +2 -0
- data/lib/ratatui_ruby/event/key/modifier.rb +2 -0
- data/lib/ratatui_ruby/event/key/navigation.rb +2 -0
- data/lib/ratatui_ruby/event/key/system.rb +2 -0
- data/lib/ratatui_ruby/event/key.rb +2 -0
- data/lib/ratatui_ruby/event/mouse.rb +2 -0
- data/lib/ratatui_ruby/event/none.rb +2 -0
- data/lib/ratatui_ruby/event/paste.rb +2 -0
- data/lib/ratatui_ruby/event/resize.rb +2 -0
- data/lib/ratatui_ruby/event.rb +2 -0
- data/lib/ratatui_ruby/frame.rb +2 -0
- data/lib/ratatui_ruby/layout/constraint.rb +2 -0
- data/lib/ratatui_ruby/layout/layout.rb +2 -0
- data/lib/ratatui_ruby/layout/rect.rb +2 -0
- data/lib/ratatui_ruby/layout.rb +2 -0
- data/lib/ratatui_ruby/list_state.rb +2 -0
- data/lib/ratatui_ruby/schema/bar_chart/bar.rb +2 -0
- data/lib/ratatui_ruby/schema/bar_chart/bar_group.rb +2 -0
- data/lib/ratatui_ruby/schema/bar_chart.rb +4 -2
- data/lib/ratatui_ruby/schema/block.rb +4 -2
- data/lib/ratatui_ruby/schema/calendar.rb +4 -2
- data/lib/ratatui_ruby/schema/canvas.rb +2 -0
- data/lib/ratatui_ruby/schema/center.rb +2 -0
- data/lib/ratatui_ruby/schema/chart.rb +4 -2
- data/lib/ratatui_ruby/schema/clear.rb +2 -0
- data/lib/ratatui_ruby/schema/constraint.rb +2 -0
- data/lib/ratatui_ruby/schema/cursor.rb +2 -0
- data/lib/ratatui_ruby/schema/draw.rb +2 -0
- data/lib/ratatui_ruby/schema/gauge.rb +4 -2
- data/lib/ratatui_ruby/schema/layout.rb +2 -0
- data/lib/ratatui_ruby/schema/line_gauge.rb +4 -2
- data/lib/ratatui_ruby/schema/list.rb +3 -1
- data/lib/ratatui_ruby/schema/list_item.rb +2 -0
- data/lib/ratatui_ruby/schema/overlay.rb +2 -0
- data/lib/ratatui_ruby/schema/paragraph.rb +2 -0
- data/lib/ratatui_ruby/schema/ratatui_logo.rb +4 -2
- data/lib/ratatui_ruby/schema/ratatui_mascot.rb +4 -2
- data/lib/ratatui_ruby/schema/rect.rb +2 -0
- data/lib/ratatui_ruby/schema/row.rb +2 -0
- data/lib/ratatui_ruby/schema/scrollbar.rb +4 -2
- data/lib/ratatui_ruby/schema/shape/label.rb +2 -0
- data/lib/ratatui_ruby/schema/sparkline.rb +4 -2
- data/lib/ratatui_ruby/schema/style.rb +2 -0
- data/lib/ratatui_ruby/schema/table.rb +2 -0
- data/lib/ratatui_ruby/schema/tabs.rb +4 -2
- data/lib/ratatui_ruby/schema/text.rb +2 -0
- data/lib/ratatui_ruby/scrollbar_state.rb +2 -0
- data/lib/ratatui_ruby/style/style.rb +3 -0
- data/lib/ratatui_ruby/style.rb +2 -0
- data/lib/ratatui_ruby/table_state.rb +2 -0
- data/lib/ratatui_ruby/test_helper/event_injection.rb +2 -0
- data/lib/ratatui_ruby/test_helper/snapshot.rb +62 -21
- data/lib/ratatui_ruby/test_helper/snapshots/axis_labels_alignment.ansi +24 -0
- data/lib/ratatui_ruby/test_helper/snapshots/axis_labels_alignment.txt +24 -0
- data/lib/ratatui_ruby/test_helper/snapshots/barchart_styled_label.ansi +5 -0
- data/lib/ratatui_ruby/test_helper/snapshots/barchart_styled_label.txt +5 -0
- data/lib/ratatui_ruby/test_helper/snapshots/chart_rendering.ansi +24 -0
- data/lib/ratatui_ruby/test_helper/snapshots/chart_rendering.txt +24 -0
- data/lib/ratatui_ruby/test_helper/snapshots/half_block_marker.ansi +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/half_block_marker.txt +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_bottom.ansi +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_bottom.txt +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_left.ansi +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_left.txt +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_right.ansi +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_right.txt +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_top.ansi +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/legend_position_top.txt +12 -0
- data/lib/ratatui_ruby/test_helper/snapshots/my_snapshot.txt +1 -0
- data/lib/ratatui_ruby/test_helper/snapshots/styled_axis_title.ansi +10 -0
- data/lib/ratatui_ruby/test_helper/snapshots/styled_axis_title.txt +10 -0
- data/lib/ratatui_ruby/test_helper/snapshots/styled_dataset_name.ansi +10 -0
- data/lib/ratatui_ruby/test_helper/snapshots/styled_dataset_name.txt +10 -0
- data/lib/ratatui_ruby/test_helper/style_assertions.rb +2 -0
- data/lib/ratatui_ruby/test_helper/terminal.rb +5 -0
- data/lib/ratatui_ruby/test_helper/test_doubles.rb +2 -0
- data/lib/ratatui_ruby/test_helper.rb +6 -4
- data/lib/ratatui_ruby/tui/buffer_factories.rb +2 -0
- data/lib/ratatui_ruby/tui/canvas_factories.rb +2 -0
- data/lib/ratatui_ruby/tui/core.rb +2 -0
- data/lib/ratatui_ruby/tui/layout_factories.rb +2 -0
- data/lib/ratatui_ruby/tui/state_factories.rb +2 -0
- data/lib/ratatui_ruby/tui/style_factories.rb +2 -0
- data/lib/ratatui_ruby/tui/text_factories.rb +2 -0
- data/lib/ratatui_ruby/tui/widget_factories.rb +2 -0
- data/lib/ratatui_ruby/tui.rb +2 -0
- data/lib/ratatui_ruby/version.rb +3 -1
- data/lib/ratatui_ruby/widgets/bar_chart/bar.rb +2 -0
- data/lib/ratatui_ruby/widgets/bar_chart/bar_group.rb +2 -0
- data/lib/ratatui_ruby/widgets/bar_chart.rb +7 -4
- data/lib/ratatui_ruby/widgets/block.rb +46 -2
- data/lib/ratatui_ruby/widgets/calendar.rb +4 -2
- data/lib/ratatui_ruby/widgets/canvas.rb +2 -0
- data/lib/ratatui_ruby/widgets/cell.rb +2 -0
- data/lib/ratatui_ruby/widgets/center.rb +2 -0
- data/lib/ratatui_ruby/widgets/chart.rb +13 -6
- data/lib/ratatui_ruby/widgets/clear.rb +2 -0
- data/lib/ratatui_ruby/widgets/cursor.rb +2 -0
- data/lib/ratatui_ruby/widgets/gauge.rb +4 -2
- data/lib/ratatui_ruby/widgets/line_gauge.rb +4 -2
- data/lib/ratatui_ruby/widgets/list.rb +3 -1
- data/lib/ratatui_ruby/widgets/list_item.rb +2 -0
- data/lib/ratatui_ruby/widgets/overlay.rb +2 -0
- data/lib/ratatui_ruby/widgets/paragraph.rb +2 -0
- data/lib/ratatui_ruby/widgets/ratatui_logo.rb +4 -2
- data/lib/ratatui_ruby/widgets/ratatui_mascot.rb +4 -2
- data/lib/ratatui_ruby/widgets/row.rb +2 -0
- data/lib/ratatui_ruby/widgets/scrollbar.rb +4 -2
- data/lib/ratatui_ruby/widgets/shape/label.rb +2 -0
- data/lib/ratatui_ruby/widgets/sparkline.rb +7 -4
- data/lib/ratatui_ruby/widgets/table.rb +2 -0
- data/lib/ratatui_ruby/widgets/tabs.rb +12 -8
- data/lib/ratatui_ruby/widgets.rb +2 -0
- data/lib/ratatui_ruby.rb +130 -9
- data/tasks/autodoc/examples.rb +2 -0
- data/tasks/autodoc/member.rb +2 -0
- data/tasks/autodoc/name.rb +2 -0
- data/tasks/autodoc.rake +2 -0
- data/tasks/bump/cargo_lockfile.rb +2 -0
- data/tasks/bump/changelog.rb +2 -0
- data/tasks/bump/header.rb +2 -0
- data/tasks/bump/history.rb +2 -0
- data/tasks/bump/links.rb +2 -0
- data/tasks/bump/manifest.rb +2 -0
- data/tasks/bump/ruby_gem.rb +2 -0
- data/tasks/bump/sem_ver.rb +2 -0
- data/tasks/bump/unreleased_section.rb +2 -0
- data/tasks/bump.rake +2 -0
- data/tasks/doc.rake +268 -0
- data/tasks/extension.rake +2 -0
- data/tasks/lint.rake +115 -0
- data/tasks/rdoc_config.rb +18 -4
- data/tasks/sourcehut.rake +2 -0
- data/tasks/terminal_preview/app_screenshot.rb +2 -0
- data/tasks/terminal_preview/crash_report.rb +2 -0
- data/tasks/terminal_preview/example_app.rb +2 -0
- data/tasks/terminal_preview/launcher_script.rb +2 -0
- data/tasks/terminal_preview/preview_collection.rb +2 -0
- data/tasks/terminal_preview/preview_timing.rb +2 -0
- data/tasks/terminal_preview/safety_confirmation.rb +2 -0
- data/tasks/terminal_preview/saved_screenshot.rb +2 -0
- data/tasks/terminal_preview/system_appearance.rb +2 -0
- data/tasks/terminal_preview/terminal_window.rb +2 -0
- data/tasks/terminal_preview/window_id.rb +2 -0
- data/tasks/terminal_preview.rake +2 -0
- data/tasks/test.rake +2 -0
- data/tasks/website/index_page.rb +2 -0
- data/tasks/website/version.rb +12 -2
- data/tasks/website/version_menu.rb +2 -0
- data/tasks/website/versioned_documentation.rb +2 -0
- data/tasks/website/website.rb +2 -0
- data/tasks/website.rake +2 -0
- metadata +97 -75
- data/doc/contributors/architectural_overhaul/chat_conversations.md +0 -4952
- data/doc/contributors/architectural_overhaul/implementation_plan.md +0 -60
- data/doc/contributors/architectural_overhaul/task.md +0 -37
- /data/doc/{async.md → concepts/async.md} +0 -0
- /data/doc/{interactive_design.md → concepts/interactive_design.md} +0 -0
- /data/doc/images/{widget_barchart_demo.png → widget_barchart.png} +0 -0
- /data/doc/images/{widget_block_demo.png → widget_block.png} +0 -0
- /data/doc/images/{widget_box_demo.png → widget_box.png} +0 -0
- /data/doc/images/{widget_calendar_demo.png → widget_calendar.png} +0 -0
- /data/doc/images/{widget_canvas_demo.png → widget_canvas.png} +0 -0
- /data/doc/images/{widget_cell_demo.png → widget_cell.png} +0 -0
- /data/doc/images/{widget_center_demo.png → widget_center.png} +0 -0
- /data/doc/images/{widget_chart_demo.png → widget_chart.png} +0 -0
- /data/doc/images/{widget_gauge_demo.png → widget_gauge.png} +0 -0
- /data/doc/images/{widget_line_gauge_demo.png → widget_line_gauge.png} +0 -0
- /data/doc/images/{widget_list_demo.png → widget_list.png} +0 -0
- /data/doc/images/{widget_map_demo.png → widget_map.png} +0 -0
- /data/doc/images/{widget_overlay_demo.png → widget_overlay.png} +0 -0
- /data/doc/images/{widget_popup_demo.png → widget_popup.png} +0 -0
- /data/doc/images/{widget_ratatui_logo_demo.png → widget_ratatui_logo.png} +0 -0
- /data/doc/images/{widget_ratatui_mascot_demo.png → widget_ratatui_mascot.png} +0 -0
- /data/doc/images/{widget_scrollbar_demo.png → widget_scrollbar.png} +0 -0
- /data/doc/images/{widget_sparkline_demo.png → widget_sparkline.png} +0 -0
- /data/doc/images/{widget_table_demo.png → widget_table.png} +0 -0
- /data/doc/images/{widget_tabs_demo.png → widget_tabs.png} +0 -0
- /data/doc/{v0.7.0_migration.md → migration/v0_7_0.md} +0 -0
- /data/doc/{debugging.md → troubleshooting/debugging.md} +0 -0
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
|
|
3
|
+
SPDX-License-Identifier: CC-BY-SA-4.0
|
|
4
|
+
-->
|
|
5
|
+
|
|
6
|
+
# Feature Request: Expose Tabs Title Rects
|
|
7
|
+
|
|
8
|
+
## Summary
|
|
9
|
+
|
|
10
|
+
`Tabs` computes the bounding rect for each tab title during rendering but does not expose this information. Interactive applications need these rects for mouse click hit-testing.
|
|
11
|
+
|
|
12
|
+
## The Problem
|
|
13
|
+
|
|
14
|
+
Building clickable tab interfaces requires knowing where each tab renders. When a user clicks within the tabs area, the application cannot determine which specific tab was clicked without duplicating the internal layout algorithm.
|
|
15
|
+
|
|
16
|
+
Currently, the only options are:
|
|
17
|
+
|
|
18
|
+
1. **Recompute the layout manually.** Duplicate the logic from `render_tabs`, accounting for padding, dividers, and title widths. This is fragile—any upstream change breaks the user's code.
|
|
19
|
+
2. **Use coarse hit-testing.** Check if a click is anywhere in the tabs area, then guess based on x-position. This breaks when titles have different widths or styled content.
|
|
20
|
+
|
|
21
|
+
Neither approach is satisfactory.
|
|
22
|
+
|
|
23
|
+
## Use Case
|
|
24
|
+
|
|
25
|
+
Consider a TUI with a tabbed interface:
|
|
26
|
+
|
|
27
|
+
```
|
|
28
|
+
┌Announce v0.7.3───────────────────────────────emate┐
|
|
29
|
+
│ Preview Email ▸ Preview Commit ▸ Announce │
|
|
30
|
+
│ │
|
|
31
|
+
└───────────────────────────────────────────────────┘
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
The application wants to detect clicks on individual tab titles (`"Preview Email"`, `"Preview Commit"`, `"Announce"`) and switch to that tab.
|
|
35
|
+
|
|
36
|
+
Without title rects, the application must manually compute where each tab renders:
|
|
37
|
+
|
|
38
|
+
```rust
|
|
39
|
+
// Manual calculation - fragile and duplicates internal logic
|
|
40
|
+
let divider_width = 3; // " ▸ " is 3 characters
|
|
41
|
+
let content_row = area.y + 1; // Skip top border
|
|
42
|
+
let mut x = area.x + 2; // Skip border + padding
|
|
43
|
+
|
|
44
|
+
let tab_rects: Vec<Rect> = titles.iter().map(|title| {
|
|
45
|
+
let tab_width = title.len() as u16;
|
|
46
|
+
let rect = Rect::new(x, content_row, tab_width, 1);
|
|
47
|
+
x += tab_width + divider_width;
|
|
48
|
+
rect
|
|
49
|
+
}).collect();
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
This duplicates private logic from `Tabs::render_tabs` and breaks when:
|
|
53
|
+
|
|
54
|
+
- Padding is configured differently (`padding_left`, `padding_right`)
|
|
55
|
+
- Divider width changes
|
|
56
|
+
- Upstream layout logic changes
|
|
57
|
+
- A block is present (affects inner area calculation)
|
|
58
|
+
|
|
59
|
+
## Current State (v0.30.0)
|
|
60
|
+
|
|
61
|
+
`Tabs` has a private `render_tabs` method that computes title areas:
|
|
62
|
+
|
|
63
|
+
```rust
|
|
64
|
+
// From src/widgets/tabs.rs - private rendering logic
|
|
65
|
+
fn render_tabs(&self, tabs_area: Rect, buf: &mut Buffer) {
|
|
66
|
+
let mut x = tabs_area.left();
|
|
67
|
+
for (i, title) in self.titles.iter().enumerate() {
|
|
68
|
+
// ...padding and title rendering...
|
|
69
|
+
|
|
70
|
+
// Title rect is computed here but not exposed
|
|
71
|
+
if Some(i) == self.selected {
|
|
72
|
+
buf.set_style(
|
|
73
|
+
Rect {
|
|
74
|
+
x,
|
|
75
|
+
y: tabs_area.top(),
|
|
76
|
+
width: pos.0.saturating_sub(x),
|
|
77
|
+
height: 1,
|
|
78
|
+
},
|
|
79
|
+
self.highlight_style,
|
|
80
|
+
);
|
|
81
|
+
}
|
|
82
|
+
// ...
|
|
83
|
+
}
|
|
84
|
+
}
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
The rect is computed for applying `highlight_style` but is not accessible to users.
|
|
88
|
+
|
|
89
|
+
## Proposed API
|
|
90
|
+
|
|
91
|
+
Following the pattern established by `Block::inner(area)`, add a pure computation method that takes an area and returns computed sub-rects without rendering:
|
|
92
|
+
|
|
93
|
+
```rust
|
|
94
|
+
impl Tabs {
|
|
95
|
+
/// Returns the bounding rect for each tab title given an area.
|
|
96
|
+
///
|
|
97
|
+
/// The rects are returned in the same order as titles were added.
|
|
98
|
+
/// Useful for hit-testing mouse clicks against specific tabs.
|
|
99
|
+
///
|
|
100
|
+
/// # Example
|
|
101
|
+
///
|
|
102
|
+
/// ```rust
|
|
103
|
+
/// let tabs = Tabs::new(["Tab 1", "Tab 2", "Tab 3"])
|
|
104
|
+
/// .divider(" | ");
|
|
105
|
+
///
|
|
106
|
+
/// let rects = tabs.title_rects(area);
|
|
107
|
+
/// for (i, rect) in rects.iter().enumerate() {
|
|
108
|
+
/// if rect.contains(mouse_position) {
|
|
109
|
+
/// selected_tab = i;
|
|
110
|
+
/// break;
|
|
111
|
+
/// }
|
|
112
|
+
/// }
|
|
113
|
+
/// ```
|
|
114
|
+
pub fn title_rects(&self, area: Rect) -> Vec<Rect> { ... }
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
Alternatively, a single-lookup method:
|
|
119
|
+
|
|
120
|
+
```rust
|
|
121
|
+
/// Returns the rect for the tab at the given index.
|
|
122
|
+
pub fn title_rect(&self, area: Rect, index: usize) -> Option<Rect> { ... }
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Workaround
|
|
126
|
+
|
|
127
|
+
Without this API, users must replicate the tab layout algorithm. Here is the current approach used in RatatuiRuby:
|
|
128
|
+
|
|
129
|
+
```rust
|
|
130
|
+
// Manually compute tab title positions
|
|
131
|
+
let divider_width = 3; // " ▸ " is 3 characters
|
|
132
|
+
let content_row = area.y + 1; // Skip top border
|
|
133
|
+
let mut x = area.x + 2; // Skip left border + padding
|
|
134
|
+
|
|
135
|
+
let tab_rects: Vec<Rect> = TABS.iter().map(|title| {
|
|
136
|
+
let tab_width = title.len() as u16;
|
|
137
|
+
let rect = Rect::new(x, content_row, tab_width, 1);
|
|
138
|
+
x += tab_width + divider_width;
|
|
139
|
+
rect
|
|
140
|
+
}).collect();
|
|
141
|
+
|
|
142
|
+
// Hit testing
|
|
143
|
+
for (i, rect) in tab_rects.iter().enumerate() {
|
|
144
|
+
if rect.contains(click_position) {
|
|
145
|
+
current_tab = i;
|
|
146
|
+
break;
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
This works for simple cases but breaks when:
|
|
152
|
+
|
|
153
|
+
- `padding_left` or `padding_right` are non-default
|
|
154
|
+
- The divider is styled (Span width differs from string length)
|
|
155
|
+
- A block wraps the tabs (inner area differs)
|
|
156
|
+
- Title text is styled (Line width differs from string length)
|
|
157
|
+
|
|
158
|
+
## Impact
|
|
159
|
+
|
|
160
|
+
This feature benefits any application with clickable tabs:
|
|
161
|
+
|
|
162
|
+
- Tab-based navigation interfaces
|
|
163
|
+
- Multi-panel applications with panel selectors
|
|
164
|
+
- Mode switchers (edit/view/preview)
|
|
165
|
+
- Category selectors
|
|
166
|
+
|
|
167
|
+
The `Tabs` widget is commonly used for navigation. Mouse interaction is a natural expectation for TUI applications running in modern terminals with mouse support.
|
|
168
|
+
|
|
169
|
+
---
|
|
170
|
+
|
|
171
|
+
This issue includes creative contributions from Claude (Anthropic) via Antigravity (Google). [https://declare-ai.org/1.0.0/creative.html](https://declare-ai.org/1.0.0/creative.html)
|
|
172
|
+
|
|
173
|
+
*Discovered while implementing click handling for tab navigation in RatatuiRuby.*
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
|
|
3
|
+
SPDX-License-Identifier: CC-BY-SA-4.0
|
|
4
|
+
-->
|
|
5
|
+
|
|
6
|
+
# Feature Request: Expose Block Title Rects
|
|
7
|
+
|
|
8
|
+
## Summary
|
|
9
|
+
|
|
10
|
+
`Block` computes the position of each title during rendering but does not expose this information. Interactive applications need title rects for mouse click hit-testing.
|
|
11
|
+
|
|
12
|
+
## The Problem
|
|
13
|
+
|
|
14
|
+
Building clickable TUI interfaces requires knowing where widgets render. When a block has multiple titles (e.g., a left-aligned title and a right-aligned toggle label), each title occupies a specific screen region. The application cannot query these regions.
|
|
15
|
+
|
|
16
|
+
Currently, the only options are:
|
|
17
|
+
|
|
18
|
+
1. **Recompute the layout manually.** Duplicate the logic from `render_left_titles`, `render_right_titles`, and `render_center_titles`. This is fragile—any upstream change breaks the user's code.
|
|
19
|
+
2. **Use coarse hit-testing.** Check if a click is anywhere in the block's top border row. This cannot distinguish between multiple titles.
|
|
20
|
+
|
|
21
|
+
Neither approach is satisfactory.
|
|
22
|
+
|
|
23
|
+
## Use Case
|
|
24
|
+
|
|
25
|
+
Consider a TUI with a tabbed interface where the block's title bar contains:
|
|
26
|
+
|
|
27
|
+
- A left-aligned title: `"Announce v0.7.3"`
|
|
28
|
+
- A right-aligned toggle: `"emate"` (clickable to switch email clients)
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
┌Announce v0.7.3───────────────────────────────emate┐
|
|
32
|
+
│ Preview Email ▸ Preview Commit ▸ Announce │
|
|
33
|
+
│ │
|
|
34
|
+
└───────────────────────────────────────────────────┘
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
The application wants to:
|
|
38
|
+
|
|
39
|
+
1. Detect clicks on `"emate"` and toggle the email client
|
|
40
|
+
2. Detect clicks on tab names and switch tabs
|
|
41
|
+
3. Ignore clicks on the border characters
|
|
42
|
+
|
|
43
|
+
Without title rects, the application must manually compute where `"emate"` renders based on block width, borders, alignment, and title content. This duplicates private logic from `Block::render_right_titles`.
|
|
44
|
+
|
|
45
|
+
## Current State (v0.30.0)
|
|
46
|
+
|
|
47
|
+
`Block` has private methods that compute title areas:
|
|
48
|
+
|
|
49
|
+
```rust
|
|
50
|
+
// Private - not accessible to users
|
|
51
|
+
fn titles_area(&self, area: Rect, position: Position) -> Rect { ... }
|
|
52
|
+
fn render_left_titles(&self, position: Position, area: Rect, buf: &mut Buffer) { ... }
|
|
53
|
+
fn render_center_titles(&self, position: Position, area: Rect, buf: &mut Buffer) { ... }
|
|
54
|
+
fn render_right_titles(&self, position: Position, area: Rect, buf: &mut Buffer) { ... }
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
The `titles_area` method computes the general title region. The `render_*_titles` methods compute individual title rects during rendering but do not expose them.
|
|
58
|
+
|
|
59
|
+
## Proposed API
|
|
60
|
+
|
|
61
|
+
Following the pattern established by `Block::inner(area)`, add a pure computation method that takes an area and returns computed sub-rects without rendering:
|
|
62
|
+
|
|
63
|
+
```rust
|
|
64
|
+
impl Block {
|
|
65
|
+
/// Returns the bounding rect for each title given an area.
|
|
66
|
+
///
|
|
67
|
+
/// The rects are returned in the same order as titles were added.
|
|
68
|
+
/// Useful for hit-testing mouse clicks against specific titles.
|
|
69
|
+
///
|
|
70
|
+
/// # Example
|
|
71
|
+
///
|
|
72
|
+
/// ```rust
|
|
73
|
+
/// let block = Block::bordered()
|
|
74
|
+
/// .title_top("Left Title")
|
|
75
|
+
/// .title_top(Line::from("Right").right_aligned());
|
|
76
|
+
///
|
|
77
|
+
/// let rects = block.title_rects(area);
|
|
78
|
+
/// if rects[1].contains(mouse_position) {
|
|
79
|
+
/// // Clicked on "Right"
|
|
80
|
+
/// }
|
|
81
|
+
/// ```
|
|
82
|
+
pub fn title_rects(&self, area: Rect) -> Vec<Rect> { ... }
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Alternatively, expose the individual areas by alignment:
|
|
87
|
+
|
|
88
|
+
```rust
|
|
89
|
+
/// Returns the rect for the title at the given index.
|
|
90
|
+
pub fn title_rect(&self, area: Rect, index: usize) -> Option<Rect> { ... }
|
|
91
|
+
|
|
92
|
+
/// Returns the titles area for a given position (top or bottom).
|
|
93
|
+
pub fn titles_area(&self, area: Rect, position: Position) -> Rect { ... }
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Workaround
|
|
97
|
+
|
|
98
|
+
Without this API, users must replicate the title layout algorithm. Here is the current approach used in RatatuiRuby:
|
|
99
|
+
|
|
100
|
+
```rust
|
|
101
|
+
// Manually compute right-aligned title position
|
|
102
|
+
let email_label_width = email_client.len() as u16;
|
|
103
|
+
let email_label_x = area.x + area.width - email_label_width - 2; // border + padding
|
|
104
|
+
let email_label_rect = Rect::new(email_label_x, area.y, email_label_width, 1);
|
|
105
|
+
|
|
106
|
+
if email_label_rect.contains(click_position) {
|
|
107
|
+
toggle_email_client();
|
|
108
|
+
}
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
This works for simple cases but breaks when:
|
|
112
|
+
|
|
113
|
+
- Borders are not all present (`Borders::LEFT` affects x offset)
|
|
114
|
+
- Multiple right-aligned titles exist (spacing affects position)
|
|
115
|
+
- Upstream layout logic changes
|
|
116
|
+
|
|
117
|
+
## Impact
|
|
118
|
+
|
|
119
|
+
This feature benefits any application with interactive block titles:
|
|
120
|
+
|
|
121
|
+
- Clickable tabs in title bars
|
|
122
|
+
- Toggle buttons in headers
|
|
123
|
+
- Breadcrumb navigation
|
|
124
|
+
- Window controls (minimize/maximize/close buttons in the title area)
|
|
125
|
+
|
|
126
|
+
Related discussion: [ratatui#738](https://github.com/ratatui/ratatui/issues/738) (title positioning behavior)
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
This issue includes creative contributions from Claude (Anthropic) via Antigravity (Google). [https://declare-ai.org/1.0.0/creative.html](https://declare-ai.org/1.0.0/creative.html)
|
|
131
|
+
|
|
132
|
+
*Discovered while implementing click handling for block title toggles in RatatuiRuby.*
|