ratatui_ruby 0.7.1 → 0.7.3

data/examples/{widget_list_demo → widget_list}/README.md

@@ -3,9 +3,9 @@ SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
-# List Widget Example
+# List (ListItem) Example
 
-[![widget_list_demo](../../doc/images/widget_list_demo.png)](app.rb)
+[![widget_list](../../doc/images/widget_list.png)](app.rb)
 
 Demonstrates a selectable list with extensive configuration options.
 
@@ -37,13 +37,16 @@ Lists are the workhorse of terminal interfaces. Managing selection state, scroll
 ## Usage
 
 ```bash
-ruby examples/widget_list_demo/app.rb
+ruby examples/widget_list/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Create a file explorer.
 - Build a navigation menu.
 - Display a log where users can scroll back to read history.
-- Implement "infinite select" behaviors.
+- Implement "infinite select" behaviors.
+
+[Read the source code →](app.rb)

data/examples/{widget_list_demo → widget_list}/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
@@ -19,10 +21,10 @@ require "faker" # Use Faker for large, realistic datasets
 #
 # Run the demo from the terminal:
 #
-#   ruby examples/widget_list_demo/app.rb
+#   ruby examples/widget_list/app.rb
 #
-# rdoc-image:/doc/images/widget_list_demo.png
-class WidgetListDemo
+# rdoc-image:/doc/images/widget_list.png
+class WidgetList
   # Initializes the demo with example data and default configuration.
   def initialize
     Faker::Config.random = Random.new(12345)
@@ -253,7 +255,7 @@ class WidgetListDemo
       )
 
       # Render title
-      title = @tui.paragraph(text: "List Widget Demo - Interactive Attribute Cycling")
+      title = @tui.paragraph(text: "List Widget - Interactive Attribute Cycling")
       frame.render_widget(title, title_area)
 
       # Render list
@@ -363,4 +365,4 @@ class WidgetListDemo
   end
 end
 
-WidgetListDemo.new.run if __FILE__ == $PROGRAM_NAME
+WidgetList.new.run if __FILE__ == $PROGRAM_NAME

data/examples/{widget_map_demo → widget_map}/README.md

@@ -3,9 +3,9 @@ SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
-# Canvas Widget Example
+# Map (World Map, Canvas) Example
 
-[![widget_map_demo](../../doc/images/widget_map_demo.png)](app.rb)
+[![widget_map](../../doc/images/widget_map.png)](app.rb)
 
 Demonstrates drawing custom graphics and maps using the standard Braille and Block patterns.
 
@@ -28,12 +28,15 @@ Standard widgets are great for text, but sometimes you need to draw. The `Canvas
 ## Usage
 
 ```bash
-ruby examples/widget_map_demo/app.rb
+ruby examples/widget_map/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Render geographic data (World, USA, Europe).
 - Overlay custom labels and markers on a map.
-- Animate visual elements on top of a static background.
+- Animate visual elements on top of a static background.
+
+[Read the source code →](app.rb)

data/examples/{widget_map_demo → widget_map}/app.rb

@@ -1,13 +1,15 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
 
 # An example of the Canvas widget showing a world map and animated shapes.
-class WidgetMapDemo
+class WidgetMap
   include RatatuiRuby::Widgets
 
   COLORS = [:black, :blue, :white, nil].freeze
@@ -90,4 +92,4 @@ class WidgetMapDemo
   end
 end
 
-WidgetMapDemo.new.run if __FILE__ == $PROGRAM_NAME
+WidgetMap.new.run if __FILE__ == $PROGRAM_NAME

data/examples/{widget_overlay_demo → widget_overlay}/README.md

@@ -2,9 +2,9 @@
   SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
   SPDX-License-Identifier: CC-BY-SA-4.0
 -->
-# Overlay Widget Demo
+# Overlay Example
 
-[![Overlay Demo](../../doc/images/widget_overlay_demo.png)](app.rb)
+[![](../../doc/images/widget_overlay.png)](app.rb)
 
 This example demonstrates the `Overlay` composition pattern for layering widgets with depth. Modals, notifications, and floating panels all require stacking widgets on top of each other.
 
@@ -25,12 +25,15 @@ This example demonstrates the `Overlay` composition pattern for layering widgets
 ## Usage
 
 ```bash
-ruby examples/widget_overlay_demo/app.rb
+ruby examples/widget_overlay/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Build modal dialogs or confirmation popups.
 - Layer notifications over existing content.
 - Understand the Clear widget's role in opaque overlays.
+
+[Read the source code →](app.rb)

