modalkit 0.0.25

A library for building applications that use modal editing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

//! # modalkit
//!
//! ## Overview
//!
//! This crate allows building terminal applications that support modal input, such as
//! the Vim text editor.
//!
//! The [mod@env] module contains keybindings for Vim and Emacs, which can be used along with
//! [key::TerminalKey] in the terminal to generate [actions] that can be used to drive [editing].
//!
//! ## Examples
//!
//! For examples using this crate, check out:
//!
//! - [modalkit-ratatui], for how to build TUI interfaces
//! - [scansion] for building a shell-like application
//! - [iamb] for a larger example of building a TUI application with custom actions
//!
//! [modalkit-ratatui]: https://docs.rs/modalkit-ratatui/latest/modalkit_ratatui/
//! [scansion]: https://docs.rs/scansion/latest/scansion/
//! [iamb]: https://github.com/ulyssa/iamb

// Require docs for public APIs, and disable the more annoying clippy lints.
#![deny(missing_docs)]

#[macro_use]
mod util;

pub mod actions;
pub mod commands;
pub mod editing;
pub mod env;
pub mod errors;
pub mod key;
pub mod ui;

pub use crossterm;
pub use editor_types::prelude;
pub use keybindings;