cartographer_rs/
lib.rs

1//! A menu builder for Terminal User Interfaces with searching and arrow
2//! key navigation
3//!
4//! Use the [`menu_item!`](crate::menu_item!) and [`menu!`](crate::menu!) macros for the best effect
5//!
6//! ## Example
7//! ```
8//! use cartographer_rs::{menu, menu_item};
9//! let menu = menu!(
10//!       "Pick a number: ",
11//!       [
12//!           menu_item!("Item Number 1", true, 1),
13//!           menu_item!("Item Number 2", false, 2, ["death"]),
14//!           menu_item!("Item Number 3", true, 3),
15//!           menu_item!("Item Number 5", true, 5, ["80", "5"])
16//!       ]
17//!   );
18//!
19//!
20//! // Returns the string of the item given
21//! let usr_selection = menu.serve()?;
22//! ```
23//!
24
25/// Contains the Menu and Menu Item structs for configuration
26mod menu;
27pub use menu::{Menu, MenuItem, MenuOptions};
28
29/// Contains the menu! and menu_item! macros
30mod menu_macros;