Struct ClickRegionRegistry 

pub struct ClickRegionRegistry<T: Clone> { /* private fields */ }

Registry for managing click regions during render.

Use this to track clickable areas that are populated during rendering and checked during event handling.

Example

use ratatui_interact::traits::ClickRegionRegistry;
use ratatui::layout::Rect;

#[derive(Clone, PartialEq, Debug)]
enum ButtonId { Save, Cancel }

let mut registry: ClickRegionRegistry<ButtonId> = ClickRegionRegistry::new();

// Clear before each render
registry.clear();

// Register regions during render
registry.register(Rect::new(0, 0, 8, 1), ButtonId::Save);
registry.register(Rect::new(10, 0, 8, 1), ButtonId::Cancel);

// Check clicks during event handling
assert_eq!(registry.handle_click(4, 0), Some(&ButtonId::Save));
assert_eq!(registry.handle_click(14, 0), Some(&ButtonId::Cancel));
assert_eq!(registry.handle_click(9, 0), None); // Gap between buttons

Implementations

impl<T: Clone> ClickRegionRegistry<T>

pub fn new() -> Self

Create a new empty registry.

pub fn with_capacity(capacity: usize) -> Self

Create a new registry with pre-allocated capacity.

pub fn clear(&mut self)

Clear all registered regions.

Call this at the start of each render to reset the regions.

pub fn register(&mut self, area: Rect, data: T)

Register a new click region.

Arguments

• area - The rectangular area that responds to clicks
• data - Data to return when this region is clicked

pub fn handle_click(&self, col: u16, row: u16) -> Option<&T>

Handle a click at the given position.

Returns a reference to the data if the click was within a region, None otherwise.

Arguments

• col - The column (x) position
• row - The row (y) position

pub fn regions(&self) -> &[ClickRegion<T>]

Get all registered regions.

pub fn is_empty(&self) -> bool

Check if any regions are registered.

pub fn len(&self) -> usize

Get the number of registered regions.

Trait Implementations

impl<T: Clone + Clone> Clone for ClickRegionRegistry<T>

fn clone(&self) -> ClickRegionRegistry<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Clone> Debug for ClickRegionRegistry<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Clone> Default for ClickRegionRegistry<T>

fn default() -> Self

Returns the “default value” for a type.