data/examples/{widget_overlay_demo → widget_overlay}/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
@@ -33,9 +35,9 @@ HEADLINES = [
   "Innovative Urban Planning Reduces Traffic Congestion by 30%",
 ].freeze
 
-# Overlay Demo Example
+# Overlay Example
 # Demonstrates the Overlay widget for layering widgets with depth.
-class WidgetOverlayDemo
+class WidgetOverlay
   def initialize
     @layer_count = 2 # Start with 2 layers visible
     @swapped = false
@@ -245,4 +247,4 @@ class WidgetOverlayDemo
   end
 end
 
-WidgetOverlayDemo.new.run if __FILE__ == $PROGRAM_NAME
+WidgetOverlay.new.run if __FILE__ == $PROGRAM_NAME

data/examples/{widget_popup_demo → widget_popup}/README.md

@@ -3,9 +3,9 @@ SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
-# Popup (Clear) Widget Example
+# Clear (Popup, Modal) Example
 
-[![widget_popup_demo](../../doc/images/widget_popup_demo.png)](app.rb)
+[![widget_popup](../../doc/images/widget_popup.png)](app.rb)
 
 Demonstrates how to render opaque overlays on top of content.
 
@@ -25,12 +25,15 @@ Terminal renders are additive. If you draw a new widget over an old one, the bac
 ## Usage
 
 ```bash
-ruby examples/widget_popup_demo/app.rb
+ruby examples/widget_popup/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Create a modal dialog (Confirm, Alert, Form).
 - Implement a dropdown menu that overlays other content.
-- Fix visual artifacts where old text shows through new widgets.
+- Fix visual artifacts where old text shows through new widgets.
+
+[Read the source code →](app.rb)

data/examples/{widget_popup_demo → widget_popup}/app.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
 
-# Popup Demo Example
+# Popup Example
 # Demonstrates the Clear widget for creating opaque popups.
 
-class WidgetPopupDemo
+class WidgetPopup
   def initialize
     @clear_enabled = false
   end
@@ -75,7 +77,7 @@ class WidgetPopupDemo
       text: popup_text,
       alignment: :center,
       block: tui.block(
-        title: "Popup Demo (q to quit, space to toggle)",
+        title: "Popup (q to quit, space to toggle)",
         borders: [:all]
       )
     )
@@ -101,4 +103,4 @@ class WidgetPopupDemo
   end
 end
 
-WidgetPopupDemo.new.run if __FILE__ == $0
+WidgetPopup.new.run if __FILE__ == $0

data/examples/{widget_ratatui_logo_demo → widget_ratatui_logo}/README.md

@@ -5,7 +5,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0
 
 # Ratatui Logo Example
 
-[![widget_ratatui_logo_demo](../../doc/images/widget_ratatui_logo_demo.png)](app.rb)
+[![widget_ratatui_logo](../../doc/images/widget_ratatui_logo.png)](app.rb)
 
 Demonstrates branding with the official logo widget.
 
@@ -23,12 +23,15 @@ A polished application often needs an "About" screen or a splash screen. This wi
 ## Usage
 
 ```bash
-ruby examples/widget_ratatui_logo_demo/app.rb
+ruby examples/widget_ratatui_logo/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Create a splash screen.
 - Add an "About" modal to your application.
-- See how to center a widget both vertically and horizontally.
+- See how to center a widget both vertically and horizontally.
+
+[Read the source code →](app.rb)

data/examples/{widget_ratatui_logo_demo → widget_ratatui_logo}/app.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 #
 # SPDX-License-Identifier: AGPL-3.0-or-later
-
-# frozen_string_literal: true
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
@@ -19,10 +21,10 @@ require "ratatui_ruby"
 #
 # Run the demo from the terminal:
 #
-#   ruby examples/widget_ratatui_logo_demo/app.rb
+#   ruby examples/widget_ratatui_logo/app.rb
 #
-# rdoc-image:/doc/images/widget_ratatui_logo_demo.png
-class WidgetRatatuiLogoDemo
+# rdoc-image:/doc/images/widget_ratatui_logo.png
+class WidgetRatatuiLogo
   def run
     RatatuiRuby.run do |tui|
       loop do
@@ -100,4 +102,4 @@ class WidgetRatatuiLogoDemo
   end
 end
 
-WidgetRatatuiLogoDemo.new.run if __FILE__ == $0
+WidgetRatatuiLogo.new.run if __FILE__ == $0

data/examples/{widget_ratatui_mascot_demo → widget_ratatui_mascot}/README.md

@@ -5,7 +5,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0
 
 # Ratatui Mascot Example
 
-[![widget_ratatui_mascot_demo](../../doc/images/widget_ratatui_mascot_demo.png)](app.rb)
+[![widget_ratatui_mascot](../../doc/images/widget_ratatui_mascot.png)](app.rb)
 
 Demonstrates the project mascot widget for adding personality.
 
