hjkl-form

Vim-modal forms for hjkl-based apps.

Part of the hjkl monorepo — a vim-modal editor in Rust.

Each text field hosts its own Editor<Buffer, FormFieldHost>, so users get the full vim grammar (hjkl, wb, ciw, dd, ...) inside form inputs. The form itself runs a tiny FSM over Form-Normal / Form-Insert modes for focus navigation, validation, and submit dispatch — keystrokes delegate to the focused field's editor when the form is in Insert mode.

Renderers live in adapter crates: hjkl-ratatui::form::draw_form ships the ratatui flavor.

Status

dirty_gen aggregates buffer mutations and form-level focus changes; renderers can cheap-skip frames when it hasn't advanced.

Usage

hjkl-form = "0.3"

use hjkl_form::{
    Field, FieldMeta, Form, FormEvent, SubmitField, SubmitOutcome, TextFieldEditor,
};

let mut name = TextFieldEditor::with_meta(FieldMeta::new("Name").required(true), 1);
name.validator = Some(Box::new(|s: &str| {
    if s.is_empty() {
        Err("name is required".into())
    } else {
        Ok(())
    }
}));

let mut form = Form::new()
    .with_title("New user")
    .with_field(Field::SingleLineText(name))
    .with_field(Field::Submit(SubmitField::new(FieldMeta::new("Create"))))
    .with_submit(Box::new(|| {
        // Persist, fire HTTP request, etc.
        SubmitOutcome::Ok
    }));

// Drive with `Form::handle_input(input)` from your event loop, then call
// `hjkl_ratatui::form::draw_form(...)` per frame.
let _ = form.handle_input(hjkl_engine::Input::default());
let _ = FormEvent::Changed;

Key bindings

Documentation

docs.rs/hjkl-form

Contributing

See the monorepo CONTRIBUTING guide.

License

MIT — see LICENSE.