Mini-Me

An embeddable, customizable, inline text-editor based on crossterm.

      ╭─── Input Prompt
    1 │ hello there
    2 │ this is a simple prompt
    3 │ thats multiline and decent enough
    4 ┃ _
      ╰─── Lines: 4     Chars: 70    Ln: 3, Col: 0

Features

• Simple, intuitive, and embeddable.
• Customize header, footer, and or margin gutters.
  • Preset styles are unstable.
• Range selection.
• Toggle-able fullscreen mode.
• (Unstable) Clipboard support.

Binary Installation

minime can be used as a CLI. The best way to install it is using:

cargo install --features=bin --path .

The binary can be used by invoking minime -h.

Default Controls

• Arrow keys work as expected.
• Home, end, delete, Tab and backtab mirrors VSCode behavior.
• F12 to enter full screen mode.
• Shift-arrow keys create a selection range.
• Esc or Enter on the last empty line to close and submit the prompt.
• Control-X/C/V clipboard support is unstable.

Usage

Basic Setup

This is the most basic setup available.

use minime::{editor::keybindings::NormalKeybinding, editor::Editor, Result};

fn main() -> Result<()> {
    println!("Write something cool!");
    // Build the prompt.
    let mut term = Editor::default();
    term.read(NormalKeybinding, DefaultRenderer::default())?;
    dbg!(term.contents());
    Ok(())
}

Advanced

You can lock stdout() or stderr() to get better performance. You can also customize several settings in the renderer.

use minime::{
    editor::{keybindings::NormalKeybinding, Editor},
    renderer::{
        full::CrosstermRenderer,
        styles::classic::{ClassicFooter, ClassicGutter, ClassicHeader},
    },
    Result,
};

fn main() -> Result<()> {
    // Redirect our output to stdout (default).
    let stdout = std::io::stdout();
    let mut lock = stdout.lock();

    let renderer = CrosstermRenderer::render_to(&mut lock)
        .max_height(Some(10))
        .margin(ClassicGutter)
        .header(ClassicHeader {
            message: "Enter on the last line or Esc to submit your input!",
        })
        .footer(ClassicFooter);

    // Print out some prompt using styling options.
    let term = Editor::with_renderer(renderer);
    let result = term.read(NormalKeybinding)?;
    dbg!(result);
    Ok(())
}