@@ -24,11 +24,14 @@ Interfaces can feel clinical. A friendly mascot adds charm and brand identity to
 ## Usage
 
 ```bash
-ruby examples/widget_ratatui_mascot_demo/app.rb
+ruby examples/widget_ratatui_mascot/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Add visual flair to your UI.
-- Create a friendly empty state or success screen.
+- Create a friendly empty state or success screen.
+
+[Read the source code →](app.rb)

data/examples/{widget_ratatui_mascot_demo → widget_ratatui_mascot}/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: CC-BY-SA-4.0
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
@@ -18,10 +20,10 @@ require "ratatui_ruby"
 #
 # Run the demo from the terminal:
 #
-#   ruby examples/widget_ratatui_mascot_demo/app.rb
+#   ruby examples/widget_ratatui_mascot/app.rb
 #
-# rdoc-image:/doc/images/widget_ratatui_mascot_demo.png
-class WidgetRatatuiMascotDemo
+# rdoc-image:/doc/images/widget_ratatui_mascot.png
+class WidgetRatatuiMascot
   def initialize
     @show_block = true
   end
@@ -90,4 +92,4 @@ class WidgetRatatuiMascotDemo
   end
 end
 
-WidgetRatatuiMascotDemo.new.run if __FILE__ == $PROGRAM_NAME
+WidgetRatatuiMascot.new.run if __FILE__ == $PROGRAM_NAME

data/examples/widget_rect/README.md

@@ -3,7 +3,7 @@ SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
-# Rect (Geometry) Widget Example
+# Rect (Area, Rectangle) Example
 
 [![widget_rect](../../doc/images/widget_rect.png)](app.rb)
 
@@ -33,6 +33,9 @@ ruby examples/widget_rect/app.rb
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Handle mouse clicks on specific buttons or areas.
 - Create resizable panes (like a split pane in an IDE).
-- Debug layout issues by inspecting Rect coordinates.
+- Debug layout issues by inspecting Rect coordinates.
+
+[Read the source code →](app.rb)

data/examples/widget_rect/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"

data/examples/widget_render/README.md

@@ -32,6 +32,9 @@ ruby examples/widget_render/app.rb
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Build a game (Snake, Tetris) inside the terminal.
 - Create a specialized visualization (Network topology graph).
-- Draw custom UI elements not provided by the library.
+- Draw custom UI elements not provided by the library.
+
+[Read the source code →](app.rb)

data/examples/widget_render/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"

data/examples/widget_rich_text/README.md

@@ -30,6 +30,9 @@ ruby examples/widget_rich_text/app.rb
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Highlight keywords in code (Syntax highlighting).
 - Create status lines with icons (e.g., "✔ Success" where the checkmark is green).
-- Emphasize specific data points in a paragraph.
+- Emphasize specific data points in a paragraph.
+
+[Read the source code →](app.rb)

data/examples/widget_rich_text/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"

data/examples/widget_scroll_text/README.md

@@ -32,6 +32,9 @@ ruby examples/widget_scroll_text/app.rb
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Build a log viewer.
 - Create a "terms and conditions" scrollbox.
-- Display code snippets that might be wider than the terminal.
+- Display code snippets that might be wider than the terminal.
+
+[Read the source code →](app.rb)

data/examples/widget_scroll_text/app.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
 
-# Demo: Scrollable Paragraph
+# Scrollable Paragraph
 # Shows how to scroll through long text content using arrow keys
 #
 # Helper: Disable experimental warnings since we use line_count/line_width

data/examples/{widget_scrollbar_demo → widget_scrollbar}/README.md

@@ -3,9 +3,9 @@ SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
-# Scrollbar Widget Example
+# Scrollbar (Scroll) Example
 
-[![widget_scrollbar_demo](../../doc/images/widget_scrollbar_demo.png)](app.rb)
+[![widget_scrollbar](../../doc/images/widget_scrollbar.png)](app.rb)
 
 Demonstrates explicit scrollbars for navigation feedback.
 
@@ -27,11 +27,14 @@ Content overflows. Users get lost in long lists. Scrollbars provide essential sp
 ## Usage
 
 ```bash
-ruby examples/widget_scrollbar_demo/app.rb
+ruby examples/widget_scrollbar/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Add visual scroll indicators to Lists or Tables.
-- Implement specialized inputs like sliders or volume controls.
+- Implement specialized inputs like sliders or volume controls.
+
+[Read the source code →](app.rb)

