A tmux like multiplexer for
gyscos/cursive
views
This project is work-in-progress
This project provides a tiling window manager for gyscos/cursive similar to Tmux. You can place any other cursive view inside of a Mux view to display these views in complex layouts side by side. Watch the demo below to see how it looks.
demo 
Expand to view
Simply add to your Cargo.toml
toml
[dependencies]
cursive-multiplex = "^0.2.0"
And then use Mux::new to create a new Mux view
rust
let (mut mux, root_node) = cursive_multiplex::Mux::new(
cursive::views::TextView::new("Hello World!".to_string())
);
Mux has defaults defined for key bindings. You can change them with the API described in the docs.
Expand to see default keybindings
| Action | Key |
|---|---|
| Move focus up | Alt + ↑ |
| Move focus right | Alt + → |
| Move focus down | Alt + ↓ |
| Move focus left | Alt + ← |
| Resize up | Ctrl + ↑ |
| Resize right | Ctrl + → |
| Resize down | Ctrl + ↓ |
| Resize left | Ctrl + ← |
You can add views by giving a path or an id to an existing node e.g.
rust
let new_node = mux.add_right_of(
cursive::views::TextView::new("Foo"),
root_node,
).expect("adding right panel to root failed");
Its also possible to add views by their path.
rust
if let Some(sibbling) = mux.root().right().right().down().build() {
let new_node = mux.add_above(
cursive::views::TextView::new("Foo"),
sibbling,
).expect("adding by path failed");
}
Returned will be a Result Ok contains the new id assigned to the view, or an error in case of failure.
You can also remove views, by giving the id of the views.
rust
mux.remove_id(new_node)?;
On success the id of the removed node is returned.
If you want to reorder your views you can easily switch them by using
rust
mux.switch_views(new_node, old_node)?;
If you find any bugs/unexpected behaviour or you have a proposition for future changes open an issue describing the current behaviour and what you expected.
:bangbang: CAUTION :bangbang: This crate uses Tmux for end2end testing and will kill your Tmux server during testing!
In order to run the integration tests, you first need to install a recent version of >=npm-10 and >=tmux-2.6!
After npm and tmux are installed, install required dependencies:
$ ./scripts/prepare-end2end-tests.sh
This will use npm to install jest and shellshot in the tests folder.
Just run
$ cargo test
to execute all available tests.
shields.io endpoints are generated inside the ./target/shields folder. They are used in this README.
Fin Christensen
:octocat:
@fin-ger
:elephant:@fin_ger@mastodon.social
:bird:@fin_ger_github
Johannes Wünsche
:octocat:
@jwuensche
:elephant:@fredowald@mastodon.social
:bird:@Fredowald
Give a :star: if this project helped you!