9 releases
new 0.2.6 | Sep 2, 2024 |
---|---|
0.2.5 | Aug 12, 2024 |
0.2.4 | Jul 22, 2024 |
0.1.1 | Jul 1, 2024 |
#66 in #focus
263 downloads per month
Used in focusable
10KB
130 lines
Crate Focusable
GitHub Repository · API Docs · Examples · Changelog · Contributing
A library for managing focusable elements in an application.
STATUS: Experimental - expect breaking changes.
This crate implements a generic focus handling approach for use in any application. This was specifically crafted with the idea of providing a way to add focusable behavior widgets in Ratatui, but does not depend on it.
Documentation is available at docs.rs.
Usage
cargo add focusable
And then implement or derive the Focus
and FocusContainer
traits for your types.
Inspired by iced_focus and rat-focus.
Example
use focusable::{Focus, FocusContainer};
#[derive(Focus)]
struct Button {
is_focused: bool,
}
#[derive(Focus)]
struct TextBox {
is_focused: bool,
}
#[derive(Clone, Focus)]
struct Label;
#[derive(FocusContainer)]
struct App {
children: Vec<Box<dyn Focus>>,
}
let label = Box::new(Label);
assert!(!label.can_focus(), "Label should not be focusable");
let button = Box::new(Button { is_focused: false });
assert!(button.can_focus());
let text_box = Box::new(TextBox { is_focused: false });
assert!(text_box.can_focus());
let mut app = App {
children: vec![label.clone(), button, label, text_box],
};
app.focus_first();
assert!(app.children[1].is_focused()); // skip the first label
app.focus_next();
assert!(app.children[3].is_focused()); // skip the second label
License
Copyright (c) 2024 Josh McKinney
This project is licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
See CONTRIBUTING.md.
Dependencies
~0.6–1.1MB
~23K SLoC