data/examples/{widget_scrollbar_demo → widget_scrollbar}/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
@@ -18,10 +20,10 @@ require "ratatui_ruby"
 #
 # Run the demo from the terminal:
 #
-#   ruby examples/widget_scrollbar_demo/app.rb
+#   ruby examples/widget_scrollbar/app.rb
 #
-# rdoc-image:/doc/images/widget_scrollbar_demo.png
-class WidgetScrollbarDemo
+# rdoc-image:/doc/images/widget_scrollbar.png
+class WidgetScrollbar
   def initialize
     @scroll_position = 0
     @content_length = 50
@@ -150,4 +152,4 @@ class WidgetScrollbarDemo
   end
 end
 
-WidgetScrollbarDemo.new.run if __FILE__ == $PROGRAM_NAME
+WidgetScrollbar.new.run if __FILE__ == $PROGRAM_NAME

data/examples/{widget_sparkline_demo → widget_sparkline}/README.md

@@ -5,7 +5,7 @@ SPDX-License-Identifier: CC-BY-SA-4.0
 
 # Sparkline Widget Example
 
-[![widget_sparkline_demo](../../doc/images/widget_sparkline_demo.png)](app.rb)
+[![widget_sparkline](../../doc/images/widget_sparkline.png)](app.rb)
 
 Demonstrates high-density data visualization in a condensed footprint.
 
@@ -31,12 +31,15 @@ Users need context. A single number ("90% CPU") tells you status, but not the tr
 ## Usage
 
 ```bash
-ruby examples/widget_sparkline_demo/app.rb
+ruby examples/widget_sparkline/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Add a "CPU Load" graph to your header.
 - Visualize stock price trends in a list row.
-- Monitor memory usage over the last 60 seconds.
+- Monitor memory usage over the last 60 seconds.
+
+[Read the source code →](app.rb)

data/examples/{widget_sparkline_demo → widget_sparkline}/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"
@@ -18,10 +20,10 @@ require "ratatui_ruby"
 #
 # Run the demo from the terminal:
 #
-#   ruby examples/widget_sparkline_demo/app.rb
+#   ruby examples/widget_sparkline/app.rb
 #
-# rdoc-image:/doc/images/widget_sparkline_demo.png
-class WidgetSparklineDemo
+# rdoc-image:/doc/images/widget_sparkline.png
+class WidgetSparkline
   def run
     RatatuiRuby.run do |tui|
       @tui = tui
@@ -144,7 +146,7 @@ class WidgetSparklineDemo
       )
 
       frame.render_widget(
-        @tui.paragraph(text: "Sparkline Widget Demo - Cycle attributes with hotkeys"),
+        @tui.paragraph(text: "Sparkline Widget - Cycle attributes with hotkeys"),
         main_layout[0]
       )
 
@@ -272,4 +274,4 @@ class WidgetSparklineDemo
   end
 end
 
-WidgetSparklineDemo.new.run if __FILE__ == $PROGRAM_NAME
+WidgetSparkline.new.run if __FILE__ == $PROGRAM_NAME

data/examples/widget_style_colors/README.md

@@ -29,6 +29,9 @@ ruby examples/widget_style_colors/app.rb
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Create meaningful heatmaps.
 - Generate color palettes dynamically.
-- Test your terminal's color support capabilities.
+- Test your terminal's color support capabilities.
+
+[Read the source code →](app.rb)

data/examples/widget_style_colors/app.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+#--
 # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 # SPDX-License-Identifier: AGPL-3.0-or-later
+#++
 
 $LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 require "ratatui_ruby"

data/examples/{widget_table_demo → widget_table}/README.md

@@ -3,9 +3,9 @@ SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
 SPDX-License-Identifier: CC-BY-SA-4.0
 -->
 
-# Table Widget Example
+# Table (Row, Cell) Example
 
-[![widget_table_demo](../../doc/images/widget_table_demo.png)](app.rb)
+[![widget_table](../../doc/images/widget_table.png)](app.rb)
 
 Demonstrates advanced options for the `Table` widget, including selection, row-level highlighting, and column-level highlighting.
 
@@ -37,12 +37,15 @@ Data grids are complex. Users expect to navigate them with keys, select rows, an
 ## Usage
 
 ```bash
-ruby examples/widget_table_demo/app.rb
+ruby examples/widget_table/app.rb
 ```
 
 ## Learning Outcomes
 
 Use this example if you need to...
+
 - Build a file explorer or process list.
 - Create a data-heavy dashboard.
-- Handle conflicting style requirements (e.g., "Highlight this row, but make this error cell red").
+- Handle conflicting style requirements (e.g., "Highlight this row, but make this error cell red").
+
+[Read the source code →](app.rb)