ratatui_ruby 0.5.0 → 0.7.0
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 +10 -4
- data/CHANGELOG.md +79 -7
- data/README.md +37 -5
- data/REUSE.toml +2 -7
- data/doc/application_architecture.md +96 -22
- data/doc/application_testing.md +76 -30
- data/doc/contributors/architectural_overhaul/chat_conversations.md +4952 -0
- data/doc/contributors/architectural_overhaul/implementation_plan.md +60 -0
- data/doc/contributors/architectural_overhaul/task.md +37 -0
- data/doc/contributors/design/ruby_frontend.md +288 -56
- data/doc/contributors/design/rust_backend.md +349 -54
- data/doc/contributors/developing_examples.md +134 -49
- data/doc/contributors/index.md +7 -5
- data/doc/contributors/v1.0.0_blockers.md +1729 -0
- data/doc/event_handling.md +11 -3
- data/doc/images/app_all_events.png +0 -0
- data/doc/images/app_color_picker.png +0 -0
- data/doc/images/app_login_form.png +0 -0
- data/doc/images/app_stateful_interaction.png +0 -0
- data/doc/images/verify_quickstart_dsl.png +0 -0
- data/doc/images/verify_quickstart_layout.png +0 -0
- data/doc/images/verify_quickstart_lifecycle.png +0 -0
- data/doc/images/verify_readme_usage.png +0 -0
- data/doc/images/widget_barchart_demo.png +0 -0
- data/doc/images/widget_block_demo.png +0 -0
- data/doc/images/widget_canvas_demo.png +0 -0
- data/doc/images/widget_cell_demo.png +0 -0
- data/doc/images/widget_center_demo.png +0 -0
- data/doc/images/widget_chart_demo.png +0 -0
- data/doc/images/widget_list_demo.png +0 -0
- data/doc/images/widget_overlay_demo.png +0 -0
- data/doc/images/widget_render.png +0 -0
- data/doc/images/widget_rich_text.png +0 -0
- data/doc/images/widget_scroll_text.png +0 -0
- data/doc/images/widget_sparkline_demo.png +0 -0
- data/doc/images/widget_table_demo.png +0 -0
- data/doc/images/widget_tabs_demo.png +0 -0
- data/doc/images/widget_text_width.png +0 -0
- data/doc/index.md +11 -6
- data/doc/interactive_design.md +2 -2
- data/doc/quickstart.md +127 -165
- data/doc/terminal_limitations.md +92 -0
- data/doc/v0.7.0_migration.md +236 -0
- data/doc/why.md +93 -0
- data/examples/app_all_events/README.md +47 -27
- data/examples/app_all_events/app.rb +38 -35
- data/examples/app_all_events/model/app_model.rb +157 -0
- data/examples/app_all_events/model/event_entry.rb +17 -0
- data/examples/app_all_events/model/msg.rb +37 -0
- data/examples/app_all_events/update.rb +73 -0
- data/examples/app_all_events/view/app_view.rb +9 -9
- data/examples/app_all_events/view/controls_view.rb +9 -7
- data/examples/app_all_events/view/counts_view.rb +13 -9
- data/examples/app_all_events/view/live_view.rb +9 -8
- data/examples/app_all_events/view/log_view.rb +11 -16
- data/examples/app_color_picker/README.md +84 -42
- data/examples/app_color_picker/app.rb +24 -62
- data/examples/app_color_picker/controls.rb +90 -0
- data/examples/app_color_picker/copy_dialog.rb +45 -49
- data/examples/app_color_picker/export_pane.rb +126 -0
- data/examples/app_color_picker/input.rb +99 -67
- data/examples/app_color_picker/main_container.rb +178 -0
- data/examples/app_color_picker/palette.rb +55 -26
- data/examples/app_login_form/README.md +49 -0
- data/examples/app_login_form/app.rb +2 -3
- data/examples/app_stateful_interaction/README.md +33 -0
- data/examples/app_stateful_interaction/app.rb +272 -0
- data/examples/timeout_demo.rb +43 -0
- data/examples/verify_quickstart_dsl/README.md +49 -0
- data/examples/verify_quickstart_dsl/app.rb +2 -0
- data/examples/verify_quickstart_layout/README.md +71 -0
- data/examples/verify_quickstart_layout/app.rb +2 -0
- data/examples/verify_quickstart_lifecycle/README.md +56 -0
- data/examples/verify_quickstart_lifecycle/app.rb +10 -4
- data/examples/verify_readme_usage/README.md +43 -0
- data/examples/verify_readme_usage/app.rb +8 -2
- data/examples/widget_barchart_demo/README.md +50 -0
- data/examples/widget_barchart_demo/app.rb +5 -5
- data/examples/widget_block_demo/README.md +36 -0
- data/examples/widget_block_demo/app.rb +256 -0
- data/examples/widget_box_demo/README.md +45 -0
- data/examples/widget_calendar_demo/README.md +39 -0
- data/examples/widget_calendar_demo/app.rb +5 -1
- data/examples/widget_canvas_demo/README.md +27 -0
- data/examples/widget_canvas_demo/app.rb +123 -0
- data/examples/widget_cell_demo/README.md +36 -0
- data/examples/widget_cell_demo/app.rb +31 -24
- data/examples/widget_center_demo/README.md +29 -0
- data/examples/widget_center_demo/app.rb +116 -0
- data/examples/widget_chart_demo/README.md +41 -0
- data/examples/widget_chart_demo/app.rb +7 -2
- data/examples/widget_gauge_demo/README.md +41 -0
- data/examples/widget_layout_split/README.md +44 -0
- data/examples/widget_line_gauge_demo/README.md +41 -0
- data/examples/widget_list_demo/README.md +49 -0
- data/examples/widget_list_demo/app.rb +91 -107
- data/examples/widget_map_demo/README.md +39 -0
- data/examples/{app_map_demo → widget_map_demo}/app.rb +4 -4
- data/examples/widget_overlay_demo/README.md +36 -0
- data/examples/widget_overlay_demo/app.rb +248 -0
- data/examples/widget_popup_demo/README.md +36 -0
- data/examples/widget_ratatui_logo_demo/README.md +34 -0
- data/examples/widget_ratatui_logo_demo/app.rb +1 -1
- data/examples/widget_ratatui_mascot_demo/README.md +34 -0
- data/examples/widget_rect/README.md +38 -0
- data/examples/widget_render/README.md +37 -0
- data/examples/widget_render/app.rb +3 -3
- data/examples/widget_rich_text/README.md +35 -0
- data/examples/widget_rich_text/app.rb +62 -33
- data/examples/widget_scroll_text/README.md +37 -0
- data/examples/widget_scroll_text/app.rb +0 -1
- data/examples/widget_scrollbar_demo/README.md +37 -0
- data/examples/widget_sparkline_demo/README.md +42 -0
- data/examples/widget_sparkline_demo/app.rb +4 -3
- data/examples/widget_style_colors/README.md +34 -0
- data/examples/widget_table_demo/README.md +48 -0
- data/examples/{app_table_select → widget_table_demo}/app.rb +65 -12
- data/examples/widget_tabs_demo/README.md +41 -0
- data/examples/widget_tabs_demo/app.rb +15 -1
- data/examples/widget_text_width/README.md +35 -0
- data/examples/widget_text_width/app.rb +113 -0
- data/exe/.gitkeep +0 -0
- data/ext/ratatui_ruby/Cargo.lock +11 -4
- data/ext/ratatui_ruby/Cargo.toml +2 -1
- data/ext/ratatui_ruby/src/events.rs +238 -26
- data/ext/ratatui_ruby/src/frame.rs +116 -3
- data/ext/ratatui_ruby/src/lib.rs +37 -6
- data/ext/ratatui_ruby/src/rendering.rs +22 -21
- data/ext/ratatui_ruby/src/string_width.rs +101 -0
- data/ext/ratatui_ruby/src/terminal.rs +39 -15
- data/ext/ratatui_ruby/src/text.rs +13 -4
- data/ext/ratatui_ruby/src/widgets/barchart.rs +24 -6
- data/ext/ratatui_ruby/src/widgets/canvas.rs +5 -5
- data/ext/ratatui_ruby/src/widgets/gauge.rs +9 -2
- data/ext/ratatui_ruby/src/widgets/line_gauge.rs +9 -2
- data/ext/ratatui_ruby/src/widgets/list.rs +179 -3
- data/ext/ratatui_ruby/src/widgets/list_state.rs +137 -0
- data/ext/ratatui_ruby/src/widgets/mod.rs +3 -0
- data/ext/ratatui_ruby/src/widgets/scrollbar.rs +93 -1
- data/ext/ratatui_ruby/src/widgets/scrollbar_state.rs +169 -0
- data/ext/ratatui_ruby/src/widgets/table.rs +191 -34
- data/ext/ratatui_ruby/src/widgets/table_state.rs +121 -0
- data/lib/ratatui_ruby/buffer/cell.rb +168 -0
- data/lib/ratatui_ruby/buffer.rb +15 -0
- data/lib/ratatui_ruby/cell.rb +4 -4
- data/lib/ratatui_ruby/event/key/character.rb +35 -0
- data/lib/ratatui_ruby/event/key/media.rb +44 -0
- data/lib/ratatui_ruby/event/key/modifier.rb +95 -0
- data/lib/ratatui_ruby/event/key/navigation.rb +55 -0
- data/lib/ratatui_ruby/event/key/system.rb +45 -0
- data/lib/ratatui_ruby/event/key.rb +111 -51
- data/lib/ratatui_ruby/event/mouse.rb +3 -3
- data/lib/ratatui_ruby/event/paste.rb +1 -1
- data/lib/ratatui_ruby/frame.rb +100 -4
- data/lib/ratatui_ruby/layout/constraint.rb +95 -0
- data/lib/ratatui_ruby/layout/layout.rb +106 -0
- data/lib/ratatui_ruby/layout/rect.rb +118 -0
- data/lib/ratatui_ruby/layout.rb +19 -0
- data/lib/ratatui_ruby/list_state.rb +88 -0
- data/lib/ratatui_ruby/schema/bar_chart/bar.rb +2 -2
- data/lib/ratatui_ruby/schema/cursor.rb +5 -0
- data/lib/ratatui_ruby/schema/gauge.rb +3 -1
- data/lib/ratatui_ruby/schema/layout.rb +1 -1
- data/lib/ratatui_ruby/schema/line_gauge.rb +2 -2
- data/lib/ratatui_ruby/schema/list.rb +25 -4
- data/lib/ratatui_ruby/schema/list_item.rb +41 -0
- data/lib/ratatui_ruby/schema/rect.rb +43 -0
- data/lib/ratatui_ruby/schema/row.rb +66 -0
- data/lib/ratatui_ruby/schema/style.rb +24 -4
- data/lib/ratatui_ruby/schema/table.rb +29 -11
- data/lib/ratatui_ruby/schema/text.rb +96 -3
- data/lib/ratatui_ruby/scrollbar_state.rb +112 -0
- data/lib/ratatui_ruby/style/style.rb +81 -0
- data/lib/ratatui_ruby/style.rb +15 -0
- data/lib/ratatui_ruby/table_state.rb +90 -0
- data/lib/ratatui_ruby/test_helper/event_injection.rb +169 -0
- data/lib/ratatui_ruby/test_helper/snapshot.rb +414 -0
- data/lib/ratatui_ruby/test_helper/style_assertions.rb +351 -0
- data/lib/ratatui_ruby/test_helper/terminal.rb +127 -0
- data/lib/ratatui_ruby/test_helper/test_doubles.rb +68 -0
- data/lib/ratatui_ruby/test_helper.rb +65 -358
- data/lib/ratatui_ruby/tui/buffer_factories.rb +20 -0
- data/lib/ratatui_ruby/tui/canvas_factories.rb +44 -0
- data/lib/ratatui_ruby/tui/core.rb +38 -0
- data/lib/ratatui_ruby/tui/layout_factories.rb +74 -0
- data/lib/ratatui_ruby/tui/state_factories.rb +33 -0
- data/lib/ratatui_ruby/tui/style_factories.rb +20 -0
- data/lib/ratatui_ruby/tui/text_factories.rb +44 -0
- data/lib/ratatui_ruby/tui/widget_factories.rb +195 -0
- data/lib/ratatui_ruby/tui.rb +75 -0
- data/lib/ratatui_ruby/version.rb +1 -1
- data/lib/ratatui_ruby/widgets/bar_chart/bar.rb +47 -0
- data/lib/ratatui_ruby/widgets/bar_chart/bar_group.rb +25 -0
- data/lib/ratatui_ruby/widgets/bar_chart.rb +239 -0
- data/lib/ratatui_ruby/widgets/block.rb +192 -0
- data/lib/ratatui_ruby/widgets/calendar.rb +84 -0
- data/lib/ratatui_ruby/widgets/canvas.rb +231 -0
- data/lib/ratatui_ruby/widgets/cell.rb +47 -0
- data/lib/ratatui_ruby/widgets/center.rb +59 -0
- data/lib/ratatui_ruby/widgets/chart.rb +185 -0
- data/lib/ratatui_ruby/widgets/clear.rb +54 -0
- data/lib/ratatui_ruby/widgets/cursor.rb +42 -0
- data/lib/ratatui_ruby/widgets/gauge.rb +72 -0
- data/lib/ratatui_ruby/widgets/line_gauge.rb +80 -0
- data/lib/ratatui_ruby/widgets/list.rb +127 -0
- data/lib/ratatui_ruby/widgets/list_item.rb +43 -0
- data/lib/ratatui_ruby/widgets/overlay.rb +43 -0
- data/lib/ratatui_ruby/widgets/paragraph.rb +99 -0
- data/lib/ratatui_ruby/widgets/ratatui_logo.rb +31 -0
- data/lib/ratatui_ruby/widgets/ratatui_mascot.rb +36 -0
- data/lib/ratatui_ruby/widgets/row.rb +68 -0
- data/lib/ratatui_ruby/widgets/scrollbar.rb +143 -0
- data/lib/ratatui_ruby/widgets/shape/label.rb +68 -0
- data/lib/ratatui_ruby/widgets/sparkline.rb +134 -0
- data/lib/ratatui_ruby/widgets/table.rb +141 -0
- data/lib/ratatui_ruby/widgets/tabs.rb +85 -0
- data/lib/ratatui_ruby/widgets.rb +40 -0
- data/lib/ratatui_ruby.rb +64 -57
- data/sig/examples/app_all_events/view.rbs +1 -1
- data/sig/examples/app_all_events/view_state.rbs +1 -1
- data/sig/examples/app_stateful_interaction/app.rbs +33 -0
- data/sig/examples/widget_block_demo/app.rbs +32 -0
- data/sig/examples/{app_map_demo → widget_map_demo}/app.rbs +2 -2
- data/sig/examples/{app_table_select → widget_table_demo}/app.rbs +2 -2
- data/sig/examples/{widget_table_flex → widget_text_width}/app.rbs +2 -3
- data/sig/ratatui_ruby/event.rbs +11 -1
- data/sig/ratatui_ruby/frame.rbs +2 -0
- data/sig/ratatui_ruby/list_state.rbs +13 -0
- data/sig/ratatui_ruby/ratatui_ruby.rbs +2 -2
- data/sig/ratatui_ruby/schema/bar_chart/bar.rbs +3 -3
- data/sig/ratatui_ruby/schema/gauge.rbs +2 -2
- data/sig/ratatui_ruby/schema/line_gauge.rbs +2 -2
- data/sig/ratatui_ruby/schema/list.rbs +4 -2
- data/sig/ratatui_ruby/schema/list_item.rbs +10 -0
- data/sig/ratatui_ruby/schema/rect.rbs +3 -0
- data/sig/ratatui_ruby/schema/row.rbs +22 -0
- data/sig/ratatui_ruby/schema/style.rbs +3 -3
- data/sig/ratatui_ruby/schema/table.rbs +3 -1
- data/sig/ratatui_ruby/schema/text.rbs +9 -6
- data/sig/ratatui_ruby/scrollbar_state.rbs +18 -0
- data/sig/ratatui_ruby/session.rbs +41 -48
- data/sig/ratatui_ruby/table_state.rbs +15 -0
- data/sig/ratatui_ruby/test_helper/event_injection.rbs +16 -0
- data/sig/ratatui_ruby/test_helper/snapshot.rbs +12 -0
- data/sig/ratatui_ruby/test_helper/style_assertions.rbs +64 -0
- data/sig/ratatui_ruby/test_helper/terminal.rbs +14 -0
- data/sig/ratatui_ruby/test_helper/test_doubles.rbs +22 -0
- data/sig/ratatui_ruby/test_helper.rbs +5 -4
- data/sig/ratatui_ruby/tui/buffer_factories.rbs +10 -0
- data/sig/ratatui_ruby/tui/canvas_factories.rbs +14 -0
- data/sig/ratatui_ruby/tui/core.rbs +14 -0
- data/sig/ratatui_ruby/tui/layout_factories.rbs +19 -0
- data/sig/ratatui_ruby/tui/state_factories.rbs +12 -0
- data/sig/ratatui_ruby/tui/style_factories.rbs +10 -0
- data/sig/ratatui_ruby/tui/text_factories.rbs +14 -0
- data/sig/ratatui_ruby/tui/widget_factories.rbs +39 -0
- data/sig/ratatui_ruby/tui.rbs +19 -0
- data/tasks/autodoc/examples.rb +79 -0
- data/tasks/autodoc.rake +7 -35
- data/tasks/bump/changelog.rb +3 -3
- data/tasks/bump/links.rb +67 -0
- data/tasks/sourcehut.rake +64 -21
- data/tasks/terminal_preview/app_screenshot.rb +13 -3
- data/tasks/terminal_preview/saved_screenshot.rb +4 -3
- metadata +169 -48
- data/doc/contributors/dwim_dx.md +0 -366
- data/doc/images/app_analytics.png +0 -0
- data/doc/images/app_custom_widget.png +0 -0
- data/doc/images/app_mouse_events.png +0 -0
- data/doc/images/app_table_select.png +0 -0
- data/doc/images/widget_block_padding.png +0 -0
- data/doc/images/widget_block_titles.png +0 -0
- data/doc/images/widget_list_styles.png +0 -0
- data/doc/images/widget_table_flex.png +0 -0
- data/examples/app_all_events/model/events.rb +0 -180
- data/examples/app_all_events/model/highlight.rb +0 -57
- data/examples/app_all_events/test/snapshots/after_focus_lost.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_focus_regained.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_horizontal_resize.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_key_a.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_key_ctrl_x.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_mouse_click.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_mouse_drag.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_multiple_events.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_paste.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_resize.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_right_click.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_vertical_resize.txt +0 -24
- data/examples/app_all_events/test/snapshots/initial_state.txt +0 -24
- data/examples/app_all_events/view_state.rb +0 -42
- data/examples/app_color_picker/scene.rb +0 -201
- data/examples/widget_block_padding/app.rb +0 -67
- data/examples/widget_block_titles/app.rb +0 -69
- data/examples/widget_list_styles/app.rb +0 -141
- data/examples/widget_table_flex/app.rb +0 -95
- data/lib/ratatui_ruby/session/autodoc.rb +0 -417
- data/lib/ratatui_ruby/session.rb +0 -163
- data/sig/examples/widget_block_padding/app.rbs +0 -11
- data/sig/examples/widget_block_titles/app.rbs +0 -11
- data/sig/examples/widget_list_styles/app.rbs +0 -11
- data/tasks/autodoc/inventory.rb +0 -61
- data/tasks/autodoc/notice.rb +0 -26
- data/tasks/autodoc/rbs.rb +0 -38
- data/tasks/autodoc/rdoc.rb +0 -45
- data/tasks/bump/comparison_links.rb +0 -41
- /data/doc/images/{app_map_demo.png → widget_map_demo.png} +0 -0
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
|
|
2
|
-
#
|
|
3
|
-
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
4
|
-
|
|
5
|
-
# frozen_string_literal: true
|
|
6
|
-
|
|
7
|
-
$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
|
|
8
|
-
require "ratatui_ruby"
|
|
9
|
-
|
|
10
|
-
# Initialize the terminal
|
|
11
|
-
class WidgetBlockTitles
|
|
12
|
-
def run
|
|
13
|
-
RatatuiRuby.run do |tui|
|
|
14
|
-
loop do
|
|
15
|
-
# Create a layout with multiple blocks demonstrating titles
|
|
16
|
-
blocks = [
|
|
17
|
-
tui.block(
|
|
18
|
-
titles: [
|
|
19
|
-
{ content: "Top Left", alignment: :left, position: :top },
|
|
20
|
-
{ content: "Top Right", alignment: :right, position: :top },
|
|
21
|
-
],
|
|
22
|
-
borders: [:all],
|
|
23
|
-
border_color: "cyan"
|
|
24
|
-
),
|
|
25
|
-
tui.block(
|
|
26
|
-
titles: [
|
|
27
|
-
{ content: "Bottom Left", alignment: :left, position: :bottom },
|
|
28
|
-
{ content: "Bottom Center", alignment: :center, position: :bottom },
|
|
29
|
-
{ content: "Bottom Right", alignment: :right, position: :bottom },
|
|
30
|
-
],
|
|
31
|
-
borders: [:all],
|
|
32
|
-
border_color: "magenta"
|
|
33
|
-
),
|
|
34
|
-
tui.block(
|
|
35
|
-
titles: [
|
|
36
|
-
"Simple String Title (Top Left Default)",
|
|
37
|
-
{ content: "Mixed Title", alignment: :center, position: :bottom },
|
|
38
|
-
],
|
|
39
|
-
borders: [:all],
|
|
40
|
-
border_color: "green"
|
|
41
|
-
),
|
|
42
|
-
]
|
|
43
|
-
|
|
44
|
-
tui.draw do |frame|
|
|
45
|
-
layout = tui.layout_split(
|
|
46
|
-
frame.area,
|
|
47
|
-
direction: :vertical,
|
|
48
|
-
constraints: [
|
|
49
|
-
tui.constraint(:length, 10),
|
|
50
|
-
tui.constraint(:length, 10),
|
|
51
|
-
tui.constraint(:length, 10),
|
|
52
|
-
]
|
|
53
|
-
)
|
|
54
|
-
|
|
55
|
-
layout.each_with_index do |area, i|
|
|
56
|
-
frame.render_widget(blocks[i], area) if blocks[i]
|
|
57
|
-
end
|
|
58
|
-
end
|
|
59
|
-
|
|
60
|
-
event = tui.poll_event
|
|
61
|
-
break if event == "q" || event == :ctrl_c
|
|
62
|
-
end
|
|
63
|
-
end
|
|
64
|
-
end
|
|
65
|
-
end
|
|
66
|
-
|
|
67
|
-
if __FILE__ == $0
|
|
68
|
-
WidgetBlockTitles.new.run
|
|
69
|
-
end
|
|
@@ -1,141 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
|
|
4
|
-
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
5
|
-
|
|
6
|
-
$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
|
|
7
|
-
require "ratatui_ruby"
|
|
8
|
-
|
|
9
|
-
# Styled List Example
|
|
10
|
-
# Demonstrates advanced styling options for the List widget.
|
|
11
|
-
class WidgetListStyles
|
|
12
|
-
attr_reader :selected_index, :highlight_spacing
|
|
13
|
-
|
|
14
|
-
def initialize
|
|
15
|
-
@items = ["Item 1", "Item 2", "Item 3"]
|
|
16
|
-
@selected_index = nil
|
|
17
|
-
|
|
18
|
-
@directions = [
|
|
19
|
-
{ name: "Top to Bottom", direction: :top_to_bottom },
|
|
20
|
-
{ name: "Bottom to Top", direction: :bottom_to_top },
|
|
21
|
-
]
|
|
22
|
-
@direction_index = 0
|
|
23
|
-
|
|
24
|
-
@highlight_spacings = [
|
|
25
|
-
{ name: "When Selected", spacing: :when_selected },
|
|
26
|
-
{ name: "Always", spacing: :always },
|
|
27
|
-
{ name: "Never", spacing: :never },
|
|
28
|
-
]
|
|
29
|
-
@highlight_spacing_index = 0
|
|
30
|
-
|
|
31
|
-
@repeat_modes = [
|
|
32
|
-
{ name: "Off", repeat: false },
|
|
33
|
-
{ name: "On", repeat: true },
|
|
34
|
-
]
|
|
35
|
-
@repeat_index = 0
|
|
36
|
-
end
|
|
37
|
-
|
|
38
|
-
def run
|
|
39
|
-
RatatuiRuby.run do |tui|
|
|
40
|
-
@tui = tui
|
|
41
|
-
@hotkey_style = @tui.style(modifiers: [:bold, :underlined])
|
|
42
|
-
|
|
43
|
-
loop do
|
|
44
|
-
render
|
|
45
|
-
break if handle_input == :quit
|
|
46
|
-
sleep 0.05
|
|
47
|
-
end
|
|
48
|
-
end
|
|
49
|
-
end
|
|
50
|
-
|
|
51
|
-
private def render
|
|
52
|
-
selection_label = @selected_index.nil? ? "none" : @selected_index.to_s
|
|
53
|
-
direction_config = @directions[@direction_index]
|
|
54
|
-
spacing_config = @highlight_spacings[@highlight_spacing_index]
|
|
55
|
-
repeat_config = @repeat_modes[@repeat_index]
|
|
56
|
-
|
|
57
|
-
@tui.draw do |frame|
|
|
58
|
-
# Split into main content and control panel
|
|
59
|
-
main_area, control_area = @tui.layout_split(
|
|
60
|
-
frame.area,
|
|
61
|
-
direction: :vertical,
|
|
62
|
-
constraints: [
|
|
63
|
-
@tui.constraint_fill(1),
|
|
64
|
-
@tui.constraint_length(5),
|
|
65
|
-
]
|
|
66
|
-
)
|
|
67
|
-
|
|
68
|
-
# Render list
|
|
69
|
-
main_list = @tui.list(
|
|
70
|
-
items: @items,
|
|
71
|
-
selected_index: @selected_index,
|
|
72
|
-
style: @tui.style(fg: :white, bg: :black),
|
|
73
|
-
highlight_style: @tui.style(fg: :blue, bg: :white, modifiers: [:bold]),
|
|
74
|
-
highlight_symbol: ">> ",
|
|
75
|
-
repeat_highlight_symbol: repeat_config[:repeat],
|
|
76
|
-
highlight_spacing: spacing_config[:spacing],
|
|
77
|
-
direction: direction_config[:direction],
|
|
78
|
-
block: @tui.block(
|
|
79
|
-
title: "Items",
|
|
80
|
-
borders: [:all]
|
|
81
|
-
)
|
|
82
|
-
)
|
|
83
|
-
frame.render_widget(main_list, main_area)
|
|
84
|
-
|
|
85
|
-
# Render control panel
|
|
86
|
-
control_panel = @tui.block(
|
|
87
|
-
title: "Controls",
|
|
88
|
-
borders: [:all],
|
|
89
|
-
children: [
|
|
90
|
-
@tui.paragraph(
|
|
91
|
-
text: [
|
|
92
|
-
@tui.text_line(spans: [
|
|
93
|
-
@tui.text_span(content: "↑/↓", style: @hotkey_style),
|
|
94
|
-
@tui.text_span(content: ": Select (#{selection_label}) "),
|
|
95
|
-
@tui.text_span(content: "x", style: @hotkey_style),
|
|
96
|
-
@tui.text_span(content: ": Toggle Selection "),
|
|
97
|
-
@tui.text_span(content: "q", style: @hotkey_style),
|
|
98
|
-
@tui.text_span(content: ": Quit"),
|
|
99
|
-
]),
|
|
100
|
-
@tui.text_line(spans: [
|
|
101
|
-
@tui.text_span(content: "d", style: @hotkey_style),
|
|
102
|
-
@tui.text_span(content: ": Direction (#{direction_config[:name]}) "),
|
|
103
|
-
@tui.text_span(content: "s", style: @hotkey_style),
|
|
104
|
-
@tui.text_span(content: ": Spacing (#{spacing_config[:name]})"),
|
|
105
|
-
]),
|
|
106
|
-
@tui.text_line(spans: [
|
|
107
|
-
@tui.text_span(content: "r", style: @hotkey_style),
|
|
108
|
-
@tui.text_span(content: ": Repeat Symbol (#{repeat_config[:name]})"),
|
|
109
|
-
]),
|
|
110
|
-
]
|
|
111
|
-
),
|
|
112
|
-
]
|
|
113
|
-
)
|
|
114
|
-
frame.render_widget(control_panel, control_area)
|
|
115
|
-
end
|
|
116
|
-
end
|
|
117
|
-
|
|
118
|
-
private def handle_input
|
|
119
|
-
case @tui.poll_event
|
|
120
|
-
in { type: :key, code: "q" } | { type: :key, code: "c", modifiers: ["ctrl"] }
|
|
121
|
-
:quit
|
|
122
|
-
in type: :key, code: "up"
|
|
123
|
-
@selected_index = (@selected_index || 0) - 1
|
|
124
|
-
@selected_index = @items.size - 1 if @selected_index.negative?
|
|
125
|
-
in type: :key, code: "down"
|
|
126
|
-
@selected_index = ((@selected_index || -1) + 1) % @items.size
|
|
127
|
-
in type: :key, code: "d"
|
|
128
|
-
@direction_index = (@direction_index + 1) % @directions.size
|
|
129
|
-
in type: :key, code: "s"
|
|
130
|
-
@highlight_spacing_index = (@highlight_spacing_index + 1) % @highlight_spacings.size
|
|
131
|
-
in type: :key, code: "r"
|
|
132
|
-
@repeat_index = (@repeat_index + 1) % @repeat_modes.size
|
|
133
|
-
in type: :key, code: "x"
|
|
134
|
-
@selected_index = @selected_index.nil? ? 0 : nil
|
|
135
|
-
else
|
|
136
|
-
nil
|
|
137
|
-
end
|
|
138
|
-
end
|
|
139
|
-
end
|
|
140
|
-
|
|
141
|
-
WidgetListStyles.new.run if __FILE__ == $PROGRAM_NAME
|
|
@@ -1,95 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
|
|
4
|
-
# SPDX-License-Identifier: AGPL-3.0-or-later
|
|
5
|
-
|
|
6
|
-
$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
|
|
7
|
-
require "ratatui_ruby"
|
|
8
|
-
|
|
9
|
-
# Demonstrates structured data layout with flexible column distribution.
|
|
10
|
-
#
|
|
11
|
-
# Data is often multidimensional. You need to show relationships between fields (Name, Age, ID). Aligning columns manually in a monospaced environment is painful and error-prone.
|
|
12
|
-
#
|
|
13
|
-
# This demo showcases the <tt>Table</tt> widget's flex modes. It renders multiple tables demonstrating how data is distributed across the available space using <tt>:legacy</tt>, <tt>:space_between</tt>, and <tt>:space_around</tt> settings.
|
|
14
|
-
#
|
|
15
|
-
# Use it to understand how to build perfectly aligned grids for database records, logs, or file lists.
|
|
16
|
-
#
|
|
17
|
-
# === Example
|
|
18
|
-
#
|
|
19
|
-
# Run the demo from the terminal:
|
|
20
|
-
#
|
|
21
|
-
# ruby examples/widget_table_flex/app.rb
|
|
22
|
-
#
|
|
23
|
-
# rdoc-image:/doc/images/widget_table_flex.png
|
|
24
|
-
class WidgetTableFlex
|
|
25
|
-
def run
|
|
26
|
-
RatatuiRuby.run do |tui|
|
|
27
|
-
loop do
|
|
28
|
-
render(tui)
|
|
29
|
-
break if handle_input(tui) == :quit
|
|
30
|
-
end
|
|
31
|
-
end
|
|
32
|
-
end
|
|
33
|
-
|
|
34
|
-
def render(tui)
|
|
35
|
-
tui.draw do |frame|
|
|
36
|
-
chunks = tui.layout_split(
|
|
37
|
-
frame.area,
|
|
38
|
-
direction: :vertical,
|
|
39
|
-
constraints: [
|
|
40
|
-
tui.constraint_length(3),
|
|
41
|
-
tui.constraint_fill(1),
|
|
42
|
-
tui.constraint_fill(1),
|
|
43
|
-
tui.constraint_fill(1),
|
|
44
|
-
]
|
|
45
|
-
)
|
|
46
|
-
|
|
47
|
-
frame.render_widget(
|
|
48
|
-
tui.paragraph(
|
|
49
|
-
text: "Table Flex Layout (press 'q' to quit)",
|
|
50
|
-
block: tui.block(title: "Header", borders: [:all])
|
|
51
|
-
),
|
|
52
|
-
chunks[0]
|
|
53
|
-
)
|
|
54
|
-
|
|
55
|
-
frame.render_widget(
|
|
56
|
-
tui.table(
|
|
57
|
-
header: ["Legacy (Default)", "Table"],
|
|
58
|
-
rows: [["Item 1", "Item 2"], ["Item 3", "Item 4"]],
|
|
59
|
-
widths: [tui.constraint_length(20), tui.constraint_length(20)],
|
|
60
|
-
block: tui.block(title: "Flex: :legacy (Default)", borders: [:all])
|
|
61
|
-
),
|
|
62
|
-
chunks[1]
|
|
63
|
-
)
|
|
64
|
-
|
|
65
|
-
frame.render_widget(
|
|
66
|
-
tui.table(
|
|
67
|
-
header: ["Space", "Between"],
|
|
68
|
-
rows: [["A", "B"], ["C", "D"]],
|
|
69
|
-
widths: [tui.constraint_length(20), tui.constraint_length(20)],
|
|
70
|
-
block: tui.block(title: "Flex: :space_between", borders: [:all]),
|
|
71
|
-
flex: :space_between
|
|
72
|
-
),
|
|
73
|
-
chunks[2]
|
|
74
|
-
)
|
|
75
|
-
|
|
76
|
-
frame.render_widget(
|
|
77
|
-
tui.table(
|
|
78
|
-
header: ["Space", "Around"],
|
|
79
|
-
rows: [["E", "F"], ["G", "H"]],
|
|
80
|
-
widths: [tui.constraint_length(20), tui.constraint_length(20)],
|
|
81
|
-
block: tui.block(title: "Flex: :space_around", borders: [:all]),
|
|
82
|
-
flex: :space_around
|
|
83
|
-
),
|
|
84
|
-
chunks[3]
|
|
85
|
-
)
|
|
86
|
-
end
|
|
87
|
-
end
|
|
88
|
-
|
|
89
|
-
def handle_input(tui)
|
|
90
|
-
event = tui.poll_event
|
|
91
|
-
:quit if event == "q" || event == :ctrl_c
|
|
92
|
-
end
|
|
93
|
-
end
|
|
94
|
-
|
|
95
|
-
WidgetTableFlex.new.run if __FILE__ == $0
|